Implementation Guide
ePA Medication Service
Version 1.3.0 - release

Resource Profile: EPA Pharmaceutical Product Medication

Official URL: https://gematik.de/fhir/epa-medication/StructureDefinition/epa-medication-pharmaceutical-product Version: 1.3.0
Active as of 2025-12-15 Computable Name: EPAMedicationPharmaceuticalProduct

Copyright/Legal: gematik GmbH / Dieses Artefakt ist lizenziert unter Apache License, Version 2.0.

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.

Usages:

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Medication C 0..* Medication Definition of a Medication
Constraints: dom-2, dom-3, dom-4, dom-5, dom-6, epa-med-1
... meta SΣ 0..1 Meta Metadata about the resource
.... versionId SΣ 0..1 id Version specific identifier
.... lastUpdated SΣ 0..1 instant When the resource version last changed
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for extension Content/Rules for all slices
.... extension:rxPrescriptionProcessIdentifier 0..1 RxPrescriptionProcessIdentifier Extension
URL: https://gematik.de/fhir/epa-medication/StructureDefinition/rx-prescription-process-identifier-extension
.... extension:isVaccine 0..1 (Complex) Extension
URL: https://gematik.de/fhir/epa-medication/StructureDefinition/medication-id-vaccine-extension
..... extension 0..0 Extension
Slice: Unordered, Open by value:url
..... url 1..1 uri "https://gematik.de/fhir/epa-medication/StructureDefinition/medication-id-vaccine-extension"
..... value[x] S 1..1 boolean Vaccine Indicator
.... extension:drugCategory 0..1 (Complex) Extension
URL: https://gematik.de/fhir/epa-medication/StructureDefinition/drug-category-extension
..... extension 0..0 Extension
Slice: Unordered, Open by value:url
..... url 1..1 uri "https://gematik.de/fhir/epa-medication/StructureDefinition/drug-category-extension"
..... value[x] S 1..1 Coding Value of extension
Binding: TI Drug Category ValueSet (required)
...... system SΣ 1..1 uri Identity of the terminology system
...... code SΣ 1..1 code Category
.... extension:normSizeCode 0..1 (Complex) Package size according to N-designation
URL: http://fhir.de/StructureDefinition/normgroesse
..... extension 0..0 Additional content defined by implementations
Slice: Unordered, Open by value:url
..... url 1..1 uri "http://fhir.de/StructureDefinition/normgroesse"
..... value[x] S 0..1 code Value of extension
Binding: https://fhir.kbv.de/ValueSet/KBV_VS_SFHIR_KBV_NORMGROESSE (required)
.... extension:packaging 0..1 (Complex) Extension
URL: https://gematik.de/fhir/epa-medication/StructureDefinition/medication-formulation-packaging-extension
..... extension 0..0 Extension
Slice: Unordered, Open by value:url
..... url 1..1 uri "https://gematik.de/fhir/epa-medication/StructureDefinition/medication-formulation-packaging-extension"
..... value[x] S 1..1 string Packaging of a formulation.
Max Length:90
.... extension:manufacturingInstructions 0..1 (Complex) Extension
URL: https://gematik.de/fhir/epa-medication/StructureDefinition/medication-manufacturing-instructions-extension
..... extension 0..0 Extension
Slice: Unordered, Open by value:url
..... url 1..1 uri "https://gematik.de/fhir/epa-medication/StructureDefinition/medication-manufacturing-instructions-extension"
..... value[x] S 1..1 string Manufacturing instructions for a formulation.
Max Length:500
.... extension:type S 0..1 (Complex) Medication Type
URL: https://gematik.de/fhir/epa-medication/StructureDefinition/epa-medication-type-extension
..... extension 0..0 Extension
Slice: Unordered, Open by value:url
..... url 1..1 uri "https://gematik.de/fhir/epa-medication/StructureDefinition/epa-medication-type-extension"
..... value[x] S 1..1 Coding Value of extension
Binding: TI Medication Type ValueSet for a Pharmaceutical Product (required)
... Slices for identifier Σ 0..* Identifier Business identifier for this medication
Slice: Unordered, Open by value:$this
.... identifier:EPAMedicationUniqueIdentifier Σ 0..1 EPAMedicationUniqueIdentifier Business identifier for this medication

Required Pattern: At least the following
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... use 0..1 code usual | official | temp | secondary | old (If known)
..... type 0..1 CodeableConcept Description of identifier
..... system 1..1 uri The namespace for the identifier value
Fixed Value: https://gematik.de/fhir/epa-medication/sid/epa-medication-unique-identifier
..... value 0..1 string The value that is unique
..... period 0..1 Period Time period when id is/was valid for use
..... assigner 0..1 Reference(Organization) Organization that issued id (may be just text)
.... identifier:RxOriginatorProcessIdentifier Σ 0..1 RxOriginatorProcessIdentifier Business identifier for this medication

Required Pattern: At least the following
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... use 0..1 code usual | official | temp | secondary | old (If known)
..... type 0..1 CodeableConcept Description of identifier
..... system 1..1 uri The namespace for the identifier value
Fixed Value: https://gematik.de/fhir/epa-medication/sid/rx-originator-process-identifier
..... value 0..1 string The value that is unique
..... period 0..1 Period Time period when id is/was valid for use
..... assigner 0..1 Reference(Organization) Organization that issued id (may be just text)
... code SΣ 0..1 CodeableConcept Medication in coded form or as free text if necessary
Binding: SNOMEDCTMedicationCodes (example): A coded concept that defines the type of a medication.
.... Slices for coding SΣ 0..* Coding Code defined by a terminology system
Slice: Unordered, Open by value:$this
..... coding:atc-de SΣ 0..* Coding Code defined by a terminology system

Required Pattern: At least the following
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... system 1..1 uri Identity of the terminology system
Fixed Value: http://fhir.de/CodeSystem/bfarm/atc
...... version 0..1 string Version of the system - if relevant
...... code 0..1 code Symbol in syntax defined by the system
...... display 0..1 string Representation defined by the system
...... userSelected 0..1 boolean If this coding was chosen directly by the user
...... system SΣ 1..1 uri Identity of the terminology system
...... version Σ 1..1 string Version of the system - if relevant
...... code SΣ 1..1 code Symbol in syntax defined by the system
...... display SΣ 0..1 string Representation defined by the system
..... coding:ask SΣ 0..* Coding Code defined by a terminology system

Required Pattern: At least the following
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... system 1..1 uri Identity of the terminology system
Fixed Value: http://fhir.de/CodeSystem/ask
...... version 0..1 string Version of the system - if relevant
...... code 0..1 code Symbol in syntax defined by the system
...... display 0..1 string Representation defined by the system
...... userSelected 0..1 boolean If this coding was chosen directly by the user
...... system SΣ 1..1 uri Identity of the terminology system
...... code SΣ 1..1 code Symbol in syntax defined by the system
...... display SΣ 0..1 string Representation defined by the system
.... text SΣ 0..1 string Plain text representation of the concept
... status ?!SΣ 0..1 code Status of Medication Information
Binding: Medication Status Codes (required): A coded concept defining if the medication is in active use.
... manufacturer SΣC 0..1 Reference(Organization) Manufacturer of the Medication
Constraints: ref-1
.... display SΣ 1..1 string Text alternative for the resource
... form S 0..1 CodeableConcept Form of Dispensing
Binding: SNOMEDCTFormCodes (example): A coded concept defining the form of a medication.
.... Slices for coding SΣ 0..* Coding Code defined by a terminology system
Slice: Unordered, Open by value:$this
..... coding:kbvDarreichungsform SΣ 0..* Coding Code defined by a terminology system
Binding: https://fhir.kbv.de/ValueSet/KBV_VS_SFHIR_KBV_DARREICHUNGSFORM (required)

Required Pattern: At least the following
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... system 1..1 uri Identity of the terminology system
Fixed Value: https://fhir.kbv.de/CodeSystem/KBV_CS_SFHIR_KBV_DARREICHUNGSFORM
...... version 0..1 string Version of the system - if relevant
...... code 0..1 code Symbol in syntax defined by the system
...... display 0..1 string Representation defined by the system
...... userSelected 0..1 boolean If this coding was chosen directly by the user
...... system SΣ 1..1 uri Identity of the terminology system
...... code SΣ 1..1 code Symbol in syntax defined by the system
...... display SΣ 0..1 string Representation defined by the system
... amount SΣC 0..1 Ratio Amount of drug in package
Constraints: rat-1
.... numerator SΣC 0..1 Quantity Numerator value
Binding: UCUMCodes (preferred)
Constraints: qty-3
..... Slices for extension Content/Rules for all slices
...... extension:packagingSize 0..1 (Complex) Extension
URL: https://gematik.de/fhir/epa-medication/StructureDefinition/medication-packaging-size-extension
....... extension 0..0 Extension
Slice: Unordered, Open by value:url
....... url 1..1 uri "https://gematik.de/fhir/epa-medication/StructureDefinition/medication-packaging-size-extension"
....... value[x] S 1..1 string Package size according to divided quantity
Max Length:7
...... extension:totalQuantity 0..1 (Complex) Extension
URL: https://gematik.de/fhir/epa-medication/StructureDefinition/medication-total-quantity-formulation-extension
....... extension 0..0 Extension
Slice: Unordered, Open by value:url
....... url 1..1 uri "https://gematik.de/fhir/epa-medication/StructureDefinition/medication-total-quantity-formulation-extension"
....... value[x] S 1..1 string Total quantity of the formulation.
Max Length:7
..... value SΣ 0..1 decimal Numerical value (with implicit precision)
..... comparator ?!Σ 0..1 code < | <= | >= | > - how to understand the value
Binding: QuantityComparator (required): How the Quantity should be understood and represented.
..... unit SΣ 0..1 string Unit representation
..... system SΣC 0..1 uri System that defines coded unit form
..... code SΣ 0..1 code Coded form of the unit
.... denominator SΣC 0..1 Quantity Denominator value
Binding: UCUMCodes (preferred)
Constraints: qty-3
..... value SΣ 0..1 decimal Numerical value (with implicit precision)
..... comparator ?!Σ 0..1 code < | <= | >= | > - how to understand the value
Binding: QuantityComparator (required): How the Quantity should be understood and represented.
..... unit SΣ 0..1 string Unit representation
..... system SΣC 0..1 uri System that defines coded unit form
..... code SΣ 0..1 code Coded form of the unit
... ingredient S 0..* BackboneElement Active or inactive ingredients of the medication, including pharmaceutical substances as well as individual medicinal products in combination packs.
.... Slices for extension Content/Rules for all slices
..... extension:darreichungsform 0..1 string Extension
URL: https://gematik.de/fhir/epa-medication/StructureDefinition/medication-ingredient-darreichungsform-extension
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... Slices for item[x] S 1..1 CodeableConcept The actual ingredient or content
Slice: Unordered, Closed by type:$this
..... item[x]:itemCodeableConcept S 0..1 CodeableConcept Encoded description of the substance or component.
...... Slices for coding SΣ 0..* Coding Code defined by a terminology system
Slice: Unordered, Open by value:$this
....... coding:ask SΣ 0..* Coding Code defined by a terminology system

Required Pattern: At least the following
........ id 0..1 string Unique id for inter-element referencing
........ extension 0..* Extension Additional content defined by implementations
........ system 1..1 uri Identity of the terminology system
Fixed Value: http://fhir.de/CodeSystem/ask
........ version 0..1 string Version of the system - if relevant
........ code 0..1 code Symbol in syntax defined by the system
........ display 0..1 string Representation defined by the system
........ userSelected 0..1 boolean If this coding was chosen directly by the user
........ system SΣ 1..1 uri Identity of the terminology system
........ code SΣ 1..1 code Symbol in syntax defined by the system
........ display SΣ 0..1 string Representation defined by the system
....... coding:atc-de SΣ 0..* Coding Code defined by a terminology system

