Implementation Guide
ePA Medication Service
Version 1.2.0-ballot.2 - draft

## FHIR-Artefakte

Diese Seite enthält eine Übersicht aller FHIR-Artefakte, die im Rahmen dieses Implementation Guide für den Medication Service definiert werden. Sie bilden die Grundlage für die strukturierte Abbildung und Verarbeitung von Medikationsdaten innerhalb des Medication Service. Dazu gehören Profile zur Spezifizierung von Ressourcen, ein Capability Statement zur Beschreibung der unterstützten Funktionen sowie Operation Definitions, die spezielle FHIR-Operationen für den Abruf und die Verwaltung von Medikationsdaten festlegen.

### Terminologien: Value Sets

Die folgenden Value Sets sind für die FHIR-Data-Service-Funktionalitäten festgelegt.

Context Codes | Codes that define the context of a resource instance in the ePA context
eMP MedicationRequest Status Value Set | eMP MedicationRequest Status Value Set
ePA MedicationStatement Status Value Set | ePA MedicationStatement Status Value Set
EPA MedicationStatement Processing Codes | Codes that define events that occur during processing of an EMPMedicationStatement
EPA Statuswerte Dispensierinformationen einstellen (E-Rezept-Fachdienst) | Dieses ValueSet definiert die möglichen ePA Statuswerte für die FHIR-Operation Dispensierinformationen einstellen (E-Rezept-Fachdienst). Es bestimmt, ob eine vorläufige oder abgeschlossene Dispensierung vorliegt.

### Systemverhalten

#### Capability Statements

Das CapabilityStatement beschreibt die Anforderungen und Fähigkeiten, die ein Server für die konforme Implementierung des Medication Service umsetzen muss. Es handelt sich um eine Konformitätserklärung, die spezifiziert, welche Ressourcen, Interaktionen und Suchparameter das ePA-Aktensystem für den Medication Service unterstützen muss.

EPA Capability Statement für Clients des ePA Medication Service | Dieses Capability Statement legt die Anforderungen an ePA Clients fest, die den Medication Service der verwenden. Es definiert die unterstützten Interaktionen, erforderliche HTTP Header sowie erwartete Status Codes.
EPA CapabilityStatement für den Medication Service | EPA CapabilityStatement für den Medication Service

#### Operation Definitions

