eMediplan CHMED Implementation Guide
2.1.0 - CI Build
eMediplan CHMED Implementation Guide
2.1.0 - CI Build
eMediplan CHMED Implementation Guide, published by IG eMediplan. This is not an authorized publication; it is the continuous build for version 2.1.0). This version is based on the current content of https://github.com/ahdis/chmed/ and changes regularly. See the Directory of published versions
| Official URL: http://chmed.emediplan.ch/fhir/StructureDefinition/chmed-dosage | Version: 2.1.0 | |||
| Active as of 2022-08-12 | Computable Name: CHMEDDosage | |||
Copyright/Legal: CC-BY-SA-4.0 |
||||
Dosage according to the ‘eMedication Plan CHMED Posology’
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from Dosage
Summary
Must-Support: 2 elements
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
This structure is derived from Dosage
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  Dosage | 0..* | Dosage | CHMED Dosage | |
  posologyObjectType | S | 0..* | Coding | CHMED Posology Object Type URL: http://chmed.emediplan.ch/fhir/StructureDefinition/chmed-posology-object-type Binding: CHMED Posology Object Type (required) |
| timedDosageObjectType | S | 0..1 | Coding | CHMED Timed Dosage Object Type URL: http://chmed.emediplan.ch/fhir/StructureDefinition/chmed-timed-dosage-object-type Binding: CHMED Timed Dosage Object Type (required) |
| sequence | 0..1 | integer | The order of the dosage instructions (number is identical -> concurrent, number is different -> sequential) | |
  Slices for additionalInstruction | 0..* | CodeableConcept | Supplemental instruction or warnings to the patient - e.g. "with meals", "may cause drowsiness" Slice: Unordered, Open by pattern:$this | |
  additionalInstruction:relativeToMeal | 0..1 | CodeableConcept | When the medicament must be applied relative to a meal (before, during or after) Binding: CHMED Relative to Meal (required) | |
 additionalInstruction:evenOddDays | 0..1 | CodeableConcept | The medicament is be applied on even or odd days Binding: CHMED Even/Odd Days (required) | |
| timing | ||||
 repeat | ||||
 dayOfMonth | 0..* | positiveInt | Day of Month for schedule URL: http://hl7.org/fhir/StructureDefinition/timing-dayOfMonth | |
 boundsPeriod | 0..1 | Period | Length/Range of lengths, or (Start and/or end) limits | |
| start | 0..1 | dateTime | Starting time with inclusive boundary | |
 end | 0..1 | dateTime | End time with inclusive boundary, if not ongoing | |
| count | 0..1 | positiveInt | Number of times to repeat | |
| duration | 0..1 | decimal | How long when it happens | |
| durationUnit | 0..1 | code | s | min | h | d | wk | mo | a - unit of time (UCUM) | |
| frequency | 0..1 | positiveInt | Event occurs frequency times per period | |
| period | 0..1 | decimal | Event occurs frequency times per period | |
| periodUnit | 0..1 | code | s | min | h | d | wk | mo | a - unit of time (UCUM) | |
| dayOfWeek | 0..* | code | mon | tue | wed | thu | fri | sat | sun | |
| timeOfDay | 0..* | time | Time of day for action | |
| when | 0..* | code | Code for time period of occurrence | |
 asNeededBoolean | 0..1 | boolean | Reserve medication ('true' if in reserve, 'false' otherwise) | |