Required Pattern: At least the following
........ id 0..1 string Unique id for inter-element referencing
........ extension 0..* Extension Additional content defined by implementations
........ system 1..1 uri Identity of the terminology system
Fixed Value: http://fhir.de/CodeSystem/bfarm/atc
........ version 0..1 string Version of the system - if relevant
........ code 0..1 code Symbol in syntax defined by the system
........ display 0..1 string Representation defined by the system
........ userSelected 0..1 boolean If this coding was chosen directly by the user
........ system SΣ 1..1 uri Identity of the terminology system
........ version Σ 1..1 string Version of the system - if relevant
........ code SΣ 1..1 code Symbol in syntax defined by the system
........ display SΣ 0..1 string Representation defined by the system
....... coding:pzn SΣ 0..* Coding Code defined by a terminology system

Required Pattern: At least the following
........ id 0..1 string Unique id for inter-element referencing
........ extension 0..* Extension Additional content defined by implementations
........ system 1..1 uri Identity of the terminology system
Fixed Value: http://fhir.de/CodeSystem/ifa/pzn
........ version 0..1 string Version of the system - if relevant
........ code 0..1 code Symbol in syntax defined by the system
........ display 0..1 string Representation defined by the system
........ userSelected 0..1 boolean If this coding was chosen directly by the user
........ system SΣ 1..1 uri Identity of the terminology system
........ code SΣ 1..1 code Symbol in syntax defined by the system
........ display SΣ 0..1 string Representation defined by the system
...... text SΣ 0..1 string Plain text representation of the concept
.... isActive 0..1 boolean Is it an active ingredient?
.... strength SC 0..1 Ratio Strength
Constraints: rat-1
..... Slices for extension Content/Rules for all slices
...... extension:amountText 0..1 (Complex) Extension
URL: https://gematik.de/fhir/epa-medication/StructureDefinition/medication-ingredient-amount-extension
....... extension 0..0 Extension
Slice: Unordered, Open by value:url
....... url 1..1 uri "https://gematik.de/fhir/epa-medication/StructureDefinition/medication-ingredient-amount-extension"
....... value[x] S 1..1 string Free-text amount of an ingredient in a formulation.
Max Length:20
..... numerator SΣC 0..1 Quantity Numerator value
Binding: UCUMCodes (preferred)
Constraints: qty-3
...... value SΣ 1..1 decimal Numerical value (with implicit precision)
...... comparator ?!Σ 0..1 code < | <= | >= | > - how to understand the value
Binding: QuantityComparator (required): How the Quantity should be understood and represented.
...... unit SΣ 0..1 string Unit representation
...... system SΣC 0..1 uri System that defines coded unit form
...... code SΣ 0..1 code Coded form of the unit
..... denominator SΣC 0..1 Quantity Denominator value
Binding: UCUMCodes (preferred)
Constraints: qty-3
...... value SΣ 1..1 decimal Numerical value (with implicit precision)
...... comparator ?!Σ 0..1 code < | <= | >= | > - how to understand the value
Binding: QuantityComparator (required): How the Quantity should be understood and represented.
...... unit SΣ 0..1 string Unit representation
...... system SΣC 0..1 uri System that defines coded unit form
...... code SΣ 0..1 code Coded form of the unit
... batch 0..1 BackboneElement Batch Information
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... lotNumber 0..1 string Batch Number

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Medication.extension:drugCategory.​value[x] Base required TI Drug Category ValueSet 📦1.0.7 TI Terminology v1.0
Medication.extension:normSizeCode.​value[x] Base required https://fhir.kbv.de/ValueSet/KBV_VS_SFHIR_KBV_NORMGROESSE Not State Unknown
Medication.extension:type.​value[x] Base required TI Medication Type ValueSet for a Pharmaceutical Product 📦1.0.7 TI Terminology v1.0
Medication.code Base example SNOMED CT Medication Codes 📍4.0.1 FHIR Std.
Medication.status Base required Medication status codes 📍4.0.1 FHIR Std.
Medication.form Base example SNOMED CT Form Codes 📍4.0.1 FHIR Std.
Medication.form.coding:kbvDarreichungsform Base required https://fhir.kbv.de/ValueSet/KBV_VS_SFHIR_KBV_DARREICHUNGSFORM Not State Unknown
Medication.amount.numerator Base preferred UCUM Codes 📦4.0.1 FHIR Std.
Medication.amount.numerator.​comparator Base required QuantityComparator 📍4.0.1 FHIR Std.
Medication.amount.denominator Base preferred UCUM Codes 📦4.0.1 FHIR Std.
Medication.amount.denominator.​comparator Base required QuantityComparator 📍4.0.1 FHIR Std.
Medication.ingredient.​strength.numerator Base preferred UCUM Codes 📦4.0.1 FHIR Std.
Medication.ingredient.​strength.numerator.comparator Base required QuantityComparator 📍4.0.1 FHIR Std.
Medication.ingredient.​strength.denominator Base preferred UCUM Codes 📦4.0.1 FHIR Std.
Medication.ingredient.​strength.denominator.​comparator Base required QuantityComparator 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error Medication If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Medication If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error Medication If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error Medication If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Medication A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
epa-med-1 error Medication Medication code, name, or ingredients must be specified code.exists() or ingredient.exists()
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
qty-3 error Medication.amount.numerator, Medication.amount.denominator, Medication.ingredient.strength.numerator, Medication.ingredient.strength.denominator If a code for the unit is present, the system SHALL also be present code.empty() or system.exists()
rat-1 error Medication.amount, Medication.ingredient.strength Numerator and denominator SHALL both be present, or both are absent. If both are absent, there SHALL be some extension present (numerator.empty() xor denominator.exists()) and (numerator.exists() or extension.exists())
ref-1 error Medication.manufacturer SHALL have a contained resource if a local reference is provided reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))

This structure is derived from Medication

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Medication C 0..* Medication Definition of a Medication
Constraints: epa-med-1
... meta S 0..1 Meta Metadata about the resource
.... versionId S 0..1 id Version specific identifier
.... lastUpdated S 0..1 instant When the resource version last changed
... contained 0..0 Contained, inline Resources
... Slices for extension Content/Rules for all slices
.... extension:rxPrescriptionProcessIdentifier 0..1 RxPrescriptionProcessIdentifier Extension
URL: https://gematik.de/fhir/epa-medication/StructureDefinition/rx-prescription-process-identifier-extension
.... extension:isVaccine 0..1 (Complex) Extension
URL: https://gematik.de/fhir/epa-medication/StructureDefinition/medication-id-vaccine-extension
..... value[x] S 1..1 boolean Vaccine Indicator
.... extension:drugCategory 0..1 (Complex) Extension
URL: https://gematik.de/fhir/epa-medication/StructureDefinition/drug-category-extension
..... value[x] S 1..1 Coding Value of extension
...... system S 1..1 uri Identity of the terminology system
...... code S 1..1 code Category
.... extension:normSizeCode 0..1 (Complex) Package size according to N-designation
URL: http://fhir.de/StructureDefinition/normgroesse
..... value[x] S 0..1 code Value of extension
.... extension:packaging 0..1 (Complex) Extension
URL: https://gematik.de/fhir/epa-medication/StructureDefinition/medication-formulation-packaging-extension
..... value[x] S 1..1 string Packaging of a formulation.
.... extension:manufacturingInstructions 0..1 (Complex) Extension
URL: https://gematik.de/fhir/epa-medication/StructureDefinition/medication-manufacturing-instructions-extension
..... value[x] S 1..1 string Manufacturing instructions for a formulation.
.... extension:type S 0..1 (Complex) Medication Type
URL: https://gematik.de/fhir/epa-medication/StructureDefinition/epa-medication-type-extension
..... value[x] 1..1 Coding Value of extension
Binding: TI Medication Type ValueSet for a Pharmaceutical Product (required)
.... identifier:EPAMedicationUniqueIdentifier 0..1 EPAMedicationUniqueIdentifier Business identifier for this medication
Required Pattern: At least the following
..... system 1..1 uri The namespace for the identifier value
Fixed Value: https://gematik.de/fhir/epa-medication/sid/epa-medication-unique-identifier
.... identifier:RxOriginatorProcessIdentifier 0..1 RxOriginatorProcessIdentifier Business identifier for this medication
Required Pattern: At least the following
..... system 1..1 uri The namespace for the identifier value
Fixed Value: https://gematik.de/fhir/epa-medication/sid/rx-originator-process-identifier
... code S 0..1 CodeableConcept Medication in coded form or as free text if necessary
.... Slices for coding S 0..* Coding Code defined by a terminology system
Slice: Unordered, Open by value:$this
..... coding:pzn S 0..0 Code defined by a terminology system
Required Pattern: At least the following
...... system 1..1 uri Identity of the terminology system
Fixed Value: http://fhir.de/CodeSystem/ifa/pzn
..... coding:atc-de S 0..* Coding Code defined by a terminology system

Required Pattern: At least the following
...... system 1..1 uri Identity of the terminology system
Fixed Value: http://fhir.de/CodeSystem/bfarm/atc
...... system S 1..1 uri Identity of the terminology system
...... version 1..1 string Version of the system - if relevant
...... code S 1..1 code Symbol in syntax defined by the system
...... display S 0..1 string Representation defined by the system
..... coding:ask S 0..* Coding Code defined by a terminology system

Required Pattern: At least the following
...... system 1..1 uri Identity of the terminology system
Fixed Value: http://fhir.de/CodeSystem/ask
...... system S 1..1 uri Identity of the terminology system
...... code S 1..1 code Symbol in syntax defined by the system
...... display S 0..1 string Representation defined by the system
.... text S 0..1 string Plain text representation of the concept
... status S 0..1 code Status of Medication Information
... manufacturer S 0..1 Reference(Organization) Manufacturer of the Medication
.... display S 1..1 string Text alternative for the resource
... form S 0..1 CodeableConcept Form of Dispensing
.... Slices for coding S 0..* Coding Code defined by a terminology system
Slice: Unordered, Open by value:$this
..... coding:kbvDarreichungsform S 0..* Coding Code defined by a terminology system
Binding: https://fhir.kbv.de/ValueSet/KBV_VS_SFHIR_KBV_DARREICHUNGSFORM (required)

