MedlinePlus Connect: webservice
Inhoud
- Overzicht webservice
- Uitgangsparameters:
- Verzoeken om diagnose (probleem) codes
- Optionele parameters:
- Beschrijving van geselecteerde atoomelementen (of JSON-objecten) in reactie op probleemcodeverzoeken
- Voorbeelden van verzoeken om probleemcodes
- Gerelateerde services en bestanden
- Verzoeken om informatie over geneesmiddelen
- Optionele parameters:
- Beschrijving van geselecteerde atoomelementen (of JSON-objecten) in reactie op medicatieverzoeken
- Voorbeelden van verzoeken om medicijncodes
- Verzoeken om informatie over laboratoriumtests
- Optionele parameters:
- Beschrijving van geselecteerde atoomelementen (of JSON-objecten) in reactie op laboratoriumtestverzoeken
- Voorbeelden van aanvragen voor laboratoriumtests
- Aanvaardbaar gebruik beleid
- Meer informatie
MedlinePlus Connect is beschikbaar als webapplicatie of webservice. Hieronder vindt u de technische details voor het implementeren van de webservice, die reageert op verzoeken op basis van:
U bent welkom om te linken naar en de gegevens weer te geven die door MedlinePlus Connect worden geretourneerd. U mag geen MedlinePlus-pagina's naar uw site kopiëren. Als u gegevens van de MedlinePlus Connect-webservice gebruikt, geeft u dan aan dat de informatie afkomstig is van MedlinePlus.gov, maar gebruikt u niet het MedlinePlus-logo of suggereert u anderszins dat MedlinePlus uw specifieke product goedkeurt. Raadpleeg de API-pagina van NLM voor meer informatie. Voor meer informatie over het linken naar MedlinePlus-inhoud buiten deze service, raadpleegt u onze richtlijnen en instructies voor het koppelen.
Als je besluit om MedlinePlus Connect te gebruiken, meld je dan aan voor de e-maillijst om op de hoogte te blijven van de ontwikkelingen en ideeën uit te wisselen met je collega's. Laat het ons weten als u MedlinePlus Connect implementeert door contact met ons op te nemen.
Overzicht webservice
De parameters voor de webserviceverzoeken voldoen aan de HL7 Context-Aware Knowledge Retrieval (Infobutton) Knowledge Request URL-Based Implementation Guide. Het op REST gebaseerde antwoord voldoet aan de HL7 Context-Aware Knowledge Retrieval (Infobutton) Service-Oriented Architecture Implementation Guide. De uitvoer van het verzoek kan XML zijn in de Atom-feedindeling, JSON of JSONP.
De structuur van het verzoek geeft aan welk type code u verstuurt. In alle gevallen is de basis-URL voor de webservice: https://connect.medlineplus.gov/service
MedlinePlus Connect maakt gebruik van HTTPS-verbindingen. HTTP-verzoeken worden niet geaccepteerd en bestaande implementaties die HTTP gebruiken, moeten worden bijgewerkt naar HTTPS.
Uitgangsparameters:
Deze parameters zijn optioneel. Als u ze weglaat, is het standaardantwoord Engelse informatie in XML-indeling.
Taal
Geef aan of u wilt dat het antwoord in het Engels of Spaans is. MedlinePlus Connect gaat ervan uit dat Engels de taal is als dit niet is opgegeven.
Als u wilt dat het antwoord op het opzoeken van de probleemcode in het Spaans is, gebruikt u: informationRecipient.languageCode.c=es
(=sp ook geaccepteerd)
Gebruik het volgende om Engels op te geven: informationRecipient.languageCode.c=en
Formaat
Geef aan of u wilt dat het antwoordformaat XML, JSON of JSONP is. XML is de standaard.
- Gebruik om JSON aan te vragen:
- kennisResponseType=toepassing/json
- Gebruik voor JSONP:
- knowledgeResponseType=application/javascript&callback=CallbackFunction waarbij CallbackFunction een naam is die u aan de terugbelfunctie geeft.
- Gebruik voor een antwoord in XML:
- knowledgeResponseType=text/xml of laat de parameter knowledgeResponseType uit de aanvraag.
Verzoeken om diagnose (probleem) codes
Voor een probleemcode retourneert MedlinePlus Connect links en informatie van MedlinePlus-pagina's met gezondheidsthema's, geneticapagina's of pagina's van andere NIH-instituten.
MedlinePlus Connect retourneert het volgende:
Er is mogelijk niet altijd een overeenkomst voor elke code. In die gevallen zal MedlinePlus Connect een null-antwoord retourneren.
De basis-URL van de service is: https://connect.medlineplus.gov/service
Er zijn twee vereiste parameters voor elke query naar deze service:
- Codesysteem
Identificeer het probleemcodesysteem dat u gaat gebruiken.- Voor ICD-10-CM gebruik:
- mainSearchCriteria.v.cs=2.16.840.1.113883.6.90
- Voor ICD-9-CM gebruik:
- mainSearchCriteria.v.cs=2.16.840.1.113883.6.103
- Voor gebruik van SNOMED CT:
- mainSearchCriteria.v.cs=2.16.840.1.113883.6.96
- Code
Identificeer de daadwerkelijke code die u probeert op te zoeken:
mainSearchCriteria.v.c=250.33
Optionele parameters:
Code Titel
U kunt ook de naam/titel van de probleemcode identificeren. Deze informatie heeft echter geen invloed op de reactie (in tegenstelling tot de MedlinePlus Connect-webtoepassing waar de naam-/titelinformatie kan worden gebruikt). mainSearchCriteria.v.dn=Diabetes mellitus met ander coma type 1 ongecontroleerd Zie de bovenstaande sectie over uitvoerparameters voor details over taal en uitvoerformaten.
Beschrijving van geselecteerde atoomelementen (of JSON-objecten) in reactie op probleemcodeverzoeken
Element | Klassenknooppunt | Omschrijving |
---|---|---|
titel | Titel van overeenkomende MedlinePlus-pagina met gezondheidsonderwerpen of GHR-pagina | |
koppeling | URL voor overeenkomende MedlinePlus-pagina met gezondheidsonderwerpen of GHR-pagina | |
samenvatting | De volledige samenvatting voor het onderwerp gezondheid. Dit omvat ingesloten links naar andere relevante gezondheidsonderwerpen en alle opmaak, inclusief opsommingstekens en alinea-afstand. De samenvatting is in HTML. Voor GHR-pagina's is het eerste gedeelte van de volledige pagina beschikbaar. | |
samenvatting | Synoniemen voor het onderwerp. Deze worden op een pagina met gezondheidsonderwerpen aangeduid als "Ook genoemd". Niet alle onderwerpen hebben "Ook wel"-termen. | |
samenvatting | Naamsvermelding voor samenvattingstekst, als het grootste deel van de samenvatting afkomstig was van een andere federale instantie. Niet alle samenvattingen hebben een attributie. Niet-toegeschreven tekst is origineel van MedlinePlus. | |
samenvatting | Geselecteerde links die bij het onderwerp horen. Dit omvat de paginanaam, URL en bijbehorende organisatie (indien van toepassing). De links zijn opgemaakt in een lijst met opsommingstekens. Niet alle onderwerpen hebben deze links. Het aantal links kan variëren van nul tot tientallen. |
Voorbeelden van verzoeken om probleemcodes
Een volledig verzoek voor Diabetes Mellitus met ander ongecontroleerd coma type 1, ICD-9 code 250.33, voor een Spaanssprekende patiënt zou het volgende URL-adres hebben: https://connect.medlineplus.gov/service?mainSearchCriteria.v.cs=2.16 .840.1.113883.6.103&mainSearchCriteria.vc=250.33&mainSearchCriteria.v.dn=Diabetes%20mellitus%20with%20other%20coma%20type%201%20uncontroll&informationRecipient.languageCode.c=es
Een patiënt met dezelfde diagnose maar het gevraagde formaat is JSON en de taal is Engels: https://connect.medlineplus.gov/service?mainSearchCriteria.v.cs=2.16.840.1.113883.6.103&mainSearchCriteria.vc=250.33&knowledgeResponseType=application /json
Een patiënt gediagnosticeerd met "Pneumonie als gevolg van Pseudomonas" met behulp van SNOMED CT-code 41381004: https://connect.medlineplus.gov/service?mainSearchCriteria.v.cs=2.16.840.1.113883.6.96&mainSearchCriteria.vc=41381004&mainSearchCriteria.v.dn= Longontsteking%20due%20to%20Pseudomonas%20%28stoornis%29&informationRecipient.languageCode.c=nl
Een patiënt met dezelfde diagnose maar het gevraagde 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=CallbackFunction
Gerelateerde services en bestanden
Als u MedlinePlus-gezondheidsonderwerpen wilt ontvangen als reactie op sms-verzoeken, in plaats van op probleemcodes, moet u de MedlinePlus-webservice onderzoeken. Zie ook onze pagina met XML-bestanden als u de volledige set MedlinePlus-gezondheidsonderwerpen in XML-indeling nodig heeft.
Verzoeken om informatie over geneesmiddelen
MedlinePlus Connect biedt de beste overeenkomsten met geneesmiddelinformatie bij het ontvangen van een RXCUI. Het geeft ook goede resultaten bij het ontvangen van een NDC-code. MedlinePlus Connect kan antwoorden in het Engels of Spaans geven.
Voor verzoeken om Engelse medicatie-informatie, als u geen NDC of RXCUI verzendt of als we geen overeenkomst vinden op basis van de code, gebruikt de toepassing de tekstreeks die u verzendt om de beste overeenkomst met medicijninformatie weer te geven. Voor verzoeken om Spaanse medicatie-informatie reageert MedlinePlus Connect alleen op NDC's of RXCUI's en gebruikt geen tekstreeksen. Het is mogelijk om een antwoord in het Engels te krijgen, maar geen antwoord in het Spaans.
De MedlinePlus Connect-webservice retourneert het volgende:
Er kunnen meerdere reacties zijn op één medicatieverzoek. Er is mogelijk niet altijd een match voor elk verzoek. In die gevallen zal MedlinePlus Connect een null-antwoord retourneren.
Voor verzoeken om informatie over geneesmiddelen is de basis-URL: https://connect.medlineplus.gov/service
Voeg deze gegevens toe om een verzoek te verzenden:
- Codesysteem
Identificeer het type medicatiecode dat u verzendt. (Vereist voor Engels en Spaans)- Voor RXCUI-gebruik:
- mainSearchCriteria.v.cs=2.16.840.1.113883.6.88
- Voor NDC-gebruik:
- mainSearchCriteria.v.cs=2.16.840.1.113883.6.69
- Code
Identificeer de daadwerkelijke code die u probeert op te zoeken. (Voorkeur voor Engels, Vereist voor Spaans)
mainSearchCriteria.v.c=637188 - Naam geneesmiddel
Identificeer de naam van het medicijn met een tekstreeks. (Optioneel voor Engels, niet gebruikt voor Spaans)
mainSearchCriteria.v.dn=Chantix 0,5 MG orale tablet
Optionele parameters:
Code TitelBij het verzenden van een verzoek om Engelse informatie kunt u de optionele parameter van de naam van het medicijn opnemen. Dit wordt gedetailleerd beschreven in het bovenstaande gedeelte. mainSearchCriteria.v.dn=Chantix 0,5 MG orale tablet
Zie het bovenstaande gedeelte over uitvoerparameters voor details over taal en uitvoerformaten.
Beschrijving van geselecteerde atoomelementen (of JSON-objecten) in reactie op medicatieverzoeken
Element | Omschrijving |
---|---|
titel | Titel voor overeenkomende MedlinePlus-medicatiepagina |
koppeling | URL voor de overeenkomende MedlinePlus-medicatiepagina |
schrijver | Bronvermelding voor medicatie-informatie |
Voorbeelden van verzoeken om medicijncodes
Uw aanvraag voor medicatie-informatie moet er als volgt uitzien.
Om informatie door een RXCUI op te vragen, moet uw verzoek er als volgt uitzien: 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&informationRecipient.languageCode.c=nl
Als u informatie wilt aanvragen bij een NDC voor een Spaanssprekende, moet uw verzoek er als volgt uitzien: https://connect.medlineplus.gov/service?mainSearchCriteria.v.cs=2.16.840.1.113883.6.69&mainSearchCriteria.vc=00310-0751- 39&informationRecipient.languageCode.c=es
Als u een tekstreeks wilt verzenden zonder medicatiecode, moet u uw vraag identificeren als een NDC-verzoek, zodat MedlinePlus Connect weet dat u op zoek bent naar medicatie-informatie. Dit werkt alleen voor Engelse verzoeken. Uw verzoek kan er als volgt uitzien: 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
Verzoeken om informatie over laboratoriumtests
MedlinePlus Connect biedt overeenkomsten met laboratoriumtestinformatie bij ontvangst van een LOINC-verzoek. De service kan een antwoord geven in het Engels of Spaans.
De MedlinePlus Connect-webservice retourneert het volgende:
Er is mogelijk niet altijd een overeenkomst voor elke code. In die gevallen zal MedlinePlus Connect een null-antwoord retourneren.
De basis-URL van de service is: https://connect.medlineplus.gov/service
Dit zijn twee vereiste parameters voor elke labtestquery naar deze service:
- Codesysteem
- Identificeer dat u het LINC-codesysteem gebruikt. Gebruik:
- mainSearchCriteria.v.cs=2.16.840.1.113883.6.1
- MedlinePlus Connect accepteert ook:
- mainSearchCriteria.v.cs=2.16.840.1.113883.11.79
- Code
identificeer de daadwerkelijke code die u probeert op te zoeken:
mainSearchCriteria.v.c=3187-2
Optionele parameters:
Code TitelU kunt ook de naam van de laboratoriumtest identificeren. Deze informatie heeft echter geen invloed op de reactie. mainSearchCriteria.v.dn=Factor IX-test
Zie het bovenstaande gedeelte over uitvoerparameters voor details over taal en uitvoerformaten.
Beschrijving van geselecteerde atoomelementen (of JSON-objecten) in reactie op laboratoriumtestverzoeken
Element | Omschrijving |
---|---|
titel | Titel van overeenkomende MedlinePlus-labtestpagina |
koppeling | URL voor overeenkomende MedlinePlus-labtestpagina |
samenvatting | Fragment van de pagina-inhoud |
schrijver | Bronvermelding voor de inhoud van de laboratoriumtest |
Voorbeelden van aanvragen voor laboratoriumtests
Als u informatie wilt aanvragen voor een Engelstalige spreker, kan uw verzoek er als volgt uitzien: 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.languageCode.c =en
Als u informatie wilt aanvragen voor een Spaanssprekende, kan uw verzoek er als volgt uitzien: 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.c =es
Aanvaardbaar gebruik beleid
Om overbelasting van de MedlinePlus-servers te voorkomen, vereist NLM dat gebruikers van MedlinePlus Connect niet meer dan 100 verzoeken per minuut per IP-adres verzenden. Verzoeken die deze limiet overschrijden, worden niet behandeld en de service wordt pas na 300 seconden hersteld of totdat de aanvraagsnelheid onder de limiet komt, afhankelijk van wat later komt. Om het aantal verzoeken dat u naar Connect stuurt te beperken, raadt NLM aan om de resultaten gedurende een periode van 12-24 uur in de cache op te slaan.
Dit beleid is opgesteld om ervoor te zorgen dat de service beschikbaar en toegankelijk blijft voor alle gebruikers. Neem contact met ons op als u een specifiek gebruiksscenario heeft waarbij u een groot aantal verzoeken naar MedlinePlus Connect moet sturen en dus de in dit beleid beschreven limiet voor het aantal verzoeken moet overschrijden. NLM-medewerkers zullen uw verzoek beoordelen en bepalen of een uitzondering kan worden toegestaan. Raadpleeg ook de documentatie van de MedlinePlus XML-bestanden. Deze XML-bestanden bevatten volledige dossiers over gezondheidsonderwerpen en kunnen dienen als een alternatieve methode om toegang te krijgen tot MedlinePlus-gegevens.