Medication IG DE
2.0.0-ballot - ballot
Medication IG DE
2.0.0-ballot - ballot
Medication IG DE, published by HL7 Deutschland e.V.. This guide is not an authorized publication; it is the continuous build for version 2.0.0-ballot built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/hl7germany/medication-ig-de-r4/ and changes regularly. See the Directory of published versions
| Official URL: http://ig.fhir.de/igs/medication/StructureDefinition/DosageDE | Version: 2.0.0-ballot | |||
| Active as of 2026-10-14 | Computable Name: DosageDE | |||
Gibt an, wie das Medikament eingenommen oder verabreicht wurde bzw. eingenommen oder verabreicht werden soll - entweder selbst vom Patienten eingenommen oder bei Fremdverabreichung von Dritten (z. B. Leistungserbringer, Angehörige) verabreicht.
Dieses Profil beschreibt die Verwendung der FHIR-Ressource Dosage im deutschen Kontext und ist für die allgemeine Interoperabilität konzipiert. Das Profil ist offen gehalten und setzt keine spezifischen Dosierschemata voraus, sondern legt ein „Must Support“ auf alle relevanten Felder. Ziel ist es, eine flexible und breit einsetzbare Abbildung von Dosierungsangaben zu ermöglichen, wie sie in unterschiedlichen Primärsystemen und Anwendungsfällen benötigt wird.
Empfehlung:
Nutzen Sie dieses Profil für alle Anwendungsfälle, in denen Dosierungsinformationen interoperabel ausgetauscht werden sollen. Orientieren Sie sich bei der Umsetzung an den empfohlenen Dosierschemata, um eine konsistente und verständliche Darstellung zu gewährleisten.
Weitere Hinweise und Beispiele zu bewährten Dosierschemata ist unter Unterstützte Dosierungen beschrieben.
Usages:
You can also check for usages in the FHIR IG Statistics
Description of Profiles, Differentials, Snapshots and how the different presentations work.
| Name | Flags | Card. | Type | Description & Constraints Filter:  |
|---|---|---|---|---|
  Dosage |
C | 0..* | Dosage | How the medication is/was taken or should be taken Constraints: DosageStructuredOrFreeTextWarning, DosageStructuredRequiresBothWarning, DosageDoseUnitSameCodeWarning, DosageDoseValuePositiveWarning, DosageLimitsPositiveWarning, DosageFourSlotPatternInTextWarning, FreeTextSingleDosageOnlyWarning, AsNeededForRequiresAsNeededWarning, dos-1 |
  Slices for extension |
Content/Rules for all slices | |||
   extension:asNeededFor |
0..* | (Complex) | Indikation für die Bedarfsdosierung URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Dosage.asNeededFor | |
   extension |
0..0 | Extension Slice: Unordered, Open by value:url | ||
 url |
1..1 | uri | "http://hl7.org/fhir/5.0/StructureDefinition/extension-Dosage.asNeededFor" | |
  value[x] |
0..1 | CodeableConcept | Value of extension Binding: SNOMEDCTMedicationAsNeededReasonCodes (example) | |
 text |
0..1 | string | Plain text representation of the concept | |
 Slices for modifierExtension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
| modifierExtension:minimumIntervalBetweenAdministrations |
0..1 | (Complex) | Mindestabstand zwischen zwei Gaben URL: http://ig.fhir.de/igs/medication/StructureDefinition/MinimumIntervalBetweenAdministrations | |
| extension |
0..0 | Extension Slice: Unordered, Open by value:url | ||
| url |
1..1 | uri | "http://ig.fhir.de/igs/medication/StructureDefinition/MinimumIntervalBetweenAdministrations" | |
| value[x] |
1..1 | Duration | Mindestabstand zwischen zwei Gaben | |
 comparator |
0..1 | code | < | <= | >= | > - how to understand the value Binding: QuantityComparator (required): How the Quantity should be understood and represented. | |
| unit |
0..1 | string | Unit representation | |
| system |
C | 0..1 | uri | System that defines coded unit form |
| code |
0..1 | code | Coded form of the unit | |
| text |
0..1 | string | Freitext-Dosierungsanweisungen, z. B. 'Maximal 3x täglich 1 Stück bei Bedarf' | |
| patientInstruction |
0..1 | string | Ergänzende Anwendungshinweise für Patientinnen und Patienten | |
| timing |
0..1 | TimingDE | Wann das Medikament verabreicht werden soll | |
| asNeeded[x] |
0..1 | boolean | Bedarfsdosierung (nur Ja/Nein-Angabe) | |
| doseAndRate |
0..* | Element | Menge des verabreichten Medikaments | |
 Slices for dose[x] |
0..1 | Amount of medication per dose Slice: Unordered, Closed by type:$this Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | ||
 doseRange |
Range | |||
| doseQuantity |
Quantity(SimpleQuantity) | |||
 dose[x]:doseQuantity |
0..1 | SimpleQuantity  |
Menge des Medikaments pro Dosis Binding: Dosage DoseQuantity ValueSet (required) | |
 value |
0..1 | decimal | Numerical value (with implicit precision) | |
| unit |
0..1 | string | Unit representation | |
| system |
C | 0..1 | uri | System that defines coded unit form |
 code |
0..1 | code | Coded form of the unit | |
| dose[x]:doseRange |
0..1 | Range | Amount of medication per dose | |
 low |
C | 0..1 | SimpleQuantity(4.0.1) | Low limit Binding: Dosage DoseQuantity ValueSet (required) Constraints: sqty-1 |
 value |