Required Pattern: At least the following
...... system 1..1 uri Identity of the terminology system
Fixed Value: https://fhir.kbv.de/CodeSystem/KBV_CS_SFHIR_KBV_DARREICHUNGSFORM
...... system S 1..1 uri Identity of the terminology system
...... code S 1..1 code Symbol in syntax defined by the system
...... display S 0..1 string Representation defined by the system
... amount S 0..1 Ratio Amount of drug in package
.... numerator S 0..1 Quantity Numerator value
Binding: UCUMCodes (preferred)
..... Slices for extension Content/Rules for all slices
...... extension:packagingSize 0..1 (Complex) Extension
URL: https://gematik.de/fhir/epa-medication/StructureDefinition/medication-packaging-size-extension
....... value[x] S 1..1 string Package size according to divided quantity
...... extension:totalQuantity 0..1 (Complex) Extension
URL: https://gematik.de/fhir/epa-medication/StructureDefinition/medication-total-quantity-formulation-extension
....... value[x] S 1..1 string Total quantity of the formulation.
..... value S 0..1 decimal Numerical value (with implicit precision)
..... unit S 0..1 string Unit representation
..... system S 0..1 uri System that defines coded unit form
..... code S 0..1 code Coded form of the unit
.... denominator S 0..1 Quantity Denominator value
Binding: UCUMCodes (preferred)
..... value S 0..1 decimal Numerical value (with implicit precision)
..... unit S 0..1 string Unit representation
..... system S 0..1 uri System that defines coded unit form
..... code S 0..1 code Coded form of the unit
... ingredient S 0..* BackboneElement Active or inactive ingredients of the medication, including pharmaceutical substances as well as individual medicinal products in combination packs.
.... Slices for extension Content/Rules for all slices
..... extension:darreichungsform 0..1 string Extension
URL: https://gematik.de/fhir/epa-medication/StructureDefinition/medication-ingredient-darreichungsform-extension
.... Slices for item[x] S 1..1 CodeableConcept The actual ingredient or content
Slice: Unordered, Open by type:$this
..... item[x]:itemCodeableConcept S 0..1 CodeableConcept Encoded description of the substance or component.
...... Slices for coding S 0..* Coding Code defined by a terminology system
Slice: Unordered, Open by value:$this
....... coding:ask S 0..* Coding Code defined by a terminology system

Required Pattern: At least the following
........ system 1..1 uri Identity of the terminology system
Fixed Value: http://fhir.de/CodeSystem/ask
........ system S 1..1 uri Identity of the terminology system
........ code S 1..1 code Symbol in syntax defined by the system
........ display S 0..1 string Representation defined by the system
....... coding:atc-de S 0..* Coding Code defined by a terminology system

Required Pattern: At least the following
........ system 1..1 uri Identity of the terminology system
Fixed Value: http://fhir.de/CodeSystem/bfarm/atc
........ system S 1..1 uri Identity of the terminology system
........ version 1..1 string Version of the system - if relevant
........ code S 1..1 code Symbol in syntax defined by the system
........ display S 0..1 string Representation defined by the system
....... coding:pzn S 0..* Coding Code defined by a terminology system

Required Pattern: At least the following
........ system 1..1 uri Identity of the terminology system
Fixed Value: http://fhir.de/CodeSystem/ifa/pzn
........ system S 1..1 uri Identity of the terminology system
........ code S 1..1 code Symbol in syntax defined by the system
........ display S 0..1 string Representation defined by the system
...... text S 0..1 string Plain text representation of the concept
..... item[x]:itemReference S 0..0 Medication Pharmaceutical Product can't have child Medications
.... isActive 0..1 boolean Is it an active ingredient?
.... strength S 0..1 Ratio Strength
..... Slices for extension Content/Rules for all slices
...... extension:amountText 0..1 (Complex) Extension
URL: https://gematik.de/fhir/epa-medication/StructureDefinition/medication-ingredient-amount-extension
....... value[x] S 1..1 string Free-text amount of an ingredient in a formulation.
..... numerator S 0..1 Quantity Numerator value
Binding: UCUMCodes (preferred)
...... value S 1..1 decimal Numerical value (with implicit precision)
...... unit S 0..1 string Unit representation
...... system S 0..1 uri System that defines coded unit form
...... code S 0..1 code Coded form of the unit
..... denominator S 0..1 Quantity Denominator value
Binding: UCUMCodes (preferred)
...... value S 1..1 decimal Numerical value (with implicit precision)
...... unit S 0..1 string Unit representation
...... system S 0..1 uri System that defines coded unit form
...... code S 0..1 code Coded form of the unit
... batch 0..1 BackboneElement Batch Information
.... lotNumber 0..1 string Batch Number

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
Medication.extension:type.​value[x] Base required TI Medication Type ValueSet for a Pharmaceutical Product 📦1.0.7 TI Terminology v1.0
Medication.form.coding:kbvDarreichungsform Base required https://fhir.kbv.de/ValueSet/KBV_VS_SFHIR_KBV_DARREICHUNGSFORM Not State Unknown
Medication.amount.numerator Base preferred UCUM Codes 📦4.0.1 FHIR Std.
Medication.amount.denominator Base preferred UCUM Codes 📦4.0.1 FHIR Std.
Medication.ingredient.​strength.numerator Base preferred UCUM Codes 📦4.0.1 FHIR Std.
Medication.ingredient.​strength.denominator Base preferred UCUM Codes 📦4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
epa-med-1 error Medication Medication code, name, or ingredients must be specified code.exists() or ingredient.exists()
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Medication C 0..* Medication Definition of a Medication
Constraints: dom-2, dom-3, dom-4, dom-5, dom-6, epa-med-1
... id Σ 0..1 id Logical id of this artifact
... meta SΣ 0..1 Meta Metadata about the resource
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... versionId SΣ 0..1 id Version specific identifier
.... lastUpdated SΣ 0..1 instant When the resource version last changed
.... source Σ 0..1 uri Identifies where the resource comes from
.... profile Σ 0..* canonical(StructureDefinition) Profiles this resource claims to conform to
.... security Σ 0..* Coding Security Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
.... tag Σ 0..* Coding Tags applied to this resource
Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... extension:rxPrescriptionProcessIdentifier 0..1 RxPrescriptionProcessIdentifier Extension
URL: https://gematik.de/fhir/epa-medication/StructureDefinition/rx-prescription-process-identifier-extension
.... extension:isVaccine 0..1 (Complex) Extension
URL: https://gematik.de/fhir/epa-medication/StructureDefinition/medication-id-vaccine-extension
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..0 Extension
Slice: Unordered, Open by value:url
..... url 1..1 uri "https://gematik.de/fhir/epa-medication/StructureDefinition/medication-id-vaccine-extension"
..... value[x] S 1..1 boolean Vaccine Indicator
.... extension:drugCategory 0..1 (Complex) Extension
URL: https://gematik.de/fhir/epa-medication/StructureDefinition/drug-category-extension
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..0 Extension
Slice: Unordered, Open by value:url
..... url 1..1 uri "https://gematik.de/fhir/epa-medication/StructureDefinition/drug-category-extension"
..... value[x] S 1..1 Coding Value of extension
Binding: TI Drug Category ValueSet (required)
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... system SΣ 1..1 uri Identity of the terminology system
...... version Σ 0..1 string Version of the system - if relevant
...... code SΣ 1..1 code Category
...... display Σ 0..1 string Representation defined by the system
...... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
.... extension:normSizeCode 0..1 (Complex) Package size according to N-designation
URL: http://fhir.de/StructureDefinition/normgroesse
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..0 Additional content defined by implementations
Slice: Unordered, Open by value:url
..... url 1..1 uri "http://fhir.de/StructureDefinition/normgroesse"
..... value[x] S 0..1 code Value of extension
Binding: https://fhir.kbv.de/ValueSet/KBV_VS_SFHIR_KBV_NORMGROESSE (required)
.... extension:packaging 0..1 (Complex) Extension
URL: https://gematik.de/fhir/epa-medication/StructureDefinition/medication-formulation-packaging-extension
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..0 Extension
Slice: Unordered, Open by value:url
..... url 1..1 uri "https://gematik.de/fhir/epa-medication/StructureDefinition/medication-formulation-packaging-extension"
..... value[x] S 1..1 string Packaging of a formulation.
Max Length:90
.... extension:manufacturingInstructions 0..1 (Complex) Extension
URL: https://gematik.de/fhir/epa-medication/StructureDefinition/medication-manufacturing-instructions-extension
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..0 Extension
Slice: Unordered, Open by value:url
..... url 1..1 uri "https://gematik.de/fhir/epa-medication/StructureDefinition/medication-manufacturing-instructions-extension"
..... value[x] S 1..1 string Manufacturing instructions for a formulation.
Max Length:500
.... extension:type S 0..1 (Complex) Medication Type
URL: https://gematik.de/fhir/epa-medication/StructureDefinition/epa-medication-type-extension
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..0 Extension
Slice: Unordered, Open by value:url
..... url 1..1 uri "https://gematik.de/fhir/epa-medication/StructureDefinition/epa-medication-type-extension"
..... value[x] S 1..1 Coding Value of extension
Binding: TI Medication Type ValueSet for a Pharmaceutical Product (required)
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
Slice: Unordered, Open by value:url
... Slices for identifier Σ 0..* Identifier Business identifier for this medication
Slice: Unordered, Open by value:$this
.... identifier:EPAMedicationUniqueIdentifier Σ 0..1 EPAMedicationUniqueIdentifier Business identifier for this medication

Required Pattern: At least the following
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... use 0..1 code usual | official | temp | secondary | old (If known)
..... type 0..1 CodeableConcept Description of identifier
..... system 1..1 uri The namespace for the identifier value
Fixed Value: https://gematik.de/fhir/epa-medication/sid/epa-medication-unique-identifier
..... value 0..1 string The value that is unique
..... period 0..1 Period Time period when id is/was valid for use
..... assigner 0..1 Reference(Organization) Organization that issued id (may be just text)
.... identifier:RxOriginatorProcessIdentifier Σ 0..1 RxOriginatorProcessIdentifier Business identifier for this medication

Required Pattern: At least the following
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... use 0..1 code usual | official | temp | secondary | old (If known)
..... type 0..1 CodeableConcept Description of identifier
..... system 1..1 uri The namespace for the identifier value
Fixed Value: https://gematik.de/fhir/epa-medication/sid/rx-originator-process-identifier
..... value 0..1 string The value that is unique
..... period 0..1 Period Time period when id is/was valid for use
..... assigner 0..1 Reference(Organization) Organization that issued id (may be just text)
... code SΣ 0..1 CodeableConcept Medication in coded form or as free text if necessary
Binding: SNOMEDCTMedicationCodes (example): A coded concept that defines the type of a medication.
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... Slices for coding SΣ 0..* Coding Code defined by a terminology system
Slice: Unordered, Open by value:$this
..... coding:atc-de SΣ 0..* Coding Code defined by a terminology system

Required Pattern: At least the following
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... system 1..1 uri Identity of the terminology system
Fixed Value: http://fhir.de/CodeSystem/bfarm/atc
...... version 0..1 string Version of the system - if relevant
...... code 0..1 code Symbol in syntax defined by the system
...... display 0..1 string Representation defined by the system
...... userSelected 0..1 boolean If this coding was chosen directly by the user
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... system SΣ 1..1 uri Identity of the terminology system
...... version Σ 1..1 string Version of the system - if relevant
...... code SΣ 1..1 code Symbol in syntax defined by the system
...... display SΣ 0..1 string Representation defined by the system
...... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
..... coding:ask SΣ 0..* Coding Code defined by a terminology system

Required Pattern: At least the following
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... system 1..1 uri Identity of the terminology system
Fixed Value: http://fhir.de/CodeSystem/ask
...... version 0..1 string Version of the system - if relevant
...... code 0..1 code Symbol in syntax defined by the system
...... display 0..1 string Representation defined by the system
...... userSelected 0..1 boolean If this coding was chosen directly by the user
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... system SΣ 1..1 uri Identity of the terminology system
...... version Σ 0..1 string Version of the system - if relevant
...... code SΣ 1..1 code Symbol in syntax defined by the system
...... display SΣ 0..1 string Representation defined by the system
...... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
.... text SΣ 0..1 string Plain text representation of the concept
... status ?!SΣ 0..1 code Status of Medication Information
Binding: Medication Status Codes (required): A coded concept defining if the medication is in active use.
... manufacturer SΣC 0..1 Reference(Organization) Manufacturer of the Medication
Constraints: ref-1
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
.... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
.... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
.... display SΣ 1..1 string Text alternative for the resource
... form S 0..1 CodeableConcept Form of Dispensing
Binding: SNOMEDCTFormCodes (example): A coded concept defining the form of a medication.
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... Slices for coding SΣ 0..* Coding Code defined by a terminology system
Slice: Unordered, Open by value:$this
..... coding:kbvDarreichungsform SΣ 0..* Coding Code defined by a terminology system
Binding: https://fhir.kbv.de/ValueSet/KBV_VS_SFHIR_KBV_DARREICHUNGSFORM (required)

