Implementation Guide
ePA Medication Service
Version 1.0.5-1 - release

## Resource Profile: EPAMedicationPZNIngredient - Detailed Descriptions

Active as of 2025-02-28

Definitions for the epa-medication-pzn-ingredient resource profile.

- Key Elements Table
- Differential Elements Table
- Snapshot Elements Table

Guidance on how to interpret the contents of this table can be found here

0. Medication
Definition | This resource is primarily used for the identification and definition of a medication for the purposes of prescribing, dispensing, and administering a medication as well as for making statements about medication use.
Short | Definition of a Medication
Control | 0..*
Invariants | dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty()) dom-4: 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-3: 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-6: A resource should have narrative for robust management (text.`div`.exists()) dom-5: If a resource is contained in another resource, it SHALL NOT have a security label (contained.meta.security.empty()) epa-med-1: Medication code, name, or ingredients must be specified (`code.exists() or ingredient.exists()`)
2. Medication.meta
Definition | The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
Short | Metadata about the resource
Control | 0..1 This element is affected by the following invariants: ele-1
Type | Meta
Must Support | true
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
4. Medication.meta.versionId
Definition | The version specific identifier, as it appears in the version portion of the URL. This value changes when the resource is created, updated, or deleted.
Short | Version specific identifier
Comments | The server assigns this value, and ignores what the client specifies, except in the case that the server is imposing version integrity on updates/deletes.
Control | 0..1 This element is affected by the following invariants: ele-1
Type | id
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
6. Medication.meta.lastUpdated
Definition | When the resource last changed - e.g. when the version changed.
Short | When the resource version last changed
Comments | This value is always populated except when the resource is first being created. The server / resource manager sets this value; what a client provides is irrelevant. This is equivalent to the HTTP Last-Modified and SHOULD have the same value on a read interaction.
Control | 0..1 This element is affected by the following invariants: ele-1
Type | instant
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
8. Medication.implicitRules
Definition | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
Short | A set of rules under which this content was created
Comments | Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.
Control | 0..1 This element is affected by the following invariants: ele-1
Type | uri
Is Modifier | true because This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
10. Medication.contained
Definition | These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
Short | Contained, inline Resources
Comments | This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.
Control | 0..0*
Type | Resource
Alternate Names | inline resources, anonymous resources, contained resources
12. Medication.extension:rxPrescriptionProcessIdentifier
Slice Name | rxPrescriptionProcessIdentifier
Definition | This extension is used to track medication prescription transactions between the E-Rezept-Fachdienst and the ePA. The RxPrescriptionProcessIdentifier is generated by the ePA Medication Service and consists of the PrescriptionId and the authoredOn date of the operation parameters request. It ensures consistent referencing and management of medication-related resources across different systems.
Short | Extension
Control | 0..1 This element is affected by the following invariants: ele-1
Type | Extension(RxPrescriptionProcessIdentifierExtension) (Extension Type: Identifier(RxPrescriptionProcessIdentifier))
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
14. Medication.extension:isVaccine
Slice Name | isVaccine
Definition | Indicator of whether this is a vaccine.
Short | Extension
Control | 0..1 This element is affected by the following invariants: ele-1
Type | Extension(MedicationIsVaccineExtension) (Extension Type: boolean)
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
16. Medication.extension:isVaccine.extension
Definition | An Extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Short | ExtensionAdditional content defined by implementations
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..0* This element is affected by the following invariants: ele-1
Type | Extension
Alternate Names | extensions, user content
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
Slicing | This element introduces a set of slices on `Medication.extension.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
18. Medication.extension:isVaccine.url
Definition | Source of the definition for the extension code - a logical name or a URL.
Short | identifies the meaning of the extension
Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.
Control | 1..1
Type | uri
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | `https://gematik.de/fhir/epa-medication/StructureDefinition/medication-is-vaccine-extension`
20. Medication.extension:isVaccine.value[x]
Definition | Indicator of whether this is a vaccine.. false - no vaccine (default value) true - vaccine Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).
Short | Vaccine IndicatorValue of extension
Control | 10..1 This element is affected by the following invariants: ele-1
Type | boolean, date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, Coding, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, CodeableConcept, ParameterDefinition, dateTime, code, string, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, Expression, Signature, unsignedInt, time
[x] Note | SeeChoice of Data Typesfor further information about how to use [x]
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
22. Medication.extension:drugCategory
Slice Name | drugCategory
Definition | Extension for indicating the medication category.
Short | Extension
Control | 0..1 This element is affected by the following invariants: ele-1
Type | Extension(DrugCategoryExtension) (Extension Type: Coding)
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
24. Medication.extension:drugCategory.extension
Definition | An Extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Short | ExtensionAdditional content defined by implementations
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..0* This element is affected by the following invariants: ele-1
Type | Extension
Alternate Names | extensions, user content
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
Slicing | This element introduces a set of slices on `Medication.extension.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
26. Medication.extension:drugCategory.url
Definition | Source of the definition for the extension code - a logical name or a URL.
Short | identifies the meaning of the extension
Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.
Control | 1..1
Type | uri
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | `https://gematik.de/fhir/epa-medication/StructureDefinition/drug-category-extension`
28. Medication.extension:drugCategory.value[x]
Definition | Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).
Short | Value of extension
Control | 10..1 This element is affected by the following invariants: ele-1
Binding | The codes SHALL be taken from For codes, see TI Drug Category ValueSet (required to `https://gematik.de/fhir/terminology/ValueSet/ti-drug-category-vs` )
Type | Coding, date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, CodeableConcept, ParameterDefinition, dateTime, code, string, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, Signature, unsignedInt, time
[x] Note | SeeChoice of Data Typesfor further information about how to use [x]
Must Support | true
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
30. Medication.extension:drugCategory.value[x].system
Definition | The identification of the code system that defines the meaning of the symbol in the code.
Short | Identity of the terminology system
Comments | The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.
Control | 10..1 This element is affected by the following invariants: ele-1
Type | uri
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Summary | true
Requirements | Need to be unambiguous about the source of the definition of the symbol.
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
32. Medication.extension:drugCategory.value[x].code
Definition | Drug Category A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).
Short | CategorySymbol in syntax defined by the system
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size
Control | 10..1 This element is affected by the following invariants: ele-1
Type | code
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Summary | true
Requirements | Need to refer to a particular code in the system.
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
34. Medication.extension:normSizeCode
Slice Name | normSizeCode
Definition | Description of the therapy-appropriate package size (e.g., N1)
Short | Package size according to N-designation
Control | 0..1 This element is affected by the following invariants: ele-1
Type | Extension(ExtensionNormgroesseDeBasis) (Extension Type: code)
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
36. Medication.extension:normSizeCode.extension
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Short | Additional content defined by implementations
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..0* This element is affected by the following invariants: ele-1
Type | Extension
Standard Status | Normative (from Trial Use)
Alternate Names | extensions, user content
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
Slicing | This element introduces a set of slices on `Medication.extension.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
38. Medication.extension:normSizeCode.url
Definition | Source of the definition for the extension code - a logical name or a URL.
Short | identifies the meaning of the extension
Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.
Control | 1..1
Type | uri
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | `http://fhir.de/StructureDefinition/normgroesse`
40. Medication.extension:normSizeCode.value[x]
Definition | Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).
Short | Value of extension
Control | 0..1 This element is affected by the following invariants: ele-1
Binding | The codes SHALL be taken from For codes, see https://fhir.kbv.de/ValueSet/KBV_VS_SFHIR_KBV_NORMGROESSE (required to `https://fhir.kbv.de/ValueSet/KBV_VS_SFHIR_KBV_NORMGROESSE` )
Type | code, date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, Coding, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, CodeableConcept, ParameterDefinition, dateTime, string, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, Signature, unsignedInt, time
[x] Note | SeeChoice of Data Typesfor further information about how to use [x]
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
42. Medication.extension:packaging
Slice Name | packaging
Definition | Information on the packaging of a formulation.
Short | Extension
Control | 0..1 This element is affected by the following invariants: ele-1
Type | Extension(MedicationFormulationPackagingExtension) (Extension Type: string)
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
44. Medication.extension:packaging.extension
Definition | An Extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Short | ExtensionAdditional content defined by implementations
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..0* This element is affected by the following invariants: ele-1
Type | Extension
Alternate Names | extensions, user content
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
Slicing | This element introduces a set of slices on `Medication.extension.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
46. Medication.extension:packaging.url
Definition | Source of the definition for the extension code - a logical name or a URL.
Short | identifies the meaning of the extension
Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.
Control | 1..1
Type | uri
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | `https://gematik.de/fhir/epa-medication/StructureDefinition/medication-formulation-packaging-extension`
48. Medication.extension:packaging.value[x]
Definition | Information on transport containers or packaging for a formulation. Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).
Short | Packaging of a formulation.Value of extension
Control | 10..1 This element is affected by the following invariants: ele-1
Type | string, date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, Coding, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, CodeableConcept, ParameterDefinition, dateTime, code, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, Signature, unsignedInt, time
[x] Note | SeeChoice of Data Typesfor further information about how to use [x]
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Max Length: | 90
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
50. Medication.extension:manufacturingInstructions
Slice Name | manufacturingInstructions
Definition | Manufacturing instructions regarding the preparation of a formulation (Subscriptio).
Short | Extension
Control | 0..1 This element is affected by the following invariants: ele-1
Type | Extension(MedicationManufacturingInstructionsExtension) (Extension Type: string)
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
52. Medication.extension:manufacturingInstructions.extension
Definition | An Extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Short | ExtensionAdditional content defined by implementations
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..0* This element is affected by the following invariants: ele-1
Type | Extension
Alternate Names | extensions, user content
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
Slicing | This element introduces a set of slices on `Medication.extension.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
54. Medication.extension:manufacturingInstructions.url
Definition | Source of the definition for the extension code - a logical name or a URL.
Short | identifies the meaning of the extension
Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.
Control | 1..1
Type | uri
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | `https://gematik.de/fhir/epa-medication/StructureDefinition/medication-manufacturing-instructions-extension`
56. Medication.extension:manufacturingInstructions.value[x]
Definition | Manufacturing instructions regarding the preparation of a formulation (Subscriptio). Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).
Short | Manufacturing instructions for a formulation.Value of extension
Control | 10..1 This element is affected by the following invariants: ele-1
Type | string, date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, Coding, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, CodeableConcept, ParameterDefinition, dateTime, code, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, Signature, unsignedInt, time
[x] Note | SeeChoice of Data Typesfor further information about how to use [x]
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Max Length: | 500
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
58. Medication.extension:type
Slice Name | type
Definition | Extension for EPAMedication types
Short | Medication Type
Control | 0..1 This element is affected by the following invariants: ele-1
Type | Extension(Medication Type) (Extension Type: Coding)
Must Support | true
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
60. Medication.extension:type.extension
Definition | An Extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Short | ExtensionAdditional content defined by implementations
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..0* This element is affected by the following invariants: ele-1
Type | Extension
Alternate Names | extensions, user content
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
Slicing | This element introduces a set of slices on `Medication.extension.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
62. Medication.extension:type.url
Definition | Source of the definition for the extension code - a logical name or a URL.
Short | identifies the meaning of the extension
Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.
Control | 1..1
Type | uri
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | `https://gematik.de/fhir/epa-medication/StructureDefinition/epa-medication-type-extension`
64. Medication.extension:type.value[x]
Definition | Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).
Short | Value of extension
Control | 10..1 This element is affected by the following invariants: ele-1
Binding | The codes SHALL be taken from For codes, see TI Medication Type ValueSet for PZN-Medication (required to `https://gematik.de/fhir/terminology/ValueSet/ti-medication-type-product-vs` )
Type | Coding, date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, CodeableConcept, ParameterDefinition, dateTime, code, string, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, Signature, unsignedInt, time
[x] Note | SeeChoice of Data Typesfor further information about how to use [x]
Must Support | true
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
66. Medication.modifierExtension
Definition | May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Short | Extensions that cannot be ignored
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..* This element is affected by the following invariants: ele-1
Type | Extension
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them
Standard Status | Normative (from Trial Use)
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.
Alternate Names | extensions, user content
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
Slicing | This element introduces a set of slices on `Medication.modifierExtension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
68. Medication.identifier
Definition | Business identifier for this medication.
Short | Business identifier for this medication
Comments | The serial number could be included as an identifier.
Note | This is a business identifier, not a resource identifier (see discussion)
Control | 0..* This element is affected by the following invariants: ele-1
Type | Identifier
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
Slicing | This element introduces a set of slices on `Medication.identifier`. The slices areUnordered and Open, and can be differentiated using the following discriminators: pattern @ $this
70. Medication.identifier:EPAMedicationUniqueIdentifier
Slice Name | EPAMedicationUniqueIdentifier
Definition | Business identifier for this medication.
Short | Business identifier for this medication
Comments | The serial number could be included as an identifier.
Note | This is a business identifier, not a resource identifier (see discussion)
Control | 0..1* This element is affected by the following invariants: ele-1
Type | Identifier(Medication Unique Identifier)
Summary | true
Pattern Value | `{ "system" : "https://gematik.de/fhir/epa-medication/sid/epa-medication-unique-identifier" }`
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
72. Medication.identifier:RxOriginatorProcessIdentifier
Slice Name | RxOriginatorProcessIdentifier
Definition | Business identifier for this medication.
Short | Business identifier for this medication
Comments | The serial number could be included as an identifier.
Note | This is a business identifier, not a resource identifier (see discussion)
Control | 0..1* This element is affected by the following invariants: ele-1
Type | Identifier(RxOriginatorProcessIdentifier)
Summary | true
Pattern Value | `{ "system" : "https://gematik.de/fhir/epa-medication/sid/rx-originator-process-identifier" }`
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
74. Medication.code
Definition | A code (or set of codes) that specify this medication, or a textual description if no code is available. Usage note: This could be a standard medication code such as a code from RxNorm, SNOMED CT, IDMP etc. It could also be a national or local formulary code, optionally with translations to other code systems.
Short | Medication in coded form or as free text if necessaryCodes that identify this medication
Comments | Depending on the context of use, the code that was actually selected by the user (prescriber, dispenser, etc.) will have the coding.userSelected set to true. As described in the coding datatype: "A coding may be marked as a "userSelected" if a user selected the particular coded value in a user interface (e.g. the user selects an item in a pick-list). If a user selected coding exists, it is the preferred choice for performing translations etc. Other codes can only be literal translations to alternative code systems, or codes at a lower level of granularity (e.g. a generic code for a vendor-specific primary one).
Control | 0..1 This element is affected by the following invariants: ele-1
Binding | For example codes, see SNOMEDCTMedicationCodes http://hl7.org/fhir/ValueSet/medication-codes (example to `http://hl7.org/fhir/ValueSet/medication-codes` ) A coded concept that defines the type of a medication.
Type | CodeableConcept
Must Support | true
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
76. Medication.code.coding
Definition | A reference to a code defined by a terminology system.
Short | Code defined by a terminology system
Comments | Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.
Control | 10..* This element is affected by the following invariants: ele-1
Type | Coding
Must Support | true
Summary | true
Requirements | Allows for alternative encodings within a code system, and translations to other code systems.
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
Slicing | This element introduces a set of slices on `Medication.code.coding`. The slices areUnordered and Open, and can be differentiated using the following discriminators: pattern @ $this
78. Medication.code.coding:pzn
Slice Name | pzn
Definition | A reference to a code defined by a terminology system.
Short | Code defined by a terminology system
Comments | Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.
Control | 10..1* This element is affected by the following invariants: ele-1
Type | Coding
Must Support | true
Summary | true
Requirements | Allows for alternative encodings within a code system, and translations to other code systems.
Pattern Value | `{ "system" : "http://fhir.de/CodeSystem/ifa/pzn" }`
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
80. Medication.code.coding:pzn.system
Definition | The identification of the code system that defines the meaning of the symbol in the code.
Short | Identity of the terminology system
Comments | The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.
Control | 10..1 This element is affected by the following invariants: ele-1
Type | uri
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Summary | true
Requirements | Need to be unambiguous about the source of the definition of the symbol.
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
82. Medication.code.coding:pzn.code
Definition | A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).
Short | Symbol in syntax defined by the system
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size
Control | 10..1 This element is affected by the following invariants: ele-1
Type | code
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Summary | true
Requirements | Need to refer to a particular code in the system.
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
84. Medication.code.coding:pzn.display
Definition | A representation of the meaning of the code in the system, following the rules of the system.
Short | Representation defined by the system
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size
Control | 0..1 This element is affected by the following invariants: ele-1
Type | string
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Summary | true
Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system.
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
86. Medication.code.coding:atc-de
Slice Name | atc-de
Definition | A reference to a code defined by a terminology system.
Short | Code defined by a terminology system
Comments | Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.
Control | 0..* This element is affected by the following invariants: ele-1
Type | Coding
Must Support | true
Summary | true
Requirements | Allows for alternative encodings within a code system, and translations to other code systems.
Pattern Value | `{ "system" : "http://fhir.de/CodeSystem/bfarm/atc" }`
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
88. Medication.code.coding:atc-de.system
Definition | The identification of the code system that defines the meaning of the symbol in the code.
Short | Identity of the terminology system
Comments | The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.
Control | 10..1 This element is affected by the following invariants: ele-1
Type | uri
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Summary | true
Requirements | Need to be unambiguous about the source of the definition of the symbol.
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
90. Medication.code.coding:atc-de.code
Definition | A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).
Short | Symbol in syntax defined by the system
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size
Control | 10..1 This element is affected by the following invariants: ele-1
Type | code
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Summary | true
Requirements | Need to refer to a particular code in the system.
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
92. Medication.code.coding:atc-de.display
Definition | A representation of the meaning of the code in the system, following the rules of the system.
Short | Representation defined by the system
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size
Control | 0..1 This element is affected by the following invariants: ele-1
Type | string
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Summary | true
Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system.
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
94. Medication.code.coding:ask
Slice Name | ask
Definition | A reference to a code defined by a terminology system.
Short | Code defined by a terminology system
Comments | Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.
Control | 0..* This element is affected by the following invariants: ele-1
Type | Coding
Must Support | true
Summary | true
Requirements | Allows for alternative encodings within a code system, and translations to other code systems.
Pattern Value | `{ "system" : "http://fhir.de/CodeSystem/ask" }`
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
96. Medication.code.coding:ask.system
Definition | The identification of the code system that defines the meaning of the symbol in the code.
Short | Identity of the terminology system
Comments | The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.
Control | 10..1 This element is affected by the following invariants: ele-1
Type | uri
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Summary | true
Requirements | Need to be unambiguous about the source of the definition of the symbol.
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
98. Medication.code.coding:ask.code
Definition | A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).
Short | Symbol in syntax defined by the system
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size
Control | 10..1 This element is affected by the following invariants: ele-1
Type | code
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Summary | true
Requirements | Need to refer to a particular code in the system.
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
100. Medication.code.coding:ask.display
Definition | A representation of the meaning of the code in the system, following the rules of the system.
Short | Representation defined by the system
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size
Control | 0..1 This element is affected by the following invariants: ele-1
Type | string
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Summary | true
Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system.
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
102. Medication.code.coding:snomed
Slice Name | snomed
Definition | A reference to a code defined by a terminology system.
Short | Code defined by a terminology system
Comments | Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.
Control | 0..* This element is affected by the following invariants: ele-1
Binding | Unless not suitable, these codes SHALL be taken from For codes, see TI Arzneimittel SNOMED CT ValueSet (extensible to `https://gematik.de/fhir/terminology/ValueSet/ti-medication-snomed-ct-vs` )
Type | Coding
Summary | true
Requirements | Allows for alternative encodings within a code system, and translations to other code systems.
Pattern Value | `{ "system" : "http://snomed.info/sct" }`
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
104. Medication.code.coding:snomed.system
Definition | The identification of the code system that defines the meaning of the symbol in the code.
Short | Identity of the terminology system
Comments | The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.
Control | 10..1 This element is affected by the following invariants: ele-1
Type | uri
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Summary | true
Requirements | Need to be unambiguous about the source of the definition of the symbol.
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
106. Medication.code.coding:snomed.code
Definition | A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).
Short | Symbol in syntax defined by the system
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size
Control | 10..1 This element is affected by the following invariants: ele-1
Type | code
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Summary | true
Requirements | Need to refer to a particular code in the system.
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
108. Medication.code.coding:snomed.display
Definition | A representation of the meaning of the code in the system, following the rules of the system.
Short | Representation defined by the system
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size
Control | 0..1 This element is affected by the following invariants: ele-1
Type | string
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Summary | true
Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system.
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
110. Medication.code.text
Definition | A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.
Short | Plain text representation of the concept
Comments | Very often the text is the same as a displayName of one of the codings.
Control | 0..1 This element is affected by the following invariants: ele-1
Type | string
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Summary | true
Requirements | The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
112. Medication.status
Definition | A code to indicate if the medication is in active use.
Short | Status of Medication Informationactive | inactive | entered-in-error
Comments | This status is intended to identify if the medication in a local system is in active use within a drug database or inventory. For example, a pharmacy system may create a new drug file record for a compounded product "ABC Hospital Special Cream" with an active status. At some point in the future, it may be determined that the drug record was created with an error and the status is changed to "entered in error". This status is not intended to specify if a medication is part of a particular formulary. It is possible that the drug record may be referenced by multiple formularies or catalogues and each of those entries would have a separate status.
Control | 0..1 This element is affected by the following invariants: ele-1
Binding | The codes SHALL be taken from Medication Status Codes http://hl7.org/fhir/ValueSet/medication-status|4.0.1 (required to `http://hl7.org/fhir/ValueSet/medication-status|4.0.1` ) A coded concept defining if the medication is in active use.
Type | code
Is Modifier | true because This element changes the interpretation of all descriptive attributes.
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
114. Medication.manufacturer
Definition | Describes the details of the manufacturer of the medication product. This is not intended to represent the distributor of a medication product.
Short | Manufacturer of the MedicationManufacturer of the item
Comments | Here, the actual manufacturer of the medication can be named, primarily in the case of active ingredient mixtures (compounding prescriptions), such as the hospital pharmacy. It is important to note that the licensing organization, as mentioned in the PZN (Pharmaceutical Central Number) data, is not considered the manufacturer. References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.
Control | 0..1 This element is affected by the following invariants: ele-1
Type | Reference(Organization)
Must Support | true
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ref-1: 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')))
116. Medication.manufacturer.reference
Definition | A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.
Short | Literal reference, Relative, internal or absolute URL
Comments | Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server.
Control | 0..1 This element is affected by the following invariants: ele-1, ref-1
Type | string
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
118. Medication.manufacturer.display
Definition | Plain text narrative that identifies the resource in addition to the resource reference.
Short | Text alternative for the resource
Comments | This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.
Control | 10..1 This element is affected by the following invariants: ele-1
Type | string
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
120. Medication.form
Definition | Describes the form of the item. Powder; tablets; capsule.
Short | Form of Dispensingpowder | tablets | capsule +
Comments | When Medication is referenced from MedicationRequest, this is the ordered form. When Medication is referenced within MedicationDispense, this is the dispensed form. When Medication is referenced within MedicationAdministration, this is administered form.
Control | 0..1 This element is affected by the following invariants: ele-1
Binding | For example codes, see SNOMEDCTFormCodes http://hl7.org/fhir/ValueSet/medication-form-codes (example to `http://hl7.org/fhir/ValueSet/medication-form-codes` ) A coded concept defining the form of a medication.
Type | CodeableConcept
Must Support | true
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
122. Medication.form.coding
Definition | A reference to a code defined by a terminology system.
Short | Code defined by a terminology system
Comments | Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.
Control | 0..* This element is affected by the following invariants: ele-1
Type | Coding
Must Support | true
Summary | true
Requirements | Allows for alternative encodings within a code system, and translations to other code systems.
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
Slicing | This element introduces a set of slices on `Medication.form.coding`. The slices areUnordered and Open, and can be differentiated using the following discriminators: pattern @ $this
124. Medication.form.coding:edqm
Slice Name | edqm
Definition | A reference to a code defined by a terminology system.
Short | Code defined by a terminology system
Comments | Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.
Control | 0..* This element is affected by the following invariants: ele-1
Binding | The codes SHOULD be taken from For codes, see Medicine Doseform - IPS (preferred to `http://hl7.org/fhir/uv/ips/ValueSet/medicine-doseform` )
Type | Coding
Must Support | true
Summary | true
Requirements | Allows for alternative encodings within a code system, and translations to other code systems.
Pattern Value | `{ "system" : "http://standardterms.edqm.eu" }`
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
126. Medication.form.coding:edqm.system
Definition | The identification of the code system that defines the meaning of the symbol in the code.
Short | Identity of the terminology system
Comments | The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.
Control | 10..1 This element is affected by the following invariants: ele-1
Type | uri
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Summary | true
Requirements | Need to be unambiguous about the source of the definition of the symbol.
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
128. Medication.form.coding:edqm.code
Definition | A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).
Short | Symbol in syntax defined by the system
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size
Control | 10..1 This element is affected by the following invariants: ele-1
Type | code
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Summary | true
Requirements | Need to refer to a particular code in the system.
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
130. Medication.form.coding:edqm.display
Definition | A representation of the meaning of the code in the system, following the rules of the system.
Short | Representation defined by the system
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size
Control | 0..1 This element is affected by the following invariants: ele-1
Type | string
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Summary | true
Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system.
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
132. Medication.form.coding:snomed
Slice Name | snomed
Definition | A reference to a code defined by a terminology system.
Short | Code defined by a terminology system
Comments | Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.
Control | 0..* This element is affected by the following invariants: ele-1
Binding | The codes SHOULD be taken from For codes, see Value Set Darreichungsform SNOMED CT (preferred to `https://gematik.de/fhir/terminology/ValueSet/ti-medicine-form-snomed-ct-vs` )
Type | Coding
Summary | true
Requirements | Allows for alternative encodings within a code system, and translations to other code systems.
Pattern Value | `{ "system" : "http://snomed.info/sct" }`
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
134. Medication.form.coding:snomed.system
Definition | The identification of the code system that defines the meaning of the symbol in the code.
Short | Identity of the terminology system
Comments | The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.
Control | 10..1 This element is affected by the following invariants: ele-1
Type | uri
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Summary | true
Requirements | Need to be unambiguous about the source of the definition of the symbol.
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
136. Medication.form.coding:snomed.version
Definition | The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.
Short | Version of the system - if relevant
Comments | Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.
Note | This is a business version Id, not a resource version Id (see discussion)
Control | 0..1 This element is affected by the following invariants: ele-1
Type | string
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
138. Medication.form.coding:snomed.code
Definition | A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).
Short | Symbol in syntax defined by the system
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size
Control | 10..1 This element is affected by the following invariants: ele-1
Type | code
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Summary | true
Requirements | Need to refer to a particular code in the system.
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
140. Medication.form.coding:snomed.display
Definition | A representation of the meaning of the code in the system, following the rules of the system.
Short | Representation defined by the system
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size
Control | 0..1 This element is affected by the following invariants: ele-1
Type | string
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Summary | true
Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system.
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
142. Medication.form.coding:kbvDarreichungsform
Slice Name | kbvDarreichungsform
Definition | A reference to a code defined by a terminology system.
Short | Code defined by a terminology system
Comments | KBV updates its "Schüsseltabellen" package more often than ePA versions get released. However, the eRezept clients and eRezept service take over new KBV package versions quickly after release and thus hands them over to the ePA Medication Service. Since the Medication Service is potentially fixed onto an older version of the KBV package, it would reject the forwarded eRezept data. In the future, the Medication Service will be enabled to update to the latest KBV package versions without the need for a new ePA release. Since the eRezept does check the codes against the latest KBV package version, the Medication Service will not receive any "invalid" codes and clients can rely on the Medication Service data conforming to the latest KBV package. Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.
Control | 0..* This element is affected by the following invariants: ele-1
Binding | The codes SHALL be taken from For codes, see https://fhir.kbv.de/ValueSet/KBV_VS_SFHIR_KBV_DARREICHUNGSFORM (required to `https://fhir.kbv.de/ValueSet/KBV_VS_SFHIR_KBV_DARREICHUNGSFORM` )
Type | Coding
Must Support | true
Summary | true
Requirements | Allows for alternative encodings within a code system, and translations to other code systems.
Pattern Value | `{ "system" : "https://fhir.kbv.de/CodeSystem/KBV_CS_SFHIR_KBV_DARREICHUNGSFORM" }`
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
144. Medication.form.coding:kbvDarreichungsform.system
Definition | The identification of the code system that defines the meaning of the symbol in the code.
Short | Identity of the terminology system
Comments | The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.
Control | 10..1 This element is affected by the following invariants: ele-1
Type | uri
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Summary | true
Requirements | Need to be unambiguous about the source of the definition of the symbol.
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
146. Medication.form.coding:kbvDarreichungsform.code
Definition | A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).
Short | Symbol in syntax defined by the system
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size
Control | 10..1 This element is affected by the following invariants: ele-1
Type | code
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Summary | true
Requirements | Need to refer to a particular code in the system.
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
148. Medication.form.coding:kbvDarreichungsform.display
Definition | A representation of the meaning of the code in the system, following the rules of the system.
Short | Representation defined by the system
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size
Control | 0..1 This element is affected by the following invariants: ele-1
Type | string
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Summary | true
Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system.
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
150. Medication.amount
Definition | Specific amount of the drug in the packaged product. For example, when specifying a product that has the same strength (For example, Insulin glargine 100 unit per mL solution for injection), this attribute provides additional clarification of the package amount (For example, 3 mL, 10mL, etc.).
Short | Amount of drug in package
Comments | The Ratio datatype should only be used to express a relationship of two numbers if the relationship cannot be suitably expressed using a Quantity and a common unit. Where the denominator value is known to be fixed to "1", Quantity should be used instead of Ratio.
Control | 0..1 This element is affected by the following invariants: ele-1
Type | Ratio
Must Support | true
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) rat-1: 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()))
152. Medication.amount.numerator
Definition | The value of the numerator.
Short | Numerator value
Comments | The context of use may frequently define what kind of quantity this is and therefore what kind of units can be used. The context of use may also restrict the values for the comparator.
Control | 0..1 This element is affected by the following invariants: ele-1
Binding | The codes SHOULD be taken from For codes, see UCUMCodes (preferred to `http://hl7.org/fhir/ValueSet/ucum-units` )
Type | Quantity
Must Support | true
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) qty-3: If a code for the unit is present, the system SHALL also be present (code.empty() or system.exists())
154. Medication.amount.numerator.extension:packagingSize
Slice Name | packagingSize
Definition | Specification of the package size according to divided quantity (e.g., 100, 2x25), only appears in conjunction with "unit" (e.g., 100 Stück).
Short | Extension
Control | 0..1 This element is affected by the following invariants: ele-1
Type | Extension(MedicationPackagingSizeExtension) (Extension Type: string)
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
156. Medication.amount.numerator.extension:packagingSize.extension
Definition | An Extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Short | ExtensionAdditional content defined by implementations
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..0* This element is affected by the following invariants: ele-1
Type | Extension
Alternate Names | extensions, user content
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
Slicing | This element introduces a set of slices on `Medication.amount.numerator.extension.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
158. Medication.amount.numerator.extension:packagingSize.url
Definition | Source of the definition for the extension code - a logical name or a URL.
Short | identifies the meaning of the extension
Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.
Control | 1..1
Type | uri
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | `https://gematik.de/fhir/epa-medication/StructureDefinition/medication-packaging-size-extension`
160. Medication.amount.numerator.extension:packagingSize.value[x]
Definition | Specification of the package size according to divided quantity (e.g., 100, 2x25), only appears in conjunction with "unit" (e.g., 100 Stück). Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).
Short | Package size according to divided quantityValue of extension
Control | 10..1 This element is affected by the following invariants: ele-1
Type | string, date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, Coding, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, CodeableConcept, ParameterDefinition, dateTime, code, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, Signature, unsignedInt, time
[x] Note | SeeChoice of Data Typesfor further information about how to use [x]
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Max Length: | 7
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
162. Medication.amount.numerator.extension:totalQuantity
Slice Name | totalQuantity
Definition | Total quantity of the formulation (without the unit).
Short | Extension
Control | 0..1 This element is affected by the following invariants: ele-1
Type | Extension(MedicationTotalQuantityFormulationExtension) (Extension Type: string)
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
164. Medication.amount.numerator.extension:totalQuantity.extension
Definition | An Extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Short | ExtensionAdditional content defined by implementations
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..0* This element is affected by the following invariants: ele-1
Type | Extension
Alternate Names | extensions, user content
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
Slicing | This element introduces a set of slices on `Medication.amount.numerator.extension.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
166. Medication.amount.numerator.extension:totalQuantity.url
Definition | Source of the definition for the extension code - a logical name or a URL.
Short | identifies the meaning of the extension
Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.
Control | 1..1
Type | uri
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | `https://gematik.de/fhir/epa-medication/StructureDefinition/medication-total-quantity-formulation-extension`
168. Medication.amount.numerator.extension:totalQuantity.value[x]
Definition | Total quantity of the formulation (without the unit). Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).
Short | Total quantity of the formulation.Value of extension
Control | 10..1 This element is affected by the following invariants: ele-1
Type | string, date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, Coding, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, CodeableConcept, ParameterDefinition, dateTime, code, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, Signature, unsignedInt, time
[x] Note | SeeChoice of Data Typesfor further information about how to use [x]
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Max Length: | 7
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
170. Medication.amount.numerator.value
Definition | The value of the measured amount. The value includes an implicit precision in the presentation of the value.
Short | Numerical value (with implicit precision)
Comments | The implicit precision in the value should always be honored. Monetary values have their own rules for handling precision (refer to standard accounting text books).
Control | 0..1 This element is affected by the following invariants: ele-1
Type | decimal
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Summary | true
Requirements | Precision is handled implicitly in almost all cases of measurement.
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
172. Medication.amount.numerator.comparator
Definition | How the value should be understood and represented - whether the actual value is greater or less than the stated value due to measurement issues; e.g. if the comparator is "<" , then the real value is < stated value.
Short | < | <= | >= | > - how to understand the value
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size
Control | 0..1 This element is affected by the following invariants: ele-1
Binding | The codes SHALL be taken from QuantityComparator http://hl7.org/fhir/ValueSet/quantity-comparator|4.0.1 (required to `http://hl7.org/fhir/ValueSet/quantity-comparator|4.0.1` ) How the Quantity should be understood and represented.
Type | code
Is Modifier | true because This is labeled as "Is Modifier" because the comparator modifies the interpretation of the value significantly. If there is no comparator, then there is no modification of the value
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Requirements | Need a framework for handling measures where the value is <5ug/L or >400mg/L due to the limitations of measuring methodology.
Meaning if Missing | If there is no comparator, then there is no modification of the value
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
174. Medication.amount.numerator.unit
Definition | A human-readable form of the unit.
Short | Unit representation
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size
Control | 0..1 This element is affected by the following invariants: ele-1
Type | string
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Summary | true
Requirements | There are many representations for units of measure and in many contexts, particular representations are fixed and required. I.e. mcg for micrograms.
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
176. Medication.amount.numerator.system
Definition | The identification of the system that provides the coded form of the unit.
Short | System that defines coded unit form
Comments | see http://en.wikipedia.org/wiki/Uniform_resource_identifier
Control | 0..1 This element is affected by the following invariants: ele-1, qty-3
Type | uri
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Summary | true
Requirements | Need to know the system that defines the coded form of the unit.
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
178. Medication.amount.numerator.code
Definition | A computer processable form of the unit in some unit representation system.
Short | Coded form of the unit
Comments | The preferred system is UCUM, but SNOMED CT can also be used (for customary units) or ISO 4217 for currency. The context of use may additionally require a code from a particular system.
Control | 0..1 This element is affected by the following invariants: ele-1
Type | code
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Summary | true
Requirements | Need a computable form of the unit that is fixed across all forms. UCUM provides this for quantities, but SNOMED CT provides many units of interest.
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
180. Medication.amount.denominator
Definition | The value of the denominator.
Short | Denominator value
Comments | The context of use may frequently define what kind of quantity this is and therefore what kind of units can be used. The context of use may also restrict the values for the comparator.
Control | 0..1 This element is affected by the following invariants: ele-1
Binding | The codes SHOULD be taken from For codes, see UCUMCodes (preferred to `http://hl7.org/fhir/ValueSet/ucum-units` )
Type | Quantity
Must Support | true
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) qty-3: If a code for the unit is present, the system SHALL also be present (code.empty() or system.exists())
182. Medication.amount.denominator.value
Definition | The value of the measured amount. The value includes an implicit precision in the presentation of the value.
Short | Numerical value (with implicit precision)
Comments | The implicit precision in the value should always be honored. Monetary values have their own rules for handling precision (refer to standard accounting text books).
Control | 0..1 This element is affected by the following invariants: ele-1
Type | decimal
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Summary | true
Requirements | Precision is handled implicitly in almost all cases of measurement.
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
184. Medication.amount.denominator.comparator
Definition | How the value should be understood and represented - whether the actual value is greater or less than the stated value due to measurement issues; e.g. if the comparator is "<" , then the real value is < stated value.
Short | < | <= | >= | > - how to understand the value
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size
Control | 0..1 This element is affected by the following invariants: ele-1
Binding | The codes SHALL be taken from QuantityComparator http://hl7.org/fhir/ValueSet/quantity-comparator|4.0.1 (required to `http://hl7.org/fhir/ValueSet/quantity-comparator|4.0.1` ) How the Quantity should be understood and represented.
Type | code
Is Modifier | true because This is labeled as "Is Modifier" because the comparator modifies the interpretation of the value significantly. If there is no comparator, then there is no modification of the value
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Requirements | Need a framework for handling measures where the value is <5ug/L or >400mg/L due to the limitations of measuring methodology.
Meaning if Missing | If there is no comparator, then there is no modification of the value
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
186. Medication.amount.denominator.unit
Definition | A human-readable form of the unit.
Short | Unit representation
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size
Control | 0..1 This element is affected by the following invariants: ele-1
Type | string
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Summary | true
Requirements | There are many representations for units of measure and in many contexts, particular representations are fixed and required. I.e. mcg for micrograms.
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
188. Medication.amount.denominator.system
Definition | The identification of the system that provides the coded form of the unit.
Short | System that defines coded unit form
Comments | see http://en.wikipedia.org/wiki/Uniform_resource_identifier
Control | 0..1 This element is affected by the following invariants: ele-1, qty-3
Type | uri
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Summary | true
Requirements | Need to know the system that defines the coded form of the unit.
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
190. Medication.amount.denominator.code
Definition | A computer processable form of the unit in some unit representation system.
Short | Coded form of the unit
Comments | The preferred system is UCUM, but SNOMED CT can also be used (for customary units) or ISO 4217 for currency. The context of use may additionally require a code from a particular system.
Control | 0..1 This element is affected by the following invariants: ele-1
Type | code
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Summary | true
Requirements | Need a computable form of the unit that is fixed across all forms. UCUM provides this for quantities, but SNOMED CT provides many units of interest.
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
192. Medication.ingredient
Definition | Identifies a particular constituent of interest in the product.
Short | Active or inactive ingredients of the medication, including pharmaceutical substances as well as individual medicinal products in combination packs.
Comments | The ingredients need not be a complete list. If an ingredient is not specified, this does not indicate whether an ingredient is present or absent. If an ingredient is specified it does not mean that all ingredients are specified. It is possible to specify both inactive and active ingredients.
Control | 0..* This element is affected by the following invariants: ele-1
Type | BackboneElement
Must Support | true
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
194. Medication.ingredient.extension:darreichungsform
Slice Name | darreichungsform
Definition | Dosage form of an ingredient in a formulation.
Short | Extension
Control | 0..1 This element is affected by the following invariants: ele-1
Type | Extension(MedicationIngredientDarreichungsformExtension) (Extension Type: string)
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
196. Medication.ingredient.modifierExtension
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Short | Extensions that cannot be ignored even if unrecognized
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..* This element is affected by the following invariants: ele-1
Type | Extension
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summary | true
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.
Alternate Names | extensions, user content, modifiers
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
198. Medication.ingredient.item[x]
Definition | The actual ingredient - either a substance (simple ingredient) or another medication of a medication.
Short | The actual ingredient or content
Control | 1..1 This element is affected by the following invariants: ele-1
Type | CodeableConcept, Reference(Substance, Medication)
[x] Note | SeeChoice of Data Typesfor further information about how to use [x]
Must Support | true
Requirements | The ingredient may reference a substance (for example, amoxicillin) or another medication (for example in the case of a compounded product, Glaxal Base).
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
Slicing | This element introduces a set of slices on `Medication.ingredient.item[x]`. The slices areUnordered and Closed, and can be differentiated using the following discriminators: type @ $this
200. Medication.ingredient.item[x]:itemCodeableConcept
Slice Name | itemCodeableConcept
Definition | The actual ingredient - either a substance (simple ingredient) or another medication of a medication.
Short | Encoded description of the substance or component.The actual ingredient or content
Control | 01..1 This element is affected by the following invariants: ele-1
Type | CodeableConcept, Reference(Substance, Medication)
[x] Note | SeeChoice of Data Typesfor further information about how to use [x]
Must Support | true
Requirements | The ingredient may reference a substance (for example, amoxicillin) or another medication (for example in the case of a compounded product, Glaxal Base).
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
202. Medication.ingredient.item[x]:itemCodeableConcept.coding
Definition | A reference to a code defined by a terminology system.
Short | Code defined by a terminology system
Comments | Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.
Control | 0..* This element is affected by the following invariants: ele-1
Type | Coding
Must Support | true
Summary | true
Requirements | Allows for alternative encodings within a code system, and translations to other code systems.
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
Slicing | This element introduces a set of slices on `Medication.ingredient.item[x].coding`. The slices areUnordered and Open, and can be differentiated using the following discriminators: pattern @ $this
204. Medication.ingredient.item[x]:itemCodeableConcept.coding:ask
Slice Name | ask
Definition | A reference to a code defined by a terminology system.
Short | Code defined by a terminology system
Comments | Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.
Control | 0..* This element is affected by the following invariants: ele-1
Type | Coding
Must Support | true
Summary | true
Requirements | Allows for alternative encodings within a code system, and translations to other code systems.
Pattern Value | `{ "system" : "http://fhir.de/CodeSystem/ask" }`
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
206. Medication.ingredient.item[x]:itemCodeableConcept.coding:ask.system
Definition | The identification of the code system that defines the meaning of the symbol in the code.
Short | Identity of the terminology system
Comments | The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.
Control | 10..1 This element is affected by the following invariants: ele-1
Type | uri
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Summary | true
Requirements | Need to be unambiguous about the source of the definition of the symbol.
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
208. Medication.ingredient.item[x]:itemCodeableConcept.coding:ask.code
Definition | A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).
Short | Symbol in syntax defined by the system
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size
Control | 10..1 This element is affected by the following invariants: ele-1
Type | code
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Summary | true
Requirements | Need to refer to a particular code in the system.
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
210. Medication.ingredient.item[x]:itemCodeableConcept.coding:ask.display
Definition | A representation of the meaning of the code in the system, following the rules of the system.
Short | Representation defined by the system
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size
Control | 0..1 This element is affected by the following invariants: ele-1
Type | string
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Summary | true
Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system.
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
212. Medication.ingredient.item[x]:itemCodeableConcept.coding:atc-de
Slice Name | atc-de
Definition | A reference to a code defined by a terminology system.
Short | Code defined by a terminology system
Comments | Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.
Control | 0..* This element is affected by the following invariants: ele-1
Type | Coding
Must Support | true
Summary | true
Requirements | Allows for alternative encodings within a code system, and translations to other code systems.
Pattern Value | `{ "system" : "http://fhir.de/CodeSystem/bfarm/atc" }`
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
214. Medication.ingredient.item[x]:itemCodeableConcept.coding:atc-de.system
Definition | The identification of the code system that defines the meaning of the symbol in the code.
Short | Identity of the terminology system
Comments | The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.
Control | 10..1 This element is affected by the following invariants: ele-1
Type | uri
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Summary | true
Requirements | Need to be unambiguous about the source of the definition of the symbol.
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
216. Medication.ingredient.item[x]:itemCodeableConcept.coding:atc-de.code
Definition | A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).
Short | Symbol in syntax defined by the system
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size
Control | 10..1 This element is affected by the following invariants: ele-1
Type | code
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Summary | true
Requirements | Need to refer to a particular code in the system.
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
218. Medication.ingredient.item[x]:itemCodeableConcept.coding:atc-de.display
Definition | A representation of the meaning of the code in the system, following the rules of the system.
Short | Representation defined by the system
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size
Control | 0..1 This element is affected by the following invariants: ele-1
Type | string
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Summary | true
Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system.
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
220. Medication.ingredient.item[x]:itemCodeableConcept.coding:snomed
Slice Name | snomed
Definition | A reference to a code defined by a terminology system.
Short | Code defined by a terminology system
Comments | Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.
Control | 0..* This element is affected by the following invariants: ele-1
Binding | The codes SHOULD be taken from For codes, see TI Substance SNOMED CT ValueSet (preferred to `https://gematik.de/fhir/terminology/ValueSet/ti-substance-snomed-ct-vs` )
Type | Coding
Summary | true
Requirements | Allows for alternative encodings within a code system, and translations to other code systems.
Pattern Value | `{ "system" : "http://snomed.info/sct" }`
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
222. Medication.ingredient.item[x]:itemCodeableConcept.coding:snomed.system
Definition | The identification of the code system that defines the meaning of the symbol in the code.
Short | Identity of the terminology system
Comments | The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.
Control | 10..1 This element is affected by the following invariants: ele-1
Type | uri
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Summary | true
Requirements | Need to be unambiguous about the source of the definition of the symbol.
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
224. Medication.ingredient.item[x]:itemCodeableConcept.coding:snomed.version
Definition | The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.
Short | Version of the system - if relevant
Comments | Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.
Note | This is a business version Id, not a resource version Id (see discussion)
Control | 0..1 This element is affected by the following invariants: ele-1
Type | string
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
226. Medication.ingredient.item[x]:itemCodeableConcept.coding:snomed.code
Definition | A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).
Short | Symbol in syntax defined by the system
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size
Control | 10..1 This element is affected by the following invariants: ele-1
Type | code
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Summary | true
Requirements | Need to refer to a particular code in the system.
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
228. Medication.ingredient.item[x]:itemCodeableConcept.coding:snomed.display
Definition | A representation of the meaning of the code in the system, following the rules of the system.
Short | Representation defined by the system
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size
Control | 0..1 This element is affected by the following invariants: ele-1
Type | string
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Summary | true
Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system.
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
230. Medication.ingredient.item[x]:itemCodeableConcept.coding:pzn
Slice Name | pzn
Definition | A reference to a code defined by a terminology system.
Short | Code defined by a terminology system
Comments | Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.
Control | 0..* This element is affected by the following invariants: ele-1
Type | Coding
Must Support | true
Summary | true
Requirements | Allows for alternative encodings within a code system, and translations to other code systems.
Pattern Value | `{ "system" : "http://fhir.de/CodeSystem/ifa/pzn" }`
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
232. Medication.ingredient.item[x]:itemCodeableConcept.coding:pzn.system
Definition | The identification of the code system that defines the meaning of the symbol in the code.
Short | Identity of the terminology system
Comments | The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.
Control | 10..1 This element is affected by the following invariants: ele-1
Type | uri
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Summary | true
Requirements | Need to be unambiguous about the source of the definition of the symbol.
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
234. Medication.ingredient.item[x]:itemCodeableConcept.coding:pzn.code
Definition | A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).
Short | Symbol in syntax defined by the system
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size
Control | 10..1 This element is affected by the following invariants: ele-1
Type | code
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Summary | true
Requirements | Need to refer to a particular code in the system.
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
236. Medication.ingredient.item[x]:itemCodeableConcept.coding:pzn.display
Definition | A representation of the meaning of the code in the system, following the rules of the system.
Short | Representation defined by the system
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size
Control | 0..1 This element is affected by the following invariants: ele-1
Type | string
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Summary | true
Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system.
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
238. Medication.ingredient.item[x]:itemCodeableConcept.text
Definition | A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.
Short | Plain text representation of the concept
Comments | Very often the text is the same as a displayName of one of the codings.
Control | 0..1 This element is affected by the following invariants: ele-1
Type | string
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Summary | true
Requirements | The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
240. Medication.ingredient.item[x]:itemReference
Slice Name | itemReference
Definition | The actual ingredient - either a substance (simple ingredient) or another medication of a medication.
Short | Medication Ingredients can't have child MedicationsThe actual ingredient or content
Control | 01..01 This element is affected by the following invariants: ele-1
Type | Reference(Medication, Substance), CodeableConcept
Must Support | true
Requirements | The ingredient may reference a substance (for example, amoxicillin) or another medication (for example in the case of a compounded product, Glaxal Base).
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
242. Medication.ingredient.isActive
Definition | Indication of whether this ingredient affects the therapeutic action of the drug.
Short | Is it an active ingredient?Active ingredient indicator
Control | 0..1 This element is affected by the following invariants: ele-1
Type | boolean
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Requirements | True indicates that the ingredient affects the therapeutic action of the drug (i.e. active). False indicates that the ingredient does not affect the therapeutic action of the drug (i.e. inactive).
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
244. Medication.ingredient.strength
Definition | Specifies how many (or how much) of the items there are in this Medication. For example, 250 mg per tablet. This is expressed as a ratio where the numerator is 250mg and the denominator is 1 tablet.
Short | StrengthQuantity of ingredient present
Comments | The Ratio datatype should only be used to express a relationship of two numbers if the relationship cannot be suitably expressed using a Quantity and a common unit. Where the denominator value is known to be fixed to "1", Quantity should be used instead of Ratio.
Control | 0..1 This element is affected by the following invariants: ele-1
Type | Ratio
Must Support | true
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) rat-1: 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()))
246. Medication.ingredient.strength.extension:amountText
Slice Name | amountText
Definition | Free-text amount of the ingredient for classical Latin notations such as "ad 100.0" or "quantum satis," including the unit.
Short | Extension
Control | 0..1 This element is affected by the following invariants: ele-1
Type | Extension(MedicationIngredientAmountExtensions) (Extension Type: string)
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
248. Medication.ingredient.strength.extension:amountText.extension
Definition | An Extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Short | ExtensionAdditional content defined by implementations
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..0* This element is affected by the following invariants: ele-1
Type | Extension
Alternate Names | extensions, user content
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
Slicing | This element introduces a set of slices on `Medication.ingredient.strength.extension.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
250. Medication.ingredient.strength.extension:amountText.url
Definition | Source of the definition for the extension code - a logical name or a URL.
Short | identifies the meaning of the extension
Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.
Control | 1..1
Type | uri
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | `https://gematik.de/fhir/epa-medication/StructureDefinition/medication-ingredient-amount-extension`
252. Medication.ingredient.strength.extension:amountText.value[x]
Definition | Free-text amount of the ingredient for classical Latin notations such as "ad 100.0" or "quantum satis," including the unit. Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).
Short | Free-text amount of an ingredient in a formulation.Value of extension
Control | 10..1 This element is affected by the following invariants: ele-1
Type | string, date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, Coding, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, CodeableConcept, ParameterDefinition, dateTime, code, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, Signature, unsignedInt, time
[x] Note | SeeChoice of Data Typesfor further information about how to use [x]
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Max Length: | 20
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
254. Medication.ingredient.strength.numerator
Definition | The value of the numerator.
Short | Numerator value
Comments | The context of use may frequently define what kind of quantity this is and therefore what kind of units can be used. The context of use may also restrict the values for the comparator.
Control | 0..1 This element is affected by the following invariants: ele-1
Binding | The codes SHOULD be taken from For codes, see UCUMCodes (preferred to `http://hl7.org/fhir/ValueSet/ucum-units` )
Type | Quantity
Must Support | true
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) qty-3: If a code for the unit is present, the system SHALL also be present (code.empty() or system.exists())
256. Medication.ingredient.strength.numerator.value
Definition | The value of the measured amount. The value includes an implicit precision in the presentation of the value.
Short | Numerical value (with implicit precision)
Comments | The implicit precision in the value should always be honored. Monetary values have their own rules for handling precision (refer to standard accounting text books).
Control | 10..1 This element is affected by the following invariants: ele-1
Type | decimal
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Summary | true
Requirements | Precision is handled implicitly in almost all cases of measurement.
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
258. Medication.ingredient.strength.numerator.comparator
Definition | How the value should be understood and represented - whether the actual value is greater or less than the stated value due to measurement issues; e.g. if the comparator is "<" , then the real value is < stated value.
Short | < | <= | >= | > - how to understand the value
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size
Control | 0..1 This element is affected by the following invariants: ele-1
Binding | The codes SHALL be taken from QuantityComparator http://hl7.org/fhir/ValueSet/quantity-comparator|4.0.1 (required to `http://hl7.org/fhir/ValueSet/quantity-comparator|4.0.1` ) How the Quantity should be understood and represented.
Type | code
Is Modifier | true because This is labeled as "Is Modifier" because the comparator modifies the interpretation of the value significantly. If there is no comparator, then there is no modification of the value
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Requirements | Need a framework for handling measures where the value is <5ug/L or >400mg/L due to the limitations of measuring methodology.
Meaning if Missing | If there is no comparator, then there is no modification of the value
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
260. Medication.ingredient.strength.numerator.unit
Definition | A human-readable form of the unit.
Short | Unit representation
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size
Control | 0..1 This element is affected by the following invariants: ele-1
Type | string
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Summary | true
Requirements | There are many representations for units of measure and in many contexts, particular representations are fixed and required. I.e. mcg for micrograms.
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
262. Medication.ingredient.strength.numerator.system
Definition | The identification of the system that provides the coded form of the unit.
Short | System that defines coded unit form
Comments | see http://en.wikipedia.org/wiki/Uniform_resource_identifier
Control | 0..1 This element is affected by the following invariants: ele-1, qty-3
Type | uri
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Summary | true
Requirements | Need to know the system that defines the coded form of the unit.
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
264. Medication.ingredient.strength.numerator.code
Definition | A computer processable form of the unit in some unit representation system.
Short | Coded form of the unit
Comments | The preferred system is UCUM, but SNOMED CT can also be used (for customary units) or ISO 4217 for currency. The context of use may additionally require a code from a particular system.
Control | 0..1 This element is affected by the following invariants: ele-1
Type | code
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Summary | true
Requirements | Need a computable form of the unit that is fixed across all forms. UCUM provides this for quantities, but SNOMED CT provides many units of interest.
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
266. Medication.ingredient.strength.denominator
Definition | The value of the denominator.
Short | Denominator value
Comments | The context of use may frequently define what kind of quantity this is and therefore what kind of units can be used. The context of use may also restrict the values for the comparator.
Control | 0..1 This element is affected by the following invariants: ele-1
Binding | The codes SHOULD be taken from For codes, see UCUMCodes (preferred to `http://hl7.org/fhir/ValueSet/ucum-units` )
Type | Quantity
Must Support | true
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) qty-3: If a code for the unit is present, the system SHALL also be present (code.empty() or system.exists())
268. Medication.ingredient.strength.denominator.value
Definition | The value of the measured amount. The value includes an implicit precision in the presentation of the value.
Short | Numerical value (with implicit precision)
Comments | The implicit precision in the value should always be honored. Monetary values have their own rules for handling precision (refer to standard accounting text books).
Control | 10..1 This element is affected by the following invariants: ele-1
Type | decimal
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Summary | true
Requirements | Precision is handled implicitly in almost all cases of measurement.
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
270. Medication.ingredient.strength.denominator.comparator
Definition | How the value should be understood and represented - whether the actual value is greater or less than the stated value due to measurement issues; e.g. if the comparator is "<" , then the real value is < stated value.
Short | < | <= | >= | > - how to understand the value
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size
Control | 0..1 This element is affected by the following invariants: ele-1
Binding | The codes SHALL be taken from QuantityComparator http://hl7.org/fhir/ValueSet/quantity-comparator|4.0.1 (required to `http://hl7.org/fhir/ValueSet/quantity-comparator|4.0.1` ) How the Quantity should be understood and represented.
Type | code
Is Modifier | true because This is labeled as "Is Modifier" because the comparator modifies the interpretation of the value significantly. If there is no comparator, then there is no modification of the value
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Requirements | Need a framework for handling measures where the value is <5ug/L or >400mg/L due to the limitations of measuring methodology.
Meaning if Missing | If there is no comparator, then there is no modification of the value
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
272. Medication.ingredient.strength.denominator.unit
Definition | A human-readable form of the unit.
Short | Unit representation
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size
Control | 0..1 This element is affected by the following invariants: ele-1
Type | string
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Summary | true
Requirements | There are many representations for units of measure and in many contexts, particular representations are fixed and required. I.e. mcg for micrograms.
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
274. Medication.ingredient.strength.denominator.system
Definition | The identification of the system that provides the coded form of the unit.
Short | System that defines coded unit form
Comments | see http://en.wikipedia.org/wiki/Uniform_resource_identifier
Control | 0..1 This element is affected by the following invariants: ele-1, qty-3
Type | uri
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Summary | true
Requirements | Need to know the system that defines the coded form of the unit.
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
276. Medication.ingredient.strength.denominator.code
Definition | A computer processable form of the unit in some unit representation system.
Short | Coded form of the unit
Comments | The preferred system is UCUM, but SNOMED CT can also be used (for customary units) or ISO 4217 for currency. The context of use may additionally require a code from a particular system.
Control | 0..1 This element is affected by the following invariants: ele-1
Type | code
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Summary | true
Requirements | Need a computable form of the unit that is fixed across all forms. UCUM provides this for quantities, but SNOMED CT provides many units of interest.
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
278. Medication.batch
Definition | Information that only applies to packages (not products).
Short | Batch InformationDetails about packaged medications
Control | 0..1 This element is affected by the following invariants: ele-1
Type | BackboneElement
Must Support | true
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
280. Medication.batch.modifierExtension
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Short | Extensions that cannot be ignored even if unrecognized
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..* This element is affected by the following invariants: ele-1
Type | Extension
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summary | true
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.
Alternate Names | extensions, user content, modifiers
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
282. Medication.batch.lotNumber
Definition | The assigned lot number of a batch of the specified product.
Short | Batch NumberIdentifier assigned to batch
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size
Control | 0..1 This element is affected by the following invariants: ele-1
Type | string
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

