CH EMED (R4)
5.0.0 - trial-use
CH EMED (R4)
5.0.0 - trial-use
This page is part of the CH EMED (R4) (v5.0.0: STU 5) based on FHIR (HL7® FHIR® Standard) R4. This is the current published version. For a full list of available versions, see the Directory of published versions
| Official URL: http://fhir.ch/ig/ch-emed/StructureDefinition/ch-emed-dosage-medicationrequest | Version: 5.0.0 | |||
| Active as of 2024-12-17 | Computable Name: CHEMEDDosageMedicationRequest | |||
Copyright/Legal: CC0-1.0 |
||||
Definition of the dosage (used in MedicationRequest)
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 |
C | 0..* | CHEMEDDosage | CH EMED Dosage (MedicationRequest) ch-dosage-3: Patient instruction/free text dosage instruction, or timing and dose/rate has to be specified |
| Documentation for this format | ||||
| Id | Grade | Path(s) | Details | Requirements |
| ch-dosage-3 | error | Dosage | Patient instruction/free text dosage instruction, or timing and dose/rate has to be specified : patientInstruction.exists() or (timing.exists() and doseAndRate.exists()) |
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Dosage |
C | 0..* | CHEMEDDosage | CH EMED Dosage (MedicationRequest) ele-1: All FHIR elements must have a @value or children ch-dosage-4: For split dosage timing event and dose/rate are required ch-dosage-3: Patient instruction/free text dosage instruction, or timing and dose/rate has to be specified |
  modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
 patientInstruction |
SΣ | 0..1 | string | Patient instructions (e.g. 'take with food'), incl. free text dosage instructions (e.g. for complex dosage) ele-1: All FHIR elements must have a @value or children |
  timing |
Σ | 0..1 | Timing | When medication should be administered ele-1: All FHIR elements must have a @value or children |
 modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
 repeat |
ΣC | 0..1 | Element | When the event is to occur ele-1: All FHIR elements must have a @value or children tim-1: if there's a duration, there needs to be duration units tim-2: if there's a period, there needs to be period units tim-4: duration SHALL be a non-negative value tim-5: period SHALL be a non-negative value tim-6: If there's a periodMax, there must be a period tim-7: If there's a durationMax, there must be a duration tim-8: If there's a countMax, there must be a count tim-9: If there's an offset, there must be a when (and not C, CM, CD, CV) tim-10: If there's a timeOfDay, there cannot be a when, or vice versa |
  Slices for bounds[x] |
Σ | 0..1 | Length/Range of lengths, or (Start and/or end) limits Slice: Unordered, Open by type:$this ele-1: All FHIR elements must have a @value or children | |
 boundsDuration |
Duration | |||
| boundsRange |
Range | |||
| boundsPeriod |
Period | |||
  bounds[x]:boundsPeriod |
SΣ | 0..1 | Period | Start and/or end of treatment ele-1: All FHIR elements must have a @value or children |
 when |
SΣC | 0..* | code | Code for time period of occurrence Binding: EventTiming (required): Real world event relating to the schedule. ele-1: All FHIR elements must have a @value or children ch-emed-event-timing: For the representation of the time of administration according to the 1-1-1-1 scheme, the values MORN-NOON-EVE-NIGHT are highly recommended. |
| Slices for asNeeded[x] |
Σ | 0..1 | Take "as needed" (for x) Slice: Unordered, Open by type:$this Binding: SNOMEDCTMedicationAsNeededReasonCodes (example): A coded concept identifying the precondition that should be met or evaluated prior to consuming or administering a medication dose. For example "pain", "30 minutes prior to sexual intercourse", "on flare-up" etc. ele-1: All FHIR elements must have a @value or children | |
| asNeededBoolean |
boolean | |||
| asNeededCodeableConcept |
CodeableConcept | |||
| asNeeded[x]:asNeededBoolean |
Σ | 0..1 | boolean | In reserve (to be taken by the patient only if the need arises - e.g. pains) ele-1: All FHIR elements must have a @value or children |
| route |
Σ | 0..1 | CodeableConcept | Route of administration Binding: EDQM - RouteOfAdministration (required) ele-1: All FHIR elements must have a @value or children |
| coding |
SΣ | 1..* | Coding | Code defined by a terminology system ele-1: All FHIR elements must have a @value or children |
| system |
Σ | 1..1 | uri | Identity of the terminology system ele-1: All FHIR elements must have a @value or children |
| code |
Σ | 1..1 | code | Symbol in syntax defined by the system ele-1: All FHIR elements must have a @value or children |
| doseAndRate |
Σ | 0..1 | Element | Amount of medication administered ele-1: All FHIR elements must have a @value or children |
 dose[x] |