Required Pattern: At least the following
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... system 1..1 uri Identity of the terminology system
Fixed Value: https://fhir.kbv.de/CodeSystem/KBV_CS_SFHIR_KBV_DARREICHUNGSFORM
...... version 0..1 string Version of the system - if relevant
...... code 0..1 code Symbol in syntax defined by the system
...... display 0..1 string Representation defined by the system
...... userSelected 0..1 boolean If this coding was chosen directly by the user
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... system SΣ 1..1 uri Identity of the terminology system
...... version Σ 0..1 string Version of the system - if relevant
...... code SΣ 1..1 code Symbol in syntax defined by the system
...... display SΣ 0..1 string Representation defined by the system
...... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
.... text Σ 0..1 string Plain text representation of the concept
... amount SΣC 0..1 Ratio Amount of drug in package
Constraints: rat-1
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... numerator SΣC 0..1 Quantity Numerator value
Binding: UCUMCodes (preferred)
Constraints: qty-3
..... id 0..1 string Unique id for inter-element referencing
..... Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... extension:packagingSize 0..1 (Complex) Extension
URL: https://gematik.de/fhir/epa-medication/StructureDefinition/medication-packaging-size-extension
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..0 Extension
Slice: Unordered, Open by value:url
....... url 1..1 uri "https://gematik.de/fhir/epa-medication/StructureDefinition/medication-packaging-size-extension"
....... value[x] S 1..1 string Package size according to divided quantity
Max Length:7
...... extension:totalQuantity 0..1 (Complex) Extension
URL: https://gematik.de/fhir/epa-medication/StructureDefinition/medication-total-quantity-formulation-extension
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..0 Extension
Slice: Unordered, Open by value:url
....... url 1..1 uri "https://gematik.de/fhir/epa-medication/StructureDefinition/medication-total-quantity-formulation-extension"
....... value[x] S 1..1 string Total quantity of the formulation.
Max Length:7
..... value SΣ 0..1 decimal Numerical value (with implicit precision)
..... comparator ?!Σ 0..1 code < | <= | >= | > - how to understand the value
Binding: QuantityComparator (required): How the Quantity should be understood and represented.
..... unit SΣ 0..1 string Unit representation
..... system SΣC 0..1 uri System that defines coded unit form
..... code SΣ 0..1 code Coded form of the unit
.... denominator SΣC 0..1 Quantity Denominator value
Binding: UCUMCodes (preferred)
Constraints: qty-3
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... value SΣ 0..1 decimal Numerical value (with implicit precision)
..... comparator ?!Σ 0..1 code < | <= | >= | > - how to understand the value
Binding: QuantityComparator (required): How the Quantity should be understood and represented.
..... unit SΣ 0..1 string Unit representation
..... system SΣC 0..1 uri System that defines coded unit form
..... code SΣ 0..1 code Coded form of the unit
... ingredient S 0..* BackboneElement Active or inactive ingredients of the medication, including pharmaceutical substances as well as individual medicinal products in combination packs.
.... id 0..1 string Unique id for inter-element referencing
.... Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... extension:darreichungsform 0..1 string Extension
URL: https://gematik.de/fhir/epa-medication/StructureDefinition/medication-ingredient-darreichungsform-extension
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... Slices for item[x] S 1..1 CodeableConcept The actual ingredient or content
Slice: Unordered, Closed by type:$this
..... item[x]:itemCodeableConcept S 0..1 CodeableConcept Encoded description of the substance or component.
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... Slices for coding SΣ 0..* Coding Code defined by a terminology system
Slice: Unordered, Open by value:$this
....... coding:ask SΣ 0..* Coding Code defined by a terminology system

Required Pattern: At least the following
........ id 0..1 string Unique id for inter-element referencing
........ extension 0..* Extension Additional content defined by implementations
........ system 1..1 uri Identity of the terminology system
Fixed Value: http://fhir.de/CodeSystem/ask
........ version 0..1 string Version of the system - if relevant
........ code 0..1 code Symbol in syntax defined by the system
........ display 0..1 string Representation defined by the system
........ userSelected 0..1 boolean If this coding was chosen directly by the user
........ id 0..1 string Unique id for inter-element referencing
........ extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
........ system SΣ 1..1 uri Identity of the terminology system
........ version Σ 0..1 string Version of the system - if relevant
........ code SΣ 1..1 code Symbol in syntax defined by the system
........ display SΣ 0..1 string Representation defined by the system
........ userSelected Σ 0..1 boolean If this coding was chosen directly by the user
....... coding:atc-de SΣ 0..* Coding Code defined by a terminology system

Required Pattern: At least the following
........ id 0..1 string Unique id for inter-element referencing
........ extension 0..* Extension Additional content defined by implementations
........ system 1..1 uri Identity of the terminology system
Fixed Value: http://fhir.de/CodeSystem/bfarm/atc
........ version 0..1 string Version of the system - if relevant
........ code 0..1 code Symbol in syntax defined by the system
........ display 0..1 string Representation defined by the system
........ userSelected 0..1 boolean If this coding was chosen directly by the user
........ id 0..1 string Unique id for inter-element referencing
........ extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
........ system SΣ 1..1 uri Identity of the terminology system
........ version Σ 1..1 string Version of the system - if relevant
........ code SΣ 1..1 code Symbol in syntax defined by the system
........ display SΣ 0..1 string Representation defined by the system
........ userSelected Σ 0..1 boolean If this coding was chosen directly by the user
....... coding:pzn SΣ 0..* Coding Code defined by a terminology system

Required Pattern: At least the following
........ id 0..1 string Unique id for inter-element referencing
........ extension 0..* Extension Additional content defined by implementations
........ system 1..1 uri Identity of the terminology system
Fixed Value: http://fhir.de/CodeSystem/ifa/pzn
........ version 0..1 string Version of the system - if relevant
........ code 0..1 code Symbol in syntax defined by the system
........ display 0..1 string Representation defined by the system
........ userSelected 0..1 boolean If this coding was chosen directly by the user
........ id 0..1 string Unique id for inter-element referencing
........ extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
........ system SΣ 1..1 uri Identity of the terminology system
........ version Σ 0..1 string Version of the system - if relevant
........ code SΣ 1..1 code Symbol in syntax defined by the system
........ display SΣ 0..1 string Representation defined by the system
........ userSelected Σ 0..1 boolean If this coding was chosen directly by the user
...... text SΣ 0..1 string Plain text representation of the concept
.... isActive 0..1 boolean Is it an active ingredient?
.... strength SC 0..1 Ratio Strength
Constraints: rat-1
..... id 0..1 string Unique id for inter-element referencing
..... Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... extension:amountText 0..1 (Complex) Extension
URL: https://gematik.de/fhir/epa-medication/StructureDefinition/medication-ingredient-amount-extension
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..0 Extension
Slice: Unordered, Open by value:url
....... url 1..1 uri "https://gematik.de/fhir/epa-medication/StructureDefinition/medication-ingredient-amount-extension"
....... value[x] S 1..1 string Free-text amount of an ingredient in a formulation.
Max Length:20
..... numerator SΣC 0..1 Quantity Numerator value
Binding: UCUMCodes (preferred)
Constraints: qty-3
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... value SΣ 1..1 decimal Numerical value (with implicit precision)
...... comparator ?!Σ 0..1 code < | <= | >= | > - how to understand the value
Binding: QuantityComparator (required): How the Quantity should be understood and represented.
...... unit SΣ 0..1 string Unit representation
...... system SΣC 0..1 uri System that defines coded unit form
...... code SΣ 0..1 code Coded form of the unit
..... denominator SΣC 0..1 Quantity Denominator value
Binding: UCUMCodes (preferred)
Constraints: qty-3
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... value SΣ 1..1 decimal Numerical value (with implicit precision)
...... comparator ?!Σ 0..1 code < | <= | >= | > - how to understand the value
Binding: QuantityComparator (required): How the Quantity should be understood and represented.
...... unit SΣ 0..1 string Unit representation
...... system SΣC 0..1 uri System that defines coded unit form
...... code SΣ 0..1 code Coded form of the unit
... batch 0..1 BackboneElement Batch Information
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... lotNumber 0..1 string Batch Number
.... expirationDate 0..1 dateTime When batch will expire

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Medication.meta.security Base extensible SecurityLabels 📍4.0.1 FHIR Std.
Medication.meta.tag Base example Common Tags 📍4.0.1 FHIR Std.
Medication.language Base preferred Common Languages 📍4.0.1 FHIR Std.
Medication.extension:drugCategory.​value[x] Base required TI Drug Category ValueSet 📦1.0.7 TI Terminology v1.0
Medication.extension:normSizeCode.​value[x] Base required https://fhir.kbv.de/ValueSet/KBV_VS_SFHIR_KBV_NORMGROESSE Not State Unknown
Medication.extension:type.​value[x] Base required TI Medication Type ValueSet for a Pharmaceutical Product 📦1.0.7 TI Terminology v1.0
Medication.code Base example SNOMED CT Medication Codes 📍4.0.1 FHIR Std.
Medication.status Base required Medication status codes 📍4.0.1 FHIR Std.
Medication.manufacturer.​type Base extensible ResourceType 📍4.0.1 FHIR Std.
Medication.form Base example SNOMED CT Form Codes 📍4.0.1 FHIR Std.
Medication.form.coding:kbvDarreichungsform Base required https://fhir.kbv.de/ValueSet/KBV_VS_SFHIR_KBV_DARREICHUNGSFORM Not State Unknown
Medication.amount.numerator Base preferred UCUM Codes 📦4.0.1 FHIR Std.
Medication.amount.numerator.​comparator Base required QuantityComparator 📍4.0.1 FHIR Std.
Medication.amount.denominator Base preferred UCUM Codes 📦4.0.1 FHIR Std.
Medication.amount.denominator.​comparator Base required QuantityComparator 📍4.0.1 FHIR Std.
Medication.ingredient.​strength.numerator Base preferred UCUM Codes 📦4.0.1 FHIR Std.
Medication.ingredient.​strength.numerator.comparator Base required QuantityComparator 📍4.0.1 FHIR Std.
Medication.ingredient.​strength.denominator Base preferred UCUM Codes 📦4.0.1 FHIR Std.
Medication.ingredient.​strength.denominator.​comparator Base required QuantityComparator 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error Medication If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Medication If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error Medication If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error Medication If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Medication A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
epa-med-1 error Medication Medication code, name, or ingredients must be specified code.exists() or ingredient.exists()
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
qty-3 error Medication.amount.numerator, Medication.amount.denominator, Medication.ingredient.strength.numerator, Medication.ingredient.strength.denominator If a code for the unit is present, the system SHALL also be present code.empty() or system.exists()
rat-1 error Medication.amount, Medication.ingredient.strength Numerator and denominator SHALL both be present, or both are absent. If both are absent, there SHALL be some extension present (numerator.empty() xor denominator.exists()) and (numerator.exists() or extension.exists())
ref-1 error Medication.manufacturer SHALL have a contained resource if a local reference is provided reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))

This structure is derived from Medication

Summary

