MedlinePlus Connect: webová služba
Obsah
- Přehled webových služeb
- Výstupní parametry
- Žádosti o diagnostické (problémové) kódy
- Volitelné parametry
- Popis vybraných prvků atomů (nebo objektů JSON) v reakci na žádosti o problémový kód
- Příklady žádostí o problémové kódy
- Související služby a soubory
- Žádosti o informace o drogách
- Volitelné parametry
- Popis vybraných prvků atomů (nebo objektů JSON) v reakci na žádosti o léčbu
- Příklady žádostí o kódy drog
- Žádosti o informace o laboratorním testu
- Volitelné parametry
- Popis vybraných prvků atomů (nebo objektů JSON) v reakci na požadavky na laboratorní test
- Příklady žádostí o laboratorní testy
- Zásady přijatelného použití
- Více informací
MedlinePlus Connect je k dispozici jako webová aplikace nebo webová služba. Níže jsou uvedeny technické podrobnosti pro implementaci webové služby, která odpovídá na požadavky na základě:
Můžete vrátit odkaz a zobrazit data vrácená MedlinePlus Connect. Stránky MedlinePlus nesmíte kopírovat na svůj web. Pokud používáte data z webové služby MedlinePlus Connect, uveďte, že informace pocházejí z MedlinePlus.gov, ale nepoužívejte logo MedlinePlus nebo z čehož jinak vyplývá, že MedlinePlus podporuje váš konkrétní produkt. Další pokyny najdete na stránce API NLM. Další informace o tom, jak propojit obsah MedlinePlus mimo tuto službu, najdete v našich pokynech a pokynech k propojení.
Pokud se rozhodnete použít MedlinePlus Connect, zaregistrujte se do seznamu e-mailů, abyste drželi krok s vývojem a vyměňujte si nápady se svými kolegy. Sdělte nám, prosím, pokud implementujete MedlinePlus Connect, kontaktujte nás.
Přehled webových služeb
Parametry požadavků na webové služby jsou v souladu s HL7 Context-Aware Knowledge Retrieval (Infobutton) Knowledge Request URL-Based Implementation Guide. Odpověď založená na REST odpovídá příručce implementace architektury orientované na služby HL7 Context-Aware Knowledge Retrieval (Infobutton). Výstupem požadavku může být XML ve formátu zdroje Atom, JSON nebo JSONP.
Struktura požadavku označuje, jaký typ kódu odesíláte. Ve všech případech je základní adresa URL webové služby: https://connect.medlineplus.gov/service
MedlinePlus Connect používá připojení HTTPS. Požadavky HTTP nebudou přijaty a stávající implementace využívající HTTP by se měly aktualizovat na HTTPS.
Výstupní parametry
Tyto parametry jsou volitelné. Pokud je vynecháte, výchozí odpovědí jsou anglické informace ve formátu XML.
Jazyk
Určete, zda chcete, aby byla odpověď v angličtině nebo španělštině. Pokud není uveden, MedlinePlus Connect bude předpokládat, že jazykem je angličtina.
Pokud si přejete, aby odpověď na vyhledání kódu problému byla ve španělštině, použijte: informationRecipient.languageCode.c = es
(= sp také přijato)
Chcete-li určit angličtinu, použijte následující: informationRecipient.languageCode.c = en
Formát
Určete, zda chcete, aby formát odpovědi byl XML, JSON nebo JSONP. XML je výchozí.
- Chcete-li požádat o JSON, použijte:
- knowledgeResponseType = aplikace / json
- Pro JSONP použijte:
- knowledgeResponseType = application / javascript & callback = CallbackFunction kde CallbackFunction je název, kterému dáte funkci zpětného volání.
- Pro odpověď v XML použijte:
- knowledgeResponseType = text / xml nebo vynechejte parametr knowledgeResponseType mimo požadavek.
Žádosti o diagnostické (problémové) kódy
Pokud jde o problémový kód, MedlinePlus Connect vrátí odkazy a informace ze stránek věnovaných zdraví MedlinePlus, genetických stránek nebo stránek od jiných institutů NIH.
MedlinePlus Connect vrátí následující:
Pro každý kód nemusí vždy existovat shoda. V takových případech MedlinePlus Connect vrátí nulovou odpověď.
Základní adresa URL služby je: https://connect.medlineplus.gov/service
U každého dotazu na tuto službu existují dva požadované parametry:
- Systém kódů
Určete systém kódů problémů, který budete používat.- Pro použití ICD-10-CM:
- mainSearchCriteria.v.cs = 2.16.840.1.113883.6.90
- Pro použití ICD-9-CM:
- mainSearchCriteria.v.cs = 2.16.840.1.113883.6.103
- Pro použití SNOMED CT:
- mainSearchCriteria.v.cs = 2.16.840.1.113883.6.96
- Kód
Určete skutečný kód, který se pokoušíte vyhledat:
mainSearchCriteria.v.c = 250,33
Volitelné parametry
Název kódu
Můžete také identifikovat název / název problémového kódu. Tyto informace však nemají vliv na odezvu (na rozdíl od webové aplikace MedlinePlus Connect, kde lze použít informace o názvu / názvu). mainSearchCriteria.v.dn = Diabetes mellitus s nekontrolovaným jiným typem kómy 1 Viz jazyk výše a výstupní formáty výše v části Výstupní parametry.
Popis vybraných prvků atomů (nebo objektů JSON) v reakci na žádosti o problémový kód
Živel | Uzel třídy | Popis |
---|---|---|
titul | Název shodné stránky tématu zdraví MedlinePlus nebo stránky GHR | |
odkaz | URL pro shodnou stránku tématu zdraví MedlinePlus nebo stránku GHR | |
souhrn | Úplné shrnutí tématu týkajícího se zdraví. To zahrnuje vložené odkazy na další relevantní témata týkající se zdraví a veškeré formátování, včetně odrážek a mezer mezi odstavci. Souhrn je v HTML. U stránek GHR je uvedena první část celé stránky. | |
souhrn | Synonyma k tématu. Tito jsou na stránce tématu zdraví označováni jako „Také se nazývají“. Ne všechna témata mají výrazy „Také se nazývají“. | |
souhrn | Potvrzení atribuce za text souhrnu, pokud většina souhrnu pocházela od jiné federální agentury. Ne všechny souhrny mají přiřazení. Nepřiřazený text je původní pro MedlinePlus. | |
souhrn | Vybrané odkazy spojené s tématem. To zahrnuje název stránky, URL a přidruženou organizaci (je-li k dispozici). Odkazy jsou formátovány v seznamu s odrážkami. Ne všechna témata mají tyto odkazy. Počet odkazů se může pohybovat od nuly do desítek. |
Příklady žádostí o problémové kódy
Kompletní žádost o Diabetes Mellitus s jiným nekontrolovaným kóma typu 1, kód ICD-9 250,33, pro španělsky mluvícího pacienta by měla následující 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% 20nekontrolováno & informationRecipient.languageCode.c = es
Pacient se stejnou diagnózou, ale požadovaný formát je JSON a jazykem 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 „Pneumonie způsobená Pseudomonas“ pomocí 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= Pneumonie% 20due% 20to% 20Pseudomonas% 20% 28disorder% 29 & informationRecipient.languageCode.c = en
Pacient se stejnou diagnózou, ale požadovaným formátem 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=Callback=Callback
Související služby a soubory
Chcete-li dostávat témata týkající se zdraví MedlinePlus v reakci na textové požadavky, na rozdíl od kódů problémů, prozkoumejte webovou službu MedlinePlus. Také pokud potřebujete úplnou sadu témat zdraví MedlinePlus ve formátu XML, podívejte se na naši stránku se soubory XML.
Žádosti o informace o drogách
Při příjmu RXCUI poskytuje aplikace MedlinePlus Connect ty nejlepší informace o lécích. Poskytuje také dobré výsledky při příjmu kódu NDC. MedlinePlus Connect může poskytovat odpovědi v angličtině nebo španělštině.
Pokud u žádostí o informace o lécích v angličtině neposíláte NDC nebo RXCUI nebo pokud na základě kódu nenalezneme žádnou shodu, aplikace použije textový řetězec, který odešlete, k zobrazení nejlepší shody informací o lécích. Na žádosti o informace o španělských lécích reaguje MedlinePlus Connect pouze na NDC nebo RXCUI a nepoužívá textové řetězce. Je možné mít odpověď v angličtině, ale žádná odpověď ve španělštině.
Webová služba MedlinePlus Connect vrátí následující:
Na jednu žádost o léčbu může být více odpovědí. Pro každý požadavek nemusí vždy existovat shoda. V takových případech MedlinePlus Connect vrátí nulovou odpověď.
U žádostí o informace o lécích je základní adresa URL: https://connect.medlineplus.gov/service
Chcete-li odeslat požadavek, uveďte tyto informace:
- Systém kódů
Určete typ léčebného kódu, který odesíláte. (Povinné pro angličtinu a španělštinu)- Pro RXCUI použijte:
- mainSearchCriteria.v.cs = 2.16.840.1.113883.6.88
- Pro použití NDC:
- mainSearchCriteria.v.cs = 2.16.840.1.113883.6.69
- Kód
Určete skutečný kód, který se pokoušíte vyhledat. (Preferováno pro angličtinu, požadováno pro španělštinu)
mainSearchCriteria.v.c = 637188 - Název drogy
Identifikujte název léku pomocí textového řetězce. (Volitelné pro angličtinu, nepoužívá se pro španělštinu)
mainSearchCriteria.v.dn = Chantix 0,5 MG perorální tableta
Volitelné parametry
Název kóduPři odesílání žádosti o informace v angličtině můžete uvést volitelný parametr názvu léku. To je podrobně popsáno ve výše uvedené části. mainSearchCriteria.v.dn = Chantix 0,5 MG perorální tableta
Viz výše část Výstupní parametry, kde najdete podrobnosti o jazykových a výstupních formátech.
Popis vybraných prvků atomů (nebo objektů JSON) v reakci na žádosti o léčbu
Živel | Popis |
---|---|
titul | Nadpis pro odpovídající stránku s léky MedlinePlus |
odkaz | URL pro odpovídající stránku s léky MedlinePlus |
autor | Uvedení zdroje pro informace o léčbě |
Příklady žádostí o kódy drog
Vaše žádost o informace o léčbě by měla vypadat jako jedna z následujících.
Chcete-li požádat o informace prostřednictvím RXCUI, měla by vaše žádost vypadat 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 informaceRecipient.languageCode.c = en
Chcete-li požádat NDC o informace pro španělského mluvčího, měla by vaše žádost vypadat 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
Chcete-li odeslat textový řetězec bez kódu léku, musíte identifikovat svůj dotaz jako požadavek typu NDC, aby MedlinePlus Connect věděl, že hledáte informace o lécích. Toto bude fungovat pouze pro anglické požadavky. Váš požadavek může vypadat 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
Žádosti o informace o laboratorním testu
MedlinePlus Connect poskytuje shody s informacemi o laboratorních testech, když obdrží požadavek LOINC. Tato služba může poskytnout odpověď v angličtině nebo španělštině.
Webová služba MedlinePlus Connect vrátí následující:
Pro každý kód nemusí vždy existovat shoda. V takových případech MedlinePlus Connect vrátí nulovou odpověď.
Základní adresa URL služby je: https://connect.medlineplus.gov/service
Jedná se o dva požadované parametry pro jakýkoli laboratorní testovací dotaz pro tuto službu:
- Systém kódů
- Zjistěte, že používáte systém kódů LOINC. Použití:
- mainSearchCriteria.v.cs = 2.16.840.1.113883.6.1
- MedlinePlus Connect také přijímá:
- mainSearchCriteria.v.cs = 2.16.840.1.113883.11.79
- Kód
identifikujte skutečný kód, který se pokoušíte vyhledat:
mainSearchCriteria.v.c = 3187-2
Volitelné parametry
Název kóduMůžete také identifikovat název laboratorního testu. Tyto informace však nemají vliv na odpověď. mainSearchCriteria.v.dn = Stanovení faktoru IX
Viz výše část Výstupní parametry, kde najdete podrobnosti o jazykových a výstupních formátech.
Popis vybraných prvků atomů (nebo objektů JSON) v reakci na požadavky na laboratorní test
Živel | Popis |
---|---|
titul | Název shodné laboratorní testovací stránky MedlinePlus |
odkaz | URL pro odpovídající laboratorní testovací stránku MedlinePlus |
souhrn | Úryvek z obsahu stránky |
autor | Uvedení zdroje pro obsah laboratorního testu |
Příklady žádostí o laboratorní testy
Chcete-li požádat o informace pro anglicky mluvícího, váš požadavek může vypadat jako jeden z následujících: 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 = en https://connect.medlineplus.gov/service?mainSearchCriteria.v.cs=2.16.840.1.113883.6.1&mainSearchCriteria.vc=3187-2&informationRecipient.laguageCode = en
Chcete-li požádat o informace pro mluvčího španělštiny, může váš požadavek vypadat jako jeden z následujících: 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.languageCode = es
Zásady přijatelného použití
Aby se zabránilo přetížení serverů MedlinePlus, NLM vyžaduje, aby uživatelé MedlinePlus Connect neposílali více než 100 požadavků za minutu na IP adresu. Žádosti, které překročí tento limit, nebudou obsluhovány a služba nebude obnovena po dobu 300 sekund nebo dokud rychlost požadavku neklesne pod limit, podle toho, co nastane později. Chcete-li omezit počet požadavků, které odesíláte do služby Connect, NLM doporučuje ukládat výsledky do mezipaměti po dobu 12–24 hodin.
Tato zásada je zavedena, aby zajistila, že služba zůstane dostupná a přístupná všem uživatelům. Pokud máte konkrétní případ použití, který vyžaduje, abyste odeslali velké množství požadavků na MedlinePlus Connect, a překročili tak limit rychlosti žádostí uvedený v těchto zásadách, kontaktujte nás. Zaměstnanci NLM vyhodnotí váš požadavek a určí, zda může být udělena výjimka. Přečtěte si také dokumentaci souborů MedlinePlus XML. Tyto soubory XML obsahují úplné záznamy témat o zdraví a mohou sloužit jako alternativní metoda přístupu k datům MedlinePlus.