Guidance on how to interpret the contents of this table can be found here

0. Medication
Invariants | epa-med-1: Medication code, name, or ingredients must be specified (`code.exists() or ingredient.exists()`)
2. Medication.meta
Must Support | true
4. Medication.meta.versionId
Must Support | true
6. Medication.meta.lastUpdated
Must Support | true
8. Medication.contained
Control | 0..0
10. Medication.extension:rxPrescriptionProcessIdentifier
Slice Name | rxPrescriptionProcessIdentifier
Control | 0..1
Type | Extension(RxPrescriptionProcessIdentifierExtension) (Extension Type: Identifier(RxPrescriptionProcessIdentifier))
12. Medication.extension:isVaccine
Slice Name | isVaccine
Control | 0..1
Type | Extension(MedicationIsVaccineExtension) (Extension Type: boolean)
14. Medication.extension:isVaccine.value[x]
[x] Note | SeeChoice of Data Typesfor further information about how to use [x]
Must Support | true
16. Medication.extension:drugCategory
Slice Name | drugCategory
Control | 0..1
Type | Extension(DrugCategoryExtension) (Extension Type: Coding)
18. Medication.extension:drugCategory.value[x]
[x] Note | SeeChoice of Data Typesfor further information about how to use [x]
Must Support | true
20. Medication.extension:drugCategory.value[x].system
Control | 1..?
Must Support | true
22. Medication.extension:drugCategory.value[x].code
Control | 1..?
Must Support | true
24. Medication.extension:normSizeCode
Slice Name | normSizeCode
Definition | Description of the therapy-appropriate package size (e.g., N1)
Short | Package size according to N-designation
Control | 0..1
Type | Extension(ExtensionNormgroesseDeBasis) (Extension Type: code)
26. Medication.extension:normSizeCode.value[x]
[x] Note | SeeChoice of Data Typesfor further information about how to use [x]
Must Support | true
28. Medication.extension:packaging
Slice Name | packaging
Control | 0..1
Type | Extension(MedicationFormulationPackagingExtension) (Extension Type: string)
30. Medication.extension:packaging.value[x]
[x] Note | SeeChoice of Data Typesfor further information about how to use [x]
Must Support | true
32. Medication.extension:manufacturingInstructions
Slice Name | manufacturingInstructions
Control | 0..1
Type | Extension(MedicationManufacturingInstructionsExtension) (Extension Type: string)
34. Medication.extension:manufacturingInstructions.value[x]
[x] Note | SeeChoice of Data Typesfor further information about how to use [x]
Must Support | true
36. Medication.extension:type
Slice Name | type
Control | 0..1
Type | Extension(Medication Type) (Extension Type: Coding)
Must Support | true
38. Medication.extension:type.value[x]
Binding | The codes SHALL be taken from TI Medication Type ValueSet for PZN-Medication (required to `https://gematik.de/fhir/terminology/ValueSet/ti-medication-type-product-vs` )
[x] Note | SeeChoice of Data Typesfor further information about how to use [x]
40. Medication.identifier
Note | This is a business identifier, not a resource identifier (see discussion)
Slicing | This element introduces a set of slices on `Medication.identifier`. The slices areUnordered and Open, and can be differentiated using the following discriminators: pattern @ $this
42. Medication.identifier:EPAMedicationUniqueIdentifier
Slice Name | EPAMedicationUniqueIdentifier
Note | This is a business identifier, not a resource identifier (see discussion)
Control | 0..1
Type | Identifier(Medication Unique Identifier)
Pattern Value | `{ "system" : "https://gematik.de/fhir/epa-medication/sid/epa-medication-unique-identifier" }`
44. Medication.identifier:RxOriginatorProcessIdentifier
Slice Name | RxOriginatorProcessIdentifier
Note | This is a business identifier, not a resource identifier (see discussion)
Control | 0..1
Type | Identifier(RxOriginatorProcessIdentifier)
Pattern Value | `{ "system" : "https://gematik.de/fhir/epa-medication/sid/rx-originator-process-identifier" }`
46. Medication.code
Short | Medication in coded form or as free text if necessary
Must Support | true
48. Medication.code.coding
Control | 1..?
Must Support | true
Slicing | This element introduces a set of slices on `Medication.code.coding`. The slices areUnordered and Open, and can be differentiated using the following discriminators: pattern @ $this
50. Medication.code.coding:pzn
Slice Name | pzn
Control | 1..1
Must Support | true
Pattern Value | `{ "system" : "http://fhir.de/CodeSystem/ifa/pzn" }`
52. Medication.code.coding:pzn.system
Control | 1..?
Must Support | true
54. Medication.code.coding:pzn.code
Control | 1..?
Must Support | true
56. Medication.code.coding:pzn.display
Must Support | true
58. Medication.code.coding:atc-de
Slice Name | atc-de
Control | 0..*
Must Support | true
Pattern Value | `{ "system" : "http://fhir.de/CodeSystem/bfarm/atc" }`
60. Medication.code.coding:atc-de.system
Control | 1..?
Must Support | true
62. Medication.code.coding:atc-de.code
Control | 1..?
Must Support | true
64. Medication.code.coding:atc-de.display
Must Support | true
66. Medication.code.coding:ask
Slice Name | ask
Control | 0..*
Must Support | true
Pattern Value | `{ "system" : "http://fhir.de/CodeSystem/ask" }`
68. Medication.code.coding:ask.system
Control | 1..?
Must Support | true
70. Medication.code.coding:ask.code
Control | 1..?
Must Support | true
72. Medication.code.coding:ask.display
Must Support | true
74. Medication.code.coding:snomed
Slice Name | snomed
Control | 0..*
Binding | Unless not suitable, these codes SHALL be taken from TI Arzneimittel SNOMED CT ValueSet (extensible to `https://gematik.de/fhir/terminology/ValueSet/ti-medication-snomed-ct-vs` )
Pattern Value | `{ "system" : "http://snomed.info/sct" }`
76. Medication.code.coding:snomed.system
Control | 1..?
Must Support | true
78. Medication.code.coding:snomed.code
Control | 1..?
Must Support | true
80. Medication.code.coding:snomed.display
Must Support | true
82. Medication.code.text
Must Support | true
84. Medication.status
Short | Status of Medication Information
Must Support | true
86. Medication.manufacturer
Short | Manufacturer of the Medication
Comments | Here, the actual manufacturer of the medication can be named, primarily in the case of active ingredient mixtures (compounding prescriptions), such as the hospital pharmacy. It is important to note that the licensing organization, as mentioned in the PZN (Pharmaceutical Central Number) data, is not considered the manufacturer.
Must Support | true
88. Medication.manufacturer.display
Control | 1..?
Must Support | true
90. Medication.form
Short | Form of Dispensing
Must Support | true
92. Medication.form.coding
Must Support | true
Slicing | This element introduces a set of slices on `Medication.form.coding`. The slices areUnordered and Open, and can be differentiated using the following discriminators: pattern @ $this
94. Medication.form.coding:edqm
Slice Name | edqm
Control | 0..*
Binding | The codes SHOULD be taken from Medicine Doseform - IPS (preferred to `http://hl7.org/fhir/uv/ips/ValueSet/medicine-doseform` )
Must Support | true
Pattern Value | `{ "system" : "http://standardterms.edqm.eu" }`
96. Medication.form.coding:edqm.system
Control | 1..?
Must Support | true
98. Medication.form.coding:edqm.code
Control | 1..?
Must Support | true
100. Medication.form.coding:edqm.display
Must Support | true
102. Medication.form.coding:snomed
Slice Name | snomed
Control | 0..*
Binding | The codes SHOULD be taken from Value Set Darreichungsform SNOMED CT (preferred to `https://gematik.de/fhir/terminology/ValueSet/ti-medicine-form-snomed-ct-vs` )
Pattern Value | `{ "system" : "http://snomed.info/sct" }`
104. Medication.form.coding:snomed.system
Control | 1..?
Must Support | true
106. Medication.form.coding:snomed.version
Note | This is a business version Id, not a resource version Id (see discussion)
Must Support | true
108. Medication.form.coding:snomed.code
Control | 1..?
Must Support | true
110. Medication.form.coding:snomed.display
Must Support | true
112. Medication.form.coding:kbvDarreichungsform
Slice Name | kbvDarreichungsform
Comments | KBV updates its "Schüsseltabellen" package more often than ePA versions get released. However, the eRezept clients and eRezept service take over new KBV package versions quickly after release and thus hands them over to the ePA Medication Service. Since the Medication Service is potentially fixed onto an older version of the KBV package, it would reject the forwarded eRezept data. In the future, the Medication Service will be enabled to update to the latest KBV package versions without the need for a new ePA release. Since the eRezept does check the codes against the latest KBV package version, the Medication Service will not receive any "invalid" codes and clients can rely on the Medication Service data conforming to the latest KBV package.
Control | 0..*
Binding | The codes SHALL be taken from https://fhir.kbv.de/ValueSet/KBV_VS_SFHIR_KBV_DARREICHUNGSFORM (required to `https://fhir.kbv.de/ValueSet/KBV_VS_SFHIR_KBV_DARREICHUNGSFORM` )
Must Support | true
Pattern Value | `{ "system" : "https://fhir.kbv.de/CodeSystem/KBV_CS_SFHIR_KBV_DARREICHUNGSFORM" }`
114. Medication.form.coding:kbvDarreichungsform.system
Control | 1..?
Must Support | true
116. Medication.form.coding:kbvDarreichungsform.code
Control | 1..?
Must Support | true
118. Medication.form.coding:kbvDarreichungsform.display
Must Support | true
120. Medication.amount
Must Support | true
122. Medication.amount.numerator
Binding | The codes SHOULD be taken from UCUMCodes (preferred to `http://hl7.org/fhir/ValueSet/ucum-units` )
Must Support | true
124. Medication.amount.numerator.extension:packagingSize
Slice Name | packagingSize
Control | 0..1
Type | Extension(MedicationPackagingSizeExtension) (Extension Type: string)
126. Medication.amount.numerator.extension:packagingSize.value[x]
[x] Note | SeeChoice of Data Typesfor further information about how to use [x]
Must Support | true
128. Medication.amount.numerator.extension:totalQuantity
Slice Name | totalQuantity
Control | 0..1
Type | Extension(MedicationTotalQuantityFormulationExtension) (Extension Type: string)
130. Medication.amount.numerator.extension:totalQuantity.value[x]
[x] Note | SeeChoice of Data Typesfor further information about how to use [x]
Must Support | true
132. Medication.amount.numerator.value
Must Support | true
134. Medication.amount.numerator.unit
Must Support | true
136. Medication.amount.numerator.system
Must Support | true
138. Medication.amount.numerator.code
Must Support | true
140. Medication.amount.denominator
Binding | The codes SHOULD be taken from UCUMCodes (preferred to `http://hl7.org/fhir/ValueSet/ucum-units` )
Must Support | true
142. Medication.amount.denominator.value
Must Support | true
144. Medication.amount.denominator.unit
Must Support | true
146. Medication.amount.denominator.system
Must Support | true
148. Medication.amount.denominator.code
Must Support | true
150. Medication.ingredient
Short | Active or inactive ingredients of the medication, including pharmaceutical substances as well as individual medicinal products in combination packs.
Must Support | true
152. Medication.ingredient.extension:darreichungsform
Slice Name | darreichungsform
Control | 0..1
Type | Extension(MedicationIngredientDarreichungsformExtension) (Extension Type: string)
154. Medication.ingredient.item[x]
[x] Note | SeeChoice of Data Typesfor further information about how to use [x]
Must Support | true
Slicing | This element introduces a set of slices on `Medication.ingredient.item[x]`. The slices areUnordered and Open, and can be differentiated using the following discriminators: type @ $this
156. Medication.ingredient.item[x]:itemCodeableConcept
Slice Name | itemCodeableConcept
Short | Encoded description of the substance or component.
Control | 0..1
Type | CodeableConcept
[x] Note | SeeChoice of Data Typesfor further information about how to use [x]
Must Support | true
158. Medication.ingredient.item[x]:itemCodeableConcept.coding
Must Support | true
Slicing | This element introduces a set of slices on `Medication.ingredient.item[x].coding`. The slices areUnordered and Open, and can be differentiated using the following discriminators: pattern @ $this
160. Medication.ingredient.item[x]:itemCodeableConcept.coding:ask
Slice Name | ask
Control | 0..*
Must Support | true
Pattern Value | `{ "system" : "http://fhir.de/CodeSystem/ask" }`
162. Medication.ingredient.item[x]:itemCodeableConcept.coding:ask.system
Control | 1..?
Must Support | true
164. Medication.ingredient.item[x]:itemCodeableConcept.coding:ask.code
Control | 1..?
Must Support | true
166. Medication.ingredient.item[x]:itemCodeableConcept.coding:ask.display
Must Support | true
168. Medication.ingredient.item[x]:itemCodeableConcept.coding:atc-de
Slice Name | atc-de
Control | 0..*
Must Support | true
Pattern Value | `{ "system" : "http://fhir.de/CodeSystem/bfarm/atc" }`
170. Medication.ingredient.item[x]:itemCodeableConcept.coding:atc-de.system
Control | 1..?
Must Support | true
172. Medication.ingredient.item[x]:itemCodeableConcept.coding:atc-de.code
Control | 1..?
Must Support | true
174. Medication.ingredient.item[x]:itemCodeableConcept.coding:atc-de.display
Must Support | true
176. Medication.ingredient.item[x]:itemCodeableConcept.coding:snomed
Slice Name | snomed
Control | 0..*
Binding | The codes SHOULD be taken from TI Substance SNOMED CT ValueSet (preferred to `https://gematik.de/fhir/terminology/ValueSet/ti-substance-snomed-ct-vs` )
Pattern Value | `{ "system" : "http://snomed.info/sct" }`
178. Medication.ingredient.item[x]:itemCodeableConcept.coding:snomed.system
Control | 1..?
Must Support | true
180. Medication.ingredient.item[x]:itemCodeableConcept.coding:snomed.version
Note | This is a business version Id, not a resource version Id (see discussion)
Must Support | true
182. Medication.ingredient.item[x]:itemCodeableConcept.coding:snomed.code
Control | 1..?
Must Support | true
184. Medication.ingredient.item[x]:itemCodeableConcept.coding:snomed.display
Must Support | true
186. Medication.ingredient.item[x]:itemCodeableConcept.coding:pzn
Slice Name | pzn
Control | 0..*
Must Support | true
Pattern Value | `{ "system" : "http://fhir.de/CodeSystem/ifa/pzn" }`
188. Medication.ingredient.item[x]:itemCodeableConcept.coding:pzn.system
Control | 1..?
Must Support | true
190. Medication.ingredient.item[x]:itemCodeableConcept.coding:pzn.code
Control | 1..?
Must Support | true
192. Medication.ingredient.item[x]:itemCodeableConcept.coding:pzn.display
Must Support | true
194. Medication.ingredient.item[x]:itemCodeableConcept.text
Must Support | true
196. Medication.ingredient.item[x]:itemReference
Slice Name | itemReference
Short | Medication Ingredients can't have child Medications
Control | 0..0
Type | Reference(Medication)
Must Support | true
198. Medication.ingredient.isActive
Short | Is it an active ingredient?
200. Medication.ingredient.strength
Short | Strength
Must Support | true
202. Medication.ingredient.strength.extension:amountText
Slice Name | amountText
Control | 0..1
Type | Extension(MedicationIngredientAmountExtensions) (Extension Type: string)
204. Medication.ingredient.strength.extension:amountText.value[x]
[x] Note | SeeChoice of Data Typesfor further information about how to use [x]
Must Support | true
206. Medication.ingredient.strength.numerator
Binding | The codes SHOULD be taken from UCUMCodes (preferred to `http://hl7.org/fhir/ValueSet/ucum-units` )
Must Support | true
208. Medication.ingredient.strength.numerator.value
Control | 1..?
Must Support | true
210. Medication.ingredient.strength.numerator.unit
Must Support | true
212. Medication.ingredient.strength.numerator.system
Must Support | true
214. Medication.ingredient.strength.numerator.code
Must Support | true
216. Medication.ingredient.strength.denominator
Binding | The codes SHOULD be taken from UCUMCodes (preferred to `http://hl7.org/fhir/ValueSet/ucum-units` )
Must Support | true
218. Medication.ingredient.strength.denominator.value
Control | 1..?
Must Support | true
220. Medication.ingredient.strength.denominator.unit
Must Support | true
222. Medication.ingredient.strength.denominator.system
Must Support | true
224. Medication.ingredient.strength.denominator.code
Must Support | true
226. Medication.batch
Short | Batch Information
Must Support | true
228. Medication.batch.lotNumber
Short | Batch Number
Must Support | true

