Query API: MedicationDispense (Abgabe)

Profile: EPAMedicationDispense

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 (Query MedicationDispense)

GET [base]/epa/medication/api/v1/fhir/MedicationDispense

OperationId: listMedicationDispenses_MedicationSvc


Anfragen an die MedicationDispense-Ressource können über die RESTful API mittels HTTP GET-Anfragen durchgeführt werden. Dabei können spezifische Suchparameter genutzt werden, um die Anfragen zu verfeinern. Zum Beispiel:

  • Suche nach Medikamentenabgaben, die an einem bestimmten Tag erfolgten: ?whenHandedOver=2025-02-14
  • Suche nach Medikamentenabgaben, die innerhalb eines Datumsbereichs erfolgten: ?whenHandedOver=ge2025-02-01&whenHandedOver=le2025-02-28
  • Suche nach Medikamentenabgaben, die vor oder nach einem bestimmten Datum erfolgten: ?whenHandedOver=gt2025-03-15 (nach dem 15. März 2025)
  • Suche nach Medikamentenabgaben, die zwischen dem 1. März und dem 15. März 2025 abgeschlossen und übergeben wurden: ?whenHandedOver=ge2025-03-01&whenHandedOver=le2025-03-15&status=completed

Bei Anfragen an die QueryAPI für die MedicationDispense-Ressource wird die Antwort als ein FHIR Bundle des Typs searchset zurückgegeben. Dieses Bundle enthält eine Sammlung von Einträgen, die jeweils eine Instanz der MedicationDispense-Ressource oder weiteren Ressourcen im Zusammenhang mit der Abfrage enthalten können.

Suchparameter

ParameterTypeDefinitionBeschreibungAnforderung
_idtokenhttp://hl7.org/fhir/SearchParameter/Resource-id

Resource.​id

MUSS
_lastUpdateddatehttp://hl7.org/fhir/SearchParameter/Resource-lastUpdated

Resource.​meta.​lastUpdated

MUSS
identifiertokenhttp://hl7.org/fhir/SearchParameter/clinical-identifier

MedicationDispense.identifier

MUSS
whenhandedoverdatehttp://hl7.org/fhir/SearchParameter/MedicationDispense-whenhandedover

MedicationDispense.whenHandedOver

MUSS
prescriptionreferencehttp://hl7.org/fhir/SearchParameter/medications-prescription

MedicationDispense.authorizingPrescription

MUSS
performerreferencehttp://hl7.org/fhir/SearchParameter/MedicationDispense-performer

MedicationDispense.performer.actor

MUSS
statustokenhttp://hl7.org/fhir/SearchParameter/medications-status

MedicationDispense.status

MUSS
medicationreferencehttp://hl7.org/fhir/SearchParameter/medications-medication

MedicationDispense.medication as Reference

MUSS
rx-prescriptiontokenhttps://gematik.de/fhir/epa-medication/SearchParameter/rx-prescription-process-sp

MedicationDispense.extension

MUSS

Suche per Include oder RevInclude

Include
MedicationDispense.medication
MedicationDispense.performer
MedicationDispense.prescription
RevInclude
Provenance.target

Beispielantworten