Add Medication List Entry | Diese Operation ermöglicht das gezielte Hinzufügen einer neuen Medikation zur elektronischen Medikationsliste (eML).
eMP-Eintrag hinzufügen | Diese Operation ermöglicht das gezielte Hinzufügen eines neuen Medikations-Eintrags zum elektronischen Medikationsplan (eMP).
Batch eMP Einträge | Mit der Batch Operation $batch-emp können Primärsysteme mehrere fachliche Änderungen am eMP in einem Aufruf an den Medication Service übergeben. Innerhalb des Request-Bundles werden ausschließlich FHIR-Operationen ausgeführt (keine direkten Resource-CRUDs). Am Ende wird ein emp-commit ausgeführt, der eine neue Plan-Version (Provenance) erzeugt. Die Operation antwortet mit einem Bundle vom Typ transaction-response.
Cancel Dispensation eRP | The Cancel Dispensation eRP operation, used by the E-Rezept-Fachdienst, in the context of the ePA Medication Service, is applied to cancel or reverse information regarding the dispensation of a medication. This operation is necessary when a medication dispensation is cancelled by a pharmacist or when there is a return of the medication by the insurant. After the E-Rezept-Fachdienst performs this operation, the corresponding dispensation entry for the medication in the patient's ePA is marked as cancelled, which the goal in ensuring an accurate and up-to-date record of the patient's medication data.
Cancel Medication List Entry | Diese Operation dient dem gezielten Widerruf/Abbruch eines bestehenden Eintrags der elektronischen Medikationsliste (eML) auf Instanzebene.
Cancel Prescription eRP | The $cancel-prescription-erp operation is used by the E-Rezept-Fachdienst to cancel an already issued electronic prescription. This function is applied when a prescription is no longer needed for various reasons, such as changes in medication or errors in the initial issuance. After cancellation by the E-Rezept-Fachdienst, this information is transmitted to the ePA Medication Service, where the prescription is calculations. It can then no longer be used for dispensing medication. This process ensures accuracy and safety in the management of medications.
eMP Commit Operation | Die eMP Commit Operation dient zum Abschluss einer Batch-Verarbeitung von eMP-Einträgen. Sie erzeugt eine neue Version des elektronischen Medikationsplans (eMP), indem eine aktualisierte Instanz von **EMPChronologyProvenance** erstellt wird, die auf alle relevanten **EMPMedicationRequest** verweist. Diese Operation wird in der Regel nur einmal am Ende eines Batch-Kontextes aufgerufen.
Get Medication List | Die Operation liefert die elektronische Medikationsliste (eML) in Form eines FHIR searchSet-Bundles. In der eML werden ausschließlich nicht stornierte Instanzen von Verschreibungsdaten, Dispensierdaten, nachgetragenen Medikamenten sowie die zugehörige Versicherteninformation aus dem Patient Service angezeigt.
Medication Plan (eMP) | Diese Operation ermöglicht den gezielten Abruf eines elektronischen Medikationsplans (eMP) aus dem Datenraum des Medication Service. Der zurückgegebene Medikationsplan besteht aus einer Sammlung relevanter Ressourceninstanzen, die zu einem bestimmten Zeitpunkt gemeinsam gültig waren, sowie die zugehörige Versicherteninformation (Patient) aus dem Patient Service. Die Operation akzeptiert optional eine Provenance-Referenz.id als Eingabeparameter. Wird diese übergeben, liefert die Operation exakt den Zustand des Medikationsplans, wie er durch diese Provenance-Version beschrieben ist. So kann auch ein vergangener Stand des eMP nachvollziehbar wiedergegeben werden. Wird keine Provenance angegeben, gibt die Operation den aktuellsten Stand des Medikationsplans zurück - also die derzeit gültige Kombination aus aktiven und pausierten Medikationsdaten. Das Ergebnis ist ein Bundle vom Typ collection, das alle zugehörigen Ressourcendaten enthält.
eMP-Eintrag verknüpfen | Diese Instanz-Operation dient der Verknüpfung eines bestehenden eML-Eintrags (MedicationStatement) mit einem bereits dokumentierten Eintrag im elektronischen Medikationsplan (eMP).
Medication Plan Chronology Log | Diese Operation liefert die chronologische Historie aller gespeicherten Versionen des elektronischen Medikationsplans (eMP) in Form von Provenance-Ressourcen. Jede Provenance-Instanz beschreibt dabei einen dokumentierten Zustand des eMP zu einem bestimmten Zeitpunkt. Die Operation ermöglicht es, gezielt die Versionshistorie des Medikationsplans abzufragen - etwa um Änderungen nachzuvollziehen oder frühere Zustände einzusehen.
Provide Dispensation eRP | The Provide Dispensation eRP operation in the ePA Medication Service is used to record information about the dispensing of medications based on an electronic prescription in the patient's record. This operation comes into play when a patient receives their medication from a pharmacy. It documents that the medication has been dispensed as per the prescription, including details like the quantity, date of dispensing, and pharmacy information. This helps maintain a comprehensive overview of the patient's medication history.
Provide Prescription eRP | The Provide Prescription eRP operation in the ePA MedicationService is used to add electronic prescriptions to a patient's record. These prescriptions are already made by the E-Rezept-Fachdienst. This operation does not create new patient prescriptions; it just puts the ones made by the E-Rezept-Fachdienst into the patient's ePA, making sure they are stored safely and can be easily accessed.
eMP-Verknüpfung entfernen | Diese Operation des Medication Service dient dazu, eine Verknüpfung zwischen einem bestehenden eML-Eintrag und einem dokumentierten eMP-Eintrag aufzuheben.
eMP-Eintrag aktualisieren | Diese Operation dient der gezielten Aktualisierung eines bestehenden Medikations-Eintrags im elektronischen Medikationsplan (eMP).

