Implementation Guide
TI Common
Version 1.4.0 - release

FHIR-Artefakte

Auf dieser Seite befindet sich eine Liste der FHIR-Artefakte, welche im Rahmen dieses Implementation Guide definiert werden.

Common

Ressourcenprofile

TI Organization

Definiert die Datenstruktur für medizinische, regulatorische und technische Organisationen

TI Patient

Das Patient-Profil für die Telematikinfrastruktur (TI) FHIR Data Services

TI PractitionerRole

Dieses Profil beschreibt die Verwendung der FHIR-Ressource PractitionerRole in der Telematikinfrastruktur (TI). Es wird verwendet, um die Rolle und Funktion einer Gesundheitsfachperson innerhalb einer Organisation zu definieren.

TI Practitioner

Dieses Profil beschreibt die Verwendung der FHIR-Ressource Practitioner im Kontext der Telematikinfrastruktur (TI). Es dient der strukturierten Darstellung von Gesundheitsfachpersonen, wie z.B. Ärzt:innen, Zahnärzt:innen, Psychotherapeut:innen oder Apotheker:innen, innerhalb TI-konformer Anwendungen.

Tabelle: Common Ressourcenprofile

Extensions

National Contact Point of Health (NCPeH) Country Extension

The country extension for National Contact Point of Health (NCPeH) Organizations, representing the country in which the NCPeH is located.

Tabelle: Common Extensions

Datentypen

Profil für den TIFlow AccessCode

Der AccessCode ist ein generiertes Geheimnis, das Zugriff auf eine Ressource gewährt, z. B. Task.

Profil für das TIFlow Secret

Das Secret ist ein generiertes Geheimnis, das Zugriff auf eine TIFlow Verordnung gewährt, z. B. Task.

Tabelle: Common Datentypen

Medikationsprozess (dgMP)

Code Systems

Context Codes

Codes that define the context of a resource instance in the ePA context

Tabelle: Medikationsprozess Code Systems

Value Sets

Context Codes

Codes that define the context of a resource instance in the ePA context

Tabelle: Medikationsprozess Value Sets

Ressourcenprofile

TI Medication dgMP

Defines the medication resource for the Medication Service in the TI ecosystem.

TI MedicationDispense dgMP

Defines the medication dispense resource for the Medication Service in the TI ecosystem.

TI Pharmaceutical Product Medication dgMP

Definiert die Medication-Ressource für eine Komponente einer 'Kombipackung' für den digitale Medikationsprozess (dgMP). Diese Profile sollen von TIMedicationDgMP abgeleitet werden. Aufgrund von Tooling-Problemen kann diese Vererbung derzeit jedoch nicht umgesetzt werden.

TI Medication PZN Ingredient dgMP

Definiert die Medication-Ressource für einen PZN-Bestandteil einer Rezeptur zur Verwendung in der TI.

TI MedicationRequest dgMP

Defines the medication request resource for the Medication Service in the TI ecosystem.

TI MedicationStatement dgMP

Hält die Medikationsinformationen eines Patienten.

Tabelle: Medikationsprozess Ressourcenprofile

Extensions

ContextExtension

Extension for indicating the context.

DrugCategoryExtension

Extension for indicating the medication category.

Medication Type

Extension for EPAMedication types

IndicatorBVGExtension

Indicator of whether this regulation is made in reference to the 'Bundesentschädigungsgesetz' or the 'Bundesversorgungsgesetz'.

IndicatorSERExtension

Kennzeichnung, ob diese Verordnung mit Bezug zum Sozialen Entschädigungsrecht nach SGB XIV (SER) erfolgt

MedicationFormulationPackagingExtension

Information on the packaging of a formulation.

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.

MedicationIsVaccineExtension

Indicator of whether this is a vaccine.

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.

NarcoticsExtension

Abbildung der Angaben zur Verordnung eines Betäubungsmittels im Sinne des Betäubungsmittelgesetzes (BtMG)

PatientIDExtension

Patienten-ID, welche bei der Verordnung bestimmter Arzneimittel angegeben werden kann.

PrescriberIDExtension

Verschreiber-ID, welche bei der Verordnung bestimmter Präparate anzugeben ist, damit die Apotheke das Rezept beliefern darf.

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.

TeratogenicExtension

Abbildung der Angaben zur Verordnung eines teratogenen Arzneimittels (T-Rezept)

Tabelle: Medikationsprozess Extensions

Datentypen

Identifikator Profil für E-Rezept-IDs

Die E-Rezept-ID ist eine generierte und nicht veränderbare Zahlenfolge, die durch Punkte getrennt ist. Die ersten drei Ziffern definieren die Art der Verordnung. Die nächsten zwölf Ziffern stellen die generierte, eindeutige und fortlaufende Sequenz der Verordnung dar. Die letzten beiden Ziffern sind Prüfziffern gemäß ISO 7064.

Profil für den Identifikator eines eMP-Eintrags

Definiert die Struktur des Identifikators für einen Eintrag im elektronischen Medikationsplan (eMP). Der Identifikator ermöglicht die eindeutige technische Referenzierung einzelner eMP-Einträge.

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.

Tabelle: Medikationsprozess Datentypen

Verhalten

