MedlinePlus Connect: webservice
Kontint
- Webtsjinst oersicht
- Utfierparameters
- Fersiken foar diagnoaze (probleem) koades
- Opsjonele Parameters
- Beskriuwing fan selekteare atoomeleminten (of JSON-objekten) yn antwurd op fersyk fan probleemkoades
- Foarbylden fan fersiken foar probleemkoades
- Besibbe tsjinsten en bestannen
- Fersiken foar ynformaasje oer drugs
- Opsjonele Parameters
- Beskriuwing fan selekteare atoomeleminten (as JSON-objekten) yn antwurd op medisynoanfragen
- Foarbylden fan fersiken foar drugskoades
- Fersiken foar labtestynformaasje
- Opsjonele Parameters
- Beskriuwing fan selekteare atoomeleminten (of JSON-objekten) yn antwurd op labtestoanfragen
- Foarbylden fan fersiken foar labtests
- Akseptabel belied foar gebrûk
- Mear ynformaasje
MedlinePlus Connect is beskikber as in webapplikaasje as webservice. Hjirûnder binne de technyske details foar it útfieren fan 'e webservice, dy't reageart op fersiken basearre op:
Jo binne wolkom om te keppeljen nei en werjaan de gegevens weromjûn troch MedlinePlus Connect. Jo meie MedlinePlus-siden net nei jo side kopiearje. As jo gegevens brûke fan 'e MedlinePlus Connect-webservice, jouwe dan oan dat de ynformaasje komt fan MedlinePlus.gov, mar brûk it MedlinePlus-logo net of oars betsjutte dat MedlinePlus jo spesifike produkt stipet. Sjoch asjebleaft de API-pagina fan NLM foar fierdere begelieding. Sjoch asjebleaft ús rjochtlinen en ynstruksjes oer keppeljen foar mear ynformaasje oer hoe't jo kinne keppelje nei MedlinePlus-ynhâld bûten dizze tsjinst.
As jo beslute om MedlinePlus Connect te brûken, meld jo dan oan foar de e-postlist om op 'e hichte te bliuwen fan ûntjouwingen en ideeën te wikseljen mei jo kollega's. Fertel ús as jo MedlinePlus Connect ymplementearje troch kontakt mei ús op te nimmen.
Webtsjinst oersicht
De parameters foar de webservice-oanfragen binne oerien mei de HL7 Context-Aware Knowledge Retrieval (Infobutton) Kennis-oanfraach URL-basearre ymplementaasjegids. It REST-basearre antwurd befettet de HL7 Context-Aware Knowledge Retrieval (Infobutton) Service-Oriented Architecture Implementation Guide. De útfier fan it fersyk kin XML wêze yn it Atom-feedformaat, JSON, as JSONP.
De struktuer fan it fersyk jout oan hokker type koade jo stjoere. Yn alle gefallen is de basis-URL foar de webservice: https://connect.medlineplus.gov/service
MedlinePlus Connect brûkt HTTPS-ferbiningen. HTTP-oanfragen wurde net aksepteare en besteande ymplementaasjes mei HTTP moatte bywurkje nei HTTPS.
Utfierparameters
Dizze parameters binne opsjoneel. As jo se weilitte, is it standert antwurd Ingelske ynformaasje yn XML-formaat.
Taal
Identifisearje as jo wolle dat it antwurd yn it Ingelsk of Spaansk is. MedlinePlus Connect sil oannimme dat Ingelsk de taal is as it net wurdt oantsjutte.
As jo wolle dat it antwurd op it opsykjen fan de probleemkoade yn it Spaansk is, brûk dan: informationRecipient.languageCode.c = es
(= sp ek aksepteare)
Om Ingelsk oan te jaan, brûk it folgjende: informationRecipient.languageCode.c = en
Formaat
Identifisearje as jo wolle dat it antwurdformaat XML, JSON of JSONP is. XML is de standert.
- Om JSON oan te freegjen, brûk:
- knowledgeResponseType = applikaasje / json
- Brûk foar JSONP:
- knowledgeResponseType = application / javascript & callback = CallbackFunction wêrby CallbackFunction in namme is dy't jo de call-back-funksje jouwe.
- Brûk foar in antwurd yn XML:
- knowledgeResponseType = tekst / xml of lit de parameter knowledgeResponseType bûten it fersyk.
Fersiken foar diagnoaze (probleem) koades
Foar in probleemkoade sil MedlinePlus Connect links en ynformaasje weromjaan fan MedlinePlus-pagina's oer sûnens, genetyske siden, of siden fan oare NIH-ynstituten.
MedlinePlus Connect sil it folgjende werombringe:
D'r is miskien net altyd in wedstriid foar elke koade. Yn dy gefallen sil MedlinePlus Connect in nul antwurd jaan.
De basis URL fan 'e tsjinst is: https://connect.medlineplus.gov/service
D'r binne twa fereaske parameters foar elke fraach nei dizze tsjinst:
- Koadesysteem
Identifisearje it probleemkoadesysteem dat jo sille brûke.- Foar ICD-10-CM gebrûk:
- mainSearchCriteria.v.cs = 2.16.840.1.113883.6.90
- Foar ICD-9-CM gebrûk:
- mainSearchCriteria.v.cs = 2.16.840.1.113883.6.103
- Foar SNOMED CT gebrûk:
- mainSearchCriteria.v.cs = 2.16.840.1.113883.6.96
- Koade
Identifisearje de eigentlike koade dy't jo besykje op te sykjen:
mainSearchCriteria.v.c = 250.33
Opsjonele Parameters
Koade titel
Jo kinne ek de namme / titel fan 'e probleemkoade identifisearje. Dizze ynformaasje hat lykwols gjin ynfloed op it antwurd (oars as de MedlinePlus Connect-webapplikaasje wêr't de namme / titelynformaasje kin wurde brûkt). mainSearchCriteria.v.dn = Diabetes mellitus mei oare koma type 1 sûnder kontrôle Sjoch it boppesteande diel oer Utfierparameters foar details oer taal- en útfierformaten.
Beskriuwing fan selekteare atoomeleminten (of JSON-objekten) yn antwurd op fersyk fan probleemkoades
| Elemint | Klasse knooppunt | Beskriuwing |
|---|---|---|
| titel | Titel fan oerienkommende MedlinePlus sûnensûnderwerpside as GHR-pagina | |
| link | URL foar oerienkommende MedlinePlus-side oer sûnens of GHR-pagina | |
| gearfetting | De folsleine gearfetting foar it sûnensûnderwerp. Dit omfettet ynbêde keppelings nei oare relevante sûnensûnderwerpen, en alle opmaak, ynklusyf kûgels en paragraafôfstân. De gearfetting is yn HTML. Foar GHR-siden wurdt de earste seksje fan 'e folsleine pagina oanbean. | |
| gearfetting | Synonimen foar it ûnderwerp. Dizze wurde op in pagina oer sûnens neamd as "Ek wol neamd". Net alle ûnderwerpen hawwe termen "Ek wol neamd". | |
| gearfetting | Erkenning fan attribúsje foar gearfettingstekst, as de mearderheid fan 'e gearfetting fan in oar federaal buro wie. Net alle gearfettings hawwe in attribúsje. Unattribueare tekst is orizjineel foar MedlinePlus. | |
| gearfetting | Selekteare keppelings assosjeare mei it ûnderwerp. Dit omfettet de pagina namme, URL, en assosjeare organisaasje (as fan tapassing). De keppelings binne opmakke yn in kûgelistlist. Net alle ûnderwerpen hawwe dizze keppelings. It oantal links kin fariearje fan nul oant tsientallen. |
Foarbylden fan fersiken foar probleemkoades
In folslein fersyk foar Diabetes Mellitus mei oare koma-type 1 ûnkontroleare, ICD-9-koade 250.33, foar in Spaansktalige pasjint soe it folgjende URL-adres hawwe: https://connect.medlineplus.gov/service?mainSearchCriteria.v.cs=2.16 .840.1.113883.6.103 & mainSearchCriteria.vc = 250.33 & mainSearchCriteria.v.dn = Diabetes% 20mellitus% 20mei% 20other% 20coma% 20type% 201% 20 unkontrolleare & informationRecipient.languageCode.c = es
In pasjint mei deselde diagnoaze, mar it frege formaat is JSON en de taal is Ingelsk: https://connect.medlineplus.gov/service?mainSearchCriteria.v.cs=2.16.840.1.113883.6.103&mainSearchCriteria.vc=250.33&knowledgeResponseType=application / json
In pasjint diagnostisearre mei "Longûntstekking fanwege Pseudomonas" mei SNOMED CT-koade 41381004: https://connect.medlineplus.gov/service?mainSearchCriteria.v.cs=2.16.840.1.113883.6.96&mainSearchCriteria.vc=41381004&mainSearchCriteria.v.dn= Longûntstekking% 20due% 20to% 20 Pseudomonas% 20% 28 disorder% 29 & informationRecipient.languageCode.c = en
In pasjint mei deselde diagnoaze, mar it frege 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
Besibbe tsjinsten en bestannen
Om MedlinePlus-sûnensûnderwerpen te ûntfangen yn antwurd op tekstoanfragen, yn tsjinstelling ta probleemcodes, ûndersykje de MedlinePlus-webservice. As jo ek de folsleine set fan MedlinePlus-sûnensûnderwerpen nedich binne yn XML-formaat, sjoch dan ús pagina XML-bestannen.
Fersiken foar ynformaasje oer drugs
MedlinePlus Connect biedt de bêste wedstriden oer medisynynformaasje by it ûntfangen fan in RXCUI. It leveret ek goede resultaten by it ûntfangen fan in NDC-koade. MedlinePlus Connect kin antwurden leverje yn it Ingelsk as Spaansk.
As jo gjin NDC of RXCUI ferstjoere foar fersiken om ynformaasje oer Ingelske medisinen, as wy gjin oerienkomst fine op basis fan 'e koade, sil de applikaasje de tekststring brûke dy't jo stjoere om de bêste oerienkomst oer medisynynformaasje te werjaan. Foar fersiken om ynformaasje oer Spaanske medisinen reageart MedlinePlus Connect allinich op NDC's of RXCUI's en brûkt gjin tekststrings. It is mooglik in antwurd te hawwen yn it Ingelsk, mar gjin antwurd yn it Spaansk.
De MedlinePlus Connect webservice sil it folgjende werombringe:
D'r kinne meardere antwurden wêze op ien medikaasje-oanfraach. D'r is miskien net altyd in wedstriid foar elk fersyk. Yn dy gefallen sil MedlinePlus Connect in nul antwurd jaan.
Foar oanfragen foar medisynynformaasje is de basis URL: https://connect.medlineplus.gov/service
Om in fersyk te stjoeren, omfetsje dizze stikken ynformaasje:
- Koadesysteem
Identifisearje it type medikaasjekoade dat jo stjoere. (Fereaske foar Ingelsk en Spaansk)- Foar RXCUI gebrûk:
- mainSearchCriteria.v.cs = 2.16.840.1.113883.6.88
- Foar NDC gebrûk:
- mainSearchCriteria.v.cs = 2.16.840.1.113883.6.69
- Koade
Identifisearje de wirklike koade dy't jo besykje op te sykjen. (Foarkar foar Ingelsk, ferplicht foar Spaansk)
mainSearchCriteria.v.c = 637188 - Drugsnamme
Identifisearje de namme fan it medisyn mei in tekststring. (Opsjoneel foar Ingelsk, net brûkt foar Spaansk)
mainSearchCriteria.v.dn = Chantix 0,5 mg mûnlinge tablet
Opsjonele Parameters
Koade titelBy it ferstjoeren fan in fersyk foar Ingelske ynformaasje kinne jo de opsjonele parameter fan 'e namme fan' e medikaasje opnimme. Dit wurdt detaillearre yn 'e boppesteande seksje. mainSearchCriteria.v.dn = Chantix 0,5 mg mûnlinge tablet
Sjoch it boppesteande diel oer Utfierparameters foar details oer taal- en útfierformaten.
Beskriuwing fan selekteare atoomeleminten (as JSON-objekten) yn antwurd op medisynoanfragen
| Elemint | Beskriuwing |
|---|---|
| titel | Titel foar oerienkommende MedlinePlus medikaasje side |
| link | URL foar de oerienkommende MedlinePlus medikaasje side |
| skriuwer | Boarne-attribúsje foar ynformaasje oer medisinen |
Foarbylden fan fersiken foar drugskoades
Jo oanfraach foar medisynynformaasje moat as ien fan 'e folgjende útsjen.
Om ynformaasje te freegjen troch in RXCUI, moat jo fersyk der sa útsjen: 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 Tablet & informationRecipient.languageCode.c = en
Om ynformaasje te freegjen troch in NDC foar in Spaanske sprekker, moat jo fersyk der sa útsjen: https://connect.medlineplus.gov/service?mainSearchCriteria.v.cs=2.16.840.1.113883.6.69&mainSearchCriteria.vc=00310-0751- 39 & informationRecipient.languageCode.c = es
Om in tekststring te stjoeren sûnder in medikaasje-koade, moatte jo jo fraach identifisearje as in NDC-type fersyk, sadat MedlinePlus Connect wit dat jo ynformaasje sykje oer medisinen. Dit sil allinich wurkje foar Ingelske oanfragen. Jo fersyk kin sa útsjen: 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
Fersiken foar labtestynformaasje
MedlinePlus Connect biedt oerienkomsten mei laboratoriumtestynformaasje by it ûntfangen fan in LOINC-fersyk. De tsjinst kin in antwurd leverje yn it Ingelsk as Spaansk.
De MedlinePlus Connect webservice sil it folgjende werombringe:
D'r is miskien net altyd in wedstriid foar elke koade. Yn dy gefallen sil MedlinePlus Connect in nul antwurd jaan.
De basis URL fan 'e tsjinst is: https://connect.medlineplus.gov/service
Dit binne twa fereaske parameters foar elke labtest-fraach nei dizze tsjinst:
- Koadesysteem
- Identifisearje dat jo it LOINC-koadesysteem brûke. Brûke:
- mainSearchCriteria.v.cs = 2.16.840.1.113883.6.1
- MedlinePlus Connect sil ek akseptearje:
- mainSearchCriteria.v.cs = 2.16.840.1.113883.11.79
- Koade
identifisearje de wirklike koade dy't jo besykje op te sykjen:
mainSearchCriteria.v.c = 3187-2
Opsjonele Parameters
Koade titelJo kinne ek de namme fan 'e labestest identifisearje. Dizze ynformaasje hat lykwols gjin ynfloed op it antwurd. mainSearchCriteria.v.dn = Faktor IX-assay
Sjoch it boppesteande diel oer Utfierparameters foar details oer taal- en útfierformaten.
Beskriuwing fan selekteare atoomeleminten (of JSON-objekten) yn antwurd op labtestoanfragen
| Elemint | Beskriuwing |
|---|---|
| titel | Titel fan oerienkommende MedlinePlus lab testside |
| link | URL foar oerienkommende MedlinePlus lab testside |
| gearfetting | Snippet fan 'e pagina-ynhâld |
| skriuwer | Boarne-attribúsje foar de ynhâld fan 'e labestest |
Foarbylden fan fersiken foar labtests
Om ynformaasje foar in Ingelske sprekker oan te freegjen, kin jo fersyk der útsjen as ien fan 'e folgjende: 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 = en https://connect.medlineplus.gov/service?mainSearchCriteria.v.cs=2.16.840.1.113883.6.1&mainSearchCriteria.vc=3187-2&informationRecipient.languageCode.c = en
Om ynformaasje foar in Spaanske sprekker oan te freegjen, kin jo oanfraach lykje op ien fan 'e folgjende: 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
Akseptabel belied foar gebrûk
Om oerladen fan 'e MedlinePlus-tsjinners te foarkommen, freget NLM dat brûkers fan MedlinePlus Connect net mear dan 100 fersiken per minuut per IP-adres stjoere. Fersiken dy't dizze limyt oerskriuwe, wurde net betsjinne, en tsjinst sil 300 sekonden net wersteld wurde of oant de fersykrate ûnder de limyt falt, wat letter ek komt. Om it oantal oanfragen te beheinen dat jo nei Connect stjoere, adviseart NLM cachingresultaten foar in perioade fan 12-24 oere.
Dit belied is yn plak om te soargjen dat de tsjinst beskikber en tagonklik bliuwt foar alle brûkers. As jo in spesifike gebrûk hawwe dy't jo fereasket in grut oantal oanfragen nei MedlinePlus Connect te stjoeren, en dêrmei de limyt foar fersykpersintaazje oerskriuwt yn dit belied, nim dan kontakt mei ús op. NLM-meiwurkers sille jo fersyk evaluearje en bepale as in útsûndering kin wurde ferliend. Besjoch ek de dokumintaasje fan MedlinePlus XML-bestannen. Dizze XML-bestannen befetsje komplete records oer sûnensûnderwerpen en kinne tsjinje as in alternative metoade foar tagong ta MedlinePlus-gegevens.
Mear ynformaasje
Wy Riede Jo Oan
Is pine yn 'e kiel en boarst in kombinaasje om jo soargen oer te meitsjen?
