MedlinePlus Connect:网络服务
内容
- 网络服务概览
- 输出参数
- 请求诊断(问题)代码
- 可选参数
- 响应问题代码请求的选定 Atom 元素(或 JSON 对象)的描述
- 问题代码请求示例
- 相关服务和文件
- 药品信息请求
- 可选参数
- 响应药物请求的选定原子元素(或 JSON 对象)的描述
- 药品代码请求示例
- 实验室测试信息请求
- 可选参数
- 响应实验室测试请求的选定 Atom 元素(或 JSON 对象)的描述
- 实验室测试请求示例
- 可接受的使用政策
- 更多信息
MedlinePlus Connect 可用作 Web 应用程序或 Web 服务。以下是实现 Web 服务的技术细节,该服务响应基于以下条件的请求:
欢迎您链接并显示 MedlinePlus Connect 返回的数据。您不得将 MedlinePlus 页面复制到您的网站上。如果您使用来自 MedlinePlus Connect 网络服务的数据,请说明该信息来自 MedlinePlus.gov,但不要使用 MedlinePlus 标志或暗示 MedlinePlus 认可您的特定产品。请参阅 NLM 的 API 页面以获取进一步指导。有关如何在此服务之外链接到 MedlinePlus 内容的更多信息,请参阅我们的链接指南和说明。
如果您决定使用 MedlinePlus Connect,请注册电子邮件列表以跟上发展并与您的同事交流想法。请通过联系我们告诉我们您是否实施 MedlinePlus Connect。
网络服务概览
Web 服务请求的参数符合 HL7 Context-Aware Knowledge Retrieval (Infobutton) Knowledge Request URL-Based Implementation Guide。基于 REST 的响应符合 HL7 Context-Aware Knowledge Retrieval (Infobutton) Service-Oriented Architecture Implementation Guide。请求的输出可以是 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,请使用:
- 知识响应类型=应用程序/json
- 对于 JSONP,请使用:
- KnowledgeResponseType=application/javascript&callback=CallbackFunction 其中 CallbackFunction 是您为回调函数指定的名称。
- 对于 XML 格式的响应,请使用:
- KnowledgeResponseType=text/xml 或将knowledgeResponseType 参数保留在请求之外。
请求诊断(问题)代码
对于问题代码,MedlinePlus Connect 将返回来自 MedlinePlus 健康主题页面、遗传学页面或其他 NIH 研究所页面的链接和信息。
MedlinePlus Connect 将返回以下信息:
每个代码可能并不总是匹配。在这些情况下,MedlinePlus Connect 将返回空响应。
该服务的基本 URL 是:https://connect.medlineplus.gov/service
对此服务的任何查询都有两个必需的参数:
- 代码系统
确定您将使用的问题代码系统。- 对于 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%20uncontrolled&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=41381Cdnriteria.肺炎%20due%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&callback=CallbackFunction
相关服务和文件
要接收 MedlinePlus 健康主题以响应文本请求,而不是问题代码,请调查 MedlinePlus Web 服务。此外,如果您需要 XML 格式的全套 MedlinePlus 健康主题,请参阅我们的 XML 文件页面。
药品信息请求
当收到 RXCUI 时,MedlinePlus Connect 会提供最佳的药物信息匹配。它还在接收 NDC 代码时提供了良好的结果。 MedlinePlus Connect 可以提供英语或西班牙语回复。
对于英文药物信息的请求,如果您没有发送 NDC 或 RXCUI,或者如果我们根据代码发现没有匹配项,应用程序将使用您发送的文本字符串来显示最佳药物信息匹配项。对于西班牙药物信息请求,MedlinePlus Connect 仅响应 NDC 或 RXCUI,不使用文本字符串。有可能用英语回答但没有用西班牙语回答。
MedlinePlus Connect Web 服务将返回以下内容:
对一项药物请求可能有多种响应。每个请求可能并不总是匹配。在这些情况下,MedlinePlus Connect 将返回空响应。
对于药物信息请求,基本 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=Chantix 0.5 MG 口服片剂
可选参数
代码标题发送英文信息请求时,您可以包含药物名称的可选参数。这在上一节中有详细说明。 mainSearchCriteria.v.dn=Chantix 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 请求讲西班牙语的人的信息,您的请求应如下所示:https://connect.medlineplus.gov/service?mainSearchCriteria.v.cs=2.16.840.1.113883.6.69&mainSearchCriteria.vc=00310-0751- 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.c =zh
实验室测试信息请求
MedlinePlus Connect 在收到 LOINC 请求时提供与实验室测试信息的匹配。该服务可以提供英语或西班牙语的回复。
MedlinePlus Connect Web 服务将返回以下内容:
每个代码可能并不总是匹配。在这些情况下,MedlinePlus Connect 将返回空响应。
该服务的基本 URL 是:https://connect.medlineplus.gov/service
这是对此服务的任何实验室测试查询的两个必需参数:
- 代码系统
- 确定您使用的是 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.languageCode.c =zh
要请求讲西班牙语的人的信息,您的请求可能类似于以下内容之一: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.languageCode.c =es
可接受的使用政策
为了避免 MedlinePlus 服务器过载,NLM 要求 MedlinePlus Connect 的用户每个 IP 地址每分钟发送不超过 100 个请求。超过此限制的请求将不会得到服务,并且在 300 秒内或直到请求速率低于该限制(以较晚者为准)之前不会恢复服务。为了限制您发送到 Connect 的请求数量,NLM 建议将结果缓存 12-24 小时。
制定此政策是为了确保所有用户都可以使用和访问该服务。如果您有特定用例需要您向 MedlinePlus Connect 发送大量请求,从而超出本政策中概述的请求速率限制,请联系我们。 NLM 工作人员将评估您的请求并确定是否可以批准例外。另请查看 MedlinePlus XML 文件文档。这些 XML 文件包含完整的健康主题记录,可以作为访问 MedlinePlus 数据的替代方法。