Guidance on how to interpret the contents of this table can be found here

0. Medication
Definition | This resource is primarily used for the identification and definition of a medication for the purposes of prescribing, dispensing, and administering a medication as well as for making statements about medication use.
Short | Definition of a Medication
Control | 0..*
Invariants | dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (`contained.contained.empty()`) dom-4: 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-3: 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-6: A resource should have narrative for robust management (`text.`div`.exists()`) dom-5: If a resource is contained in another resource, it SHALL NOT have a security label (`contained.meta.security.empty()`) epa-med-1: Medication code, name, or ingredients must be specified (`code.exists() or ingredient.exists()`)
2. Medication.id
Definition | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
Short | Logical id of this artifact
Comments | The only time that a resource does not have an id is when it is being submitted to the server using a create operation.
Control | 0..1
Type | id
Summary | true
4. Medication.meta
Definition | The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
Short | Metadata about the resource
Control | 0..1 This element is affected by the following invariants: ele-1
Type | Meta
Must Support | true
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
6. Medication.meta.id
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Short | Unique id for inter-element referencing
Control | 0..1
Type | string
XML Format | In the XML format, this property is represented as an attribute.
8. Medication.meta.extension
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Short | Additional content defined by implementations
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..* This element is affected by the following invariants: ele-1
Type | Extension
Standard Status | Normative (from Trial Use)
Alternate Names | extensions, user content
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
Slicing | This element introduces a set of slices on `Medication.meta.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
10. Medication.meta.versionId
Definition | The version specific identifier, as it appears in the version portion of the URL. This value changes when the resource is created, updated, or deleted.
Short | Version specific identifier
Comments | The server assigns this value, and ignores what the client specifies, except in the case that the server is imposing version integrity on updates/deletes.
Control | 0..1 This element is affected by the following invariants: ele-1
Type | id
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
12. Medication.meta.lastUpdated
Definition | When the resource last changed - e.g. when the version changed.
Short | When the resource version last changed
Comments | This value is always populated except when the resource is first being created. The server / resource manager sets this value; what a client provides is irrelevant. This is equivalent to the HTTP Last-Modified and SHOULD have the same value on a read interaction.
Control | 0..1 This element is affected by the following invariants: ele-1
Type | instant
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
14. Medication.meta.source
Definition | A uri that identifies the source system of the resource. This provides a minimal amount of Provenance information that can be used to track or differentiate the source of information in the resource. The source may identify another FHIR server, document, message, database, etc.
Short | Identifies where the resource comes from
Comments | In the provenance resource, this corresponds to Provenance.entity.what[x]. The exact use of the source (and the implied Provenance.entity.role) is left to implementer discretion. Only one nominated source is allowed; for additional provenance details, a full Provenance resource should be used. This element can be used to indicate where the current master source of a resource that has a canonical URL if the resource is no longer hosted at the canonical URL.
Control | 0..1 This element is affected by the following invariants: ele-1
Type | uri
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
16. Medication.meta.profile
Definition | A list of profiles (references to StructureDefinition resources) that this resource claims to conform to. The URL is a reference to StructureDefinition.url.
Short | Profiles this resource claims to conform to
Comments | It is up to the server and/or other infrastructure of policy to determine whether/how these claims are verified and/or updated over time. The list of profile URLs is a set.
Control | 0..* This element is affected by the following invariants: ele-1
Type | canonical(StructureDefinition)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
18. Medication.meta.security
Definition | Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure.
Short | Security Labels applied to this resource
Comments | The security labels can be updated without changing the stated version of the resource. The list of security labels is a set. Uniqueness is based the system/code, and version and display are ignored.
Control | 0..* This element is affected by the following invariants: ele-1
Binding | Unless not suitable, these codes SHALL be taken from All Security Labels (extensible to `http://hl7.org/fhir/ValueSet/security-labels` ) Security Labels from the Healthcare Privacy and Security Classification System.
Type | Coding
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
20. Medication.meta.tag
Definition | Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource.
Short | Tags applied to this resource
Comments | The tags can be updated without changing the stated version of the resource. The list of tags is a set. Uniqueness is based the system/code, and version and display are ignored.
Control | 0..* This element is affected by the following invariants: ele-1
Binding | For example codes, see CommonTags (example to `http://hl7.org/fhir/ValueSet/common-tags` ) Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
Type | Coding
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
22. Medication.implicitRules
Definition | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
Short | A set of rules under which this content was created
Comments | Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.
Control | 0..1 This element is affected by the following invariants: ele-1
Type | uri
Is Modifier | true because This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
24. Medication.language
Definition | The base language in which the resource is written.
Short | Language of the resource content
Comments | Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).
Control | 0..1 This element is affected by the following invariants: ele-1
Binding | The codes SHOULD be taken from CommonLanguages (preferred to `http://hl7.org/fhir/ValueSet/languages` ) A human language.
Additional Bindings | Purpose
AllLanguages | Max Binding
Type | code
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
26. Medication.text
Definition | A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
Short | Text summary of the resource, for human interpretation
Comments | Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.
Control | 0..1 This element is affected by the following invariants: ele-1
Type | Narrative
Alternate Names | narrative, html, xhtml, display
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
28. Medication.contained
Definition | These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
Short | Contained, inline Resources
Comments | This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.
Control | 0..0
Type | Resource
Alternate Names | inline resources, anonymous resources, contained resources
30. Medication.extension
Definition | May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Short | Additional content defined by implementations
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..* This element is affected by the following invariants: ele-1
Type | Extension
Standard Status | Normative (from Trial Use)
Alternate Names | extensions, user content
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
Slicing | This element introduces a set of slices on `Medication.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
32. Medication.extension:rxPrescriptionProcessIdentifier
Slice Name | rxPrescriptionProcessIdentifier
Definition | This extension is used to track medication prescription transactions between the E-Rezept-Fachdienst and the ePA. The RxPrescriptionProcessIdentifier is generated by the ePA Medication Service and consists of the PrescriptionId and the authoredOn date of the operation parameters request. It ensures consistent referencing and management of medication-related resources across different systems.
Short | Extension
Control | 0..1 This element is affected by the following invariants: ele-1
Type | Extension(RxPrescriptionProcessIdentifierExtension) (Extension Type: Identifier(RxPrescriptionProcessIdentifier))
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
34. Medication.extension:isVaccine
Slice Name | isVaccine
Definition | Indicator of whether this is a vaccine.
Short | Extension
Control | 0..1 This element is affected by the following invariants: ele-1
Type | Extension(MedicationIsVaccineExtension) (Extension Type: boolean)
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
36. Medication.extension:isVaccine.id
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Short | Unique id for inter-element referencing
Control | 0..1
Type | string
XML Format | In the XML format, this property is represented as an attribute.
38. Medication.extension:isVaccine.extension
Definition | An Extension
Short | Extension
Control | 0..0 This element is affected by the following invariants: ele-1
Type | Extension
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
Slicing | This element introduces a set of slices on `Medication.extension.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
40. Medication.extension:isVaccine.url
Definition | Source of the definition for the extension code - a logical name or a URL.
Short | identifies the meaning of the extension
Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.
Control | 1..1
Type | uri
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | `https://gematik.de/fhir/epa-medication/StructureDefinition/medication-is-vaccine-extension`
42. Medication.extension:isVaccine.value[x]
Definition | Indicator of whether this is a vaccine.. false - no vaccine (default value) true - vaccine
Short | Vaccine Indicator
Control | 1..1 This element is affected by the following invariants: ele-1
Type | boolean
[x] Note | SeeChoice of Data Typesfor further information about how to use [x]
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
44. Medication.extension:drugCategory
Slice Name | drugCategory
Definition | Extension for indicating the medication category.
Short | Extension
Control | 0..1 This element is affected by the following invariants: ele-1
Type | Extension(DrugCategoryExtension) (Extension Type: Coding)
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
46. Medication.extension:drugCategory.id
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Short | Unique id for inter-element referencing
Control | 0..1
Type | string
XML Format | In the XML format, this property is represented as an attribute.
48. Medication.extension:drugCategory.extension
Definition | An Extension
Short | Extension
Control | 0..0 This element is affected by the following invariants: ele-1
Type | Extension
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
Slicing | This element introduces a set of slices on `Medication.extension.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
50. Medication.extension:drugCategory.url
Definition | Source of the definition for the extension code - a logical name or a URL.
Short | identifies the meaning of the extension
Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.
Control | 1..1
Type | uri
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | `https://gematik.de/fhir/epa-medication/StructureDefinition/drug-category-extension`
52. Medication.extension:drugCategory.value[x]
Definition | Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).
Short | Value of extension
Control | 1..1 This element is affected by the following invariants: ele-1
Binding | The codes SHALL be taken from TI Drug Category ValueSet (required to `https://gematik.de/fhir/terminology/ValueSet/ti-drug-category-vs` )
Type | Coding
[x] Note | SeeChoice of Data Typesfor further information about how to use [x]
Must Support | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
54. Medication.extension:drugCategory.value[x].id
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Short | Unique id for inter-element referencing
Control | 0..1
Type | string
XML Format | In the XML format, this property is represented as an attribute.
56. Medication.extension:drugCategory.value[x].extension
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Short | Additional content defined by implementations
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..* This element is affected by the following invariants: ele-1
Type | Extension
Standard Status | Normative (from Trial Use)
Alternate Names | extensions, user content
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
Slicing | This element introduces a set of slices on `Medication.extension.value[x].extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
58. Medication.extension:drugCategory.value[x].system
Definition | The identification of the code system that defines the meaning of the symbol in the code.
Short | Identity of the terminology system
Comments | The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.
Control | 1..1 This element is affected by the following invariants: ele-1
Type | uri
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Summary | true
Requirements | Need to be unambiguous about the source of the definition of the symbol.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
60. Medication.extension:drugCategory.value[x].version
Definition | The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.
Short | Version of the system - if relevant
Comments | Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.
Note | This is a business version Id, not a resource version Id (see discussion)
Control | 0..1 This element is affected by the following invariants: ele-1
Type | string
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
62. Medication.extension:drugCategory.value[x].code
Definition | Drug Category
Short | Category
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size
Control | 1..1 This element is affected by the following invariants: ele-1
Type | code
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Summary | true
Requirements | Need to refer to a particular code in the system.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
64. Medication.extension:drugCategory.value[x].display
Definition | A representation of the meaning of the code in the system, following the rules of the system.
Short | Representation defined by the system
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size
Control | 0..1 This element is affected by the following invariants: ele-1
Type | string
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
66. Medication.extension:drugCategory.value[x].userSelected
Definition | Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).
Short | If this coding was chosen directly by the user
Comments | Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.
Control | 0..1 This element is affected by the following invariants: ele-1
Type | boolean
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Requirements | This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
68. Medication.extension:normSizeCode
Slice Name | normSizeCode
Definition | Description of the therapy-appropriate package size (e.g., N1)
Short | Package size according to N-designation
Control | 0..1 This element is affected by the following invariants: ele-1
Type | Extension(ExtensionNormgroesseDeBasis) (Extension Type: code)
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
70. Medication.extension:normSizeCode.id
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Short | Unique id for inter-element referencing
Control | 0..1
Type | string
XML Format | In the XML format, this property is represented as an attribute.
72. Medication.extension:normSizeCode.extension
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Short | Additional content defined by implementations
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..0 This element is affected by the following invariants: ele-1
Type | Extension
Standard Status | Normative (from Trial Use)
Alternate Names | extensions, user content
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
Slicing | This element introduces a set of slices on `Medication.extension.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
74. Medication.extension:normSizeCode.url
Definition | Source of the definition for the extension code - a logical name or a URL.
Short | identifies the meaning of the extension
Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.
Control | 1..1
Type | uri
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | `http://fhir.de/StructureDefinition/normgroesse`
76. Medication.extension:normSizeCode.value[x]
Definition | Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).
Short | Value of extension
Control | 0..1 This element is affected by the following invariants: ele-1
Binding | The codes SHALL be taken from https://fhir.kbv.de/ValueSet/KBV_VS_SFHIR_KBV_NORMGROESSE (required to `https://fhir.kbv.de/ValueSet/KBV_VS_SFHIR_KBV_NORMGROESSE` )
Type | code
[x] Note | SeeChoice of Data Typesfor further information about how to use [x]
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
78. Medication.extension:packaging
Slice Name | packaging
Definition | Information on the packaging of a formulation.
Short | Extension
Control | 0..1 This element is affected by the following invariants: ele-1
Type | Extension(MedicationFormulationPackagingExtension) (Extension Type: string)
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
80. Medication.extension:packaging.id
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Short | Unique id for inter-element referencing
Control | 0..1
Type | string
XML Format | In the XML format, this property is represented as an attribute.
82. Medication.extension:packaging.extension
Definition | An Extension
Short | Extension
Control | 0..0 This element is affected by the following invariants: ele-1
Type | Extension
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
Slicing | This element introduces a set of slices on `Medication.extension.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
84. Medication.extension:packaging.url
Definition | Source of the definition for the extension code - a logical name or a URL.
Short | identifies the meaning of the extension
Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.
Control | 1..1
Type | uri
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | `https://gematik.de/fhir/epa-medication/StructureDefinition/medication-formulation-packaging-extension`
86. Medication.extension:packaging.value[x]
Definition | Information on transport containers or packaging for a formulation.
Short | Packaging of a formulation.
Control | 1..1 This element is affected by the following invariants: ele-1
Type | string
[x] Note | SeeChoice of Data Typesfor further information about how to use [x]
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Max Length: | 90
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
88. Medication.extension:manufacturingInstructions
Slice Name | manufacturingInstructions
Definition | Manufacturing instructions regarding the preparation of a formulation (Subscriptio).
Short | Extension
Control | 0..1 This element is affected by the following invariants: ele-1
Type | Extension(MedicationManufacturingInstructionsExtension) (Extension Type: string)
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
90. Medication.extension:manufacturingInstructions.id
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Short | Unique id for inter-element referencing
Control | 0..1
Type | string
XML Format | In the XML format, this property is represented as an attribute.
92. Medication.extension:manufacturingInstructions.extension
Definition | An Extension
Short | Extension
Control | 0..0 This element is affected by the following invariants: ele-1
Type | Extension
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
Slicing | This element introduces a set of slices on `Medication.extension.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
94. Medication.extension:manufacturingInstructions.url
Definition | Source of the definition for the extension code - a logical name or a URL.
Short | identifies the meaning of the extension
Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.
Control | 1..1
Type | uri
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | `https://gematik.de/fhir/epa-medication/StructureDefinition/medication-manufacturing-instructions-extension`
96. Medication.extension:manufacturingInstructions.value[x]
Definition | Manufacturing instructions regarding the preparation of a formulation (Subscriptio).
Short | Manufacturing instructions for a formulation.
Control | 1..1 This element is affected by the following invariants: ele-1
Type | string
[x] Note | SeeChoice of Data Typesfor further information about how to use [x]
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Max Length: | 500
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
98. Medication.extension:type
Slice Name | type
Definition | Extension for EPAMedication types
Short | Medication Type
Control | 0..1 This element is affected by the following invariants: ele-1
Type | Extension(Medication Type) (Extension Type: Coding)
Must Support | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
100. Medication.extension:type.id
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Short | Unique id for inter-element referencing
Control | 0..1
Type | string
XML Format | In the XML format, this property is represented as an attribute.
102. Medication.extension:type.extension
Definition | An Extension
Short | Extension
Control | 0..0 This element is affected by the following invariants: ele-1
Type | Extension
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
Slicing | This element introduces a set of slices on `Medication.extension.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
104. Medication.extension:type.url
Definition | Source of the definition for the extension code - a logical name or a URL.
Short | identifies the meaning of the extension
Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.
Control | 1..1
Type | uri
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | `https://gematik.de/fhir/epa-medication/StructureDefinition/epa-medication-type-extension`
106. Medication.extension:type.value[x]
Definition | Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).
Short | Value of extension
Control | 1..1 This element is affected by the following invariants: ele-1
Binding | The codes SHALL be taken from TI Medication Type ValueSet for PZN-Medication (required to `https://gematik.de/fhir/terminology/ValueSet/ti-medication-type-product-vs` )
Type | Coding
[x] Note | SeeChoice of Data Typesfor further information about how to use [x]
Must Support | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
108. Medication.modifierExtension
Definition | May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Short | Extensions that cannot be ignored
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..* This element is affected by the following invariants: ele-1
Type | Extension
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them
Standard Status | Normative (from Trial Use)
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.
Alternate Names | extensions, user content
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
Slicing | This element introduces a set of slices on `Medication.modifierExtension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
110. Medication.identifier
Definition | Business identifier for this medication.
Short | Business identifier for this medication
Comments | The serial number could be included as an identifier.
Note | This is a business identifier, not a resource identifier (see discussion)
Control | 0..* This element is affected by the following invariants: ele-1
Type | Identifier
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
Slicing | This element introduces a set of slices on `Medication.identifier`. The slices areUnordered and Open, and can be differentiated using the following discriminators: pattern @ $this
112. Medication.identifier:EPAMedicationUniqueIdentifier
Slice Name | EPAMedicationUniqueIdentifier
Definition | Business identifier for this medication.
Short | Business identifier for this medication
Comments | The serial number could be included as an identifier.
Note | This is a business identifier, not a resource identifier (see discussion)
Control | 0..1 This element is affected by the following invariants: ele-1
Type | Identifier(Medication Unique Identifier)
Summary | true
Pattern Value | `{ "system" : "https://gematik.de/fhir/epa-medication/sid/epa-medication-unique-identifier" }`
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
114. Medication.identifier:RxOriginatorProcessIdentifier
Slice Name | RxOriginatorProcessIdentifier
Definition | Business identifier for this medication.
Short | Business identifier for this medication
Comments | The serial number could be included as an identifier.
Note | This is a business identifier, not a resource identifier (see discussion)
Control | 0..1 This element is affected by the following invariants: ele-1
Type | Identifier(RxOriginatorProcessIdentifier)
Summary | true
Pattern Value | `{ "system" : "https://gematik.de/fhir/epa-medication/sid/rx-originator-process-identifier" }`
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
116. Medication.code
Definition | A code (or set of codes) that specify this medication, or a textual description if no code is available. Usage note: This could be a standard medication code such as a code from RxNorm, SNOMED CT, IDMP etc. It could also be a national or local formulary code, optionally with translations to other code systems.
Short | Medication in coded form or as free text if necessary
Comments | Depending on the context of use, the code that was actually selected by the user (prescriber, dispenser, etc.) will have the coding.userSelected set to true. As described in the coding datatype: "A coding may be marked as a "userSelected" if a user selected the particular coded value in a user interface (e.g. the user selects an item in a pick-list). If a user selected coding exists, it is the preferred choice for performing translations etc. Other codes can only be literal translations to alternative code systems, or codes at a lower level of granularity (e.g. a generic code for a vendor-specific primary one).
Control | 0..1 This element is affected by the following invariants: ele-1
Binding | For example codes, see SNOMEDCTMedicationCodes (example to `http://hl7.org/fhir/ValueSet/medication-codes` ) A coded concept that defines the type of a medication.
Type | CodeableConcept
Must Support | true
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
118. Medication.code.id
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Short | Unique id for inter-element referencing
Control | 0..1
Type | string
XML Format | In the XML format, this property is represented as an attribute.
120. Medication.code.extension
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Short | Additional content defined by implementations
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..* This element is affected by the following invariants: ele-1
Type | Extension
Standard Status | Normative (from Trial Use)
Alternate Names | extensions, user content
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
Slicing | This element introduces a set of slices on `Medication.code.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
122. Medication.code.coding
Definition | A reference to a code defined by a terminology system.
Short | Code defined by a terminology system
Comments | Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.
Control | 1..* This element is affected by the following invariants: ele-1
Type | Coding
Must Support | true
Summary | true
Requirements | Allows for alternative encodings within a code system, and translations to other code systems.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
Slicing | This element introduces a set of slices on `Medication.code.coding`. The slices areUnordered and Open, and can be differentiated using the following discriminators: pattern @ $this
124. Medication.code.coding:pzn
Slice Name | pzn
Definition | A reference to a code defined by a terminology system.
Short | Code defined by a terminology system
Comments | Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.
Control | 1..1 This element is affected by the following invariants: ele-1
Type | Coding
Must Support | true
Summary | true
Requirements | Allows for alternative encodings within a code system, and translations to other code systems.
Pattern Value | `{ "system" : "http://fhir.de/CodeSystem/ifa/pzn" }`
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
126. Medication.code.coding:pzn.id
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Short | Unique id for inter-element referencing
Control | 0..1
Type | string
XML Format | In the XML format, this property is represented as an attribute.
128. Medication.code.coding:pzn.extension
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Short | Additional content defined by implementations
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..* This element is affected by the following invariants: ele-1
Type | Extension
Standard Status | Normative (from Trial Use)
Alternate Names | extensions, user content
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
Slicing | This element introduces a set of slices on `Medication.code.coding.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
130. Medication.code.coding:pzn.system
Definition | The identification of the code system that defines the meaning of the symbol in the code.
Short | Identity of the terminology system
Comments | The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.
Control | 1..1 This element is affected by the following invariants: ele-1
Type | uri
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Summary | true
Requirements | Need to be unambiguous about the source of the definition of the symbol.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
132. Medication.code.coding:pzn.version
Definition | The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.
Short | Version of the system - if relevant
Comments | Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.
Note | This is a business version Id, not a resource version Id (see discussion)
Control | 0..1 This element is affected by the following invariants: ele-1
Type | string
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
134. Medication.code.coding:pzn.code
Definition | A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).
Short | Symbol in syntax defined by the system
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size
Control | 1..1 This element is affected by the following invariants: ele-1
Type | code
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Summary | true
Requirements | Need to refer to a particular code in the system.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
136. Medication.code.coding:pzn.display
Definition | A representation of the meaning of the code in the system, following the rules of the system.
Short | Representation defined by the system
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size
Control | 0..1 This element is affected by the following invariants: ele-1
Type | string
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Summary | true
Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
138. Medication.code.coding:pzn.userSelected
Definition | Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).
Short | If this coding was chosen directly by the user
Comments | Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.
Control | 0..1 This element is affected by the following invariants: ele-1
Type | boolean
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Requirements | This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
140. Medication.code.coding:atc-de
Slice Name | atc-de
Definition | A reference to a code defined by a terminology system.
Short | Code defined by a terminology system
Comments | Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.
Control | 0..* This element is affected by the following invariants: ele-1
Type | Coding
Must Support | true
Summary | true
Requirements | Allows for alternative encodings within a code system, and translations to other code systems.
Pattern Value | `{ "system" : "http://fhir.de/CodeSystem/bfarm/atc" }`
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
142. Medication.code.coding:atc-de.id
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Short | Unique id for inter-element referencing
Control | 0..1
Type | string
XML Format | In the XML format, this property is represented as an attribute.
144. Medication.code.coding:atc-de.extension
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Short | Additional content defined by implementations
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..* This element is affected by the following invariants: ele-1
Type | Extension
Standard Status | Normative (from Trial Use)
Alternate Names | extensions, user content
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
Slicing | This element introduces a set of slices on `Medication.code.coding.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
146. Medication.code.coding:atc-de.system
Definition | The identification of the code system that defines the meaning of the symbol in the code.
Short | Identity of the terminology system
Comments | The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.
Control | 1..1 This element is affected by the following invariants: ele-1
Type | uri
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Summary | true
Requirements | Need to be unambiguous about the source of the definition of the symbol.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
148. Medication.code.coding:atc-de.version
Definition | The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.
Short | Version of the system - if relevant
Comments | Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.
Note | This is a business version Id, not a resource version Id (see discussion)
Control | 0..1 This element is affected by the following invariants: ele-1
Type | string
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
150. Medication.code.coding:atc-de.code
Definition | A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).
Short | Symbol in syntax defined by the system
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size
Control | 1..1 This element is affected by the following invariants: ele-1
Type | code
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Summary | true
Requirements | Need to refer to a particular code in the system.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
152. Medication.code.coding:atc-de.display
Definition | A representation of the meaning of the code in the system, following the rules of the system.
Short | Representation defined by the system
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size
Control | 0..1 This element is affected by the following invariants: ele-1
Type | string
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Summary | true
Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
154. Medication.code.coding:atc-de.userSelected
Definition | Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).
Short | If this coding was chosen directly by the user
Comments | Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.
Control | 0..1 This element is affected by the following invariants: ele-1
Type | boolean
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Requirements | This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
156. Medication.code.coding:ask
Slice Name | ask
Definition | A reference to a code defined by a terminology system.
Short | Code defined by a terminology system
Comments | Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.
Control | 0..* This element is affected by the following invariants: ele-1
Type | Coding
Must Support | true
Summary | true
Requirements | Allows for alternative encodings within a code system, and translations to other code systems.
Pattern Value | `{ "system" : "http://fhir.de/CodeSystem/ask" }`
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
158. Medication.code.coding:ask.id
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Short | Unique id for inter-element referencing
Control | 0..1
Type | string
XML Format | In the XML format, this property is represented as an attribute.
160. Medication.code.coding:ask.extension
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Short | Additional content defined by implementations
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..* This element is affected by the following invariants: ele-1
Type | Extension
Standard Status | Normative (from Trial Use)
Alternate Names | extensions, user content
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
Slicing | This element introduces a set of slices on `Medication.code.coding.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
162. Medication.code.coding:ask.system
Definition | The identification of the code system that defines the meaning of the symbol in the code.
Short | Identity of the terminology system
Comments | The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.
Control | 1..1 This element is affected by the following invariants: ele-1
Type | uri
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Summary | true
Requirements | Need to be unambiguous about the source of the definition of the symbol.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
164. Medication.code.coding:ask.version
Definition | The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.
Short | Version of the system - if relevant
Comments | Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.
Note | This is a business version Id, not a resource version Id (see discussion)
Control | 0..1 This element is affected by the following invariants: ele-1
Type | string
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
166. Medication.code.coding:ask.code
Definition | A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).
Short | Symbol in syntax defined by the system
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size
Control | 1..1 This element is affected by the following invariants: ele-1
Type | code
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Summary | true
Requirements | Need to refer to a particular code in the system.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
168. Medication.code.coding:ask.display
Definition | A representation of the meaning of the code in the system, following the rules of the system.
Short | Representation defined by the system
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size
Control | 0..1 This element is affected by the following invariants: ele-1
Type | string
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Summary | true
Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
170. Medication.code.coding:ask.userSelected
Definition | Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).
Short | If this coding was chosen directly by the user
Comments | Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.
Control | 0..1 This element is affected by the following invariants: ele-1
Type | boolean
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Requirements | This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
172. Medication.code.coding:snomed
Slice Name | snomed
Definition | A reference to a code defined by a terminology system.
Short | Code defined by a terminology system
Comments | Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.
Control | 0..* This element is affected by the following invariants: ele-1
Binding | Unless not suitable, these codes SHALL be taken from TI Arzneimittel SNOMED CT ValueSet (extensible to `https://gematik.de/fhir/terminology/ValueSet/ti-medication-snomed-ct-vs` )
Type | Coding
Summary | true
Requirements | Allows for alternative encodings within a code system, and translations to other code systems.
Pattern Value | `{ "system" : "http://snomed.info/sct" }`
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
174. Medication.code.coding:snomed.id
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Short | Unique id for inter-element referencing
Control | 0..1
Type | string
XML Format | In the XML format, this property is represented as an attribute.
176. Medication.code.coding:snomed.extension
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Short | Additional content defined by implementations
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..* This element is affected by the following invariants: ele-1
Type | Extension
Standard Status | Normative (from Trial Use)
Alternate Names | extensions, user content
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
Slicing | This element introduces a set of slices on `Medication.code.coding.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
178. Medication.code.coding:snomed.system
Definition | The identification of the code system that defines the meaning of the symbol in the code.
Short | Identity of the terminology system
Comments | The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.
Control | 1..1 This element is affected by the following invariants: ele-1
Type | uri
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Summary | true
Requirements | Need to be unambiguous about the source of the definition of the symbol.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
180. Medication.code.coding:snomed.version
Definition | The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.
Short | Version of the system - if relevant
Comments | Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.
Note | This is a business version Id, not a resource version Id (see discussion)
Control | 0..1 This element is affected by the following invariants: ele-1
Type | string
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
182. Medication.code.coding:snomed.code
Definition | A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).
Short | Symbol in syntax defined by the system
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size
Control | 1..1 This element is affected by the following invariants: ele-1
Type | code
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Summary | true
Requirements | Need to refer to a particular code in the system.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
184. Medication.code.coding:snomed.display
Definition | A representation of the meaning of the code in the system, following the rules of the system.
Short | Representation defined by the system
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size
Control | 0..1 This element is affected by the following invariants: ele-1
Type | string
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Summary | true
Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
186. Medication.code.coding:snomed.userSelected
Definition | Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).
Short | If this coding was chosen directly by the user
Comments | Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.
Control | 0..1 This element is affected by the following invariants: ele-1
Type | boolean
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Requirements | This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
188. Medication.code.text
Definition | A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.
Short | Plain text representation of the concept
Comments | Very often the text is the same as a displayName of one of the codings.
Control | 0..1 This element is affected by the following invariants: ele-1
Type | string
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Summary | true
Requirements | The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
190. Medication.status
Definition | A code to indicate if the medication is in active use.
Short | Status of Medication Information
Comments | This status is intended to identify if the medication in a local system is in active use within a drug database or inventory. For example, a pharmacy system may create a new drug file record for a compounded product "ABC Hospital Special Cream" with an active status. At some point in the future, it may be determined that the drug record was created with an error and the status is changed to "entered in error". This status is not intended to specify if a medication is part of a particular formulary. It is possible that the drug record may be referenced by multiple formularies or catalogues and each of those entries would have a separate status.
Control | 0..1 This element is affected by the following invariants: ele-1
Binding | The codes SHALL be taken from Medication Status Codes (required to `http://hl7.org/fhir/ValueSet/medication-status|4.0.1` ) A coded concept defining if the medication is in active use.
Type | code
Is Modifier | true because This element changes the interpretation of all descriptive attributes.
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
192. Medication.manufacturer
Definition | Describes the details of the manufacturer of the medication product. This is not intended to represent the distributor of a medication product.
Short | Manufacturer of the Medication
Comments | Here, the actual manufacturer of the medication can be named, primarily in the case of active ingredient mixtures (compounding prescriptions), such as the hospital pharmacy. It is important to note that the licensing organization, as mentioned in the PZN (Pharmaceutical Central Number) data, is not considered the manufacturer.
Control | 0..1 This element is affected by the following invariants: ele-1
Type | Reference(Organization)
Must Support | true
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ref-1: 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'))`)
194. Medication.manufacturer.id
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Short | Unique id for inter-element referencing
Control | 0..1
Type | string
XML Format | In the XML format, this property is represented as an attribute.
196. Medication.manufacturer.extension
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Short | Additional content defined by implementations
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..* This element is affected by the following invariants: ele-1
Type | Extension
Standard Status | Normative (from Trial Use)
Alternate Names | extensions, user content
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
Slicing | This element introduces a set of slices on `Medication.manufacturer.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
198. Medication.manufacturer.reference
Definition | A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.
Short | Literal reference, Relative, internal or absolute URL
Comments | Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server.
Control | 0..1 This element is affected by the following invariants: ele-1, ref-1
Type | string
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
200. Medication.manufacturer.type
Definition | The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent. The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).
Short | Type the reference refers to (e.g. "Patient")
Comments | This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified.
Control | 0..1 This element is affected by the following invariants: ele-1
Binding | Unless not suitable, these codes SHALL be taken from ResourceType (extensible to `http://hl7.org/fhir/ValueSet/resource-types` ) Aa resource (or, for logical models, the URI of the logical model).
Type | uri
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
202. Medication.manufacturer.identifier
Definition | An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.
Short | Logical reference, when literal reference is not known
Comments | When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it. Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any).
Note | This is a business identifier, not a resource identifier (see discussion)
Control | 0..1 This element is affected by the following invariants: ele-1
Type | Identifier
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
204. Medication.manufacturer.display
Definition | Plain text narrative that identifies the resource in addition to the resource reference.
Short | Text alternative for the resource
Comments | This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.
Control | 1..1 This element is affected by the following invariants: ele-1
Type | string
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
206. Medication.form
Definition | Describes the form of the item. Powder; tablets; capsule.
Short | Form of Dispensing
Comments | When Medication is referenced from MedicationRequest, this is the ordered form. When Medication is referenced within MedicationDispense, this is the dispensed form. When Medication is referenced within MedicationAdministration, this is administered form.
Control | 0..1 This element is affected by the following invariants: ele-1
Binding | For example codes, see SNOMEDCTFormCodes (example to `http://hl7.org/fhir/ValueSet/medication-form-codes` ) A coded concept defining the form of a medication.
Type | CodeableConcept
Must Support | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
208. Medication.form.id
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Short | Unique id for inter-element referencing
Control | 0..1
Type | string
XML Format | In the XML format, this property is represented as an attribute.
210. Medication.form.extension
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Short | Additional content defined by implementations
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..* This element is affected by the following invariants: ele-1
Type | Extension
Standard Status | Normative (from Trial Use)
Alternate Names | extensions, user content
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
Slicing | This element introduces a set of slices on `Medication.form.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
212. Medication.form.coding
Definition | A reference to a code defined by a terminology system.
Short | Code defined by a terminology system
Comments | Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.
Control | 0..* This element is affected by the following invariants: ele-1
Type | Coding
Must Support | true
Summary | true
Requirements | Allows for alternative encodings within a code system, and translations to other code systems.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
Slicing | This element introduces a set of slices on `Medication.form.coding`. The slices areUnordered and Open, and can be differentiated using the following discriminators: pattern @ $this
214. Medication.form.coding:edqm
Slice Name | edqm
Definition | A reference to a code defined by a terminology system.
Short | Code defined by a terminology system
Comments | Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.
Control | 0..* This element is affected by the following invariants: ele-1
Binding | The codes SHOULD be taken from Medicine Doseform - IPS (preferred to `http://hl7.org/fhir/uv/ips/ValueSet/medicine-doseform` )
Type | Coding
Must Support | true
Summary | true
Requirements | Allows for alternative encodings within a code system, and translations to other code systems.
Pattern Value | `{ "system" : "http://standardterms.edqm.eu" }`
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
216. Medication.form.coding:edqm.id
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Short | Unique id for inter-element referencing
Control | 0..1
Type | string
XML Format | In the XML format, this property is represented as an attribute.
218. Medication.form.coding:edqm.extension
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Short | Additional content defined by implementations
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..* This element is affected by the following invariants: ele-1
Type | Extension
Standard Status | Normative (from Trial Use)
Alternate Names | extensions, user content
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
Slicing | This element introduces a set of slices on `Medication.form.coding.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
220. Medication.form.coding:edqm.system
Definition | The identification of the code system that defines the meaning of the symbol in the code.
Short | Identity of the terminology system
Comments | The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.
Control | 1..1 This element is affected by the following invariants: ele-1
Type | uri
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Summary | true
Requirements | Need to be unambiguous about the source of the definition of the symbol.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
222. Medication.form.coding:edqm.version
Definition | The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.
Short | Version of the system - if relevant
Comments | Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.
Note | This is a business version Id, not a resource version Id (see discussion)
Control | 0..1 This element is affected by the following invariants: ele-1
Type | string
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
224. Medication.form.coding:edqm.code
Definition | A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).
Short | Symbol in syntax defined by the system
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size
Control | 1..1 This element is affected by the following invariants: ele-1
Type | code
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Summary | true
Requirements | Need to refer to a particular code in the system.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
226. Medication.form.coding:edqm.display
Definition | A representation of the meaning of the code in the system, following the rules of the system.
Short | Representation defined by the system
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size
Control | 0..1 This element is affected by the following invariants: ele-1
Type | string
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Summary | true
Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
228. Medication.form.coding:edqm.userSelected
Definition | Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).
Short | If this coding was chosen directly by the user
Comments | Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.
Control | 0..1 This element is affected by the following invariants: ele-1
Type | boolean
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Requirements | This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
230. Medication.form.coding:snomed
Slice Name | snomed
Definition | A reference to a code defined by a terminology system.
Short | Code defined by a terminology system
Comments | Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.
Control | 0..* This element is affected by the following invariants: ele-1
Binding | The codes SHOULD be taken from Value Set Darreichungsform SNOMED CT (preferred to `https://gematik.de/fhir/terminology/ValueSet/ti-medicine-form-snomed-ct-vs` )
Type | Coding
Summary | true
Requirements | Allows for alternative encodings within a code system, and translations to other code systems.
Pattern Value | `{ "system" : "http://snomed.info/sct" }`
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
232. Medication.form.coding:snomed.id
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Short | Unique id for inter-element referencing
Control | 0..1
Type | string
XML Format | In the XML format, this property is represented as an attribute.
234. Medication.form.coding:snomed.extension
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Short | Additional content defined by implementations
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..* This element is affected by the following invariants: ele-1
Type | Extension
Standard Status | Normative (from Trial Use)
Alternate Names | extensions, user content
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
Slicing | This element introduces a set of slices on `Medication.form.coding.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
236. Medication.form.coding:snomed.system
Definition | The identification of the code system that defines the meaning of the symbol in the code.
Short | Identity of the terminology system
Comments | The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.
Control | 1..1 This element is affected by the following invariants: ele-1
Type | uri
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Summary | true
Requirements | Need to be unambiguous about the source of the definition of the symbol.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
238. Medication.form.coding:snomed.version
Definition | The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.
Short | Version of the system - if relevant
Comments | Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.
Note | This is a business version Id, not a resource version Id (see discussion)
Control | 0..1 This element is affected by the following invariants: ele-1
Type | string
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
240. Medication.form.coding:snomed.code
Definition | A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).
Short | Symbol in syntax defined by the system
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size
Control | 1..1 This element is affected by the following invariants: ele-1
Type | code
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Summary | true
Requirements | Need to refer to a particular code in the system.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
242. Medication.form.coding:snomed.display
Definition | A representation of the meaning of the code in the system, following the rules of the system.
Short | Representation defined by the system
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size
Control | 0..1 This element is affected by the following invariants: ele-1
Type | string
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Summary | true
Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
244. Medication.form.coding:snomed.userSelected
Definition | Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).
Short | If this coding was chosen directly by the user
Comments | Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.
Control | 0..1 This element is affected by the following invariants: ele-1
Type | boolean
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Requirements | This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
246. Medication.form.coding:kbvDarreichungsform
Slice Name | kbvDarreichungsform
Definition | A reference to a code defined by a terminology system.
Short | Code defined by a terminology system
Comments | KBV updates its "Schüsseltabellen" package more often than ePA versions get released. However, the eRezept clients and eRezept service take over new KBV package versions quickly after release and thus hands them over to the ePA Medication Service. Since the Medication Service is potentially fixed onto an older version of the KBV package, it would reject the forwarded eRezept data. In the future, the Medication Service will be enabled to update to the latest KBV package versions without the need for a new ePA release. Since the eRezept does check the codes against the latest KBV package version, the Medication Service will not receive any "invalid" codes and clients can rely on the Medication Service data conforming to the latest KBV package.
Control | 0..* This element is affected by the following invariants: ele-1
Binding | The codes SHALL be taken from https://fhir.kbv.de/ValueSet/KBV_VS_SFHIR_KBV_DARREICHUNGSFORM (required to `https://fhir.kbv.de/ValueSet/KBV_VS_SFHIR_KBV_DARREICHUNGSFORM` )
Type | Coding
Must Support | true
Summary | true
Requirements | Allows for alternative encodings within a code system, and translations to other code systems.
Pattern Value | `{ "system" : "https://fhir.kbv.de/CodeSystem/KBV_CS_SFHIR_KBV_DARREICHUNGSFORM" }`
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
248. Medication.form.coding:kbvDarreichungsform.id
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Short | Unique id for inter-element referencing
Control | 0..1
Type | string
XML Format | In the XML format, this property is represented as an attribute.
250. Medication.form.coding:kbvDarreichungsform.extension
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Short | Additional content defined by implementations
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..* This element is affected by the following invariants: ele-1
Type | Extension
Standard Status | Normative (from Trial Use)
Alternate Names | extensions, user content
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
Slicing | This element introduces a set of slices on `Medication.form.coding.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
252. Medication.form.coding:kbvDarreichungsform.system
Definition | The identification of the code system that defines the meaning of the symbol in the code.
Short | Identity of the terminology system
Comments | The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.
Control | 1..1 This element is affected by the following invariants: ele-1
Type | uri
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Summary | true
Requirements | Need to be unambiguous about the source of the definition of the symbol.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
254. Medication.form.coding:kbvDarreichungsform.version
Definition | The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.
Short | Version of the system - if relevant
Comments | Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.
Note | This is a business version Id, not a resource version Id (see discussion)
Control | 0..1 This element is affected by the following invariants: ele-1
Type | string
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
256. Medication.form.coding:kbvDarreichungsform.code
Definition | A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).
Short | Symbol in syntax defined by the system
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size
Control | 1..1 This element is affected by the following invariants: ele-1
Type | code
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Summary | true
Requirements | Need to refer to a particular code in the system.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
258. Medication.form.coding:kbvDarreichungsform.display
Definition | A representation of the meaning of the code in the system, following the rules of the system.
Short | Representation defined by the system
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size
Control | 0..1 This element is affected by the following invariants: ele-1
Type | string
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Summary | true
Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
260. Medication.form.coding:kbvDarreichungsform.userSelected
Definition | Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).
Short | If this coding was chosen directly by the user
Comments | Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.
Control | 0..1 This element is affected by the following invariants: ele-1
Type | boolean
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Requirements | This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
262. Medication.form.text
Definition | A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.
Short | Plain text representation of the concept
Comments | Very often the text is the same as a displayName of one of the codings.
Control | 0..1 This element is affected by the following invariants: ele-1
Type | string
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Requirements | The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
264. Medication.amount
Definition | Specific amount of the drug in the packaged product. For example, when specifying a product that has the same strength (For example, Insulin glargine 100 unit per mL solution for injection), this attribute provides additional clarification of the package amount (For example, 3 mL, 10mL, etc.).
Short | Amount of drug in package
Comments | The Ratio datatype should only be used to express a relationship of two numbers if the relationship cannot be suitably expressed using a Quantity and a common unit. Where the denominator value is known to be fixed to "1", Quantity should be used instead of Ratio.
Control | 0..1 This element is affected by the following invariants: ele-1
Type | Ratio
Must Support | true
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) rat-1: 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())`)
266. Medication.amount.id
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Short | Unique id for inter-element referencing
Control | 0..1
Type | string
XML Format | In the XML format, this property is represented as an attribute.
268. Medication.amount.extension
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Short | Additional content defined by implementations
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..* This element is affected by the following invariants: ele-1
Type | Extension
Standard Status | Normative (from Trial Use)
Alternate Names | extensions, user content
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
Slicing | This element introduces a set of slices on `Medication.amount.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
270. Medication.amount.numerator
Definition | The value of the numerator.
Short | Numerator value
Comments | The context of use may frequently define what kind of quantity this is and therefore what kind of units can be used. The context of use may also restrict the values for the comparator.
Control | 0..1 This element is affected by the following invariants: ele-1
Binding | The codes SHOULD be taken from UCUMCodes (preferred to `http://hl7.org/fhir/ValueSet/ucum-units` )
Type | Quantity
Must Support | true
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) qty-3: If a code for the unit is present, the system SHALL also be present (`code.empty() or system.exists()`)
272. Medication.amount.numerator.id
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Short | Unique id for inter-element referencing
Control | 0..1
Type | string
XML Format | In the XML format, this property is represented as an attribute.
274. Medication.amount.numerator.extension
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Short | Additional content defined by implementations
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..* This element is affected by the following invariants: ele-1
Type | Extension
Standard Status | Normative (from Trial Use)
Alternate Names | extensions, user content
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
Slicing | This element introduces a set of slices on `Medication.amount.numerator.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
276. Medication.amount.numerator.extension:packagingSize
Slice Name | packagingSize
Definition | Specification of the package size according to divided quantity (e.g., 100, 2x25), only appears in conjunction with "unit" (e.g., 100 Stück).
Short | Extension
Control | 0..1 This element is affected by the following invariants: ele-1
Type | Extension(MedicationPackagingSizeExtension) (Extension Type: string)
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
278. Medication.amount.numerator.extension:packagingSize.id
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Short | Unique id for inter-element referencing
Control | 0..1
Type | string
XML Format | In the XML format, this property is represented as an attribute.
280. Medication.amount.numerator.extension:packagingSize.extension
Definition | An Extension
Short | Extension
Control | 0..0 This element is affected by the following invariants: ele-1
Type | Extension
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
Slicing | This element introduces a set of slices on `Medication.amount.numerator.extension.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
282. Medication.amount.numerator.extension:packagingSize.url
Definition | Source of the definition for the extension code - a logical name or a URL.
Short | identifies the meaning of the extension
Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.
Control | 1..1
Type | uri
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | `https://gematik.de/fhir/epa-medication/StructureDefinition/medication-packaging-size-extension`
284. Medication.amount.numerator.extension:packagingSize.value[x]
Definition | Specification of the package size according to divided quantity (e.g., 100, 2x25), only appears in conjunction with "unit" (e.g., 100 Stück).
Short | Package size according to divided quantity
Control | 1..1 This element is affected by the following invariants: ele-1
Type | string
[x] Note | SeeChoice of Data Typesfor further information about how to use [x]
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Max Length: | 7
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
286. Medication.amount.numerator.extension:totalQuantity
Slice Name | totalQuantity
Definition | Total quantity of the formulation (without the unit).
Short | Extension
Control | 0..1 This element is affected by the following invariants: ele-1
Type | Extension(MedicationTotalQuantityFormulationExtension) (Extension Type: string)
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
288. Medication.amount.numerator.extension:totalQuantity.id
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Short | Unique id for inter-element referencing
Control | 0..1
Type | string
XML Format | In the XML format, this property is represented as an attribute.
290. Medication.amount.numerator.extension:totalQuantity.extension
Definition | An Extension
Short | Extension
Control | 0..0 This element is affected by the following invariants: ele-1
Type | Extension
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
Slicing | This element introduces a set of slices on `Medication.amount.numerator.extension.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
292. Medication.amount.numerator.extension:totalQuantity.url
Definition | Source of the definition for the extension code - a logical name or a URL.
Short | identifies the meaning of the extension
Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.
Control | 1..1
Type | uri
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | `https://gematik.de/fhir/epa-medication/StructureDefinition/medication-total-quantity-formulation-extension`
294. Medication.amount.numerator.extension:totalQuantity.value[x]
Definition | Total quantity of the formulation (without the unit).
Short | Total quantity of the formulation.
Control | 1..1 This element is affected by the following invariants: ele-1
Type | string
[x] Note | SeeChoice of Data Typesfor further information about how to use [x]
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Max Length: | 7
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
296. Medication.amount.numerator.value
Definition | The value of the measured amount. The value includes an implicit precision in the presentation of the value.
Short | Numerical value (with implicit precision)
Comments | The implicit precision in the value should always be honored. Monetary values have their own rules for handling precision (refer to standard accounting text books).
Control | 0..1 This element is affected by the following invariants: ele-1
Type | decimal
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Summary | true
Requirements | Precision is handled implicitly in almost all cases of measurement.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
298. Medication.amount.numerator.comparator
Definition | How the value should be understood and represented - whether the actual value is greater or less than the stated value due to measurement issues; e.g. if the comparator is "<" , then the real value is < stated value.
Short | < | <= | >= | > - how to understand the value
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size
Control | 0..1 This element is affected by the following invariants: ele-1
Binding | The codes SHALL be taken from QuantityComparator (required to `http://hl7.org/fhir/ValueSet/quantity-comparator|4.0.1` ) How the Quantity should be understood and represented.
Type | code
Is Modifier | true because This is labeled as "Is Modifier" because the comparator modifies the interpretation of the value significantly. If there is no comparator, then there is no modification of the value
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Requirements | Need a framework for handling measures where the value is <5ug/L or >400mg/L due to the limitations of measuring methodology.
Meaning if Missing | If there is no comparator, then there is no modification of the value
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
300. Medication.amount.numerator.unit
Definition | A human-readable form of the unit.
Short | Unit representation
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size
Control | 0..1 This element is affected by the following invariants: ele-1
Type | string
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Summary | true
Requirements | There are many representations for units of measure and in many contexts, particular representations are fixed and required. I.e. mcg for micrograms.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
302. Medication.amount.numerator.system
Definition | The identification of the system that provides the coded form of the unit.
Short | System that defines coded unit form
Comments | see http://en.wikipedia.org/wiki/Uniform_resource_identifier
Control | 0..1 This element is affected by the following invariants: ele-1, qty-3
Type | uri
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Summary | true
Requirements | Need to know the system that defines the coded form of the unit.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
304. Medication.amount.numerator.code
Definition | A computer processable form of the unit in some unit representation system.
Short | Coded form of the unit
Comments | The preferred system is UCUM, but SNOMED CT can also be used (for customary units) or ISO 4217 for currency. The context of use may additionally require a code from a particular system.
Control | 0..1 This element is affected by the following invariants: ele-1
Type | code
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Summary | true
Requirements | Need a computable form of the unit that is fixed across all forms. UCUM provides this for quantities, but SNOMED CT provides many units of interest.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
306. Medication.amount.denominator
Definition | The value of the denominator.
Short | Denominator value
Comments | The context of use may frequently define what kind of quantity this is and therefore what kind of units can be used. The context of use may also restrict the values for the comparator.
Control | 0..1 This element is affected by the following invariants: ele-1
Binding | The codes SHOULD be taken from UCUMCodes (preferred to `http://hl7.org/fhir/ValueSet/ucum-units` )
Type | Quantity
Must Support | true
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) qty-3: If a code for the unit is present, the system SHALL also be present (`code.empty() or system.exists()`)
308. Medication.amount.denominator.id
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Short | Unique id for inter-element referencing
Control | 0..1
Type | string
XML Format | In the XML format, this property is represented as an attribute.
310. Medication.amount.denominator.extension
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Short | Additional content defined by implementations
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..* This element is affected by the following invariants: ele-1
Type | Extension
Standard Status | Normative (from Trial Use)
Alternate Names | extensions, user content
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
Slicing | This element introduces a set of slices on `Medication.amount.denominator.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
312. Medication.amount.denominator.value
Definition | The value of the measured amount. The value includes an implicit precision in the presentation of the value.
Short | Numerical value (with implicit precision)
Comments | The implicit precision in the value should always be honored. Monetary values have their own rules for handling precision (refer to standard accounting text books).
Control | 0..1 This element is affected by the following invariants: ele-1
Type | decimal
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Summary | true
Requirements | Precision is handled implicitly in almost all cases of measurement.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
314. Medication.amount.denominator.comparator
Definition | How the value should be understood and represented - whether the actual value is greater or less than the stated value due to measurement issues; e.g. if the comparator is "<" , then the real value is < stated value.
Short | < | <= | >= | > - how to understand the value
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size
Control | 0..1 This element is affected by the following invariants: ele-1
Binding | The codes SHALL be taken from QuantityComparator (required to `http://hl7.org/fhir/ValueSet/quantity-comparator|4.0.1` ) How the Quantity should be understood and represented.
Type | code
Is Modifier | true because This is labeled as "Is Modifier" because the comparator modifies the interpretation of the value significantly. If there is no comparator, then there is no modification of the value
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Requirements | Need a framework for handling measures where the value is <5ug/L or >400mg/L due to the limitations of measuring methodology.
Meaning if Missing | If there is no comparator, then there is no modification of the value
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
316. Medication.amount.denominator.unit
Definition | A human-readable form of the unit.
Short | Unit representation
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size
Control | 0..1 This element is affected by the following invariants: ele-1
Type | string
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Summary | true
Requirements | There are many representations for units of measure and in many contexts, particular representations are fixed and required. I.e. mcg for micrograms.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
318. Medication.amount.denominator.system
Definition | The identification of the system that provides the coded form of the unit.
Short | System that defines coded unit form
Comments | see http://en.wikipedia.org/wiki/Uniform_resource_identifier
Control | 0..1 This element is affected by the following invariants: ele-1, qty-3
Type | uri
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Summary | true
Requirements | Need to know the system that defines the coded form of the unit.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
320. Medication.amount.denominator.code
Definition | A computer processable form of the unit in some unit representation system.
Short | Coded form of the unit
Comments | The preferred system is UCUM, but SNOMED CT can also be used (for customary units) or ISO 4217 for currency. The context of use may additionally require a code from a particular system.
Control | 0..1 This element is affected by the following invariants: ele-1
Type | code
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Summary | true
Requirements | Need a computable form of the unit that is fixed across all forms. UCUM provides this for quantities, but SNOMED CT provides many units of interest.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
322. Medication.ingredient
Definition | Identifies a particular constituent of interest in the product.
Short | Active or inactive ingredients of the medication, including pharmaceutical substances as well as individual medicinal products in combination packs.
Comments | The ingredients need not be a complete list. If an ingredient is not specified, this does not indicate whether an ingredient is present or absent. If an ingredient is specified it does not mean that all ingredients are specified. It is possible to specify both inactive and active ingredients.
Control | 0..* This element is affected by the following invariants: ele-1
Type | BackboneElement
Must Support | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
324. Medication.ingredient.id
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Short | Unique id for inter-element referencing
Control | 0..1
Type | string
XML Format | In the XML format, this property is represented as an attribute.
326. Medication.ingredient.extension
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Short | Additional content defined by implementations
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..* This element is affected by the following invariants: ele-1
Type | Extension
Standard Status | Normative (from Trial Use)
Alternate Names | extensions, user content
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
Slicing | This element introduces a set of slices on `Medication.ingredient.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
328. Medication.ingredient.extension:darreichungsform
Slice Name | darreichungsform
Definition | Dosage form of an ingredient in a formulation.
Short | Extension
Control | 0..1 This element is affected by the following invariants: ele-1
Type | Extension(MedicationIngredientDarreichungsformExtension) (Extension Type: string)
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
330. Medication.ingredient.modifierExtension
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Short | Extensions that cannot be ignored even if unrecognized
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..* This element is affected by the following invariants: ele-1
Type | Extension
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summary | true
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.
Alternate Names | extensions, user content, modifiers
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
332. Medication.ingredient.item[x]
Definition | The actual ingredient - either a substance (simple ingredient) or another medication of a medication.
Short | The actual ingredient or content
Control | 1..1 This element is affected by the following invariants: ele-1
Type | CodeableConcept
[x] Note | SeeChoice of Data Typesfor further information about how to use [x]
Must Support | true
Requirements | The ingredient may reference a substance (for example, amoxicillin) or another medication (for example in the case of a compounded product, Glaxal Base).
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
Slicing | This element introduces a set of slices on `Medication.ingredient.item[x]`. The slices areUnordered and Closed, and can be differentiated using the following discriminators: type @ $this
334. Medication.ingredient.item[x]:itemCodeableConcept
Slice Name | itemCodeableConcept
Definition | The actual ingredient - either a substance (simple ingredient) or another medication of a medication.
Short | Encoded description of the substance or component.
Control | 0..1 This element is affected by the following invariants: ele-1
Type | CodeableConcept
[x] Note | SeeChoice of Data Typesfor further information about how to use [x]
Must Support | true
Requirements | The ingredient may reference a substance (for example, amoxicillin) or another medication (for example in the case of a compounded product, Glaxal Base).
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
336. Medication.ingredient.item[x]:itemCodeableConcept.id
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Short | Unique id for inter-element referencing
Control | 0..1
Type | string
XML Format | In the XML format, this property is represented as an attribute.
338. Medication.ingredient.item[x]:itemCodeableConcept.extension
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Short | Additional content defined by implementations
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..* This element is affected by the following invariants: ele-1
Type | Extension
Standard Status | Normative (from Trial Use)
Alternate Names | extensions, user content
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
Slicing | This element introduces a set of slices on `Medication.ingredient.item[x].extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
340. Medication.ingredient.item[x]:itemCodeableConcept.coding
Definition | A reference to a code defined by a terminology system.
Short | Code defined by a terminology system
Comments | Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.
Control | 0..* This element is affected by the following invariants: ele-1
Type | Coding
Must Support | true
Summary | true
Requirements | Allows for alternative encodings within a code system, and translations to other code systems.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
Slicing | This element introduces a set of slices on `Medication.ingredient.item[x].coding`. The slices areUnordered and Open, and can be differentiated using the following discriminators: pattern @ $this
342. Medication.ingredient.item[x]:itemCodeableConcept.coding:ask
Slice Name | ask
Definition | A reference to a code defined by a terminology system.
Short | Code defined by a terminology system
Comments | Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.
Control | 0..* This element is affected by the following invariants: ele-1
Type | Coding
Must Support | true
Summary | true
Requirements | Allows for alternative encodings within a code system, and translations to other code systems.
Pattern Value | `{ "system" : "http://fhir.de/CodeSystem/ask" }`
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
344. Medication.ingredient.item[x]:itemCodeableConcept.coding:ask.id
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Short | Unique id for inter-element referencing
Control | 0..1
Type | string
XML Format | In the XML format, this property is represented as an attribute.
346. Medication.ingredient.item[x]:itemCodeableConcept.coding:ask.extension
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Short | Additional content defined by implementations
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..* This element is affected by the following invariants: ele-1
Type | Extension
Standard Status | Normative (from Trial Use)
Alternate Names | extensions, user content
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
Slicing | This element introduces a set of slices on `Medication.ingredient.item[x].coding.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
348. Medication.ingredient.item[x]:itemCodeableConcept.coding:ask.system
Definition | The identification of the code system that defines the meaning of the symbol in the code.
Short | Identity of the terminology system
Comments | The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.
Control | 1..1 This element is affected by the following invariants: ele-1
Type | uri
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Summary | true
Requirements | Need to be unambiguous about the source of the definition of the symbol.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
350. Medication.ingredient.item[x]:itemCodeableConcept.coding:ask.version
Definition | The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.
Short | Version of the system - if relevant
Comments | Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.
Note | This is a business version Id, not a resource version Id (see discussion)
Control | 0..1 This element is affected by the following invariants: ele-1
Type | string
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
352. Medication.ingredient.item[x]:itemCodeableConcept.coding:ask.code
Definition | A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).
Short | Symbol in syntax defined by the system
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size
Control | 1..1 This element is affected by the following invariants: ele-1
Type | code
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Summary | true
Requirements | Need to refer to a particular code in the system.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
354. Medication.ingredient.item[x]:itemCodeableConcept.coding:ask.display
Definition | A representation of the meaning of the code in the system, following the rules of the system.
Short | Representation defined by the system
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size
Control | 0..1 This element is affected by the following invariants: ele-1
Type | string
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Summary | true
Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
356. Medication.ingredient.item[x]:itemCodeableConcept.coding:ask.userSelected
Definition | Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).
Short | If this coding was chosen directly by the user
Comments | Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.
Control | 0..1 This element is affected by the following invariants: ele-1
Type | boolean
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Requirements | This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
358. Medication.ingredient.item[x]:itemCodeableConcept.coding:atc-de
Slice Name | atc-de
Definition | A reference to a code defined by a terminology system.
Short | Code defined by a terminology system
Comments | Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.
Control | 0..* This element is affected by the following invariants: ele-1
Type | Coding
Must Support | true
Summary | true
Requirements | Allows for alternative encodings within a code system, and translations to other code systems.
Pattern Value | `{ "system" : "http://fhir.de/CodeSystem/bfarm/atc" }`
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
360. Medication.ingredient.item[x]:itemCodeableConcept.coding:atc-de.id
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Short | Unique id for inter-element referencing
Control | 0..1
Type | string
XML Format | In the XML format, this property is represented as an attribute.
362. Medication.ingredient.item[x]:itemCodeableConcept.coding:atc-de.extension
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Short | Additional content defined by implementations
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..* This element is affected by the following invariants: ele-1
Type | Extension
Standard Status | Normative (from Trial Use)
Alternate Names | extensions, user content
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
Slicing | This element introduces a set of slices on `Medication.ingredient.item[x].coding.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
364. Medication.ingredient.item[x]:itemCodeableConcept.coding:atc-de.system
Definition | The identification of the code system that defines the meaning of the symbol in the code.
Short | Identity of the terminology system
Comments | The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.
Control | 1..1 This element is affected by the following invariants: ele-1
Type | uri
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Summary | true
Requirements | Need to be unambiguous about the source of the definition of the symbol.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
366. Medication.ingredient.item[x]:itemCodeableConcept.coding:atc-de.version
Definition | The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.
Short | Version of the system - if relevant
Comments | Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.
Note | This is a business version Id, not a resource version Id (see discussion)
Control | 0..1 This element is affected by the following invariants: ele-1
Type | string
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
368. Medication.ingredient.item[x]:itemCodeableConcept.coding:atc-de.code
Definition | A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).
Short | Symbol in syntax defined by the system
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size
Control | 1..1 This element is affected by the following invariants: ele-1
Type | code
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Summary | true
Requirements | Need to refer to a particular code in the system.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
370. Medication.ingredient.item[x]:itemCodeableConcept.coding:atc-de.display
Definition | A representation of the meaning of the code in the system, following the rules of the system.
Short | Representation defined by the system
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size
Control | 0..1 This element is affected by the following invariants: ele-1
Type | string
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Summary | true
Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
372. Medication.ingredient.item[x]:itemCodeableConcept.coding:atc-de.userSelected
Definition | Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).
Short | If this coding was chosen directly by the user
Comments | Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.
Control | 0..1 This element is affected by the following invariants: ele-1
Type | boolean
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Requirements | This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
374. Medication.ingredient.item[x]:itemCodeableConcept.coding:snomed
Slice Name | snomed
Definition | A reference to a code defined by a terminology system.
Short | Code defined by a terminology system
Comments | Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.
Control | 0..* This element is affected by the following invariants: ele-1
Binding | The codes SHOULD be taken from TI Substance SNOMED CT ValueSet (preferred to `https://gematik.de/fhir/terminology/ValueSet/ti-substance-snomed-ct-vs` )
Type | Coding
Summary | true
Requirements | Allows for alternative encodings within a code system, and translations to other code systems.
Pattern Value | `{ "system" : "http://snomed.info/sct" }`
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
376. Medication.ingredient.item[x]:itemCodeableConcept.coding:snomed.id
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Short | Unique id for inter-element referencing
Control | 0..1
Type | string
XML Format | In the XML format, this property is represented as an attribute.
378. Medication.ingredient.item[x]:itemCodeableConcept.coding:snomed.extension
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Short | Additional content defined by implementations
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..* This element is affected by the following invariants: ele-1
Type | Extension
Standard Status | Normative (from Trial Use)
Alternate Names | extensions, user content
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
Slicing | This element introduces a set of slices on `Medication.ingredient.item[x].coding.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
380. Medication.ingredient.item[x]:itemCodeableConcept.coding:snomed.system
Definition | The identification of the code system that defines the meaning of the symbol in the code.
Short | Identity of the terminology system
Comments | The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.
Control | 1..1 This element is affected by the following invariants: ele-1
Type | uri
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Summary | true
Requirements | Need to be unambiguous about the source of the definition of the symbol.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
382. Medication.ingredient.item[x]:itemCodeableConcept.coding:snomed.version
Definition | The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.
Short | Version of the system - if relevant
Comments | Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.
Note | This is a business version Id, not a resource version Id (see discussion)
Control | 0..1 This element is affected by the following invariants: ele-1
Type | string
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
384. Medication.ingredient.item[x]:itemCodeableConcept.coding:snomed.code
Definition | A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).
Short | Symbol in syntax defined by the system
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size
Control | 1..1 This element is affected by the following invariants: ele-1
Type | code
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Summary | true
Requirements | Need to refer to a particular code in the system.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
386. Medication.ingredient.item[x]:itemCodeableConcept.coding:snomed.display
Definition | A representation of the meaning of the code in the system, following the rules of the system.
Short | Representation defined by the system
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size
Control | 0..1 This element is affected by the following invariants: ele-1
Type | string
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Summary | true
Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
388. Medication.ingredient.item[x]:itemCodeableConcept.coding:snomed.userSelected
Definition | Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).
Short | If this coding was chosen directly by the user
Comments | Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.
Control | 0..1 This element is affected by the following invariants: ele-1
Type | boolean
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Requirements | This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
390. Medication.ingredient.item[x]:itemCodeableConcept.coding:pzn
Slice Name | pzn
Definition | A reference to a code defined by a terminology system.
Short | Code defined by a terminology system
Comments | Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.
Control | 0..* This element is affected by the following invariants: ele-1
Type | Coding
Must Support | true
Summary | true
Requirements | Allows for alternative encodings within a code system, and translations to other code systems.
Pattern Value | `{ "system" : "http://fhir.de/CodeSystem/ifa/pzn" }`
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
392. Medication.ingredient.item[x]:itemCodeableConcept.coding:pzn.id
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Short | Unique id for inter-element referencing
Control | 0..1
Type | string
XML Format | In the XML format, this property is represented as an attribute.
394. Medication.ingredient.item[x]:itemCodeableConcept.coding:pzn.extension
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Short | Additional content defined by implementations
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..* This element is affected by the following invariants: ele-1
Type | Extension
Standard Status | Normative (from Trial Use)
Alternate Names | extensions, user content
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
Slicing | This element introduces a set of slices on `Medication.ingredient.item[x].coding.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
396. Medication.ingredient.item[x]:itemCodeableConcept.coding:pzn.system
Definition | The identification of the code system that defines the meaning of the symbol in the code.
Short | Identity of the terminology system
Comments | The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.
Control | 1..1 This element is affected by the following invariants: ele-1
Type | uri
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Summary | true
Requirements | Need to be unambiguous about the source of the definition of the symbol.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
398. Medication.ingredient.item[x]:itemCodeableConcept.coding:pzn.version
Definition | The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.
Short | Version of the system - if relevant
Comments | Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.
Note | This is a business version Id, not a resource version Id (see discussion)
Control | 0..1 This element is affected by the following invariants: ele-1
Type | string
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
400. Medication.ingredient.item[x]:itemCodeableConcept.coding:pzn.code
Definition | A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).
Short | Symbol in syntax defined by the system
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size
Control | 1..1 This element is affected by the following invariants: ele-1
Type | code
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Summary | true
Requirements | Need to refer to a particular code in the system.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
402. Medication.ingredient.item[x]:itemCodeableConcept.coding:pzn.display
Definition | A representation of the meaning of the code in the system, following the rules of the system.
Short | Representation defined by the system
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size
Control | 0..1 This element is affected by the following invariants: ele-1
Type | string
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Summary | true
Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
404. Medication.ingredient.item[x]:itemCodeableConcept.coding:pzn.userSelected
Definition | Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).
Short | If this coding was chosen directly by the user
Comments | Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.
Control | 0..1 This element is affected by the following invariants: ele-1
Type | boolean
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Requirements | This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
406. Medication.ingredient.item[x]:itemCodeableConcept.text
Definition | A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.
Short | Plain text representation of the concept
Comments | Very often the text is the same as a displayName of one of the codings.
Control | 0..1 This element is affected by the following invariants: ele-1
Type | string
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Summary | true
Requirements | The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
408. Medication.ingredient.item[x]:itemReference
Slice Name | itemReference
Definition | The actual ingredient - either a substance (simple ingredient) or another medication of a medication.
Short | Medication Ingredients can't have child Medications
Control | 0..0 This element is affected by the following invariants: ele-1
Type | Reference(Medication)
Must Support | true
Requirements | The ingredient may reference a substance (for example, amoxicillin) or another medication (for example in the case of a compounded product, Glaxal Base).
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
410. Medication.ingredient.isActive
Definition | Indication of whether this ingredient affects the therapeutic action of the drug.
Short | Is it an active ingredient?
Control | 0..1 This element is affected by the following invariants: ele-1
Type | boolean
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Requirements | True indicates that the ingredient affects the therapeutic action of the drug (i.e. active). False indicates that the ingredient does not affect the therapeutic action of the drug (i.e. inactive).
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
412. Medication.ingredient.strength
Definition | Specifies how many (or how much) of the items there are in this Medication. For example, 250 mg per tablet. This is expressed as a ratio where the numerator is 250mg and the denominator is 1 tablet.
Short | Strength
Comments | The Ratio datatype should only be used to express a relationship of two numbers if the relationship cannot be suitably expressed using a Quantity and a common unit. Where the denominator value is known to be fixed to "1", Quantity should be used instead of Ratio.
Control | 0..1 This element is affected by the following invariants: ele-1
Type | Ratio
Must Support | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) rat-1: 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())`)
414. Medication.ingredient.strength.id
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Short | Unique id for inter-element referencing
Control | 0..1
Type | string
XML Format | In the XML format, this property is represented as an attribute.
416. Medication.ingredient.strength.extension
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Short | Additional content defined by implementations
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..* This element is affected by the following invariants: ele-1
Type | Extension
Standard Status | Normative (from Trial Use)
Alternate Names | extensions, user content
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
Slicing | This element introduces a set of slices on `Medication.ingredient.strength.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
418. Medication.ingredient.strength.extension:amountText
Slice Name | amountText
Definition | Free-text amount of the ingredient for classical Latin notations such as "ad 100.0" or "quantum satis," including the unit.
Short | Extension
Control | 0..1 This element is affected by the following invariants: ele-1
Type | Extension(MedicationIngredientAmountExtensions) (Extension Type: string)
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
420. Medication.ingredient.strength.extension:amountText.id
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Short | Unique id for inter-element referencing
Control | 0..1
Type | string
XML Format | In the XML format, this property is represented as an attribute.
422. Medication.ingredient.strength.extension:amountText.extension
Definition | An Extension
Short | Extension
Control | 0..0 This element is affected by the following invariants: ele-1
Type | Extension
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
Slicing | This element introduces a set of slices on `Medication.ingredient.strength.extension.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
424. Medication.ingredient.strength.extension:amountText.url
Definition | Source of the definition for the extension code - a logical name or a URL.
Short | identifies the meaning of the extension
Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.
Control | 1..1
Type | uri
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | `https://gematik.de/fhir/epa-medication/StructureDefinition/medication-ingredient-amount-extension`
426. Medication.ingredient.strength.extension:amountText.value[x]
Definition | Free-text amount of the ingredient for classical Latin notations such as "ad 100.0" or "quantum satis," including the unit.
Short | Free-text amount of an ingredient in a formulation.
Control | 1..1 This element is affected by the following invariants: ele-1
Type | string
[x] Note | SeeChoice of Data Typesfor further information about how to use [x]
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Max Length: | 20
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
428. Medication.ingredient.strength.numerator
Definition | The value of the numerator.
Short | Numerator value
Comments | The context of use may frequently define what kind of quantity this is and therefore what kind of units can be used. The context of use may also restrict the values for the comparator.
Control | 0..1 This element is affected by the following invariants: ele-1
Binding | The codes SHOULD be taken from UCUMCodes (preferred to `http://hl7.org/fhir/ValueSet/ucum-units` )
Type | Quantity
Must Support | true
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) qty-3: If a code for the unit is present, the system SHALL also be present (`code.empty() or system.exists()`)
430. Medication.ingredient.strength.numerator.id
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Short | Unique id for inter-element referencing
Control | 0..1
Type | string
XML Format | In the XML format, this property is represented as an attribute.
432. Medication.ingredient.strength.numerator.extension
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Short | Additional content defined by implementations
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..* This element is affected by the following invariants: ele-1
Type | Extension
Standard Status | Normative (from Trial Use)
Alternate Names | extensions, user content
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
Slicing | This element introduces a set of slices on `Medication.ingredient.strength.numerator.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
434. Medication.ingredient.strength.numerator.value
Definition | The value of the measured amount. The value includes an implicit precision in the presentation of the value.
Short | Numerical value (with implicit precision)
Comments | The implicit precision in the value should always be honored. Monetary values have their own rules for handling precision (refer to standard accounting text books).
Control | 1..1 This element is affected by the following invariants: ele-1
Type | decimal
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Summary | true
Requirements | Precision is handled implicitly in almost all cases of measurement.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
436. Medication.ingredient.strength.numerator.comparator
Definition | How the value should be understood and represented - whether the actual value is greater or less than the stated value due to measurement issues; e.g. if the comparator is "<" , then the real value is < stated value.
Short | < | <= | >= | > - how to understand the value
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size
Control | 0..1 This element is affected by the following invariants: ele-1
Binding | The codes SHALL be taken from QuantityComparator (required to `http://hl7.org/fhir/ValueSet/quantity-comparator|4.0.1` ) How the Quantity should be understood and represented.
Type | code
Is Modifier | true because This is labeled as "Is Modifier" because the comparator modifies the interpretation of the value significantly. If there is no comparator, then there is no modification of the value
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Requirements | Need a framework for handling measures where the value is <5ug/L or >400mg/L due to the limitations of measuring methodology.
Meaning if Missing | If there is no comparator, then there is no modification of the value
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
438. Medication.ingredient.strength.numerator.unit
Definition | A human-readable form of the unit.
Short | Unit representation
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size
Control | 0..1 This element is affected by the following invariants: ele-1
Type | string
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Summary | true
Requirements | There are many representations for units of measure and in many contexts, particular representations are fixed and required. I.e. mcg for micrograms.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
440. Medication.ingredient.strength.numerator.system
Definition | The identification of the system that provides the coded form of the unit.
Short | System that defines coded unit form
Comments | see http://en.wikipedia.org/wiki/Uniform_resource_identifier
Control | 0..1 This element is affected by the following invariants: ele-1, qty-3
Type | uri
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Summary | true
Requirements | Need to know the system that defines the coded form of the unit.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
442. Medication.ingredient.strength.numerator.code
Definition | A computer processable form of the unit in some unit representation system.
Short | Coded form of the unit
Comments | The preferred system is UCUM, but SNOMED CT can also be used (for customary units) or ISO 4217 for currency. The context of use may additionally require a code from a particular system.
Control | 0..1 This element is affected by the following invariants: ele-1
Type | code
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Summary | true
Requirements | Need a computable form of the unit that is fixed across all forms. UCUM provides this for quantities, but SNOMED CT provides many units of interest.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
444. Medication.ingredient.strength.denominator
Definition | The value of the denominator.
Short | Denominator value
Comments | The context of use may frequently define what kind of quantity this is and therefore what kind of units can be used. The context of use may also restrict the values for the comparator.
Control | 0..1 This element is affected by the following invariants: ele-1
Binding | The codes SHOULD be taken from UCUMCodes (preferred to `http://hl7.org/fhir/ValueSet/ucum-units` )
Type | Quantity
Must Support | true
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) qty-3: If a code for the unit is present, the system SHALL also be present (`code.empty() or system.exists()`)
446. Medication.ingredient.strength.denominator.id
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Short | Unique id for inter-element referencing
Control | 0..1
Type | string
XML Format | In the XML format, this property is represented as an attribute.
448. Medication.ingredient.strength.denominator.extension
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Short | Additional content defined by implementations
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..* This element is affected by the following invariants: ele-1
Type | Extension
Standard Status | Normative (from Trial Use)
Alternate Names | extensions, user content
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
Slicing | This element introduces a set of slices on `Medication.ingredient.strength.denominator.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
450. Medication.ingredient.strength.denominator.value
Definition | The value of the measured amount. The value includes an implicit precision in the presentation of the value.
Short | Numerical value (with implicit precision)
Comments | The implicit precision in the value should always be honored. Monetary values have their own rules for handling precision (refer to standard accounting text books).
Control | 1..1 This element is affected by the following invariants: ele-1
Type | decimal
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Summary | true
Requirements | Precision is handled implicitly in almost all cases of measurement.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
452. Medication.ingredient.strength.denominator.comparator
Definition | How the value should be understood and represented - whether the actual value is greater or less than the stated value due to measurement issues; e.g. if the comparator is "<" , then the real value is < stated value.
Short | < | <= | >= | > - how to understand the value
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size
Control | 0..1 This element is affected by the following invariants: ele-1
Binding | The codes SHALL be taken from QuantityComparator (required to `http://hl7.org/fhir/ValueSet/quantity-comparator|4.0.1` ) How the Quantity should be understood and represented.
Type | code
Is Modifier | true because This is labeled as "Is Modifier" because the comparator modifies the interpretation of the value significantly. If there is no comparator, then there is no modification of the value
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Requirements | Need a framework for handling measures where the value is <5ug/L or >400mg/L due to the limitations of measuring methodology.
Meaning if Missing | If there is no comparator, then there is no modification of the value
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
454. Medication.ingredient.strength.denominator.unit
Definition | A human-readable form of the unit.
Short | Unit representation
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size
Control | 0..1 This element is affected by the following invariants: ele-1
Type | string
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Summary | true
Requirements | There are many representations for units of measure and in many contexts, particular representations are fixed and required. I.e. mcg for micrograms.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
456. Medication.ingredient.strength.denominator.system
Definition | The identification of the system that provides the coded form of the unit.
Short | System that defines coded unit form
Comments | see http://en.wikipedia.org/wiki/Uniform_resource_identifier
Control | 0..1 This element is affected by the following invariants: ele-1, qty-3
Type | uri
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Summary | true
Requirements | Need to know the system that defines the coded form of the unit.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
458. Medication.ingredient.strength.denominator.code
Definition | A computer processable form of the unit in some unit representation system.
Short | Coded form of the unit
Comments | The preferred system is UCUM, but SNOMED CT can also be used (for customary units) or ISO 4217 for currency. The context of use may additionally require a code from a particular system.
Control | 0..1 This element is affected by the following invariants: ele-1
Type | code
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Summary | true
Requirements | Need a computable form of the unit that is fixed across all forms. UCUM provides this for quantities, but SNOMED CT provides many units of interest.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
460. Medication.batch
Definition | Information that only applies to packages (not products).
Short | Batch Information
Control | 0..1 This element is affected by the following invariants: ele-1
Type | BackboneElement
Must Support | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
462. Medication.batch.id
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Short | Unique id for inter-element referencing
Control | 0..1
Type | string
XML Format | In the XML format, this property is represented as an attribute.
464. Medication.batch.extension
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Short | Additional content defined by implementations
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..* This element is affected by the following invariants: ele-1
Type | Extension
Standard Status | Normative (from Trial Use)
Alternate Names | extensions, user content
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
Slicing | This element introduces a set of slices on `Medication.batch.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
466. Medication.batch.modifierExtension
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Short | Extensions that cannot be ignored even if unrecognized
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..* This element is affected by the following invariants: ele-1
Type | Extension
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summary | true
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.
Alternate Names | extensions, user content, modifiers
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
468. Medication.batch.lotNumber
Definition | The assigned lot number of a batch of the specified product.
Short | Batch Number
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size
Control | 0..1 This element is affected by the following invariants: ele-1
Type | string
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
470. Medication.batch.expirationDate
Definition | When this specific batch of product will expire.
Short | When batch will expire
Control | 0..1 This element is affected by the following invariants: ele-1
Type | dateTime
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)