CH Core (R4)
5.0.0-ballot - ballot
This page is part of the CH Core (R4) (v5.0.0-ballot: STU 5 Ballot 1) 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-core/StructureDefinition/ch-core-dosage | Version: 5.0.0-ballot | |||
Active as of 2024-05-16 | Computable Name: CHCoreDosage | |||
Copyright/Legal: CC0-1.0 |
Dosage for medication use cases
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from Dosage
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Dosage | 0..* | Dosage | CH Core Dosage | |
route | 0..1 | CodeableConcept | How drug should enter body Binding: EDQM - RouteOfAdministration (preferred) | |
method | 0..1 | CodeableConcept | Technique for administering medication Binding: EDQM - Administration Method (preferred) | |
doseAndRate | ||||
dose[x] | 0..1 | Amount of medication per dose | ||
doseRange | Range(CHCoreRangeWithEmedUnits) | |||
doseQuantity | Quantity(CHCoreQuantityWithEmedUnits) | |||
Documentation for this format |
Path | Conformance | ValueSet | URI |
Dosage.route | preferred | RouteOfAdministrationEDQMhttp://fhir.ch/ig/ch-term/ValueSet/edqm-routeofadministration | |
Dosage.method | preferred | AdministrationMethodEDQMhttp://fhir.ch/ig/ch-term/ValueSet/edqm-administrationmethod |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Dosage | 0..* | Dosage | CH Core Dosage | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
route | Σ | 0..1 | CodeableConcept | How drug should enter body Binding: EDQM - RouteOfAdministration (preferred) |
method | Σ | 0..1 | CodeableConcept | Technique for administering medication Binding: EDQM - Administration Method (preferred) |
Documentation for this format |
Path | Conformance | ValueSet | URI |
Dosage.route | preferred | RouteOfAdministrationEDQMhttp://fhir.ch/ig/ch-term/ValueSet/edqm-routeofadministration | |
Dosage.method | preferred | AdministrationMethodEDQMhttp://fhir.ch/ig/ch-term/ValueSet/edqm-administrationmethod |
Id | Grade | Path(s) | Details | Requirements |
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() |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Dosage | 0..* | Dosage | CH Core Dosage | |
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 | Σ | 0..1 | integer | The order of the dosage instructions |
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 | Σ | 0..1 | string | Patient or consumer oriented instructions |
timing | Σ | 0..1 | Timing | When medication should be administered |
asNeeded[x] | Σ | 0..1 | Take "as needed" (for x) 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 | |||
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 | How drug should enter body Binding: EDQM - RouteOfAdministration (preferred) |
method | Σ | 0..1 | CodeableConcept | Technique for administering medication Binding: EDQM - Administration Method (preferred) |
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. |
dose[x] | Σ | 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-codes from the FHIR Standard | |
Dosage.asNeeded[x] | example | SNOMEDCTMedicationAsNeededReasonCodeshttp://hl7.org/fhir/ValueSet/medication-as-needed-reason from the FHIR Standard | |
Dosage.site | example | SNOMEDCTAnatomicalStructureForAdministrationSiteCodeshttp://hl7.org/fhir/ValueSet/approach-site-codes from the FHIR Standard | |
Dosage.route | preferred | RouteOfAdministrationEDQMhttp://fhir.ch/ig/ch-term/ValueSet/edqm-routeofadministration | |
Dosage.method | preferred | AdministrationMethodEDQMhttp://fhir.ch/ig/ch-term/ValueSet/edqm-administrationmethod | |
Dosage.doseAndRate.type | example | DoseAndRateTypehttp://hl7.org/fhir/ValueSet/dose-rate-type from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
This structure is derived from Dosage
Differential View
This structure is derived from Dosage
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Dosage | 0..* | Dosage | CH Core Dosage | |
route | 0..1 | CodeableConcept | How drug should enter body Binding: EDQM - RouteOfAdministration (preferred) | |
method | 0..1 | CodeableConcept | Technique for administering medication Binding: EDQM - Administration Method (preferred) | |
doseAndRate | ||||
dose[x] | 0..1 | Amount of medication per dose | ||
doseRange | Range(CHCoreRangeWithEmedUnits) | |||
doseQuantity | Quantity(CHCoreQuantityWithEmedUnits) | |||
Documentation for this format |
Path | Conformance | ValueSet | URI |
Dosage.route | preferred | RouteOfAdministrationEDQMhttp://fhir.ch/ig/ch-term/ValueSet/edqm-routeofadministration | |
Dosage.method | preferred | AdministrationMethodEDQMhttp://fhir.ch/ig/ch-term/ValueSet/edqm-administrationmethod |
Key Elements View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Dosage | 0..* | Dosage | CH Core Dosage | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
route | Σ | 0..1 | CodeableConcept | How drug should enter body Binding: EDQM - RouteOfAdministration (preferred) |
method | Σ | 0..1 | CodeableConcept | Technique for administering medication Binding: EDQM - Administration Method (preferred) |
Documentation for this format |
Path | Conformance | ValueSet | URI |
Dosage.route | preferred | RouteOfAdministrationEDQMhttp://fhir.ch/ig/ch-term/ValueSet/edqm-routeofadministration | |
Dosage.method | preferred | AdministrationMethodEDQMhttp://fhir.ch/ig/ch-term/ValueSet/edqm-administrationmethod |
Id | Grade | Path(s) | Details | Requirements |
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() |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Dosage | 0..* | Dosage | CH Core Dosage | |
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 | Σ | 0..1 | integer | The order of the dosage instructions |
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 | Σ | 0..1 | string | Patient or consumer oriented instructions |
timing | Σ | 0..1 | Timing | When medication should be administered |
asNeeded[x] | Σ | 0..1 | Take "as needed" (for x) 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 | |||
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 | How drug should enter body Binding: EDQM - RouteOfAdministration (preferred) |
method | Σ | 0..1 | CodeableConcept | Technique for administering medication Binding: EDQM - Administration Method (preferred) |
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. |
dose[x] | Σ | 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-codes from the FHIR Standard | |
Dosage.asNeeded[x] | example | SNOMEDCTMedicationAsNeededReasonCodeshttp://hl7.org/fhir/ValueSet/medication-as-needed-reason from the FHIR Standard | |
Dosage.site | example | SNOMEDCTAnatomicalStructureForAdministrationSiteCodeshttp://hl7.org/fhir/ValueSet/approach-site-codes from the FHIR Standard | |
Dosage.route | preferred | RouteOfAdministrationEDQMhttp://fhir.ch/ig/ch-term/ValueSet/edqm-routeofadministration | |
Dosage.method | preferred | AdministrationMethodEDQMhttp://fhir.ch/ig/ch-term/ValueSet/edqm-administrationmethod | |
Dosage.doseAndRate.type | example | DoseAndRateTypehttp://hl7.org/fhir/ValueSet/dose-rate-type from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
This structure is derived from Dosage
Other representations of profile: CSV, Excel, Schematron