| route | 0..1 | CodeableConcept | Route of administration Binding: EDQM - RouteOfAdministration (required) | |
| method | 0..1 | CodeableConcept | Method of administration Binding: CHMED Method of Administration (required) | |
| doseAndRate | ||||
| doseRange | 0..1 | CHEMEDRangeWithEmedUnits | Set of values bounded by low and high | |
| low | 0..1 | CHEMEDQuantityWithEmedUnits | A fixed quantity (no comparator) | |
| high | 0..1 | CHEMEDQuantityWithEmedUnits | A fixed quantity (no comparator) | |
| doseQuantity | 0..1 | CHEMEDQuantityWithEmedUnits | A fixed quantity (no comparator) | |
| doseQuantityTo | 0..1 | CHEMEDQuantityWithEmedUnits | CHMED Dose Quantity To URL: http://chmed.emediplan.ch/fhir/StructureDefinition/chmed-dose-quantity-to | |
| value | 1..1 | decimal | Numerical value (with implicit precision) | |
| unit | 1..1 | string | Unit representation | |
| system | 1..1 | uri | System of the code from Units of Presentation | |
| code | 1..1 | code | Coded form of the unit | |
| maxDosePerPeriod | 0..1 | CHEMEDRatioWithEmedUnits | A ratio of two Quantity values - a numerator and a denominator | |
| numerator | 1..1 | CHEMEDQuantityWithEmedUnits | A fixed quantity (no comparator) | |
| denominator | ||||
| value | 1..1 | decimal | Numerical value (with implicit precision) | |
| unit | 1..1 | string | Unit representation | |
| system | 1..1 | uri | System of the code from Units of Presentation | |
| code | 1..1 | code | Coded form of the unit | |
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Dosage | 0..* | Dosage | CHMED Dosage | |
| id | 0..1 | string | Unique id for inter-element referencing | |
 Slices for extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| posologyObjectType | S | 0..* | Coding | CHMED Posology Object Type URL: http://chmed.emediplan.ch/fhir/StructureDefinition/chmed-posology-object-type Binding: CHMED Posology Object Type (required) |
| timedDosageObjectType | S | 0..1 | Coding | CHMED Timed Dosage Object Type URL: http://chmed.emediplan.ch/fhir/StructureDefinition/chmed-timed-dosage-object-type Binding: CHMED Timed Dosage Object Type (required) |
 modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| sequence | Σ | 0..1 | integer | The order of the dosage instructions (number is identical -> concurrent, number is different -> sequential) |
| text | Σ | 0..1 | string | Free text dosage instructions e.g. SIG |
| Slices for additionalInstruction | Σ | 0..* | CodeableConcept | Supplemental instruction or warnings to the patient - e.g. "with meals", "may cause drowsiness" Slice: Unordered, Open by pattern:$this Binding: SNOMEDCTAdditionalDosageInstructions (example): A coded concept identifying additional instructions such as "take with water" or "avoid operating heavy machinery". |
| additionalInstruction:relativeToMeal | Σ | 0..1 | CodeableConcept | When the medicament must be applied relative to a meal (before, during or after) Binding: CHMED Relative to Meal (required) |
| additionalInstruction:evenOddDays | Σ | 0..1 | CodeableConcept | The medicament is be applied on even or odd days Binding: CHMED Even/Odd Days (required) |
| patientInstruction | Σ | 0..1 | string | Patient or consumer oriented instructions |
| timing | Σ | 0..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 | ΣI | 0..1 | Element | When the event is to occur |
| id | 0..1 | string | Unique id for inter-element referencing | |
| Slices for extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| dayOfMonth | 0..* | positiveInt | Day of Month for schedule URL: http://hl7.org/fhir/StructureDefinition/timing-dayOfMonth | |
| 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 | Σ | 0..1 | Period | Length/Range of lengths, or (Start and/or end) limits |
 id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| start | ΣI | 0..1 | dateTime | Starting time with inclusive boundary |
 end | ΣI | 0..1 | dateTime | End time with inclusive boundary, if not ongoing |
