MedlinePlus Connect: webová služba
Obsah
- Prehľad webových služieb
- Výstupné parametre
- Žiadosti o diagnostické (problémové) kódy
- Nepovinné parametre
- Opis vybraných prvkov atómu (alebo objektov JSON) v reakcii na žiadosti o problémový kód
- Príklady žiadostí o kódy problémov
- Súvisiace služby a súbory
- Žiadosti o informácie o drogách
- Nepovinné parametre
- Popis vybraných prvkov atómu (alebo objektov JSON) v reakcii na žiadosť o liečbu
- Príklady žiadostí o kódy liekov
- Žiadosti o informácie o laboratórnom teste
- Nepovinné parametre
- Popis vybraných prvkov atómu (alebo objektov JSON) v odpovedi na požiadavky laboratórneho testu
- Príklady žiadostí o laboratórne testy
- Pravidlá prijateľného použitia
- Viac informácií
MedlinePlus Connect je k dispozícii ako webová aplikácia alebo webová služba. Ďalej sú uvedené technické podrobnosti implementácie webovej služby, ktorá reaguje na požiadavky na základe:
Môžete vrátiť odkaz a zobraziť údaje vrátené pomocou aplikácie MedlinePlus Connect. Stránky MedlinePlus nesmiete kopírovať na svoje webové stránky. Ak používate údaje z webovej služby MedlinePlus Connect, uveďte, prosím, že informácie sú z MedlinePlus.gov, ale nepoužívajte logo MedlinePlus alebo z iného dôvodu nevyplýva, že MedlinePlus podporuje váš konkrétny produkt. Ďalšie pokyny nájdete na stránke API spoločnosti NLM. Viac informácií o tom, ako prepojiť na obsah MedlinePlus mimo túto službu, nájdete v našich pokynoch a pokynoch na prepojenie.
Ak sa rozhodnete používať MedlinePlus Connect, zaregistrujte sa do zoznamu e-mailov, aby ste držali krok s vývojom a vymieňajte si nápady so svojimi kolegami. Ak implementujete MedlinePlus Connect, povedzte nám, prosím, kontaktujte nás.
Prehľad webových služieb
Parametre pre požiadavky webovej služby zodpovedajú Príručke implementácie na základe adresy URL založenej na vedomostiach HL7 na základe vedomia (infobutton). Odozva na základe REST je v súlade s Sprievodcom implementácie architektúry orientovanej na služby HL7 Context-Aware Knowledge Retrieval (Infobutton). Výstupom žiadosti môže byť XML vo formáte informačného kanála Atom, JSON alebo JSONP.
Štruktúra žiadosti naznačuje, aký typ kódu odosielate. Vo všetkých prípadoch je základná adresa URL webovej služby: https://connect.medlineplus.gov/service
Aplikácia MedlinePlus Connect používa pripojenie HTTPS. HTTP požiadavky nebudú akceptované a existujúce implementácie využívajúce HTTP by sa mali aktualizovať na HTTPS.
Výstupné parametre
Tieto parametre sú voliteľné. Ak ich vynecháte, predvolenou odpoveďou sú anglické informácie vo formáte XML.
Jazyk
Určite, či chcete, aby bola odpoveď v angličtine alebo španielčine. Aplikácia MedlinePlus Connect bude vychádzať z toho, že ak nie je uvedený inak, bude ako jazyk použitý jazyk English.
Ak chcete, aby bola odpoveď na vyhľadanie kódu problému v španielčine, použite: informationRecipient.languageCode.c = es
(= sp tiež akceptované)
Na zadanie angličtiny použite nasledujúci príkaz: informationRecipient.languageCode.c = sk
Formát
Zistite, či chcete, aby formát odpovede bol XML, JSON alebo JSONP. XML je predvolené.
- Ak chcete požiadať o JSON, použite:
- knowledgeResponseType = aplikácia / json
- Pre JSONP použite:
- knowledgeResponseType = application / javascript & callback = CallbackFunction kde CallbackFunction je názov, ktorému dáte funkciu spätného volania.
- Pre odpoveď v XML použite:
- knowledgeResponseType = text / xml alebo vynechajte parameter knowledgeResponseType mimo požiadavky.
Žiadosti o diagnostické (problémové) kódy
V prípade kódu problému MedlinePlus Connect vráti odkazy a informácie zo stránok s témami o zdraví MedlinePlus, zo stránok o genetike alebo zo stránok od iných ústavov NIH.
MedlinePlus Connect vráti nasledujúce:
Pre každý kód nemusí byť vždy zhoda. V týchto prípadoch MedlinePlus Connect vráti nulovú odpoveď.
Základná adresa URL služby je: https://connect.medlineplus.gov/service
Pre každý dotaz na túto službu existujú dva požadované parametre:
- Kódový systém
Identifikujte systém kódov problémov, ktorý budete používať.- Pre použitie ICD-10-CM:
- mainSearchCriteria.v.cs = 2.16.840.1.113883.6.90
- Pre použitie ICD-9-CM:
- mainSearchCriteria.v.cs = 2.16.840.1.113883.6.103
- Pre použitie SNOMED CT:
- mainSearchCriteria.v.cs = 2.16.840.1.113883.6.96
- Zákonníka
Uveďte skutočný kód, ktorý sa pokúšate vyhľadať:
mainSearchCriteria.v.c = 250,33
Nepovinné parametre
Názov kódu
Môžete tiež identifikovať názov / názov kódu problému. Tieto informácie však nemajú vplyv na odpoveď (na rozdiel od webovej aplikácie MedlinePlus Connect, kde je možné použiť informácie o mene / titule). mainSearchCriteria.v.dn = Diabetes mellitus s inou nekontrolovanou inou kómou typu 1 Podrobnosti o jazyku a výstupných formátoch pozri vyššie v časti Výstupné parametre.
Opis vybraných prvkov atómu (alebo objektov JSON) v reakcii na žiadosti o problémový kód
| Element | Uzol triedy | Popis |
|---|---|---|
| titul | Názov zhodnej stránky témy zdravia MedlinePlus alebo stránky GHR | |
| odkaz | URL pre zodpovedajúcu stránku témy zdravia MedlinePlus alebo stránku GHR | |
| zhrnutie | Úplné zhrnutie k téme týkajúcej sa zdravia. Patria sem vložené odkazy na ďalšie príslušné témy týkajúce sa zdravia a všetko formátovanie vrátane odrážok a medzier medzi odsekmi. Súhrn je v HTML. Pre stránky GHR je poskytnutá prvá časť celej stránky. | |
| zhrnutie | Synonymá pre danú tému. Na stránke venovanej zdraviu sa označujú ako „Tiež sa nazýva“. Nie všetky témy majú výrazy „Tiež sa nazýva“. | |
| zhrnutie | Potvrdenie zdroja pre text súhrnu, ak väčšina súhrnu pochádzala od inej federálnej agentúry. Nie všetky súhrny majú uvedenie zdroja. Nepriradený text je pôvodný pre MedlinePlus. | |
| zhrnutie | Vybrané odkazy súvisiace s témou. Patrí sem názov stránky, adresa URL a pridružená organizácia (ak sú k dispozícii). Odkazy sú formátované v zozname s odrážkami. Nie všetky témy majú tieto odkazy. Počet odkazov sa môže pohybovať od nuly do desiatok. |
Príklady žiadostí o kódy problémov
Kompletná žiadosť o Diabetes Mellitus s inou nekontrolovanou kómou typu 1, kódom ICD-9 250,33, pre španielsky hovoriaceho pacienta by mala túto adresu URL: https://connect.medlineplus.gov/service?mainSearchCriteria.v.cs=2.16 .840.1.113883.6.103 & mainSearchCriteria.vc = 250,33 & mainSearchCriteria.v.dn = Diabetes% 20mellitus% 20s% 20other% 20coma% 20typ% 201% 20nekontrolovaný & informationRecipient.languageCode.c = es
Pacient s rovnakou diagnózou, ale požadovaný formát je JSON a jazyk je angličtina: https://connect.medlineplus.gov/service?mainSearchCriteria.v.cs=2.16.840.1.113883.6.103&mainSearchCriteria.vc=250.33&knowledgeResponseType=application / json
Pacient s diagnózou „Pneumónia spôsobená Pseudomonas“ pomocou kódu SNOMED CT 41381004: https://connect.medlineplus.gov/service?mainSearchCriteria.v.cs=2.16.840.1.113883.6.96&mainSearchCriteria.vc=41381004&mainSearchCriteria.v.dn= Pneumónia% 20due% 20to% 20Pseudomonas% 20% 28rozchod% 29 & informationRecipient.languageCode.c = sk
Pacient s rovnakou diagnózou, ale požadovaným formátom 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=Callback=Call
Súvisiace služby a súbory
Ak chcete dostávať témy týkajúce sa zdravia MedlinePlus v reakcii na textové žiadosti, na rozdiel od problémových kódov, preskúmajte webovú službu MedlinePlus. Ak potrebujete úplnú sadu tém týkajúcich sa zdravia MedlinePlus vo formáte XML, pozrite si našu stránku so súbormi XML.
Žiadosti o informácie o drogách
Aplikácia MedlinePlus Connect poskytuje najlepšie informácie o liekoch pri prijatí RXCUI. Poskytuje tiež dobré výsledky pri prijímaní kódu NDC. MedlinePlus Connect dokáže poskytnúť odpovede v angličtine alebo španielčine.
Ak v prípade žiadostí o informácie o liekoch v angličtine neodošlete NDC alebo RXCUI alebo ak na základe kódu nenájdeme zhodu, použije aplikácia textový reťazec, ktorý odošlete, na zobrazenie najlepšej zhody informácií o lieku. Na žiadosti o informácie o španielskych liekoch reaguje MedlinePlus Connect iba na NDC alebo RXCUI a nepoužíva textové reťazce. Je možné mať odpoveď v angličtine, ale žiadna odpoveď v španielčine.
Webová služba MedlinePlus Connect vráti nasledujúce:
Na jednu žiadosť o liek mohlo byť viac odpovedí. Môže sa stať, že pre každú požiadavku nemusí byť vždy zhoda. V týchto prípadoch MedlinePlus Connect vráti nulovú odpoveď.
V prípade žiadostí o informácie o lieku je základná adresa URL: https://connect.medlineplus.gov/service
Ak chcete poslať žiadosť, uveďte tieto informácie:
- Kódový systém
Identifikujte typ kódu lieku, ktorý odosielate. (Povinné pre angličtinu a španielčinu)- Pre RXCUI použite:
- mainSearchCriteria.v.cs = 2.16.840.1.113883.6.88
- Pre použitie NDC:
- mainSearchCriteria.v.cs = 2.16.840.1.113883.6.69
- Zákonníka
Identifikujte skutočný kód, ktorý sa snažíte vyhľadať. (Preferované pre angličtinu, požadované pre španielčinu)
mainSearchCriteria.v.c = 637188 - Názov lieku
Identifikujte názov lieku pomocou textového reťazca. (Voliteľné pre angličtinu, nepoužíva sa pre španielčinu)
mainSearchCriteria.v.dn = Chantix 0,5 MG perorálna tableta
Nepovinné parametre
Názov kóduPri zasielaní žiadosti o informácie v angličtine môžete uviesť voliteľný parameter názvu lieku. Toto je podrobne uvedené v predchádzajúcej časti. mainSearchCriteria.v.dn = Chantix 0,5 MG perorálna tableta
V predchádzajúcej časti o výstupných parametroch nájdete podrobnosti o jazykoch a výstupných formátoch.
Popis vybraných prvkov atómu (alebo objektov JSON) v reakcii na žiadosť o liečbu
| Element | Popis |
|---|---|
| titul | Nadpis pre zodpovedajúcu stránku s liečbou MedlinePlus |
| odkaz | URL zodpovedajúcej stránky s liečbou MedlinePlus |
| autor | Uvedenie zdroja pre informácie o liekoch |
Príklady žiadostí o kódy liekov
Vaša žiadosť o informácie o lieku by mala vyzerať ako jedna z nasledujúcich.
Ak chcete požiadať o informácie prostredníctvom RXCUI, vaša žiadosť by mala vyzerať takto: 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% 20Oral% 20Tablet a informácieRecipient.languageCode.c = sk
Ak chcete od španielskeho hovorcu požiadať NDC o informácie, vaša žiadosť by mala vyzerať takto: https://connect.medlineplus.gov/service?mainSearchCriteria.v.cs=2.16.840.1.113883.6.69&mainSearchCriteria.vc=00310-0751- 39 & informationRecipient.languageCode.c = es
Ak chcete odoslať textový reťazec bez kódu lieku, musíte identifikovať svoj dopyt ako požiadavku typu NDC, aby služba MedlinePlus Connect vedela, že hľadáte informácie o lieku. Toto bude fungovať iba pre žiadosti v angličtine. Vaša žiadosť môže vyzerať takto: 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
Žiadosti o informácie o laboratórnom teste
Aplikácia MedlinePlus Connect poskytuje zhody s informáciami o laboratórnych testoch, keď dostane požiadavku LOINC. Služba môže poskytnúť odpoveď v angličtine alebo španielčine.
Webová služba MedlinePlus Connect vráti nasledujúce:
Pre každý kód nemusí byť vždy zhoda. V týchto prípadoch MedlinePlus Connect vráti nulovú odpoveď.
Základná adresa URL služby je: https://connect.medlineplus.gov/service
Toto sú dva požadované parametre pre akýkoľvek laboratórny testovací dotaz pre túto službu:
- Kódový systém
- Zistite, že používate systém kódov LOINC. Použitie:
- mainSearchCriteria.v.cs = 2.16.840.1.113883.6.1
- MedlinePlus Connect bude akceptovať aj:
- mainSearchCriteria.v.cs = 2.16.840.1.113883.11.79
- Zákonníka
identifikujte skutočný kód, ktorý sa pokúšate vyhľadať:
mainSearchCriteria.v.c = 3187-2
Nepovinné parametre
Názov kóduMôžete tiež určiť názov laboratórneho testu. Táto informácia však nemá vplyv na reakciu. mainSearchCriteria.v.dn = Stanovenie faktora IX
V predchádzajúcej časti o výstupných parametroch nájdete podrobnosti o jazykových a výstupných formátoch.
Popis vybraných prvkov atómu (alebo objektov JSON) v odpovedi na požiadavky laboratórneho testu
| Element | Popis |
|---|---|
| titul | Názov zhodnej laboratórnej testovacej stránky MedlinePlus |
| odkaz | URL zodpovedajúcej laboratórnej testovacej stránky MedlinePlus |
| zhrnutie | Úryvok z obsahu stránky |
| autor | Uvedenie zdroja pre obsah laboratórneho testu |
Príklady žiadostí o laboratórne testy
Ak chcete požiadať o informácie pre anglicky hovoriaceho človeka, vaša žiadosť môže vyzerať ako jedna z nasledujúcich: 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 = sk https://connect.medlineplus.gov/service?mainSearchCriteria.v.cs=2.16.840.1.113883.6.1&mainSearchCriteria.vc=3187-2&informationRecipient.languageCode = en
Ak chcete požiadať o informácie pre španielskeho hovorcu, vaša žiadosť môže vyzerať ako jedna z nasledujúcich: 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 = es
Pravidlá prijateľného použitia
Aby sa zabránilo preťaženiu serverov MedlinePlus, NLM vyžaduje, aby používatelia MedlinePlus Connect neposielali viac ako 100 požiadaviek za minútu na jednu adresu IP. Žiadosti, ktoré presiahnu tento limit, nebudú vybavené a služba nebude obnovená po dobu 300 sekúnd alebo dovtedy, kým miera žiadosti neklesne pod limit, podľa toho, čo nastane neskôr. Aby ste obmedzili počet žiadostí, ktoré posielate na server Connect, NLM odporúča ukladať výsledky do medzipamäte na dobu 12 - 24 hodín.
Toto pravidlo je zavedené s cieľom zabezpečiť, aby služba zostala dostupná a prístupná všetkým používateľom. Ak máte konkrétny prípad použitia, ktorý vyžaduje, aby ste odoslali veľké množstvo požiadaviek na server MedlinePlus Connect, a teda prekročili limit rýchlosti žiadostí uvedený v týchto zásadách, kontaktujte nás. Pracovníci NLM vyhodnotia vašu žiadosť a určia, či je možné udeliť výnimku. Prečítajte si tiež dokumentáciu k súborom XML MedlinePlus. Tieto súbory XML obsahujú úplné záznamy o témach týkajúcich sa zdravia a môžu slúžiť ako alternatívna metóda prístupu k údajom MedlinePlus.
Viac informácií
Odporučiť
6 zdraviu prospešných výhod konopných semienok
