MedlinePlus Connect: Web Service

Inhalt

• Web Service Iwwersiicht
• Ausgabparameter
• Ufroe fir Diagnos (Problem) Coden
• Optional Parameteren
• Beschreiwung vun ausgewielten Atomelementer (oder JSON Objeten) als Äntwert op Problemcode Ufroen
• Beispiller vu Ufroen fir Probleemcoden
• Zesummenhang Servicer an Dateien
• Ufroe fir Drogeninformatioun
• Optional Parameteren
• Beschreiwung vun ausgewielten Atomelementer (oder JSON Objekter) als Äntwert op Medikamenterufroen
• Beispiller vu Ufroen fir Drogekoden
• Ufroe fir Labo Test Informatioun
• Optional Parameteren
• Beschreiwung vun ausgewielten Atomelementer (oder JSON Objekter) als Äntwert op Labo Test Ufroen
• Beispiller vu Ufroen fir Labo Tester
• Akzeptabel Benotzungspolitik
• Méi Informatioun

MedlinePlus Connect ass als Webapplikatioun oder Webdienst verfügbar. Hei drënner sinn d'technesch Detailer fir de Webservice z'implementéieren, deen op Ufroen äntwert baséiert op:

Dir sidd häerzlech wëllkomm op d'Donnéeë vum MedlinePlus Connect zréckzeginn an ze weisen. Dir däerft MedlinePlus Säiten net op Äre Site kopéieren. Wann Dir Daten aus dem MedlinePlus Connect Web Service benotzt, gitt weg datt d'Informatioun vu MedlinePlus.gov ass awer net de MedlinePlus Logo benotzt oder soss implizéiert datt MedlinePlus Äre bestëmmte Produkt ënnerstëtzt. Kuckt w.e.g. NLM's API Säit fir weider Guidance. Fir méi Informatioun wéi Dir mat MedlinePlus Inhalt ausserhalb vun dësem Service verlinkt, kuckt w.e.g. eis Richtlinnen an Instruktiounen iwwer d'Verknëppelen.

Wann Dir décidéiert MedlinePlus Connect ze benotzen, mellt Iech un fir d'E-Mail Lëscht fir mat Entwécklungen ze halen an Iddien mat Äre Kollegen auszetauschen. Sot eis w.e.g. wann Dir MedlinePlus Connect implementéiert andeems Dir eis kontaktéiert.

Web Service Iwwersiicht

D'Parameter fir d'Webservice Ufroen entspriechen dem HL7 Context-Aware Knowledge Retrieval (Infobutton) Knowledge Request URL-Based Implementation Guide. Déi REST-baséiert Äntwert entsprécht dem HL7 Context-Aware Knowledge Retrieval (Infobutton) Service-Oriented Architecture Implementation Guide. D'Ausgab vun der Ufro kann XML am Atom Feed Format, JSON oder JSONP sinn.

D'Struktur vun der Ufro weist un wéi ee Code Dir schéckt. An alle Fäll ass d'Basis URL fir de Web Service: https://connect.medlineplus.gov/service

MedlinePlus Connect benotzt HTTPS Verbindungen. HTTP Ufroen ginn net akzeptéiert an existent Implementéierungen mat HTTP sollten op HTTPS aktualiséieren.

Ausgabparameter

Dës Parameter sinn optional. Wann Dir se erausléisst, ass d'Standard Äntwert englesch Informatioun am XML Format.

Sprooch
Identifizéiert ob Dir wëllt datt d'Äntwert op Englesch oder Spuenesch ass. MedlinePlus Connect wäert unhuelen datt Englesch d'Sprooch ass wann se net spezifizéiert ass.

Wann Dir wëllt datt d'Äntwert op de Problemcode op Spuenesch ass, benotzt: informationRecipient.languageCode.c = es
(= sp och akzeptéiert)

Fir Englesch ze spezifizéieren, benotzt folgend: informationRecipient.languageCode.c = en

Formatéieren
Identifizéiert wann Dir wëllt datt d'Äntwertformat XML, JSON oder JSONP ass. XML ass de Standard.

Fir JSON ze froen, benotzt:

knowledgeResponseType = Uwendung / json

Fir JSONP benotzt:

knowledgeResponseType = Uwendung / Javascript & Réckruff = CallbackFunction wou CallbackFunction en Numm ass deen Dir de Réckruff Funktioun gitt.

Fir eng Äntwert am XML benotzt:

knowledgeResponseType = text / xml oder loosst de parameter parameterResponseType aus der Ufro eraus.

Ufroe fir Diagnos (Problem) Coden

