MedlinePlus Connect: webbtjänst
Innehåll
- Översikt över webbtjänster
- Utgångsparametrar
- Begäran om diagnos (problemkoder)
- Valfria parametrar
- Beskrivning av valda atomelement (eller JSON-objekt) i svar på problemkodförfrågningar
- Exempel på förfrågningar om problemkoder
- Relaterade tjänster och filer
- Begäran om läkemedelsinformation
- Valfria parametrar
- Beskrivning av valda atomelement (eller JSON-objekt) som svar på läkemedelsförfrågningar
- Exempel på begäranden om läkemedelskoder
- Begäran om labtestinformation
- Valfria parametrar
- Beskrivning av valda atomelement (eller JSON-objekt) som svar på laboratorietestförfrågningar
- Exempel på begäran om laboratorietester
- Policy för godtagbar användning
- Mer information
MedlinePlus Connect finns som webbapplikation eller webbtjänst. Nedan finns de tekniska detaljerna för implementering av webbtjänsten, som svarar på förfrågningar baserade på:
Du är välkommen att länka till och visa data som returneras av MedlinePlus Connect. Du får inte kopiera MedlinePlus-sidor till din webbplats. Om du använder data från MedlinePlus Connect webbtjänst, vänligen ange att informationen kommer från MedlinePlus.gov men använd inte MedlinePlus-logotypen eller på annat sätt antyd att MedlinePlus stöder din specifika produkt. Se NLM: s API-sida för ytterligare vägledning. För mer information om hur du länkar till MedlinePlus-innehåll utanför denna tjänst, se våra riktlinjer och instruktioner om länkning.
Om du väljer att använda MedlinePlus Connect kan du registrera dig för e-postlistan för att hålla koll på utvecklingen och utbyta idéer med dina kollegor. Berätta om du implementerar MedlinePlus Connect genom att kontakta oss.
Översikt över webbtjänster
Parametrarna för webbtjänstförfrågningar överensstämmer med HL7 Context-Aware Knowledge Retrieval (Infobutton) Knowledge Request URL-Based Implementation Guide. Det REST-baserade svaret överensstämmer med HL7 Context-Aware Knowledge Retrieval (Infobutton) Service-Oriented Architecture Implementation Guide. Utdata från begäran kan vara XML i Atom-feedformat, JSON eller JSONP.
Förfråganens struktur anger vilken typ av kod du skickar. I alla fall är webbadressen för webbtjänsten: https://connect.medlineplus.gov/service
MedlinePlus Connect använder HTTPS-anslutningar. HTTP-förfrågningar accepteras inte och befintliga implementeringar som använder HTTP bör uppdateras till HTTPS.
Utgångsparametrar
Dessa parametrar är valfria. Om du utelämnar dem är standardsvaret engelsk information i XML-format.
Språk
Identifiera om du vill att svaret ska vara på engelska eller spanska. MedlinePlus Connect antar att engelska är språket om det inte anges.
Om du vill att svaret på problemkodsuppslaget ska vara på spanska, använd: informationRecipient.languageCode.c = es
(= sp accepteras också)
För att specificera engelska, använd följande: informationRecipient.languageCode.c = sv
Formatera
Identifiera om du vill att svarsformatet ska vara XML, JSON eller JSONP. XML är standard.
- För att begära JSON, använd:
- knowledgeResponseType = application / json
- För JSONP, använd:
- knowledgeResponseType = application / javascript & callback = CallbackFunction där CallbackFunction är ett namn du ger återuppringningsfunktionen.
- För svar i XML, använd:
- knowledgeResponseType = text / xml eller lämna parametern knowledgeResponseType utanför begäran.
Begäran om diagnos (problemkoder)
För en problemkod returnerar MedlinePlus Connect länkar och information från MedlinePlus hälsotemasidor, genetikssidor eller sidor från andra NIH-institut.
MedlinePlus Connect returnerar följande:
Det kanske inte alltid är en matchning för varje kod. I dessa fall kommer MedlinePlus Connect att returnera ett null-svar.
Tjänstens grund-URL är: https://connect.medlineplus.gov/service
Det finns två parametrar som krävs för alla frågor till den här tjänsten:
- Kodsystem
Identifiera det problemkodsystem du ska använda.- För ICD-10-CM användning:
- mainSearchCriteria.v.cs = 2.16.840.1.113883.6.90
- För ICD-9-CM användning:
- mainSearchCriteria.v.cs = 2.16.840.1.113883.6.103
- För SNOMED CT-användning:
- mainSearchCriteria.v.cs = 2.16.840.1.113883.6.96
- Koda
Identifiera den faktiska koden som du försöker slå upp:
mainSearchCriteria.v.c = 250.33
Valfria parametrar
Kodtitel
Du kan också identifiera namnet / titeln på problemkoden. Denna information påverkar dock inte svaret (till skillnad från MedlinePlus Connect-webbapplikationen där namn / titelinformation kan användas). mainSearchCriteria.v.dn = Diabetes mellitus med annan koma typ 1 okontrollerad Se ovanstående avsnitt om utmatningsparametrar för information om språk och utdataformat.
Beskrivning av valda atomelement (eller JSON-objekt) i svar på problemkodförfrågningar
Element | Klassnod | Beskrivning |
---|---|---|
titel | Titel på matchad hälsoämnesida för MedlinePlus eller GHR-sida | |
länk | URL för matchad hälsoämnesida för MedlinePlus eller GHR-sida | |
sammanfattning | Den fullständiga sammanfattningen för hälsoämnet. Detta inkluderar inbäddade länkar till andra relevanta hälsoämnen och all formatering, inklusive kulor och avsnittsavstånd. Sammanfattningen är i HTML. För GHR-sidor finns det första avsnittet på hela sidan. | |
sammanfattning | Synonymer för ämnet. Dessa kallas "Också kallade" på en hälsoämnesida. Inte alla ämnen har "Även kallade" termer. | |
sammanfattning | Tillskrivningsbekräftelse för sammanfattande text, om majoriteten av sammanfattningen var från en annan federal myndighet. Inte alla sammanfattningar har en tillskrivning. Otillskriven text är original till MedlinePlus. | |
sammanfattning | Valda länkar kopplade till ämnet. Detta inkluderar sidnamnet, URL och tillhörande organisation (i tillämpliga fall). Länkarna är formaterade i en punktlista. Inte alla ämnen har dessa länkar. Antalet länkar kan variera från noll till dussintals. |
Exempel på förfrågningar om problemkoder
En fullständig begäran om diabetes mellitus med annan okontrollerad koma typ 1, ICD-9-kod 250.33, för en spansktalande patient skulle ha följande URL-adress: https://connect.medlineplus.gov/service?mainSearchCriteria.v.cs=2.16 .840.1.113883.6.103 & mainSearchCriteria.vc = 250.33 & mainSearchCriteria.v.dn = Diabetes% 20mellitus% 20med% 20other% 20coma 20 20typ% 201% 20 okontrollerad & informationRecipient.languageCode.c = es
En patient med samma diagnos men det önskade formatet är JSON och språket är engelska: https://connect.medlineplus.gov/service?mainSearchCriteria.v.cs=2.16.840.1.113883.6.103&mainSearchCriteria.vc=250.33&knowledgeResponseType=application / json
En patient diagnostiserad med "lunginflammation på grund av Pseudomonas" med SNOMED CT-kod 41381004: https://connect.medlineplus.gov/service?mainSearchCriteria.v.cs=2.16.840.1.113883.6.96&mainSearchCriteria.vc=41381004&mainSearchCriteria.v.dn= Lunginflammation% 20due% 20to% 20Pseudomonas% 20% 28disorder% 29 & informationRecipient.languageCode.c = sv
En patient med samma diagnos men det önskade formatet är 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
Relaterade tjänster och filer
För att få MedlinePlus-hälsoämnen som svar på textförfrågningar, i motsats till problemkoder, undersök MedlinePlus-webbtjänsten. Om du behöver den kompletta uppsättningen av MedlinePlus-hälsoämnen i XML-format, se vår XML-filsida.
Begäran om läkemedelsinformation
MedlinePlus Connect ger de bästa läkemedelsinformationsmatcherna när du får en RXCUI. Det ger också bra resultat när du tar emot en NDC-kod. MedlinePlus Connect kan ge svar på engelska eller spanska.
Om du inte skickar en NDC eller RXCUI eller om vi inte hittar någon matchning baserat på koden, kommer applikationen att använda den textsträng som du skickar för att visa den bästa läkemedelsinformationsmatchningen för förfrågningar om medicinsk information. För förfrågningar om spansk läkemedelsinformation svarar MedlinePlus Connect endast på NDC eller RXCUI och använder inte textsträngar. Det är möjligt att ha ett svar på engelska men inget svar på spanska.
Webbtjänsten MedlinePlus Connect returnerar följande:
Det kan finnas flera svar på en medicinförfrågan. Det kan inte alltid finnas en matchning för varje begäran. I dessa fall returnerar MedlinePlus Connect ett nollsvar.
För förfrågningar om läkemedelsinformation är basadressen: https://connect.medlineplus.gov/service
För att skicka en begäran, inkludera följande information:
- Kodsystem
Identifiera vilken typ av medicineringskod du skickar. (Krävs för engelska och spanska)- För RXCUI-användning:
- mainSearchCriteria.v.cs = 2.16.840.1.113883.6.88
- För NDC-användning:
- mainSearchCriteria.v.cs = 2.16.840.1.113883.6.69
- Koda
Identifiera den faktiska koden som du försöker slå upp. (Föredras för engelska, krävs för spanska)
mainSearchCriteria.v.c = 637188 - Läkemedelsnamn
Identifiera läkemedlets namn med en textsträng. (Valfritt för engelska, används inte för spanska)
mainSearchCriteria.v.dn = Chantix 0,5 mg oral tablett
Valfria parametrar
KodtitelNär du skickar en begäran om engelsk information kan du inkludera den valfria parametern för läkemedlets namn. Detta beskrivs i avsnittet ovan. mainSearchCriteria.v.dn = Chantix 0,5 mg oral tablett
Se avsnittet ovan om utmatningsparametrar för information om språk och utdataformat.
Beskrivning av valda atomelement (eller JSON-objekt) som svar på läkemedelsförfrågningar
Element | Beskrivning |
---|---|
titel | Titel för matchad medicinsk sida för MedlinePlus |
länk | URL för matchad MedlinePlus-läkemedelssida |
författare | Källtillskrivning för information om läkemedel |
Exempel på begäranden om läkemedelskoder
Din läkemedelsinformationsförfrågan ska se ut som något av följande.
För att begära information från en RXCUI ska din förfrågan se ut så här: 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 Oralt% 20 Tabell & information Mottagare. Språk Code.c = sv
För att begära information från en NDC för en spansktalande ska din begäran se ut så här: https://connect.medlineplus.gov/service?mainSearchCriteria.v.cs=2.16.840.1.113883.6.69&mainSearchCriteria.vc=00310-0751- 39 & informationRecipient.languageCode.c = es
För att skicka en textsträng utan medicineringskod måste du identifiera din fråga som en NDC-typförfrågan så att MedlinePlus Connect vet att du letar efter medicininformation. Detta fungerar endast för engelska förfrågningar. Din begäran kan se ut så här: 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 = sv
Begäran om labtestinformation
MedlinePlus Connect tillhandahåller matchningar med laboratorietestinformation när du får en LOINC-begäran. Tjänsten kan ge svar på engelska eller spanska.
Webbtjänsten MedlinePlus Connect returnerar följande:
Det kanske inte alltid är en matchning för varje kod. I dessa fall returnerar MedlinePlus Connect ett nollsvar.
Tjänstens grund-URL är: https://connect.medlineplus.gov/service
Dessa är två nödvändiga parametrar för alla laboratorietestfrågor till den här tjänsten:
- Kodsystem
- Identifiera att du använder LOINC-kodsystemet. Använda sig av:
- mainSearchCriteria.v.cs = 2.16.840.1.113883.6.1
- MedlinePlus Connect accepterar också:
- mainSearchCriteria.v.cs = 2.16.840.1.113883.11.79
- Koda
identifiera den faktiska koden du försöker slå upp:
mainSearchCriteria.v.c = 3187-2
Valfria parametrar
KodtitelDu kan också identifiera namnet på laboratorietestet. Denna information påverkar dock inte svaret. mainSearchCriteria.v.dn = Faktor IX-analys
Se avsnittet ovan om utmatningsparametrar för information om språk och utdataformat.
Beskrivning av valda atomelement (eller JSON-objekt) som svar på laboratorietestförfrågningar
Element | Beskrivning |
---|---|
titel | Titel på matchad MedlinePlus-testsida |
länk | URL för matchad MedlinePlus-testsida |
sammanfattning | Utdrag från sidinnehållet |
författare | Källtillskrivning för laboratorietestens innehåll |
Exempel på begäran om laboratorietester
För att begära information för en engelsktalande kan din förfrågan se ut som något av följande: 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 = sv https://connect.medlineplus.gov/service?mainSearchCriteria.v.cs=2.16.840.1.113883.6.1&mainSearchCriteria.vc=3187-2&informationRecipient.languageCode.c = sv
För att begära information för en spansktalande kan din begäran se ut som något av följande: 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 = es https://connect.medlineplus.gov/service?mainSearchCriteria.v.cs=2.16.840.1.113883.6.1&mainSearchCriteria.vc=3187-2&informationRecipient.languageCode.c = es
Policy för godtagbar användning
För att undvika överbelastning av MedlinePlus-servrarna kräver NLM att användare av MedlinePlus Connect inte skickar mer än 100 förfrågningar per minut per IP-adress. Förfrågningar som överskrider denna gräns kommer inte att betjänas och tjänsten återställs inte under 300 sekunder eller förrän begärandegraden faller under gränsen, beroende på vilket som kommer senare. För att begränsa antalet förfrågningar som du skickar till Connect rekommenderar NLM cachningsresultat under en 12-24 timmarsperiod.
Denna policy finns för att säkerställa att tjänsten förblir tillgänglig och tillgänglig för alla användare. Om du har ett specifikt användningsfall som kräver att du skickar ett stort antal förfrågningar till MedlinePlus Connect och därmed överskrider den begärandegräns som anges i denna policy, vänligen kontakta oss. NLM-personal kommer att utvärdera din begäran och avgöra om ett undantag kan beviljas. Läs också dokumentationen för MedlinePlus XML-filer. Dessa XML-filer innehåller fullständiga hälsoämnesregister och kan fungera som en alternativ metod för åtkomst till MedlinePlus-data.