Render API: Medikationsplan abrufen
Der Medication Service unterstützt die aufbereitete Generierung des aktuellen Medikationsplandokuments (eMP) im Datenformat PDF/A (d.h. hier kein FHIR).
Voraussetzungen
Dem Medication Service MÜSSEN zur Auswertung in Operationen für jede Aktivität die folgenden Informationen bereitstehen:
- Name des Nutzers
- Nutzergruppe/Rolle ((profession-)oid)
- Kennung (Telematik-ID oder KVNR)
- Hinweis auf eine gültige Befugnis des aktuellen Benutzers (requestor)
HTTP Header-Parameter
Ein ePA-Client MUSS die folgenden HTTP Header bei einer Anfrage an den Medication Service setzen:
| Name | Anforderung | Datentyp | Beschreibung |
|---|---|---|---|
| x-insurantid | MUSS | String | Health Record Identifier |
| x-useragent | KANN | String | User Agent Information |
| X-Request-ID | MUSS | String | UUID der Nachricht |
Wiederholungsintervalle
Die folgenden Wiederholungsintervalle werden im Falle einer Fehlerantwort definiert:
- '409' Conflict (statusMismatch)
- etwa 24 Stunden
- '500' Internal Error
- etwa 10 Minuten
Erlaubte Nutzergruppen
| professionOID |
|---|
| oid_versicherter |
| oid_praxis_arzt |
| oid_krankenhaus |
| oid_institution |
| oid_krankenhaus |
| oid_institution-vorsorge-reha |
| oid_zahnarztpraxis |
| oid_praxis_psychotherapeut |
| oid_institution-oegd |
| oid_öffentliche_apotheke |
| oid_institution-pflege |
| oid_institution-geburtshilfe |
| oid_praxis-physiotherapeut |
| oid_institution-arbeitsmedizin |
Interaktion (Render MedicationPlan)
Ein ePA-Client kann über den folgenden URL-Aufruf das o.g. Format anfordern:
GET [base]/epa/medication/render/v1/emp/pdf
OperationId: renderMedicationPlanToPDF_MedicationSvc
Alle Listeneinträge werden automatisch nach absteigender Reihenfolge beginnend mit dem zuletzt aktualisierten Eintrag sortiert. Grundlage ist der FHIR-Elementwert Meta.lastUpdated der Instanz vom Typ EPAMedicationStatement. Ferner müssen sie in die zugeordneten Zwischenüberschriften eingruppiert sein.
Rückgabeformate
Den folgenden Media Type (d.h. Content-Type) MUSS der Medication Service für eine erfolgreiche Ausgabe setzen:
| Ausgabeformat | Media Type | HTTP Code |
|---|---|---|
| PDF/A | application/pdf |
200 |
Antwort-Status-Codes
| Status Code | Bedingung | Error Code | Bemerkung |
|---|---|---|---|
| 200 | Successful operation | ||
| 400 | Unknown or invalid search parameter (s) | ||
| 403 | Requestor role is not in the list of allowed user groups | invalidOid | |
| 404 | Health record is in state UNKNOWN or INITIALIZED | noHealthRecord | (siehe 'Wiederholungsintervalle') |
| 404 | Rendering led to empty list | noEntries | |
| 409 | Health record is in state SUSPENDED | statusMismatch | (siehe 'Wiederholungsintervalle') |
| 423 | If the insurant objected to the medication process or objected to the submission of prescription and dispensation data into the ePA system, the Medication Service is locked. | locked | |
| 500 | Any other error | internalError | (siehe 'Wiederholungsintervalle') |
Error Codes MÜSSEN mit dem entsprechenden HTTP Status Code vom Medication Service mit dem Media Type application/json nach folgendem Schema zurückgegeben werden:
{
"errorCode": "statusMismatch"
}
Schematischer Aufbau
Die Festlegungen für den Ausdruck des eMPs werden nachgereicht, da sie sich derzeit noch in Abstimmung befinden. Einbezogen sind hier sowohl gematik als auch mio42, KBV, BÄK und ABDA.