Mandatory: 0 element(21 nested mandatory elements)
Must-Support: 78 elements
Prohibited: 3 elements

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of Medication.identifier
  • The element 1 is sliced based on the value of Medication.code.coding
  • The element 1 is sliced based on the value of Medication.form.coding
  • The element 1 is sliced based on the value of Medication.ingredient.item[x]
  • The element 1 is sliced based on the value of Medication.ingredient.item[x].coding

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Medication C 0..* Medication Definition of a Medication
Constraints: dom-2, dom-3, dom-4, dom-5, dom-6, epa-med-1
... meta SΣ 0..1 Meta Metadata about the resource
.... versionId SΣ 0..1 id Version specific identifier
.... lastUpdated SΣ 0..1 instant When the resource version last changed
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for extension Content/Rules for all slices
.... extension:rxPrescriptionProcessIdentifier 0..1 RxPrescriptionProcessIdentifier Extension
URL: https://gematik.de/fhir/epa-medication/StructureDefinition/rx-prescription-process-identifier-extension
.... extension:isVaccine 0..1 (Complex) Extension
URL: https://gematik.de/fhir/epa-medication/StructureDefinition/medication-id-vaccine-extension
..... extension 0..0 Extension
Slice: Unordered, Open by value:url
..... url 1..1 uri "https://gematik.de/fhir/epa-medication/StructureDefinition/medication-id-vaccine-extension"
..... value[x] S 1..1 boolean Vaccine Indicator
.... extension:drugCategory 0..1 (Complex) Extension
URL: https://gematik.de/fhir/epa-medication/StructureDefinition/drug-category-extension
..... extension 0..0 Extension
Slice: Unordered, Open by value:url
..... url 1..1 uri "https://gematik.de/fhir/epa-medication/StructureDefinition/drug-category-extension"
..... value[x] S 1..1 Coding Value of extension
Binding: TI Drug Category ValueSet (required)
...... system SΣ 1..1 uri Identity of the terminology system
...... code SΣ 1..1 code Category
.... extension:normSizeCode 0..1 (Complex) Package size according to N-designation
URL: http://fhir.de/StructureDefinition/normgroesse
..... extension 0..0 Additional content defined by implementations
Slice: Unordered, Open by value:url
..... url 1..1 uri "http://fhir.de/StructureDefinition/normgroesse"
..... value[x] S 0..1 code Value of extension
Binding: https://fhir.kbv.de/ValueSet/KBV_VS_SFHIR_KBV_NORMGROESSE (required)
.... extension:packaging 0..1 (Complex) Extension
URL: https://gematik.de/fhir/epa-medication/StructureDefinition/medication-formulation-packaging-extension
..... extension 0..0 Extension
Slice: Unordered, Open by value:url
..... url 1..1 uri "https://gematik.de/fhir/epa-medication/StructureDefinition/medication-formulation-packaging-extension"
..... value[x] S 1..1 string Packaging of a formulation.
Max Length:90
.... extension:manufacturingInstructions 0..1 (Complex) Extension
URL: https://gematik.de/fhir/epa-medication/StructureDefinition/medication-manufacturing-instructions-extension
..... extension 0..0 Extension
Slice: Unordered, Open by value:url
..... url 1..1 uri "https://gematik.de/fhir/epa-medication/StructureDefinition/medication-manufacturing-instructions-extension"
..... value[x] S 1..1 string Manufacturing instructions for a formulation.
Max Length:500
.... extension:type S 0..1 (Complex) Medication Type
URL: https://gematik.de/fhir/epa-medication/StructureDefinition/epa-medication-type-extension
..... extension 0..0 Extension
Slice: Unordered, Open by value:url
..... url 1..1 uri "https://gematik.de/fhir/epa-medication/StructureDefinition/epa-medication-type-extension"
..... value[x] S 1..1 Coding Value of extension
Binding: TI Medication Type ValueSet for a Pharmaceutical Product (required)
... Slices for identifier Σ 0..* Identifier Business identifier for this medication
Slice: Unordered, Open by value:$this
.... identifier:EPAMedicationUniqueIdentifier Σ 0..1 EPAMedicationUniqueIdentifier Business identifier for this medication

Required Pattern: At least the following
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... use 0..1 code usual | official | temp | secondary | old (If known)
..... type 0..1 CodeableConcept Description of identifier
..... system 1..1 uri The namespace for the identifier value
Fixed Value: https://gematik.de/fhir/epa-medication/sid/epa-medication-unique-identifier
..... value 0..1 string The value that is unique
..... period 0..1 Period Time period when id is/was valid for use
..... assigner 0..1 Reference(Organization) Organization that issued id (may be just text)
.... identifier:RxOriginatorProcessIdentifier Σ 0..1 RxOriginatorProcessIdentifier Business identifier for this medication

Required Pattern: At least the following
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... use 0..1 code usual | official | temp | secondary | old (If known)
..... type 0..1 CodeableConcept Description of identifier
..... system 1..1 uri The namespace for the identifier value
Fixed Value: https://gematik.de/fhir/epa-medication/sid/rx-originator-process-identifier
..... value 0..1 string The value that is unique
..... period 0..1 Period Time period when id is/was valid for use
..... assigner 0..1 Reference(Organization) Organization that issued id (may be just text)
... code SΣ 0..1 CodeableConcept Medication in coded form or as free text if necessary
Binding: SNOMEDCTMedicationCodes (example): A coded concept that defines the type of a medication.
.... Slices for coding SΣ 0..* Coding Code defined by a terminology system
Slice: Unordered, Open by value:$this
..... coding:atc-de SΣ 0..* Coding Code defined by a terminology system

Required Pattern: At least the following
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... system 1..1 uri Identity of the terminology system
Fixed Value: http://fhir.de/CodeSystem/bfarm/atc
...... version 0..1 string Version of the system - if relevant
...... code 0..1 code Symbol in syntax defined by the system
...... display 0..1 string Representation defined by the system
...... userSelected 0..1 boolean If this coding was chosen directly by the user
...... system SΣ 1..1 uri Identity of the terminology system
...... version Σ 1..1 string Version of the system - if relevant
...... code SΣ 1..1 code Symbol in syntax defined by the system
...... display SΣ 0..1 string Representation defined by the system
..... coding:ask SΣ 0..* Coding Code defined by a terminology system

Required Pattern: At least the following
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... system 1..1 uri Identity of the terminology system
Fixed Value: http://fhir.de/CodeSystem/ask
...... version 0..1 string Version of the system - if relevant
...... code 0..1 code Symbol in syntax defined by the system
...... display 0..1 string Representation defined by the system
...... userSelected 0..1 boolean If this coding was chosen directly by the user
...... system SΣ 1..1 uri Identity of the terminology system
...... code SΣ 1..1 code Symbol in syntax defined by the system
...... display SΣ 0..1 string Representation defined by the system
.... text SΣ 0..1 string Plain text representation of the concept
... status ?!SΣ 0..1 code Status of Medication Information
Binding: Medication Status Codes (required): A coded concept defining if the medication is in active use.
... manufacturer SΣC 0..1 Reference(Organization) Manufacturer of the Medication
Constraints: ref-1
.... display SΣ 1..1 string Text alternative for the resource
... form S 0..1 CodeableConcept Form of Dispensing
Binding: SNOMEDCTFormCodes (example): A coded concept defining the form of a medication.
.... Slices for coding SΣ 0..* Coding Code defined by a terminology system
Slice: Unordered, Open by value:$this
..... coding:kbvDarreichungsform SΣ 0..* Coding Code defined by a terminology system
Binding: https://fhir.kbv.de/ValueSet/KBV_VS_SFHIR_KBV_DARREICHUNGSFORM (required)

Required Pattern: At least the following
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... system 1..1 uri Identity of the terminology system
Fixed Value: https://fhir.kbv.de/CodeSystem/KBV_CS_SFHIR_KBV_DARREICHUNGSFORM
...... version 0..1 string Version of the system - if relevant
...... code 0..1 code Symbol in syntax defined by the system
...... display 0..1 string Representation defined by the system
...... userSelected 0..1 boolean If this coding was chosen directly by the user
...... system SΣ 1..1 uri Identity of the terminology system
...... code SΣ 1..1 code Symbol in syntax defined by the system
...... display SΣ 0..1 string Representation defined by the system
... amount SΣC 0..1 Ratio Amount of drug in package
Constraints: rat-1
.... numerator SΣC 0..1 Quantity Numerator value
Binding: UCUMCodes (preferred)
Constraints: qty-3
..... Slices for extension Content/Rules for all slices
...... extension:packagingSize 0..1 (Complex) Extension
URL: https://gematik.de/fhir/epa-medication/StructureDefinition/medication-packaging-size-extension
....... extension 0..0 Extension
Slice: Unordered, Open by value:url
....... url 1..1 uri "https://gematik.de/fhir/epa-medication/StructureDefinition/medication-packaging-size-extension"
....... value[x] S 1..1 string Package size according to divided quantity
Max Length:7
...... extension:totalQuantity 0..1 (Complex) Extension
URL: https://gematik.de/fhir/epa-medication/StructureDefinition/medication-total-quantity-formulation-extension
....... extension 0..0 Extension
Slice: Unordered, Open by value:url
....... url 1..1 uri "https://gematik.de/fhir/epa-medication/StructureDefinition/medication-total-quantity-formulation-extension"
....... value[x] S 1..1 string Total quantity of the formulation.
Max Length:7
..... value SΣ 0..1 decimal Numerical value (with implicit precision)
..... comparator ?!Σ 0..1 code < | <= | >= | > - how to understand the value
Binding: QuantityComparator (required): How the Quantity should be understood and represented.
..... unit SΣ 0..1 string Unit representation
..... system SΣC 0..1 uri System that defines coded unit form
..... code SΣ 0..1 code Coded form of the unit
.... denominator SΣC 0..1 Quantity Denominator value
Binding: UCUMCodes (preferred)
Constraints: qty-3
..... value SΣ 0..1 decimal Numerical value (with implicit precision)
..... comparator ?!Σ 0..1 code < | <= | >= | > - how to understand the value
Binding: QuantityComparator (required): How the Quantity should be understood and represented.
..... unit SΣ 0..1 string Unit representation
..... system SΣC 0..1 uri System that defines coded unit form
..... code SΣ 0..1 code Coded form of the unit
... ingredient S 0..* BackboneElement Active or inactive ingredients of the medication, including pharmaceutical substances as well as individual medicinal products in combination packs.
.... Slices for extension Content/Rules for all slices
..... extension:darreichungsform 0..1 string Extension
URL: https://gematik.de/fhir/epa-medication/StructureDefinition/medication-ingredient-darreichungsform-extension
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... Slices for item[x] S 1..1 CodeableConcept The actual ingredient or content
Slice: Unordered, Closed by type:$this
..... item[x]:itemCodeableConcept S 0..1 CodeableConcept Encoded description of the substance or component.
...... Slices for coding SΣ 0..* Coding Code defined by a terminology system
Slice: Unordered, Open by value:$this
....... coding:ask SΣ 0..* Coding Code defined by a terminology system

Required Pattern: At least the following
........ id 0..1 string Unique id for inter-element referencing
........ extension 0..* Extension Additional content defined by implementations
........ system 1..1 uri Identity of the terminology system
Fixed Value: http://fhir.de/CodeSystem/ask
........ version 0..1 string Version of the system - if relevant
........ code 0..1 code Symbol in syntax defined by the system
........ display 0..1 string Representation defined by the system
........ userSelected 0..1 boolean If this coding was chosen directly by the user
........ system SΣ 1..1 uri Identity of the terminology system
........ code SΣ 1..1 code Symbol in syntax defined by the system
........ display SΣ 0..1 string Representation defined by the system
....... coding:atc-de SΣ 0..* Coding Code defined by a terminology system

