MedlinePlus Connect: Webservice
Inhalt
- Übersicht über den Webservice
- Ausgabeparameter
- Anfragen für Diagnose-(Problem-)Codes
- Optionale Parameter
- Beschreibung ausgewählter Atom-Elemente (oder JSON-Objekte) als Reaktion auf Problemcode-Anfragen
- Beispiele für Anfragen nach Problemcodes
- Zugehörige Dienste und Dateien
- Anfragen nach Arzneimittelinformationen
- Optionale Parameter
- Beschreibung ausgewählter Atom-Elemente (oder JSON-Objekte) als Antwort auf Medikamentenanfragen
- Beispiele für Anfragen nach Arzneimittelcodes
- Anfragen für Labortestinformationen
- Optionale Parameter
- Beschreibung ausgewählter Atom-Elemente (oder JSON-Objekte) als Antwort auf Lab-Testanforderungen
- Beispiele für Anfragen für Labortests
- Richtlinien zur akzeptablen Nutzung
- Mehr Informationen
MedlinePlus Connect ist als Webanwendung oder Webservice verfügbar. Nachfolgend finden Sie die technischen Details zur Implementierung des Webdienstes, der auf Anfragen reagiert, basierend auf:
Gerne können Sie die von MedlinePlus Connect zurückgegebenen Daten verlinken und anzeigen. Sie dürfen keine MedlinePlus-Seiten auf Ihre Site kopieren. Wenn Sie Daten aus dem MedlinePlus Connect Webservice verwenden, geben Sie bitte an, dass die Informationen von MedlinePlus.gov stammen, verwenden Sie jedoch nicht das MedlinePlus-Logo oder implizieren Sie anderweitig, dass MedlinePlus Ihr spezielles Produkt unterstützt. Weitere Informationen finden Sie auf der API-Seite von NLM. Weitere Informationen zum Verlinken auf MedlinePlus-Inhalte außerhalb dieses Dienstes finden Sie in unseren Richtlinien und Anweisungen zum Verlinken.
Wenn Sie sich für MedlinePlus Connect entscheiden, tragen Sie sich in die E-Mail-Liste ein, um auf dem Laufenden zu bleiben und sich mit Ihren Kollegen auszutauschen. Bitte teilen Sie uns mit, wenn Sie MedlinePlus Connect implementieren, indem Sie uns kontaktieren.
Übersicht über den Webservice
Die Parameter für die Web-Service-Anforderungen entsprechen dem URL-basierten Implementierungshandbuch für HL7-Knowledge-Requests (Infobutton). Die REST-basierte Antwort entspricht dem HL7 Context-Aware Knowledge Retrieval (Infobutton) Service-Oriented Architecture Implementation Guide. Die Ausgabe der Anfrage kann XML im Atom-Feed-Format, JSON oder JSONP sein.
Die Struktur der Anfrage gibt an, welche Art von Code Sie senden. In allen Fällen lautet die Basis-URL für den Webdienst: https://connect.medlineplus.gov/service
MedlinePlus Connect verwendet HTTPS-Verbindungen. HTTP-Anfragen werden nicht akzeptiert und vorhandene Implementierungen, die HTTP verwenden, sollten auf HTTPS aktualisiert werden.
Ausgabeparameter
Diese Parameter sind optional. Wenn Sie sie weglassen, sind die Standardantwort englische Informationen im XML-Format.
Sprache
Geben Sie an, ob die Antwort auf Englisch oder Spanisch erfolgen soll. MedlinePlus Connect geht davon aus, dass Englisch die Sprache ist, wenn es nicht angegeben ist.
Wenn Sie möchten, dass die Antwort auf die Problemcode-Suche auf Spanisch ist, verwenden Sie : informationRecipient.languageCode.c=es
(=sp auch akzeptiert)
Um Englisch anzugeben, verwenden Sie Folgendes: informationRecipient.languageCode.c=en
Format
Legen Sie fest, ob das Antwortformat XML, JSON oder JSONP sein soll. XML ist die Standardeinstellung.
- Verwenden Sie zum Anfordern von JSON:
- KnowledgeResponseType=Anwendung/json
- Verwenden Sie für JSONP:
- KnowledgeResponseType=application/javascript&callback=CallbackFunction wobei CallbackFunction ein Name ist, den Sie der Rückruffunktion geben.
- Verwenden Sie für eine Antwort in XML:
- knowledgeResponseType=text/xml oder lassen Sie den Parameter knowledgeResponseType aus der Anfrage weg.
Anfragen für Diagnose-(Problem-)Codes
Bei einem Problemcode gibt MedlinePlus Connect Links und Informationen von MedlinePlus-Gesundheitsthemenseiten, Genetikseiten oder Seiten anderer NIH-Institute zurück.
MedlinePlus Connect gibt Folgendes zurück:
Möglicherweise gibt es nicht immer für jeden Code eine Übereinstimmung. In diesen Fällen gibt MedlinePlus Connect eine Null-Antwort zurück.
Die Basis-URL des Dienstes lautet: https://connect.medlineplus.gov/service
Für jede Abfrage an diesen Dienst sind zwei erforderliche Parameter erforderlich:
- Codesystem
Identifizieren Sie das Problemcodesystem, das Sie verwenden werden.- Für ICD-10-CM verwenden:
- mainSearchCriteria.v.cs=2.16.840.1.113883.6.90
- Für ICD-9-CM verwenden:
- mainSearchCriteria.v.cs=2.16.840.1.113883.6.103
- Für SNOMED CT-Verwendung:
- mainSearchCriteria.v.cs=2.16.840.1.113883.6.96
- Code
Identifizieren Sie den tatsächlichen Code, den Sie suchen möchten:
mainSearchCriteria.v.c=250.33
Optionale Parameter
Codetitel
Sie können auch den Namen/Titel des Problemcodes identifizieren. Diese Informationen haben jedoch keinen Einfluss auf die Antwort (im Gegensatz zur MedlinePlus Connect-Webanwendung, bei der die Namens-/Titelinformationen verwendet werden können). mainSearchCriteria.v.dn=Diabetes mellitus mit anderem Koma Typ 1 unkontrolliert Siehe den obigen Abschnitt über Ausgabeparameter für Details zu Sprache und Ausgabeformaten.
Beschreibung ausgewählter Atom-Elemente (oder JSON-Objekte) als Reaktion auf Problemcode-Anfragen
Element | Klassenknoten | Beschreibung |
---|---|---|
Titel | Titel der übereinstimmenden MedlinePlus-Gesundheitsthemenseite oder GHR-Seite | |
Verknüpfung | URL für übereinstimmende MedlinePlus-Gesundheitsthemenseite oder GHR-Seite | |
Zusammenfassung | Die vollständige Zusammenfassung zum Thema Gesundheit. Dazu gehören eingebettete Links zu anderen relevanten Gesundheitsthemen und alle Formatierungen, einschließlich Aufzählungszeichen und Absatzabständen. Die Zusammenfassung ist in HTML. Für GHR-Seiten wird der erste Abschnitt der ganzen Seite bereitgestellt. | |
Zusammenfassung | Synonyme für das Thema. Diese werden auf einer Gesundheitsthemenseite als "auch genannt" bezeichnet. Nicht alle Themen haben "auch genannt"-Begriffe. | |
Zusammenfassung | Anerkennungsbestätigung für Zusammenfassungstext, wenn die Zusammenfassung mehrheitlich von einer anderen Bundesbehörde stammt. Nicht alle Zusammenfassungen haben eine Zuweisung. Nicht zugeordneter Text ist ein Original von MedlinePlus. | |
Zusammenfassung | Ausgewählte Links zum Thema. Dazu gehören der Seitenname, die URL und die zugehörige Organisation (sofern zutreffend). Die Links sind in einer Aufzählungsliste formatiert. Nicht alle Themen haben diese Links. Die Anzahl der Links kann von null bis zu Dutzenden reichen. |
Beispiele für Anfragen nach Problemcodes
Eine vollständige Anfrage für Diabetes mellitus mit anderem unkontrolliertem Koma Typ 1, ICD-9-Code 250.33, für einen spanischsprachigen Patienten hätte die folgende URL-Adresse: 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%20unkontrolliert&informationRecipient.languageCode.c=es
Ein Patient mit derselben Diagnose, aber das angeforderte Format ist JSON und die Sprache ist Englisch: https://connect.medlineplus.gov/service?mainSearchCriteria.v.cs=2.16.840.1.113883.6.103&mainSearchCriteria.vc=250.33&knowledgeResponseType=application /json
Bei einem Patienten wurde mit dem SNOMED CT-Code 41381004 eine „Pneumonie aufgrund von Pseudomonas“ diagnostiziert: 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=de
Ein Patient mit derselben Diagnose, aber im angeforderten Format ist 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
Zugehörige Dienste und Dateien
Um MedlinePlus-Gesundheitsthemen als Antwort auf Textanfragen anstelle von Problemcodes zu erhalten, untersuchen Sie den MedlinePlus-Webdienst. Wenn Sie außerdem alle Gesundheitsthemen von MedlinePlus im XML-Format benötigen, besuchen Sie unsere Seite mit XML-Dateien.
Anfragen nach Arzneimittelinformationen
MedlinePlus Connect bietet die besten Übereinstimmungen mit Arzneimittelinformationen, wenn Sie eine RXCUI erhalten. Es liefert auch gute Ergebnisse beim Empfang eines NDC-Codes. MedlinePlus Connect kann Antworten auf Englisch oder Spanisch bereitstellen.
Wenn Sie bei Anfragen nach englischen Arzneimittelinformationen keine NDC oder RXCUI senden oder wir aufgrund des Codes keine Übereinstimmung finden, verwendet die Anwendung die von Ihnen gesendete Textzeichenfolge, um die beste Übereinstimmung der Arzneimittelinformationen anzuzeigen. Bei Anfragen nach spanischen Arzneimittelinformationen antwortet MedlinePlus Connect nur auf NDCs oder RXCUIs und verwendet keine Textzeichenfolgen. Eine Antwort auf Englisch ist möglich, jedoch keine Antwort auf Spanisch.
Der MedlinePlus Connect-Webdienst gibt Folgendes zurück:
Es kann mehrere Antworten auf eine Medikamentenanfrage geben. Möglicherweise gibt es nicht immer für jede Anfrage eine Übereinstimmung. In diesen Fällen gibt MedlinePlus Connect eine Null-Antwort zurück.
Für Anfragen nach Arzneimittelinformationen lautet die Basis-URL: https://connect.medlineplus.gov/service
Um eine Anfrage zu senden, geben Sie diese Informationen an:
- Codesystem
Identifizieren Sie die Art des Medikamentencodes, den Sie senden. (Erforderlich für Englisch und Spanisch)- Für RXCUI-Verwendung:
- mainSearchCriteria.v.cs=2.16.840.1.113883.6.88
- Für NDC-Verwendung:
- mainSearchCriteria.v.cs=2.16.840.1.113883.6.69
- Code
Identifizieren Sie den tatsächlichen Code, den Sie suchen möchten. (Bevorzugt für Englisch, Erforderlich für Spanisch)
mainSearchCriteria.v.c=637188 - Medikamentenname
Identifizieren Sie den Namen des Medikaments mit einer Textzeichenfolge. (Optional für Englisch, nicht für Spanisch verwendet)
mainSearchCriteria.v.dn=Chantix 0,5 mg orale Tablette
Optionale Parameter
CodetitelWenn Sie eine Anfrage nach englischen Informationen senden, können Sie den optionalen Parameter des Namens des Medikaments angeben. Dies ist im obigen Abschnitt detailliert beschrieben. mainSearchCriteria.v.dn=Chantix 0,5 mg orale Tablette
Weitere Informationen zu Sprache und Ausgabeformaten finden Sie im obigen Abschnitt zu Ausgabeparametern.
Beschreibung ausgewählter Atom-Elemente (oder JSON-Objekte) als Antwort auf Medikamentenanfragen
Element | Beschreibung |
---|---|
Titel | Titel für übereinstimmende MedlinePlus-Medikamentenseite |
Verknüpfung | URL für die übereinstimmende MedlinePlus-Medikamentenseite |
Autor | Quellenangabe für Arzneimittelinformationen |
Beispiele für Anfragen nach Arzneimittelcodes
Ihre Anfrage zu Medikamenteninformationen sollte wie folgt aussehen.
Um Informationen von einer RXCUI anzufordern, sollte Ihre Anfrage wie folgt aussehen: 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=en
Um Informationen von einem NDC für einen Spanischsprecher anzufordern, sollte Ihre Anfrage wie folgt aussehen: https://connect.medlineplus.gov/service?mainSearchCriteria.v.cs=2.16.840.1.113883.6.69&mainSearchCriteria.vc=00310-0751- 39&informationRecipient.languageCode.c=es
Um eine Textzeichenfolge ohne Medikamentencode zu senden, müssen Sie Ihre Anfrage als NDC-Anfrage kennzeichnen, damit MedlinePlus Connect weiß, dass Sie nach Medikamenteninformationen suchen. Dies funktioniert nur für englische Anfragen. Ihre Anfrage könnte so aussehen: 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 =de
Anfragen für Labortestinformationen
MedlinePlus Connect bietet Übereinstimmungen mit Labortestinformationen, wenn eine LOINC-Anfrage empfangen wird. Der Dienst kann eine Antwort auf Englisch oder Spanisch bereitstellen.
Der MedlinePlus Connect-Webdienst gibt Folgendes zurück:
Möglicherweise gibt es nicht immer für jeden Code eine Übereinstimmung. In diesen Fällen gibt MedlinePlus Connect eine Null-Antwort zurück.
Die Basis-URL des Dienstes lautet: https://connect.medlineplus.gov/service
Dies sind zwei erforderliche Parameter für jede Labortestabfrage an diesen Dienst:
- Codesystem
- Stellen Sie sicher, dass Sie das LOINC-Codesystem verwenden. Benutzen:
- mainSearchCriteria.v.cs=2.16.840.1.113883.6.1
- MedlinePlus Connect akzeptiert auch:
- mainSearchCriteria.v.cs=2.16.840.1.113883.11.79
- Code
Identifizieren Sie den tatsächlichen Code, den Sie suchen möchten:
mainSearchCriteria.v.c=3187-2
Optionale Parameter
CodetitelSie können auch den Namen des Labortests identifizieren. Diese Informationen haben jedoch keinen Einfluss auf die Antwort. mainSearchCriteria.v.dn=Faktor-IX-Assay
Weitere Informationen zu Sprache und Ausgabeformaten finden Sie im obigen Abschnitt zu Ausgabeparametern.
Beschreibung ausgewählter Atom-Elemente (oder JSON-Objekte) als Antwort auf Lab-Testanforderungen
Element | Beschreibung |
---|---|
Titel | Titel der übereinstimmenden MedlinePlus-Labortestseite |
Verknüpfung | URL für übereinstimmende MedlinePlus-Labortestseite |
Zusammenfassung | Ausschnitt aus dem Seiteninhalt |
Autor | Quellenangabe für den Inhalt des Labortests |
Beispiele für Anfragen für Labortests
Um Informationen für einen Englischsprachigen anzufordern, kann Ihre Anfrage wie folgt aussehen: 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 =de
Um Informationen für einen Spanischsprachigen anzufordern, kann Ihre Anfrage wie folgt aussehen: 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
Richtlinien zur akzeptablen Nutzung
Um eine Überlastung der MedlinePlus-Server zu vermeiden, verlangt NLM, dass Benutzer von MedlinePlus Connect nicht mehr als 100 Anfragen pro Minute pro IP-Adresse senden. Anfragen, die dieses Limit überschreiten, werden nicht bedient und der Service wird 300 Sekunden lang nicht wiederhergestellt oder bis die Anfragerate unter das Limit fällt, je nachdem, was später eintritt. Um die Anzahl der Anfragen zu begrenzen, die Sie an Connect senden, empfiehlt NLM, die Ergebnisse für einen Zeitraum von 12 bis 24 Stunden zwischenzuspeichern.
Diese Richtlinie soll sicherstellen, dass der Dienst für alle Benutzer verfügbar und zugänglich bleibt. Wenn Sie einen bestimmten Anwendungsfall haben, bei dem Sie eine große Anzahl von Anfragen an MedlinePlus Connect senden müssen und somit die in dieser Richtlinie beschriebene Begrenzung der Anfragerate überschreiten, kontaktieren Sie uns bitte. NLM-Mitarbeiter werden Ihre Anfrage prüfen und entscheiden, ob eine Ausnahme gewährt werden kann. Bitte lesen Sie auch die Dokumentation zu den MedlinePlus-XML-Dateien. Diese XML-Dateien enthalten vollständige Datensätze zu Gesundheitsthemen und können als alternative Methode für den Zugriff auf MedlinePlus-Daten dienen.