CH Core (R4)
5.0.0-ci-build - ci-build Switzerland flag

CH Core (R4), published by HL7 Switzerland. This guide is not an authorized publication; it is the continuous build for version 5.0.0-ci-build built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/hl7ch/ch-core/ and changes regularly. See the Directory of published versions

Data Type Profile: CH Core Dosage

Official URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-core-dosage Version: 5.0.0-ci-build
Active as of 2024-04-16 Computable Name: CHCoreDosage

Copyright/Legal: CC0-1.0

Dosage for medication use cases

Usage:

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

This structure is derived from Dosage

NameFlagsCard.TypeDescription & Constraintsdoco
.. 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)

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
Dosage.routepreferredRouteOfAdministrationEDQM
http://fhir.ch/ig/ch-term/ValueSet/edqm-routeofadministration
Dosage.methodpreferredAdministrationMethodEDQM
http://fhir.ch/ig/ch-term/ValueSet/edqm-administrationmethod
NameFlagsCard.TypeDescription & Constraintsdoco
.. 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)

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Dosage.routepreferredRouteOfAdministrationEDQM
http://fhir.ch/ig/ch-term/ValueSet/edqm-routeofadministration
Dosage.methodpreferredAdministrationMethodEDQM
http://fhir.ch/ig/ch-term/ValueSet/edqm-administrationmethod

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
NameFlagsCard.TypeDescription & Constraintsdoco
.. 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
... 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

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Dosage.additionalInstructionexampleSNOMEDCTAdditionalDosageInstructions
http://hl7.org/fhir/ValueSet/additional-instruction-codes
from the FHIR Standard
Dosage.asNeeded[x]exampleSNOMEDCTMedicationAsNeededReasonCodes
http://hl7.org/fhir/ValueSet/medication-as-needed-reason
from the FHIR Standard
Dosage.siteexampleSNOMEDCTAnatomicalStructureForAdministrationSiteCodes
http://hl7.org/fhir/ValueSet/approach-site-codes
from the FHIR Standard
Dosage.routepreferredRouteOfAdministrationEDQM
http://fhir.ch/ig/ch-term/ValueSet/edqm-routeofadministration
Dosage.methodpreferredAdministrationMethodEDQM
http://fhir.ch/ig/ch-term/ValueSet/edqm-administrationmethod
Dosage.doseAndRate.typeexampleDoseAndRateType
http://hl7.org/fhir/ValueSet/dose-rate-type
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

Differential View

This structure is derived from Dosage

NameFlagsCard.TypeDescription & Constraintsdoco
.. 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)

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
Dosage.routepreferredRouteOfAdministrationEDQM
http://fhir.ch/ig/ch-term/ValueSet/edqm-routeofadministration
Dosage.methodpreferredAdministrationMethodEDQM
http://fhir.ch/ig/ch-term/ValueSet/edqm-administrationmethod

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. 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)

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Dosage.routepreferredRouteOfAdministrationEDQM
http://fhir.ch/ig/ch-term/ValueSet/edqm-routeofadministration
Dosage.methodpreferredAdministrationMethodEDQM
http://fhir.ch/ig/ch-term/ValueSet/edqm-administrationmethod

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. 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
... 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

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Dosage.additionalInstructionexampleSNOMEDCTAdditionalDosageInstructions
http://hl7.org/fhir/ValueSet/additional-instruction-codes
from the FHIR Standard
Dosage.asNeeded[x]exampleSNOMEDCTMedicationAsNeededReasonCodes
http://hl7.org/fhir/ValueSet/medication-as-needed-reason
from the FHIR Standard
Dosage.siteexampleSNOMEDCTAnatomicalStructureForAdministrationSiteCodes
http://hl7.org/fhir/ValueSet/approach-site-codes
from the FHIR Standard
Dosage.routepreferredRouteOfAdministrationEDQM
http://fhir.ch/ig/ch-term/ValueSet/edqm-routeofadministration
Dosage.methodpreferredAdministrationMethodEDQM
http://fhir.ch/ig/ch-term/ValueSet/edqm-administrationmethod
Dosage.doseAndRate.typeexampleDoseAndRateType
http://hl7.org/fhir/ValueSet/dose-rate-type
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

 

Other representations of profile: CSV, Excel, Schematron