CH EMED (R4)
3.0.0 - STU3
This page is part of the CH EMED (R4) (v3.0.0: STU 3) based on FHIR R4. . For a full list of available versions, see the Directory of published versions
Official URL: http://fhir.ch/ig/ch-emed/StructureDefinition/ch-emed-dosage-split-medicationrequest | Version: 3.0.0 | |||
Active as of 2022-12-21 | Computable Name: CHEMEDDosageSplitMedicationRequest | |||
Copyright/Legal: CC-BY-SA-4.0 |
Definition of the split dosage (used in MedicationRequest)
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 | 0..* | CHEMEDDosageSplit | CH EMED Dosage Split (MedicationRequest) | |
timing | 1..1 | Timing | When medication should be administered | |
repeat | 1..1 | Element | When the event is to occur | |
when | 1..* | code | Code for time period of occurrence | |
doseAndRate | 1..1 | Element | Amount of medication administered | |
Documentation for this format |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Dosage | 0..* | CHEMEDDosageSplit | CH EMED Dosage Split (MedicationRequest) | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
sequence | ΣC | 1..1 | integer | The order of the dosage instructions |
timing | Σ | 1..1 | Timing | When medication should be administered |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
repeat | ΣC | 1..1 | Element | When the event is to occur |
Slices for bounds[x] | Σ | 0..1 | Length/Range of lengths, or (Start and/or end) limits Slice: Unordered, Open by type:$this | |
boundsDuration | Duration | |||
boundsRange | Range | |||
boundsPeriod | Period | |||
when | SΣC | 1..* | code | Code for time period of occurrence Binding: EventTiming (required): Real world event relating to the schedule. |
doseAndRate | Σ | 1..1 | Element | Amount of medication administered |
dose[x] | SΣ | 0..1 | Amount of medication per dose | |
doseRange | Range(CHEMEDRangeWithEmedUnits) | |||
doseQuantity | Quantity(CHEMEDQuantityWithEmedUnits) | |||
Documentation for this format |
Path | Conformance | ValueSet |
Dosage.timing.repeat.when | required | EventTiming |
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() | |
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 (MedicationRequest) | |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
sequence | ΣC | 1..1 | integer | The order of the dosage instructions |
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 | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
event | Σ | 0..* | dateTime | When the event occurs |
repeat | ΣC | 1..1 | Element | When the event is to occur |
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 | Length/Range of lengths, or (Start and/or end) limits Slice: Unordered, Open by type:$this | |
boundsDuration | Duration | |||
boundsRange | Range | |||
boundsPeriod | Period | |||
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 | Code for time period of occurrence Binding: EventTiming (required): Real world event relating to the schedule. |
offset | Σ | 0..1 | unsignedInt | Minutes from event (before or after) |
code | Σ | 0..1 | CodeableConcept | BID | TID | QID | AM | PM | QD | QOD | + 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 | The kind of dose or rate specified Binding: DoseAndRateType (example): The kind of dose or rate specified. |
dose[x] | SΣ | 0..1 | Amount of medication per dose | |
doseRange | Range(CHEMEDRangeWithEmedUnits) | |||
doseQuantity | Quantity(CHEMEDQuantityWithEmedUnits) | |||
rate[x] | Σ | 0..1 | Amount of medication per unit of time | |
rateRatio | Ratio | |||
rateRange | Range | |||
rateQuantity | Quantity(SimpleQuantity) | |||
Documentation for this format |
Path | Conformance | ValueSet |
Dosage.timing.repeat.durationUnit | required | UnitsOfTime |
Dosage.timing.repeat.periodUnit | required | UnitsOfTime |
Dosage.timing.repeat.dayOfWeek | required | DaysOfWeek |
Dosage.timing.repeat.when | required | EventTiming |
Dosage.timing.code | preferred | TimingAbbreviation |
Dosage.doseAndRate.type | example | DoseAndRateType |
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() |
This structure is derived from CHEMEDDosageSplit
Differential View
This structure is derived from CHEMEDDosageSplit
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Dosage | 0..* | CHEMEDDosageSplit | CH EMED Dosage Split (MedicationRequest) | |
timing | 1..1 | Timing | When medication should be administered | |
repeat | 1..1 | Element | When the event is to occur | |
when | 1..* | code | Code for time period of occurrence | |
doseAndRate | 1..1 | Element | Amount of medication administered | |
Documentation for this format |
Key Elements View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Dosage | 0..* | CHEMEDDosageSplit | CH EMED Dosage Split (MedicationRequest) | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
sequence | ΣC | 1..1 | integer | The order of the dosage instructions |
timing | Σ | 1..1 | Timing | When medication should be administered |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
repeat | ΣC | 1..1 | Element | When the event is to occur |
Slices for bounds[x] | Σ | 0..1 | Length/Range of lengths, or (Start and/or end) limits Slice: Unordered, Open by type:$this | |
boundsDuration | Duration | |||
boundsRange | Range | |||
boundsPeriod | Period | |||
when | SΣC | 1..* | code | Code for time period of occurrence Binding: EventTiming (required): Real world event relating to the schedule. |
doseAndRate | Σ | 1..1 | Element | Amount of medication administered |
dose[x] | SΣ | 0..1 | Amount of medication per dose | |
doseRange | Range(CHEMEDRangeWithEmedUnits) | |||
doseQuantity | Quantity(CHEMEDQuantityWithEmedUnits) | |||
Documentation for this format |
Path | Conformance | ValueSet |
Dosage.timing.repeat.when | required | EventTiming |
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() | |
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 (MedicationRequest) | |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
sequence | ΣC | 1..1 | integer | The order of the dosage instructions |
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 | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
event | Σ | 0..* | dateTime | When the event occurs |
repeat | ΣC | 1..1 | Element | When the event is to occur |
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 | Length/Range of lengths, or (Start and/or end) limits Slice: Unordered, Open by type:$this | |
boundsDuration | Duration | |||
boundsRange | Range | |||
boundsPeriod | Period | |||
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 | Code for time period of occurrence Binding: EventTiming (required): Real world event relating to the schedule. |
offset | Σ | 0..1 | unsignedInt | Minutes from event (before or after) |
code | Σ | 0..1 | CodeableConcept | BID | TID | QID | AM | PM | QD | QOD | + 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 | The kind of dose or rate specified Binding: DoseAndRateType (example): The kind of dose or rate specified. |
dose[x] | SΣ | 0..1 | Amount of medication per dose | |
doseRange | Range(CHEMEDRangeWithEmedUnits) | |||
doseQuantity | Quantity(CHEMEDQuantityWithEmedUnits) | |||
rate[x] | Σ | 0..1 | Amount of medication per unit of time | |
rateRatio | Ratio | |||
rateRange | Range | |||
rateQuantity | Quantity(SimpleQuantity) | |||
Documentation for this format |
Path | Conformance | ValueSet |
Dosage.timing.repeat.durationUnit | required | UnitsOfTime |
Dosage.timing.repeat.periodUnit | required | UnitsOfTime |
Dosage.timing.repeat.dayOfWeek | required | DaysOfWeek |
Dosage.timing.repeat.when | required | EventTiming |
Dosage.timing.code | preferred | TimingAbbreviation |
Dosage.doseAndRate.type | example | DoseAndRateType |
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() |
This structure is derived from CHEMEDDosageSplit
Other representations of profile: CSV, Excel, Schematron