Dieses Capability Statement Profil dient als TI-weit gültige Referenz für die Definition der RESTful-FHIR-Schnittstellen.

Capability Statement Profil

Capability Statement Profil für TI FHIR Data Service

Dieses Profil beschreibt die Fähigkeiten eines FHIR Data Service innerhalb der Telematikinfrastruktur (TI) spezifiziert ist.

Tabelle: Capability Statement

Operation Definition Profil

OperationDefinition Profil für TI FHIR Data Service

Dieses Profil beschreibt FHIR Operationen des FHIR Data Service innerhalb der Telematikinfrastruktur (TI). Es stellt sicher, dass zustandsverändernde Operationen ('affectsState = true') nicht über HTTP GET ausgeführt werden dürfen.

Tabelle: Operation Definition

Code Systems

TI Environments CodeSystem

Dieses CodeSystem definiert standardisierte Umgebungskennzeichen für CapabilityStatements des TI-Fachdienstes. Es erlaubt die eindeutige Kennzeichnung, ob die beschriebene Fähigkeit für Produktions-, Referenz-, Test- oder Entwicklungsumgebung gilt.

TIFHIR Configuration CS

Dieses CodeSystem beschreibt die FHIR-Konfigurationen eines FHIR Data Service der TI. Die konkrete Konzeptliste wird extern im gematik-Releaseprozess als Release-Artefakt verwaltet und versioniert; dieser IG referenziert diese Konzepte nur über das Canonical.

TI Operation Parameter Location CodeSystem

Definiert die möglichen Positionen eines Parameters bei der HTTP-Übertragung einer FHIR-Operation.

TI Restful Interaction CodeSystem

Ergänzt die standardisierten FHIR REST-Interaktionen um weitere ressourcenbezogene Interaktionen.

Tabelle: Code Systems

Value Sets

TI Environments ValueSet

Dieses ValueSet enthält alle zulässigen Umgebungskennzeichen für CapabilityStatements des TI-Flow-Fachdienstes und wird für die verpflichtende Kennzeichnung der Zielumgebung verwendet.

TI FHIR Configuration ValueSet

Dieses ValueSet bildet den zulässigen Wertebereich für die FHIR-Konfiguration eines FHIR-Data Service der TI ab.

TI Operation Parameter Location ValueSet

Zulässige Positionen eines Parameters bei der HTTP-Übertragung einer FHIR-Operation.

TI Restful Interaction ValueSet

Definiert die unterstützten REST-Interaktionen einschließlich der TI-spezifischen bedingten Interaktionen.

Tabelle: Value Sets

Capability Extensions

Base URL der FHIR-API

Gibt die Basis-URL des FHIR-Servers als Zeichenkette an. Beispiel: http://epa4all/epa/medication/api/v1/fhir

HTTP Header

Ermöglicht die Angabe global oder spezifisch geforderter HTTP Header in einem CapabilityStatement oder einer Resource-Interaktion.

HTTP Method for FHIR Operation

Gibt an, ob eine FHIR Operation mit GET, POST oder beidem verwendet werden darf.

HTTP-Antwortinformationen

Definiert Informationen zu HTTP-Antworten für FHIR-Interaktionen, inklusive Statuscode, Beschreibung, Beispiel und Response-Schema.

Search Parameter Interaction

Gibt an, für welche REST-Interaktionen ein SearchParameter unterstützt wird.

TI Feature

Deklariert ein einzelnes Feature eines TI Fachdienst-Deployments. Das Teilfeld `definition` verweist per Canonical auf den Feature-Bezeichner (analog zum HL7 Application Feature Framework, `hl7.fhir.uv.application-feature`); `value` beschreibt den aktuellen Zustand des Features am betrachteten Endpoint. Kompatibilitätshinweis: Diese Extension spiegelt bewusst die Sub-Extension-Namen `definition` und `value` des HL7-Frameworks wider, um eine spätere Migration oder Profilierung ohne Breaking Change zu ermöglichen.

TI FHIR Configuration

Diese Extension deklariert eine konkrete Konfigurationsausprägung eines FHIR-Data Service in der TI auf CapabilityStatement-Ebene. Die Konfiguration wird als Code transportiert. Die Bedeutung und Konstellation einer FHIR-Konfiguration ist aus externen Quellen der Releaseplanung zu entnehmen.

Tabelle: Capability Extensions

Operation Outcome

Ressourcenprofile

TI Operation Outcome

Das Operation Outcome-Profil für die Telematikinfrastruktur (TI) FHIR Data Services

Tabelle: Operation Outcome - Ressourcenprofile

Extensions

ExpectedDosageTextExtension

This extension is used in an Operation Outcome to state the expected Dosage Instruction in the rendered-dosagetext-extension.

Tabelle: Operation Outcome - Extensions

Code Systems

TI Operation Outcome Details CodeSystem

Telematikinfrastruktur (TI) Operation Outcome Details CodeSystem

Tabelle: Operation Outcome - Code Systems

Value Sets

TI Operation Outcome Details Value Set

Enthält alle Codes für das Operation Outcome der Telematikinfrastruktur (TI) sowie die in FHIR definierten Operation-Outcome-Codes.

Tabelle: Operation Outcome - Value Sets

Beispielinstanzen

Bundle

OperationOutcome

Patient