SΣ | 0..1 | Amount of medication per dose ele-1: All FHIR elements must have a @value or children | |
| doseRange |
Range(CHCoreRangeWithEmedUnits) | |||
| doseQuantity |
Quantity(CHCoreQuantityWithEmedUnits) | |||
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| Dosage.timing.repeat.when | required | EventTiminghttp://hl7.org/fhir/ValueSet/event-timing|4.0.1from the FHIR Standard | |
| Dosage.asNeeded[x] | example | SNOMEDCTMedicationAsNeededReasonCodeshttp://hl7.org/fhir/ValueSet/medication-as-needed-reasonfrom the FHIR Standard | |
| Dosage.route | required | RouteOfAdministrationEDQMhttp://fhir.ch/ig/ch-term/ValueSet/edqm-routeofadministration |
| Id | Grade | Path(s) | Details | Requirements |
| ch-dosage-3 | error | Dosage | Patient instruction/free text dosage instruction, or timing and dose/rate has to be specified : patientInstruction.exists() or (timing.exists() and doseAndRate.exists()) | |
| ch-dosage-4 | error | Dosage | For split dosage timing event and dose/rate are required : sequence.exists() implies (timing.repeat.when.exists() and doseAndRate.dose.exists()) | |
| ch-emed-event-timing | warning | Dosage.timing.repeat.when | For the representation of the time of administration according to the 1-1-1-1 scheme, the values MORN-NOON-EVE-NIGHT are highly recommended. : $this='MORN' or $this='NOON' or $this='EVE' or $this='NIGHT' | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| tim-1 | error | Dosage.timing.repeat | if there's a duration, there needs to be duration units : duration.empty() or durationUnit.exists() | |
| tim-2 | error | Dosage.timing.repeat | if there's a period, there needs to be period units : period.empty() or periodUnit.exists() | |
| tim-4 | error | Dosage.timing.repeat | duration SHALL be a non-negative value : duration.exists() implies duration >= 0 | |
| tim-5 | error | Dosage.timing.repeat | period SHALL be a non-negative value : period.exists() implies period >= 0 | |
| tim-6 | error | Dosage.timing.repeat | If there's a periodMax, there must be a period : periodMax.empty() or period.exists() | |
| tim-7 | error | Dosage.timing.repeat | If there's a durationMax, there must be a duration : durationMax.empty() or duration.exists() | |
| tim-8 | error | Dosage.timing.repeat | If there's a countMax, there must be a count : countMax.empty() or count.exists() | |
| tim-9 | error | Dosage.timing.repeat | If there's an offset, there must be a when (and not C, CM, CD, CV) : offset.empty() or (when.exists() and ((when in ('C' | 'CM' | 'CD' | 'CV')).not())) | |
| tim-10 | error | Dosage.timing.repeat | If there's a timeOfDay, there cannot be a when, or vice versa : timeOfDay.empty() or when.empty() |
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Dosage |
C | 0..* | CHEMEDDosage | CH EMED Dosage (MedicationRequest) ch-dosage-4: For split dosage timing event and dose/rate are required ch-dosage-3: Patient instruction/free text dosage instruction, or timing and dose/rate has to be specified |
| id |
0..1 | string | Unique id for inter-element referencing | |
 extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| sequence |