#### Suchparameter

IsEMPSP | Liefert alle Referencen, die einen eMP bezug haben
ContextSP | Liefert alle Resourcen mit diesem Context Code
DerivedFromSP | Search by resources from which the medication statement is derived
IsEMPChronologySP | Liefert alle Resourcen die eMP bezug haben (oder nicht)
MedicationRequestActivitySP | Liefert alle referenzierten eML MedicationStatement Aktivitäten
MedicationRequestEffectiveDosePeriodSP | Ermöglicht die Suche anhand des Zeitraums, in dem die Medikation eingenommen werden soll
RxPrescriptionProcessParameter | Returns Medications, MedicationDispenses or MedicationStatement with the Rx Prescription Process Identifier.

#### Operation Outcome

EPA Medication Service OperationOutcome Code System | EPA Medication Service Operation Outcome Code System
EPA Medication Service Operation Outcome | Das Operation Outcome-Profil für den Medication Service der ePA.
EPA Medication Service Operation Outcome ValueSet | Enthält alle Codes für das Operation Outcome des Medication Service.

### Parameterprofile für Operationen

EPA Operation addEMLEntry Input-Parameters | EPA Operation addEMLEntry Input-Parameters
EPA Operation addEMPEntry Input-Parameters | EPA Operation addEMPEntry Input-Parameters
EPA Operation CancelDispensation ERP Input-Parameters | EPA Operation CancelDispensation ERP Input-Parameters
EPA Operation CancelPrescription ERP Input-Parameters | EPA Operation CancelPrescription ERP Input-Parameters
EPA Operation EMLEntry Output-Parameters | EPA Operation EMLEntry Output-Parameters
EPA Operation EMPEntry Output-Parameters | EPA Operation EMPEntry Output-Parameters
EPA Operation Link eMP Output Parameters | EPA Operation Link eMP Output Parameters
EPA Operation Link eMP Parameters | EPA Operation Link eMP Parameters
EPA Operation ProvideDispensation ERP Input-Parameters | EPA Operation ProvideDispensation ERP Input-Parameters
EPA Operation ProvidePrescription ERP Input-Parameters | EPA Operation ProvidePrescription ERP Input-Parameters
EPA eMP Commit Operation Input-Parameters | EPA eMP Commit Operation Input-Parameters
EPA Operation RxDispensation ERP Output-Parameters | EPA Operation RxDispensation ERP Output-Parameters
EPA Operation RxPrescription ERP Output-Parameters | EPA Operation RxPrescription ERP Output-Parameters
EPA Operation UpdateEMPEntry Input-Parameters | EPA Operation UpdateEMPEntry Input-Parameters

### Ressourcenprofile