{
    "resourceType": "Bundle",
    "id": "example-searchset-medicationdispense",
    "type": "searchset",
    "total": 100,
    "link":  [
        {
            "relation": "self",
            "url": "/epa/medication/api/v1/fhir/MedicationDispense?_offset=20&_count=10"
        },
        {
            "relation": "previous",
            "url": "/epa/medication/api/v1/fhir/MedicationDispense?_offset=10&_count=10"
        },
        {
            "relation": "next",
            "url": "/epa/medication/api/v1/fhir/MedicationDispense?_offset=30&_count=10"
        }
    ],
    "entry":  [
        {
            "fullUrl": "https://epa-as-0.prod.epa4all.de/vau-cid-1234/epa/medication/api/v1/fhir/MedicationDispense/4e6e1623-778e-44a3-b208-8479f5339e43",
            "resource": {
                "resourceType": "MedicationDispense",
                "id": "4e6e1623-778e-44a3-b208-8479f5339e43",
                "meta": {
                    "versionId": "1",
                    "lastUpdated": "2025-01-22T14:43:33.244Z",
                    "profile":  [
                        "https://gematik.de/fhir/epa-medication/StructureDefinition/epa-medication-dispense"
                    ]
                },
                "extension":  [
                    {
                        "valueIdentifier": {
                            "system": "https://gematik.de/fhir/epa-medication/sid/rx-prescription-process-identifier",
                            "value": "160.153.303.257.459_20250122"
                        },
                        "url": "https://gematik.de/fhir/epa-medication/StructureDefinition/rx-prescription-process-identifier-extension"
                    }
                ],
                "identifier":  [
                    {
                        "system": "https://gematik.de/fhir/epa-medication/sid/rx-originator-process-identifier",
                        "value": "5d8fbf7c-bdb0-44c2-95fe-423ae0404ccd_160.153.303.257.459"
                    }
                ],
                "status": "completed",
                "category": {
                    "coding":  [
                        {
                            "code": "prescription",
                            "system": "https://gematik.de/fhir/terminology/CodeSystem/EPAMedicationDispenseCategoryCS",
                            "display": "prescription dispense"
                        }
                    ]
                },
                "medicationReference": {
                    "reference": "Medication/2571d29b-e213-40ec-b817-a1490718a490"
                },
                "subject": {
                    "identifier": {
                        "type": {
                            "coding":  [
                                {
                                    "code": "KVZ10",
                                    "system": "http://fhir.de/CodeSystem/identifier-type-de-basis",
                                    "display": "Krankenversichertennummer"
                                }
                            ]
                        },
                        "value": "X110411319",
                        "system": "http://fhir.de/sid/gkv/kvid-10"
                    }
                },
                "whenHandedOver": "2025-01-22",
                "performer":  [
                    {
                        "actor": {
                            "reference": "Organization/3856402c-7636-4fbd-98bd-d278852b8e88"
                        }
                    }
                ],
                "authorizingPrescription":  [
                    {
                        "reference": "MedicationRequest/bb91cde8-0426-4f4b-a766-5d818d0605bd"
                    }
                ],
                "dosageInstruction":  [
                    {
                        "text": "1-0-0-0"
                    }
                ],
                "substitution": {
                    "wasSubstituted": false
                }
            },
            "search": {
                "mode": "match"
            }
        },
        {
            "fullUrl": "https://epa-as-0.prod.epa4all.de/vau-cid-1234/epa/medication/api/v1/fhir/MedicationDispense/46865835-8c8f-4139-86ba-271bd3565250",
            "resource": {
                "resourceType": "MedicationDispense",
                "id": "46865835-8c8f-4139-86ba-271bd3565250",
                "meta": {
                    "versionId": "1",
                    "lastUpdated": "2025-01-22T14:43:33.244Z",
                    "profile":  [
                        "https://gematik.de/fhir/epa-medication/StructureDefinition/epa-medication-dispense"
                    ]
                },
                "extension":  [
                    {
                        "valueIdentifier": {
                            "system": "https://gematik.de/fhir/epa-medication/sid/rx-prescription-process-identifier",
                            "value": "160.153.303.257.459_20250122"
                        },
                        "url": "https://gematik.de/fhir/epa-medication/StructureDefinition/rx-prescription-process-identifier-extension"
                    }
                ],
                "identifier":  [
                    {
                        "system": "https://gematik.de/fhir/epa-medication/sid/rx-originator-process-identifier",
                        "value": "86d65df3-5ca4-457d-8859-285830fe091b_160.153.303.257.459"
                    }
                ],
                "status": "completed",
                "category": {
                    "coding":  [
                        {
                            "code": "prescription",
                            "system": "https://gematik.de/fhir/terminology/CodeSystem/EPAMedicationDispenseCategoryCS",
                            "display": "prescription dispense"
                        }
                    ]
                },
                "medicationReference": {
                    "reference": "Medication/3b990824-3814-4d75-80b1-e2935827f8f0"
                },
                "subject": {
                    "identifier": {
                        "type": {
                            "coding":  [
                                {
                                    "code": "KVZ10",
                                    "system": "http://fhir.de/CodeSystem/identifier-type-de-basis",
                                    "display": "Krankenversichertennummer"
                                }
                            ]
                        },
                        "value": "X110411319",
                        "system": "http://fhir.de/sid/gkv/kvid-10"
                    }
                },
                "whenHandedOver": "2025-01-22",
                "performer":  [
                    {
                        "actor": {
                            "reference": "Organization/3856402c-7636-4fbd-98bd-d278852b8e88"
                        }
                    }
                ],
                "authorizingPrescription":  [
                    {
                        "reference": "MedicationRequest/bb91cde8-0426-4f4b-a766-5d818d0605bd"
                    }
                ],
                "dosageInstruction":  [
                    {
                        "text": "1-0-0-0"
                    }
                ],
                "substitution": {
                    "wasSubstituted": false
                }
            },
            "search": {
                "mode": "match"
            }
        }
    ]
}
<Bundle xmlns="http://hl7.org/fhir">
    <id value="example-searchset-medicationdispense" />
    <type value="searchset" />
    <total value="100" />
    <link>
        <relation value="self" />
        <url value="/epa/medication/api/v1/fhir/MedicationDispense?_offset=20&amp;_count=10" />
    </link>
    <link>
        <relation value="previous" />
        <url value="/epa/medication/api/v1/fhir/MedicationDispense?_offset=10&amp;_count=10" />
    </link>
    <link>
        <relation value="next" />
        <url value="/epa/medication/api/v1/fhir/MedicationDispense?_offset=30&amp;_count=10" />
    </link>
    <entry>
        <fullUrl value="https://epa-as-0.prod.epa4all.de/vau-cid-1234/epa/medication/api/v1/fhir/MedicationDispense/4e6e1623-778e-44a3-b208-8479f5339e43" />
        <resource>
            <MedicationDispense>
                <id value="4e6e1623-778e-44a3-b208-8479f5339e43" />
                <meta>
                    <versionId value="1" />
                    <lastUpdated value="2025-01-22T14:43:33.244Z" />
                    <profile value="https://gematik.de/fhir/epa-medication/StructureDefinition/epa-medication-dispense" />
                </meta>
                <extension url="https://gematik.de/fhir/epa-medication/StructureDefinition/rx-prescription-process-identifier-extension">
                    <valueIdentifier>
                        <system value="https://gematik.de/fhir/epa-medication/sid/rx-prescription-process-identifier" />
                        <value value="160.153.303.257.459_20250122" />
                    </valueIdentifier>
                </extension>
                <identifier>
                    <system value="https://gematik.de/fhir/epa-medication/sid/rx-originator-process-identifier" />
                    <value value="5d8fbf7c-bdb0-44c2-95fe-423ae0404ccd_160.153.303.257.459" />
                </identifier>
                <status value="completed" />
                <category>
                    <coding>
                        <system value="https://gematik.de/fhir/terminology/CodeSystem/EPAMedicationDispenseCategoryCS" />
                        <code value="prescription" />
                        <display value="prescription dispense" />
                    </coding>
                </category>
                <medicationReference>
                    <reference value="Medication/2571d29b-e213-40ec-b817-a1490718a490" />
                </medicationReference>
                <subject>
                    <identifier>
                        <type>
                            <coding>
                                <system value="http://fhir.de/CodeSystem/identifier-type-de-basis" />
                                <code value="KVZ10" />
                                <display value="Krankenversichertennummer" />
                            </coding>
                        </type>
                        <system value="http://fhir.de/sid/gkv/kvid-10" />
                        <value value="X110411319" />
                    </identifier>
                </subject>
                <performer>
                    <actor>
                        <reference value="Organization/3856402c-7636-4fbd-98bd-d278852b8e88" />
                    </actor>
                </performer>
                <authorizingPrescription>
                    <reference value="MedicationRequest/bb91cde8-0426-4f4b-a766-5d818d0605bd" />
                </authorizingPrescription>
                <whenHandedOver value="2025-01-22" />
                <dosageInstruction>
                    <text value="1-0-0-0" />
                </dosageInstruction>
                <substitution>
                    <wasSubstituted value="false" />
                </substitution>
            </MedicationDispense>
        </resource>
        <search>
            <mode value="match" />
        </search>
    </entry>
    <entry>
        <fullUrl value="https://epa-as-0.prod.epa4all.de/vau-cid-1234/epa/medication/api/v1/fhir/MedicationDispense/46865835-8c8f-4139-86ba-271bd3565250" />
        <resource>
            <MedicationDispense>
                <id value="46865835-8c8f-4139-86ba-271bd3565250" />
                <meta>
                    <versionId value="1" />
                    <lastUpdated value="2025-01-22T14:43:33.244Z" />
                    <profile value="https://gematik.de/fhir/epa-medication/StructureDefinition/epa-medication-dispense" />
                </meta>
                <extension url="https://gematik.de/fhir/epa-medication/StructureDefinition/rx-prescription-process-identifier-extension">
                    <valueIdentifier>
                        <system value="https://gematik.de/fhir/epa-medication/sid/rx-prescription-process-identifier" />
                        <value value="160.153.303.257.459_20250122" />
                    </valueIdentifier>
                </extension>
                <identifier>
                    <system value="https://gematik.de/fhir/epa-medication/sid/rx-originator-process-identifier" />
                    <value value="86d65df3-5ca4-457d-8859-285830fe091b_160.153.303.257.459" />
                </identifier>
                <status value="completed" />
                <category>
                    <coding>
                        <system value="https://gematik.de/fhir/terminology/CodeSystem/EPAMedicationDispenseCategoryCS" />
                        <code value="prescription" />
                        <display value="prescription dispense" />
                    </coding>
                </category>
                <medicationReference>
                    <reference value="Medication/3b990824-3814-4d75-80b1-e2935827f8f0" />
                </medicationReference>
                <subject>
                    <identifier>
                        <type>
                            <coding>
                                <system value="http://fhir.de/CodeSystem/identifier-type-de-basis" />
                                <code value="KVZ10" />
                                <display value="Krankenversichertennummer" />
                            </coding>
                        </type>
                        <system value="http://fhir.de/sid/gkv/kvid-10" />
                        <value value="X110411319" />
                    </identifier>
                </subject>
                <performer>
                    <actor>
                        <reference value="Organization/3856402c-7636-4fbd-98bd-d278852b8e88" />
                    </actor>
                </performer>
                <authorizingPrescription>
                    <reference value="MedicationRequest/bb91cde8-0426-4f4b-a766-5d818d0605bd" />
                </authorizingPrescription>
                <whenHandedOver value="2025-01-22" />
                <dosageInstruction>
                    <text value="1-0-0-0" />
                </dosageInstruction>
                <substitution>
                    <wasSubstituted value="false" />
                </substitution>
            </MedicationDispense>
        </resource>
        <search>
            <mode value="match" />
        </search>
    </entry>