Required Pattern: At least the following
........ id 0..1 string Unique id for inter-element referencing
........ extension 0..* Extension Additional content defined by implementations
........ system 1..1 uri Identity of the terminology system
Fixed Value: http://fhir.de/CodeSystem/bfarm/atc
........ version 0..1 string Version of the system - if relevant
........ code 0..1 code Symbol in syntax defined by the system
........ display 0..1 string Representation defined by the system
........ userSelected 0..1 boolean If this coding was chosen directly by the user
........ system SΣ 1..1 uri Identity of the terminology system
........ version Σ 1..1 string Version of the system - if relevant
........ code SΣ 1..1 code Symbol in syntax defined by the system
........ display SΣ 0..1 string Representation defined by the system
....... coding:pzn SΣ 0..* Coding Code defined by a terminology system

Required Pattern: At least the following
........ id 0..1 string Unique id for inter-element referencing
........ extension 0..* Extension Additional content defined by implementations
........ system 1..1 uri Identity of the terminology system
Fixed Value: http://fhir.de/CodeSystem/ifa/pzn
........ version 0..1 string Version of the system - if relevant
........ code 0..1 code Symbol in syntax defined by the system
........ display 0..1 string Representation defined by the system
........ userSelected 0..1 boolean If this coding was chosen directly by the user
........ system SΣ 1..1 uri Identity of the terminology system
........ code SΣ 1..1 code Symbol in syntax defined by the system
........ display SΣ 0..1 string Representation defined by the system
...... text SΣ 0..1 string Plain text representation of the concept
.... isActive 0..1 boolean Is it an active ingredient?
.... strength SC 0..1 Ratio Strength
Constraints: rat-1
..... Slices for extension Content/Rules for all slices
...... extension:amountText 0..1 (Complex) Extension
URL: https://gematik.de/fhir/epa-medication/StructureDefinition/medication-ingredient-amount-extension
....... extension 0..0 Extension
Slice: Unordered, Open by value:url
....... url 1..1 uri "https://gematik.de/fhir/epa-medication/StructureDefinition/medication-ingredient-amount-extension"
....... value[x] S 1..1 string Free-text amount of an ingredient in a formulation.
Max Length:20
..... numerator SΣC 0..1 Quantity Numerator value
Binding: UCUMCodes (preferred)
Constraints: qty-3
...... value SΣ 1..1 decimal Numerical value (with implicit precision)
...... comparator ?!Σ 0..1 code < | <= | >= | > - how to understand the value
Binding: QuantityComparator (required): How the Quantity should be understood and represented.
...... unit SΣ 0..1 string Unit representation
...... system SΣC 0..1 uri System that defines coded unit form
...... code SΣ 0..1 code Coded form of the unit
..... denominator SΣC 0..1 Quantity Denominator value
Binding: UCUMCodes (preferred)
Constraints: qty-3
...... value SΣ 1..1 decimal Numerical value (with implicit precision)
...... comparator ?!Σ 0..1 code < | <= | >= | > - how to understand the value
Binding: QuantityComparator (required): How the Quantity should be understood and represented.
...... unit SΣ 0..1 string Unit representation
...... system SΣC 0..1 uri System that defines coded unit form
...... code SΣ 0..1 code Coded form of the unit
... batch 0..1 BackboneElement Batch Information
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... lotNumber 0..1 string Batch Number

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Medication.extension:drugCategory.​value[x] Base required TI Drug Category ValueSet 📦1.0.7 TI Terminology v1.0
Medication.extension:normSizeCode.​value[x] Base required https://fhir.kbv.de/ValueSet/KBV_VS_SFHIR_KBV_NORMGROESSE Not State Unknown
Medication.extension:type.​value[x] Base required TI Medication Type ValueSet for a Pharmaceutical Product 📦1.0.7 TI Terminology v1.0
Medication.code Base example SNOMED CT Medication Codes 📍4.0.1 FHIR Std.
Medication.status Base required Medication status codes 📍4.0.1 FHIR Std.
Medication.form Base example SNOMED CT Form Codes 📍4.0.1 FHIR Std.
Medication.form.coding:kbvDarreichungsform Base required https://fhir.kbv.de/ValueSet/KBV_VS_SFHIR_KBV_DARREICHUNGSFORM Not State Unknown
Medication.amount.numerator Base preferred UCUM Codes 📦4.0.1 FHIR Std.
Medication.amount.numerator.​comparator Base required QuantityComparator 📍4.0.1 FHIR Std.
Medication.amount.denominator Base preferred UCUM Codes 📦4.0.1 FHIR Std.
Medication.amount.denominator.​comparator Base required QuantityComparator 📍4.0.1 FHIR Std.
Medication.ingredient.​strength.numerator Base preferred UCUM Codes 📦4.0.1 FHIR Std.
Medication.ingredient.​strength.numerator.comparator Base required QuantityComparator 📍4.0.1 FHIR Std.
Medication.ingredient.​strength.denominator Base preferred UCUM Codes 📦4.0.1 FHIR Std.
Medication.ingredient.​strength.denominator.​comparator Base required QuantityComparator 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error Medication If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Medication If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error Medication If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error Medication If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Medication A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
epa-med-1 error Medication Medication code, name, or ingredients must be specified code.exists() or ingredient.exists()
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
qty-3 error Medication.amount.numerator, Medication.amount.denominator, Medication.ingredient.strength.numerator, Medication.ingredient.strength.denominator If a code for the unit is present, the system SHALL also be present code.empty() or system.exists()
rat-1 error Medication.amount, Medication.ingredient.strength Numerator and denominator SHALL both be present, or both are absent. If both are absent, there SHALL be some extension present (numerator.empty() xor denominator.exists()) and (numerator.exists() or extension.exists())
ref-1 error Medication.manufacturer SHALL have a contained resource if a local reference is provided reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))

Differential View

This structure is derived from Medication

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Medication C 0..* Medication Definition of a Medication
Constraints: epa-med-1
... meta S 0..1 Meta Metadata about the resource
.... versionId S 0..1 id Version specific identifier
.... lastUpdated S 0..1 instant When the resource version last changed
... contained 0..0 Contained, inline Resources
... Slices for extension Content/Rules for all slices
.... extension:rxPrescriptionProcessIdentifier 0..1 RxPrescriptionProcessIdentifier Extension
URL: https://gematik.de/fhir/epa-medication/StructureDefinition/rx-prescription-process-identifier-extension
.... extension:isVaccine 0..1 (Complex) Extension
URL: https://gematik.de/fhir/epa-medication/StructureDefinition/medication-id-vaccine-extension
..... value[x] S 1..1 boolean Vaccine Indicator
.... extension:drugCategory 0..1 (Complex) Extension
URL: https://gematik.de/fhir/epa-medication/StructureDefinition/drug-category-extension
..... value[x] S 1..1 Coding Value of extension
...... system S 1..1 uri Identity of the terminology system
...... code S 1..1 code Category
.... extension:normSizeCode 0..1 (Complex) Package size according to N-designation
URL: http://fhir.de/StructureDefinition/normgroesse
..... value[x] S 0..1 code Value of extension
.... extension:packaging 0..1 (Complex) Extension
URL: https://gematik.de/fhir/epa-medication/StructureDefinition/medication-formulation-packaging-extension
..... value[x] S 1..1 string Packaging of a formulation.
.... extension:manufacturingInstructions 0..1 (Complex) Extension
URL: https://gematik.de/fhir/epa-medication/StructureDefinition/medication-manufacturing-instructions-extension
..... value[x] S 1..1 string Manufacturing instructions for a formulation.
.... extension:type S 0..1 (Complex) Medication Type
URL: https://gematik.de/fhir/epa-medication/StructureDefinition/epa-medication-type-extension
..... value[x] 1..1 Coding Value of extension
Binding: TI Medication Type ValueSet for a Pharmaceutical Product (required)
.... identifier:EPAMedicationUniqueIdentifier 0..1 EPAMedicationUniqueIdentifier Business identifier for this medication
Required Pattern: At least the following
..... system 1..1 uri The namespace for the identifier value
Fixed Value: https://gematik.de/fhir/epa-medication/sid/epa-medication-unique-identifier
.... identifier:RxOriginatorProcessIdentifier 0..1 RxOriginatorProcessIdentifier Business identifier for this medication
Required Pattern: At least the following
..... system 1..1 uri The namespace for the identifier value
Fixed Value: https://gematik.de/fhir/epa-medication/sid/rx-originator-process-identifier
... code S 0..1 CodeableConcept Medication in coded form or as free text if necessary
.... Slices for coding S 0..* Coding Code defined by a terminology system
Slice: Unordered, Open by value:$this
..... coding:pzn S 0..0 Code defined by a terminology system
Required Pattern: At least the following
...... system 1..1 uri Identity of the terminology system
Fixed Value: http://fhir.de/CodeSystem/ifa/pzn
..... coding:atc-de S 0..* Coding Code defined by a terminology system

Required Pattern: At least the following
...... system 1..1 uri Identity of the terminology system
Fixed Value: http://fhir.de/CodeSystem/bfarm/atc
...... system S 1..1 uri Identity of the terminology system
...... version 1..1 string Version of the system - if relevant
...... code S 1..1 code Symbol in syntax defined by the system
...... display S 0..1 string Representation defined by the system
..... coding:ask S 0..* Coding Code defined by a terminology system

Required Pattern: At least the following
...... system 1..1 uri Identity of the terminology system
Fixed Value: http://fhir.de/CodeSystem/ask
...... system S 1..1 uri Identity of the terminology system
...... code S 1..1 code Symbol in syntax defined by the system
...... display S 0..1 string Representation defined by the system
.... text S 0..1 string Plain text representation of the concept
... status S 0..1 code Status of Medication Information
... manufacturer S 0..1 Reference(Organization) Manufacturer of the Medication
.... display S 1..1 string Text alternative for the resource
... form S 0..1 CodeableConcept Form of Dispensing
.... Slices for coding S 0..* Coding Code defined by a terminology system
Slice: Unordered, Open by value:$this
..... coding:kbvDarreichungsform S 0..* Coding Code defined by a terminology system
Binding: https://fhir.kbv.de/ValueSet/KBV_VS_SFHIR_KBV_DARREICHUNGSFORM (required)

Required Pattern: At least the following
...... system 1..1 uri Identity of the terminology system
Fixed Value: https://fhir.kbv.de/CodeSystem/KBV_CS_SFHIR_KBV_DARREICHUNGSFORM
...... system S 1..1 uri Identity of the terminology system
...... code S 1..1 code Symbol in syntax defined by the system
...... display S 0..1 string Representation defined by the system
... amount S 0..1 Ratio Amount of drug in package
.... numerator S 0..1 Quantity Numerator value
Binding: UCUMCodes (preferred)
..... Slices for extension Content/Rules for all slices
...... extension:packagingSize 0..1 (Complex) Extension
URL: https://gematik.de/fhir/epa-medication/StructureDefinition/medication-packaging-size-extension
....... value[x] S 1..1 string Package size according to divided quantity
...... extension:totalQuantity 0..1 (Complex) Extension
URL: https://gematik.de/fhir/epa-medication/StructureDefinition/medication-total-quantity-formulation-extension
....... value[x] S 1..1 string Total quantity of the formulation.
..... value S 0..1 decimal Numerical value (with implicit precision)
..... unit S 0..1 string Unit representation
..... system S 0..1 uri System that defines coded unit form
..... code S 0..1 code Coded form of the unit
.... denominator S 0..1 Quantity Denominator value
Binding: UCUMCodes (preferred)
..... value S 0..1 decimal Numerical value (with implicit precision)
..... unit S 0..1 string Unit representation
..... system S 0..1 uri System that defines coded unit form
..... code S 0..1 code Coded form of the unit
... ingredient S 0..* BackboneElement Active or inactive ingredients of the medication, including pharmaceutical substances as well as individual medicinal products in combination packs.
.... Slices for extension Content/Rules for all slices
..... extension:darreichungsform 0..1 string Extension
URL: https://gematik.de/fhir/epa-medication/StructureDefinition/medication-ingredient-darreichungsform-extension
.... Slices for item[x] S 1..1 CodeableConcept The actual ingredient or content
Slice: Unordered, Open by type:$this
..... item[x]:itemCodeableConcept S 0..1 CodeableConcept Encoded description of the substance or component.
...... Slices for coding S 0..* Coding Code defined by a terminology system
Slice: Unordered, Open by value:$this
....... coding:ask S 0..* Coding Code defined by a terminology system