| 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 | Σ | 0..* | 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. |
| Slices for asNeeded[x] | Σ | 0..1 | boolean | Take "as needed" (for x) Slice: Unordered, Closed by type:$this |
| asNeeded[x]:asNeededBoolean | Σ | 0..1 | boolean | Reserve medication ('true' if in reserve, 'false' otherwise) |
| site | Σ | 0..1 | CodeableConcept | Body site to administer to Binding: SNOMEDCTAnatomicalStructureForAdministrationSiteCodes (example): A coded concept describing the site location the medicine enters into or onto the body. |
| route | Σ | 0..1 | CodeableConcept | Route of administration Binding: EDQM - RouteOfAdministration (required) |
| method | Σ | 0..1 | CodeableConcept | Method of administration Binding: CHMED Method of Administration (required) |
| doseAndRate | Σ | 0..* | 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. |
| Slices for dose[x] | Σ | 0..1 | Amount of medication per dose Slice: Unordered, Closed by type:$this | |
| doseRange | Range | |||
| doseQuantity | Quantity | |||
 dose[x]:doseRange | I | 0..1 | CHEMEDRangeWithEmedUnits | Set of values bounded by low and high |
 id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| low | I | 0..1 | CHEMEDQuantityWithEmedUnits | A fixed quantity (no comparator) |
| high | I | 0..1 | CHEMEDQuantityWithEmedUnits | A fixed quantity (no comparator) |
| dose[x]:doseQuantity | I | 0..1 | CHEMEDQuantityWithEmedUnits | A fixed quantity (no comparator) |
| id | 0..1 | string | Unique id for inter-element referencing | |
| Slices for extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| doseQuantityTo | 0..1 | CHEMEDQuantityWithEmedUnits | CHMED Dose Quantity To URL: http://chmed.emediplan.ch/fhir/StructureDefinition/chmed-dose-quantity-to | |
| value | Σ | 1..1 | decimal | Numerical value (with implicit precision) |
| unit | Σ | 1..1 | string | Unit representation |
| system | ΣI | 1..1 | uri | System of the code from Units of Presentation |
| code | Σ | 1..1 | code | Coded form of the unit Binding: UnitCode (required): The coded unit used describing the quantity. |
 rate[x] | Σ | 0..1 | Amount of medication per unit of time | |
