MedlinePlus Connect: spletna storitev
Vsebina
- Pregled spletnih storitev
- Izhodni parametri
- Zahteve za diagnostične kode (težave)
- Neobvezni parametri
- Opis izbranih atomskih elementov (ali objektov JSON) v odgovoru na zahteve za kodo težave
- Primeri zahtev za šifre problemov
- Povezane storitve in datoteke
- Zahteve za informacije o zdravilih
- Neobvezni parametri
- Opis izbranih atomskih elementov (ali predmetov JSON) v odgovoru na zahteve za zdravila
- Primeri zahtev za kodekse o drogah
- Zahteve za informacije o laboratorijskih testih
- Neobvezni parametri
- Opis izbranih atomskih elementov (ali objektov JSON) v odgovoru na zahteve za laboratorijski test
- Primeri zahtev za laboratorijske teste
- Pravilnik o sprejemljivi uporabi
- Več informacij
MedlinePlus Connect je na voljo kot spletna aplikacija ali spletna storitev. Spodaj so tehnične podrobnosti za izvajanje spletne storitve, ki se odziva na zahteve na podlagi:
Vabimo vas, da se povežete in prikažete podatke, ki jih vrne MedlinePlus Connect. Strani MedlinePlus ne smete kopirati na svojo spletno stran. Če uporabljate podatke iz spletne storitve MedlinePlus Connect, navedite, da gre za podatke iz MedlinePlus.gov, vendar ne uporabljajte logotipa MedlinePlus ali kako drugače pomeni, da MedlinePlus podpira vaš izdelek. Za nadaljnja navodila glejte stran API-ja NLM. Za več informacij o povezovanju z vsebino MedlinePlus zunaj te storitve si oglejte naše smernice in navodila za povezovanje.
Če se odločite za uporabo MedlinePlus Connect, se prijavite na e-poštni seznam, da boste sledili razvoju in izmenjali ideje s svojimi kolegi. Povejte nam, ali uporabljate MedlinePlus Connect, tako da nas kontaktirate.
Pregled spletnih storitev
Parametri za zahteve za spletne storitve so v skladu z vodnikom za izvajanje URL-ja za zahtevo po znanju HL7, ki temelji na kontekstu (Infobutton). Odgovor, ki temelji na REST, je v skladu s HL7 Priročnikom za izvajanje arhitekturno usmerjene arhitekture (Infobutton), ki temelji na kontekstu. Rezultat zahteve je lahko XML v obliki vira Atom, JSON ali JSONP.
Struktura zahteve označuje, katero vrsto kode pošiljate. V vseh primerih je osnovni URL spletne storitve: https://connect.medlineplus.gov/service
MedlinePlus Connect uporablja povezave HTTPS. Zahteve HTTP ne bodo sprejete, obstoječe izvedbe, ki uporabljajo HTTP, pa bi se morale posodobiti na HTTPS.
Izhodni parametri
Ti parametri niso obvezni. Če jih izpustite, so privzeti odgovori angleški podatki v obliki XML.
Jezik
Ugotovite, ali želite, da je odgovor v angleščini ali španščini. MedlinePlus Connect bo domneval, da je angleščina jezik, če ni določen.
Če želite, da je odgovor na iskanje kode težave v španščini, uporabite: informationRecipient.languageCode.c = es
(= tudi sp sprejeto)
Če želite določiti angleščino, uporabite naslednje: informationRecipient.languageCode.c = sl
Oblika
Ugotovite, ali želite, da je oblika odziva XML, JSON ali JSONP. Privzeti je XML.
- Če želite zahtevati JSON, uporabite:
- knowledgeResponseType = application / json
- Za JSONP uporabite:
- knowledgeResponseType = application / javascript & callback = CallbackFunction, kjer je CallbackFunction ime, ki mu daste funkcijo povratnega klica.
- Za odgovor v XML uporabite:
- knowledgeResponseType = text / xml ali pa pustite parameter knowledgeResponseType zunaj zahteve.
Zahteve za diagnostične kode (težave)
Za kodo težave bo MedlinePlus Connect vrnil povezave in informacije s strani s temami o zdravju MedlinePlus, strani z genetiko ali strani z drugih zavodov NIH.
MedlinePlus Connect bo vrnil naslednje:
Za vsako kodo se morda ne bo vedno ujemalo. V teh primerih bo MedlinePlus Connect vrnil ničelni odgovor.
Osnovni URL storitve je: https://connect.medlineplus.gov/service
Za vsako poizvedbo te storitve sta potrebna dva parametra:
- Sistem kod
Določite sistem s kodo težave, ki ga boste uporabljali.- Za uporabo ICD-10-CM:
- mainSearchCriteria.v.cs = 2.16.840.1.113883.6.90
- Za uporabo ICD-9-CM:
- mainSearchCriteria.v.cs = 2.16.840.1.113883.6.103
- Za uporabo SNOMED CT:
- mainSearchCriteria.v.cs = 2.16.840.1.113883.6.96
- Koda
Določite dejansko kodo, ki jo želite poiskati:
mainSearchCriteria.v.c = 250,33
Neobvezni parametri
Naslov kode
Prav tako lahko prepoznate ime / naslov kode težave. Vendar te informacije ne vplivajo na odziv (v nasprotju s spletno aplikacijo MedlinePlus Connect, kjer se lahko uporabljajo podatki o imenu / naslovu). mainSearchCriteria.v.dn = Sladkorna bolezen z nekontrolirano drugo komo tipa 1 Za podrobnosti o jeziku in izhodnih oblikah glejte zgornji razdelek o izhodnih parametrih.
Opis izbranih atomskih elementov (ali objektov JSON) v odgovoru na zahteve za kodo težave
Element | Vozlišče razreda | Opis |
---|---|---|
naslov | Naslov ujemajoče se strani z zdravstveno temo MedlinePlus ali strani GHR | |
povezava | URL za ujemajočo se temo zdravstvenega vprašanja MedlinePlus ali stran GHR | |
povzetek | Celoten povzetek za zdravstveno temo. To vključuje vdelane povezave do drugih ustreznih zdravstvenih tem in vse oblike, vključno z oznakami in presledki med odstavki. Povzetek je v HTML. Za strani GHR je na voljo prvi odsek celotne strani. | |
povzetek | Sopomenke za temo. Na strani z zdravstvenimi temami so omenjeni kot "Imenovani tudi". Vse teme nimajo izrazov, imenovanih tudi ». | |
povzetek | Potrdilo o dodeljevanju besedila povzetka, če je bila večina povzetka iz druge zvezne agencije. Vsi povzetki nimajo lastnosti. Besedilo brez dodeljevanja je izvirno za MedlinePlus. | |
povzetek | Izbrane povezave, povezane s temo. To vključuje ime strani, URL in povezano organizacijo (če je primerno). Povezave so oblikovane v označenem seznamu. Te povezave nimajo vseh tem. Število povezav se lahko giblje od nič do deset. |
Primeri zahtev za šifre problemov
Popolna zahteva za diabetes diabetes mellitus z drugo nenadzorovano komo tipa 1, koda ICD-9 250.33, za špansko govorečega pacienta bi imela naslednji URL naslov: https://connect.medlineplus.gov/service?mainSearchCriteria.v.cs=2.16 .840.1.113883.6.103 & mainSearchCriteria.vc = 250.33 & mainSearchCriteria.v.dn = Sladkorna bolezen% 20mellitus% 20z% 20ostalimi% 20koma% 20tip% 201% 20nenadzorovano & informationRecipient.languageCode.c = es
Pacient z enako diagnozo, vendar zahtevana oblika je JSON, jezik pa je angleščina: https://connect.medlineplus.gov/service?mainSearchCriteria.v.cs=2.16.840.1.113883.6.103&mainSearchCriteria.vc=250.33&knowledgeResponseType=application / json
Pacient z diagnozo "pljučnica zaradi psevdomonase" z uporabo kode SNOMED CT 41381004: https://connect.medlineplus.gov/service?mainSearchCriteria.v.cs=2.16.840.1.113883.6.96&mainSearchCriteria.vc=41381004&mainSearchCriteria.v.d. Pljučnica% 20du% 20to% 20Pseudomonas% 20% 28disorder% 29 & informationRecipient.languageCode.c = sl
Pacient z enako diagnozo, vendar zahtevana oblika je JSONP: https://connect.medlineplus.gov/service?mainSearchCriteria.v.cs=2.16.840.1.113883.6.96&mainSearchCriteria.v.c=41381004&knowledgeResponseType=application/javascript&callback=CallbackCallback
Povezane storitve in datoteke
Če želite v odgovor na besedilne zahteve v nasprotju s kodami težav prejemati zdravstvene teme MedlinePlus, raziščite spletno storitev MedlinePlus. Če potrebujete celoten sklop zdravstvenih tem MedlinePlus v obliki XML, si oglejte našo stran z datotekami XML.
Zahteve za informacije o zdravilih
MedlinePlus Connect zagotavlja najboljše informacije o zdravilih, ko prejmete RXCUI. Zagotavlja tudi dobre rezultate pri prejemu kode NDC. MedlinePlus Connect lahko nudi odgovore v angleškem ali španskem jeziku.
Če ne pošljete NDC ali RXCUI ali če na podlagi kode ne najdemo ujemanja, bo aplikacija za zahteve po angleških informacijah o zdravilih uporabila besedilni niz, ki ga boste poslali, za prikaz najboljšega ujemanja informacij o zdravilih. Na zahteve za informacije o španskih zdravilih se MedlinePlus Connect odziva samo na NDC ali RXCUI in ne uporablja besedilnih nizov. Odgovor je možen v angleščini, v španščini pa ne.
Spletna storitev MedlinePlus Connect bo vrnila naslednje:
Na eno zahtevo za zdravilo je lahko več odgovorov. Za vsako zahtevo se morda ne bo vedno ujemalo. V teh primerih bo MedlinePlus Connect vrnil ničelni odgovor.
Za zahteve po informacijah o zdravilih je osnovni URL: https://connect.medlineplus.gov/service
Če želite poslati zahtevo, vključite te podatke:
- Sistem kod
Določite vrsto kode zdravila, ki jo pošiljate. (Obvezno za angleščino in španščino)- Za uporabo RXCUI:
- mainSearchCriteria.v.cs = 2.16.840.1.113883.6.88
- Za uporabo NDC:
- mainSearchCriteria.v.cs = 2.16.840.1.113883.6.69
- Koda
Določite dejansko kodo, ki jo želite poiskati. (Zaželeno za angleščino, obvezno za španščino)
mainSearchCriteria.v.c = 637188 - Ime zdravila
Določite ime zdravila z besedilnim nizom. (Neobvezno za angleščino, ne uporablja se za španščino)
mainSearchCriteria.v.dn = Chantix 0,5 mg peroralna tableta
Neobvezni parametri
Naslov kodeKo pošiljate zahtevo za informacije v angleščini, lahko vključite neobvezni parameter imena zdravila. To je podrobno opisano v zgornjem poglavju. mainSearchCriteria.v.dn = Chantix 0,5 mg peroralna tableta
Za podrobnosti o jeziku in izhodnih formatih glejte zgornji razdelek o izhodnih parametrih.
Opis izbranih atomskih elementov (ali predmetov JSON) v odgovoru na zahteve za zdravila
Element | Opis |
---|---|
naslov | Naslov ujemajoče se strani z zdravili MedlinePlus |
povezava | URL ustrezne strani z zdravili MedlinePlus |
avtor | Dodelitev vira za informacije o zdravilih |
Primeri zahtev za kodekse o drogah
Zahteva za informacije o zdravilih bi morala izgledati takole.
Če želite zahtevati informacije s strani RXCUI, mora biti vaša zahteva videti tako: 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% 20Ustno% 20Tabela in informacijeRecipient.languageCode.c = sl
Če želite od NDC zahtevati informacije za špansko govorečega, mora biti vaša zahteva videti tako: https://connect.medlineplus.gov/service?mainSearchCriteria.v.cs=2.16.840.1.113883.6.69&mainSearchCriteria.vc=00310-0751- 39 & informationRecipient.languageCode.c = es
Če želite poslati besedilni niz brez kode zdravila, morate svojo poizvedbo označiti kot zahtevo tipa NDC, da bo MedlinePlus Connect vedel, da iščete informacije o zdravilu. To bo delovalo samo za zahteve v angleščini. Vaša zahteva bi lahko izgledala takole: 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
Zahteve za informacije o laboratorijskih testih
MedlinePlus Connect zagotavlja informacije o laboratorijskih testih, ko prejmete zahtevo LOINC. Storitev lahko odgovori v angleškem ali španskem jeziku.
Spletna storitev MedlinePlus Connect bo vrnila naslednje:
Za vsako kodo se morda ne bo vedno ujemalo. V teh primerih bo MedlinePlus Connect vrnil ničelni odgovor.
Osnovni URL storitve je: https://connect.medlineplus.gov/service
To sta dva zahtevana parametra za katero koli poizvedbo laboratorijske preizkusne storitve:
- Sistem kod
- Ugotovite, da uporabljate kodni sistem LOINC. Uporaba:
- mainSearchCriteria.v.cs = 2.16.840.1.113883.6.1
- MedlinePlus Connect bo sprejel tudi:
- mainSearchCriteria.v.cs = 2.16.840.1.113883.11.79
- Koda
določite dejansko kodo, ki jo želite poiskati:
mainSearchCriteria.v.c = 3187-2
Neobvezni parametri
Naslov kodeDoločite lahko tudi ime laboratorijskega testa. Vendar te informacije ne vplivajo na odziv. mainSearchCriteria.v.dn = Analiza faktorja IX
Za podrobnosti o jeziku in izhodnih formatih glejte zgornji razdelek o izhodnih parametrih.
Opis izbranih atomskih elementov (ali objektov JSON) v odgovoru na zahteve za laboratorijski test
Element | Opis |
---|---|
naslov | Naslov ujemajoče se preskusne strani MedlinePlus |
povezava | URL za ujemajočo se preskusno stran MedlinePlus |
povzetek | Delček iz vsebine strani |
avtor | Izvorno dodeljevanje vsebine laboratorijskega testa |
Primeri zahtev za laboratorijske teste
Če želite zahtevati informacije za angleško govorečega, je lahko vaša zahteva videti tako: 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 = sl https://connect.medlineplus.gov/service?mainSearchCriteria.v.cs=2.16.840.1.113883.6.1&mainSearchCriteria.vc=3187-2&informationRecipient.language. = en
Če želite zahtevati informacije za špansko govorečega, je lahko vaša zahteva videti tako: 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.languageuage. = es
Pravilnik o sprejemljivi uporabi
Da bi se izognili preobremenitvi strežnikov MedlinePlus, NLM zahteva, da uporabniki MedlinePlus Connect pošljejo največ 100 zahtev na minuto na naslov IP. Zahteve, ki presegajo to omejitev, ne bodo servisirane in storitev ne bo obnovljena 300 sekund ali dokler stopnja zahtev ne pade pod omejitev, kar nastopi pozneje. Če želite omejiti število zahtev, ki jih pošljete na Connect, NLM priporoča rezultate predpomnjenja za obdobje 12–24 ur.
Ta pravilnik je namenjen zagotavljanju, da bo storitev še naprej na voljo in dostopna vsem uporabnikom. Če imate poseben primer uporabe, ki zahteva, da na MedlinePlus Connect pošljete veliko število zahtev in tako presežete omejitev stopnje zahtev, opisano v tem pravilniku, se obrnite na nas. Uslužbenci NLM bodo ocenili vašo zahtevo in ugotovili, ali se lahko odobri izjema. Preglejte tudi dokumentacijo o datotekah MedlinePlus XML. Te datoteke XML vsebujejo popolne zapise o zdravstvenih temah in lahko služijo kot nadomestni način dostopa do podatkov MedlinePlus.