Required Pattern: At least the following
........ system 1..1 uri Identity of the terminology system
Fixed Value: http://fhir.de/CodeSystem/ask
........ system S 1..1 uri Identity of the terminology system
........ code S 1..1 code Symbol in syntax defined by the system
........ display S 0..1 string Representation defined by the system
....... coding:atc-de S 0..* Coding Code defined by a terminology system

Required Pattern: At least the following
........ system 1..1 uri Identity of the terminology system
Fixed Value: http://fhir.de/CodeSystem/bfarm/atc
........ system S 1..1 uri Identity of the terminology system
........ version 1..1 string Version of the system - if relevant
........ code S 1..1 code Symbol in syntax defined by the system
........ display S 0..1 string Representation defined by the system
....... coding:pzn S 0..* Coding Code defined by a terminology system

Required Pattern: At least the following
........ system 1..1 uri Identity of the terminology system
Fixed Value: http://fhir.de/CodeSystem/ifa/pzn
........ system S 1..1 uri Identity of the terminology system
........ code S 1..1 code Symbol in syntax defined by the system
........ display S 0..1 string Representation defined by the system
...... text S 0..1 string Plain text representation of the concept
..... item[x]:itemReference S 0..0 Medication Pharmaceutical Product can't have child Medications
.... isActive 0..1 boolean Is it an active ingredient?
.... strength S 0..1 Ratio Strength
..... Slices for extension Content/Rules for all slices
...... extension:amountText 0..1 (Complex) Extension
URL: https://gematik.de/fhir/epa-medication/StructureDefinition/medication-ingredient-amount-extension
....... value[x] S 1..1 string Free-text amount of an ingredient in a formulation.
..... numerator S 0..1 Quantity Numerator value
Binding: UCUMCodes (preferred)
...... value S 1..1 decimal Numerical value (with implicit precision)
...... unit S 0..1 string Unit representation
...... system S 0..1 uri System that defines coded unit form
...... code S 0..1 code Coded form of the unit
..... denominator S 0..1 Quantity Denominator value
Binding: UCUMCodes (preferred)
...... value S 1..1 decimal Numerical value (with implicit precision)
...... unit S 0..1 string Unit representation
...... system S 0..1 uri System that defines coded unit form
...... code S 0..1 code Coded form of the unit
... batch 0..1 BackboneElement Batch Information
.... lotNumber 0..1 string Batch Number

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
Medication.extension:type.​value[x] Base required TI Medication Type ValueSet for a Pharmaceutical Product 📦1.0.7 TI Terminology v1.0
Medication.form.coding:kbvDarreichungsform Base required https://fhir.kbv.de/ValueSet/KBV_VS_SFHIR_KBV_DARREICHUNGSFORM Not State Unknown
Medication.amount.numerator Base preferred UCUM Codes 📦4.0.1 FHIR Std.
Medication.amount.denominator Base preferred UCUM Codes 📦4.0.1 FHIR Std.
Medication.ingredient.​strength.numerator Base preferred UCUM Codes 📦4.0.1 FHIR Std.
Medication.ingredient.​strength.denominator Base preferred UCUM Codes 📦4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
epa-med-1 error Medication Medication code, name, or ingredients must be specified code.exists() or ingredient.exists()

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Medication C 0..* Medication Definition of a Medication
Constraints: dom-2, dom-3, dom-4, dom-5, dom-6, epa-med-1
... id Σ 0..1 id Logical id of this artifact
... meta SΣ 0..1 Meta Metadata about the resource
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... versionId SΣ 0..1 id Version specific identifier
.... lastUpdated SΣ 0..1 instant When the resource version last changed
.... source Σ 0..1 uri Identifies where the resource comes from
.... profile Σ 0..* canonical(StructureDefinition) Profiles this resource claims to conform to
.... security Σ 0..* Coding Security Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
.... tag Σ 0..* Coding Tags applied to this resource
Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... extension:rxPrescriptionProcessIdentifier 0..1 RxPrescriptionProcessIdentifier Extension
URL: https://gematik.de/fhir/epa-medication/StructureDefinition/rx-prescription-process-identifier-extension
.... extension:isVaccine 0..1 (Complex) Extension
URL: https://gematik.de/fhir/epa-medication/StructureDefinition/medication-id-vaccine-extension
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..0 Extension
Slice: Unordered, Open by value:url
..... url 1..1 uri "https://gematik.de/fhir/epa-medication/StructureDefinition/medication-id-vaccine-extension"
..... value[x] S 1..1 boolean Vaccine Indicator
.... extension:drugCategory 0..1 (Complex) Extension
URL: https://gematik.de/fhir/epa-medication/StructureDefinition/drug-category-extension
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..0 Extension
Slice: Unordered, Open by value:url
..... url 1..1 uri "https://gematik.de/fhir/epa-medication/StructureDefinition/drug-category-extension"
..... value[x] S 1..1 Coding Value of extension
Binding: TI Drug Category ValueSet (required)
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... system SΣ 1..1 uri Identity of the terminology system
...... version Σ 0..1 string Version of the system - if relevant
...... code SΣ 1..1 code Category
...... display Σ 0..1 string Representation defined by the system
...... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
.... extension:normSizeCode 0..1 (Complex) Package size according to N-designation
URL: http://fhir.de/StructureDefinition/normgroesse
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..0 Additional content defined by implementations
Slice: Unordered, Open by value:url
..... url 1..1 uri "http://fhir.de/StructureDefinition/normgroesse"
..... value[x] S 0..1 code Value of extension
Binding: https://fhir.kbv.de/ValueSet/KBV_VS_SFHIR_KBV_NORMGROESSE (required)
.... extension:packaging 0..1 (Complex) Extension
URL: https://gematik.de/fhir/epa-medication/StructureDefinition/medication-formulation-packaging-extension
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..0 Extension
Slice: Unordered, Open by value:url
..... url 1..1 uri "https://gematik.de/fhir/epa-medication/StructureDefinition/medication-formulation-packaging-extension"
..... value[x] S 1..1 string Packaging of a formulation.
Max Length:90
.... extension:manufacturingInstructions 0..1 (Complex) Extension
URL: https://gematik.de/fhir/epa-medication/StructureDefinition/medication-manufacturing-instructions-extension
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..0 Extension
Slice: Unordered, Open by value:url
..... url 1..1 uri "https://gematik.de/fhir/epa-medication/StructureDefinition/medication-manufacturing-instructions-extension"
..... value[x] S 1..1 string Manufacturing instructions for a formulation.
Max Length:500
.... extension:type S 0..1 (Complex) Medication Type
URL: https://gematik.de/fhir/epa-medication/StructureDefinition/epa-medication-type-extension
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..0 Extension
Slice: Unordered, Open by value:url
..... url 1..1 uri "https://gematik.de/fhir/epa-medication/StructureDefinition/epa-medication-type-extension"
..... value[x] S 1..1 Coding Value of extension
Binding: TI Medication Type ValueSet for a Pharmaceutical Product (required)
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
Slice: Unordered, Open by value:url
... Slices for identifier Σ 0..* Identifier Business identifier for this medication
Slice: Unordered, Open by value:$this
.... identifier:EPAMedicationUniqueIdentifier Σ 0..1 EPAMedicationUniqueIdentifier Business identifier for this medication

Required Pattern: At least the following
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... use 0..1 code usual | official | temp | secondary | old (If known)
..... type 0..1 CodeableConcept Description of identifier
..... system 1..1 uri The namespace for the identifier value
Fixed Value: https://gematik.de/fhir/epa-medication/sid/epa-medication-unique-identifier
..... value 0..1 string The value that is unique
..... period 0..1 Period Time period when id is/was valid for use
..... assigner 0..1 Reference(Organization) Organization that issued id (may be just text)
.... identifier:RxOriginatorProcessIdentifier Σ 0..1 RxOriginatorProcessIdentifier Business identifier for this medication

Required Pattern: At least the following
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... use 0..1 code usual | official | temp | secondary | old (If known)
..... type 0..1 CodeableConcept Description of identifier
..... system 1..1 uri The namespace for the identifier value
Fixed Value: https://gematik.de/fhir/epa-medication/sid/rx-originator-process-identifier
..... value 0..1 string The value that is unique
..... period 0..1 Period Time period when id is/was valid for use
..... assigner 0..1 Reference(Organization) Organization that issued id (may be just text)
... code SΣ 0..1 CodeableConcept Medication in coded form or as free text if necessary
Binding: SNOMEDCTMedicationCodes (example): A coded concept that defines the type of a medication.
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... Slices for coding SΣ 0..* Coding Code defined by a terminology system
Slice: Unordered, Open by value:$this
..... coding:atc-de SΣ 0..* Coding Code defined by a terminology system

Required Pattern: At least the following
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... system 1..1 uri Identity of the terminology system
Fixed Value: http://fhir.de/CodeSystem/bfarm/atc
...... version 0..1 string Version of the system - if relevant
...... code 0..1 code Symbol in syntax defined by the system
...... display 0..1 string Representation defined by the system
...... userSelected 0..1 boolean If this coding was chosen directly by the user
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... system SΣ 1..1 uri Identity of the terminology system
...... version Σ 1..1 string Version of the system - if relevant
...... code SΣ 1..1 code Symbol in syntax defined by the system
...... display SΣ 0..1 string Representation defined by the system
...... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
..... coding:ask SΣ 0..* Coding Code defined by a terminology system

Required Pattern: At least the following
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... system 1..1 uri Identity of the terminology system
Fixed Value: http://fhir.de/CodeSystem/ask
...... version 0..1 string Version of the system - if relevant
...... code 0..1 code Symbol in syntax defined by the system
...... display 0..1 string Representation defined by the system
...... userSelected 0..1 boolean If this coding was chosen directly by the user
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... system SΣ 1..1 uri Identity of the terminology system
...... version Σ 0..1 string Version of the system - if relevant
...... code SΣ 1..1 code Symbol in syntax defined by the system
...... display SΣ 0..1 string Representation defined by the system
...... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
.... text SΣ 0..1 string Plain text representation of the concept
... status ?!SΣ 0..1 code Status of Medication Information
Binding: Medication Status Codes (required): A coded concept defining if the medication is in active use.
... manufacturer SΣC 0..1 Reference(Organization) Manufacturer of the Medication
Constraints: ref-1
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
.... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
.... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
.... display SΣ 1..1 string Text alternative for the resource
... form S 0..1 CodeableConcept Form of Dispensing
Binding: SNOMEDCTFormCodes (example): A coded concept defining the form of a medication.
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... Slices for coding SΣ 0..* Coding Code defined by a terminology system
Slice: Unordered, Open by value:$this
..... coding:kbvDarreichungsform SΣ 0..* Coding Code defined by a terminology system
Binding: https://fhir.kbv.de/ValueSet/KBV_VS_SFHIR_KBV_DARREICHUNGSFORM (required)

