家庭医学大全科API
病名検索API(name_search)
「家庭医学大全科」の病名を検索するAPIです。部分一致、よみがな検索、AND検索など様々な条件での検索が可能です。
リクエストURL
- XML
- /name_search.xml?[parameter]=[value]...
- JSON
- /name_search.json?[parameter]=[value]...
※APIを利用するには契約時に発行されるAPIキーをGETパラメータに加える必要があります。
リクエストパラメータ
パラメータ名 | 必須 | データタイプ | 説明 | 条件 | 初期値 |
---|---|---|---|---|---|
key | ○ | string | API利用キー | 有効なAPIキーを指定 | - |
q | ○ | string | 検索文字列 | UTF8エンコード済の文字列 部分一致検索の場合に限り、スペース区切りで複数キーワードに対応 最大10キーワード |
- |
limit | - | integer | 検索結果取得件数 | 1〜100までの数値 | 10 |
offset | - | string | 検索オフセット | 0〜999までの数値 | 0 |
type | - | string | 検索タイプ | b, p のいずれかを指定
|
p |
b_type | - | string | qパラメータに複数キーワード設定時の動作指定 | all, any のいずれかを指定
|
all |
target | - | string | 検索対象 | t, y, all のいずれかを指定
|
all |
sort | - | string | ソート順 | id, t, f, y のいずれかを指定
|
id |
inline_tag | - | boolean | インラインタグ(Linkタグ)の出現設定 | 0, 1 のいずれかを指定
|
0 |
レスポンスフィールド
ID | パラメータ名 | 出現回数 | データタイプ | 必須 | 説明 | 備考 | 例 | inline_tag |
---|---|---|---|---|---|---|---|---|
1 | results | 1 | - | ○ | レスポンスルートノード | - | - | - |
2 | api_version | 1 | integer | ○ | APIバージョン | - | 1.0 | - |
3 | results_available | 1 | integer | ○ | 全件数 | 対象はitemパラメータ | 150 | - |
4 | results_returned | 1 | integer | ○ | 取得件数 | 対象はitemパラメータ | 10 | - |
5 | results_offset | 1 | integer | ○ | 開始位置(オフセット値) | 対象はitemパラメータ | 0 | - |
6 | items | 1 | - | ○ | - | - | - | - |
7 | item | 複数回 | - | ○ | 取得項目情報 | 病気を内包 | - | - |
8 | disease | 1 | - | - | 病気情報 | - | - | - |
9 | id | 1 | integer | ○ | 病気ID | - | 040622000 | - |
10 | name | 1 | string | ○ | 病名 | - | 睡眠障害 | - |
11 | name_kana | 1 | string | ○ | 病名かな | - | すいみんしょうがい | - |
12 | name_foreign | 1 | string | ○ | 病名(英語) | - | Sleep disorder | - |
13 | parents | 1 | - | ○ | - | - | - | |
14 | parent | 複数回 | - | 所属元病気 | - | - | - | |
15 | id | 1 | integer | ○ | 病気ID | - | 040622000 | - |
16 | name | 1 | string | ○ | 病名 | - | 睡眠障害 | - |
17 | name_kana | 1 | string | ○ | 病名かな | - | すいみんしょうがい | - |
18 | name_foreign | 1 | string | ○ | 病名(英語) | - | Sleep disorder | - |
19 | children | 1 | - | ○ | - | - | - | |
20 | child | 複数回 | - | 所持している病気 | - | - | - | |
21 | id | 1 | integer | ○ | 病気ID | - | 040622000 | - |
22 | name | 1 | string | ○ | 病名 | - | 睡眠障害 | - |
23 | name_kana | 1 | string | ○ | 病名かな | - | すいみんしょうがい | - |
24 | name_foreign | 1 | string | ○ | 病名(英語) | - | Sleep disorder | - |
25 | body | 1 | - | - | 本文 | - | - | - |
26 | p | 複数回 | string | - | 本文段落 | XMLの場合、xml:space属性にて値「preserve」を指定 | 眠障害は、広く睡眠に関する病気全般を指す言葉で、夜間の睡眠が障害される.. | ○ |
27 | departments | 1 | - | ○ | 初診に適した診療科 | - | - | - |
28 | department | 複数回 | string | - | 診療科 | - | 精神科 | - |
29 | details | 1 | - | ○ | - | - | - | - |
30 | detail | 複数回 | - | - | 病気詳細情報 | - | - | - |
31 | title | 1 | string | ○ | 詳細名 | - | 治療の方法 | ○ |
32 | body | 1 | - | ○ | 詳細内容 | - | - | - |
33 | p | 複数回 | string | - | 詳細内容段落 | XMLの場合、xml:space属性にて値「preserve」を指定 | 疾患自体の効果的な治療方法は確立していないので、行動.. | ○ |
34 | columns | 1 | - | ○ | - | - | - | - |
35 | column | 複数回 | - | 病気からリンクしているコラム情報 | - | - | - | |
36 | id | 1 | string | ○ | コラムID | - | 010248C01 | - |
37 | name | 1 | string | ○ | コラム名 | - | フォン・ウィレブラント病 | ○ |
38 | body | 1 | string | - | コラム内容 | - | - | - |
39 | p | 複数回 | string | - | コラム内容段落 | XMLの場合、xml:space属性にて値「preserve」を指定 | フォン・ウィレブラント因子(VWF)は、出血箇所の障害血管内.. | ○ |
40 | images | 1 | - | ○ | - | - | - | - |
41 | image | 複数回 | - | - | コラム情報からリンクしている画像 | - | - | - |
42 | id | 1 | string | ○ | 画像ID | - | 010120000_01 | - |
43 | large | 1 | - | ○ | 大きいサイズの画像 | 縦/横とも、上限1000pixel | - | - |
44 | uri | 1 | string | ○ | 画像へのURI | - | - | |
45 | alt | 1 | string | ○ | キャプション | - | 表1 何となくおかしい(症状や検査所見を含めて) | - |
46 | width | 1 | integer | ○ | 画像の幅(pixel) | - | 1000 | - |
47 | height | 1 | integer | ○ | 画像の高さ(pixel) | - | 403 | - |
48 | content_type | 1 | string | ○ | 画像の種類 | - | image/jpeg | - |
49 | size | 1 | integer | ○ | 画像の容量(byte) | - | 152323 | - |
50 | sensitive_flg | 1 | integer | ○ | センシティブフラグ | 0 または 1 | 0 | - |
51 | small | 1 | - | ○ | 小さいサイズの画像 | 縦/横とも、上限200pixel | - | - |
52 | uri | 1 | string | ○ | 画像へのURI | - | - | |
53 | alt | 1 | string | ○ | キャプション | - | 表1 何となくおかしい(症状や検査所見を含めて) | - |
54 | width | 1 | integer | ○ | 画像の幅(pixel) | - | 200 | - |
55 | height | 1 | integer | ○ | 画像の高さ(pixel) | - | 81 | - |
56 | content_type | 1 | string | ○ | 画像の種類 | - | image/jpeg | - |
57 | size | 1 | integer | ○ | 画像の容量(byte) | - | 11386 | - |
58 | sensitive_flg | 1 | integer | ○ | センシティブフラグ | 0 または 1 | 0 | - |
59 | authors | 1 | - | ○ | - | - | - | - |
60 | author | 複数回 | - | ○ | 著者情報 | - | - | - |
61 | name | 1 | string | ○ | 著者名 | - | 浜松大学健康プロデュース学部心身マネジメント学科教授 | - |
62 | belongs | 1 | string | ○ | 所属 | - | 竹内修二 | - |
63 | images | 1 | - | ○ | - | - | - | - |
64 | image | 複数回 | - | - | コラム情報からリンクしている画像 | - | - | - |
65 | id | 1 | string | ○ | 画像ID | - | 010120000_01 | - |
66 | large | 1 | - | ○ | 大きいサイズの画像 | 縦/横とも、上限1000pixel | - | - |
67 | uri | 1 | string | ○ | 画像へのURI | - | - | |
68 | alt | 1 | string | ○ | キャプション | - | 表1 何となくおかしい(症状や検査所見を含めて) | - |
69 | width | 1 | integer | ○ | 画像の幅(pixel) | - | 1000 | - |
70 | height | 1 | integer | ○ | 画像の高さ(pixel) | - | 403 | - |
71 | content_type | 1 | string | ○ | 画像の種類 | - | image/jpeg | - |
72 | size | 1 | integer | ○ | 画像の容量(byte) | - | 152323 | - |
73 | sensitive_flg | 1 | integer | ○ | センシティブフラグ | 0 または 1 | 0 | - |
74 | small | 1 | - | ○ | 小さいサイズの画像 | 縦/横とも、上限200pixel | - | - |
75 | uri | 1 | string | ○ | 画像へのURI | - | - | |
76 | alt | 1 | string | ○ | キャプション | - | 表1 何となくおかしい(症状や検査所見を含めて) | - |
77 | width | 1 | integer | ○ | 画像の幅(pixel) | - | 200 | - |
78 | height | 1 | integer | ○ | 画像の高さ(pixel) | - | 81 | - |
79 | content_type | 1 | string | ○ | 画像の種類 | - | image/jpeg | - |
80 | size | 1 | integer | ○ | 画像の容量(byte) | - | 11386 | - |
81 | sensitive_flg | 1 | integer | ○ | センシティブフラグ | 0 または 1 | 0 | - |
82 | authors | 1 | - | ○ | - | - | - | - |
83 | author | 1 | - | ○ | 著者情報 | - | - | - |
84 | name | 1 | string | ○ | 著者名 | - | 浜松大学健康プロデュース学部心身マネジメント学科教授 | - |
85 | belongs | 1 | string | ○ | 所属 | - | 竹内修二 | - |