MedlinePlus Connect: webdiens
Tevrede
- Webdiensoorsig
- Uitsetparameters
- Versoeke vir diagnosekodes
- Opsionele parameters
- Beskrywing van geselekteerde atoomelemente (of JSON-voorwerpe) in reaksie op probleemkodeversoeke
- Voorbeelde van versoeke vir probleemkodes
- Verwante dienste en lêers
- Versoeke om dwelminligting
- Opsionele parameters
- Beskrywing van geselekteerde atoomelemente (of JSON-voorwerpe) in antwoord op medisyneversoeke
- Voorbeelde van versoeke vir dwelmkodes
- Versoeke vir laboratoriumtoetsinligting
- Opsionele parameters
- Beskrywing van geselekteerde atoomelemente (of JSON-voorwerpe) in reaksie op laboratoriumtoetsversoeke
- Voorbeelde van versoeke vir laboratoriumtoetse
- Aanvaarbare gebruiksbeleid
- Meer inligting
MedlinePlus Connect is beskikbaar as 'n webtoepassing of webdiens. Hieronder is die tegniese besonderhede vir die implementering van die webdiens, wat reageer op versoeke gebaseer op:
U is welkom om die data wat deur MedlinePlus Connect teruggestuur word, te skakel en weer te gee. U mag nie MedlinePlus-bladsye na u webwerf kopieer nie. As u data van die MedlinePlus Connect-webdiens gebruik, moet u asseblief aandui dat die inligting van MedlinePlus.gov afkomstig is, maar nie die MedlinePlus-logo gebruik nie, of andersins impliseer dat MedlinePlus u spesifieke produk onderskryf. Raadpleeg die API-bladsy van NLM vir verdere leiding. Vir meer inligting oor hoe om na MedlinePlus-inhoud buite hierdie diens te skakel, sien ons riglyne en instruksies oor die skakel.
As u besluit om MedlinePlus Connect te gebruik, meld u aan vir die e-poslys om tred te hou met die ontwikkeling en idees met u kollegas uit te ruil. Vertel ons as u MedlinePlus Connect implementeer deur ons te kontak.
Webdiensoorsig
Die parameters vir die webdiensversoeke voldoen aan die HL7 Context-Aware Knowledge Retrieval (Infobutton) Knowledge Request URL-Based Implementation Guide. Die REST-gebaseerde reaksie is in ooreenstemming met die HL7 Context-Aware Knowledge Retrieval (Infobutton) Service-Oriented Architecture Implementation Guide. Die uitvoer van die versoek kan XML in die Atom-voerformaat, JSON, of JSONP wees.
Die struktuur van die versoek dui aan watter tipe kode u stuur. In alle gevalle is die basis-URL vir die webdiens: https://connect.medlineplus.gov/service
MedlinePlus Connect gebruik HTTPS-verbindings. HTTP-versoeke sal nie aanvaar word nie en bestaande implementasies wat HTTP gebruik, moet na HTTPS opgedateer word.
Uitsetparameters
Hierdie parameters is opsioneel. As u dit uitlaat, is die Engelse inligting in XML-formaat die verstekreaksie.
Taal
Identifiseer of u die antwoord in Engels of Spaans wil hê. MedlinePlus Connect aanvaar dat Engels die taal is as dit nie gespesifiseer word nie.
Gebruik die volgende: informationRecipient.languageCode.c = es as u wil reageer op die probleemkode in Spaans.
(= sp ook aanvaar)
Om Engels te spesifiseer, gebruik die volgende: informationRecipient.languageCode.c = af
Formaat
Identifiseer of u die antwoordformaat XML, JSON of JSONP wil hê. XML is die standaard.
- Om JSON aan te vra, gebruik:
- knowledgeResponseType = toepassing / json
- Gebruik vir JSONP:
- knowledgeResponseType = application / javascript & callback = CallbackFunction waar CallbackFunction 'n naam is wat u die terugbelfunksie gee.
- Gebruik 'n antwoord in XML:
- knowledgeResponseType = text / xml of laat die parameter knowledgeResponseType buite die versoek.
Versoeke vir diagnosekodes
Vir 'n probleemkode sal MedlinePlus Connect skakels en inligting terugstuur vanaf MedlinePlus-gesondheidsonderwerpbladsye, genetika-bladsye of bladsye van ander NIH-institute.
MedlinePlus Connect sal die volgende terugstuur:
Daar is miskien nie altyd 'n pasmaat vir elke kode nie. In daardie gevalle sal MedlinePlus Connect 'n nul-antwoord lewer.
Die basis-URL van die diens is: https://connect.medlineplus.gov/service
Daar is twee vereiste parameters vir enige navrae aan hierdie diens:
- Kodestelsel
Identifiseer die probleemkodesisteem wat u gaan gebruik.- Vir die gebruik van ICD-10-CM:
- mainSearchCriteria.v.cs = 2.16.840.1.113883.6.90
- Vir die gebruik van ICD-9-CM:
- mainSearchCriteria.v.cs = 2.16.840.1.113883.6.103
- Vir SNOMED CT gebruik:
- mainSearchCriteria.v.cs = 2.16.840.1.113883.6.96
- Kode
Identifiseer die werklike kode wat u probeer opsoek:
mainSearchCriteria.v.c = 250.33
Opsionele parameters
Kode titel
U kan ook die naam / titel van die probleemkode identifiseer. Hierdie inligting beïnvloed egter nie die reaksie nie (anders as die MedlinePlus Connect-webtoepassing waar die naam- / titelinligting gebruik kan word). mainSearchCriteria.v.dn = Diabetes mellitus met ander koma tipe 1 ongekontroleerd Sien die bostaande afdeling oor die uitvoerparameters vir besonderhede oor taal- en uitvoerformate.
Beskrywing van geselekteerde atoomelemente (of JSON-voorwerpe) in reaksie op probleemkodeversoeke
Element | Klasknoop | Beskrywing |
---|---|---|
titel | Titel van ooreenstemmende MedlinePlus-gesondheidsonderwerpbladsy of GHR-bladsy | |
skakel | URL vir ooreenstemmende MedlinePlus-gesondheidsonderwerpbladsy of GHR-bladsy | |
opsomming | Die volledige opsomming vir die gesondheidsonderwerp. Dit sluit in ingeboude skakels na ander relevante gesondheidsonderwerpe, en alle opmaak, insluitend kolpunte en paragraafafstand. Die opsomming is in HTML. Vir GHR-bladsye word die eerste gedeelte van die volledige bladsy verskaf. | |
opsomming | Sinonieme vir die onderwerp. Dit word op 'n gesondheidsonderwerpbladsy na verwys as 'Ook genoem'. Nie alle onderwerpe het terme "Ook genoem" nie. | |
opsomming | Erkenning van erkenning vir opsommende teks, as die meerderheid van die opsomming van 'n ander federale agentskap was. Nie alle opsommings het 'n toeskrywing nie. Ongeskrewe teks is oorspronklik van MedlinePlus. | |
opsomming | Geselekteerde skakels wat verband hou met die onderwerp. Dit sluit die bladsynaam, URL en gepaardgaande organisasie (indien van toepassing) in. Die skakels word in 'n kolpuntlys geformateer. Nie alle onderwerpe het hierdie skakels nie. Die aantal skakels kan wissel van nul tot dosyne. |
Voorbeelde van versoeke vir probleemkodes
'N Volledige versoek vir Diabetes Mellitus met 'n ander coma tipe 1, ICD-9-kode 250.33, vir 'n Spaanssprekende pasiënt het die volgende URL-adres: https://connect.medlineplus.gov/service?mainSearchCriteria.v.cs=2.16 .840.1.113883.6.103 & mainSearchCriteria.vc = 250.33 & mainSearchCriteria.v.dn = Diabetes% 20mellitus% 20met% 20other% 20coma% 20type% 201% 20onbeheerde & informationRecipient.languageCode.c = es
'N Pasiënt met dieselfde diagnose, maar die aangevraagde formaat, is JSON en die taal is Engels: https://connect.medlineplus.gov/service?mainSearchCriteria.v.cs=2.16.840.1.113883.6.103&mainSearchCriteria.vc=250.33&knowledgeResponseType=application / json
'N Pasiënt wat gediagnoseer is met' Longontsteking as gevolg van Pseudomonas 'met behulp van SNOMED CT-kode 41381004: https://connect.medlineplus.gov/service?mainSearchCriteria.v.cs=2.16.840.1.113883.6.96&mainSearchCriteria.vc=41381004&mainSearchCriteria.v.dn= Longontsteking% 20due% 20to% 20Pseudomonas% 20% 28disorder% 29 & informationRecipient.languageCode.c = af
'N Pasiënt met dieselfde diagnose, maar die gevraagde formaat, is 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
Verwante dienste en lêers
Om MedlinePlus-gesondheidsonderwerpe te ontvang in reaksie op teksversoeke, in teenstelling met probleemkodes, moet u die MedlinePlus-webdiens ondersoek. As u ook die volledige reeks MedlinePlus-gesondheidsonderwerpe in XML-formaat benodig, raadpleeg ons XML-lêersbladsy.
Versoeke om dwelminligting
MedlinePlus Connect bied die beste medisyne-inligting wat ooreenstem met die ontvangs van 'n RXCUI. Dit lewer ook goeie resultate as u 'n NDC-kode ontvang. MedlinePlus Connect kan antwoorde in Engels of Spaans lewer.
As u nie 'n NDC of RXCUI stuur nie, of as ons geen ooreenstemming op grond van die kode vind nie, sal die aansoek die teksstring wat u stuur, gebruik om die beste inligting vir dwelminligting te toon, indien u nie 'n NDC of RXCUI stuur nie. Vir versoeke vir Spaanse medisyne-inligting reageer MedlinePlus Connect slegs op NDC's of RXCUI's en gebruik dit nie teksstringe nie. Dit is moontlik om 'n antwoord in Engels te hê, maar geen antwoord in Spaans nie.
Die MedlinePlus Connect-webdiens lewer die volgende op:
Daar kan verskeie reaksies op een medisyneversoek wees. Daar is miskien nie altyd 'n wedstryd vir elke versoek nie. In daardie gevalle sal MedlinePlus Connect 'n nul-antwoord lewer.
Die basis-URL vir versoeke vir dwelminligting is: https://connect.medlineplus.gov/service
Sluit die volgende inligting in om 'n versoek te stuur:
- Kodestelsel
Identifiseer die tipe medikasiekode wat u stuur. (Vereis vir Engels en Spaans)- Vir RXCUI gebruik:
- mainSearchCriteria.v.cs = 2.16.840.1.113883.6.88
- Vir NDC gebruik:
- mainSearchCriteria.v.cs = 2.16.840.1.113883.6.69
- Kode
Identifiseer die werklike kode wat u probeer naslaan. (Voorkeur vir Engels, vereis vir Spaans)
mainSearchCriteria.v.c = 637188 - Dwelmsnaam
Identifiseer die naam van die middel met 'n teksstring. (Opsioneel vir Engels, word nie vir Spaans gebruik nie)
mainSearchCriteria.v.dn = Chantix 0,5 mg mondelinge tablet
Opsionele parameters
Kode titelAs u 'n versoek vir Engelse inligting stuur, kan u die opsionele parameter van die naam van die medikasie insluit. Dit word in die bostaande gedeelte uiteengesit. mainSearchCriteria.v.dn = Chantix 0,5 mg mondelinge tablet
Sien die bostaande afdeling oor die uitvoerparameters vir inligting oor taal- en uitvoerformate.
Beskrywing van geselekteerde atoomelemente (of JSON-voorwerpe) in antwoord op medisyneversoeke
Element | Beskrywing |
---|---|
titel | Titel vir ooreenstemmende MedlinePlus-medisyne-bladsy |
skakel | URL vir die ooreenstemmende MedlinePlus-medisyne-bladsy |
skrywer | Bron-toeskrywing vir medisyne-inligting |
Voorbeelde van versoeke vir dwelmkodes
U medisyne-inligtingsversoek moet soos een van die volgende lyk.
Om inligting deur 'n RXCUI aan te vra, moet u versoek so lyk: 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 Orale% 20 Tabel en inligting Ontvanger.taalkode.c = af
Om inligting deur 'n NDC vir 'n Spaansspreker aan te vra, moet u versoek so lyk: https://connect.medlineplus.gov/service?mainSearchCriteria.v.cs=2.16.840.1.113883.6.69&mainSearchCriteria.vc=00310-0751- 39 & inligtingRecipient.languageCode.c = es
Om 'n teksstring sonder medikasiekode te stuur, moet u u navraag identifiseer as 'n NDC-tipe versoek, sodat MedlinePlus Connect weet dat u medisyne-inligting soek. Dit sal slegs vir Engelse versoeke werk. U versoek kan so lyk: 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 = af
Versoeke vir laboratoriumtoetsinligting
MedlinePlus Connect bied ooreenstemmings met laboratoriumtoetsinligting wanneer 'n LOINC-versoek ontvang word. Die diens kan in Engels of Spaans reageer.
Die MedlinePlus Connect-webdiens lewer die volgende op:
Daar is miskien nie altyd 'n pasmaat vir elke kode nie. In daardie gevalle sal MedlinePlus Connect 'n nul-antwoord lewer.
Die basis-URL van die diens is: https://connect.medlineplus.gov/service
Dit is twee vereiste parameters vir enige laboratoriumtoetsnavrae aan hierdie diens:
- Kodestelsel
- Identifiseer dat u die LOINC-kodesisteem gebruik. Gebruik:
- mainSearchCriteria.v.cs = 2.16.840.1.113883.6.1
- MedlinePlus Connect aanvaar ook:
- mainSearchCriteria.v.cs = 2.16.840.1.113883.11.79
- Kode
identifiseer die werklike kode wat u probeer naslaan:
mainSearchCriteria.v.c = 3187-2
Opsionele parameters
Kode titelU kan ook die naam van die laboratoriumtoets identifiseer. Hierdie inligting beïnvloed egter nie die reaksie nie. mainSearchCriteria.v.dn = Faktor IX-toets
Sien die bostaande afdeling oor die uitvoerparameters vir inligting oor taal- en uitvoerformate.
Beskrywing van geselekteerde atoomelemente (of JSON-voorwerpe) in reaksie op laboratoriumtoetsversoeke
Element | Beskrywing |
---|---|
titel | Titel van ooreenstemmende MedlinePlus-laboratoriumtoetsbladsy |
skakel | URL vir ooreenstemmende MedlinePlus-laboratoriumtoetsbladsy |
opsomming | Stukkie uit die bladsyinhoud |
skrywer | Bron toekenning vir die laboratorium toetsinhoud |
Voorbeelde van versoeke vir laboratoriumtoetse
Om inligting vir 'n Engelssprekende aan te vra, kan u versoek soos een van die volgende lyk: 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 = nl https://connect.medlineplus.gov/service?mainSearchCriteria.v.cs=2.16.840.1.113883.6.1&mainSearchCriteria.vc=3187-2&informationRecipient.languageCode.c = af
Om inligting vir 'n Spaansspreker aan te vra, kan u versoek soos een van die volgende lyk: 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
Aanvaarbare gebruiksbeleid
Om oorbelasting van die MedlinePlus-bedieners te voorkom, vereis NLM dat gebruikers van MedlinePlus Connect nie meer as 100 versoeke per minuut per IP-adres moet stuur nie. Versoeke wat hierdie limiet oorskry, sal nie gediens word nie en die diens sal nie vir 300 sekondes herstel word of totdat die versoektarief onder die limiet val nie, wat ook al later kom. Om die aantal versoeke wat u aan Connect stuur, te beperk, beveel NLM cache-resultate aan vir 'n periode van 12-24 uur.
Hierdie beleid is ingestel om te verseker dat die diens beskikbaar en toeganklik bly vir alle gebruikers. As u 'n spesifieke gebruiksgeval het wat vereis dat u 'n groot aantal versoeke na MedlinePlus Connect moet stuur en dus die limiet vir die versoektarief wat in hierdie beleid uiteengesit word, oorskry, kontak ons asseblief. NLM-personeel sal u versoek evalueer en bepaal of 'n uitsondering toegestaan kan word. Lees ook die MedlinePlus XML-lêersdokumentasie. Hierdie XML-lêers bevat volledige gesondheidsonderwerprekords en kan dien as alternatiewe toegang tot MedlinePlus-data.