Required Pattern: At least the following
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... system 1..1 uri Identity of the terminology system
Fixed Value: https://fhir.kbv.de/CodeSystem/KBV_CS_SFHIR_KBV_DARREICHUNGSFORM
...... version 0..1 string Version of the system - if relevant
...... code 0..1 code Symbol in syntax defined by the system
...... display 0..1 string Representation defined by the system
...... userSelected 0..1 boolean If this coding was chosen directly by the user
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... system SΣ 1..1 uri Identity of the terminology system
...... version Σ 0..1 string Version of the system - if relevant
...... code SΣ 1..1 code Symbol in syntax defined by the system
...... display SΣ 0..1 string Representation defined by the system
...... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
.... text Σ 0..1 string Plain text representation of the concept
... amount SΣC 0..1 Ratio Amount of drug in package
Constraints: rat-1
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... numerator SΣC 0..1 Quantity Numerator value
Binding: UCUMCodes (preferred)
Constraints: qty-3
..... id 0..1 string Unique id for inter-element referencing
..... Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... extension:packagingSize 0..1 (Complex) Extension
URL: https://gematik.de/fhir/epa-medication/StructureDefinition/medication-packaging-size-extension
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..0 Extension
Slice: Unordered, Open by value:url
....... url 1..1 uri "https://gematik.de/fhir/epa-medication/StructureDefinition/medication-packaging-size-extension"
....... value[x] S 1..1 string Package size according to divided quantity
Max Length:7
...... extension:totalQuantity 0..1 (Complex) Extension
URL: https://gematik.de/fhir/epa-medication/StructureDefinition/medication-total-quantity-formulation-extension
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..0 Extension
Slice: Unordered, Open by value:url
....... url 1..1 uri "https://gematik.de/fhir/epa-medication/StructureDefinition/medication-total-quantity-formulation-extension"
....... value[x] S 1..1 string Total quantity of the formulation.
Max Length:7
..... value SΣ 0..1 decimal Numerical value (with implicit precision)
..... comparator ?!Σ 0..1 code < | <= | >= | > - how to understand the value
Binding: QuantityComparator (required): How the Quantity should be understood and represented.
..... unit SΣ 0..1 string Unit representation
..... system SΣC 0..1 uri System that defines coded unit form
..... code SΣ 0..1 code Coded form of the unit
.... denominator SΣC 0..1 Quantity Denominator value
Binding: UCUMCodes (preferred)
Constraints: qty-3
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... value SΣ 0..1 decimal Numerical value (with implicit precision)
..... comparator ?!Σ 0..1 code < | <= | >= | > - how to understand the value
Binding: QuantityComparator (required): How the Quantity should be understood and represented.
..... unit SΣ 0..1 string Unit representation
..... system SΣC 0..1 uri System that defines coded unit form
..... code SΣ 0..1 code Coded form of the unit
... ingredient S 0..* BackboneElement Active or inactive ingredients of the medication, including pharmaceutical substances as well as individual medicinal products in combination packs.
.... id 0..1 string Unique id for inter-element referencing
.... Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... extension:darreichungsform 0..1 string Extension
URL: https://gematik.de/fhir/epa-medication/StructureDefinition/medication-ingredient-darreichungsform-extension
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... Slices for item[x] S 1..1 CodeableConcept The actual ingredient or content
Slice: Unordered, Closed by type:$this
..... item[x]:itemCodeableConcept S 0..1 CodeableConcept Encoded description of the substance or component.
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... Slices for coding SΣ 0..* Coding Code defined by a terminology system
Slice: Unordered, Open by value:$this
....... coding:ask SΣ 0..* Coding Code defined by a terminology system

Required Pattern: At least the following
........ id 0..1 string Unique id for inter-element referencing
........ extension 0..* Extension Additional content defined by implementations
........ system 1..1 uri Identity of the terminology system
Fixed Value: http://fhir.de/CodeSystem/ask
........ version 0..1 string Version of the system - if relevant
........ code 0..1 code Symbol in syntax defined by the system
........ display 0..1 string Representation defined by the system
........ userSelected 0..1 boolean If this coding was chosen directly by the user
........ id 0..1 string Unique id for inter-element referencing
........ extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
........ system SΣ 1..1 uri Identity of the terminology system
........ version Σ 0..1 string Version of the system - if relevant
........ code SΣ 1..1 code Symbol in syntax defined by the system
........ display SΣ 0..1 string Representation defined by the system
........ userSelected Σ 0..1 boolean If this coding was chosen directly by the user
....... coding:atc-de SΣ 0..* Coding Code defined by a terminology system

Required Pattern: At least the following
........ id 0..1 string Unique id for inter-element referencing
........ extension 0..* Extension Additional content defined by implementations
........ system 1..1 uri Identity of the terminology system
Fixed Value: http://fhir.de/CodeSystem/bfarm/atc
........ version 0..1 string Version of the system - if relevant
........ code 0..1 code Symbol in syntax defined by the system
........ display 0..1 string Representation defined by the system
........ userSelected 0..1 boolean If this coding was chosen directly by the user
........ id 0..1 string Unique id for inter-element referencing
........ extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
........ system SΣ 1..1 uri Identity of the terminology system
........ version Σ 1..1 string Version of the system - if relevant
........ code SΣ 1..1 code Symbol in syntax defined by the system
........ display SΣ 0..1 string Representation defined by the system
........ userSelected Σ 0..1 boolean If this coding was chosen directly by the user
....... coding:pzn SΣ 0..* Coding Code defined by a terminology system

Required Pattern: At least the following
........ id 0..1 string Unique id for inter-element referencing
........ extension 0..* Extension Additional content defined by implementations
........ system 1..1 uri Identity of the terminology system
Fixed Value: http://fhir.de/CodeSystem/ifa/pzn
........ version 0..1 string Version of the system - if relevant
........ code 0..1 code Symbol in syntax defined by the system
........ display 0..1 string Representation defined by the system
........ userSelected 0..1 boolean If this coding was chosen directly by the user
........ id 0..1 string Unique id for inter-element referencing
........ extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
........ system SΣ 1..1 uri Identity of the terminology system
........ version Σ 0..1 string Version of the system - if relevant
........ code SΣ 1..1 code Symbol in syntax defined by the system
........ display SΣ 0..1 string Representation defined by the system
........ userSelected Σ 0..1 boolean If this coding was chosen directly by the user
...... text SΣ 0..1 string Plain text representation of the concept
.... isActive 0..1 boolean Is it an active ingredient?
.... strength SC 0..1 Ratio Strength
Constraints: rat-1
..... id 0..1 string Unique id for inter-element referencing
..... Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... extension:amountText 0..1 (Complex) Extension
URL: https://gematik.de/fhir/epa-medication/StructureDefinition/medication-ingredient-amount-extension
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..0 Extension
Slice: Unordered, Open by value:url
....... url 1..1 uri "https://gematik.de/fhir/epa-medication/StructureDefinition/medication-ingredient-amount-extension"
....... value[x] S 1..1 string Free-text amount of an ingredient in a formulation.
Max Length:20
..... numerator SΣC 0..1 Quantity Numerator value
Binding: UCUMCodes (preferred)
Constraints: qty-3
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... value SΣ 1..1 decimal Numerical value (with implicit precision)
...... comparator ?!Σ 0..1 code < | <= | >= | > - how to understand the value
Binding: QuantityComparator (required): How the Quantity should be understood and represented.
...... unit SΣ 0..1 string Unit representation
...... system SΣC 0..1 uri System that defines coded unit form
...... code SΣ 0..1 code Coded form of the unit
..... denominator SΣC 0..1 Quantity Denominator value
Binding: UCUMCodes (preferred)
Constraints: qty-3
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... value SΣ 1..1 decimal Numerical value (with implicit precision)
...... comparator ?!Σ 0..1 code < | <= | >= | > - how to understand the value
Binding: QuantityComparator (required): How the Quantity should be understood and represented.
...... unit SΣ 0..1 string Unit representation
...... system SΣC 0..1 uri System that defines coded unit form
...... code SΣ 0..1 code Coded form of the unit
... batch 0..1 BackboneElement Batch Information
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... lotNumber 0..1 string Batch Number
.... expirationDate 0..1 dateTime When batch will expire

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Medication.meta.security Base extensible SecurityLabels 📍4.0.1 FHIR Std.
Medication.meta.tag Base example Common Tags 📍4.0.1 FHIR Std.
Medication.language Base preferred Common Languages 📍4.0.1 FHIR Std.
Medication.extension:drugCategory.​value[x] Base required TI Drug Category ValueSet 📦1.0.7 TI Terminology v1.0
Medication.extension:normSizeCode.​value[x] Base required https://fhir.kbv.de/ValueSet/KBV_VS_SFHIR_KBV_NORMGROESSE Not State Unknown
Medication.extension:type.​value[x] Base required TI Medication Type ValueSet for a Pharmaceutical Product 📦1.0.7 TI Terminology v1.0
Medication.code Base example SNOMED CT Medication Codes 📍4.0.1 FHIR Std.
Medication.status Base required Medication status codes 📍4.0.1 FHIR Std.
Medication.manufacturer.​type Base extensible ResourceType 📍4.0.1 FHIR Std.
Medication.form Base example SNOMED CT Form Codes 📍4.0.1 FHIR Std.
Medication.form.coding:kbvDarreichungsform Base required https://fhir.kbv.de/ValueSet/KBV_VS_SFHIR_KBV_DARREICHUNGSFORM Not State Unknown
Medication.amount.numerator Base preferred UCUM Codes 📦4.0.1 FHIR Std.
Medication.amount.numerator.​comparator Base required QuantityComparator 📍4.0.1 FHIR Std.
Medication.amount.denominator Base preferred UCUM Codes 📦4.0.1 FHIR Std.
Medication.amount.denominator.​comparator Base required QuantityComparator 📍4.0.1 FHIR Std.
Medication.ingredient.​strength.numerator Base preferred UCUM Codes 📦4.0.1 FHIR Std.
Medication.ingredient.​strength.numerator.comparator Base required QuantityComparator 📍4.0.1 FHIR Std.
Medication.ingredient.​strength.denominator Base preferred UCUM Codes 📦4.0.1 FHIR Std.
Medication.ingredient.​strength.denominator.​comparator Base required QuantityComparator 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error Medication If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Medication If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error Medication If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error Medication If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Medication A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
epa-med-1 error Medication Medication code, name, or ingredients must be specified code.exists() or ingredient.exists()
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
qty-3 error Medication.amount.numerator, Medication.amount.denominator, Medication.ingredient.strength.numerator, Medication.ingredient.strength.denominator If a code for the unit is present, the system SHALL also be present code.empty() or system.exists()
rat-1 error Medication.amount, Medication.ingredient.strength Numerator and denominator SHALL both be present, or both are absent. If both are absent, there SHALL be some extension present (numerator.empty() xor denominator.exists()) and (numerator.exists() or extension.exists())
ref-1 error Medication.manufacturer SHALL have a contained resource if a local reference is provided reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))

This structure is derived from Medication

Summary

Mandatory: 0 element(21 nested mandatory elements)
Must-Support: 78 elements
Prohibited: 3 elements

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of Medication.identifier
  • The element 1 is sliced based on the value of Medication.code.coding
  • The element 1 is sliced based on the value of Medication.form.coding
  • The element 1 is sliced based on the value of Medication.ingredient.item[x]
  • The element 1 is sliced based on the value of Medication.ingredient.item[x].coding

 

Other representations of profile: CSV, Excel, Schematron