| rateRatio | Ratio | |||
| rateRange | Range | |||
| rateQuantity | Quantity(SimpleQuantity) | |||
| maxDosePerPeriod | I | 0..1 | CHEMEDRatioWithEmedUnits | A ratio of two Quantity values - a numerator and a denominator |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| numerator | I | 1..1 | CHEMEDQuantityWithEmedUnits | A fixed quantity (no comparator) |
| denominator | I | 1..1 | CHEMEDQuantityWithEmedUnits | A fixed quantity (no comparator) |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| value | Σ | 1..1 | decimal | Numerical value (with implicit precision) |
| unit | Σ | 1..1 | string | Unit representation |
| system | ΣI | 1..1 | uri | System of the code from Units of Presentation |
| code | Σ | 1..1 | code | Coded form of the unit Binding: UnitCode (required): The coded unit used describing the quantity. |
| maxDosePerAdministration | Σ | 0..1 | SimpleQuantity | Upper limit on medication per administration |
| maxDosePerLifetime | Σ | 0..1 | SimpleQuantity | Upper limit on medication per lifetime of the patient |
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Dosage | 0..* | Dosage | CHMED Dosage | |
| posologyObjectType | 0..* | Coding | CHMED Posology Object Type URL: http://chmed.emediplan.ch/fhir/StructureDefinition/chmed-posology-object-type Binding: CHMED Posology Object Type (required) | |
| timedDosageObjectType | 0..1 | Coding | CHMED Timed Dosage Object Type URL: http://chmed.emediplan.ch/fhir/StructureDefinition/chmed-timed-dosage-object-type Binding: CHMED Timed Dosage Object Type (required) | |
| Documentation for this format | ||||
This structure is derived from Dosage
Summary
Must-Support: 2 elements
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
Differential View
This structure is derived from Dosage
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Dosage | 0..* | Dosage | CHMED Dosage | |
| posologyObjectType | S | 0..* | Coding | CHMED Posology Object Type URL: http://chmed.emediplan.ch/fhir/StructureDefinition/chmed-posology-object-type Binding: CHMED Posology Object Type (required) |
| timedDosageObjectType | S | 0..1 | Coding | CHMED Timed Dosage Object Type URL: http://chmed.emediplan.ch/fhir/StructureDefinition/chmed-timed-dosage-object-type Binding: CHMED Timed Dosage Object Type (required) |
| sequence | 0..1 | integer | The order of the dosage instructions (number is identical -> concurrent, number is different -> sequential) | |
| Slices for additionalInstruction | 0..* | CodeableConcept | Supplemental instruction or warnings to the patient - e.g. "with meals", "may cause drowsiness" Slice: Unordered, Open by pattern:$this | |
| additionalInstruction:relativeToMeal | 0..1 | CodeableConcept | When the medicament must be applied relative to a meal (before, during or after) Binding: CHMED Relative to Meal (required) | |
| additionalInstruction:evenOddDays | 0..1 | CodeableConcept | The medicament is be applied on even or odd days Binding: CHMED Even/Odd Days (required) | |
| timing | ||||
| repeat | ||||
| dayOfMonth | 0..* | positiveInt | Day of Month for schedule URL: http://hl7.org/fhir/StructureDefinition/timing-dayOfMonth | |
| boundsPeriod | 0..1 | Period | Length/Range of lengths, or (Start and/or end) limits | |
| start | 0..1 | dateTime | Starting time with inclusive boundary | |
| end | 0..1 | dateTime | End time with inclusive boundary, if not ongoing | |
| count | 0..1 | positiveInt | Number of times to repeat | |
| duration | 0..1 | decimal | How long when it happens | |
| durationUnit | 0..1 | code | s | min | h | d | wk | mo | a - unit of time (UCUM) | |
| frequency | 0..1 | positiveInt | Event occurs frequency times per period | |
| period | 0..1 | decimal | Event occurs frequency times per period | |
| periodUnit | 0..1 | code | s | min | h | d | wk | mo | a - unit of time (UCUM) | |
| dayOfWeek | 0..* | code | mon | tue | wed | thu | fri | sat | sun | |
| timeOfDay | 0..* | time | Time of day for action | |
| when | 0..* | code | Code for time period of occurrence | |
| asNeededBoolean | 0..1 | boolean | Reserve medication ('true' if in reserve, 'false' otherwise) | |
| route | 0..1 | CodeableConcept | Route of administration Binding: EDQM - RouteOfAdministration (required) | |
| method | 0..1 | CodeableConcept | Method of administration Binding: CHMED Method of Administration (required) | |
| doseAndRate | ||||
| doseRange | 0..1 | CHEMEDRangeWithEmedUnits | Set of values bounded by low and high | |
| low | 0..1 | CHEMEDQuantityWithEmedUnits | A fixed quantity (no comparator) | |
| high | 0..1 | CHEMEDQuantityWithEmedUnits | A fixed quantity (no comparator) | |
| doseQuantity | 0..1 | CHEMEDQuantityWithEmedUnits | A fixed quantity (no comparator) | |
| doseQuantityTo | 0..1 | CHEMEDQuantityWithEmedUnits | CHMED Dose Quantity To URL: http://chmed.emediplan.ch/fhir/StructureDefinition/chmed-dose-quantity-to | |
| value | 1..1 | decimal | Numerical value (with implicit precision) | |
| unit | 1..1 | string | Unit representation | |
| system | 1..1 | uri | System of the code from Units of Presentation | |
| code | 1..1 | code | Coded form of the unit | |
| maxDosePerPeriod | 0..1 | CHEMEDRatioWithEmedUnits | A ratio of two Quantity values - a numerator and a denominator | |
| numerator | 1..1 | CHEMEDQuantityWithEmedUnits | A fixed quantity (no comparator) | |
| denominator | ||||
| value | 1..1 | decimal | Numerical value (with implicit precision) | |
| unit | 1..1 | string | Unit representation | |
| system | 1..1 | uri | System of the code from Units of Presentation | |
| code | 1..1 | code | Coded form of the unit | |
| Documentation for this format | ||||
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Dosage | 0..* | Dosage | CHMED Dosage | |
| id | 0..1 | string | Unique id for inter-element referencing | |
| Slices for extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| posologyObjectType | S | 0..* | Coding | CHMED Posology Object Type URL: http://chmed.emediplan.ch/fhir/StructureDefinition/chmed-posology-object-type Binding: CHMED Posology Object Type (required) |
| timedDosageObjectType | S | 0..1 | Coding | CHMED Timed Dosage Object Type URL: http://chmed.emediplan.ch/fhir/StructureDefinition/chmed-timed-dosage-object-type Binding: CHMED Timed Dosage Object Type (required) |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| sequence | Σ | 0..1 | integer | The order of the dosage instructions (number is identical -> concurrent, number is different -> sequential) |
| text | Σ | 0..1 | string | Free text dosage instructions e.g. SIG |
| Slices for additionalInstruction | Σ | 0..* | CodeableConcept | Supplemental instruction or warnings to the patient - e.g. "with meals", "may cause drowsiness" Slice: Unordered, Open by pattern:$this Binding: SNOMEDCTAdditionalDosageInstructions (example): A coded concept identifying additional instructions such as "take with water" or "avoid operating heavy machinery". |
| additionalInstruction:relativeToMeal | Σ | 0..1 | CodeableConcept | When the medicament must be applied relative to a meal (before, during or after) Binding: CHMED Relative to Meal (required) |
| additionalInstruction:evenOddDays | Σ | 0..1 | CodeableConcept | The medicament is be applied on even or odd days Binding: CHMED Even/Odd Days (required) |
| patientInstruction | Σ | 0..1 | string | Patient or consumer oriented instructions |
| timing | Σ | 0..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 | ΣI | 0..1 | Element | When the event is to occur |
| id | 0..1 | string | Unique id for inter-element referencing | |
| Slices for extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| dayOfMonth | 0..* | positiveInt | Day of Month for schedule URL: http://hl7.org/fhir/StructureDefinition/timing-dayOfMonth | |
| 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 | Σ | 0..1 | Period | Length/Range of lengths, or (Start and/or end) limits |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| start | ΣI | 0..1 | dateTime | Starting time with inclusive boundary |
| end | ΣI | 0..1 | dateTime | End time with inclusive boundary, if not ongoing |
| 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 | Σ | 0..* | 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. |
| Slices for asNeeded[x] | Σ | 0..1 | boolean | Take "as needed" (for x) Slice: Unordered, Closed by type:$this |
| asNeeded[x]:asNeededBoolean | Σ | 0..1 | boolean | Reserve medication ('true' if in reserve, 'false' otherwise) |
| site | Σ | 0..1 | CodeableConcept | Body site to administer to Binding: SNOMEDCTAnatomicalStructureForAdministrationSiteCodes (example): A coded concept describing the site location the medicine enters into or onto the body. |
| route | Σ | 0..1 | CodeableConcept | Route of administration Binding: EDQM - RouteOfAdministration (required) |
| method | Σ | 0..1 | CodeableConcept | Method of administration Binding: CHMED Method of Administration (required) |
| doseAndRate | Σ | 0..* | 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. |
| Slices for dose[x] | Σ | 0..1 | Amount of medication per dose Slice: Unordered, Closed by type:$this | |
| doseRange | Range | |||
| doseQuantity | Quantity | |||
| dose[x]:doseRange | I | 0..1 | CHEMEDRangeWithEmedUnits | Set of values bounded by low and high |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| low | I | 0..1 | CHEMEDQuantityWithEmedUnits | A fixed quantity (no comparator) |
| high | I | 0..1 | CHEMEDQuantityWithEmedUnits | A fixed quantity (no comparator) |
| dose[x]:doseQuantity | I | 0..1 | CHEMEDQuantityWithEmedUnits | A fixed quantity (no comparator) |
| id | 0..1 | string | Unique id for inter-element referencing | |
| Slices for extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| doseQuantityTo | 0..1 | CHEMEDQuantityWithEmedUnits | CHMED Dose Quantity To URL: http://chmed.emediplan.ch/fhir/StructureDefinition/chmed-dose-quantity-to | |
| value | Σ | 1..1 | decimal | Numerical value (with implicit precision) |
| unit | Σ | 1..1 | string | Unit representation |
| system | ΣI | 1..1 | uri | System of the code from Units of Presentation |
| code | Σ | 1..1 | code | Coded form of the unit Binding: UnitCode (required): The coded unit used describing the quantity. |
| rate[x] | Σ | 0..1 | Amount of medication per unit of time | |
| rateRatio | Ratio | |||
| rateRange | Range | |||
| rateQuantity | Quantity(SimpleQuantity) | |||
| maxDosePerPeriod | I | 0..1 | CHEMEDRatioWithEmedUnits | A ratio of two Quantity values - a numerator and a denominator |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| numerator | I | 1..1 | CHEMEDQuantityWithEmedUnits | A fixed quantity (no comparator) |
| denominator | I | 1..1 | CHEMEDQuantityWithEmedUnits | A fixed quantity (no comparator) |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| value | Σ | 1..1 | decimal | Numerical value (with implicit precision) |
| unit | Σ | 1..1 | string | Unit representation |
| system | ΣI | 1..1 | uri | System of the code from Units of Presentation |
| code | Σ | 1..1 | code | Coded form of the unit Binding: UnitCode (required): The coded unit used describing the quantity. |
| maxDosePerAdministration | Σ | 0..1 | SimpleQuantity | Upper limit on medication per administration |
| maxDosePerLifetime | Σ | 0..1 | SimpleQuantity | Upper limit on medication per lifetime of the patient |
| Documentation for this format | ||||
Other representations of profile: CSV, Excel, Schematron
| Path | Conformance | ValueSet |
| Dosage.additionalInstruction | example | SNOMEDCTAdditionalDosageInstructions |
| Dosage.additionalInstruction:relativeToMeal | required | RelativeToMeal |
| Dosage.additionalInstruction:evenOddDays | required | EvenOddDays |
| 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.site | example | SNOMEDCTAnatomicalStructureForAdministrationSiteCodes |
| Dosage.route | required | RouteOfAdministrationEDQM |
| Dosage.method | required | CDTYP62 |
| Dosage.doseAndRate.type | example | DoseAndRateType |
| Dosage.doseAndRate.dose[x]:doseQuantity.code | required | UnitCode |
| Dosage.maxDosePerPeriod.denominator.code | required | UnitCode |
| Id | Grade | Path | Details | Requirements |
| ele-1 | error | Dosage | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Dosage.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | Dosage.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | error | Dosage.extension:posologyObjectType | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | Dosage.extension:posologyObjectType | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | error | Dosage.extension:timedDosageObjectType | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | Dosage.extension:timedDosageObjectType | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | error | Dosage.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | Dosage.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | error | Dosage.sequence | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Dosage.text | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Dosage.additionalInstruction | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Dosage.additionalInstruction:relativeToMeal | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Dosage.additionalInstruction:evenOddDays | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Dosage.patientInstruction | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Dosage.timing | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Dosage.timing.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | Dosage.timing.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | error | Dosage.timing.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | Dosage.timing.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | error | Dosage.timing.event | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Dosage.timing.repeat | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| 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() | |
| ele-1 | error | Dosage.timing.repeat.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | Dosage.timing.repeat.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | error | Dosage.timing.repeat.extension:dayOfMonth | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | Dosage.timing.repeat.extension:dayOfMonth | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | error | Dosage.timing.repeat.bounds[x] | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Dosage.timing.repeat.bounds[x]:boundsPeriod | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Dosage.timing.repeat.bounds[x]:boundsPeriod.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | Dosage.timing.repeat.bounds[x]:boundsPeriod.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | error | Dosage.timing.repeat.bounds[x]:boundsPeriod.start | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Dosage.timing.repeat.bounds[x]:boundsPeriod.end | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Dosage.timing.repeat.count | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Dosage.timing.repeat.countMax | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Dosage.timing.repeat.duration | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Dosage.timing.repeat.durationMax | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Dosage.timing.repeat.durationUnit | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Dosage.timing.repeat.frequency | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Dosage.timing.repeat.frequencyMax | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Dosage.timing.repeat.period | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Dosage.timing.repeat.periodMax | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Dosage.timing.repeat.periodUnit | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Dosage.timing.repeat.dayOfWeek | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Dosage.timing.repeat.timeOfDay | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Dosage.timing.repeat.when | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Dosage.timing.repeat.offset | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Dosage.timing.code | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Dosage.asNeeded[x] | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Dosage.asNeeded[x]:asNeededBoolean | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Dosage.site | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Dosage.route | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Dosage.method | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Dosage.doseAndRate | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Dosage.doseAndRate.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | Dosage.doseAndRate.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | error | Dosage.doseAndRate.type | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Dosage.doseAndRate.dose[x] | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Dosage.doseAndRate.dose[x]:doseRange | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| 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) | |
| ele-1 | error | Dosage.doseAndRate.dose[x]:doseRange.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | Dosage.doseAndRate.dose[x]:doseRange.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | error | Dosage.doseAndRate.dose[x]:doseRange.low | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| qty-3 | error | Dosage.doseAndRate.dose[x]:doseRange.low | If a code for the unit is present, the system SHALL also be present : code.empty() or system.exists() | |
| sqty-1 | error | Dosage.doseAndRate.dose[x]:doseRange.low | The comparator is not used on a SimpleQuantity : comparator.empty() | |
| ele-1 | error | Dosage.doseAndRate.dose[x]:doseRange.high | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| qty-3 | error | Dosage.doseAndRate.dose[x]:doseRange.high | If a code for the unit is present, the system SHALL also be present : code.empty() or system.exists() | |
| sqty-1 | error | Dosage.doseAndRate.dose[x]:doseRange.high | The comparator is not used on a SimpleQuantity : comparator.empty() | |
| ele-1 | error | Dosage.doseAndRate.dose[x]:doseQuantity | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| 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() | |
| sqty-1 | error | Dosage.doseAndRate.dose[x]:doseQuantity | The comparator is not used on a SimpleQuantity : comparator.empty() | |
| ele-1 | error | Dosage.doseAndRate.dose[x]:doseQuantity.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | Dosage.doseAndRate.dose[x]:doseQuantity.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | error | Dosage.doseAndRate.dose[x]:doseQuantity.extension:doseQuantityTo | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | Dosage.doseAndRate.dose[x]:doseQuantity.extension:doseQuantityTo | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | error | Dosage.doseAndRate.dose[x]:doseQuantity.value | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Dosage.doseAndRate.dose[x]:doseQuantity.unit | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Dosage.doseAndRate.dose[x]:doseQuantity.system | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Dosage.doseAndRate.dose[x]:doseQuantity.code | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Dosage.doseAndRate.rate[x] | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Dosage.maxDosePerPeriod | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| rat-1 | error | 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()) | |
| ele-1 | error | Dosage.maxDosePerPeriod.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | Dosage.maxDosePerPeriod.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | error | Dosage.maxDosePerPeriod.numerator | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| qty-3 | error | Dosage.maxDosePerPeriod.numerator | If a code for the unit is present, the system SHALL also be present : code.empty() or system.exists() | |
| sqty-1 | error | Dosage.maxDosePerPeriod.numerator | The comparator is not used on a SimpleQuantity : comparator.empty() | |
| ele-1 | error | Dosage.maxDosePerPeriod.denominator | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| qty-3 | error | Dosage.maxDosePerPeriod.denominator | If a code for the unit is present, the system SHALL also be present : code.empty() or system.exists() | |
| sqty-1 | error | Dosage.maxDosePerPeriod.denominator | The comparator is not used on a SimpleQuantity : comparator.empty() | |
| ele-1 | error | Dosage.maxDosePerPeriod.denominator.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | Dosage.maxDosePerPeriod.denominator.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | error | Dosage.maxDosePerPeriod.denominator.value | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Dosage.maxDosePerPeriod.denominator.unit | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Dosage.maxDosePerPeriod.denominator.system | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Dosage.maxDosePerPeriod.denominator.code | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Dosage.maxDosePerAdministration | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Dosage.maxDosePerLifetime | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |