MedlinePlus Connect: Web サービス
コンテンツ
- Web サービスの概要
- 出力パラメータ
- 診断要求 (問題) コード
- オプションのパラメータ
- 問題コードのリクエストに応じて選択された Atom 要素 (または JSON オブジェクト) の説明
- 問題コードのリクエスト例
- 関連サービスとファイル
- 医薬品情報の請求
- オプションのパラメータ
- 投薬リクエストに応じて選択された原子要素 (または JSON オブジェクト) の説明
- 医薬品コードのリクエストの例
- ラボ テスト情報のリクエスト
- オプションのパラメータ
- ラボ テスト リクエストに応じて選択された Atom 要素 (または JSON オブジェクト) の説明
- ラボテストのリクエスト例
- 利用規定
- 詳しくは
MedlinePlus Connect は、Web アプリケーションまたは Web サービスとして利用できます。以下に基づいてリクエストに応答する Web サービスを実装するための技術的な詳細を示します。
MedlinePlus Connect から返されたデータにリンクして表示することは大歓迎です。 MedlinePlus のページをサイトにコピーすることはできません。 MedlinePlus Connect Web サービスのデータを使用する場合は、その情報が MedlinePlus.gov からのものであることを示してください。ただし、MedlinePlus ロゴを使用したり、MedlinePlus が特定の製品を推奨していると暗示したりしないでください。詳細なガイダンスについては、NLM の API ページを参照してください。このサービス外の MedlinePlus コンテンツにリンクする方法の詳細については、リンクに関するガイドラインと手順をご覧ください。
MedlinePlus Connect を使用する場合は、メーリング リストにサインアップして、開発状況を把握し、同僚とアイデアを交換してください。 MedlinePlus Connect を実装しているかどうかについては、お問い合わせからお知らせください。
Web サービスの概要
Web サービス リクエストのパラメータは、HL7 Context-Aware Knowledge Retrieval (Infobutton) ナレッジ リクエスト URL ベースの実装ガイドに準拠しています。 REST ベースの応答は、HL7 Context-Aware Knowledge Retrieval (Infobutton) Service-Oriented Architecture 実装ガイドに準拠しています。要求の出力は、Atom フィード形式の XML、JSON、または JSONP にすることができます。
リクエストの構造は、送信するコードのタイプを示します。いずれの場合も、Web サービスのベース URL は https://connect.medlineplus.gov/service です。
MedlinePlus Connect は HTTPS 接続を使用します。 HTTP 要求は受け入れられず、HTTP を使用する既存の実装は HTTPS に更新する必要があります。
出力パラメータ
これらのパラメータはオプションです。それらを省略した場合、デフォルトの応答は XML 形式の英語情報です。
言語
応答を英語にするかスペイン語にするかを指定します。指定されていない場合、MedlinePlus Connect は英語が言語であると想定します。
問題コードのルックアップへの応答をスペイン語にする場合は、次を使用します: informationRecipient.languageCode.c=es
(=sp も可)
英語を指定するには、次を使用します: informationRecipient.languageCode.c=en
フォーマット
応答形式を XML、JSON、または JSONP のいずれにするかを指定します。 XML がデフォルトです。
- JSON を要求するには、次を使用します。
- KnowledgeResponseType=アプリケーション/json
- JSONP の場合、次を使用します。
- KnowledgeResponseType=application/javascript&callback=CallbackFunction ここで、CallbackFunction は、コールバック関数に付ける名前です。
- XML の応答には、次を使用します。
- KnowledgeResponseType=text/xml にするか、リクエストから KnowledgeResponseType パラメータを除外します。
診断要求 (問題) コード
問題コードの場合、MedlinePlus Connect は、MedlinePlus 健康トピック ページ、遺伝学ページ、または他の NIH 研究所のページからのリンクと情報を返します。
MedlinePlus Connect は以下を返します。
各コードが常に一致するとは限りません。そのような場合、MedlinePlus Connect は null 応答を返します。
サービスのベース URL は https://connect.medlineplus.gov/service です。
このサービスへのクエリには 2 つの必須パラメータがあります。
- コード体系
使用する問題コード システムを特定します。- ICD-10-CM の場合:
- mainSearchCriteria.v.cs=2.16.840.1.113883.6.90
- ICD-9-CM の使用の場合:
- mainSearchCriteria.v.cs=2.16.840.1.113883.6.103
- SNOMED CT の使用:
- mainSearchCriteria.v.cs=2.16.840.1.113883.6.96
- コード
調べようとしている実際のコードを特定します。
mainSearchCriteria.v.c=250.33
オプションのパラメータ
コードタイトル
問題コードの名前/タイトルを特定することもできます。ただし、この情報は応答に影響しません (名前/タイトル情報が使用される可能性のある MedlinePlus Connect Web アプリケーションとは異なります)。 mainSearchCriteria.v.dn=その他の昏睡タイプ 1 の糖尿病が制御されていない 言語および出力形式の詳細については、出力パラメータに関する上記のセクションを参照してください。
問題コードのリクエストに応じて選択された Atom 要素 (または JSON オブジェクト) の説明
素子 | クラスノード | 説明 |
---|---|---|
題名 | 一致した MedlinePlus 健康トピック ページまたは GHR ページのタイトル | |
リンク | 一致する MedlinePlus 健康トピック ページまたは GHR ページの URL | |
概要 | 健康トピックの完全な要約。これには、他の関連する健康トピックへの埋め込みリンク、および箇条書きや段落の間隔を含むすべての書式設定が含まれます。概要は HTML です。 GHR ページの場合、ページ全体の最初のセクションが提供されます。 | |
概要 | トピックの同義語。これらは、健康トピックのページでは「別名」とも呼ばれます。すべてのトピックに「別名」という用語があるわけではありません。 | |
概要 | 要約の大半が別の連邦機関からのものである場合、要約テキストの帰属の確認。すべての要約に属性があるわけではありません。属性のないテキストは MedlinePlus 独自のものです。 | |
概要 | トピックに関連する選択されたリンク。これには、ページ名、URL、関連する組織 (該当する場合) が含まれます。リンクは箇条書きでフォーマットされています。すべてのトピックにこれらのリンクがあるわけではありません。リンクの数は、ゼロから数十の範囲です。 |
問題コードのリクエスト例
スペイン語を話す患者に対する、他の昏睡タイプ 1 のコントロールされていない ICD-9 コード 250.33 の真性糖尿病の完全なリクエストには、次の URL アドレスが含まれます: https://connect.medlineplus.gov/service?mainSearchCriteria.v.cs=2.16 .840.1.113883.6.103&mainSearchCriteria.vc=250.33&mainSearchCriteria.v.dn=Diabetes%20mellitus%20with%20other%20coma%20type%201%20uncontrol&informationRecipient.languageCode.c=es
同じ診断の患者ですが、要求された形式は JSON で、言語は英語です: https://connect.medlineplus.gov/service?mainSearchCriteria.v.cs=2.16.840.1.113883.6.103&mainSearchCriteria.vc=250.33&knowledgeResponseType=application /json
SNOMED CTコード41381004を使用して「シュードモナスによる肺炎」と診断された患者:https://connect.medlineplus.gov/service?mainSearchCriteria.v.cs=2.16.840.1.113883.6.96&mainSearchCriteria.vc=41381dCriteria=肺炎%20%20to%20Pseudomonas%20%28disorder%29&informationRecipient.languageCode.c=en
同じ診断の患者ですが、要求された形式は JSONP です: https://connect.medlineplus.gov/service?mainSearchCriteria.v.cs=2.16.840.1.113883.6.96&mainSearchCriteria.v.c=41381004&knowledgeResponseType=application/javascript&callbackFunctionbackFunctionbackFunction
関連サービスとファイル
問題コードではなく、テキスト リクエストに応じて MedlinePlus ヘルス トピックを受信するには、MedlinePlus Web サービスを調査します。また、XML 形式の MedlinePlus 健康トピックの完全なセットが必要な場合は、XML ファイル ページを参照してください。
医薬品情報の請求
MedlinePlus Connect は、RXCUI を受信したときに、最適な医薬品情報を提供します。また、NDC コードを受信したときにも良好な結果が得られます。 MedlinePlus Connect は、英語またはスペイン語で回答できます。
英語の医薬品情報をリクエストする場合、NDC または RXCUI を送信しない場合、またはコードに基づいて一致するものが見つからない場合、アプリケーションは送信したテキスト文字列を使用して、最も一致する医薬品情報を表示します。スペインの医薬品情報のリクエストの場合、MedlinePlus Connect は NDC または RXCUI にのみ応答し、テキスト文字列は使用しません。英語での回答は可能ですが、スペイン語での回答はありません。
MedlinePlus Connect Web サービスは以下を返します。
1 つの投薬リクエストに対して複数の応答がある場合があります。リクエストごとに常に一致するとは限りません。そのような場合、MedlinePlus Connect は null 応答を返します。
医薬品情報のリクエストの場合、ベース URL は https://connect.medlineplus.gov/service です。
リクエストを送信するには、次の情報を含めます。
- コード体系
送信する投薬コードの種類を特定します。 (英語とスペイン語は必須)- RXCUI の場合:
- mainSearchCriteria.v.cs=2.16.840.1.113883.6.88
- NDC の使用:
- mainSearchCriteria.v.cs=2.16.840.1.113883.6.69
- コード
調べようとしている実際のコードを特定します。 (英語の場合は推奨、スペイン語の場合は必須)
mainSearchCriteria.v.c=637188 - 薬剤名
テキスト文字列で薬の名前を識別します。 (英語ではオプション、スペイン語では使用されません)
mainSearchCriteria.v.dn=チャンティックス 0.5 MG 経口錠剤
オプションのパラメータ
コードタイトル英語情報のリクエストを送信する場合、医薬品の名前のオプション パラメータを含めることができます。これについては、上記のセクションで詳しく説明しています。 mainSearchCriteria.v.dn=チャンティックス 0.5 MG 経口錠剤
言語と出力形式の詳細については、出力パラメータに関する上記のセクションを参照してください。
投薬リクエストに応じて選択された原子要素 (または JSON オブジェクト) の説明
素子 | 説明 |
---|---|
題名 | 一致する MedlinePlus 投薬ページのタイトル |
リンク | 一致した MedlinePlus 投薬ページの URL |
著者 | 投薬情報の出典の帰属 |
医薬品コードのリクエストの例
投薬情報のリクエストは、次のいずれかの形式である必要があります。
RXCUI で情報を要求するには、要求は次のようになります。 https://connect.medlineplus.gov/service?mainSearchCriteria.v.cs=2.16.840.1.113883.6.88&mainSearchCriteria.vc=637188&mainSearchCriteria.v.dn=Chantix% 200.5%20MG%20Oral%20Tablet&informationRecipient.languageCode.c=en
スペイン語話者の NDC による情報を要求するには、次のように要求する必要があります。 39&informationRecipient.languageCode.c=es
投薬コードのないテキスト文字列を送信するには、クエリを NDC タイプのリクエストとして識別する必要があります。これにより、MedlinePlus Connect は、投薬情報を探していることを認識します。これは英語のリクエストに対してのみ機能します。リクエストは次のようになります: https://connect.medlineplus.gov/service?mainSearchCriteria.v.cs=2.16.840.1.113883.6.69&mainSearchCriteria.v.dn=Chantix%200.5%20MG%20Oral%20Tablet&informationRecipient.languageCode. =en
ラボ テスト情報のリクエスト
MedlinePlus Connect は、LOINC リクエストを受信したときに、ラボ試験情報との一致を提供します。このサービスは、英語またはスペイン語で応答できます。
MedlinePlus Connect Web サービスは以下を返します。
各コードが常に一致するとは限りません。そのような場合、MedlinePlus Connect は null 応答を返します。
サービスのベース URL は https://connect.medlineplus.gov/service です。
これらは、このサービスに対するラボ テスト クエリの 2 つの必須パラメーターです。
- コード体系
- LOINC コード システムを使用していることを確認します。使用する:
- mainSearchCriteria.v.cs=2.16.840.1.113883.6.1
- MedlinePlus Connect は次のものも受け入れます。
- mainSearchCriteria.v.cs=2.16.840.1.113883.11.79
- コード
検索しようとしている実際のコードを特定します。
mainSearchCriteria.v.c=3187-2
オプションのパラメータ
コードタイトルラボテストの名前を特定することもできます。ただし、この情報は応答には影響しません。 mainSearchCriteria.v.dn=ファクター IX アッセイ
言語と出力形式の詳細については、出力パラメータに関する上記のセクションを参照してください。
ラボ テスト リクエストに応じて選択された Atom 要素 (または JSON オブジェクト) の説明
素子 | 説明 |
---|---|
題名 | 一致した MedlinePlus ラボ テスト ページのタイトル |
リンク | 一致した MedlinePlus ラボ テスト ページの URL |
概要 | ページ コンテンツのスニペット |
著者 | ラボ テスト コンテンツのソースの帰属 |
ラボテストのリクエスト例
英語話者の情報をリクエストする場合、リクエストは次のいずれかのようになります: https://connect.medlineplus.gov/service?mainSearchCriteria.v.cs=2.16.840.1.113883.6.1&mainSearchCriteria.vc=3187-2&mainSearchCriteria. v.dn=Factor%20IX%20assay&informationRecipient.languageCode.c=en https://connect.medlineplus.gov/service?mainSearchCriteria.v.cs=2.16.840.1.113883.6.1&mainSearchCriteria.vc=3187-2&informationRecipient.languageCodec. =en
スペイン語話者の情報をリクエストする場合、リクエストは次のいずれかのようになります: https://connect.medlineplus.gov/service?mainSearchCriteria.v.cs=2.16.840.1.113883.6.1&mainSearchCriteria.vc=3187-2&mainSearchCriteria. v.dn=Factor%20IX%20assay&informationRecipient.languageCode.c=es https://connect.medlineplus.gov/service?mainSearchCriteria.v.cs=2.16.840.1.113883.6.1&mainSearchCriteria.vc=3187-2&informationRecipient.languageCodec. =es
利用規定
MedlinePlus サーバーの過負荷を避けるために、NLM では、MedlinePlus Connect のユーザーが IP アドレスごとに 1 分あたり 100 を超えるリクエストを送信しないように要求しています。この制限を超えるリクエストは処理されず、300 秒間、またはリクエスト レートが制限を下回るまでのいずれか遅い方まで、サービスは復元されません。 Connect に送信するリクエストの数を制限するために、NLM は 12 ~ 24 時間の期間結果をキャッシュすることをお勧めします。
このポリシーは、サービスが引き続き利用可能であり、すべてのユーザーがアクセスできるようにするために設定されています。 MedlinePlus Connect に大量のリクエストを送信する必要がある特定のユース ケースがあり、そのためこのポリシーに記載されているリクエスト レート制限を超える場合は、お問い合わせください。 NLMのスタッフがあなたのリクエストを評価し、例外が認められるかどうかを判断します。 MedlinePlus XML ファイルのドキュメントも確認してください。これらの XML ファイルには、完全な健康トピック レコードが含まれており、MedlinePlus データにアクセスする代替方法として使用できます。