ΣC | 0..1 | integer | The order of the dosage instructions ch-dosage-1: No sequence number (for one dosage element) or sequence number = 1 (for more than one dosage element) |
| text |
Σ | 0..1 | string | Free text dosage instructions e.g. SIG |
| 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". |
| 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 | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| event |
Σ | 0..* | dateTime | When the event occurs |
| repeat |
ΣC | 0..1 | Element | When the event is to occur tim-1: if there's a duration, there needs to be duration units tim-2: if there's a period, there needs to be period units tim-4: duration SHALL be a non-negative value tim-5: period SHALL be a non-negative value tim-6: If there's a periodMax, there must be a period tim-7: If there's a durationMax, there must be a duration tim-8: If there's a countMax, there must be a count tim-9: If there's an offset, there must be a when (and not C, CM, CD, CV) tim-10: If there's a timeOfDay, there cannot be a when, or vice versa |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| Slices for bounds[x] |
Σ | 0..1 | Length/Range of lengths, or (Start and/or end) limits Slice: Unordered, Open by type:$this | |
| boundsDuration |
Duration | |||
| boundsRange |
Range | |||
| boundsPeriod |
Period | |||
| bounds[x]:boundsPeriod |
SΣ | 0..1 | Period | Start and/or end of treatment |
| count |
Σ | 0..1 | positiveInt | Number of times to repeat |
| countMax |
Σ | 0..1 | positiveInt | Maximum number of times to repeat |
| duration |
Σ | 0..1 | decimal | How long when it happens |
| durationMax |
Σ | 0..1 | decimal | How long when it happens (Max) |
| durationUnit |
Σ | 0..1 | code | s | min | h | d | wk | mo | a - unit of time (UCUM) Binding: UnitsOfTime (required): A unit of time (units from UCUM). |
| frequency |
Σ | 0..1 | positiveInt | Event occurs frequency times per period |
| frequencyMax |
Σ | 0..1 | positiveInt | Event occurs up to frequencyMax times per period |
| period |
Σ | 0..1 | decimal | Event occurs frequency times per period |
| periodMax |
Σ | 0..1 | decimal | Upper limit of period (3-4 hours) |
| periodUnit |
Σ | 0..1 | code | s | min | h | d | wk | mo | a - unit of time (UCUM) Binding: UnitsOfTime (required): A unit of time (units from UCUM). |
| dayOfWeek |
Σ | 0..* | code | mon | tue | wed | thu | fri | sat | sun Binding: DaysOfWeek (required) |
| timeOfDay |
Σ | 0..* | time | Time of day for action |
| when |
SΣC | 0..* | code | Code for time period of occurrence Binding: EventTiming (required): Real world event relating to the schedule. ch-emed-event-timing: For the representation of the time of administration according to the 1-1-1-1 scheme, the values MORN-NOON-EVE-NIGHT are highly recommended. |
| 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 | Take "as needed" (for x) Slice: Unordered, Open by type:$this Binding: SNOMEDCTMedicationAsNeededReasonCodes (example): A coded concept identifying the precondition that should be met or evaluated prior to consuming or administering a medication dose. For example "pain", "30 minutes prior to sexual intercourse", "on flare-up" etc. | |
| asNeededBoolean |
boolean | |||
| asNeededCodeableConcept |
CodeableConcept | |||
| 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 | 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) |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations 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 |
Σ | 0..1 | string | Plain text representation of the concept |
| method |
Σ | 0..1 | CodeableConcept | Administration method Binding: EDQM - Administration Method (required) |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| coding |
Σ | 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 |
Σ | 0..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 | The kind of dose or rate specified Binding: DoseAndRateType (example): The kind of dose or rate specified. |
| dose[x] |
SΣ | 0..1 | Amount of medication per dose | |
| doseRange |
Range(CHCoreRangeWithEmedUnits) | |||
| doseQuantity |
Quantity(CHCoreQuantityWithEmedUnits) | |||
| rate[x] |
Σ | 0..1 | Amount of medication per unit of time | |
| rateRatio |
Ratio | |||
| rateRange |
Range | |||
| rateQuantity |
Quantity(SimpleQuantity) | |||
| maxDosePerPeriod |
Σ | 0..1 | Ratio | Upper limit on medication per unit of time |
| 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 | ||||
| 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.asNeeded[x] | example | SNOMEDCTMedicationAsNeededReasonCodeshttp://hl7.org/fhir/ValueSet/medication-as-needed-reasonfrom 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-term/ValueSet/edqm-routeofadministration | |
| Dosage.method | required | AdministrationMethodEDQMhttp://fhir.ch/ig/ch-term/ValueSet/edqm-administrationmethod | |
| 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-3 | error | Dosage | Patient instruction/free text dosage instruction, or timing and dose/rate has to be specified : patientInstruction.exists() or (timing.exists() and doseAndRate.exists()) | |
| ch-dosage-4 | error | Dosage | For split dosage timing event and dose/rate are required : sequence.exists() implies (timing.repeat.when.exists() and doseAndRate.dose.exists()) | |
| ch-emed-event-timing | warning | Dosage.timing.repeat.when | For the representation of the time of administration according to the 1-1-1-1 scheme, the values MORN-NOON-EVE-NIGHT are highly recommended. : $this='MORN' or $this='NOON' or $this='EVE' or $this='NIGHT' | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| tim-1 | error | Dosage.timing.repeat | if there's a duration, there needs to be duration units : duration.empty() or durationUnit.exists() | |
| tim-2 | error | Dosage.timing.repeat | if there's a period, there needs to be period units : period.empty() or periodUnit.exists() | |
| tim-4 | error | Dosage.timing.repeat | duration SHALL be a non-negative value : duration.exists() implies duration >= 0 | |
| tim-5 | error | Dosage.timing.repeat | period SHALL be a non-negative value : period.exists() implies period >= 0 | |
| tim-6 | error | Dosage.timing.repeat | If there's a periodMax, there must be a period : periodMax.empty() or period.exists() | |
| tim-7 | error | Dosage.timing.repeat | If there's a durationMax, there must be a duration : durationMax.empty() or duration.exists() | |
| tim-8 | error | Dosage.timing.repeat | If there's a countMax, there must be a count : countMax.empty() or count.exists() | |
| tim-9 | error | Dosage.timing.repeat | If there's an offset, there must be a when (and not C, CM, CD, CV) : offset.empty() or (when.exists() and ((when in ('C' | 'CM' | 'CD' | 'CV')).not())) | |
| tim-10 | error | Dosage.timing.repeat | If there's a timeOfDay, there cannot be a when, or vice versa : timeOfDay.empty() or when.empty() |
This structure is derived from CHEMEDDosage
Differential View
This structure is derived from CHEMEDDosage
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Dosage |
C | 0..* | CHEMEDDosage | CH EMED Dosage (MedicationRequest) ch-dosage-3: Patient instruction/free text dosage instruction, or timing and dose/rate has to be specified |
| Documentation for this format | ||||
| Id | Grade | Path(s) | Details | Requirements |
| ch-dosage-3 | error | Dosage | Patient instruction/free text dosage instruction, or timing and dose/rate has to be specified : patientInstruction.exists() or (timing.exists() and doseAndRate.exists()) |
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Dosage |
C | 0..* | CHEMEDDosage | CH EMED Dosage (MedicationRequest) ele-1: All FHIR elements must have a @value or children ch-dosage-4: For split dosage timing event and dose/rate are required ch-dosage-3: Patient instruction/free text dosage instruction, or timing and dose/rate has to be specified |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| patientInstruction |
SΣ | 0..1 | string | Patient instructions (e.g. 'take with food'), incl. free text dosage instructions (e.g. for complex dosage) ele-1: All FHIR elements must have a @value or children |
| timing |
Σ | 0..1 | Timing | When medication should be administered ele-1: All FHIR elements must have a @value or children |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| repeat |
ΣC | 0..1 | Element | When the event is to occur ele-1: All FHIR elements must have a @value or children tim-1: if there's a duration, there needs to be duration units tim-2: if there's a period, there needs to be period units tim-4: duration SHALL be a non-negative value tim-5: period SHALL be a non-negative value tim-6: If there's a periodMax, there must be a period tim-7: If there's a durationMax, there must be a duration tim-8: If there's a countMax, there must be a count tim-9: If there's an offset, there must be a when (and not C, CM, CD, CV) tim-10: If there's a timeOfDay, there cannot be a when, or vice versa |
| Slices for bounds[x] |
Σ | 0..1 | Length/Range of lengths, or (Start and/or end) limits Slice: Unordered, Open by type:$this ele-1: All FHIR elements must have a @value or children | |
| boundsDuration |
Duration | |||
| boundsRange |
Range | |||
| boundsPeriod |
Period | |||
| bounds[x]:boundsPeriod |
SΣ | 0..1 | Period | Start and/or end of treatment ele-1: All FHIR elements must have a @value or children |
| when |
SΣC | 0..* | code | Code for time period of occurrence Binding: EventTiming (required): Real world event relating to the schedule. ele-1: All FHIR elements must have a @value or children ch-emed-event-timing: For the representation of the time of administration according to the 1-1-1-1 scheme, the values MORN-NOON-EVE-NIGHT are highly recommended. |
| Slices for asNeeded[x] |
Σ | 0..1 | Take "as needed" (for x) Slice: Unordered, Open by type:$this Binding: SNOMEDCTMedicationAsNeededReasonCodes (example): A coded concept identifying the precondition that should be met or evaluated prior to consuming or administering a medication dose. For example "pain", "30 minutes prior to sexual intercourse", "on flare-up" etc. ele-1: All FHIR elements must have a @value or children | |
| asNeededBoolean |
boolean | |||
| asNeededCodeableConcept |
CodeableConcept | |||
| asNeeded[x]:asNeededBoolean |
Σ | 0..1 | boolean | In reserve (to be taken by the patient only if the need arises - e.g. pains) ele-1: All FHIR elements must have a @value or children |
| route |
Σ | 0..1 | CodeableConcept | Route of administration Binding: EDQM - RouteOfAdministration (required) ele-1: All FHIR elements must have a @value or children |
| coding |
SΣ | 1..* | Coding | Code defined by a terminology system ele-1: All FHIR elements must have a @value or children |
| system |
Σ | 1..1 | uri | Identity of the terminology system ele-1: All FHIR elements must have a @value or children |
| code |
Σ | 1..1 | code | Symbol in syntax defined by the system ele-1: All FHIR elements must have a @value or children |
| doseAndRate |
Σ | 0..1 | Element | Amount of medication administered ele-1: All FHIR elements must have a @value or children |
| dose[x] |
SΣ | 0..1 | Amount of medication per dose ele-1: All FHIR elements must have a @value or children | |
| doseRange |
Range(CHCoreRangeWithEmedUnits) | |||
| doseQuantity |
Quantity(CHCoreQuantityWithEmedUnits) | |||
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| Dosage.timing.repeat.when | required | EventTiminghttp://hl7.org/fhir/ValueSet/event-timing|4.0.1from the FHIR Standard | |
| Dosage.asNeeded[x] | example | SNOMEDCTMedicationAsNeededReasonCodeshttp://hl7.org/fhir/ValueSet/medication-as-needed-reasonfrom the FHIR Standard | |
| Dosage.route | required | RouteOfAdministrationEDQMhttp://fhir.ch/ig/ch-term/ValueSet/edqm-routeofadministration |
| Id | Grade | Path(s) | Details | Requirements |
| ch-dosage-3 | error | Dosage | Patient instruction/free text dosage instruction, or timing and dose/rate has to be specified : patientInstruction.exists() or (timing.exists() and doseAndRate.exists()) | |
| ch-dosage-4 | error | Dosage | For split dosage timing event and dose/rate are required : sequence.exists() implies (timing.repeat.when.exists() and doseAndRate.dose.exists()) | |
| ch-emed-event-timing | warning | Dosage.timing.repeat.when | For the representation of the time of administration according to the 1-1-1-1 scheme, the values MORN-NOON-EVE-NIGHT are highly recommended. : $this='MORN' or $this='NOON' or $this='EVE' or $this='NIGHT' | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| tim-1 | error | Dosage.timing.repeat | if there's a duration, there needs to be duration units : duration.empty() or durationUnit.exists() | |
| tim-2 | error | Dosage.timing.repeat | if there's a period, there needs to be period units : period.empty() or periodUnit.exists() | |
| tim-4 | error | Dosage.timing.repeat | duration SHALL be a non-negative value : duration.exists() implies duration >= 0 | |
| tim-5 | error | Dosage.timing.repeat | period SHALL be a non-negative value : period.exists() implies period >= 0 | |
| tim-6 | error | Dosage.timing.repeat | If there's a periodMax, there must be a period : periodMax.empty() or period.exists() | |
| tim-7 | error | Dosage.timing.repeat | If there's a durationMax, there must be a duration : durationMax.empty() or duration.exists() | |
| tim-8 | error | Dosage.timing.repeat | If there's a countMax, there must be a count : countMax.empty() or count.exists() | |
| tim-9 | error | Dosage.timing.repeat | If there's an offset, there must be a when (and not C, CM, CD, CV) : offset.empty() or (when.exists() and ((when in ('C' | 'CM' | 'CD' | 'CV')).not())) | |
| tim-10 | error | Dosage.timing.repeat | If there's a timeOfDay, there cannot be a when, or vice versa : timeOfDay.empty() or when.empty() |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Dosage |
C | 0..* | CHEMEDDosage | CH EMED Dosage (MedicationRequest) ch-dosage-4: For split dosage timing event and dose/rate are required ch-dosage-3: Patient instruction/free text dosage instruction, or timing and dose/rate has to be specified |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| sequence |
ΣC | 0..1 | integer | The order of the dosage instructions ch-dosage-1: No sequence number (for one dosage element) or sequence number = 1 (for more than one dosage element) |
| text |
Σ | 0..1 | string | Free text dosage instructions e.g. SIG |
| 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". |
| 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 | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| event |
Σ | 0..* | dateTime | When the event occurs |
| repeat |
ΣC | 0..1 | Element | When the event is to occur tim-1: if there's a duration, there needs to be duration units tim-2: if there's a period, there needs to be period units tim-4: duration SHALL be a non-negative value tim-5: period SHALL be a non-negative value tim-6: If there's a periodMax, there must be a period tim-7: If there's a durationMax, there must be a duration tim-8: If there's a countMax, there must be a count tim-9: If there's an offset, there must be a when (and not C, CM, CD, CV) tim-10: If there's a timeOfDay, there cannot be a when, or vice versa |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| Slices for bounds[x] |
Σ | 0..1 | Length/Range of lengths, or (Start and/or end) limits Slice: Unordered, Open by type:$this | |
| boundsDuration |
Duration | |||
| boundsRange |
Range | |||
| boundsPeriod |
Period | |||
| bounds[x]:boundsPeriod |
SΣ | 0..1 | Period | Start and/or end of treatment |
| count |
Σ | 0..1 | positiveInt | Number of times to repeat |
| countMax |
Σ | 0..1 | positiveInt | Maximum number of times to repeat |
| duration |
Σ | 0..1 | decimal | How long when it happens |
| durationMax |
Σ | 0..1 | decimal | How long when it happens (Max) |
| durationUnit |
Σ | 0..1 | code | s | min | h | d | wk | mo | a - unit of time (UCUM) Binding: UnitsOfTime (required): A unit of time (units from UCUM). |
| frequency |
Σ | 0..1 | positiveInt | Event occurs frequency times per period |
| frequencyMax |
Σ | 0..1 | positiveInt | Event occurs up to frequencyMax times per period |
| period |
Σ | 0..1 | decimal | Event occurs frequency times per period |
| periodMax |
Σ | 0..1 | decimal | Upper limit of period (3-4 hours) |
| periodUnit |
Σ | 0..1 | code | s | min | h | d | wk | mo | a - unit of time (UCUM) Binding: UnitsOfTime (required): A unit of time (units from UCUM). |
| dayOfWeek |
Σ | 0..* | code | mon | tue | wed | thu | fri | sat | sun Binding: DaysOfWeek (required) |
| timeOfDay |
Σ | 0..* | time | Time of day for action |
| when |
SΣC | 0..* | code | Code for time period of occurrence Binding: EventTiming (required): Real world event relating to the schedule. ch-emed-event-timing: For the representation of the time of administration according to the 1-1-1-1 scheme, the values MORN-NOON-EVE-NIGHT are highly recommended. |
| 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 | Take "as needed" (for x) Slice: Unordered, Open by type:$this Binding: SNOMEDCTMedicationAsNeededReasonCodes (example): A coded concept identifying the precondition that should be met or evaluated prior to consuming or administering a medication dose. For example "pain", "30 minutes prior to sexual intercourse", "on flare-up" etc. | |
| asNeededBoolean |
boolean | |||
| asNeededCodeableConcept |
CodeableConcept | |||
| 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 | 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) |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations 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 |
Σ | 0..1 | string | Plain text representation of the concept |
| method |
Σ | 0..1 | CodeableConcept | Administration method Binding: EDQM - Administration Method (required) |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| coding |
Σ | 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 |
Σ | 0..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 | The kind of dose or rate specified Binding: DoseAndRateType (example): The kind of dose or rate specified. |
| dose[x] |
SΣ | 0..1 | Amount of medication per dose | |
| doseRange |
Range(CHCoreRangeWithEmedUnits) | |||
| doseQuantity |
Quantity(CHCoreQuantityWithEmedUnits) | |||
| rate[x] |
Σ | 0..1 | Amount of medication per unit of time | |
| rateRatio |
Ratio | |||
| rateRange |
Range | |||
| rateQuantity |
Quantity(SimpleQuantity) | |||
| maxDosePerPeriod |
Σ | 0..1 | Ratio | Upper limit on medication per unit of time |
| 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 | ||||
| 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.asNeeded[x] | example | SNOMEDCTMedicationAsNeededReasonCodeshttp://hl7.org/fhir/ValueSet/medication-as-needed-reasonfrom 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-term/ValueSet/edqm-routeofadministration | |
| Dosage.method | required | AdministrationMethodEDQMhttp://fhir.ch/ig/ch-term/ValueSet/edqm-administrationmethod | |
| 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-3 | error | Dosage | Patient instruction/free text dosage instruction, or timing and dose/rate has to be specified : patientInstruction.exists() or (timing.exists() and doseAndRate.exists()) | |
| ch-dosage-4 | error | Dosage | For split dosage timing event and dose/rate are required : sequence.exists() implies (timing.repeat.when.exists() and doseAndRate.dose.exists()) | |
| ch-emed-event-timing | warning | Dosage.timing.repeat.when | For the representation of the time of administration according to the 1-1-1-1 scheme, the values MORN-NOON-EVE-NIGHT are highly recommended. : $this='MORN' or $this='NOON' or $this='EVE' or $this='NIGHT' | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| tim-1 | error | Dosage.timing.repeat | if there's a duration, there needs to be duration units : duration.empty() or durationUnit.exists() | |
| tim-2 | error | Dosage.timing.repeat | if there's a period, there needs to be period units : period.empty() or periodUnit.exists() | |
| tim-4 | error | Dosage.timing.repeat | duration SHALL be a non-negative value : duration.exists() implies duration >= 0 | |
| tim-5 | error | Dosage.timing.repeat | period SHALL be a non-negative value : period.exists() implies period >= 0 | |
| tim-6 | error | Dosage.timing.repeat | If there's a periodMax, there must be a period : periodMax.empty() or period.exists() | |
| tim-7 | error | Dosage.timing.repeat | If there's a durationMax, there must be a duration : durationMax.empty() or duration.exists() | |
| tim-8 | error | Dosage.timing.repeat | If there's a countMax, there must be a count : countMax.empty() or count.exists() | |
| tim-9 | error | Dosage.timing.repeat | If there's an offset, there must be a when (and not C, CM, CD, CV) : offset.empty() or (when.exists() and ((when in ('C' | 'CM' | 'CD' | 'CV')).not())) | |
| tim-10 | error | Dosage.timing.repeat | If there's a timeOfDay, there cannot be a when, or vice versa : timeOfDay.empty() or when.empty() |
This structure is derived from CHEMEDDosage
Other representations of profile: CSV, Excel, Schematron