CH EMED EPR
1.0.0 - trial-use
CH EMED EPR
1.0.0 - trial-use
This page is part of the FHIR eMedication exchange formats for the implementation effort of CARA within its EPR community (v1.0.0: STU1) based on FHIR (HL7® FHIR® Standard) R4. This is the current published version in its permanent home (it will always be available at this URL). For a full list of available versions, see the Directory of published versions
| Official URL: http://fhir.ch/ig/ch-emed-epr/StructureDefinition/ch-emed-epr-dosage | Version: 1.0.0 | |||
| Draft as of 2024-01-26 | Computable Name: CHEMEDEPRDosage | |||
Copyright/Legal: CC0-1.0 |
||||
Definition of the main dosage element (used in MedicationStatement / MedicationDispense)
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from CHEMEDDosage
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  Dosage | CHEMEDDosage | |||
  extension | D | 0..* | Extension | ✕ This element is not supported |
 modifierExtension | 0..0 | |||
| text | D | 0..1 | string | ✕ This element is not supported |
 additionalInstruction | ||||
 extension | D | 0..* | Extension | ✕ This element is not supported |
 text | 1..1 | string | Plain text representation of the concept | |
| timing | ||||
| id | D | 0..1 | string | ✕ This element is not supported |
| extension | D | 0..* | Extension | ✕ This element is not supported |
| modifierExtension | 0..0 | |||
| event | D | 0..* | dateTime | ✕ This element is not supported |
| repeat | ||||
| id | D | 0..1 | string | ✕ This element is not supported |
| extension | D | 0..* | Extension | ✕ This element is not supported |
 bounds[x] | 0..1 | Period | Length/Range of lengths, or (Start and/or end) limits | |
| count | D | 0..1 | positiveInt | ✕ This element is not supported |
| countMax | D | 0..1 | positiveInt | ✕ This element is not supported |
| duration | D | 0..1 | decimal | ✕ This element is not supported |
| durationMax | D | 0..1 | decimal | ✕ This element is not supported |
| durationUnit | D | 0..1 | code | ✕ This element is not supported |
| frequency | D | 0..1 | positiveInt | ✕ This element is not supported |
| frequencyMax | D | 0..1 | positiveInt | ✕ This element is not supported |
| period | D | 0..1 | decimal | ✕ This element is not supported |
| periodMax | D | 0..1 | decimal | ✕ This element is not supported |
| periodUnit | D | 0..1 | code | ✕ This element is not supported |
| dayOfWeek | D | 0..* | code | ✕ This element is not supported |
| timeOfDay | D | 0..* | time | ✕ This element is not supported |
| when | C | 0..* | code | ... It shall only contain values from Event Timings only-standard-event-timings: The timing event shall only be 'MORN', 'NOON', 'EVE' or 'NIGHT'. |
| offset | D | 0..1 | unsignedInt | ✕ This element is not supported |
| code | D | 0..1 | CodeableConcept | ✕ This element is not supported |
 asNeeded[x] | 0..1 | boolean | Take "as needed" (for x) | |
 asNeeded[x]:asNeededBoolean | 0..1 | boolean | In reserve (to be taken by the patient only if the need arises - e.g. pains) | |
| site | D | 0..1 | CodeableConcept | ✕ This element is not supported |
| extension | D | 0..* | Extension | ✕ This element is not supported |
| text | 1..1 | string | Plain text representation of the concept | |
| route | 0..1 | CodeableConcept | Route of administration | |
| extension | D | 0..* | Extension | ✕ This element is not supported |
| text | 1..1 | string | Plain text representation of the concept | |
| method | D | 0..1 | CodeableConcept | ✕ This element is not supported |
| extension | D | 0..* | Extension | ✕ This element is not supported |
| text | 1..1 | string | Plain text representation of the concept | |
| doseAndRate | ||||
| type | D | 0..1 | CodeableConcept | ✕ This element is not supported |
 Slices for dose[x] | 0..1 | CHEMEDRangeWithEmedUnits, CHEMEDQuantityWithEmedUnits | 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 | |
| maxDosePerPeriod | 0..1 | CHEMEDEPRRatioAmountPerTime | A ratio of two Quantity values - a numerator and a denominator | |
| maxDosePerAdministration | 0..1 | CHEMEDEPRAmountQuantity | A fixed quantity (no comparator) | |
| maxDosePerLifetime | D | 0..1 | CHEMEDEPRAmountQuantity | ✕ This element is not supported |
| 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 | C | 0..* | CHEMEDDosage | CH EMED Dosage (MedicationStatement / MedicationDispense) |
| extension | 0..* | Extension | ✕ This element is not supported Slice: Unordered, Open by value:url | |
| text | Σ | 0..1 | string | ✕ This element is not supported |
| patientInstruction | SΣ | 0..1 | string | Patient instructions (e.g. 'take with food'), incl. free text dosage instructions (e.g. for complex dosage) |
| timing | Σ | 0..1 | Timing | When medication should be administered |
| id | 0..1 | string | ✕ This element is not supported | |
| extension | 0..* | Extension | ✕ This element is not supported Slice: Unordered, Open by value:url | |
| event | Σ | 0..* | dateTime | ✕ This element is not supported |
| repeat | ΣC | 0..1 | Element | When the event is to occur |
| id | 0..1 | string | ✕ This element is not supported | |
| extension | 0..* | Extension | ✕ This element is not supported 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 |
| bounds[x]:boundsPeriod | SΣ | 0..1 | Period | Start and/or end of treatment |
| count | Σ | 0..1 | positiveInt | ✕ This element is not supported |
| countMax | Σ | 0..1 | positiveInt | ✕ This element is not supported |
| duration | Σ | 0..1 | decimal | ✕ This element is not supported |
| durationMax | Σ | 0..1 | decimal | ✕ This element is not supported |
| durationUnit | Σ | 0..1 | code | ✕ This element is not supported Binding: UnitsOfTime (required): A unit of time (units from UCUM). |
| frequency | Σ | 0..1 | positiveInt | ✕ This element is not supported |
| frequencyMax | Σ | 0..1 | positiveInt | ✕ This element is not supported |
| period | Σ | 0..1 | decimal | ✕ This element is not supported |
| periodMax | Σ | 0..1 | decimal | ✕ This element is not supported |
| periodUnit | Σ | 0..1 | code | ✕ This element is not supported Binding: UnitsOfTime (required): A unit of time (units from UCUM). |
| dayOfWeek | Σ | 0..* | code | ✕ This element is not supported Binding: DaysOfWeek (required) |
| timeOfDay | Σ | 0..* | time | ✕ This element is not supported |
| when | SΣC | 0..* | code | ... It shall only contain values from Event Timings Binding: EventTiming (required): Real world event relating to the schedule. only-standard-event-timings: The timing event shall only be 'MORN', 'NOON', 'EVE' or 'NIGHT'. |
| offset | Σ | 0..1 | unsignedInt | ✕ This element is not supported |
| code | Σ | 0..1 | CodeableConcept | ✕ This element is not supported Binding: TimingAbbreviation (preferred): Code for a known / defined timing pattern. |
| Slices for asNeeded[x] | Σ | 0..1 | boolean | Take "as needed" (for x) Slice: Unordered, Closed by type:$this |
| asNeeded[x]:asNeededBoolean | Σ | 0..1 | boolean | In reserve (to be taken by the patient only if the need arises - e.g. pains) |
| site | Σ | 0..1 | CodeableConcept | ✕ This element is not supported Binding: SNOMEDCTAnatomicalStructureForAdministrationSiteCodes (example): A coded concept describing the site location the medicine enters into or onto the body. |
| extension | 0..* | Extension | ✕ This element is not supported Slice: Unordered, Open by value:url | |
| text | Σ | 1..1 | string | Plain text representation of the concept |
| route | Σ | 0..1 | CodeableConcept | Route of administration Binding: EDQM - RouteOfAdministration (required) |
| extension | 0..* | Extension | ✕ This element is not supported Slice: Unordered, Open by value:url | |
| coding | SΣ | 1..* | Coding | Code defined by a terminology system |
| system | Σ | 1..1 | uri | Identity of the terminology system |
| code | Σ | 1..1 | code | Symbol in syntax defined by the system |
| text | Σ | 1..1 | string | Plain text representation of the concept |
| method | Σ | 0..1 | CodeableConcept | ✕ This element is not supported Binding: SNOMEDCTAdministrationMethodCodes (example): A coded concept describing the technique by which the medicine is administered. |
| extension | 0..* | Extension | ✕ This element is not supported Slice: Unordered, Open by value:url | |
| text | Σ | 1..1 | string | Plain text representation of the concept |
| doseAndRate | Σ | 0..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Σ | 0..1 | Amount of medication per dose Slice: Unordered, Closed by type:$this | |
| doseRange | Range(CHEMEDRangeWithEmedUnits) | |||
| doseQuantity | Quantity(CHEMEDQuantityWithEmedUnits) | |||
| dose[x]:doseQuantity | SC | 0..1 | CHEMEDEPRAmountQuantity | A fixed quantity (no comparator) |
| dose[x]:doseRange | SC | 0..1 | CHEMEDEPRAmountRange | Set of values bounded by low and high |
| rate[x] | C | 0..1 | CHEMEDEPRRatioAmountPerTime | A ratio of two Quantity values - a numerator and a denominator |
| maxDosePerPeriod | C | 0..1 | CHEMEDEPRRatioAmountPerTime | A ratio of two Quantity values - a numerator and a denominator |
| maxDosePerAdministration | C | 0..1 | CHEMEDEPRAmountQuantity | A fixed quantity (no comparator) |
| maxDosePerLifetime | C | 0..1 | CHEMEDEPRAmountQuantity | ✕ This element is not supported |
| 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.site | example | SNOMEDCTAnatomicalStructureForAdministrationSiteCodeshttp://hl7.org/fhir/ValueSet/approach-site-codesfrom the FHIR Standard | |
| Dosage.route | required | RouteOfAdministrationEDQMhttp://fhir.ch/ig/ch-emed/ValueSet/edqm-routeofadministration | |
| Dosage.method | example | SNOMEDCTAdministrationMethodCodeshttp://hl7.org/fhir/ValueSet/administration-method-codesfrom 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-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() | |
| 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, Dosage.maxDosePerAdministration, Dosage.maxDosePerLifetime | 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], Dosage.maxDosePerPeriod | 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, Dosage.maxDosePerAdministration, Dosage.maxDosePerLifetime | 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 | C | 0..* | CHEMEDDosage | CH EMED Dosage (MedicationStatement / MedicationDispense) |
| 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 | 0..1 | integer | The order of the dosage instructions |
| text | Σ | 0..1 | string | ✕ This element is not supported |
| additionalInstruction | Σ | 0..* | CodeableConcept | Supplemental instruction or warnings to the patient - e.g. "with meals", "may cause drowsiness" Binding: SNOMEDCTAdditionalDosageInstructions (example): A coded concept identifying additional instructions such as "take with water" or "avoid operating heavy machinery". |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | ✕ This element is not supported Slice: Unordered, Open by value:url | |
| coding | Σ | 0..* | Coding | Code defined by a terminology system |
| text | Σ | 1..1 | string | Plain text representation of the concept |
| patientInstruction | SΣ | 0..1 | string | Patient instructions (e.g. 'take with food'), incl. free text dosage instructions (e.g. for complex dosage) |
| timing | Σ | 0..1 | Timing | When medication should be administered |
| id | 0..1 | string | ✕ This element is not supported | |
| extension | 0..* | Extension | ✕ This element is not supported Slice: Unordered, Open by value:url | |
| event | Σ | 0..* | dateTime | ✕ This element is not supported |
| repeat | ΣC | 0..1 | Element | When the event is to occur |
| id | 0..1 | string | ✕ This element is not supported | |
| extension | 0..* | Extension | ✕ This element is not supported 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 |
| bounds[x]:boundsPeriod | SΣ | 0..1 | Period | Start and/or end of treatment |
| count | Σ | 0..1 | positiveInt | ✕ This element is not supported |
| countMax | Σ | 0..1 | positiveInt | ✕ This element is not supported |
| duration | Σ | 0..1 | decimal | ✕ This element is not supported |
| durationMax | Σ | 0..1 | decimal | ✕ This element is not supported |
| durationUnit | Σ | 0..1 | code | ✕ This element is not supported Binding: UnitsOfTime (required): A unit of time (units from UCUM). |
| frequency | Σ | 0..1 | positiveInt | ✕ This element is not supported |
| frequencyMax | Σ | 0..1 | positiveInt | ✕ This element is not supported |
| period | Σ | 0..1 | decimal | ✕ This element is not supported |
| periodMax | Σ | 0..1 | decimal | ✕ This element is not supported |
| periodUnit | Σ | 0..1 | code | ✕ This element is not supported Binding: UnitsOfTime (required): A unit of time (units from UCUM). |
| dayOfWeek | Σ | 0..* | code | ✕ This element is not supported Binding: DaysOfWeek (required) |
| timeOfDay | Σ | 0..* | time | ✕ This element is not supported |
| when | SΣC | 0..* | code | ... It shall only contain values from Event Timings Binding: EventTiming (required): Real world event relating to the schedule. only-standard-event-timings: The timing event shall only be 'MORN', 'NOON', 'EVE' or 'NIGHT'. |
| offset | Σ | 0..1 | unsignedInt | ✕ This element is not supported |
| code | Σ | 0..1 | CodeableConcept | ✕ This element is not supported Binding: TimingAbbreviation (preferred): Code for a known / defined timing pattern. |
| Slices for asNeeded[x] | Σ | 0..1 | boolean | Take "as needed" (for x) Slice: Unordered, Closed by type:$this |
| asNeeded[x]:asNeededBoolean | Σ | 0..1 | boolean | In reserve (to be taken by the patient only if the need arises - e.g. pains) |
| site | Σ | 0..1 | CodeableConcept | ✕ This element is not supported Binding: SNOMEDCTAnatomicalStructureForAdministrationSiteCodes (example): A coded concept describing the site location the medicine enters into or onto the body. |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | ✕ This element is not supported Slice: Unordered, Open by value:url | |
| coding | Σ | 0..* | Coding | Code defined by a terminology system |
| text | Σ | 1..1 | string | Plain text representation of the concept |
| route | Σ | 0..1 | CodeableConcept | Route of administration Binding: EDQM - RouteOfAdministration (required) |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | ✕ This element is not supported Slice: Unordered, Open by value:url | |
| coding | SΣ | 1..* | Coding | Code defined by a terminology system |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| system | Σ | 1..1 | uri | Identity of the terminology system |
| version | Σ | 0..1 | string | Version of the system - if relevant |
| code | Σ | 1..1 | code | Symbol in syntax defined by the system |
| display | Σ | 0..1 | string | Representation defined by the system |
| userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user |
| text | Σ | 1..1 | string | Plain text representation of the concept |
| method | Σ | 0..1 | CodeableConcept | ✕ This element is not supported Binding: SNOMEDCTAdministrationMethodCodes (example): A coded concept describing the technique by which the medicine is administered. |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | ✕ This element is not supported Slice: Unordered, Open by value:url | |
| coding | Σ | 0..* | Coding | Code defined by a terminology system |
| text | Σ | 1..1 | string | Plain text representation of the concept |
| doseAndRate | Σ | 0..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Σ | 0..1 | Amount of medication per dose Slice: Unordered, Closed by type:$this | |
| doseRange | Range(CHEMEDRangeWithEmedUnits) | |||
| doseQuantity | Quantity(CHEMEDQuantityWithEmedUnits) | |||
| dose[x]:doseQuantity | SC | 0..1 | CHEMEDEPRAmountQuantity | A fixed quantity (no comparator) |
| dose[x]:doseRange | SC | 0..1 | CHEMEDEPRAmountRange | Set of values bounded by low and high |
| rate[x] | C | 0..1 | CHEMEDEPRRatioAmountPerTime | A ratio of two Quantity values - a numerator and a denominator |
| maxDosePerPeriod | C | 0..1 | CHEMEDEPRRatioAmountPerTime | A ratio of two Quantity values - a numerator and a denominator |
| maxDosePerAdministration | C | 0..1 | CHEMEDEPRAmountQuantity | A fixed quantity (no comparator) |
| maxDosePerLifetime | C | 0..1 | CHEMEDEPRAmountQuantity | ✕ This element is not supported |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| Dosage.additionalInstruction | example | SNOMEDCTAdditionalDosageInstructionshttp://hl7.org/fhir/ValueSet/additional-instruction-codesfrom the FHIR Standard | |
| 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.site | example | SNOMEDCTAnatomicalStructureForAdministrationSiteCodeshttp://hl7.org/fhir/ValueSet/approach-site-codesfrom the FHIR Standard | |
| Dosage.route | required | RouteOfAdministrationEDQMhttp://fhir.ch/ig/ch-emed/ValueSet/edqm-routeofadministration | |
| Dosage.method | example | SNOMEDCTAdministrationMethodCodeshttp://hl7.org/fhir/ValueSet/administration-method-codesfrom 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-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() | |
| 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, Dosage.maxDosePerAdministration, Dosage.maxDosePerLifetime | 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], Dosage.maxDosePerPeriod | 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, Dosage.maxDosePerAdministration, Dosage.maxDosePerLifetime | 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 CHEMEDDosage
Summary
Mandatory: 0 element (4 nested mandatory elements)
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 CHEMEDDosage
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Dosage | CHEMEDDosage | |||
| extension | D | 0..* | Extension | ✕ This element is not supported |
| modifierExtension | 0..0 | |||
| text | D | 0..1 | string | ✕ This element is not supported |
| additionalInstruction | ||||
| extension | D | 0..* | Extension | ✕ This element is not supported |
| text | 1..1 | string | Plain text representation of the concept | |
| timing | ||||
| id | D | 0..1 | string | ✕ This element is not supported |
| extension | D | 0..* | Extension | ✕ This element is not supported |
| modifierExtension | 0..0 | |||
| event | D | 0..* | dateTime | ✕ This element is not supported |
| repeat | ||||
| id | D | 0..1 | string | ✕ This element is not supported |
| extension | D | 0..* | Extension | ✕ This element is not supported |
| bounds[x] | 0..1 | Period | Length/Range of lengths, or (Start and/or end) limits | |
| count | D | 0..1 | positiveInt | ✕ This element is not supported |
| countMax | D | 0..1 | positiveInt | ✕ This element is not supported |
| duration | D | 0..1 | decimal | ✕ This element is not supported |
| durationMax | D | 0..1 | decimal | ✕ This element is not supported |
| durationUnit | D | 0..1 | code | ✕ This element is not supported |
| frequency | D | 0..1 | positiveInt | ✕ This element is not supported |
| frequencyMax | D | 0..1 | positiveInt | ✕ This element is not supported |
| period | D | 0..1 | decimal | ✕ This element is not supported |
| periodMax | D | 0..1 | decimal | ✕ This element is not supported |
| periodUnit | D | 0..1 | code | ✕ This element is not supported |
| dayOfWeek | D | 0..* | code | ✕ This element is not supported |
| timeOfDay | D | 0..* | time | ✕ This element is not supported |
| when | C | 0..* | code | ... It shall only contain values from Event Timings only-standard-event-timings: The timing event shall only be 'MORN', 'NOON', 'EVE' or 'NIGHT'. |
| offset | D | 0..1 | unsignedInt | ✕ This element is not supported |
| code | D | 0..1 | CodeableConcept | ✕ This element is not supported |
| asNeeded[x] | 0..1 | boolean | Take "as needed" (for x) | |
| asNeeded[x]:asNeededBoolean | 0..1 | boolean | In reserve (to be taken by the patient only if the need arises - e.g. pains) | |
| site | D | 0..1 | CodeableConcept | ✕ This element is not supported |
| extension | D | 0..* | Extension | ✕ This element is not supported |
| text | 1..1 | string | Plain text representation of the concept | |
| route | 0..1 | CodeableConcept | Route of administration | |
| extension | D | 0..* | Extension | ✕ This element is not supported |
| text | 1..1 | string | Plain text representation of the concept | |
| method | D | 0..1 | CodeableConcept | ✕ This element is not supported |
| extension | D | 0..* | Extension | ✕ This element is not supported |
| text | 1..1 | string | Plain text representation of the concept | |
| doseAndRate | ||||
| type | D | 0..1 | CodeableConcept | ✕ This element is not supported |
| Slices for dose[x] | 0..1 | CHEMEDRangeWithEmedUnits, CHEMEDQuantityWithEmedUnits | 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 | |
| maxDosePerPeriod | 0..1 | CHEMEDEPRRatioAmountPerTime | A ratio of two Quantity values - a numerator and a denominator | |
| maxDosePerAdministration | 0..1 | CHEMEDEPRAmountQuantity | A fixed quantity (no comparator) | |
| maxDosePerLifetime | D | 0..1 | CHEMEDEPRAmountQuantity | ✕ This element is not supported |
| 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 | C | 0..* | CHEMEDDosage | CH EMED Dosage (MedicationStatement / MedicationDispense) |
| extension | 0..* | Extension | ✕ This element is not supported Slice: Unordered, Open by value:url | |
| text | Σ | 0..1 | string | ✕ This element is not supported |
| patientInstruction | SΣ | 0..1 | string | Patient instructions (e.g. 'take with food'), incl. free text dosage instructions (e.g. for complex dosage) |
| timing | Σ | 0..1 | Timing | When medication should be administered |
| id | 0..1 | string | ✕ This element is not supported | |
| extension | 0..* | Extension | ✕ This element is not supported Slice: Unordered, Open by value:url | |
| event | Σ | 0..* | dateTime | ✕ This element is not supported |
| repeat | ΣC | 0..1 | Element | When the event is to occur |
| id | 0..1 | string | ✕ This element is not supported | |
| extension | 0..* | Extension | ✕ This element is not supported 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 |
| bounds[x]:boundsPeriod | SΣ | 0..1 | Period | Start and/or end of treatment |
| count | Σ | 0..1 | positiveInt | ✕ This element is not supported |
| countMax | Σ | 0..1 | positiveInt | ✕ This element is not supported |
| duration | Σ | 0..1 | decimal | ✕ This element is not supported |
| durationMax | Σ | 0..1 | decimal | ✕ This element is not supported |
| durationUnit | Σ | 0..1 | code | ✕ This element is not supported Binding: UnitsOfTime (required): A unit of time (units from UCUM). |
| frequency | Σ | 0..1 | positiveInt | ✕ This element is not supported |
| frequencyMax | Σ | 0..1 | positiveInt | ✕ This element is not supported |
| period | Σ | 0..1 | decimal | ✕ This element is not supported |
| periodMax | Σ | 0..1 | decimal | ✕ This element is not supported |
| periodUnit | Σ | 0..1 | code | ✕ This element is not supported Binding: UnitsOfTime (required): A unit of time (units from UCUM). |
| dayOfWeek | Σ | 0..* | code | ✕ This element is not supported Binding: DaysOfWeek (required) |
| timeOfDay | Σ | 0..* | time | ✕ This element is not supported |
| when | SΣC | 0..* | code | ... It shall only contain values from Event Timings Binding: EventTiming (required): Real world event relating to the schedule. only-standard-event-timings: The timing event shall only be 'MORN', 'NOON', 'EVE' or 'NIGHT'. |
| offset | Σ | 0..1 | unsignedInt | ✕ This element is not supported |
| code | Σ | 0..1 | CodeableConcept | ✕ This element is not supported Binding: TimingAbbreviation (preferred): Code for a known / defined timing pattern. |
| Slices for asNeeded[x] | Σ | 0..1 | boolean | Take "as needed" (for x) Slice: Unordered, Closed by type:$this |
| asNeeded[x]:asNeededBoolean | Σ | 0..1 | boolean | In reserve (to be taken by the patient only if the need arises - e.g. pains) |
| site | Σ | 0..1 | CodeableConcept | ✕ This element is not supported Binding: SNOMEDCTAnatomicalStructureForAdministrationSiteCodes (example): A coded concept describing the site location the medicine enters into or onto the body. |
| extension | 0..* | Extension | ✕ This element is not supported Slice: Unordered, Open by value:url | |
| text | Σ | 1..1 | string | Plain text representation of the concept |
| route | Σ | 0..1 | CodeableConcept | Route of administration Binding: EDQM - RouteOfAdministration (required) |
| extension | 0..* | Extension | ✕ This element is not supported Slice: Unordered, Open by value:url | |
| coding | SΣ | 1..* | Coding | Code defined by a terminology system |
| system | Σ | 1..1 | uri | Identity of the terminology system |
| code | Σ | 1..1 | code | Symbol in syntax defined by the system |
| text | Σ | 1..1 | string | Plain text representation of the concept |
| method | Σ | 0..1 | CodeableConcept | ✕ This element is not supported Binding: SNOMEDCTAdministrationMethodCodes (example): A coded concept describing the technique by which the medicine is administered. |
| extension | 0..* | Extension | ✕ This element is not supported Slice: Unordered, Open by value:url | |
| text | Σ | 1..1 | string | Plain text representation of the concept |
| doseAndRate | Σ | 0..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Σ | 0..1 | Amount of medication per dose Slice: Unordered, Closed by type:$this | |
| doseRange | Range(CHEMEDRangeWithEmedUnits) | |||
| doseQuantity | Quantity(CHEMEDQuantityWithEmedUnits) | |||
| dose[x]:doseQuantity | SC | 0..1 | CHEMEDEPRAmountQuantity | A fixed quantity (no comparator) |
| dose[x]:doseRange | SC | 0..1 | CHEMEDEPRAmountRange | Set of values bounded by low and high |
| rate[x] | C | 0..1 | CHEMEDEPRRatioAmountPerTime | A ratio of two Quantity values - a numerator and a denominator |
| maxDosePerPeriod | C | 0..1 | CHEMEDEPRRatioAmountPerTime | A ratio of two Quantity values - a numerator and a denominator |
| maxDosePerAdministration | C | 0..1 | CHEMEDEPRAmountQuantity | A fixed quantity (no comparator) |
| maxDosePerLifetime | C | 0..1 | CHEMEDEPRAmountQuantity | ✕ This element is not supported |
| 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.site | example | SNOMEDCTAnatomicalStructureForAdministrationSiteCodeshttp://hl7.org/fhir/ValueSet/approach-site-codesfrom the FHIR Standard | |
| Dosage.route | required | RouteOfAdministrationEDQMhttp://fhir.ch/ig/ch-emed/ValueSet/edqm-routeofadministration | |
| Dosage.method | example | SNOMEDCTAdministrationMethodCodeshttp://hl7.org/fhir/ValueSet/administration-method-codesfrom 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-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() | |
| 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, Dosage.maxDosePerAdministration, Dosage.maxDosePerLifetime | 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], Dosage.maxDosePerPeriod | 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, Dosage.maxDosePerAdministration, Dosage.maxDosePerLifetime | 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 | C | 0..* | CHEMEDDosage | CH EMED Dosage (MedicationStatement / MedicationDispense) |
| 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 | 0..1 | integer | The order of the dosage instructions |
| text | Σ | 0..1 | string | ✕ This element is not supported |
| additionalInstruction | Σ | 0..* | CodeableConcept | Supplemental instruction or warnings to the patient - e.g. "with meals", "may cause drowsiness" Binding: SNOMEDCTAdditionalDosageInstructions (example): A coded concept identifying additional instructions such as "take with water" or "avoid operating heavy machinery". |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | ✕ This element is not supported Slice: Unordered, Open by value:url | |
| coding | Σ | 0..* | Coding | Code defined by a terminology system |
| text | Σ | 1..1 | string | Plain text representation of the concept |
| patientInstruction | SΣ | 0..1 | string | Patient instructions (e.g. 'take with food'), incl. free text dosage instructions (e.g. for complex dosage) |
| timing | Σ | 0..1 | Timing | When medication should be administered |
| id | 0..1 | string | ✕ This element is not supported | |
| extension | 0..* | Extension | ✕ This element is not supported Slice: Unordered, Open by value:url | |
| event | Σ | 0..* | dateTime | ✕ This element is not supported |
| repeat | ΣC | 0..1 | Element | When the event is to occur |
| id | 0..1 | string | ✕ This element is not supported | |
| extension | 0..* | Extension | ✕ This element is not supported 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 |
| bounds[x]:boundsPeriod | SΣ | 0..1 | Period | Start and/or end of treatment |
| count | Σ | 0..1 | positiveInt | ✕ This element is not supported |
| countMax | Σ | 0..1 | positiveInt | ✕ This element is not supported |
| duration | Σ | 0..1 | decimal | ✕ This element is not supported |
| durationMax | Σ | 0..1 | decimal | ✕ This element is not supported |
| durationUnit | Σ | 0..1 | code | ✕ This element is not supported Binding: UnitsOfTime (required): A unit of time (units from UCUM). |
| frequency | Σ | 0..1 | positiveInt | ✕ This element is not supported |
| frequencyMax | Σ | 0..1 | positiveInt | ✕ This element is not supported |
| period | Σ | 0..1 | decimal | ✕ This element is not supported |
| periodMax | Σ | 0..1 | decimal | ✕ This element is not supported |
| periodUnit | Σ | 0..1 | code | ✕ This element is not supported Binding: UnitsOfTime (required): A unit of time (units from UCUM). |
| dayOfWeek | Σ | 0..* | code | ✕ This element is not supported Binding: DaysOfWeek (required) |
| timeOfDay | Σ | 0..* | time | ✕ This element is not supported |
| when | SΣC | 0..* | code | ... It shall only contain values from Event Timings Binding: EventTiming (required): Real world event relating to the schedule. only-standard-event-timings: The timing event shall only be 'MORN', 'NOON', 'EVE' or 'NIGHT'. |
| offset | Σ | 0..1 | unsignedInt | ✕ This element is not supported |
| code | Σ | 0..1 | CodeableConcept | ✕ This element is not supported Binding: TimingAbbreviation (preferred): Code for a known / defined timing pattern. |
| Slices for asNeeded[x] | Σ | 0..1 | boolean | Take "as needed" (for x) Slice: Unordered, Closed by type:$this |
| asNeeded[x]:asNeededBoolean | Σ | 0..1 | boolean | In reserve (to be taken by the patient only if the need arises - e.g. pains) |
| site | Σ | 0..1 | CodeableConcept | ✕ This element is not supported Binding: SNOMEDCTAnatomicalStructureForAdministrationSiteCodes (example): A coded concept describing the site location the medicine enters into or onto the body. |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | ✕ This element is not supported Slice: Unordered, Open by value:url | |
| coding | Σ | 0..* | Coding | Code defined by a terminology system |
| text | Σ | 1..1 | string | Plain text representation of the concept |
| route | Σ | 0..1 | CodeableConcept | Route of administration Binding: EDQM - RouteOfAdministration (required) |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | ✕ This element is not supported Slice: Unordered, Open by value:url | |
| coding | SΣ | 1..* | Coding | Code defined by a terminology system |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| system | Σ | 1..1 | uri | Identity of the terminology system |
| version | Σ | 0..1 | string | Version of the system - if relevant |
| code | Σ | 1..1 | code | Symbol in syntax defined by the system |
| display | Σ | 0..1 | string | Representation defined by the system |
| userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user |
| text | Σ | 1..1 | string | Plain text representation of the concept |
| method | Σ | 0..1 | CodeableConcept | ✕ This element is not supported Binding: SNOMEDCTAdministrationMethodCodes (example): A coded concept describing the technique by which the medicine is administered. |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | ✕ This element is not supported Slice: Unordered, Open by value:url | |
| coding | Σ | 0..* | Coding | Code defined by a terminology system |
| text | Σ | 1..1 | string | Plain text representation of the concept |
| doseAndRate | Σ | 0..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Σ | 0..1 | Amount of medication per dose Slice: Unordered, Closed by type:$this | |
| doseRange | Range(CHEMEDRangeWithEmedUnits) | |||
| doseQuantity | Quantity(CHEMEDQuantityWithEmedUnits) | |||
| dose[x]:doseQuantity | SC | 0..1 | CHEMEDEPRAmountQuantity | A fixed quantity (no comparator) |
| dose[x]:doseRange | SC | 0..1 | CHEMEDEPRAmountRange | Set of values bounded by low and high |
| rate[x] | C | 0..1 | CHEMEDEPRRatioAmountPerTime | A ratio of two Quantity values - a numerator and a denominator |
| maxDosePerPeriod | C | 0..1 | CHEMEDEPRRatioAmountPerTime | A ratio of two Quantity values - a numerator and a denominator |
| maxDosePerAdministration | C | 0..1 | CHEMEDEPRAmountQuantity | A fixed quantity (no comparator) |
| maxDosePerLifetime | C | 0..1 | CHEMEDEPRAmountQuantity | ✕ This element is not supported |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| Dosage.additionalInstruction | example | SNOMEDCTAdditionalDosageInstructionshttp://hl7.org/fhir/ValueSet/additional-instruction-codesfrom the FHIR Standard | |
| 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.site | example | SNOMEDCTAnatomicalStructureForAdministrationSiteCodeshttp://hl7.org/fhir/ValueSet/approach-site-codesfrom the FHIR Standard | |
| Dosage.route | required | RouteOfAdministrationEDQMhttp://fhir.ch/ig/ch-emed/ValueSet/edqm-routeofadministration | |
| Dosage.method | example | SNOMEDCTAdministrationMethodCodeshttp://hl7.org/fhir/ValueSet/administration-method-codesfrom 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-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() | |
| 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, Dosage.maxDosePerAdministration, Dosage.maxDosePerLifetime | 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], Dosage.maxDosePerPeriod | 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, Dosage.maxDosePerAdministration, Dosage.maxDosePerLifetime | 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 CHEMEDDosage
Summary
Mandatory: 0 element (4 nested mandatory elements)
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