eMP-Chronologieeintrag | Dieses Profil beschreibt die Verwendung der FHIR-Resource Provenance zur Abbildung eines eMP-Chronologieeintrags. Die Provenance-Instanz dokumentiert, welche eMP-Einträge (MedicationRequest-Instanzen) zu einem bestimmten Zeitpunkt als Teil des elektronischen Medikationsplans (eMP) gültig waren. Ein eMP-Chronologieeintrag wird immer dann erzeugt, wenn sich die eMP-relevanten Instanzen geändert haben oder neue eMP-Einträge hinzugekommen sind. Er referenziert sämtliche zum Erstellungszeitpunkt aktiven eMP-MedicationRequest-Instanzen, d.h. alle Ressourcen mit dem Status active oder on-hold. Dadurch wird der Zustand des Medikationsplans zu diesem Zeitpunkt nachvollziehbar. Der eMP-Chronologieeintrag ermöglicht somit eine eindeutige und versionssichere Rückverfolgung der Zusammensetzung des eMP über verschiedene Zeitpunkte hinweg.
eMP-Eintrag | Hält die Medikationsinformationen eines Eintrags für den elektronischen MedikationsPlan (eMP) vor und stellt das zentrale Element dar. Es stellt die Verbindung zwischen der Planung und einem oder mehrerer Verschreibungsprozesse oder Nachträge.
eMP Medication | Defines the medication resource for the Medication Service in the ePA system in the eMP context.
Batch API eMP-Einträge - Request-Bundle | Request-Bundle für die Batch-Operation zur Verarbeitung von eMP-Einträgen. Erlaubt sind ausschließlich FHIR-Operationen (POST) für den eMP. $emp-commit MUSS genau einmal vorkommen. Es sind keine direkten Ressourcen-CRUDs zulässig.
EPA MedicationDispense | Defines the medication dispense resource for the Medication Service in the ePA system.
EPA Pharmaceutical Product Medication | Defines the medication resource for a component of a 'Kombipackung' for the Medication Service in the ePA system. These profiles are intended to inherit from EPAMedication, but due to tooling issues, this inheritance cannot currently be implemented.
EPA Medication PZN Ingredient | Defines the medication resource for a PZN ingredient of a compounding medication for the Medication Service in the ePA system. These profiles are intended to inherit from EPAMedication, but due to tooling issues, this inheritance cannot currently be implemented.
EPA MedicationRequest | Defines the medication request resource for the Medication Service in the ePA system.
EPA MedicationStatement | Hält die Medikationsinformationen eines Eintrags in der elektronischen Medikationsliste (eML) vor und stellt das zentrale Element dar. Es wird zu Verschreibungs- und Dispensierinformationen als auch Nachträgen in der eML genutzt.
EPA Medication | Defines the medication resource for the Medication Service in the ePA system.

### Datentypen

Medication Unique Identifier | This unique identifier is generated within the Medication Service. It is either a hash derived from a specific set of data elements of the Medication resource or a direct repetition of a single data element. This identifier ensures the distinct identification of Medication resources across the ePA system.
RxOriginatorProcessIdentifier | The RxOriginatorProcessIdentifier, generated within the Medication Service, links the prescriptionID from the E-Rezept-Fachdienst with the original input FHIR resource ID, facilitating accurate tracking and utilization of medication data in operational processes within digital healthcare systems.
RxPrescriptionProcessIdentifier | This transaction identifier is used to track medication prescription transactions between the E-Rezept-Fachdienst and the ePA. It is generated by the ePA Medication Service, ensuring a consistent and unique identification of each transaction. The identifier is composed of the PrescriptionId and the authoredOn-date of the operations parameters request, providing a robust mechanism for referencing and managing medication-related resources across systems.

### Erweiterungen (Extension) Definitions

ContextExtension | Extension for indicating the context.
DrugCategoryExtension | Extension for indicating the medication category.
EMPMedicationRequestActitvityExtension | Bildet eine Aktivität in bezug auf ein EMPMedicationRequest ab
Medication Type | Extension for EPAMedication types
EPAMedicationStatementProcessingEventExtension | Bildet ein Ereignis ab, das wärend der Verarbeitung auftritt.
IndicatorBVGExtension | Indicator of whether this regulation is made in reference to the 'Bundesentschädigungsgesetz' or the 'Bundesversorgungsgesetz'.
IsEMPChronologyExtension | Definiert, ob die Provenance ein eMP-Chronologieeintrag ist.
IsEMPExtension | Definiert ob etwas einen Bezug zum eMP hat
MedicationFormulationPackagingExtension | Information on the packaging of a formulation.
MedicationIsVaccineExtension | Indicator of whether this is a vaccine.
MedicationIngredientAmountExtensions | Free-text amount of the ingredient for classical Latin notations such as "ad 100.0" or "quantum satis," including the unit.
MedicationIngredientDarreichungsformExtension | Dosage form of an ingredient in a formulation.
MedicationManufacturingInstructionsExtension | Manufacturing instructions regarding the preparation of a formulation (Subscriptio).
MedicationPackagingSizeExtension | Specification of the package size according to divided quantity (e.g., 100, 2x25), only appears in conjunction with "unit" (e.g., 100 Stück).
MedicationTotalQuantityFormulationExtension | Total quantity of the formulation (without the unit).
MultiplePrescription | This FHIR Extension for multiple prescriptions adds details such as repetition count and time intervals for repeated medication orders to FHIR resources.
PatientNoteExtension | Extension für einen Hinweis für den Patienten
ReasonPatientInstructionExtension | Patientenverständliche Beschreibung des Grundes
RxPrescriptionProcessIdentifierExtension | This extension is used to track medication prescription transactions between the E-Rezept-Fachdienst and the ePA. The RxPrescriptionProcessIdentifier is generated by the ePA Medication Service and consists of the PrescriptionId and the authoredOn date of the operation parameters request. It ensures consistent referencing and management of medication-related resources across different systems.