Fir e Probleemcode gëtt MedlinePlus Connect Links a Informatioune vu MedlinePlus Gesondheetsthema Säiten, Genetik Säiten oder Säiten aus aneren NIH Instituter zréck.

MedlinePlus Connect wäert déi folgend zréckschécken:

Et kann net ëmmer e Match fir all Code sinn. An deene Fäll gëtt MedlinePlus Connect eng null Äntwert zréck.

D'Basis URL vum Service ass: https://connect.medlineplus.gov/service

Et ginn zwee erfuerderlech Parameter fir all Ufro un dësem Service:

1. Code System
   Identifizéiert de Problemcodesystem deen Dir benotzt.

   Fir ICD-10-CM benotzt:

   mainSearchCriteria.v.cs = 2.16.840.1.113883.6.90

   Fir ICD-9-CM benotzt:

   mainSearchCriteria.v.cs = 2.16.840.1.113883.6.103

   Fir SNOMED CT benotzt:

   mainSearchCriteria.v.cs = 2.16.840.1.113883.6.96

2. Code
   Identifizéiert den aktuelle Code deen Dir probéiert nozekucken:
   mainSearchCriteria.v.c = 250.33

Optional Parameteren

Code Titel
Dir kënnt och den Numm / Titel vum Probleemcode identifizéieren. Dës Informatioun beaflosst awer net d'Äntwert (am Géigesaz zu der MedlinePlus Connect Webapplikatioun wou den Numm / den Titel Informatioune kënne benotzt ginn). mainSearchCriteria.v.dn = Diabetis mellitus mat anerem Koma Typ 1 onkontrolléiert Kuckt déi uewe genannte Sektioun iwwer Ausgangsparameteren fir Detailer iwwer Sprooch an Ausgangsformater.

Beschreiwung vun ausgewielten Atomelementer (oder JSON Objeten) als Äntwert op Problemcode Ufroen

Element	Klass Node	Beschreiwung
Titel		Titel vun entspriechender MedlinePlus Gesondheetsthema Säit oder GHR Säit
Link		URL fir passend MedlinePlus Gesondheets Thematiksäit oder GHR Säit
Resumé		De komplette Resumé fir de Gesondheetsthema. Dëst beinhalt agebaute Linken op aner relevant Gesondheetsthemen, an all Formatéierung, och Kugelen a Paragrafabstand. De Resumé ass an HTML. Fir GHR Säiten ass déi éischt Sektioun vun der ganzer Säit.
Resumé		Synonyme fir d'Thema. Dës ginn als "Och genannt" bezeechent op enger Gesondheetsthema Säit. Net all Themen hunn "Och genannt" Begrëffer.
Resumé		Attributiounserkennung fir de Resumé Text, wann d'Majoritéit vum Resumé vun enger anerer federaler Agence war. Net all Zesummefaassungen hunn eng Attributioun. Onattributer Text ass originell zu MedlinePlus.
Resumé		Ausgewielte Linken déi mam Thema verbonne sinn. Dëst beinhalt de Säitennumm, URL an assoziéiert Organisatioun (wann zoutreffend). D'Links sinn an enger punktueller Lëscht formatéiert. Net all Themen hunn dës Linken. D'Zuel vun de Linken ka vu Null bis Dosende reichen.

Beispiller vu Ufroen fir Probleemcoden

Eng komplett Ufro fir Diabetis Mellitus mat aneren Koma Typ 1 onkontrolléiert, ICD-9 Code 250.33, fir e spueneschsproochege Patient hätt déi folgend URL Adress: https://connect.medlineplus.gov/service?mainSearchCriteria.v.cs=2.16 .840.1.113883.6.103 & mainSearchCriteria.vc = 250.33 & mainSearchCriteria.v.dn = Diabetis% 20mellitus% 20with% 20other% 20coma% 20type% 201% 20onkontrolléiert & informationRecipient.languageCode.c = es

E Patient mat der selwechter Diagnos awer dat gefrote Format ass JSON an d'Sprooch ass Englesch: https://connect.medlineplus.gov/service?mainSearchCriteria.v.cs=2.16.840.1.113883.6.103&mainSearchCriteria.vc=250.33&knowledgeResponseType=application / json

E Patient diagnostizéiert mat "Pneumonie wéinst Pseudomonas" mam SNOMED CT Code 41381004: https://connect.medlineplus.gov/service?mainSearchCriteria.v.cs=2.16.840.1.113883.6.96&mainSearchCriteria.vc=41381004&mainSearchCriteria.v.dn= Pneumonie% 20due% 20to% 20 Pseudomonas% 20% 28 Disorder% 29 & informationRecipient.languageCode.c = en

