CH EMED EPR
1.0.1-ci-build - ci-build
CH EMED EPR
1.0.1-ci-build - ci-build
CH EMED EPR, published by CARA. This guide is not an authorized publication; it is the continuous build for version 1.0.1-ci-build built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/CARA-ch/ch-emed-epr/ and changes regularly. See the Directory of published versions
| Official URL: http://fhir.ch/ig/ch-emed-epr/StructureDefinition/ch-emed-epr-dosage-split | Version: 1.0.1-ci-build | |||
| Draft as of 2024-04-05 | Computable Name: CHEMEDEPRDosageSplit | |||
Copyright/Legal: CC0-1.0 |
||||
Definition of the split dosage element
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from CHEMEDDosageSplit
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  Dosage |
CHEMEDDosageSplit | |||
  extension |
D | 0..* | Extension | ✕ This element is not supported |
 modifierExtension |
0..0 | |||
| text |
D | 0..0 | string | |
 timing |
||||
 modifierExtension |
0..0 | |||
| event |
D | 0..* | dateTime | ✕ This element is not supported |
| repeat |
||||
 bounds[x] |
0..1 | Period | Length/Range of lengths, or (Start and/or end) limits | |
 when |
C | 1..* | code | ... It shall only contain values from Event Timings only-standard-event-timings: The timing event shall only be 'MORN', 'NOON', 'EVE' or 'NIGHT'. |
| code |
D | 0..1 | CodeableConcept | ✕ This element is not supported |
 doseAndRate |
||||
 type |
D | 0..1 | CodeableConcept | ✕ This element is not supported |
 Slices for dose[x] |
1..1 | CHCoreRangeWithEmedUnits, CHCoreQuantityWithEmedUnits | Amount of medication per dose Slice: Unordered, Open by type:$this | |
  dose[x]:doseQuantity |
0..1 | CHEMEDEPRAmountQuantity | A fixed quantity (no comparator) | |
 dose[x]:doseRange |
0..1 | CHEMEDEPRAmountRange | Set of values bounded by low and high | |
| rate[x] |
0..1 | CHEMEDEPRRatioAmountPerTime | A ratio of two Quantity values - a numerator and a denominator | |
| Documentation for this format | ||||
| Id | Grade | Path(s) | Details | Requirements |
| only-standard-event-timings | error | Dosage.timing.repeat.when | The timing event shall only be 'MORN', 'NOON', 'EVE' or 'NIGHT'. : $this = 'MORN' or $this = 'NOON' or $this = 'EVE' or $this = 'NIGHT' |
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Dosage |
0..* | CHEMEDDosageSplit | CH EMED Dosage Split (MedicationStatement / MedicationDispense / MedicationRequest) | |
| extension |
0..* | Extension | ✕ This element is not supported Slice: Unordered, Open by value:url | |
 sequence |