### Beispielinstanzen

Bundle

- ExampleEPABatchEmpRequestBundle

- ExampleEPABatchEmpResponseBundle

- ExampleEpaGetMedicationListBundle

- ExampleEpaGetMedicationPlanBundle

- ExampleSearchsetBundleEPAMedication

- ExampleSearchsetBundleEPAMedicationDispense

- ExampleSearchsetBundleEPAMedicationRequest

- ExampleSearchsetBundleEPAMedicationStatement

- MedicationPlanChronologyLogBundle

Medication

- COTRIM

- eMP_Benazepril

- Cancelled_Diclo

- Doxycyclin

- Diclo

- Aciclovir

- Ramipril

- Technical-Exp-NachtragEmlMedicationIBU

- Venlafaxin

- L-Thyroxin_MV_4

- L-Thyroxin_MV_3

- eMP_Sumatriptan

- Cortison Dexpantenol Medication

- Technical-Exp-EPAMedicationMax

- Technical-Exp-NachtragEmlMedication

- Technical-Exp-NachtragEmpMedicationEml

- Technical-Exp-NachtragEmpMedicationEmp

- L-Thyroxin_MV_2

- Prospan

- JanuviaFilmtabletten

- L-Thyroxin_MV_1

- IBU

- Sumatriptan

MedicationDispense

- Prospan_Dispense

- JanuviaFilmtabletten_Dispense

- Ramipril_Dispense

- COTRIM_Dispense

- Aciclovir_Dispense

- Venlafaxin_Dispense

- Doxycyclin_Dispense

- L-Thyroxin_Dispense_MV_1

- Sumatriptan_Dispense

MedicationRequest

- L-Thyroxin_Request_MV_3

- Doxycyclin_Request

- Ramipril_Request

- eMP_Sumatriptan_Request

- L-Thyroxin_Request_MV_2

- JanuviaFilmtabletten_Request

- L-Thyroxin_Request_MV_4

- Prospan_Request

- Sumatriptan_Request

- Aciclovir_Request

- eMP_Benazepril_Request

- Venlafaxin_Request

- Technical-Exp-NachtragEmpMedicationRequestEmp

- L-Thyroxin_Request_MV_1

- COTRIM_Request

MedicationStatement

- Ramipril_Information

- L-Thyroxin_Information_MV_1

- Prospan_Information

- IBU_Information

- Doxycyclin_Information

- Cancelled_Diclo_Information

- Diclo_Information

- Technical-Exp-NachtragEmlMedicationStatement

- Technical-Exp-NachtragEmpMedicationStatementEml

- COTRIM_LINKING_NOT_SUCCESSFUL_Information

- Venlafaxin_Information

- Aciclovir_Information

- Sumatriptan_Information

- JanuviaFilmtabletten_Information

OperationOutcome

- ExpOperationOutcomeNoValidStructureWithDiagnostics

- ExpOperationOutcomeEMPChronologyIdMismatch

- ExpOperationOutcomeDosageInvalid

- ExpOperationOutcomeEMPLinkingNotSuccessful

- ExpOperationOutcomeSuccess

- ExpOperationOutcomeNoValidStructure

