MedlinePlus Connect: вэб-служба

Задаволены

• Агляд вэб-службы
• Выхадныя параметры
• Запыты на коды дыягностыкі (праблемы)
• Дадатковыя параметры
• Апісанне выбраных элементаў атама (альбо аб'ектаў JSON) у адказ на запыты кода праблемы
• Прыклады запытаў на коды праблем
• Звязаныя паслугі і файлы
• Запыты на інфармацыю пра лекі
• Дадатковыя параметры
• Апісанне выбраных элементаў атама (альбо аб'ектаў JSON) у адказ на запыты на лекі
• Прыклады запытаў на коды наркотыкаў
• Запыты на інфармацыю аб лабараторных выпрабаваннях
• Дадатковыя параметры
• Апісанне выбраных элементаў атама (альбо аб'ектаў JSON) у адказ на запыты лабараторных выпрабаванняў
• Прыклады запытаў на лабараторныя тэсты
• Палітыка прымальнага выкарыстання
• Дадатковая інфармацыя

MedlinePlus Connect даступны як вэб-дадатак або вэб-сэрвіс. Ніжэй прыведзены тэхнічныя дэталі для рэалізацыі вэб-службы, якая адказвае на запыты на аснове:

Вы можаце зрабіць спасылку і адлюстраваць дадзеныя, вернутыя MedlinePlus Connect. Вы не можаце капіраваць старонкі MedlinePlus на свой сайт. Калі вы выкарыстоўваеце дадзеныя вэб-службы MedlinePlus Connect, калі ласка, укажыце, што інфармацыя паступае з MedlinePlus.gov, але не выкарыстоўвайце лагатып MedlinePlus альбо іншым чынам азначае, што MedlinePlus падтрымлівае ваш канкрэтны прадукт. Для атрымання дадатковых указанняў глядзіце старонку API NLM. Для атрымання дадатковай інфармацыі пра тое, як зрабіць спасылку на змест MedlinePlus па-за межамі гэтай службы, калі ласка, прачытайце нашы рэкамендацыі і інструкцыі па спасылцы.

Калі вы вырашыце выкарыстоўваць MedlinePlus Connect, падпішыцеся на спіс рассылання, каб ісці ў нагу з развіццём падзей і абменьвацца ідэямі з калегамі. Скажыце нам, калі вы рэалізуеце MedlinePlus Connect, звязаўшыся з намі.

Агляд вэб-службы

Параметры запытаў на вэб-паслугі адпавядаюць HL7 Context-Aware Knowledge Retrieval (Infobutton) Knowledge Request Кіраўніцтва па рэалізацыі на аснове URL. Адказ, заснаваны на REST, адпавядае кіраўніцтву па рэалізацыі арыентаванай на службу архітэктуры HL7 (Infobutton). Вынікам запыту можа быць XML у фармаце Atom feed, 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 = be

Фармат
Вызначце, калі вы хочаце, каб фармат адказу быў 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

Для любога запыту да гэтай службы ёсць два неабходныя параметры:

1. Кодавая сістэма
   Вызначце сістэму кода праблемы, якую вы будзеце выкарыстоўваць.

   Для выкарыстання па МКБ-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

2. Кодэкс
   Вызначце фактычны код, які вы спрабуеце знайсці:
   mainSearchCriteria.v.c = 250,33

Дадатковыя параметры

Назва кода
Вы таксама можаце вызначыць імя / загаловак кода праблемы. Аднак гэтая інфармацыя не ўплывае на рэакцыю (у адрозненне ад вэб-прыкладання MedlinePlus Connect, дзе можа выкарыстоўвацца інфармацыя пра імя / загаловак). mainSearchCriteria.v.dn = Цукровы дыябет з іншай некантралюемай комай тыпу 1 Глядзіце вышэй раздзел "Параметры вываду" для атрымання падрабязнай інфармацыі пра мову і фарматы вываду.

Апісанне выбраных элементаў атама (альбо аб'ектаў 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% 20с% 20астатнімі% 20coma% 20type% 201% 20uncontroll & 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

Пацыент з дыягназам "Пнеўманія з прычыны псевдомонады" з выкарыстаннем кода CT CT 41381004: https://connect.medlineplus.gov/service?mainSearchCriteria.v.cs=2.16.840.1.113883.6.96&mainSearchCriteria.vc=41381004&mainSearchCriteria.v.d. Пнеўманія% 20 да% 20 да% 20 псеўдаманады% 20% 28разлад% 29 & informationRecipient.languageCode.c = be

Пацыент з такім жа дыягназам, але запытаны фармат - JSONP: https://connect.medlineplus.gov/service?mainSearchCriteria.v.cs=2.16.840.1.113883.6.96&mainSearchCriteria.v.c=41381004&knowledgeResponseType=application/javascript&callback=CallbackFallbackCallback

Звязаныя паслугі і файлы

Каб атрымліваць тэмы здароўя 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

Каб адправіць запыт, уключыце наступную інфармацыю:

1. Сістэма кода
   Вызначце тып кода лекаў, які вы дасылаеце. (Патрабуецца для англійскай і іспанскай моў)
   

   Для выкарыстання RXCUI:

   mainSearchCriteria.v.cs = 2.16.840.1.113883.6.88

   Для выкарыстання NDC:

   mainSearchCriteria.v.cs = 2.16.840.1.113883.6.69

   MedlinePlus Connect таксама можа прымаць тэкставы радок для запытаў інфармацыі пра лекі на англійскай мове, але вы павінны паказаць, што шукаеце інфармацыю пра лекі, уключыўшы адну з дзвюх пералічаных вышэй сістэм кодаў.
2. Кодэкс
   Вызначце фактычны код, які вы спрабуеце знайсці. (Пераважная для англійскай, абавязковая для іспанскай)
   mainSearchCriteria.v.c = 637188
3. Назва лекі
   Вызначце назву прэпарата з дапамогай тэкставага радка. (Неабавязкова для англійскай мовы, не выкарыстоўваецца для іспанскай)
   mainSearchCriteria.v.dn = Пероральная таблетка Chantix 0,5 мг

Як мінімум, вы павінны вызначыць кодавую сістэму і код, альбо кодавую сістэму і назву прэпарата. Адпраўце ўсіх трох для дасягнення найлепшых вынікаў на англійскай мове. Адпраўце сістэму кодаў і код для іспанскіх запытаў.

Дадатковыя параметры

Назва кода

Адпраўляючы запыт на інфармацыю на англійскай мове, вы можаце ўключыць неабавязковы параметр назвы лекі. Гэта падрабязна апісана ў раздзеле вышэй. mainSearchCriteria.v.dn = Пероральная таблетка Chantix 0,5 мг

Падрабязную інфармацыю пра мову і фарматы вываду глядзіце ў раздзеле "Выхадныя параметры".

Апісанне выбраных элементаў атама (альбо аб'ектаў 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% 20Аральны% 20Таблетка і інфармацыяRecipient.languageCode.c = be

Каб запытаць інфармацыю з боку НДЦ для іспанамоўнага, ваш запыт павінен выглядаць так: 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 = en

Запыты на інфармацыю аб лабараторных выпрабаваннях

MedlinePlus Connect забяспечвае супадзенне інфармацыі з лабараторнымі тэстамі пры атрыманні запыту LOINC. Служба можа даць адказ на англійскай ці іспанскай мовах.

Вэб-служба MedlinePlus Connect верне наступнае:

Не заўсёды можа быць знойдзена адпаведнасць для кожнага кода. У гэтых выпадках MedlinePlus Connect верне нулявы адказ.

Базавы URL-адрас службы: https://connect.medlineplus.gov/service

Гэта два абавязковыя параметры для любога запыту лабараторнага тэсту да гэтай службы:

1. Сістэма кода
   

   Вызначце, што вы выкарыстоўваеце сістэму кодаў LOINC. Выкарыстанне:

   mainSearchCriteria.v.cs = 2.16.840.1.113883.6.1

   MedlinePlus Connect таксама прымае:

   mainSearchCriteria.v.cs = 2.16.840.1.113883.11.79

2. Кодэкс
   вызначыць фактычны код, які вы спрабуеце знайсці:
   mainSearchCriteria.v.c = 3187-2

Дадатковыя параметры

Назва кода

Вы таксама можаце вызначыць назву лабараторнага тэсту. Аднак гэтая інфармацыя не ўплывае на рэакцыю. mainSearchCriteria.v.dn = Аналіз фактару IX

Падрабязную інфармацыю пра мову і фарматы вываду глядзіце ў раздзеле "Выхадныя параметры".

Апісанне выбраных элементаў атама (альбо аб'ектаў 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 = be https://connect.medlineplus.gov/service?mainSearchCriteria.v.cs=2.16.840.1.113883.6.1&mainSearchCriteria.vc=3187-2&informationRecipient.languageuage. = 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.language. = эс

Палітыка прымальнага выкарыстання

Каб пазбегнуць перагрузкі сервераў MedlinePlus, NLM патрабуе, каб карыстальнікі MedlinePlus Connect адпраўлялі не больш за 100 запытаў у хвіліну на IP-адрас. Запыты, якія перавышаюць гэты ліміт, не будуць абслугоўвацца, і служба не будзе адноўлена на працягу 300 секунд альбо пакуль хуткасць запытаў не будзе ніжэйшай за ліміт, у залежнасці ад таго, што наступіць пазней. Каб абмежаваць колькасць запытаў, якія вы адпраўляеце ў Connect, NLM рэкамендуе вынікі кэшавання на працягу 12-24 гадзін.

Гэтая палітыка дзейнічае, каб гарантаваць, што паслуга застаецца даступнай і даступнай для ўсіх карыстальнікаў. Калі ў вас ёсць канкрэтны выпадак выкарыстання, які патрабуе ад вас вялікай колькасці запытаў у MedlinePlus Connect і, такім чынам, перавышэння абмежавання хуткасці запытаў, указанага ў гэтай палітыцы, звяжыцеся з намі. Персанал NLM ацэніць ваш запыт і вызначыць, ці можа быць прадастаўлена выключэнне. Таксама праглядзіце дакументацыю па файлах XML MedlinePlus. Гэтыя XML-файлы ўтрымліваюць поўныя запісы тэм пра здароўе і могуць служыць альтэрнатыўным спосабам доступу да дадзеных MedlinePlus.

Дадатковая інфармацыя