ΣC | 1..1 | integer | The order of the dosage instructions ch-dosage-2: The sequence number must be greater than 1 |
| timing |
Σ | 1..1 | Timing | When medication should be administered |
| event |
Σ | 0..* | dateTime | ✕ This element is not supported |
| repeat |
ΣC | 1..1 | Element | When the event is to occur tim-1: if there's a duration, there needs to be duration units tim-2: if there's a period, there needs to be period units tim-4: duration SHALL be a non-negative value tim-5: period SHALL be a non-negative value tim-6: If there's a periodMax, there must be a period tim-7: If there's a durationMax, there must be a duration tim-8: If there's a countMax, there must be a count tim-9: If there's an offset, there must be a when (and not C, CM, CD, CV) tim-10: If there's a timeOfDay, there cannot be a when, or vice versa |
| Slices for bounds[x] |
Σ | 0..1 | Period | Length/Range of lengths, or (Start and/or end) limits Slice: Unordered, Closed by type:$this |
| when |
SΣC | 1..* | code | ... It shall only contain values from Event Timings Binding: EventTiming (required): Real world event relating to the schedule. ch-emed-event-timing: 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. only-standard-event-timings: The timing event shall only be 'MORN', 'NOON', 'EVE' or 'NIGHT'. |
| code |
Σ | 0..1 | CodeableConcept | ✕ This element is not supported Binding: TimingAbbreviation (preferred): Code for a known / defined timing pattern. |
| doseAndRate |
Σ | 1..1 | Element | Amount of medication administered |
| type |
Σ | 0..1 | CodeableConcept | ✕ This element is not supported Binding: DoseAndRateType (example): The kind of dose or rate specified. |
| Slices for dose[x] |
SΣ | 1..1 | Amount of medication per dose Slice: Unordered, Closed by type:$this | |
| doseRange |
Range(CHCoreRangeWithEmedUnits) | |||
| doseQuantity |
Quantity(CHCoreQuantityWithEmedUnits) | |||
| dose[x]:doseQuantity |
SC | 0..1 | CHEMEDEPRAmountQuantity | A fixed quantity (no comparator) qty-3: If a code for the unit is present, the system SHALL also be present sqty-1: The comparator is not used on a SimpleQuantity |
| dose[x]:doseRange |
SC | 0..1 | CHEMEDEPRAmountRange | Set of values bounded by low and high rng-2: If present, low SHALL have a lower value than high |
| rate[x] |
C | 0..1 | CHEMEDEPRRatioAmountPerTime | A ratio of two Quantity values - a numerator and a denominator rat-1: Numerator and denominator SHALL both be present, or both are absent. If both are absent, there SHALL be some extension present |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| Dosage.timing.repeat.when | required | EventTiminghttp://hl7.org/fhir/ValueSet/event-timing|4.0.1from the FHIR Standard | |
| Dosage.timing.code | preferred | TimingAbbreviationhttp://hl7.org/fhir/ValueSet/timing-abbreviationfrom the FHIR Standard | |
| Dosage.doseAndRate.type | example | DoseAndRateTypehttp://hl7.org/fhir/ValueSet/dose-rate-typefrom the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| ch-dosage-2 | error | Dosage.sequence | The sequence number must be greater than 1 : $this > 1 | |
| 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() | |
| only-standard-event-timings | error | Dosage.timing.repeat.when | The timing event shall only be 'MORN', 'NOON', 'EVE' or 'NIGHT'. : $this = 'MORN' or $this = 'NOON' or $this = 'EVE' or $this = 'NIGHT' | |
| qty-3 | error | Dosage.doseAndRate.dose[x]:doseQuantity | If a code for the unit is present, the system SHALL also be present : code.empty() or system.exists() | |
| rat-1 | error | Dosage.doseAndRate.rate[x] | Numerator and denominator SHALL both be present, or both are absent. If both are absent, there SHALL be some extension present : (numerator.empty() xor denominator.exists()) and (numerator.exists() or extension.exists()) | |
| rng-2 | error | Dosage.doseAndRate.dose[x]:doseRange | If present, low SHALL have a lower value than high : low.empty() or high.empty() or (low <= high) | |
| sqty-1 | error | Dosage.doseAndRate.dose[x]:doseQuantity | The comparator is not used on a SimpleQuantity : comparator.empty() | |
| 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() |
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Dosage |
0..* | CHEMEDDosageSplit | CH EMED Dosage Split (MedicationStatement / MedicationDispense / MedicationRequest) | |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | ✕ This element is not supported Slice: Unordered, Open by value:url | |
| sequence |
ΣC | 1..1 | integer | The order of the dosage instructions ch-dosage-2: The sequence number must be greater than 1 |
| timing |
Σ | 1..1 | Timing | When medication should be administered |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| event |
Σ | 0..* | dateTime | ✕ This element is not supported |
| repeat |
ΣC | 1..1 | Element | When the event is to occur tim-1: if there's a duration, there needs to be duration units tim-2: if there's a period, there needs to be period units tim-4: duration SHALL be a non-negative value tim-5: period SHALL be a non-negative value tim-6: If there's a periodMax, there must be a period tim-7: If there's a durationMax, there must be a duration tim-8: If there's a countMax, there must be a count tim-9: If there's an offset, there must be a when (and not C, CM, CD, CV) tim-10: If there's a timeOfDay, there cannot be a when, or vice versa |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| Slices for bounds[x] |
Σ | 0..1 | Period | Length/Range of lengths, or (Start and/or end) limits Slice: Unordered, Closed by type:$this |
| count |
Σ | 0..1 | positiveInt | Number of times to repeat |
| countMax |
Σ | 0..1 | positiveInt | Maximum number of times to repeat |
| duration |
Σ | 0..1 | decimal | How long when it happens |
| durationMax |
Σ | 0..1 | decimal | How long when it happens (Max) |
| durationUnit |
Σ | 0..1 | code | s | min | h | d | wk | mo | a - unit of time (UCUM) Binding: UnitsOfTime (required): A unit of time (units from UCUM). |
| frequency |
Σ | 0..1 | positiveInt | Event occurs frequency times per period |
| frequencyMax |
Σ | 0..1 | positiveInt | Event occurs up to frequencyMax times per period |
| period |
Σ | 0..1 | decimal | Event occurs frequency times per period |
| periodMax |
Σ | 0..1 | decimal | Upper limit of period (3-4 hours) |
| periodUnit |
Σ | 0..1 | code | s | min | h | d | wk | mo | a - unit of time (UCUM) Binding: UnitsOfTime (required): A unit of time (units from UCUM). |
| dayOfWeek |
Σ | 0..* | code | mon | tue | wed | thu | fri | sat | sun Binding: DaysOfWeek (required) |
| timeOfDay |
Σ | 0..* | time | Time of day for action |
| when |
SΣC | 1..* | code | ... It shall only contain values from Event Timings Binding: EventTiming (required): Real world event relating to the schedule. ch-emed-event-timing: 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. only-standard-event-timings: The timing event shall only be 'MORN', 'NOON', 'EVE' or 'NIGHT'. |
| offset |
Σ | 0..1 | unsignedInt | Minutes from event (before or after) |
| code |
Σ | 0..1 | CodeableConcept | ✕ This element is not supported Binding: TimingAbbreviation (preferred): Code for a known / defined timing pattern. |
| doseAndRate |
Σ | 1..1 | Element | Amount of medication administered |
| 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 | ✕ This element is not supported Binding: DoseAndRateType (example): The kind of dose or rate specified. |
| Slices for dose[x] |
SΣ | 1..1 | Amount of medication per dose Slice: Unordered, Closed by type:$this | |
| doseRange |
Range(CHCoreRangeWithEmedUnits) | |||
| doseQuantity |
Quantity(CHCoreQuantityWithEmedUnits) | |||
| dose[x]:doseQuantity |
SC | 0..1 | CHEMEDEPRAmountQuantity | A fixed quantity (no comparator) qty-3: If a code for the unit is present, the system SHALL also be present sqty-1: The comparator is not used on a SimpleQuantity |
| dose[x]:doseRange |
SC | 0..1 | CHEMEDEPRAmountRange | Set of values bounded by low and high rng-2: If present, low SHALL have a lower value than high |
| rate[x] |
C | 0..1 | CHEMEDEPRRatioAmountPerTime | A ratio of two Quantity values - a numerator and a denominator rat-1: Numerator and denominator SHALL both be present, or both are absent. If both are absent, there SHALL be some extension present |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| Dosage.timing.repeat.durationUnit | required | UnitsOfTimehttp://hl7.org/fhir/ValueSet/units-of-time|4.0.1from the FHIR Standard | |
| Dosage.timing.repeat.periodUnit | required | UnitsOfTimehttp://hl7.org/fhir/ValueSet/units-of-time|4.0.1from the FHIR Standard | |
| Dosage.timing.repeat.dayOfWeek | required | DaysOfWeekhttp://hl7.org/fhir/ValueSet/days-of-week|4.0.1from the FHIR Standard | |
| Dosage.timing.repeat.when | required | EventTiminghttp://hl7.org/fhir/ValueSet/event-timing|4.0.1from the FHIR Standard | |
| Dosage.timing.code | preferred | TimingAbbreviationhttp://hl7.org/fhir/ValueSet/timing-abbreviationfrom the FHIR Standard | |
| Dosage.doseAndRate.type | example | DoseAndRateTypehttp://hl7.org/fhir/ValueSet/dose-rate-typefrom the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| ch-dosage-2 | error | Dosage.sequence | The sequence number must be greater than 1 : $this > 1 | |
| 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() | |
| only-standard-event-timings | error | Dosage.timing.repeat.when | The timing event shall only be 'MORN', 'NOON', 'EVE' or 'NIGHT'. : $this = 'MORN' or $this = 'NOON' or $this = 'EVE' or $this = 'NIGHT' | |
| qty-3 | error | Dosage.doseAndRate.dose[x]:doseQuantity | If a code for the unit is present, the system SHALL also be present : code.empty() or system.exists() | |
| rat-1 | error | Dosage.doseAndRate.rate[x] | Numerator and denominator SHALL both be present, or both are absent. If both are absent, there SHALL be some extension present : (numerator.empty() xor denominator.exists()) and (numerator.exists() or extension.exists()) | |
| rng-2 | error | Dosage.doseAndRate.dose[x]:doseRange | If present, low SHALL have a lower value than high : low.empty() or high.empty() or (low <= high) | |
| sqty-1 | error | Dosage.doseAndRate.dose[x]:doseQuantity | The comparator is not used on a SimpleQuantity : comparator.empty() | |
| 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 CHEMEDDosageSplit
Summary
Prohibited: 2 elements
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
Differential View
This structure is derived from CHEMEDDosageSplit
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Dosage |
CHEMEDDosageSplit | |||
| extension |
D | 0..* | Extension | ✕ This element is not supported |
| modifierExtension |
0..0 | |||
| text |
D | 0..0 | string | |
| timing |
||||
| modifierExtension |
0..0 | |||
| event |
D | 0..* | dateTime | ✕ This element is not supported |
| repeat |
||||
| bounds[x] |
0..1 | Period | Length/Range of lengths, or (Start and/or end) limits | |
| when |
C | 1..* | code | ... It shall only contain values from Event Timings only-standard-event-timings: The timing event shall only be 'MORN', 'NOON', 'EVE' or 'NIGHT'. |
| code |
D | 0..1 | CodeableConcept | ✕ This element is not supported |
| doseAndRate |
||||
| type |
D | 0..1 | CodeableConcept | ✕ This element is not supported |
| Slices for dose[x] |
1..1 | CHCoreRangeWithEmedUnits, CHCoreQuantityWithEmedUnits | Amount of medication per dose Slice: Unordered, Open by type:$this | |
| dose[x]:doseQuantity |
0..1 | CHEMEDEPRAmountQuantity | A fixed quantity (no comparator) | |
| dose[x]:doseRange |
0..1 | CHEMEDEPRAmountRange | Set of values bounded by low and high | |
| rate[x] |
0..1 | CHEMEDEPRRatioAmountPerTime | A ratio of two Quantity values - a numerator and a denominator | |
| Documentation for this format | ||||
| Id | Grade | Path(s) | Details | Requirements |
| only-standard-event-timings | error | Dosage.timing.repeat.when | The timing event shall only be 'MORN', 'NOON', 'EVE' or 'NIGHT'. : $this = 'MORN' or $this = 'NOON' or $this = 'EVE' or $this = 'NIGHT' |
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Dosage |
0..* | CHEMEDDosageSplit | CH EMED Dosage Split (MedicationStatement / MedicationDispense / MedicationRequest) | |
| extension |
0..* | Extension | ✕ This element is not supported Slice: Unordered, Open by value:url | |
| sequence |
ΣC | 1..1 | integer | The order of the dosage instructions ch-dosage-2: The sequence number must be greater than 1 |
| timing |
Σ | 1..1 | Timing | When medication should be administered |
| event |
Σ | 0..* | dateTime | ✕ This element is not supported |
| repeat |
ΣC | 1..1 | Element | When the event is to occur tim-1: if there's a duration, there needs to be duration units tim-2: if there's a period, there needs to be period units tim-4: duration SHALL be a non-negative value tim-5: period SHALL be a non-negative value tim-6: If there's a periodMax, there must be a period tim-7: If there's a durationMax, there must be a duration tim-8: If there's a countMax, there must be a count tim-9: If there's an offset, there must be a when (and not C, CM, CD, CV) tim-10: If there's a timeOfDay, there cannot be a when, or vice versa |
| Slices for bounds[x] |
Σ | 0..1 | Period | Length/Range of lengths, or (Start and/or end) limits Slice: Unordered, Closed by type:$this |
| when |
SΣC | 1..* | code | ... It shall only contain values from Event Timings Binding: EventTiming (required): Real world event relating to the schedule. ch-emed-event-timing: 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. only-standard-event-timings: The timing event shall only be 'MORN', 'NOON', 'EVE' or 'NIGHT'. |
| code |
Σ | 0..1 | CodeableConcept | ✕ This element is not supported Binding: TimingAbbreviation (preferred): Code for a known / defined timing pattern. |
| doseAndRate |
Σ | 1..1 | Element | Amount of medication administered |
| type |
Σ | 0..1 | CodeableConcept | ✕ This element is not supported Binding: DoseAndRateType (example): The kind of dose or rate specified. |
| Slices for dose[x] |
SΣ | 1..1 | Amount of medication per dose Slice: Unordered, Closed by type:$this | |
| doseRange |
Range(CHCoreRangeWithEmedUnits) | |||
| doseQuantity |
Quantity(CHCoreQuantityWithEmedUnits) | |||
| dose[x]:doseQuantity |
SC | 0..1 | CHEMEDEPRAmountQuantity | A fixed quantity (no comparator) qty-3: If a code for the unit is present, the system SHALL also be present sqty-1: The comparator is not used on a SimpleQuantity |
| dose[x]:doseRange |
SC | 0..1 | CHEMEDEPRAmountRange | Set of values bounded by low and high rng-2: If present, low SHALL have a lower value than high |
| rate[x] |
C | 0..1 | CHEMEDEPRRatioAmountPerTime | A ratio of two Quantity values - a numerator and a denominator rat-1: Numerator and denominator SHALL both be present, or both are absent. If both are absent, there SHALL be some extension present |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| Dosage.timing.repeat.when | required | EventTiminghttp://hl7.org/fhir/ValueSet/event-timing|4.0.1from the FHIR Standard | |
| Dosage.timing.code | preferred | TimingAbbreviationhttp://hl7.org/fhir/ValueSet/timing-abbreviationfrom the FHIR Standard | |
| Dosage.doseAndRate.type | example | DoseAndRateTypehttp://hl7.org/fhir/ValueSet/dose-rate-typefrom the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| ch-dosage-2 | error | Dosage.sequence | The sequence number must be greater than 1 : $this > 1 | |
| 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() | |
| only-standard-event-timings | error | Dosage.timing.repeat.when | The timing event shall only be 'MORN', 'NOON', 'EVE' or 'NIGHT'. : $this = 'MORN' or $this = 'NOON' or $this = 'EVE' or $this = 'NIGHT' | |
| qty-3 | error | Dosage.doseAndRate.dose[x]:doseQuantity | If a code for the unit is present, the system SHALL also be present : code.empty() or system.exists() | |
| rat-1 | error | Dosage.doseAndRate.rate[x] | Numerator and denominator SHALL both be present, or both are absent. If both are absent, there SHALL be some extension present : (numerator.empty() xor denominator.exists()) and (numerator.exists() or extension.exists()) | |
| rng-2 | error | Dosage.doseAndRate.dose[x]:doseRange | If present, low SHALL have a lower value than high : low.empty() or high.empty() or (low <= high) | |
| sqty-1 | error | Dosage.doseAndRate.dose[x]:doseQuantity | The comparator is not used on a SimpleQuantity : comparator.empty() | |
| 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() |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Dosage |
0..* | CHEMEDDosageSplit | CH EMED Dosage Split (MedicationStatement / MedicationDispense / MedicationRequest) | |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | ✕ This element is not supported Slice: Unordered, Open by value:url | |
| sequence |
ΣC | 1..1 | integer | The order of the dosage instructions ch-dosage-2: The sequence number must be greater than 1 |
| timing |
Σ | 1..1 | Timing | When medication should be administered |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| event |
Σ | 0..* | dateTime | ✕ This element is not supported |
| repeat |
ΣC | 1..1 | Element | When the event is to occur tim-1: if there's a duration, there needs to be duration units tim-2: if there's a period, there needs to be period units tim-4: duration SHALL be a non-negative value tim-5: period SHALL be a non-negative value tim-6: If there's a periodMax, there must be a period tim-7: If there's a durationMax, there must be a duration tim-8: If there's a countMax, there must be a count tim-9: If there's an offset, there must be a when (and not C, CM, CD, CV) tim-10: If there's a timeOfDay, there cannot be a when, or vice versa |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| Slices for bounds[x] |
Σ | 0..1 | Period | Length/Range of lengths, or (Start and/or end) limits Slice: Unordered, Closed by type:$this |
| count |
Σ | 0..1 | positiveInt | Number of times to repeat |
| countMax |
Σ | 0..1 | positiveInt | Maximum number of times to repeat |
| duration |
Σ | 0..1 | decimal | How long when it happens |
| durationMax |
Σ | 0..1 | decimal | How long when it happens (Max) |
| durationUnit |
Σ | 0..1 | code | s | min | h | d | wk | mo | a - unit of time (UCUM) Binding: UnitsOfTime (required): A unit of time (units from UCUM). |
| frequency |
Σ | 0..1 | positiveInt | Event occurs frequency times per period |
| frequencyMax |
Σ | 0..1 | positiveInt | Event occurs up to frequencyMax times per period |
| period |
Σ | 0..1 | decimal | Event occurs frequency times per period |
| periodMax |
Σ | 0..1 | decimal | Upper limit of period (3-4 hours) |
| periodUnit |
Σ | 0..1 | code | s | min | h | d | wk | mo | a - unit of time (UCUM) Binding: UnitsOfTime (required): A unit of time (units from UCUM). |
| dayOfWeek |
Σ | 0..* | code | mon | tue | wed | thu | fri | sat | sun Binding: DaysOfWeek (required) |
| timeOfDay |
Σ | 0..* | time | Time of day for action |
| when |
SΣC | 1..* | code | ... It shall only contain values from Event Timings Binding: EventTiming (required): Real world event relating to the schedule. ch-emed-event-timing: 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. only-standard-event-timings: The timing event shall only be 'MORN', 'NOON', 'EVE' or 'NIGHT'. |
| offset |
Σ | 0..1 | unsignedInt | Minutes from event (before or after) |
| code |
Σ | 0..1 | CodeableConcept | ✕ This element is not supported Binding: TimingAbbreviation (preferred): Code for a known / defined timing pattern. |
| doseAndRate |
Σ | 1..1 | Element | Amount of medication administered |
| 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 | ✕ This element is not supported Binding: DoseAndRateType (example): The kind of dose or rate specified. |
| Slices for dose[x] |
SΣ | 1..1 | Amount of medication per dose Slice: Unordered, Closed by type:$this | |
| doseRange |
Range(CHCoreRangeWithEmedUnits) | |||
| doseQuantity |
Quantity(CHCoreQuantityWithEmedUnits) | |||
| dose[x]:doseQuantity |
SC | 0..1 | CHEMEDEPRAmountQuantity | A fixed quantity (no comparator) qty-3: If a code for the unit is present, the system SHALL also be present sqty-1: The comparator is not used on a SimpleQuantity |
| dose[x]:doseRange |
SC | 0..1 | CHEMEDEPRAmountRange | Set of values bounded by low and high rng-2: If present, low SHALL have a lower value than high |
| rate[x] |
C | 0..1 | CHEMEDEPRRatioAmountPerTime | A ratio of two Quantity values - a numerator and a denominator rat-1: Numerator and denominator SHALL both be present, or both are absent. If both are absent, there SHALL be some extension present |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| Dosage.timing.repeat.durationUnit | required | UnitsOfTimehttp://hl7.org/fhir/ValueSet/units-of-time|4.0.1from the FHIR Standard | |
| Dosage.timing.repeat.periodUnit | required | UnitsOfTimehttp://hl7.org/fhir/ValueSet/units-of-time|4.0.1from the FHIR Standard | |
| Dosage.timing.repeat.dayOfWeek | required | DaysOfWeekhttp://hl7.org/fhir/ValueSet/days-of-week|4.0.1from the FHIR Standard | |
| Dosage.timing.repeat.when | required | EventTiminghttp://hl7.org/fhir/ValueSet/event-timing|4.0.1from the FHIR Standard | |
| Dosage.timing.code | preferred | TimingAbbreviationhttp://hl7.org/fhir/ValueSet/timing-abbreviationfrom the FHIR Standard | |
| Dosage.doseAndRate.type | example | DoseAndRateTypehttp://hl7.org/fhir/ValueSet/dose-rate-typefrom the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| ch-dosage-2 | error | Dosage.sequence | The sequence number must be greater than 1 : $this > 1 | |
| 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() | |
| only-standard-event-timings | error | Dosage.timing.repeat.when | The timing event shall only be 'MORN', 'NOON', 'EVE' or 'NIGHT'. : $this = 'MORN' or $this = 'NOON' or $this = 'EVE' or $this = 'NIGHT' | |
| qty-3 | error | Dosage.doseAndRate.dose[x]:doseQuantity | If a code for the unit is present, the system SHALL also be present : code.empty() or system.exists() | |
| rat-1 | error | Dosage.doseAndRate.rate[x] | Numerator and denominator SHALL both be present, or both are absent. If both are absent, there SHALL be some extension present : (numerator.empty() xor denominator.exists()) and (numerator.exists() or extension.exists()) | |
| rng-2 | error | Dosage.doseAndRate.dose[x]:doseRange | If present, low SHALL have a lower value than high : low.empty() or high.empty() or (low <= high) | |
| sqty-1 | error | Dosage.doseAndRate.dose[x]:doseQuantity | The comparator is not used on a SimpleQuantity : comparator.empty() | |
| 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 CHEMEDDosageSplit
Summary
Prohibited: 2 elements
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
Other representations of profile: CSV, Excel, Schematron