MedlinePlus Connect: Web usluga
Sadržaj
- Pregled web usluga
- Izlazni parametri
- Zahtjevi za kodove dijagnoze (problema)
- Izborni parametri
- Opis odabranih atomskih elemenata (ili JSON objekata) u odgovoru na zahtjeve koda problema
- Primjeri zahtjeva za šifre problema
- Povezane usluge i datoteke
- Zahtjevi za informacijama o lijekovima
- Izborni parametri
- Opis odabranih atomskih elemenata (ili JSON objekata) u odgovoru na zahtjeve za lijekovima
- Primjeri zahtjeva za kodovima lijekova
- Zahtjevi za informacijama o laboratorijskim testovima
- Izborni parametri
- Opis odabranih atomskih elemenata (ili JSON objekata) u odgovoru na zahtjeve za laboratorijskim ispitivanjem
- Primjeri zahtjeva za laboratorijske testove
- Politika prihvatljive upotrebe
- Više informacija
MedlinePlus Connect dostupan je kao web aplikacija ili web usluga. Ispod su tehnički detalji za implementaciju web usluge koja odgovara na zahtjeve na osnovu:
Dobrodošli ste da povežete i prikažete podatke koje vraća MedlinePlus Connect. Ne možete kopirati stranice MedlinePlus na svoju stranicu. Ako koristite podatke s web usluge MedlinePlus Connect, navedite da su informacije s MedlinePlus.gov, ali ne koristite MedlinePlus logotip ili na drugi način implicirajte da MedlinePlus odobrava vaš određeni proizvod. Molimo pogledajte NLM-ovu API stranicu za dalja uputstva. Za više informacija o načinu povezivanja na sadržaj MedlinePlus izvan ove usluge, pogledajte naše smjernice i upute za povezivanje.
Ako se odlučite za MedlinePlus Connect, prijavite se na listu e-pošte kako biste pratili razvoj i razmjenjivali ideje sa svojim kolegama. Recite nam da li implementirate MedlinePlus Connect tako što ćete nas kontaktirati.
Pregled web usluga
Parametri za zahtjeve za web uslugom u skladu su s HL7 Vodičem za implementaciju na osnovu zahtjeva za znanjem (Infobutton) zahtjeva za znanjem HL7. Odgovor zasnovan na REST-u usklađen je s HL7 Vodičem za implementaciju orijentirane na uslugu orijentiranog na znanje o kontekstu (Infobutton). Izlaz zahtjeva može biti XML u formatu Atom feeda, JSON ili JSONP.
Struktura zahtjeva označava koju vrstu koda šaljete. U svim slučajevima, osnovni URL web usluge je: https://connect.medlineplus.gov/service
MedlinePlus Connect koristi HTTPS veze. HTTP zahtjevi neće biti prihvaćeni i postojeće implementacije koje koriste HTTP trebaju se ažurirati na HTTPS.
Izlazni parametri
Ovi parametri nisu obavezni. Ako ih izostavite, zadani odgovor su informacije na engleskom u XML formatu.
Jezik
Odredite želite li da odgovor bude na engleskom ili španskom jeziku. MedlinePlus Connect će pretpostaviti da je engleski jezik jezik ako nije naveden.
Ako želite da odgovor na traženje koda problema bude na španjolskom, upotrijebite: informationRecipient.languageCode.c = es
(= prihvaćen je i sp)
Da biste odredili engleski, koristite sljedeće: informationRecipient.languageCode.c = hr
Format
Utvrdite želite li da format odgovora bude XML, JSON ili JSONP. Zadani je XML.
- Da biste zatražili JSON, koristite:
- knowledgeResponseType = application / json
- Za JSONP koristite:
- knowledgeResponseType = application / javascript & callback = CallbackFunction gdje je CallbackFunction ime koje dajete funkciju povratnog poziva.
- Za odgovor u XML-u koristite:
- knowledgeResponseType = tekst / xml ili ostavite parametar knowledgeResponseType izvan zahtjeva.
Zahtjevi za kodove dijagnoze (problema)
Za kôd problema, MedlinePlus Connect vratit će veze i informacije sa stranica s temama o zdravlju MedlinePlus, genetičkih stranica ili stranica s drugih NIH instituta.
MedlinePlus Connect vratit će sljedeće:
Ne može uvijek biti podudaranja za svaki kod. U tim će slučajevima MedlinePlus Connect vratiti null odgovor.
Osnovni URL usluge je: https://connect.medlineplus.gov/service
Postoje dva potrebna parametra za bilo koji upit ove usluge:
- Sistem koda
Odredite sistem s kodom problema koji ćete koristiti.- Za upotrebu ICD-10-CM:
- mainSearchCriteria.v.cs = 2.16.840.1.113883.6.90
- Za upotrebu ICD-9-CM:
- mainSearchCriteria.v.cs = 2.16.840.1.113883.6.103
- Za SNOMED CT upotrebu:
- mainSearchCriteria.v.cs = 2.16.840.1.113883.6.96
- Kod
Identificirajte stvarni kod koji pokušavate potražiti:
mainSearchCriteria.v.c = 250.33
Izborni parametri
Naslov koda
Također možete identificirati ime / naslov šifre problema. Međutim, ove informacije ne utječu na odgovor (za razliku od MedlinePlus Connect web aplikacije u kojoj se mogu koristiti podaci o imenu / naslovu). mainSearchCriteria.v.dn = Dijabetes melitus sa drugom nekontrolisanom komom tipa 1 Pogledajte gornji odjeljak o izlaznim parametrima za detalje o jeziku i izlaznim formatima.
Opis odabranih atomskih elemenata (ili JSON objekata) u odgovoru na zahtjeve koda problema
Element | Čvor klase | Opis |
---|---|---|
naslov | Naslov odgovarajuće stranice zdravstvene teme MedlinePlus ili GHR stranice | |
veza | URL za podudarnu stranicu zdravstvene teme MedlinePlus ili GHR stranicu | |
sažetak | Cjelovit sažetak za zdravstvenu temu. To uključuje ugrađene veze na druge relevantne zdravstvene teme i svo oblikovanje, uključujući nabrajanje i razmake između odlomaka. Sažetak je u HTML-u. Za GHR stranice pruža se prvi odjeljak cijele stranice. | |
sažetak | Sinonimi za temu. Oni se na stranici sa zdravstvenim temama nazivaju "Također se nazivaju". Nisu sve teme izraze "Također se nazivaju". | |
sažetak | Potvrda o dodjeli za sažeti tekst, ako je većina sažetka bila iz druge savezne agencije. Nemaju svi sažeci atribuciju. Neatribuirani tekst originalan je za MedlinePlus. | |
sažetak | Odabrani linkovi povezani s temom. To uključuje naziv stranice, URL i povezanu organizaciju (ako je primjenjivo). Veze su formatirane na popisu s grafičkim oznakama. Nemaju sve teme ove veze. Broj veza može se kretati od nule do desetina. |
Primjeri zahtjeva za šifre problema
Potpuni zahtjev za dijabetes melitus s nekom nekontroliranom komom tipa 1, ICD-9 kod 250.33, za pacijenta koji govori španjolski imao bi sljedeću URL adresu: https://connect.medlineplus.gov/service?mainSearchCriteria.v.cs=2.16 .840.1.113883.6.103 & mainSearchCriteria.vc = 250.33 & mainSearchCriteria.v.dn = Dijabetes% 20mellitus% 20od% 20koma% 20tip% 201% 20nekontrolisano i informationRecipient.languageCode.c = es
Pacijent s istom dijagnozom, ali traženi format je JSON, a jezik je engleski: https://connect.medlineplus.gov/service?mainSearchCriteria.v.cs=2.16.840.1.113883.6.103&mainSearchCriteria.vc=250.33&knowledgeResponseType=application / json
Pacijent s dijagnozom "Upala pluća zbog pseudomonase" pomoću SNOMED CT koda 41381004: https://connect.medlineplus.gov/service?mainSearchCriteria.v.cs=2.16.840.1.113883.6.96&mainSearchCriteria.vc=41381004&mainSearchCriteria.v.d. Pneumonija% 20du% 20to% 20Pseudomonas% 20% 28disorder% 29 & informationRecipient.languageCode.c = hr
Pacijent sa istom dijagnozom, ali traženi format 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=CallbackCallbackCallback
Povezane usluge i datoteke
Da biste primili zdravstvene teme MedlinePlus kao odgovor na tekstualne zahtjeve, za razliku od kodova problema, istražite MedlinePlus web uslugu. Također, ako vam je potreban čitav skup zdravstvenih tema MedlinePlus u XML formatu, pogledajte našu stranicu XML datoteka.
Zahtjevi za informacijama o lijekovima
MedlinePlus Connect pruža najbolje informacije o lijekovima kada se prima RXCUI. Također pruža dobre rezultate prilikom primanja NDC koda. MedlinePlus Connect može pružiti odgovore na engleskom ili španskom jeziku.
Za zahtjeve za informacijama o lijekovima na engleskom jeziku, ako ne pošaljete NDC ili RXCUI ili ako na osnovu koda ne pronađemo podudaranje, aplikacija će koristiti tekstualni niz koji ćete poslati za prikaz najboljeg podudaranja informacija o lijeku. Na zahtjeve za španskim informacijama o lijekovima, MedlinePlus Connect odgovara samo na NDC ili RXCUI i ne koristi tekstne nizove. Odgovor je moguć na engleskom, ali na španskom nema odgovora.
Web usluga MedlinePlus Connect vratit će sljedeće:
Na jedan zahtjev za lijekom može biti više odgovora. Ne može uvijek biti podudaranja za svaki zahtjev. U tim će slučajevima MedlinePlus Connect vratiti null odgovor.
Za zahtjeve za informacijama o lijekovima, osnovni URL je: https://connect.medlineplus.gov/service
Da biste poslali zahtjev, dodajte ove podatke:
- Sistem koda
Utvrdite vrstu koda za lijek koji šaljete. (Obavezno za engleski i španski)- Za upotrebu RXCUI:
- mainSearchCriteria.v.cs = 2.16.840.1.113883.6.88
- Za NDC upotrebu:
- mainSearchCriteria.v.cs = 2.16.840.1.113883.6.69
- Kod
Identificirajte stvarni kod koji pokušavate potražiti. (Preferira se za engleski, obavezno za španski)
mainSearchCriteria.v.c = 637188 - Ime lijeka
Identificirajte naziv lijeka tekstualnim nizom. (Neobvezno za engleski, ne koristi se za španski)
mainSearchCriteria.v.dn = Chantix 0,5 mg oralna tableta
Izborni parametri
Naslov kodaKada šaljete zahtjev za informacije na engleskom jeziku, možete uključiti neobavezni parametar naziva lijeka. Ovo je detaljno opisano u gornjem odjeljku. mainSearchCriteria.v.dn = Chantix 0,5 mg oralna tableta
Pogledajte gornji odjeljak o izlaznim parametrima za detalje o jeziku i izlaznim formatima.
Opis odabranih atomskih elemenata (ili JSON objekata) u odgovoru na zahtjeve za lijekovima
Element | Opis |
---|---|
naslov | Naslov za podudarnu stranicu lijekova MedlinePlus |
veza | URL odgovarajuće stranice lijekova MedlinePlus |
autor | Izvor atributa za informacije o lijekovima |
Primjeri zahtjeva za kodovima lijekova
Vaš zahtjev za informacijama o lijekovima trebao bi izgledati kao jedan od sljedećih.
Da biste zatražili informacije putem RXCUI-a, vaš zahtjev treba izgledati ovako: https://connect.medlineplus.gov/service?mainSearchCriteria.v.cs=2.16.840.1.113883.6.88&mainSearchCriteria.vc=637188&mainSearchCriteria.v.dn=Chantix% 200,5% 20 mg% 20 usmeno% 20 tableta i informacijeRecipient.languageCode.c = hr
Da biste zatražili informacije od NDC-a za govornika španskog, vaš zahtjev bi trebao izgledati ovako: https://connect.medlineplus.gov/service?mainSearchCriteria.v.cs=2.16.840.1.113883.6.69&mainSearchCriteria.vc=00310-0751- 39 & informationRecipient.languageCode.c = es
Da biste poslali tekstualni niz bez koda lijeka, morate identificirati svoj upit kao zahtjev tipa NDC, tako da MedlinePlus Connect zna da tražite informacije o lijeku. Ovo će raditi samo za zahtjeve na engleskom jeziku. Vaš zahtjev bi mogao izgledati ovako: 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 = hr
Zahtjevi za informacijama o laboratorijskim testovima
MedlinePlus Connect pruža podudaranje sa informacijama o laboratorijskim testovima kada prima LOINC zahtjev. Usluga može pružiti odgovor na engleskom ili španskom jeziku.
Web usluga MedlinePlus Connect vratit će sljedeće:
Ne može uvijek biti podudaranja za svaki kod. U tim će slučajevima MedlinePlus Connect vratiti null odgovor.
Osnovni URL usluge je: https://connect.medlineplus.gov/service
Ovo su dva potrebna parametra za bilo koji laboratorijski testni upit ove usluge:
- Sistem koda
- Utvrdite da koristite sistem LOINC koda. Upotreba:
- mainSearchCriteria.v.cs = 2.16.840.1.113883.6.1
- MedlinePlus Connect će također prihvatiti:
- mainSearchCriteria.v.cs = 2.16.840.1.113883.11.79
- Kod
identificirajte stvarni kod koji pokušavate potražiti:
mainSearchCriteria.v.c = 3187-2
Izborni parametri
Naslov kodaTakođe možete identificirati naziv laboratorijskog testa. Međutim, ove informacije ne utječu na odgovor. mainSearchCriteria.v.dn = Analiza faktora IX
Pogledajte gornji odjeljak o izlaznim parametrima za detalje o jeziku i izlaznim formatima.
Opis odabranih atomskih elemenata (ili JSON objekata) u odgovoru na zahtjeve za laboratorijskim ispitivanjem
Element | Opis |
---|---|
naslov | Naslov odgovarajuće stranice laboratorijskog testa MedlinePlus |
veza | URL za podudarnu laboratorijsku testnu stranicu MedlinePlus |
sažetak | Isječak iz sadržaja stranice |
autor | Izvorna atribucija za sadržaj laboratorijskog testa |
Primjeri zahtjeva za laboratorijske testove
Da biste zatražili informacije za govornike engleskog jezika, vaš zahtjev može izgledati kao jedan od sljedećih: 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 = hr https://connect.medlineplus.gov/service?mainSearchCriteria.v.cs=2.16.840.1.113883.6.1&mainSearchCriteria.vc=3187-2&informationRecipient.languageuage. = hr
Da biste zatražili informacije za govornika španskog, vaš zahtjev može izgledati kao jedan od sljedećih: https://connect.medlineplus.gov/service?mainSearchCriteria.v.cs=2.16.840.1.113883.6.1&mainSearchCriteria.vc=3187-2&mainSearchCriteria. v.dn = Faktor% 20IX% 20asay & 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
Politika prihvatljive upotrebe
Kako bi izbjegao preopterećenje MedlinePlus poslužitelja, NLM zahtijeva da korisnici MedlinePlus Connect šalju ne više od 100 zahtjeva u minuti po IP adresi. Zahtjevi koji premašuju ovo ograničenje neće se servisirati i usluga se neće vratiti 300 sekundi ili dok stopa zahtjeva ne padne ispod ograničenja, ovisno o tome što nastupi kasnije. Da biste ograničili broj zahtjeva koje šaljete na Connect, NLM preporučuje rezultate predmemoriranja u periodu od 12-24 sata.
Ova je politika uspostavljena kako bi se osiguralo da usluga ostane dostupna i dostupna svim korisnicima. Ako imate određeni slučaj upotrebe koji zahtijeva da pošaljete veliki broj zahtjeva MedlinePlus Connect-u i tako premašite ograničenje stope zahtjeva navedeno u ovim pravilima, kontaktirajte nas. Osoblje NLM-a će procijeniti vaš zahtjev i utvrditi može li se odobriti izuzetak. Molimo pogledajte i dokumentaciju za MedlinePlus XML datoteke. Ove XML datoteke sadrže cjelovite zapise o zdravstvenim temama i mogu poslužiti kao alternativni način pristupa MedlinePlus podacima.