E Patient mat der selwechter Diagnos awer dat gefrote Format ass JSONP: https://connect.medlineplus.gov/service?mainSearchCriteria.v.cs=2.16.840.1.113883.6.96&mainSearchCriteria.v.c=41381004&knowledgeResponseType=application/javascript&callback=CallbackFallback

Zesummenhang Servicer an Dateien

Fir MedlinePlus Gesondheetsthemen als Äntwert op Textufroen ze kréien, am Géigesaz zu Probleemcoden, ermëttelt de MedlinePlus Web Service. Och wann Dir de komplette Set vu MedlinePlus Gesondheetsthemen am XML-Format braucht, kuckt eis XML Dateiesäit.

Ufroe fir Drogeninformatioun

MedlinePlus Connect bitt déi bescht Medikamentinformatiounsmatcher wann Dir en RXCUI kritt. Et bitt och gutt Resultater wann Dir en NDC Code kritt. MedlinePlus Connect kann Äntwerten op Englesch oder Spuenesch ubidden.

Fir Ufroen fir englesch Medikamenter Informatioun, wann Dir keen NDC oder RXCUI schéckt oder wa mir kee Match fannen op Basis vum Code, benotzt d'Applikatioun den Textstring deen Dir schéckt fir de beschten Droginformatiounsmatch ze weisen. Fir Ufroe fir spuenesch Medikamenterinformatioun reagéiert MedlinePlus Connect nëmmen op NDCen oder RXCUIen a benotzt keng Textstrings. Et ass méiglech eng Äntwert op Englesch ze hunn awer keng Äntwert op Spuenesch.

De MedlinePlus Connect Web Service bréngt déi folgend zréck:

Et kënne verschidde Äntwerten op eng Medikamenterufro sinn. Et kann net ëmmer e Match fir all Ufro sinn. An deene Fäll gëtt MedlinePlus Connect eng null Äntwert zréck.

Fir Ufroe fir Medikamentinformatioun ass d'Basis URL: https://connect.medlineplus.gov/service

Fir eng Ufro ze schécken, enthält dës Informatioun:

1. Code System
   Identifizéiert den Typ vu Medikamentcode deen Dir schéckt. (Néideg fir Englesch a Spuenesch)
   

   Fir RXCUI benotzt:

   mainSearchCriteria.v.cs = 2.16.840.1.113883.6.88

   Fir NDC benotzt:

   mainSearchCriteria.v.cs = 2.16.840.1.113883.6.69

   MedlinePlus Connect kann och en Textstring fir Ufroe fir Medikamenterinformatioun op Englesch akzeptéieren, awer Dir musst uginn datt Dir no Medikamenter Informatioun sicht andeems Dir ee vun deenen zwee uewe genannte Code Systemer enthält.
2. Code
   Identifizéiert den aktuelle Code deen Dir probéiert nozekucken. (Virgezunn fir Englesch, Néideg fir Spuenesch)
   mainSearchCriteria.v.c = 637188
3. Drogen Numm
   Identifizéiert den Numm vum Medikament mat enger Textstreng. (Optional fir Englesch, Net fir Spuenesch benotzt)
   mainSearchCriteria.v.dn = Chantix 0,5 MG Oral Tablet

Op e Minimum sollt Dir de Code System an de Code identifizéieren, oder de Code System an den Numm vum Medikament. Schéckt déi dräi fir bescht Resultater fir Englesch Ufroen. Schéckt de Codesystem an de Code fir spuenesch Ufroen.

Optional Parameteren

Code Titel

Wann Dir eng Ufro fir englesch Informatioun schéckt, kënnt Dir den optionalen Parameter vum Numm vum Medikament enthalen. Dëst ass detailléiert an der ueweger Sektioun. mainSearchCriteria.v.dn = Chantix 0,5 MG Oral Tablet

Kuckt den uewe genannten Abschnitt iwwer Ausgangsparameteren fir Detailer iwwer Sprooch an Ausgabeformater.

Beschreiwung vun ausgewielten Atomelementer (oder JSON Objekter) als Äntwert op Medikamenterufroen

Element	Beschreiwung
Titel	Titel fir passend MedlinePlus Medikamenter Säit
Link	URL fir déi passend MedlinePlus Medikamenter Säit
Auteur	Quell Attributioun fir Medikamenter Informatioun

Beispiller vu Ufroen fir Drogekoden

Är Medikamenter Informatiounsufro soll ausgesinn wéi ee vun de folgende.

Fir Informatioun vun engem RXCUI unzefroen, sollt Är Ufro esou ausgesinn: 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 Oral% 20 Tablet & informationRecipient.languageCode.c = en