</Bundle>

Antwort-Status-Codes

Status Code Bedingung Error Code Bemerkung
200 Successful operation
400 Unknown search parameter EPA OperationOutcome
400 Invalid query parameter(s) EPA OperationOutcome
400 Invalid request EPA OperationOutcome
403 Requestor role is not in the list of allowed user groups invalidOid
403 Requestor is not entitled notEntitled
403 ID-Token or Insurant-ID mismatch EPA OperationOutcome
404 Unknown resource type EPA OperationOutcome
404 Health record is in state UNKNOWN or INITIALIZED noHealthRecord (siehe 'Wiederholungsintervalle')
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')

Serviceübergreifende Error Codes ohne Verweis auf EPA OperationOutcome 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"
}

Interaktion (MedicationDispense Instance API)

GET [base]/epa/medication/api/v1/fhir/MedicationDispense/[id]

OperationId: getMedicationDispenseById_MedicationSvc


Um spezifische Details zu einer einzelnen MedicationDispense mittels der RESTful API zu erhalten, kann die MedicationDispense Instance API verwendet werden, sodass eine HTTP GET-Anfrage an den Endpunkt /MedicationDispense/[id] gerichtet wird.

Antwort-Status-Codes

Status Code Bedingung Error Code Bemerkung
200 Successful operation
400 Unknown search parameter EPA OperationOutcome
400 Invalid query parameter(s) EPA OperationOutcome
400 Invalid request EPA OperationOutcome
403 Requestor role is not in the list of allowed user groups invalidOid
403 Requestor is not entitled notEntitled
403 ID-Token or Insurant-ID mismatch EPA OperationOutcome
404 Resource is not known EPA OperationOutcome
404 Unknown resource type EPA OperationOutcome
404 Health record is in state UNKNOWN or INITIALIZED noHealthRecord (siehe 'Wiederholungsintervalle')
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')

Serviceübergreifende Error Codes ohne Verweis auf EPA OperationOutcome 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"
}