0..1 | decimal | Numerical value (with implicit precision) | |
| unit |
0..1 | string | Unit representation | |
| system |
C | 0..1 | uri | System that defines coded unit form |
| code |
0..1 | code | Coded form of the unit | |
| high |
C | 0..1 | SimpleQuantity(4.0.1) | High limit Binding: Dosage DoseQuantity ValueSet (required) Constraints: sqty-1 |
| value |
0..1 | decimal | Numerical value (with implicit precision) | |
| unit |
0..1 | string | Unit representation | |
| system |
C | 0..1 | uri | System that defines coded unit form |
| code |
0..1 | code | Coded form of the unit | |
| maxDosePerPeriod |
0..1 | Ratio | Maximale Dosis pro Zeitraum | |
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Dosage.extension:asNeededFor.value[x] | Base | example | SNOMED CT Medication As Needed Reason Codes | 📦4.0.1 | FHIR Std. |
| Dosage.modifierExtension:minimumIntervalBetweenAdministrations.value[x].comparator | Base | required | QuantityComparator | 📍4.0.1 | FHIR Std. |
| Dosage.doseAndRate.dose[x]:doseQuantity | Base | required | Dosage DoseQuantity ValueSet | 📦2.0.0-ballot | This IG |
| Dosage.doseAndRate.dose[x]:doseRange.low | Base | required | Dosage DoseQuantity ValueSet | 📦2.0.0-ballot | This IG |
| Dosage.doseAndRate.dose[x]:doseRange.high | Base | required | Dosage DoseQuantity ValueSet | 📦2.0.0-ballot | This IG |
| Id | Grade | Path(s) | Description | Expression |
| AsNeededForRequiresAsNeededWarning | warning | Dosage | A reason for use (asNeededFor) should only be given together with asNeededBoolean = true. |
extension.where(url='http://hl7.org/fhir/5.0/StructureDefinition/extension-Dosage.asNeededFor').exists() implies asNeeded.ofType(boolean) = true
|
| DosageDoseUnitSameCodeWarning | warning | Dosage | The dose unit should be the same across all dosages. |
(%resource.ofType(MedicationRequest).dosageInstruction | %resource.ofType(MedicationDispense).dosageInstruction | %resource.ofType(MedicationStatement).dosage).all(
doseAndRate.exists() implies
(
(%resource.ofType(MedicationRequest).dosageInstruction | %resource.ofType(MedicationDispense).dosageInstruction | %resource.ofType(MedicationStatement).dosage).doseAndRate.dose.ofType(Quantity).code |
(%resource.ofType(MedicationRequest).dosageInstruction | %resource.ofType(MedicationDispense).dosageInstruction | %resource.ofType(MedicationStatement).dosage).doseAndRate.dose.ofType(Range).low.code |
(%resource.ofType(MedicationRequest).dosageInstruction | %resource.ofType(MedicationDispense).dosageInstruction | %resource.ofType(MedicationStatement).dosage).doseAndRate.dose.ofType(Range).high.code
).distinct().count() = 1
)
|
| DosageDoseValuePositiveWarning | warning | Dosage | doseQuantity.value and doseRange.high.value should be greater than 0. The value 0 is additionally allowed for doseRange.low.value only. |
doseAndRate.all(
dose.ofType(Quantity).value.all($this > 0) and
dose.ofType(Range).low.value.all($this >= 0) and
dose.ofType(Range).high.value.all($this > 0)
)
|
| DosageFourSlotPatternInTextWarning | warning | Dosage | A four-slot dosing schema (Viererschema, e.g. 1-1-1-1) was detected in Dosage.text. Please check whether it can be represented structurally. |
text.exists() implies text.matches('.*\\d+\\s*[-–]\\s*\\d+\\s*[-–]\\s*\\d+\\s*[-–]\\s*\\d+.*').not()
|
| DosageLimitsPositiveWarning | warning | Dosage | The minimum interval between administrations (valueDuration.value) and maxDosePerPeriod (numerator.value, denominator.value) should be greater than 0. |
modifierExtension.where(
url = 'http://ig.fhir.de/igs/medication/StructureDefinition/MinimumIntervalBetweenAdministrations'
).value.ofType(Duration).value.all($this > 0) and
maxDosePerPeriod.numerator.value.all($this > 0) and
maxDosePerPeriod.denominator.value.all($this > 0)
|
| DosageStructuredOrFreeTextWarning | warning | Dosage | A dosage must be given either as free text only or as complete structured information only; mixing both is not allowed. |
(%resource.ofType(MedicationRequest).dosageInstruction |
%resource.ofType(MedicationDispense).dosageInstruction |
%resource.ofType(MedicationStatement).dosage).all(
(text.exists() and timing.empty() and doseAndRate.empty()) or
(text.empty() and (timing.exists() or doseAndRate.exists()))
)
|
| DosageStructuredRequiresBothWarning | warning | Dosage | If a structured dosage is given, both timing and doseAndRate should be present. For pure as-needed dosages, doseAndRate may be given without timing. |
(%resource.ofType(MedicationRequest).dosageInstruction |
%resource.ofType(MedicationDispense).dosageInstruction |
%resource.ofType(MedicationStatement).dosage).all(
(timing.exists() implies doseAndRate.exists()) and
(doseAndRate.exists() implies (
timing.exists() or
asNeeded.ofType(boolean) = true or
extension.where(url='http://hl7.org/fhir/5.0/StructureDefinition/extension-Dosage.asNeededFor').exists()
))
)
|
| FreeTextSingleDosageOnlyWarning | warning | Dosage | If a dosage is given as pure free text, there should be exactly one Dosage element. |
(
(%resource.ofType(MedicationRequest).dosageInstruction |
%resource.ofType(MedicationDispense).dosageInstruction |
%resource.ofType(MedicationStatement).dosage
).exists(text.exists() and timing.empty() and doseAndRate.empty())
)
implies
(
(%resource.ofType(MedicationRequest).dosageInstruction |
%resource.ofType(MedicationDispense).dosageInstruction |
%resource.ofType(MedicationStatement).dosage
).count() = 1
)
|
| dos-1 | error | Dosage | AsNeededFor can only be set if AsNeeded is empty or true |
extension.where(url='http://hl7.org/fhir/5.0/StructureDefinition/extension-Dosage.asNeededFor').empty() or asNeeded.empty() or asNeeded
|
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
| sqty-1 | error | Dosage.doseAndRate.dose[x]:doseRange.low, Dosage.doseAndRate.dose[x]:doseRange.high | The comparator is not used on a SimpleQuantity |
comparator.empty()
|
This structure is derived from Dosage
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Dosage |
C | 0..* | Dosage | How the medication is/was taken or should be taken Constraints: DosageStructuredOrFreeTextWarning, DosageStructuredRequiresBothWarning, DosageDoseUnitSameCodeWarning, DosageDoseValuePositiveWarning, DosageLimitsPositiveWarning, DosageFourSlotPatternInTextWarning, FreeTextSingleDosageOnlyWarning, AsNeededForRequiresAsNeededWarning, dos-1 |
| Slices for extension |
Content/Rules for all slices | |||
| extension:asNeededFor |
0..* | (Complex) | Indikation für die Bedarfsdosierung URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Dosage.asNeededFor | |
| value[x] |
||||
| text |
0..1 | string | Plain text representation of the concept | |
| Slices for modifierExtension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
| modifierExtension:minimumIntervalBetweenAdministrations |
0..1 | (Complex) | Mindestabstand zwischen zwei Gaben URL: http://ig.fhir.de/igs/medication/StructureDefinition/MinimumIntervalBetweenAdministrations | |
| value[x] |
||||
| unit |
0..1 | string | Unit representation | |
| system |
0..1 | uri | System that defines coded unit form | |
| code |
0..1 | code | Coded form of the unit | |
| text |
0..1 | string | Freitext-Dosierungsanweisungen, z. B. 'Maximal 3x täglich 1 Stück bei Bedarf' | |
| patientInstruction |
0..1 | string | Ergänzende Anwendungshinweise für Patientinnen und Patienten | |
| timing |
0..1 | TimingDE | Wann das Medikament verabreicht werden soll | |
| asNeeded[x] |
0..1 | boolean | Bedarfsdosierung (nur Ja/Nein-Angabe) | |
| doseAndRate |
0..* | Element | Menge des verabreichten Medikaments | |
| Slices for dose[x] |
0..1 | Range, SimpleQuantity(4.0.1) | Amount of medication per dose Slice: Unordered, Open by type:$this Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
| dose[x]:doseQuantity |
0..1 | SimpleQuantity | Menge des Medikaments pro Dosis Binding: Dosage DoseQuantity ValueSet (required) | |
| value |
0..1 | decimal | Numerical value (with implicit precision) | |
| unit |
0..1 | string | Unit representation | |
| system |
0..1 | uri | System that defines coded unit form | |
| code |
0..1 | code | Coded form of the unit | |
| dose[x]:doseRange |
0..1 | Range | Amount of medication per dose | |
| low |
0..1 | SimpleQuantity(4.0.1) | Low limit Binding: Dosage DoseQuantity ValueSet (required) | |
| value |
0..1 | decimal | Numerical value (with implicit precision) | |
| unit |
0..1 | string | Unit representation | |
| system |
0..1 | uri | System that defines coded unit form | |
| code |
0..1 | code | Coded form of the unit | |
| high |
0..1 | SimpleQuantity(4.0.1) | High limit Binding: Dosage DoseQuantity ValueSet (required) | |
| value |
0..1 | decimal | Numerical value (with implicit precision) | |
| unit |
0..1 | string | Unit representation | |
| system |
0..1 | uri | System that defines coded unit form | |
| code |
0..1 | code | Coded form of the unit | |
| maxDosePerPeriod |
0..1 | Ratio | Maximale Dosis pro Zeitraum | |
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Dosage.doseAndRate.dose[x]:doseQuantity | Base | required | Dosage DoseQuantity ValueSet | 📦2.0.0-ballot | This IG |
| Dosage.doseAndRate.dose[x]:doseRange.low | Base | required | Dosage DoseQuantity ValueSet | 📦2.0.0-ballot | This IG |
| Dosage.doseAndRate.dose[x]:doseRange.high | Base | required | Dosage DoseQuantity ValueSet | 📦2.0.0-ballot | This IG |
| Id | Grade | Path(s) | Description | Expression |
| AsNeededForRequiresAsNeededWarning | warning | Dosage | A reason for use (asNeededFor) should only be given together with asNeededBoolean = true. |
extension.where(url='http://hl7.org/fhir/5.0/StructureDefinition/extension-Dosage.asNeededFor').exists() implies asNeeded.ofType(boolean) = true
|
| DosageDoseUnitSameCodeWarning | warning | Dosage | The dose unit should be the same across all dosages. |
(%resource.ofType(MedicationRequest).dosageInstruction | %resource.ofType(MedicationDispense).dosageInstruction | %resource.ofType(MedicationStatement).dosage).all(
doseAndRate.exists() implies
(
(%resource.ofType(MedicationRequest).dosageInstruction | %resource.ofType(MedicationDispense).dosageInstruction | %resource.ofType(MedicationStatement).dosage).doseAndRate.dose.ofType(Quantity).code |
(%resource.ofType(MedicationRequest).dosageInstruction | %resource.ofType(MedicationDispense).dosageInstruction | %resource.ofType(MedicationStatement).dosage).doseAndRate.dose.ofType(Range).low.code |
(%resource.ofType(MedicationRequest).dosageInstruction | %resource.ofType(MedicationDispense).dosageInstruction | %resource.ofType(MedicationStatement).dosage).doseAndRate.dose.ofType(Range).high.code
).distinct().count() = 1
)
|
| DosageDoseValuePositiveWarning | warning | Dosage | doseQuantity.value and doseRange.high.value should be greater than 0. The value 0 is additionally allowed for doseRange.low.value only. |
doseAndRate.all(
dose.ofType(Quantity).value.all($this > 0) and
dose.ofType(Range).low.value.all($this >= 0) and
dose.ofType(Range).high.value.all($this > 0)
)
|
| DosageFourSlotPatternInTextWarning | warning | Dosage | A four-slot dosing schema (Viererschema, e.g. 1-1-1-1) was detected in Dosage.text. Please check whether it can be represented structurally. |
text.exists() implies text.matches('.*\\d+\\s*[-–]\\s*\\d+\\s*[-–]\\s*\\d+\\s*[-–]\\s*\\d+.*').not()
|
| DosageLimitsPositiveWarning | warning | Dosage | The minimum interval between administrations (valueDuration.value) and maxDosePerPeriod (numerator.value, denominator.value) should be greater than 0. |
modifierExtension.where(
url = 'http://ig.fhir.de/igs/medication/StructureDefinition/MinimumIntervalBetweenAdministrations'
).value.ofType(Duration).value.all($this > 0) and
maxDosePerPeriod.numerator.value.all($this > 0) and
maxDosePerPeriod.denominator.value.all($this > 0)
|
| DosageStructuredOrFreeTextWarning | warning | Dosage | A dosage must be given either as free text only or as complete structured information only; mixing both is not allowed. |
(%resource.ofType(MedicationRequest).dosageInstruction |
%resource.ofType(MedicationDispense).dosageInstruction |
%resource.ofType(MedicationStatement).dosage).all(
(text.exists() and timing.empty() and doseAndRate.empty()) or
(text.empty() and (timing.exists() or doseAndRate.exists()))
)
|
| DosageStructuredRequiresBothWarning | warning | Dosage | If a structured dosage is given, both timing and doseAndRate should be present. For pure as-needed dosages, doseAndRate may be given without timing. |
(%resource.ofType(MedicationRequest).dosageInstruction |
%resource.ofType(MedicationDispense).dosageInstruction |
%resource.ofType(MedicationStatement).dosage).all(
(timing.exists() implies doseAndRate.exists()) and
(doseAndRate.exists() implies (
timing.exists() or
asNeeded.ofType(boolean) = true or
extension.where(url='http://hl7.org/fhir/5.0/StructureDefinition/extension-Dosage.asNeededFor').exists()
))
)
|
| FreeTextSingleDosageOnlyWarning | warning | Dosage | If a dosage is given as pure free text, there should be exactly one Dosage element. |
(
(%resource.ofType(MedicationRequest).dosageInstruction |
%resource.ofType(MedicationDispense).dosageInstruction |
%resource.ofType(MedicationStatement).dosage
).exists(text.exists() and timing.empty() and doseAndRate.empty())
)
implies
(
(%resource.ofType(MedicationRequest).dosageInstruction |
%resource.ofType(MedicationDispense).dosageInstruction |
%resource.ofType(MedicationStatement).dosage
).count() = 1
)
|
| dos-1 | error | Dosage | AsNeededFor can only be set if AsNeeded is empty or true |
extension.where(url='http://hl7.org/fhir/5.0/StructureDefinition/extension-Dosage.asNeededFor').empty() or asNeeded.empty() or asNeeded
|
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Dosage |
C | 0..* | Dosage | How the medication is/was taken or should be taken Constraints: DosageStructuredOrFreeTextWarning, DosageStructuredRequiresBothWarning, DosageDoseUnitSameCodeWarning, DosageDoseValuePositiveWarning, DosageLimitsPositiveWarning, DosageFourSlotPatternInTextWarning, FreeTextSingleDosageOnlyWarning, AsNeededForRequiresAsNeededWarning, dos-1 |
| id |
0..1 | string | Unique id for inter-element referencing | |
| Slices for extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| extension:asNeededFor |
0..* | (Complex) | Indikation für die Bedarfsdosierung URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Dosage.asNeededFor | |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..0 | Extension Slice: Unordered, Open by value:url | ||
| url |
1..1 | uri | "http://hl7.org/fhir/5.0/StructureDefinition/extension-Dosage.asNeededFor" | |
| value[x] |
0..1 | CodeableConcept | Value of extension Binding: SNOMEDCTMedicationAsNeededReasonCodes (example) | |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| coding |
0..* | Coding | Code defined by a terminology system | |
| text |
0..1 | string | Plain text representation of the concept | |
| Slices for modifierExtension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
| modifierExtension:minimumIntervalBetweenAdministrations |
0..1 | (Complex) | Mindestabstand zwischen zwei Gaben URL: http://ig.fhir.de/igs/medication/StructureDefinition/MinimumIntervalBetweenAdministrations | |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..0 | Extension Slice: Unordered, Open by value:url | ||
| url |
1..1 | uri | "http://ig.fhir.de/igs/medication/StructureDefinition/MinimumIntervalBetweenAdministrations" | |
| value[x] |
1..1 | Duration | Mindestabstand zwischen zwei Gaben | |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| value |
0..1 | decimal | Numerical value (with implicit precision) | |
| comparator |
0..1 | code | < | <= | >= | > - how to understand the value Binding: QuantityComparator (required): How the Quantity should be understood and represented. | |
| unit |
0..1 | string | Unit representation | |
| system |
C | 0..1 | uri | System that defines coded unit form |
| code |
0..1 | code | Coded form of the unit | |
| sequence |
0..1 | integer | The order of the dosage instructions | |
| text |
0..1 | string | Freitext-Dosierungsanweisungen, z. B. 'Maximal 3x täglich 1 Stück bei Bedarf' | |
| additionalInstruction |
0..* | CodeableConcept | Supplemental instruction or warnings to the patient - e.g. "with meals", "may cause drowsiness" Binding: SNOMEDCTAdditionalDosageInstructions (example): A coded concept identifying additional instructions such as "take with water" or "avoid operating heavy machinery". | |
| patientInstruction |
0..1 | string | Ergänzende Anwendungshinweise für Patientinnen und Patienten | |
| timing |
0..1 | TimingDE | Wann das Medikament verabreicht werden soll | |
| asNeeded[x] |
0..1 | boolean | Bedarfsdosierung (nur Ja/Nein-Angabe) | |
| site |
0..1 | CodeableConcept | Body site to administer to Binding: SNOMEDCTAnatomicalStructureForAdministrationSiteCodes (example): A coded concept describing the site location the medicine enters into or onto the body. | |
| route |
0..1 | CodeableConcept | How drug should enter body Binding: SNOMEDCTRouteCodes (example): A coded concept describing the route or physiological path of administration of a therapeutic agent into or onto the body of a subject. | |
| method |
0..1 | CodeableConcept | Technique for administering medication Binding: SNOMEDCTAdministrationMethodCodes (example): A coded concept describing the technique by which the medicine is administered. | |
| doseAndRate |
0..* | Element | Menge des verabreichten Medikaments | |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| type |
0..1 | CodeableConcept | The kind of dose or rate specified Binding: DoseAndRateType (example): The kind of dose or rate specified. | |
| Slices for dose[x] |
0..1 | Amount of medication per dose Slice: Unordered, Closed by type:$this Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | ||
| doseRange |
Range | |||
| doseQuantity |
Quantity(SimpleQuantity) | |||
| dose[x]:doseQuantity |
0..1 | SimpleQuantity |
Menge des Medikaments pro Dosis Binding: Dosage DoseQuantity ValueSet (required) | |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| value |
0..1 | decimal | Numerical value (with implicit precision) | |
| unit |
0..1 | string | Unit representation | |
| system |
C | 0..1 | uri | System that defines coded unit form |
| code |
0..1 | code | Coded form of the unit | |
| dose[x]:doseRange |
0..1 | Range | Amount of medication per dose | |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| low |
C | 0..1 | SimpleQuantity(4.0.1) | Low limit Binding: Dosage DoseQuantity ValueSet (required) Constraints: sqty-1 |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| value |
0..1 | decimal | Numerical value (with implicit precision) | |
| unit |
0..1 | string | Unit representation | |
| system |
C | 0..1 | uri | System that defines coded unit form |
| code |
0..1 | code | Coded form of the unit | |
| high |
C | 0..1 | SimpleQuantity(4.0.1) | High limit Binding: Dosage DoseQuantity ValueSet (required) Constraints: sqty-1 |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| value |
0..1 | decimal | Numerical value (with implicit precision) | |
| unit |
0..1 | string | Unit representation | |
| system |
C | 0..1 | uri | System that defines coded unit form |
| code |
0..1 | code | Coded form of the unit | |
 rate[x] |