- ExpOperationOutcomeOrgHeaderProfileMismatch

- OperationOutcomeInvalidQueryParameter

- OperationOutcomeInvalidRequest

- ExpOperationOutcomeOperationOutsideBatch

- OperationOutcomeResourceIsNotKnown

- OperationOutcomeEmptyList

- ExpOperationOutcomeNotPermittedonCurrentDispensationStatus

- OperationOutcomeUnknownResourceType

- ExpOperationOutcomeNotPermittedCurrentPrescriptionStatus

- ExpOperationOutcomeOperationDispensationNotFound

- ExpOperationOutcomeEMPUnlinkingNotSuccessful

- OperationOutcomeUnknownSearchParameter

- ExpOperationOutcomeVersionAwareConflict

- ExpOperationOutcomeOpNotAllowed

- ExpOperationOutcomeUnresolvedReferenceinParameters

- ExpOperationOutcomeDuplicatePrescriptionDetected

- ExpOperationOutcomePrescriptionNotFound

Organization

- GematikApotheke

- PraxisTIOrganization

- ApothekeTIOrganization

- Technical-Exp-NachtragEmlLEI

- Technical-Exp-NachtragEmpLEI

- BetriebsstaetteArzt

- GematikOrganization

Parameters

- ExpEPAOpUpdateEMPEntryInputParameters_Batch

- ExpEPAOpAddEmlEntryInputParameters

- ExpEPAOpAddEMPEntryInputParameters

- ExampleEpaOpCancelDispensationERPInputParameters1

- ExampleEpaOpCancelPrescriptionERPInputParameters1

- ExpEPAOpEmlEntryCancelledOutputParameters

- ExpEPAOpEmlEntryOutputParameters

- ExpEPAOpEMPEntryOutputParameters

- ExpEPAOpEMPEntryOutputParametersUpdate

- ExpEPAOpLinkEMPEntryOutputParameters

- ExpEPAOpLinkEMPEntryParameters

- ExampleEpaOpProvideDispensationERPInputParameters1

- ExampleEpaOpProvideDispensationERPInputParameters2

- ExampleEpaOpProvideDispensationERPInputParametersInProgress

- ExampleEpaOpProvidePrescriptionERPInputParameters1

- ExampleEpaOpProvidePrescriptionERPInputParameters2

- ExpEPAOpEMPCommitInputParameters

- ExampleEpaOpRxDispensationOutputParameters1

- ExampleEpaOpRxPrescriptionERPOutputParameters1

- ExpEPAOpUnlinkEMPEntryOutputParameters

- ExpEPAOpUnlinkEMPEntryParameters

- ExpEPAOpUpdateEMPEntryInputParameters

Patient

- Technical-Exp-NachtragEmlPatient

- Technical-Exp-NachtragEmpPatient

Practitioner

- Arzt

PractitionerRole

- Arzt PractitionerRole

- PraxisTI PractitionerRole

Provenance

- eMP_Benazepril_Chronology_Provenance_1

- Prospan_Information_Provenance

- Sumatriptan_Information_Provenance

- Venlafaxin_Information_Provenance

- eMP_Sumatriptan_Activity_Provenance_Batch_Response

- eMP_Sumatripta_Chronology_Provenance

- eMP_Chronology_Provenance

- eMP_Chronology_Provenance_Batch

- Cancelled_Diclo_Information_Provenance

- L-Thyroxin_Information_Provenance

- eMP_Benazepril_Activity_Provenance

- eMP_Sumatripta_Activity_Provenance

- Technical-Exp-NachtragEmlProvenance

- Technical-Exp-NachtragEmpProvenanceEml

- Technical-Exp-NachtragEmpProvenanceEmp

- Diclo_Information_Provenance

- Ramipril_Information_Provenance

- eMP_Benazepril_Chronology_Provenance_2

- COTRIM_Information_Provenance

- Doxycyclin_Information_Provenance

- JanuviaFilmtabletten_Information_Provenance

- Aciclovir_Information_Provenance

- IBU_Information_Provenance