Fir Informatioun vun engem NDC fir e spuenesche Spriecher ze froen, sollt Är Ufro esou ausgesinn: https://connect.medlineplus.gov/service?mainSearchCriteria.v.cs=2.16.840.1.113883.6.69&mainSearchCriteria.vc=00310-0751- 39 & informationRecipient.languageCode.c = es

Fir en Textstring ouni Medikamentercode ze schécken, musst Dir Är Ufro als NDC-Typ Ufro identifizéieren, sou datt MedlinePlus Connect weess datt Dir Medikamenter Informatioun sicht. Dëst funktionnéiert nëmme fir Englesch Ufroen. Är Ufro kéint esou ausgesinn: 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

Ufroe fir Labo Test Informatioun

MedlinePlus Connect bitt Matcher fir Labortestinformatiounen wann Dir eng LOINC Ufro kritt. De Service kann eng Äntwert op Englesch oder Spuenesch liwweren.

De MedlinePlus Connect Web Service bréngt déi folgend zréck:

Et kann net ëmmer e Match fir all Code sinn. An deene Fäll gëtt MedlinePlus Connect eng null Äntwert zréck.

D'Basis URL vum Service ass: https://connect.medlineplus.gov/service

Dëst sinn zwee erfuerderlech Parameter fir all Labo Test Ufro un dësem Service:

1. Code System
   

   Identifizéiert datt Dir de LOINC Code System benotzt. Benotzt:

   mainSearchCriteria.v.cs = 2.16.840.1.113883.6.1

   MedlinePlus Connect akzeptéiert och:

   mainSearchCriteria.v.cs = 2.16.840.1.113883.11.79

2. Code
   identifizéiert den aktuelle Code deen Dir probéiert nozekucken:
   mainSearchCriteria.v.c = 3187-2

Optional Parameteren

Code Titel

Dir kënnt och den Numm vum Labo Test identifizéieren. Dës Informatioun beaflosst awer net d'Äntwert. mainSearchCriteria.v.dn = Faktor IX Assay

Kuckt den uewe genannten Abschnitt iwwer Ausgabeparameter fir Detailer iwwer Sprooch an Ausgabformater.

Beschreiwung vun ausgewielten Atomelementer (oder JSON Objekter) als Äntwert op Labo Test Ufroen

Element	Beschreiwung
Titel	Titel vun ugepassten MedlinePlus Labo Test Säit
Link	URL fir passend MedlinePlus Labo Test Säit
Resumé	Snippet aus dem Säiteninhalt
Auteur	Quell Attributioun fir de Labo Test Inhalt

Beispiller vu Ufroen fir Labo Tester

Fir Informatioun fir en Englesche Spriecher unzefroen, kënnt Är Ufro ausgesäit wéi eng vun de folgenden: https://connect.medlineplus.gov/service?mainSearchCriteria.v.cs=2.16.840.1.113883.6.1&mainSearchCriteria.vc=3187-2&mainSearchCriteria. v.dn = Faktor% 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 = en

Fir Informatioun fir e spuenesche Spriecher ze froen, kann Är Ufro ausgesinn wéi eng vun de folgenden: https://connect.medlineplus.gov/service?mainSearchCriteria.v.cs=2.16.840.1.113883.6.1&mainSearchCriteria.vc=3187-2&mainSearchCriteria v.dn = Faktor% 20IX% 20 Assay & 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

Akzeptabel Benotzungspolitik

Fir ze vermeiden d'Iwwerbelaaschtung vun de MedlinePlus Serveren, erfuerdert NLM datt Benotzer vu MedlinePlus Connect net méi wéi 100 Ufroe pro Minutt pro IP Adress schécken. Ufroen, déi dës Limit iwwerschreiden, ginn net servéiert, an de Service gëtt net fir 300 Sekonne restauréiert oder bis den Ufroquote ënner der Limit fällt, jee nodeems. Fir d'Zuel vun Ufroen ze limitéieren déi Dir un Connect schéckt, recommandéiert NLM Cache Resultater fir eng 12-24 Stonn Period.

Dës Politik ass fir ze garantéieren datt de Service verfügbar bleift an zougänglech fir all Benotzer ass. Wann Dir e spezifesche Benotzungsfall hutt deen Iech erfuerdert eng grouss Unzuel u Ufroen un MedlinePlus Connect ze schécken, an domat d'Demandezuellimit an dëser Politik iwwerschratt, kontaktéiert eis w.e.g. NLM Mataarbechter evaluéieren Är Ufro a bestëmmen ob eng Ausnahm ka ginn. Kuckt och d'MedlinePlus XML Dateien Dokumentatioun. Dës XML Dateien enthalen komplett Gesondheetsthemen records a kënnen als alternativ Method fir Zougang zu MedlinePlus Daten ze déngen.

Méi Informatioun