0..1 | Amount of medication per unit of time | ||
| rateRatio |
Ratio | |||
| rateRange |
Range | |||
| rateQuantity |
Quantity(SimpleQuantity) | |||
| maxDosePerPeriod |
0..1 | Ratio | Maximale Dosis pro Zeitraum | |
| maxDosePerAdministration |
C | 0..1 | SimpleQuantity(4.0.1) | Upper limit on medication per administration Constraints: sqty-1 |
| maxDosePerLifetime |
C | 0..1 | SimpleQuantity(4.0.1) | Upper limit on medication per lifetime of the patient Constraints: sqty-1 |
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Dosage.extension:asNeededFor.value[x] | Base | example | SNOMED CT Medication As Needed Reason Codes | 📦4.0.1 | FHIR Std. |
| Dosage.modifierExtension:minimumIntervalBetweenAdministrations.value[x].comparator | Base | required | QuantityComparator | 📍4.0.1 | FHIR Std. |
| Dosage.additionalInstruction | Base | example | SNOMED CT Additional Dosage Instructions | 📍4.0.1 | FHIR Std. |
| Dosage.site | Base | example | SNOMED CT Anatomical Structure for Administration Site Codes | 📍4.0.1 | FHIR Std. |
| Dosage.route | Base | example | SNOMED CT Route Codes | 📍4.0.1 | FHIR Std. |
| Dosage.method | Base | example | SNOMED CT Administration Method Codes | 📍4.0.1 | FHIR Std. |
| Dosage.doseAndRate.type | Base | example | DoseAndRateType | 📍4.0.1 | FHIR Std. |
| Dosage.doseAndRate.dose[x]:doseQuantity | Base | required | Dosage DoseQuantity ValueSet | 📦2.0.0-ballot | This IG |
| Dosage.doseAndRate.dose[x]:doseRange.low | Base | required | Dosage DoseQuantity ValueSet | 📦2.0.0-ballot | This IG |
| Dosage.doseAndRate.dose[x]:doseRange.high | Base | required | Dosage DoseQuantity ValueSet | 📦2.0.0-ballot | This IG |
| Id | Grade | Path(s) | Description | Expression |
| AsNeededForRequiresAsNeededWarning | warning | Dosage | A reason for use (asNeededFor) should only be given together with asNeededBoolean = true. |
extension.where(url='http://hl7.org/fhir/5.0/StructureDefinition/extension-Dosage.asNeededFor').exists() implies asNeeded.ofType(boolean) = true
|
| DosageDoseUnitSameCodeWarning | warning | Dosage | The dose unit should be the same across all dosages. |
(%resource.ofType(MedicationRequest).dosageInstruction | %resource.ofType(MedicationDispense).dosageInstruction | %resource.ofType(MedicationStatement).dosage).all(
doseAndRate.exists() implies
(
(%resource.ofType(MedicationRequest).dosageInstruction | %resource.ofType(MedicationDispense).dosageInstruction | %resource.ofType(MedicationStatement).dosage).doseAndRate.dose.ofType(Quantity).code |
(%resource.ofType(MedicationRequest).dosageInstruction | %resource.ofType(MedicationDispense).dosageInstruction | %resource.ofType(MedicationStatement).dosage).doseAndRate.dose.ofType(Range).low.code |
(%resource.ofType(MedicationRequest).dosageInstruction | %resource.ofType(MedicationDispense).dosageInstruction | %resource.ofType(MedicationStatement).dosage).doseAndRate.dose.ofType(Range).high.code
).distinct().count() = 1
)
|
| DosageDoseValuePositiveWarning | warning | Dosage | doseQuantity.value and doseRange.high.value should be greater than 0. The value 0 is additionally allowed for doseRange.low.value only. |
doseAndRate.all(
dose.ofType(Quantity).value.all($this > 0) and
dose.ofType(Range).low.value.all($this >= 0) and
dose.ofType(Range).high.value.all($this > 0)
)
|
| DosageFourSlotPatternInTextWarning | warning | Dosage | A four-slot dosing schema (Viererschema, e.g. 1-1-1-1) was detected in Dosage.text. Please check whether it can be represented structurally. |
text.exists() implies text.matches('.*\\d+\\s*[-–]\\s*\\d+\\s*[-–]\\s*\\d+\\s*[-–]\\s*\\d+.*').not()
|
| DosageLimitsPositiveWarning | warning | Dosage | The minimum interval between administrations (valueDuration.value) and maxDosePerPeriod (numerator.value, denominator.value) should be greater than 0. |
modifierExtension.where(
url = 'http://ig.fhir.de/igs/medication/StructureDefinition/MinimumIntervalBetweenAdministrations'
).value.ofType(Duration).value.all($this > 0) and
maxDosePerPeriod.numerator.value.all($this > 0) and
maxDosePerPeriod.denominator.value.all($this > 0)
|
| DosageStructuredOrFreeTextWarning | warning | Dosage | A dosage must be given either as free text only or as complete structured information only; mixing both is not allowed. |
(%resource.ofType(MedicationRequest).dosageInstruction |
%resource.ofType(MedicationDispense).dosageInstruction |
%resource.ofType(MedicationStatement).dosage).all(
(text.exists() and timing.empty() and doseAndRate.empty()) or
(text.empty() and (timing.exists() or doseAndRate.exists()))
)
|
| DosageStructuredRequiresBothWarning | warning | Dosage | If a structured dosage is given, both timing and doseAndRate should be present. For pure as-needed dosages, doseAndRate may be given without timing. |
(%resource.ofType(MedicationRequest).dosageInstruction |
%resource.ofType(MedicationDispense).dosageInstruction |
%resource.ofType(MedicationStatement).dosage).all(
(timing.exists() implies doseAndRate.exists()) and
(doseAndRate.exists() implies (
timing.exists() or
asNeeded.ofType(boolean) = true or
extension.where(url='http://hl7.org/fhir/5.0/StructureDefinition/extension-Dosage.asNeededFor').exists()
))
)
|
| FreeTextSingleDosageOnlyWarning | warning | Dosage | If a dosage is given as pure free text, there should be exactly one Dosage element. |
(
(%resource.ofType(MedicationRequest).dosageInstruction |
%resource.ofType(MedicationDispense).dosageInstruction |
%resource.ofType(MedicationStatement).dosage
).exists(text.exists() and timing.empty() and doseAndRate.empty())
)
implies
(
(%resource.ofType(MedicationRequest).dosageInstruction |
%resource.ofType(MedicationDispense).dosageInstruction |
%resource.ofType(MedicationStatement).dosage
).count() = 1
)
|
| dos-1 | error | Dosage | AsNeededFor can only be set if AsNeeded is empty or true |
extension.where(url='http://hl7.org/fhir/5.0/StructureDefinition/extension-Dosage.asNeededFor').empty() or asNeeded.empty() or asNeeded
|
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
| sqty-1 | error | Dosage.doseAndRate.dose[x]:doseRange.low, Dosage.doseAndRate.dose[x]:doseRange.high, Dosage.maxDosePerAdministration, Dosage.maxDosePerLifetime | The comparator is not used on a SimpleQuantity |
comparator.empty()
|
This structure is derived from Dosage
Summary
Must-Support: 29 elements
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Dosage |
C | 0..* | Dosage | How the medication is/was taken or should be taken Constraints: DosageStructuredOrFreeTextWarning, DosageStructuredRequiresBothWarning, DosageDoseUnitSameCodeWarning, DosageDoseValuePositiveWarning, DosageLimitsPositiveWarning, DosageFourSlotPatternInTextWarning, FreeTextSingleDosageOnlyWarning, AsNeededForRequiresAsNeededWarning, dos-1 |
| Slices for extension |
Content/Rules for all slices | |||
| extension:asNeededFor |
0..* | (Complex) | Indikation für die Bedarfsdosierung URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Dosage.asNeededFor | |
| extension |
0..0 | Extension Slice: Unordered, Open by value:url | ||
| url |
1..1 | uri | "http://hl7.org/fhir/5.0/StructureDefinition/extension-Dosage.asNeededFor" | |
| value[x] |
0..1 | CodeableConcept | Value of extension Binding: SNOMEDCTMedicationAsNeededReasonCodes (example) | |
| text |
0..1 | string | Plain text representation of the concept | |
| Slices for modifierExtension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
| modifierExtension:minimumIntervalBetweenAdministrations |
0..1 | (Complex) | Mindestabstand zwischen zwei Gaben URL: http://ig.fhir.de/igs/medication/StructureDefinition/MinimumIntervalBetweenAdministrations | |
| extension |
0..0 | Extension Slice: Unordered, Open by value:url | ||
| url |
1..1 | uri | "http://ig.fhir.de/igs/medication/StructureDefinition/MinimumIntervalBetweenAdministrations" | |
| value[x] |
1..1 | Duration | Mindestabstand zwischen zwei Gaben | |
| comparator |
0..1 | code | < | <= | >= | > - how to understand the value Binding: QuantityComparator (required): How the Quantity should be understood and represented. | |
| unit |
0..1 | string | Unit representation | |
| system |
C | 0..1 | uri | System that defines coded unit form |
| code |
0..1 | code | Coded form of the unit | |
| text |
0..1 | string | Freitext-Dosierungsanweisungen, z. B. 'Maximal 3x täglich 1 Stück bei Bedarf' | |
| patientInstruction |
0..1 | string | Ergänzende Anwendungshinweise für Patientinnen und Patienten | |
| timing |
0..1 | TimingDE | Wann das Medikament verabreicht werden soll | |
| asNeeded[x] |
0..1 | boolean | Bedarfsdosierung (nur Ja/Nein-Angabe) | |
| doseAndRate |
0..* | Element | Menge des verabreichten Medikaments | |
| Slices for dose[x] |
0..1 | Amount of medication per dose Slice: Unordered, Closed by type:$this Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | ||
| doseRange |
Range | |||
| doseQuantity |
Quantity(SimpleQuantity) | |||
| dose[x]:doseQuantity |
0..1 | SimpleQuantity |
Menge des Medikaments pro Dosis Binding: Dosage DoseQuantity ValueSet (required) | |
| value |
0..1 | decimal | Numerical value (with implicit precision) | |
| unit |
0..1 | string | Unit representation | |
| system |
C | 0..1 | uri | System that defines coded unit form |
| code |
0..1 | code | Coded form of the unit | |
| dose[x]:doseRange |
0..1 | Range | Amount of medication per dose | |
| low |
C | 0..1 | SimpleQuantity(4.0.1) | Low limit Binding: Dosage DoseQuantity ValueSet (required) Constraints: sqty-1 |
| value |
0..1 | decimal | Numerical value (with implicit precision) | |
| unit |
0..1 | string | Unit representation | |
| system |
C | 0..1 | uri | System that defines coded unit form |
| code |
0..1 | code | Coded form of the unit | |
| high |
C | 0..1 | SimpleQuantity(4.0.1) | High limit Binding: Dosage DoseQuantity ValueSet (required) Constraints: sqty-1 |
| value |
0..1 | decimal | Numerical value (with implicit precision) | |
| unit |
0..1 | string | Unit representation | |
| system |
C | 0..1 | uri | System that defines coded unit form |
| code |
0..1 | code | Coded form of the unit | |
| maxDosePerPeriod |
0..1 | Ratio | Maximale Dosis pro Zeitraum | |
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Dosage.extension:asNeededFor.value[x] | Base | example | SNOMED CT Medication As Needed Reason Codes | 📦4.0.1 | FHIR Std. |
| Dosage.modifierExtension:minimumIntervalBetweenAdministrations.value[x].comparator | Base | required | QuantityComparator | 📍4.0.1 | FHIR Std. |
| Dosage.doseAndRate.dose[x]:doseQuantity | Base | required | Dosage DoseQuantity ValueSet | 📦2.0.0-ballot | This IG |
| Dosage.doseAndRate.dose[x]:doseRange.low | Base | required | Dosage DoseQuantity ValueSet | 📦2.0.0-ballot | This IG |
| Dosage.doseAndRate.dose[x]:doseRange.high | Base | required | Dosage DoseQuantity ValueSet | 📦2.0.0-ballot | This IG |
| Id | Grade | Path(s) | Description | Expression |
| AsNeededForRequiresAsNeededWarning | warning | Dosage | A reason for use (asNeededFor) should only be given together with asNeededBoolean = true. |
extension.where(url='http://hl7.org/fhir/5.0/StructureDefinition/extension-Dosage.asNeededFor').exists() implies asNeeded.ofType(boolean) = true
|
| DosageDoseUnitSameCodeWarning | warning | Dosage | The dose unit should be the same across all dosages. |
(%resource.ofType(MedicationRequest).dosageInstruction | %resource.ofType(MedicationDispense).dosageInstruction | %resource.ofType(MedicationStatement).dosage).all(
doseAndRate.exists() implies
(
(%resource.ofType(MedicationRequest).dosageInstruction | %resource.ofType(MedicationDispense).dosageInstruction | %resource.ofType(MedicationStatement).dosage).doseAndRate.dose.ofType(Quantity).code |
(%resource.ofType(MedicationRequest).dosageInstruction | %resource.ofType(MedicationDispense).dosageInstruction | %resource.ofType(MedicationStatement).dosage).doseAndRate.dose.ofType(Range).low.code |
(%resource.ofType(MedicationRequest).dosageInstruction | %resource.ofType(MedicationDispense).dosageInstruction | %resource.ofType(MedicationStatement).dosage).doseAndRate.dose.ofType(Range).high.code
).distinct().count() = 1
)
|
| DosageDoseValuePositiveWarning | warning | Dosage | doseQuantity.value and doseRange.high.value should be greater than 0. The value 0 is additionally allowed for doseRange.low.value only. |
doseAndRate.all(
dose.ofType(Quantity).value.all($this > 0) and
dose.ofType(Range).low.value.all($this >= 0) and
dose.ofType(Range).high.value.all($this > 0)
)
|
| DosageFourSlotPatternInTextWarning | warning | Dosage | A four-slot dosing schema (Viererschema, e.g. 1-1-1-1) was detected in Dosage.text. Please check whether it can be represented structurally. |
text.exists() implies text.matches('.*\\d+\\s*[-–]\\s*\\d+\\s*[-–]\\s*\\d+\\s*[-–]\\s*\\d+.*').not()
|
| DosageLimitsPositiveWarning | warning | Dosage | The minimum interval between administrations (valueDuration.value) and maxDosePerPeriod (numerator.value, denominator.value) should be greater than 0. |
modifierExtension.where(
url = 'http://ig.fhir.de/igs/medication/StructureDefinition/MinimumIntervalBetweenAdministrations'
).value.ofType(Duration).value.all($this > 0) and
maxDosePerPeriod.numerator.value.all($this > 0) and
maxDosePerPeriod.denominator.value.all($this > 0)
|
| DosageStructuredOrFreeTextWarning | warning | Dosage | A dosage must be given either as free text only or as complete structured information only; mixing both is not allowed. |
(%resource.ofType(MedicationRequest).dosageInstruction |
%resource.ofType(MedicationDispense).dosageInstruction |
%resource.ofType(MedicationStatement).dosage).all(
(text.exists() and timing.empty() and doseAndRate.empty()) or
(text.empty() and (timing.exists() or doseAndRate.exists()))
)
|
| DosageStructuredRequiresBothWarning | warning | Dosage | If a structured dosage is given, both timing and doseAndRate should be present. For pure as-needed dosages, doseAndRate may be given without timing. |
(%resource.ofType(MedicationRequest).dosageInstruction |
%resource.ofType(MedicationDispense).dosageInstruction |
%resource.ofType(MedicationStatement).dosage).all(
(timing.exists() implies doseAndRate.exists()) and
(doseAndRate.exists() implies (
timing.exists() or
asNeeded.ofType(boolean) = true or
extension.where(url='http://hl7.org/fhir/5.0/StructureDefinition/extension-Dosage.asNeededFor').exists()
))
)
|
| FreeTextSingleDosageOnlyWarning | warning | Dosage | If a dosage is given as pure free text, there should be exactly one Dosage element. |
(
(%resource.ofType(MedicationRequest).dosageInstruction |
%resource.ofType(MedicationDispense).dosageInstruction |
%resource.ofType(MedicationStatement).dosage
).exists(text.exists() and timing.empty() and doseAndRate.empty())
)
implies
(
(%resource.ofType(MedicationRequest).dosageInstruction |
%resource.ofType(MedicationDispense).dosageInstruction |
%resource.ofType(MedicationStatement).dosage
).count() = 1
)
|
| dos-1 | error | Dosage | AsNeededFor can only be set if AsNeeded is empty or true |
extension.where(url='http://hl7.org/fhir/5.0/StructureDefinition/extension-Dosage.asNeededFor').empty() or asNeeded.empty() or asNeeded
|
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
| sqty-1 | error | Dosage.doseAndRate.dose[x]:doseRange.low, Dosage.doseAndRate.dose[x]:doseRange.high | The comparator is not used on a SimpleQuantity |
comparator.empty()
|
Differential View
This structure is derived from Dosage
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Dosage |
C | 0..* | Dosage | How the medication is/was taken or should be taken Constraints: DosageStructuredOrFreeTextWarning, DosageStructuredRequiresBothWarning, DosageDoseUnitSameCodeWarning, DosageDoseValuePositiveWarning, DosageLimitsPositiveWarning, DosageFourSlotPatternInTextWarning, FreeTextSingleDosageOnlyWarning, AsNeededForRequiresAsNeededWarning, dos-1 |
| Slices for extension |
Content/Rules for all slices | |||
| extension:asNeededFor |
0..* | (Complex) | Indikation für die Bedarfsdosierung URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Dosage.asNeededFor | |
| value[x] |
||||
| text |
0..1 | string | Plain text representation of the concept | |
| Slices for modifierExtension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
| modifierExtension:minimumIntervalBetweenAdministrations |
0..1 | (Complex) | Mindestabstand zwischen zwei Gaben URL: http://ig.fhir.de/igs/medication/StructureDefinition/MinimumIntervalBetweenAdministrations | |
| value[x] |
||||
| unit |
0..1 | string | Unit representation | |
| system |
0..1 | uri | System that defines coded unit form | |
| code |
0..1 | code | Coded form of the unit | |
| text |
0..1 | string | Freitext-Dosierungsanweisungen, z. B. 'Maximal 3x täglich 1 Stück bei Bedarf' | |
| patientInstruction |
0..1 | string | Ergänzende Anwendungshinweise für Patientinnen und Patienten | |
| timing |
0..1 | TimingDE | Wann das Medikament verabreicht werden soll | |
| asNeeded[x] |
0..1 | boolean | Bedarfsdosierung (nur Ja/Nein-Angabe) | |
| doseAndRate |
0..* | Element | Menge des verabreichten Medikaments | |
| Slices for dose[x] |
0..1 | Range, SimpleQuantity(4.0.1) | Amount of medication per dose Slice: Unordered, Open by type:$this Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
| dose[x]:doseQuantity |
0..1 | SimpleQuantity | Menge des Medikaments pro Dosis Binding: Dosage DoseQuantity ValueSet (required) | |
| value |
0..1 | decimal | Numerical value (with implicit precision) | |
| unit |
0..1 | string | Unit representation | |
| system |
0..1 | uri | System that defines coded unit form | |
| code |
0..1 | code | Coded form of the unit | |
| dose[x]:doseRange |
0..1 | Range | Amount of medication per dose | |
| low |
0..1 | SimpleQuantity(4.0.1) | Low limit Binding: Dosage DoseQuantity ValueSet (required) | |
| value |
0..1 | decimal | Numerical value (with implicit precision) | |
| unit |
0..1 | string | Unit representation | |
| system |
0..1 | uri | System that defines coded unit form | |
| code |
0..1 | code | Coded form of the unit | |
| high |
0..1 | SimpleQuantity(4.0.1) | High limit Binding: Dosage DoseQuantity ValueSet (required) | |
| value |
0..1 | decimal | Numerical value (with implicit precision) | |
| unit |
0..1 | string | Unit representation | |
| system |
0..1 | uri | System that defines coded unit form | |
| code |
0..1 | code | Coded form of the unit | |
| maxDosePerPeriod |
0..1 | Ratio | Maximale Dosis pro Zeitraum | |
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Dosage.doseAndRate.dose[x]:doseQuantity | Base | required | Dosage DoseQuantity ValueSet | 📦2.0.0-ballot | This IG |
| Dosage.doseAndRate.dose[x]:doseRange.low | Base | required | Dosage DoseQuantity ValueSet | 📦2.0.0-ballot | This IG |
| Dosage.doseAndRate.dose[x]:doseRange.high | Base | required | Dosage DoseQuantity ValueSet | 📦2.0.0-ballot | This IG |
| Id | Grade | Path(s) | Description | Expression |
| AsNeededForRequiresAsNeededWarning | warning | Dosage | A reason for use (asNeededFor) should only be given together with asNeededBoolean = true. |
extension.where(url='http://hl7.org/fhir/5.0/StructureDefinition/extension-Dosage.asNeededFor').exists() implies asNeeded.ofType(boolean) = true
|
| DosageDoseUnitSameCodeWarning | warning | Dosage | The dose unit should be the same across all dosages. |
(%resource.ofType(MedicationRequest).dosageInstruction | %resource.ofType(MedicationDispense).dosageInstruction | %resource.ofType(MedicationStatement).dosage).all(
doseAndRate.exists() implies
(
(%resource.ofType(MedicationRequest).dosageInstruction | %resource.ofType(MedicationDispense).dosageInstruction | %resource.ofType(MedicationStatement).dosage).doseAndRate.dose.ofType(Quantity).code |
(%resource.ofType(MedicationRequest).dosageInstruction | %resource.ofType(MedicationDispense).dosageInstruction | %resource.ofType(MedicationStatement).dosage).doseAndRate.dose.ofType(Range).low.code |
(%resource.ofType(MedicationRequest).dosageInstruction | %resource.ofType(MedicationDispense).dosageInstruction | %resource.ofType(MedicationStatement).dosage).doseAndRate.dose.ofType(Range).high.code
).distinct().count() = 1
)
|
| DosageDoseValuePositiveWarning | warning | Dosage | doseQuantity.value and doseRange.high.value should be greater than 0. The value 0 is additionally allowed for doseRange.low.value only. |
doseAndRate.all(
dose.ofType(Quantity).value.all($this > 0) and
dose.ofType(Range).low.value.all($this >= 0) and
dose.ofType(Range).high.value.all($this > 0)
)
|
| DosageFourSlotPatternInTextWarning | warning | Dosage | A four-slot dosing schema (Viererschema, e.g. 1-1-1-1) was detected in Dosage.text. Please check whether it can be represented structurally. |
text.exists() implies text.matches('.*\\d+\\s*[-–]\\s*\\d+\\s*[-–]\\s*\\d+\\s*[-–]\\s*\\d+.*').not()
|
| DosageLimitsPositiveWarning | warning | Dosage | The minimum interval between administrations (valueDuration.value) and maxDosePerPeriod (numerator.value, denominator.value) should be greater than 0. |
modifierExtension.where(
url = 'http://ig.fhir.de/igs/medication/StructureDefinition/MinimumIntervalBetweenAdministrations'
).value.ofType(Duration).value.all($this > 0) and
maxDosePerPeriod.numerator.value.all($this > 0) and
maxDosePerPeriod.denominator.value.all($this > 0)
|
| DosageStructuredOrFreeTextWarning | warning | Dosage | A dosage must be given either as free text only or as complete structured information only; mixing both is not allowed. |
(%resource.ofType(MedicationRequest).dosageInstruction |
%resource.ofType(MedicationDispense).dosageInstruction |
%resource.ofType(MedicationStatement).dosage).all(
(text.exists() and timing.empty() and doseAndRate.empty()) or
(text.empty() and (timing.exists() or doseAndRate.exists()))
)
|
| DosageStructuredRequiresBothWarning | warning | Dosage | If a structured dosage is given, both timing and doseAndRate should be present. For pure as-needed dosages, doseAndRate may be given without timing. |
(%resource.ofType(MedicationRequest).dosageInstruction |
%resource.ofType(MedicationDispense).dosageInstruction |
%resource.ofType(MedicationStatement).dosage).all(
(timing.exists() implies doseAndRate.exists()) and
(doseAndRate.exists() implies (
timing.exists() or
asNeeded.ofType(boolean) = true or
extension.where(url='http://hl7.org/fhir/5.0/StructureDefinition/extension-Dosage.asNeededFor').exists()
))
)
|
| FreeTextSingleDosageOnlyWarning | warning | Dosage | If a dosage is given as pure free text, there should be exactly one Dosage element. |
(
(%resource.ofType(MedicationRequest).dosageInstruction |
%resource.ofType(MedicationDispense).dosageInstruction |
%resource.ofType(MedicationStatement).dosage
).exists(text.exists() and timing.empty() and doseAndRate.empty())
)
implies
(
(%resource.ofType(MedicationRequest).dosageInstruction |
%resource.ofType(MedicationDispense).dosageInstruction |
%resource.ofType(MedicationStatement).dosage
).count() = 1
)
|
| dos-1 | error | Dosage | AsNeededFor can only be set if AsNeeded is empty or true |
extension.where(url='http://hl7.org/fhir/5.0/StructureDefinition/extension-Dosage.asNeededFor').empty() or asNeeded.empty() or asNeeded
|
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Dosage |
C | 0..* | Dosage | How the medication is/was taken or should be taken Constraints: DosageStructuredOrFreeTextWarning, DosageStructuredRequiresBothWarning, DosageDoseUnitSameCodeWarning, DosageDoseValuePositiveWarning, DosageLimitsPositiveWarning, DosageFourSlotPatternInTextWarning, FreeTextSingleDosageOnlyWarning, AsNeededForRequiresAsNeededWarning, dos-1 |
| id |
0..1 | string | Unique id for inter-element referencing | |
| Slices for extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| extension:asNeededFor |
0..* | (Complex) | Indikation für die Bedarfsdosierung URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Dosage.asNeededFor | |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..0 | Extension Slice: Unordered, Open by value:url | ||
| url |
1..1 | uri | "http://hl7.org/fhir/5.0/StructureDefinition/extension-Dosage.asNeededFor" | |
| value[x] |
0..1 | CodeableConcept | Value of extension Binding: SNOMEDCTMedicationAsNeededReasonCodes (example) | |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| coding |
0..* | Coding | Code defined by a terminology system | |
| text |
0..1 | string | Plain text representation of the concept | |
| Slices for modifierExtension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
| modifierExtension:minimumIntervalBetweenAdministrations |
0..1 | (Complex) | Mindestabstand zwischen zwei Gaben URL: http://ig.fhir.de/igs/medication/StructureDefinition/MinimumIntervalBetweenAdministrations | |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..0 | Extension Slice: Unordered, Open by value:url | ||
| url |
1..1 | uri | "http://ig.fhir.de/igs/medication/StructureDefinition/MinimumIntervalBetweenAdministrations" | |
| value[x] |
1..1 | Duration | Mindestabstand zwischen zwei Gaben | |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| value |
0..1 | decimal | Numerical value (with implicit precision) | |
| comparator |
0..1 | code | < | <= | >= | > - how to understand the value Binding: QuantityComparator (required): How the Quantity should be understood and represented. | |
| unit |
0..1 | string | Unit representation | |
| system |
C | 0..1 | uri | System that defines coded unit form |
| code |
0..1 | code | Coded form of the unit | |
| sequence |
0..1 | integer | The order of the dosage instructions | |
| text |
0..1 | string | Freitext-Dosierungsanweisungen, z. B. 'Maximal 3x täglich 1 Stück bei Bedarf' | |
| additionalInstruction |
0..* | CodeableConcept | Supplemental instruction or warnings to the patient - e.g. "with meals", "may cause drowsiness" Binding: SNOMEDCTAdditionalDosageInstructions (example): A coded concept identifying additional instructions such as "take with water" or "avoid operating heavy machinery". | |
| patientInstruction |
0..1 | string | Ergänzende Anwendungshinweise für Patientinnen und Patienten | |
| timing |
0..1 | TimingDE | Wann das Medikament verabreicht werden soll | |
| asNeeded[x] |
0..1 | boolean | Bedarfsdosierung (nur Ja/Nein-Angabe) | |
| site |
0..1 | CodeableConcept | Body site to administer to Binding: SNOMEDCTAnatomicalStructureForAdministrationSiteCodes (example): A coded concept describing the site location the medicine enters into or onto the body. | |
| route |
0..1 | CodeableConcept | How drug should enter body Binding: SNOMEDCTRouteCodes (example): A coded concept describing the route or physiological path of administration of a therapeutic agent into or onto the body of a subject. | |
| method |
0..1 | CodeableConcept | Technique for administering medication Binding: SNOMEDCTAdministrationMethodCodes (example): A coded concept describing the technique by which the medicine is administered. | |
| doseAndRate |
0..* | Element | Menge des verabreichten Medikaments | |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| type |
0..1 | CodeableConcept | The kind of dose or rate specified Binding: DoseAndRateType (example): The kind of dose or rate specified. | |
| Slices for dose[x] |
0..1 | Amount of medication per dose Slice: Unordered, Closed by type:$this Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | ||
| doseRange |
Range | |||
| doseQuantity |
Quantity(SimpleQuantity) | |||
| dose[x]:doseQuantity |
0..1 | SimpleQuantity |
Menge des Medikaments pro Dosis Binding: Dosage DoseQuantity ValueSet (required) | |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| value |
0..1 | decimal | Numerical value (with implicit precision) | |
| unit |
0..1 | string | Unit representation | |
| system |
C | 0..1 | uri | System that defines coded unit form |
| code |
0..1 | code | Coded form of the unit | |
| dose[x]:doseRange |
0..1 | Range | Amount of medication per dose | |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| low |
C | 0..1 | SimpleQuantity(4.0.1) | Low limit Binding: Dosage DoseQuantity ValueSet (required) Constraints: sqty-1 |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| value |
0..1 | decimal | Numerical value (with implicit precision) | |
| unit |
0..1 | string | Unit representation | |
| system |
C | 0..1 | uri | System that defines coded unit form |
| code |
0..1 | code | Coded form of the unit | |
| high |
C | 0..1 | SimpleQuantity(4.0.1) | High limit Binding: Dosage DoseQuantity ValueSet (required) Constraints: sqty-1 |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| value |
0..1 | decimal | Numerical value (with implicit precision) | |
| unit |
0..1 | string | Unit representation | |
| system |
C | 0..1 | uri | System that defines coded unit form |
| code |
0..1 | code | Coded form of the unit | |
| rate[x] |
0..1 | Amount of medication per unit of time | ||
| rateRatio |
Ratio | |||
| rateRange |
Range | |||
| rateQuantity |
Quantity(SimpleQuantity) | |||
| maxDosePerPeriod |
0..1 | Ratio | Maximale Dosis pro Zeitraum | |
| maxDosePerAdministration |
C | 0..1 | SimpleQuantity(4.0.1) | Upper limit on medication per administration Constraints: sqty-1 |
| maxDosePerLifetime |
C | 0..1 | SimpleQuantity(4.0.1) | Upper limit on medication per lifetime of the patient Constraints: sqty-1 |
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Dosage.extension:asNeededFor.value[x] | Base | example | SNOMED CT Medication As Needed Reason Codes | 📦4.0.1 | FHIR Std. |
| Dosage.modifierExtension:minimumIntervalBetweenAdministrations.value[x].comparator | Base | required | QuantityComparator | 📍4.0.1 | FHIR Std. |
| Dosage.additionalInstruction | Base | example | SNOMED CT Additional Dosage Instructions | 📍4.0.1 | FHIR Std. |
| Dosage.site | Base | example | SNOMED CT Anatomical Structure for Administration Site Codes | 📍4.0.1 | FHIR Std. |
| Dosage.route | Base | example | SNOMED CT Route Codes | 📍4.0.1 | FHIR Std. |
| Dosage.method | Base | example | SNOMED CT Administration Method Codes | 📍4.0.1 | FHIR Std. |
| Dosage.doseAndRate.type | Base | example | DoseAndRateType | 📍4.0.1 | FHIR Std. |
| Dosage.doseAndRate.dose[x]:doseQuantity | Base | required | Dosage DoseQuantity ValueSet | 📦2.0.0-ballot | This IG |
| Dosage.doseAndRate.dose[x]:doseRange.low | Base | required | Dosage DoseQuantity ValueSet | 📦2.0.0-ballot | This IG |
| Dosage.doseAndRate.dose[x]:doseRange.high | Base | required | Dosage DoseQuantity ValueSet | 📦2.0.0-ballot | This IG |
| Id | Grade | Path(s) | Description | Expression |
| AsNeededForRequiresAsNeededWarning | warning | Dosage | A reason for use (asNeededFor) should only be given together with asNeededBoolean = true. |
extension.where(url='http://hl7.org/fhir/5.0/StructureDefinition/extension-Dosage.asNeededFor').exists() implies asNeeded.ofType(boolean) = true
|
| DosageDoseUnitSameCodeWarning | warning | Dosage | The dose unit should be the same across all dosages. |
(%resource.ofType(MedicationRequest).dosageInstruction | %resource.ofType(MedicationDispense).dosageInstruction | %resource.ofType(MedicationStatement).dosage).all(
doseAndRate.exists() implies
(
(%resource.ofType(MedicationRequest).dosageInstruction | %resource.ofType(MedicationDispense).dosageInstruction | %resource.ofType(MedicationStatement).dosage).doseAndRate.dose.ofType(Quantity).code |
(%resource.ofType(MedicationRequest).dosageInstruction | %resource.ofType(MedicationDispense).dosageInstruction | %resource.ofType(MedicationStatement).dosage).doseAndRate.dose.ofType(Range).low.code |
(%resource.ofType(MedicationRequest).dosageInstruction | %resource.ofType(MedicationDispense).dosageInstruction | %resource.ofType(MedicationStatement).dosage).doseAndRate.dose.ofType(Range).high.code
).distinct().count() = 1
)
|
| DosageDoseValuePositiveWarning | warning | Dosage | doseQuantity.value and doseRange.high.value should be greater than 0. The value 0 is additionally allowed for doseRange.low.value only. |
doseAndRate.all(
dose.ofType(Quantity).value.all($this > 0) and
dose.ofType(Range).low.value.all($this >= 0) and
dose.ofType(Range).high.value.all($this > 0)
)
|
| DosageFourSlotPatternInTextWarning | warning | Dosage | A four-slot dosing schema (Viererschema, e.g. 1-1-1-1) was detected in Dosage.text. Please check whether it can be represented structurally. |
text.exists() implies text.matches('.*\\d+\\s*[-–]\\s*\\d+\\s*[-–]\\s*\\d+\\s*[-–]\\s*\\d+.*').not()
|
| DosageLimitsPositiveWarning | warning | Dosage | The minimum interval between administrations (valueDuration.value) and maxDosePerPeriod (numerator.value, denominator.value) should be greater than 0. |
modifierExtension.where(
url = 'http://ig.fhir.de/igs/medication/StructureDefinition/MinimumIntervalBetweenAdministrations'
).value.ofType(Duration).value.all($this > 0) and
maxDosePerPeriod.numerator.value.all($this > 0) and
maxDosePerPeriod.denominator.value.all($this > 0)
|
| DosageStructuredOrFreeTextWarning | warning | Dosage | A dosage must be given either as free text only or as complete structured information only; mixing both is not allowed. |
(%resource.ofType(MedicationRequest).dosageInstruction |
%resource.ofType(MedicationDispense).dosageInstruction |
%resource.ofType(MedicationStatement).dosage).all(
(text.exists() and timing.empty() and doseAndRate.empty()) or
(text.empty() and (timing.exists() or doseAndRate.exists()))
)
|
| DosageStructuredRequiresBothWarning | warning | Dosage | If a structured dosage is given, both timing and doseAndRate should be present. For pure as-needed dosages, doseAndRate may be given without timing. |
(%resource.ofType(MedicationRequest).dosageInstruction |
%resource.ofType(MedicationDispense).dosageInstruction |
%resource.ofType(MedicationStatement).dosage).all(
(timing.exists() implies doseAndRate.exists()) and
(doseAndRate.exists() implies (
timing.exists() or
asNeeded.ofType(boolean) = true or
extension.where(url='http://hl7.org/fhir/5.0/StructureDefinition/extension-Dosage.asNeededFor').exists()
))
)
|
| FreeTextSingleDosageOnlyWarning | warning | Dosage | If a dosage is given as pure free text, there should be exactly one Dosage element. |
(
(%resource.ofType(MedicationRequest).dosageInstruction |
%resource.ofType(MedicationDispense).dosageInstruction |
%resource.ofType(MedicationStatement).dosage
).exists(text.exists() and timing.empty() and doseAndRate.empty())
)
implies
(
(%resource.ofType(MedicationRequest).dosageInstruction |
%resource.ofType(MedicationDispense).dosageInstruction |
%resource.ofType(MedicationStatement).dosage
).count() = 1
)
|
| dos-1 | error | Dosage | AsNeededFor can only be set if AsNeeded is empty or true |
extension.where(url='http://hl7.org/fhir/5.0/StructureDefinition/extension-Dosage.asNeededFor').empty() or asNeeded.empty() or asNeeded
|
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
| sqty-1 | error | Dosage.doseAndRate.dose[x]:doseRange.low, Dosage.doseAndRate.dose[x]:doseRange.high, Dosage.maxDosePerAdministration, Dosage.maxDosePerLifetime | The comparator is not used on a SimpleQuantity |
comparator.empty()
|
This structure is derived from Dosage
Summary
Must-Support: 29 elements
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
Other representations of profile: CSV, Excel, Schematron
IG © 2025+ HL7 Deutschland e.V.. Package de.fhir.medication#2.0.0-ballot based on FHIR 4.0.1. Generated 2026-10-14
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change