MedlinePlus Connect: веб-сервис
Содержание
- Обзор веб-службы
- Выходные параметры
- Запросы диагностических (проблемных) кодов
- Дополнительные параметры
- Описание выбранных элементов Atom (или объектов JSON) в ответ на запросы кода проблемы
- Примеры запросов кодов проблем
- Связанные службы и файлы
- Запросы информации о лекарствах
- Дополнительные параметры
- Описание выбранных элементов Atom (или объектов JSON) в ответ на запросы лекарств
- Примеры запросов кодов лекарств
- Запросы информации о лабораторных испытаниях
- Дополнительные параметры
- Описание выбранных элементов Atom (или объектов JSON) в ответ на запросы лабораторных тестов
- Примеры запросов на лабораторные испытания
- Политика допустимого использования
- Больше информации
MedlinePlus Connect доступен в виде веб-приложения или веб-службы. Ниже приведены технические подробности реализации веб-службы, которая отвечает на запросы на основе:
Вы можете ссылаться на данные, возвращаемые MedlinePlus Connect, и отображать их. Вы не можете копировать страницы MedlinePlus на свой сайт. Если вы используете данные из веб-службы MedlinePlus Connect, пожалуйста, укажите, что информация взята с MedlinePlus.gov, но не используйте логотип MedlinePlus или иным образом подразумевайте, что MedlinePlus одобряет ваш конкретный продукт. Дополнительные инструкции см. На странице API NLM. Для получения дополнительной информации о том, как создавать ссылки на контент MedlinePlus за пределами этой службы, ознакомьтесь с нашими рекомендациями и инструкциями по созданию ссылок.
Если вы решите использовать MedlinePlus Connect, подпишитесь на рассылку, чтобы быть в курсе событий и обмениваться идеями с коллегами. Сообщите нам, применяете ли вы MedlinePlus Connect, связавшись с нами.
Обзор веб-службы
Параметры для запросов веб-службы соответствуют руководству по внедрению запроса знаний на основе URL-адреса HL7 Context-Aware Knowledge Retrieval (Infobutton). Ответ на основе REST соответствует руководству по реализации сервис-ориентированной архитектуры HL7 Context-Aware Knowledge Retrieval (Infobutton). Результатом запроса может быть XML в формате фида Atom, JSON или JSONP.
В структуре запроса указано, какой тип кода вы отправляете. Во всех случаях базовый 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 = application / 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.
Для любого запроса к этому сервису есть два обязательных параметра:
- Кодовая система
Определите систему кода проблемы, которую вы будете использовать.- Для МКБ-10-СМ используйте:
- mainSearchCriteria.v.cs = 2.16.840.1.113883.6.90
- Для МКБ-9-СМ используйте:
- 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, где может использоваться информация об имени / заголовке). mainSearchCriteria.v.dn = Сахарный диабет с неконтролируемым другим типом комы 1 См. выше раздел «Параметры вывода» для получения подробной информации о языке и форматах вывода.
Описание выбранных элементов Atom (или объектов JSON) в ответ на запросы кода проблемы
Элемент | Узел класса | Описание |
---|---|---|
заглавие | Заголовок соответствующей страницы темы здоровья MedlinePlus или страницы GHR | |
ссылка на сайт | URL-адрес соответствующей страницы темы здоровья MedlinePlus или страницы GHR | |
резюме | Полное резюме по теме здоровья. Сюда входят встроенные ссылки на другие соответствующие темы о здоровье и все форматирование, включая маркеры и интервалы между абзацами. Резюме в HTML. Для страниц GHR предоставляется первый раздел полной страницы. | |
резюме | Синонимы к теме. Они называются «также называемыми» на странице темы, посвященной здоровью. Не во всех темах есть термины «также называемые». | |
резюме | Подтверждение авторства краткого текста, если большая часть резюме была получена из другого федерального агентства. Не все резюме имеют указание авторства. Текст без указания атрибута является оригинальным для MedlinePlus. | |
резюме | Выбранные ссылки, связанные с темой. Это включает в себя имя страницы, URL-адрес и связанную организацию (если применимо). Ссылки представлены в виде маркированного списка. Эти ссылки есть не во всех темах. Количество ссылок может быть от нуля до десятков. |
Примеры запросов кодов проблем
Полный запрос на сахарный диабет с другой неконтролируемой комой типа 1, код по МКБ-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 = Диабет% 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
Пациенту был поставлен диагноз «Пневмония, вызванная Pseudomonas» с использованием кода SNOMED CT 41381004: https://connect.medlineplus.gov/service?mainSearchCriteria.v.cs=2.16.840.1.113883.6.96&mainSearchCriteria.vc=41381004&mainSearch=Criteria Пневмония% 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=applicationFallbackcallback=Callback=Cript
Связанные службы и файлы
Чтобы получать темы о здоровье MedlinePlus в ответ на текстовые запросы, а не коды проблем, изучите веб-службу MedlinePlus. Кроме того, если вам нужен полный набор тем о здоровье MedlinePlus в формате XML, см. Нашу страницу файлов XML.
Запросы информации о лекарствах
MedlinePlus Connect предоставляет наиболее точные сведения о лекарствах при получении RXCUI. Это также дает хорошие результаты при получении кода NDC. MedlinePlus Connect может предоставить ответы на английском или испанском языках.
Для запросов на информацию о лекарствах на английском языке, если вы не отправите NDC или RXCUI или если мы не найдем совпадения на основе кода, приложение будет использовать текстовую строку, которую вы отправляете, для отображения наилучшего совпадения информации о лекарстве. На запросы информации о лекарствах на испанском языке MedlinePlus Connect отвечает только на NDC или RXCUI и не использует текстовые строки. Можно получить ответ на английском языке, но нет ответа на испанском.
Веб-служба MedlinePlus Connect вернет следующее:
На один запрос лекарства может быть несколько ответов. Не всегда может быть соответствие каждому запросу. В таких случаях 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 = Чантикс 0,5 мг пероральная таблетка
Дополнительные параметры
Заголовок кодаОтправляя запрос на информацию на английском языке, вы можете указать необязательный параметр названия лекарства. Это подробно описано в предыдущем разделе. mainSearchCriteria.v.dn = Чантикс 0,5 мг пероральная таблетка
См. Выше раздел о параметрах вывода для получения подробной информации о языке и форматах вывода.
Описание выбранных элементов Atom (или объектов JSON) в ответ на запросы лекарств
Элемент | Описание |
---|---|
заглавие | Заголовок страницы соответствующего лекарства MedlinePlus |
ссылка на сайт | URL-адрес соответствующей страницы лекарств MedlinePlus |
автор | Указание источника информации о лекарствах |
Примеры запросов кодов лекарств
Ваш запрос информации о лекарствах должен выглядеть следующим образом.
Чтобы запросить информацию с помощью 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 = ru
Чтобы запросить у 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 = ru
Запросы информации о лабораторных испытаниях
MedlinePlus Connect предоставляет совпадения с информацией лабораторных испытаний при получении запроса LOINC. Служба может предоставить ответ на английском или испанском языках.
Веб-служба MedlinePlus Connect вернет следующее:
Не всегда может быть совпадение для каждого кода. В таких случаях 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 |
ссылка на сайт | URL-адрес соответствующей страницы лабораторного тестирования MedlinePlus |
резюме | Фрагмент из содержимого страницы |
автор | Атрибуция источника содержимого лабораторных тестов |
Примеры запросов на лабораторные испытания
Чтобы запросить информацию для англоговорящих, ваш запрос может выглядеть следующим образом: 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. = ru
Чтобы запросить информацию для говорящего по-испански, ваш запрос может выглядеть следующим образом: 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. = es
Политика допустимого использования
Чтобы избежать перегрузки серверов MedlinePlus, NLM требует, чтобы пользователи MedlinePlus Connect отправляли не более 100 запросов в минуту на каждый IP-адрес. Запросы, превышающие этот предел, не будут обслуживаться, и обслуживание не будет восстановлено в течение 300 секунд или до тех пор, пока частота запросов не упадет ниже лимита, в зависимости от того, что произойдет позже. Чтобы ограничить количество запросов, которые вы отправляете в Connect, NLM рекомендует кэшировать результаты на период от 12 до 24 часов.
Эта политика применяется для обеспечения доступности сервиса для всех пользователей. Если у вас есть конкретный вариант использования, который требует от вас отправки большого количества запросов в MedlinePlus Connect и, следовательно, превышения предела частоты запросов, указанного в этой политике, свяжитесь с нами. Персонал NLM оценит ваш запрос и определит, может ли быть предоставлено исключение. Также ознакомьтесь с документацией по XML-файлам MedlinePlus. Эти XML-файлы содержат полные записи о здоровье и могут служить альтернативным методом доступа к данным MedlinePlus.