医者からもらった薬がわかる本API
くすり検索API（search）
「医者からもらった薬がわかる本」の薬を検索するAPIです。「商品名」「一般名」「メーカー」「識別コード」など様々な条件での検索が可能です。
リクエストURL
- XML
- /search.xml?[parameter]=[value]...
- JSON
- /search.json?[parameter]=[value]...
※APIを利用するには契約時に発行されるAPIキーをGETパラメータに加える必要があります。
リクエストパラメータ
IDによるくすり詳細取得時
| パラメータ名 | 必須 | データタイプ | 説明 | 条件 | 初期値 |
|---|---|---|---|---|---|
| key | ○ | string | API利用キー | 有効なAPIキーを指定 | - |
| id | integer | くすりID | 有効なくすりIDを指定 | - |
くすり検索時
| パラメータ名 | 必須 | データタイプ | 説明 | 条件 | 初期値 |
|---|---|---|---|---|---|
| key | ○ | string | API利用キー | 有効なAPIキーを指定 | - |
| q | string | 以下項目を対象とした横断検索文字列
|
UTF8エンコード済の文字列 スペース区切りで複数キーワードに対応 最大10キーワード |
- | |
| type | string | qパラメータに複数キーワード設定時の動作指定 | all, any のいずれかを指定
|
all | |
| medicine | boolean | くすり名を検索対象とするかの設定 | 0, 1 のいずれかを指定
|
1 | |
| general | boolean | くすり一般名を検索対象とするかの設定 | 0, 1 のいずれかを指定
|
0 | |
| maker | boolean | メーカー名を検索対象とするかの設定 | 0, 1 のいずれかを指定
|
0 | |
| mcode | boolean | 本体コードを検索対象とするかの設定 | 0, 1 のいずれかを指定
|
0 | |
| pcode | boolean | 包装コードを検索対象とするかの設定 | 0, 1 のいずれかを指定
|
0 | |
| limit | integer | 検索結果取得件数 | 1-20までの数値 | 10 | |
| offset | integer | 検索オフセット | 0-999までの数値 | 0 | |
| type_id | integer | 種類IDによる絞り込み | 有効な種類IDを指定 | - | |
| form_id | integer | 剤形IDによる絞り込み | 有効な剤形IDを指定 | - | |
| mark_id | integer |
マークIDによる絞り込み ※マークID … filenameパラメータ（ID: x） |
有効なマークIDを指定 | - | |
| link | string | リンクタグ用パラメータによる絞り込み | 正しいフォーマットのLink値を指定 | - | |
| chapter_id | integer | チャプターIDによる絞り込み | 正しいフォーマットのチャプターIDを指定 | - | |
| category_level1_id | integer | 大カテゴリIDによる絞り込み | 正しいフォーマットの大カテゴリIDを指定 | - | |
| category_level2_id | integer | 中カテゴリIDによる絞り込み | 正しいフォーマットの中カテゴリIDを指定 | - | |
| inline_tag | boolean | インラインタグ(Linkタグ)の出現設定 | 0, 1 のいずれかを指定
|
0 |
レスポンスフィールド
| ID | パラメータ名 | 出現回数 | データタイプ | 必須 | 説明 | 備考 | 例 | markタグ | Linkタグ |
|---|---|---|---|---|---|---|---|---|---|
| 1 | results | 1 | - | ○ | レスポンスルートノード | - | - | - | - |
| 2 | api_version | 1 | integer | ○ | APIバージョン | - | 1.0 | - | - |
| 3 | results_available | 1 | integer | ○ | 全件数 | 対象はmedicineパラメータ | 10 | - | - |
| 4 | results_returned | 1 | integer | ○ | 取得件数 | 対象はmedicineパラメータ | 1 | - | - |
| 5 | results_offset | 1 | integer | ○ | 開始位置（オフセット値） | 対象はmedicineパラメータ | 0 | - | - |
| 6 | medicines | 1 | - | ○ | - | - | - | - | - |
| 7 | medicine | 複数回 | - | ○ | くすり情報 | - | - | - | - |
| 8 | id | 1 | integer | ○ | くすりID | - | 5510 | - | - |
| 9 | name | 1 | string | ○ | くすり名 | - | ニコナス | - | - |
| 10 | name_kana | 1 | string | ○ | くすり名かな | - | にこなす | - | - |
| 11 | day_limit | 1 | string | ○ | 使用量と回数 | - | 400mg 2分服 | - | - |
| 12 | pc | 1 | string | ○ | プレグナンシー・カテゴリー | - | C | - | - |
| 13 | original | 1 | boolean | ○ | 先発医薬品フラグ | - | 0 | - | - |
| 14 | generic | 1 | boolean | ○ | 後発医薬品フラグ | - | 1 | - | - |
| 15 | orr_label | 1 | boolean | ○ | 健康保険適応外フラグ | - | 1 | - | - |
| 16 | regulation | 1 | string | 規制 | - | 劇薬 | - | - | |
| 17 | explanation | 1 | string | 日本語訳「注」 | - | 一般名の後の( )つきのアルファベットは「処方目的」を指しています。 | - | - | |
| 18 | type | 1 | - | ○ | 薬種類情報 | - | - | - | - |
| 19 | id | 1 | integer | ○ | 薬種類ID | - | 1 | - | - |
| 20 | name | 1 | string | ○ | 薬種類名 | - | 内服液 | - | - |
| 21 | price_informations | 1 | - | ○ | - | - | - | - | - |
| 22 | price_information | 複数回 | - | - | 価格情報 | - | - | - | - |
| 23 | id | 1 | integer | - |
剤形ID ※DBのIDの為、動作環境毎に異なる |
- | 錠剤 | - | - |
| 24 | form | 1 | string | - | 剤形 | - | 錠剤 | - | - |
| 25 | quantity | 1 | string | - | 単位あたりの量 | - | 5mg | - | - |
| 26 | unit | 1 | string | - | 単位 | - | 1錠 | - | - |
| 27 | price | 1 | string | - | 価格 | - | 15円 | - | - |
| 28 | codes | 1 | - | ○ | - | - | - | - | - |
| 29 | code | 複数回 | - | ○ | コード情報 | - | - | - | - |
| 30 | main | 1 | string | - | 本体コード | - | OH111 | ○ | - |
| 31 | packing | 1 | string | - | 包装コード | - | OH-111 200mg | ○ | - |
| 32 | dose | 1 | string | - | 容量 | - | 200mg | - | |
| 33 | form | 1 | - | - | 薬剤形情報 | - | - | - | - |
| 34 | id | 1 | integer | - | 薬種類ID | - | 1 | - | - |
| 35 | name | 1 | string | - | 薬種類名 | - | 錠剤 | - | - |
| 36 | points | 1 | - | ○ | 評価ポイント情報 | - | - | - | - |
| 37 | point | 1 | integer | - | 総合評価 | - | 6 | - | - |
| 38 | uk | 1 | integer | - | イギリス評価 | - | 1 | - | - |
| 39 | usa | 1 | integer | - | アメリカ評価 | - | 1 | - | - |
| 40 | ger | 1 | integer | - | ドイツ評価 | - | 1 | - | - |
| 41 | fr | 1 | integer | - | フランス評価 | - | 1 | - | - |
| 42 | times | 1 | - | - | 収載・販売情報 | - | - | - | - |
| 43 | listing | 1 | boolean | - | 保険収載年月フラグ | - | 0 | - | - |
| 44 | selling | 1 | boolean | - | 発売年月フラグ | - | 1 | - | - |
| 45 | year | 1 | integer | - | 年 | - | 2012 | - | - |
| 46 | month | 1 | integer | - | 月 | - | 6 | - | - |
| 47 | mark_images | 1 | - | ○ | - | - | - | - | - |
| 48 | mark_image | 複数回 | - | - |
マーク画像情報 （main, packingでのmarkタグの出現順に表示される） |
縦／横とも。上限100pixel | - | - | - |
| 49 | id | 1 | string | ○ | マークID | - | 031 | - | - |
| 50 | uri | 1 | string | ○ | 画像へのURI | - | - | - | |
| 51 | alt | 1 | string | ○ | キャプション | - | マーク画像:001.jpg | - | - |
| 52 | width | 1 | integer | ○ | 画像の幅（pixel) | - | 100 | - | - |
| 53 | height | 1 | integer | ○ | 画像の高さ（pixel) | - | 98 | - | - |
| 54 | content_type | 1 | string | ○ | 画像の種類 | - | image/jpeg | - | - |
| 55 | size | 1 | integer | ○ | 画像の容量(byte) | - | 7581 | - | - |
| 56 | makers | 1 | - | ○ | - | - | - | - | - |
| 57 | maker | 複数回 | - | ○ | メーカー情報 | - | - | - | - |
| 58 | id | 1 | integer | ○ | メーカーID | - | 253 | - | - |
| 59 | name | 1 | string | - | メーカー名 | - | 大原 | - | - |
| 60 | name_kana | 1 | string | - | メーカー名かな | - | おおはら | - | - |
| 61 | full_name | 1 | string | - | メーカー名(詳細) | - | 大原薬品工業 | - | - |
| 62 | order | 1 | integer | ○ | 表示順 | - | 1 | - | - |
| 63 | images | 1 | - | ○ | - | - | - | - | - |
| 64 | image | 複数回 | - | - | メーカー画像情報（マーク画像情報） | 縦／横とも、上限100pixel | - | - | - |
| 65 | id | 1 | string | ○ | マークID | - | 1 | - | - |
| 66 | uri | 1 | string | ○ | 画像へのURI | - | - | - | |
| 67 | alt | 1 | string | ○ | キャプション | - | マーク画像:001.jpg | - | - |
| 68 | width | 1 | integer | ○ | 画像の幅（pixel) | - | 100 | - | - |
| 69 | height | 1 | integer | ○ | 画像の高さ（pixel) | - | 98 | - | - |
| 70 | content_type | 1 | string | ○ | 画像の種類 | - | image/jpeg | - | - |
| 71 | size | 1 | integer | ○ | 画像の容量（byte） | - | 7581 | - | - |
| 72 | information | 1 | - | ○ | くすり情報 | - | - | - | - |
| 73 | classification | 1 | string | - | 分類 | - | 解熱鎮痛薬(アニリン系) | - | ○ |
| 74 | effect | 1 | string | - | 処方目的・適応 | - | 手術後・外傷後，慢性副鼻腔炎，乳汁うっ滞などの腫れの緩解／気管支炎.. | - | ○ |
| 75 | comment | 1 | string | - | 解説 | - | 微生物起原の消炎酵素薬には，セラペプターゼのほかにプロナーゼ，セアプローゼS，モンサントエンザ.. | - | ○ |
| 76 | warning | 1 | string | - | 警告 | - | 重篤で遷延性(長引くこと)の低血糖症がおこることがあるため，用法・用量など指示されたことは.. | - | ○ |
| 77 | caution | 1 | string | - | 基本的注意 | - | ●1●服用してはいけない場合……重症ケトーシス，糖尿病性昏睡また.. | - | ○ |
| 78 | side_effects | 1 | string | - | 重大な副作用 | - | ①低血糖症状が現れることがあります。徐々に進行する低血糖では.. | - | ○ |
| 79 | other_side_effects | 1 | string | - | その他の副作用 | - | ●1●次回，受診した際に処方医に伝える副作用……吐きけ，嘔吐，.. | - | ○ |
| 80 | combination_contraindication | 1 | string | - | 併用してはいけない薬 | - | ●1●本剤との併用で血糖が下がりすぎる薬剤……インスリン製剤，.. | - | ○ |
| 81 | combination_caution | 1 | string | - | 注意して併用すべき薬 | - | ●1●本剤との併用で作用が強まる薬剤……炭酸リチウム製剤，.. | - | ○ |
| 82 | images | 1 | - | ○ | - | - | - | - | - |
| 83 | image | 複数回 | - | - | くすり画像情報 | - | - | - | - |
| 84 | large | 1 | - | ○ | 大きいサイズの画像 | 縦／横とも、上限1000pixel | - | - | - |
| 85 | uri | 1 | string | ○ | 画像へのURI | - | - | - | |
| 86 | alt | 1 | string | ○ | キャプション | - | 薬画像:2011-028.jpg | - | - |
| 87 | width | 1 | integer | ○ | 画像の幅(pixel) | - | 1000 | - | - |
| 88 | height | 1 | integer | ○ | 画像の高さ(pixel) | - | 511 | - | - |
| 89 | content_type | 1 | string | ○ | 画像の種類 | - | image/jpeg | - | - |
| 90 | size | 1 | integer | ○ | 画像の容量(byte) | - | 792401 | - | - |
| 91 | small | 1 | - | ○ | 小さいサイズの画像 | 縦／横とも、上限200pixel | - | - | - |
| 92 | uri | 1 | string | ○ | 画像へのURI | - | - | - | |
| 93 | alt | 1 | string | ○ | キャプション | - | 薬画像:2011-028.jpg | - | - |
| 94 | width | 1 | integer | ○ | 画像の幅(pixel) | - | 200 | - | - |
| 95 | height | 1 | integer | ○ | 画像の高さ(pixel) | - | 102 | - | - |
| 96 | content_type | 1 | string | ○ | 画像の種類 | - | image/jpeg | - | - |
| 97 | size | 1 | integer | ○ | 画像の容量(byte) | - | 35814 | - | - |
| 98 | general | 1 | - | ○ | 薬一般情報 | - | - | - | - |
| 99 | name | 1 | string | ○ | 薬一般名 | - | アリルアルカン酸誘導体を含む解熱鎮痛剤〔エドトラク（劇）〕 | - | ○ |
| 100 | original_medicines | 1 | - | ○ | - | - | - | - | - |
| 101 | original_medicine | 複数回 | - | - | 先発医薬品情報 | - | - | - | - |
| 102 | id | 1 | integer | ○ | くすりID | - | 14 | - | - |
| 103 | name | 1 | string | ○ | くすり名 | - | オステラック | - | - |
| 104 | self | 1 | boolean | ○ | 自身（medicineパラメータ[ID:7]）と同じかどうかのフラグ | - | 0 | - | - |
| 105 | makers | 1 | - | ○ | - | - | - | - | - |
| 106 | maker | 複数回 | - | ○ | メーカー情報 | - | - | - | - |
| 107 | id | 1 | integer | ○ | メーカーID | - | 14 | - | - |
| 108 | name | 1 | string | - | メーカー名 | - | ワイス | - | - |
| 109 | name_kana | 1 | string | - | メーカー名かな | - | わいす | - | - |
| 110 | full_name | 1 | string | - | メーカー名（詳細） | - | ワイス | - | - |
| 111 | order | 1 | integer | ○ | 表示順 | - | 1 | - | - |
| 112 | generic_medicines | 1 | - | ○ | - | - | - | - | - |
| 113 | generic_medicine | 複数回 | - | - | 後発医薬品情報 | - | - | - | - |
| 114 | id | 1 | integer | ○ | くすりID | - | 5510 | - | - |
| 115 | name | 1 | string | ○ | くすり名 | - | ニコナス | - | - |
| 116 | self | 1 | boolean | ○ | 自身（medicineパラメータ[ID:7]）と同じかどうかのフラグ | - | 1 | - | - |
| 117 | makers | 1 | - | ○ | - | - | - | - | - |
| 118 | maker | 複数回 | - | ○ | メーカー情報 | - | - | - | - |
| 119 | id | 1 | integer | ○ | メーカーID | - | 253 | - | - |
| 120 | name | 1 | string | - | メーカー名 | - | 大原 | - | - |
| 121 | name_kana | 1 | string | - | メーカー名かな | - | おおはら | - | - |
| 122 | full_name | 1 | string | - | メーカー名（詳細） | - | 大原薬品工業 | - | - |
| 123 | order | 1 | integer | ○ | 表示順 | - | 1 | - | - |
| 124 | categories | 1 | - | ○ | 薬カテゴリ情報 | - | - | - | - |
| 125 | chapter | 1 | - | - | チャプター情報 | - | - | - | - |
| 126 | id | 1 | - | ○ |
チャプターID ※DBのIDの為、動作環境毎に異なる |
- | 2 | - | - |
| 127 | name | 1 | - | ○ | チャプター名 | - | その他の循環器系薬剤 | - | - |
| 128 | category_level1 | 1 | - | - | 大カテゴリ情報 | - | - | - | - |
| 129 | id | 1 | - | ○ |
大カテゴリID ※DBのIDの為、動作環境毎に異なる |
- | 5 | - | - |
| 130 | name | 1 | - | ○ | 大カテゴリ名 | - | パーキンソン症候群治療薬 | - | - |
| 131 | category_level2 | 1 | - | - | 中カテゴリ情報 | - | - | - | - |
| 132 | id | 1 | - | ○ |
中カテゴリID ※DBのIDの為、動作環境毎に異なる |
- | 1 | - | - |
| 133 | name | 1 | - | ○ | 中カテゴリ名 | - | ドパミン前駆物質 | - | - |
| 134 | link | 1 | - | ○ | リンクタグ用パラメータ | - | A050205 | - | - |