CH EMED (R4)
6.0.0-ci-build - ci-build
CH EMED (R4), published by HL7 Switzerland. This guide is not an authorized publication; it is the continuous build for version 6.0.0-ci-build built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/hl7ch/ch-emed/ and changes regularly. See the Directory of published versions
| Official URL: http://fhir.ch/ig/ch-emed/StructureDefinition/ch-emed-dosage | Version: 6.0.0-ci-build | |||
| Active as of 2025-11-06 | Computable Name: CHEMEDDosage | |||
Copyright/Legal: CC0-1.0 |
||||
Definition of the dosage (used in MedicationStatement / MedicationDispense)
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: ![]() ![]() |
|---|---|---|---|---|
![]() |
C | 0..* | CHCoreDosage | CH EMED Dosage (MedicationStatement / MedicationDispense) Constraints: ch-dosage-4 |
![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() |
ΣC | 0..1 | integer | The order of the dosage instructions Constraints: ch-dosage-1 |
![]() ![]() |
SΣ | 0..1 | string | Patient instructions (e.g. 'take with food'), incl. free text dosage instructions (e.g. for complex dosage) |
![]() ![]() |
Σ | 0..1 | Timing | When medication should be administered |
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() |
ΣC | 0..1 | Element | When the event is to occur Constraints: tim-1, tim-2, tim-4, tim-5, tim-6, tim-7, tim-8, tim-9, tim-10 |
![]() ![]() ![]() ![]() |
Σ | 0..1 | Length/Range of lengths, or (Start and/or end) limits Slice: Unordered, Open by type:$this | |
![]() ![]() ![]() ![]() ![]() |
Duration | |||
![]() ![]() ![]() ![]() ![]() |
Range | |||
![]() ![]() ![]() ![]() ![]() |
Period | |||
![]() ![]() ![]() ![]() ![]() |
SΣ | 0..1 | Period | Start and/or end of treatment |
![]() ![]() ![]() ![]() |
SΣC | 0..* | code | Code for time period of occurrence Binding: EventTiming (required): Real world event relating to the schedule. Constraints: ch-emed-event-timing |
![]() ![]() |
Σ | 0..1 | Take "as needed" (for x) Slice: Unordered, Open by type:$this Binding: SNOMEDCTMedicationAsNeededReasonCodes (example): A coded concept identifying the precondition that should be met or evaluated prior to consuming or administering a medication dose. For example "pain", "30 minutes prior to sexual intercourse", "on flare-up" etc. | |
![]() ![]() ![]() |
boolean | |||
![]() ![]() ![]() |
CodeableConcept | |||
![]() ![]() ![]() |
Σ | 0..1 | boolean | In reserve (to be taken by the patient only if the need arises - e.g. pains) |
![]() ![]() |
Σ | 0..1 | CodeableConcept | Route of administration Binding: EDQM - RouteOfAdministration (required) |
![]() ![]() ![]() |
SΣ | 1..* | Coding | Code defined by a terminology system |
![]() ![]() ![]() ![]() |
Σ | 1..1 | uri | Identity of the terminology system |
![]() ![]() ![]() ![]() |
Σ | 1..1 | code | Symbol in syntax defined by the system |
![]() ![]() |
Σ | 0..1 | CodeableConcept | Administration method Binding: EDQM - Administration Method (required) |
![]() ![]() ![]() |
Σ | 1..* | Coding | Code defined by a terminology system |
![]() ![]() ![]() ![]() |
Σ | 1..1 | uri | Identity of the terminology system |
![]() ![]() ![]() ![]() |
Σ | 1..1 | code | Symbol in syntax defined by the system |
![]() ![]() |
Σ | 0..1 | Element | Amount of medication administered |
![]() ![]() ![]() |
SΣ | 0..1 | Amount of medication per dose | |
![]() ![]() ![]() ![]() |
Range(CHCoreRangeWithEmedUnits) | |||
![]() ![]() ![]() ![]() |
Quantity(CHCoreQuantityWithEmedUnits) | |||
Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Dosage.timing.repeat.when | Base | required | EventTiming | 📍4.0.1 | FHIR Std. |
| Dosage.asNeeded[x] | Base | example | SNOMED CT Medication As Needed Reason Codes | 📍4.0.1 | FHIR Std. |
| Dosage.route | Base | required | EDQM - RouteOfAdministration | 📦3.2.0 | CH Term v3.2 |
| Dosage.method | Base | required | EDQM - Administration Method | 📦3.2.0 | CH Term v3.2 |
| Id | Grade | Path(s) | Description | Expression |
| ch-dosage-1 | error | Dosage.sequence | No sequence number (for one dosage element) or sequence number = 1 (for more than one dosage element) |
$this.count() = 0 or $this = 1
|
| ch-dosage-4 | error | Dosage | For split dosage timing event and dose/rate are required |
sequence.exists() implies (timing.repeat.when.exists() and doseAndRate.dose.exists())
|
| ch-emed-event-timing | warning | Dosage.timing.repeat.when | For the representation of the time of administration according to the 1-1-1-1 scheme, the values MORN-NOON-EVE-NIGHT are highly recommended. |
$this='MORN' or $this='NOON' or $this='EVE' or $this='NIGHT'
|
| 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()
|
| tim-1 | error | Dosage.timing.repeat | if there's a duration, there needs to be duration units |
duration.empty() or durationUnit.exists()
|
| tim-2 | error | Dosage.timing.repeat | if there's a period, there needs to be period units |
period.empty() or periodUnit.exists()
|
| tim-4 | error | Dosage.timing.repeat | duration SHALL be a non-negative value |
duration.exists() implies duration >= 0
|
| tim-5 | error | Dosage.timing.repeat | period SHALL be a non-negative value |
period.exists() implies period >= 0
|
| tim-6 | error | Dosage.timing.repeat | If there's a periodMax, there must be a period |
periodMax.empty() or period.exists()
|
| tim-7 | error | Dosage.timing.repeat | If there's a durationMax, there must be a duration |
durationMax.empty() or duration.exists()
|
| tim-8 | error | Dosage.timing.repeat | If there's a countMax, there must be a count |
countMax.empty() or count.exists()
|
| tim-9 | error | Dosage.timing.repeat | If there's an offset, there must be a when (and not C, CM, CD, CV) |
offset.empty() or (when.exists() and ((when in ('C' | 'CM' | 'CD' | 'CV')).not()))
|
| tim-10 | error | Dosage.timing.repeat | If there's a timeOfDay, there cannot be a when, or vice versa |
timeOfDay.empty() or when.empty()
|
This structure is derived from CHCoreDosage
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
C | 0..* | CHCoreDosage | CH EMED Dosage (MedicationStatement / MedicationDispense) Constraints: ch-dosage-4 |
![]() ![]() |
C | 0..1 | integer | The order of the dosage instructions Constraints: ch-dosage-1 |
![]() ![]() |
S | 0..1 | string | Patient instructions (e.g. 'take with food'), incl. free text dosage instructions (e.g. for complex dosage) |
![]() ![]() |
||||
![]() ![]() ![]() |
||||
![]() ![]() ![]() ![]() |
0..1 | Duration, Range, Period | Length/Range of lengths, or (Start and/or end) limits Slice: Unordered, Open by type:$this | |
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | Period | Start and/or end of treatment |
![]() ![]() ![]() ![]() |
SC | 0..* | code | Code for time period of occurrence Constraints: ch-emed-event-timing |
![]() ![]() |
0..1 | boolean, CodeableConcept | Take "as needed" (for x) Slice: Unordered, Open by type:$this | |
![]() ![]() ![]() |
0..1 | boolean | In reserve (to be taken by the patient only if the need arises - e.g. pains) | |
![]() ![]() |
0..1 | CodeableConcept | Route of administration Binding: EDQM - RouteOfAdministration (required) | |
![]() ![]() ![]() |
S | 1..* | Coding | Code defined by a terminology system |
![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system | |
![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system | |
![]() ![]() |
0..1 | CodeableConcept | Administration method Binding: EDQM - Administration Method (required) | |
![]() ![]() ![]() |
1..* | Coding | Code defined by a terminology system | |
![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system | |
![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system | |
![]() ![]() |
0..1 | Element | Amount of medication administered | |
![]() ![]() ![]() |
S | 0..1 | CHCoreRangeWithEmedUnits, CHCoreQuantityWithEmedUnits | Amount of medication per dose |
Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Dosage.route | Base | required | EDQM - RouteOfAdministration | 📦3.2.0 | CH Term v3.2 |
| Dosage.method | Base | required | EDQM - Administration Method | 📦3.2.0 | CH Term v3.2 |
| Id | Grade | Path(s) | Description | Expression |
| ch-dosage-1 | error | Dosage.sequence | No sequence number (for one dosage element) or sequence number = 1 (for more than one dosage element) |
$this.count() = 0 or $this = 1
|
| ch-dosage-4 | error | Dosage | For split dosage timing event and dose/rate are required |
sequence.exists() implies (timing.repeat.when.exists() and doseAndRate.dose.exists())
|
| ch-emed-event-timing | warning | Dosage.timing.repeat.when | For the representation of the time of administration according to the 1-1-1-1 scheme, the values MORN-NOON-EVE-NIGHT are highly recommended. |
$this='MORN' or $this='NOON' or $this='EVE' or $this='NIGHT'
|
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
C | 0..* | CHCoreDosage | CH EMED Dosage (MedicationStatement / MedicationDispense) Constraints: ch-dosage-4 |
![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |
![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() |
ΣC | 0..1 | integer | The order of the dosage instructions Constraints: ch-dosage-1 |
![]() ![]() |
Σ | 0..1 | string | Free text dosage instructions e.g. SIG |
![]() ![]() |
Σ | 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". |
![]() ![]() |
SΣ | 0..1 | string | Patient instructions (e.g. 'take with food'), incl. free text dosage instructions (e.g. for complex dosage) |
![]() ![]() |
Σ | 0..1 | Timing | When medication should be administered |
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() |
Σ | 0..* | dateTime | When the event occurs |
![]() ![]() ![]() |
ΣC | 0..1 | Element | When the event is to occur Constraints: tim-1, tim-2, tim-4, tim-5, tim-6, tim-7, tim-8, tim-9, tim-10 |
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() |
Σ | 0..1 | Length/Range of lengths, or (Start and/or end) limits Slice: Unordered, Open by type:$this | |
![]() ![]() ![]() ![]() ![]() |
Duration | |||
![]() ![]() ![]() ![]() ![]() |
Range | |||
![]() ![]() ![]() ![]() ![]() |
Period | |||
![]() ![]() ![]() ![]() ![]() |
SΣ | 0..1 | Period | Start and/or end of treatment |
![]() ![]() ![]() ![]() |
Σ | 0..1 | positiveInt | Number of times to repeat |
![]() ![]() ![]() ![]() |
Σ | 0..1 | positiveInt | Maximum number of times to repeat |
![]() ![]() ![]() ![]() |
Σ | 0..1 | decimal | How long when it happens |
![]() ![]() ![]() ![]() |
Σ | 0..1 | decimal | How long when it happens (Max) |
![]() ![]() ![]() ![]() |
Σ | 0..1 | code | s | min | h | d | wk | mo | a - unit of time (UCUM) Binding: UnitsOfTime (required): A unit of time (units from UCUM). |
![]() ![]() ![]() ![]() |
Σ | 0..1 | positiveInt | Event occurs frequency times per period |
![]() ![]() ![]() ![]() |
Σ | 0..1 | positiveInt | Event occurs up to frequencyMax times per period |
![]() ![]() ![]() ![]() |
Σ | 0..1 | decimal | Event occurs frequency times per period |
![]() ![]() ![]() ![]() |
Σ | 0..1 | decimal | Upper limit of period (3-4 hours) |
![]() ![]() ![]() ![]() |
Σ | 0..1 | code | s | min | h | d | wk | mo | a - unit of time (UCUM) Binding: UnitsOfTime (required): A unit of time (units from UCUM). |
![]() ![]() ![]() ![]() |
Σ | 0..* | code | mon | tue | wed | thu | fri | sat | sun Binding: DaysOfWeek (required) |
![]() ![]() ![]() ![]() |
Σ | 0..* | time | Time of day for action |
![]() ![]() ![]() ![]() |
SΣC | 0..* | code | Code for time period of occurrence Binding: EventTiming (required): Real world event relating to the schedule. Constraints: ch-emed-event-timing |
![]() ![]() ![]() ![]() |
Σ | 0..1 | unsignedInt | Minutes from event (before or after) |
![]() ![]() ![]() |
Σ | 0..1 | CodeableConcept | BID | TID | QID | AM | PM | QD | QOD | + Binding: TimingAbbreviation (preferred): Code for a known / defined timing pattern. |
![]() ![]() |
Σ | 0..1 | Take "as needed" (for x) Slice: Unordered, Open by type:$this Binding: SNOMEDCTMedicationAsNeededReasonCodes (example): A coded concept identifying the precondition that should be met or evaluated prior to consuming or administering a medication dose. For example "pain", "30 minutes prior to sexual intercourse", "on flare-up" etc. | |
![]() ![]() ![]() |
boolean | |||
![]() ![]() ![]() |
CodeableConcept | |||
![]() ![]() ![]() |
Σ | 0..1 | boolean | In reserve (to be taken by the patient only if the need arises - e.g. pains) |
![]() ![]() |
Σ | 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. |
![]() ![]() |
Σ | 0..1 | CodeableConcept | Route of administration Binding: EDQM - RouteOfAdministration (required) |
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
![]() ![]() ![]() |
SΣ | 1..* | Coding | Code defined by a terminology system |
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() |
Σ | 1..1 | uri | Identity of the terminology system |
![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Version of the system - if relevant |
![]() ![]() ![]() ![]() |
Σ | 1..1 | code | Symbol in syntax defined by the system |
![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Representation defined by the system |
![]() ![]() ![]() ![]() |
Σ | 0..1 | boolean | If this coding was chosen directly by the user |
![]() ![]() ![]() |
Σ | 0..1 | string | Plain text representation of the concept |
![]() ![]() |
Σ | 0..1 | CodeableConcept | Administration method Binding: EDQM - Administration Method (required) |
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
![]() ![]() ![]() |
Σ | 1..* | Coding | Code defined by a terminology system |
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() |
Σ | 1..1 | uri | Identity of the terminology system |
![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Version of the system - if relevant |
![]() ![]() ![]() ![]() |
Σ | 1..1 | code | Symbol in syntax defined by the system |
![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Representation defined by the system |
![]() ![]() ![]() ![]() |
Σ | 0..1 | boolean | If this coding was chosen directly by the user |
![]() ![]() ![]() |
Σ | 0..1 | string | Plain text representation of the concept |
![]() ![]() |
Σ | 0..1 | Element | Amount of medication administered |
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
![]() ![]() ![]() |
Σ | 0..1 | CodeableConcept | The kind of dose or rate specified Binding: DoseAndRateType (example): The kind of dose or rate specified. |
![]() ![]() ![]() |
SΣ | 0..1 | Amount of medication per dose | |
![]() ![]() ![]() ![]() |
Range(CHCoreRangeWithEmedUnits) | |||
![]() ![]() ![]() ![]() |
Quantity(CHCoreQuantityWithEmedUnits) | |||
![]() ![]() ![]() |
Σ | 0..1 | Amount of medication per unit of time | |
![]() ![]() ![]() ![]() |
Ratio | |||
![]() ![]() ![]() ![]() |
Range | |||
![]() ![]() ![]() ![]() |
Quantity(SimpleQuantity) | |||
![]() ![]() |
Σ | 0..1 | Ratio | Upper limit on medication per unit of time |
![]() ![]() |
Σ | 0..1 | SimpleQuantity(4.0.1) | Upper limit on medication per administration |
![]() ![]() |
Σ | 0..1 | SimpleQuantity(4.0.1) | Upper limit on medication per lifetime of the patient |
Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Dosage.additionalInstruction | Base | example | SNOMED CT Additional Dosage Instructions | 📍4.0.1 | FHIR Std. |
| Dosage.timing.repeat.durationUnit | Base | required | UnitsOfTime | 📍4.0.1 | FHIR Std. |
| Dosage.timing.repeat.periodUnit | Base | required | UnitsOfTime | 📍4.0.1 | FHIR Std. |
| Dosage.timing.repeat.dayOfWeek | Base | required | DaysOfWeek | 📍4.0.1 | FHIR Std. |
| Dosage.timing.repeat.when | Base | required | EventTiming | 📍4.0.1 | FHIR Std. |
| Dosage.timing.code | Base | preferred | TimingAbbreviation | 📍4.0.1 | FHIR Std. |
| Dosage.asNeeded[x] | Base | example | SNOMED CT Medication As Needed Reason Codes | 📍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 | required | EDQM - RouteOfAdministration | 📦3.2.0 | CH Term v3.2 |
| Dosage.method | Base | required | EDQM - Administration Method | 📦3.2.0 | CH Term v3.2 |
| Dosage.doseAndRate.type | Base | example | DoseAndRateType | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| ch-dosage-1 | error | Dosage.sequence | No sequence number (for one dosage element) or sequence number = 1 (for more than one dosage element) |
$this.count() = 0 or $this = 1
|
| ch-dosage-4 | error | Dosage | For split dosage timing event and dose/rate are required |
sequence.exists() implies (timing.repeat.when.exists() and doseAndRate.dose.exists())
|
| ch-emed-event-timing | warning | Dosage.timing.repeat.when | For the representation of the time of administration according to the 1-1-1-1 scheme, the values MORN-NOON-EVE-NIGHT are highly recommended. |
$this='MORN' or $this='NOON' or $this='EVE' or $this='NIGHT'
|
| 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()
|
| tim-1 | error | Dosage.timing.repeat | if there's a duration, there needs to be duration units |
duration.empty() or durationUnit.exists()
|
| tim-2 | error | Dosage.timing.repeat | if there's a period, there needs to be period units |
period.empty() or periodUnit.exists()
|
| tim-4 | error | Dosage.timing.repeat | duration SHALL be a non-negative value |
duration.exists() implies duration >= 0
|
| tim-5 | error | Dosage.timing.repeat | period SHALL be a non-negative value |
period.exists() implies period >= 0
|
| tim-6 | error | Dosage.timing.repeat | If there's a periodMax, there must be a period |
periodMax.empty() or period.exists()
|
| tim-7 | error | Dosage.timing.repeat | If there's a durationMax, there must be a duration |
durationMax.empty() or duration.exists()
|
| tim-8 | error | Dosage.timing.repeat | If there's a countMax, there must be a count |
countMax.empty() or count.exists()
|
| tim-9 | error | Dosage.timing.repeat | If there's an offset, there must be a when (and not C, CM, CD, CV) |
offset.empty() or (when.exists() and ((when in ('C' | 'CM' | 'CD' | 'CV')).not()))
|
| tim-10 | error | Dosage.timing.repeat | If there's a timeOfDay, there cannot be a when, or vice versa |
timeOfDay.empty() or when.empty()
|
This structure is derived from CHCoreDosage
Summary
Mandatory: 0 element(6 nested mandatory elements)
Must-Support: 5 elements
Slices
This structure defines the following Slices:
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
C | 0..* | CHCoreDosage | CH EMED Dosage (MedicationStatement / MedicationDispense) Constraints: ch-dosage-4 |
![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() |
ΣC | 0..1 | integer | The order of the dosage instructions Constraints: ch-dosage-1 |
![]() ![]() |
SΣ | 0..1 | string | Patient instructions (e.g. 'take with food'), incl. free text dosage instructions (e.g. for complex dosage) |
![]() ![]() |
Σ | 0..1 | Timing | When medication should be administered |
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() |
ΣC | 0..1 | Element | When the event is to occur Constraints: tim-1, tim-2, tim-4, tim-5, tim-6, tim-7, tim-8, tim-9, tim-10 |
![]() ![]() ![]() ![]() |
Σ | 0..1 | Length/Range of lengths, or (Start and/or end) limits Slice: Unordered, Open by type:$this | |
![]() ![]() ![]() ![]() ![]() |
Duration | |||
![]() ![]() ![]() ![]() ![]() |
Range | |||
![]() ![]() ![]() ![]() ![]() |
Period | |||
![]() ![]() ![]() ![]() ![]() |
SΣ | 0..1 | Period | Start and/or end of treatment |
![]() ![]() ![]() ![]() |
SΣC | 0..* | code | Code for time period of occurrence Binding: EventTiming (required): Real world event relating to the schedule. Constraints: ch-emed-event-timing |
![]() ![]() |
Σ | 0..1 | Take "as needed" (for x) Slice: Unordered, Open by type:$this Binding: SNOMEDCTMedicationAsNeededReasonCodes (example): A coded concept identifying the precondition that should be met or evaluated prior to consuming or administering a medication dose. For example "pain", "30 minutes prior to sexual intercourse", "on flare-up" etc. | |
![]() ![]() ![]() |
boolean | |||
![]() ![]() ![]() |
CodeableConcept | |||
![]() ![]() ![]() |
Σ | 0..1 | boolean | In reserve (to be taken by the patient only if the need arises - e.g. pains) |
![]() ![]() |
Σ | 0..1 | CodeableConcept | Route of administration Binding: EDQM - RouteOfAdministration (required) |
![]() ![]() ![]() |
SΣ | 1..* | Coding | Code defined by a terminology system |
![]() ![]() ![]() ![]() |
Σ | 1..1 | uri | Identity of the terminology system |
![]() ![]() ![]() ![]() |
Σ | 1..1 | code | Symbol in syntax defined by the system |
![]() ![]() |
Σ | 0..1 | CodeableConcept | Administration method Binding: EDQM - Administration Method (required) |
![]() ![]() ![]() |
Σ | 1..* | Coding | Code defined by a terminology system |
![]() ![]() ![]() ![]() |
Σ | 1..1 | uri | Identity of the terminology system |
![]() ![]() ![]() ![]() |
Σ | 1..1 | code | Symbol in syntax defined by the system |
![]() ![]() |
Σ | 0..1 | Element | Amount of medication administered |
![]() ![]() ![]() |
SΣ | 0..1 | Amount of medication per dose | |
![]() ![]() ![]() ![]() |
Range(CHCoreRangeWithEmedUnits) | |||
![]() ![]() ![]() ![]() |
Quantity(CHCoreQuantityWithEmedUnits) | |||
Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Dosage.timing.repeat.when | Base | required | EventTiming | 📍4.0.1 | FHIR Std. |
| Dosage.asNeeded[x] | Base | example | SNOMED CT Medication As Needed Reason Codes | 📍4.0.1 | FHIR Std. |
| Dosage.route | Base | required | EDQM - RouteOfAdministration | 📦3.2.0 | CH Term v3.2 |
| Dosage.method | Base | required | EDQM - Administration Method | 📦3.2.0 | CH Term v3.2 |
| Id | Grade | Path(s) | Description | Expression |
| ch-dosage-1 | error | Dosage.sequence | No sequence number (for one dosage element) or sequence number = 1 (for more than one dosage element) |
$this.count() = 0 or $this = 1
|
| ch-dosage-4 | error | Dosage | For split dosage timing event and dose/rate are required |
sequence.exists() implies (timing.repeat.when.exists() and doseAndRate.dose.exists())
|
| ch-emed-event-timing | warning | Dosage.timing.repeat.when | For the representation of the time of administration according to the 1-1-1-1 scheme, the values MORN-NOON-EVE-NIGHT are highly recommended. |
$this='MORN' or $this='NOON' or $this='EVE' or $this='NIGHT'
|
| 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()
|
| tim-1 | error | Dosage.timing.repeat | if there's a duration, there needs to be duration units |
duration.empty() or durationUnit.exists()
|
| tim-2 | error | Dosage.timing.repeat | if there's a period, there needs to be period units |
period.empty() or periodUnit.exists()
|
| tim-4 | error | Dosage.timing.repeat | duration SHALL be a non-negative value |
duration.exists() implies duration >= 0
|
| tim-5 | error | Dosage.timing.repeat | period SHALL be a non-negative value |
period.exists() implies period >= 0
|
| tim-6 | error | Dosage.timing.repeat | If there's a periodMax, there must be a period |
periodMax.empty() or period.exists()
|
| tim-7 | error | Dosage.timing.repeat | If there's a durationMax, there must be a duration |
durationMax.empty() or duration.exists()
|
| tim-8 | error | Dosage.timing.repeat | If there's a countMax, there must be a count |
countMax.empty() or count.exists()
|
| tim-9 | error | Dosage.timing.repeat | If there's an offset, there must be a when (and not C, CM, CD, CV) |
offset.empty() or (when.exists() and ((when in ('C' | 'CM' | 'CD' | 'CV')).not()))
|
| tim-10 | error | Dosage.timing.repeat | If there's a timeOfDay, there cannot be a when, or vice versa |
timeOfDay.empty() or when.empty()
|
Differential View
This structure is derived from CHCoreDosage
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
C | 0..* | CHCoreDosage | CH EMED Dosage (MedicationStatement / MedicationDispense) Constraints: ch-dosage-4 |
![]() ![]() |
C | 0..1 | integer | The order of the dosage instructions Constraints: ch-dosage-1 |
![]() ![]() |
S | 0..1 | string | Patient instructions (e.g. 'take with food'), incl. free text dosage instructions (e.g. for complex dosage) |
![]() ![]() |
||||
![]() ![]() ![]() |
||||
![]() ![]() ![]() ![]() |
0..1 | Duration, Range, Period | Length/Range of lengths, or (Start and/or end) limits Slice: Unordered, Open by type:$this | |
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | Period | Start and/or end of treatment |
![]() ![]() ![]() ![]() |
SC | 0..* | code | Code for time period of occurrence Constraints: ch-emed-event-timing |
![]() ![]() |
0..1 | boolean, CodeableConcept | Take "as needed" (for x) Slice: Unordered, Open by type:$this | |
![]() ![]() ![]() |
0..1 | boolean | In reserve (to be taken by the patient only if the need arises - e.g. pains) | |
![]() ![]() |
0..1 | CodeableConcept | Route of administration Binding: EDQM - RouteOfAdministration (required) | |
![]() ![]() ![]() |
S | 1..* | Coding | Code defined by a terminology system |
![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system | |
![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system | |
![]() ![]() |
0..1 | CodeableConcept | Administration method Binding: EDQM - Administration Method (required) | |
![]() ![]() ![]() |
1..* | Coding | Code defined by a terminology system | |
![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system | |
![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system | |
![]() ![]() |
0..1 | Element | Amount of medication administered | |
![]() ![]() ![]() |
S | 0..1 | CHCoreRangeWithEmedUnits, CHCoreQuantityWithEmedUnits | Amount of medication per dose |
Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Dosage.route | Base | required | EDQM - RouteOfAdministration | 📦3.2.0 | CH Term v3.2 |
| Dosage.method | Base | required | EDQM - Administration Method | 📦3.2.0 | CH Term v3.2 |
| Id | Grade | Path(s) | Description | Expression |
| ch-dosage-1 | error | Dosage.sequence | No sequence number (for one dosage element) or sequence number = 1 (for more than one dosage element) |
$this.count() = 0 or $this = 1
|
| ch-dosage-4 | error | Dosage | For split dosage timing event and dose/rate are required |
sequence.exists() implies (timing.repeat.when.exists() and doseAndRate.dose.exists())
|
| ch-emed-event-timing | warning | Dosage.timing.repeat.when | For the representation of the time of administration according to the 1-1-1-1 scheme, the values MORN-NOON-EVE-NIGHT are highly recommended. |
$this='MORN' or $this='NOON' or $this='EVE' or $this='NIGHT'
|
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
C | 0..* | CHCoreDosage | CH EMED Dosage (MedicationStatement / MedicationDispense) Constraints: ch-dosage-4 |
![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |
![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() |
ΣC | 0..1 | integer | The order of the dosage instructions Constraints: ch-dosage-1 |
![]() ![]() |
Σ | 0..1 | string | Free text dosage instructions e.g. SIG |
![]() ![]() |
Σ | 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". |
![]() ![]() |
SΣ | 0..1 | string | Patient instructions (e.g. 'take with food'), incl. free text dosage instructions (e.g. for complex dosage) |
![]() ![]() |
Σ | 0..1 | Timing | When medication should be administered |
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() |
Σ | 0..* | dateTime | When the event occurs |
![]() ![]() ![]() |
ΣC | 0..1 | Element | When the event is to occur Constraints: tim-1, tim-2, tim-4, tim-5, tim-6, tim-7, tim-8, tim-9, tim-10 |
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() |
Σ | 0..1 | Length/Range of lengths, or (Start and/or end) limits Slice: Unordered, Open by type:$this | |
![]() ![]() ![]() ![]() ![]() |
Duration | |||
![]() ![]() ![]() ![]() ![]() |
Range | |||
![]() ![]() ![]() ![]() ![]() |
Period | |||
![]() ![]() ![]() ![]() ![]() |
SΣ | 0..1 | Period | Start and/or end of treatment |
![]() ![]() ![]() ![]() |
Σ | 0..1 | positiveInt | Number of times to repeat |
![]() ![]() ![]() ![]() |
Σ | 0..1 | positiveInt | Maximum number of times to repeat |
![]() ![]() ![]() ![]() |
Σ | 0..1 | decimal | How long when it happens |
![]() ![]() ![]() ![]() |
Σ | 0..1 | decimal | How long when it happens (Max) |
![]() ![]() ![]() ![]() |
Σ | 0..1 | code | s | min | h | d | wk | mo | a - unit of time (UCUM) Binding: UnitsOfTime (required): A unit of time (units from UCUM). |
![]() ![]() ![]() ![]() |
Σ | 0..1 | positiveInt | Event occurs frequency times per period |
![]() ![]() ![]() ![]() |
Σ | 0..1 | positiveInt | Event occurs up to frequencyMax times per period |
![]() ![]() ![]() ![]() |
Σ | 0..1 | decimal | Event occurs frequency times per period |
![]() ![]() ![]() ![]() |
Σ | 0..1 | decimal | Upper limit of period (3-4 hours) |
![]() ![]() ![]() ![]() |
Σ | 0..1 | code | s | min | h | d | wk | mo | a - unit of time (UCUM) Binding: UnitsOfTime (required): A unit of time (units from UCUM). |
![]() ![]() ![]() ![]() |
Σ | 0..* | code | mon | tue | wed | thu | fri | sat | sun Binding: DaysOfWeek (required) |
![]() ![]() ![]() ![]() |
Σ | 0..* | time | Time of day for action |
![]() ![]() ![]() ![]() |
SΣC | 0..* | code | Code for time period of occurrence Binding: EventTiming (required): Real world event relating to the schedule. Constraints: ch-emed-event-timing |
![]() ![]() ![]() ![]() |
Σ | 0..1 | unsignedInt | Minutes from event (before or after) |
![]() ![]() ![]() |
Σ | 0..1 | CodeableConcept | BID | TID | QID | AM | PM | QD | QOD | + Binding: TimingAbbreviation (preferred): Code for a known / defined timing pattern. |
![]() ![]() |
Σ | 0..1 | Take "as needed" (for x) Slice: Unordered, Open by type:$this Binding: SNOMEDCTMedicationAsNeededReasonCodes (example): A coded concept identifying the precondition that should be met or evaluated prior to consuming or administering a medication dose. For example "pain", "30 minutes prior to sexual intercourse", "on flare-up" etc. | |
![]() ![]() ![]() |
boolean | |||
![]() ![]() ![]() |
CodeableConcept | |||
![]() ![]() ![]() |
Σ | 0..1 | boolean | In reserve (to be taken by the patient only if the need arises - e.g. pains) |
![]() ![]() |
Σ | 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. |
![]() ![]() |
Σ | 0..1 | CodeableConcept | Route of administration Binding: EDQM - RouteOfAdministration (required) |
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
![]() ![]() ![]() |
SΣ | 1..* | Coding | Code defined by a terminology system |
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() |
Σ | 1..1 | uri | Identity of the terminology system |
![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Version of the system - if relevant |
![]() ![]() ![]() ![]() |
Σ | 1..1 | code | Symbol in syntax defined by the system |
![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Representation defined by the system |
![]() ![]() ![]() ![]() |
Σ | 0..1 | boolean | If this coding was chosen directly by the user |
![]() ![]() ![]() |
Σ | 0..1 | string | Plain text representation of the concept |
![]() ![]() |
Σ | 0..1 | CodeableConcept | Administration method Binding: EDQM - Administration Method (required) |
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
![]() ![]() ![]() |
Σ | 1..* | Coding | Code defined by a terminology system |
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() |
Σ | 1..1 | uri | Identity of the terminology system |
![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Version of the system - if relevant |
![]() ![]() ![]() ![]() |
Σ | 1..1 | code | Symbol in syntax defined by the system |
![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Representation defined by the system |
![]() ![]() ![]() ![]() |
Σ | 0..1 | boolean | If this coding was chosen directly by the user |
![]() ![]() ![]() |
Σ | 0..1 | string | Plain text representation of the concept |
![]() ![]() |
Σ | 0..1 | Element | Amount of medication administered |
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
![]() ![]() ![]() |
Σ | 0..1 | CodeableConcept | The kind of dose or rate specified Binding: DoseAndRateType (example): The kind of dose or rate specified. |
![]() ![]() ![]() |
SΣ | 0..1 | Amount of medication per dose | |
![]() ![]() ![]() ![]() |
Range(CHCoreRangeWithEmedUnits) | |||
![]() ![]() ![]() ![]() |
Quantity(CHCoreQuantityWithEmedUnits) | |||
![]() ![]() ![]() |
Σ | 0..1 | Amount of medication per unit of time | |
![]() ![]() ![]() ![]() |
Ratio | |||
![]() ![]() ![]() ![]() |
Range | |||
![]() ![]() ![]() ![]() |
Quantity(SimpleQuantity) | |||
![]() ![]() |
Σ | 0..1 | Ratio | Upper limit on medication per unit of time |
![]() ![]() |
Σ | 0..1 | SimpleQuantity(4.0.1) | Upper limit on medication per administration |
![]() ![]() |
Σ | 0..1 | SimpleQuantity(4.0.1) | Upper limit on medication per lifetime of the patient |
Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Dosage.additionalInstruction | Base | example | SNOMED CT Additional Dosage Instructions | 📍4.0.1 | FHIR Std. |
| Dosage.timing.repeat.durationUnit | Base | required | UnitsOfTime | 📍4.0.1 | FHIR Std. |
| Dosage.timing.repeat.periodUnit | Base | required | UnitsOfTime | 📍4.0.1 | FHIR Std. |
| Dosage.timing.repeat.dayOfWeek | Base | required | DaysOfWeek | 📍4.0.1 | FHIR Std. |
| Dosage.timing.repeat.when | Base | required | EventTiming | 📍4.0.1 | FHIR Std. |
| Dosage.timing.code | Base | preferred | TimingAbbreviation | 📍4.0.1 | FHIR Std. |
| Dosage.asNeeded[x] | Base | example | SNOMED CT Medication As Needed Reason Codes | 📍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 | required | EDQM - RouteOfAdministration | 📦3.2.0 | CH Term v3.2 |
| Dosage.method | Base | required | EDQM - Administration Method | 📦3.2.0 | CH Term v3.2 |
| Dosage.doseAndRate.type | Base | example | DoseAndRateType | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| ch-dosage-1 | error | Dosage.sequence | No sequence number (for one dosage element) or sequence number = 1 (for more than one dosage element) |
$this.count() = 0 or $this = 1
|
| ch-dosage-4 | error | Dosage | For split dosage timing event and dose/rate are required |
sequence.exists() implies (timing.repeat.when.exists() and doseAndRate.dose.exists())
|
| ch-emed-event-timing | warning | Dosage.timing.repeat.when | For the representation of the time of administration according to the 1-1-1-1 scheme, the values MORN-NOON-EVE-NIGHT are highly recommended. |
$this='MORN' or $this='NOON' or $this='EVE' or $this='NIGHT'
|
| 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()
|
| tim-1 | error | Dosage.timing.repeat | if there's a duration, there needs to be duration units |
duration.empty() or durationUnit.exists()
|
| tim-2 | error | Dosage.timing.repeat | if there's a period, there needs to be period units |
period.empty() or periodUnit.exists()
|
| tim-4 | error | Dosage.timing.repeat | duration SHALL be a non-negative value |
duration.exists() implies duration >= 0
|
| tim-5 | error | Dosage.timing.repeat | period SHALL be a non-negative value |
period.exists() implies period >= 0
|
| tim-6 | error | Dosage.timing.repeat | If there's a periodMax, there must be a period |
periodMax.empty() or period.exists()
|
| tim-7 | error | Dosage.timing.repeat | If there's a durationMax, there must be a duration |
durationMax.empty() or duration.exists()
|
| tim-8 | error | Dosage.timing.repeat | If there's a countMax, there must be a count |
countMax.empty() or count.exists()
|
| tim-9 | error | Dosage.timing.repeat | If there's an offset, there must be a when (and not C, CM, CD, CV) |
offset.empty() or (when.exists() and ((when in ('C' | 'CM' | 'CD' | 'CV')).not()))
|
| tim-10 | error | Dosage.timing.repeat | If there's a timeOfDay, there cannot be a when, or vice versa |
timeOfDay.empty() or when.empty()
|
This structure is derived from CHCoreDosage
Summary
Mandatory: 0 element(6 nested mandatory elements)
Must-Support: 5 elements
Slices
This structure defines the following Slices:
Other representations of profile: CSV, Excel, Schematron