HL7® FHIR® Te Aho o Te Kahu, Cancer Control Agency Implementation Guide
0.1.0 - CI Build

HL7® FHIR® Te Aho o Te Kahu, Cancer Control Agency Implementation Guide, published by Te Aho o Te Kahu, Cancer Control Agency. This guide is not an authorized publication; it is the continuous build for version 0.1.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7NZ/cca/ and changes regularly. See the Directory of published versions

Data Type Profile: Dosage

Official URL: http://hl7.org.nz/fhir/StructureDefinition/CcaDosage Version: 0.1.0
Active as of 2024-03-03 Realm: New Zealand flag Computable Name: CcaDosage

CCA Regimen Dosage.

Usage:

  • This DataType Constraint is not used by any profiles in this Implementation Guide

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..*DosageHow the medication is/was taken or should be taken
... additionalInstruction 0..0
... patientInstruction 0..0
... timing
.... code 0..1CodeableConceptBID | TID | QID | AM | PM | QD | QOD | +
Binding: Medication dose administration frequency (required)
... route 0..1CodeableConceptHow drug should enter body
Binding: Route (required)
... method 0..0
... doseAndRate
.... type 0..0
... maxDosePerPeriod 0..0
... maxDosePerLifetime 0..0

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
Dosage.timing.coderequiredDoseAdministrationFrequency
https://standards.digital.health.nz/fhir/ValueSet/sact-dose-administration-frequency
from this IG
Dosage.routerequiredRoute
https://standards.digital.health.nz/fhir/ValueSet/sact-route
from this IG
NameFlagsCard.TypeDescription & Constraintsdoco
.. Dosage 0..*DosageHow the medication is/was taken or should be taken
... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
... route Σ0..1CodeableConceptHow drug should enter body
Binding: Route (required)

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Dosage.routerequiredRoute
https://standards.digital.health.nz/fhir/ValueSet/sact-route
from this IG
NameFlagsCard.TypeDescription & Constraintsdoco
.. Dosage 0..*DosageHow the medication is/was taken or should be taken
... id 0..1stringUnique id for inter-element referencing
... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
... text Σ0..1stringFree text dosage instructions e.g. SIG
... timing Σ0..1TimingWhen medication should be administered
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... event Σ0..*dateTimeWhen the event occurs
.... repeat ΣC0..1ElementWhen 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..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... bounds[x] Σ0..1Length/Range of lengths, or (Start and/or end) limits
...... boundsDurationDuration
...... boundsRangeRange
...... boundsPeriodPeriod
..... count Σ0..1positiveIntNumber of times to repeat
..... countMax Σ0..1positiveIntMaximum number of times to repeat
..... duration Σ0..1decimalHow long when it happens
..... durationMax Σ0..1decimalHow long when it happens (Max)
..... durationUnit Σ0..1codes | min | h | d | wk | mo | a - unit of time (UCUM)
Binding: UnitsOfTime (required): A unit of time (units from UCUM).

..... frequency Σ0..1positiveIntEvent occurs frequency times per period
..... frequencyMax Σ0..1positiveIntEvent occurs up to frequencyMax times per period
..... period Σ0..1decimalEvent occurs frequency times per period
..... periodMax Σ0..1decimalUpper limit of period (3-4 hours)
..... periodUnit Σ0..1codes | min | h | d | wk | mo | a - unit of time (UCUM)
Binding: UnitsOfTime (required): A unit of time (units from UCUM).

..... dayOfWeek Σ0..*codemon | tue | wed | thu | fri | sat | sun
Binding: DaysOfWeek (required)
..... timeOfDay Σ0..*timeTime of day for action
..... when Σ0..*codeCode for time period of occurrence
Binding: EventTiming (required): Real world event relating to the schedule.


..... offset Σ0..1unsignedIntMinutes from event (before or after)
.... code Σ0..1CodeableConceptBID | TID | QID | AM | PM | QD | QOD | +
Binding: Medication dose administration frequency (required)
... asNeeded[x] Σ0..1Take "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.

.... asNeededBooleanboolean
.... asNeededCodeableConceptCodeableConcept
... route Σ0..1CodeableConceptHow drug should enter body
Binding: Route (required)
... doseAndRate Σ0..*ElementAmount of medication administered
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... dose[x] Σ0..1Amount of medication per dose
..... doseRangeRange
..... doseQuantityQuantity(SimpleQuantity)
.... rate[x] Σ0..1Amount of medication per unit of time
..... rateRatioRatio
..... rateRangeRange
..... rateQuantityQuantity(SimpleQuantity)
... maxDosePerAdministration Σ0..1SimpleQuantityUpper limit on medication per administration

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Dosage.timing.repeat.durationUnitrequiredUnitsOfTime
http://hl7.org/fhir/ValueSet/units-of-time|4.0.1
from the FHIR Standard
Dosage.timing.repeat.periodUnitrequiredUnitsOfTime
http://hl7.org/fhir/ValueSet/units-of-time|4.0.1
from the FHIR Standard
Dosage.timing.repeat.dayOfWeekrequiredDaysOfWeek
http://hl7.org/fhir/ValueSet/days-of-week|4.0.1
from the FHIR Standard
Dosage.timing.repeat.whenrequiredEventTiming
http://hl7.org/fhir/ValueSet/event-timing|4.0.1
from the FHIR Standard
Dosage.timing.coderequiredDoseAdministrationFrequency
https://standards.digital.health.nz/fhir/ValueSet/sact-dose-administration-frequency
from this IG
Dosage.asNeeded[x]exampleSNOMEDCTMedicationAsNeededReasonCodes
http://hl7.org/fhir/ValueSet/medication-as-needed-reason
from the FHIR Standard
Dosage.routerequiredRoute
https://standards.digital.health.nz/fhir/ValueSet/sact-route
from this IG

This structure is derived from Dosage

Summary

Prohibited: 7 elements

Differential View

This structure is derived from Dosage

NameFlagsCard.TypeDescription & Constraintsdoco
.. Dosage 0..*DosageHow the medication is/was taken or should be taken
... additionalInstruction 0..0
... patientInstruction 0..0
... timing
.... code 0..1CodeableConceptBID | TID | QID | AM | PM | QD | QOD | +
Binding: Medication dose administration frequency (required)
... route 0..1CodeableConceptHow drug should enter body
Binding: Route (required)
... method 0..0
... doseAndRate
.... type 0..0
... maxDosePerPeriod 0..0
... maxDosePerLifetime 0..0

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
Dosage.timing.coderequiredDoseAdministrationFrequency
https://standards.digital.health.nz/fhir/ValueSet/sact-dose-administration-frequency
from this IG
Dosage.routerequiredRoute
https://standards.digital.health.nz/fhir/ValueSet/sact-route
from this IG

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Dosage 0..*DosageHow the medication is/was taken or should be taken
... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
... route Σ0..1CodeableConceptHow drug should enter body
Binding: Route (required)

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Dosage.routerequiredRoute
https://standards.digital.health.nz/fhir/ValueSet/sact-route
from this IG

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Dosage 0..*DosageHow the medication is/was taken or should be taken
... id 0..1stringUnique id for inter-element referencing
... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
... text Σ0..1stringFree text dosage instructions e.g. SIG
... timing Σ0..1TimingWhen medication should be administered
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... event Σ0..*dateTimeWhen the event occurs
.... repeat ΣC0..1ElementWhen 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..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... bounds[x] Σ0..1Length/Range of lengths, or (Start and/or end) limits
...... boundsDurationDuration
...... boundsRangeRange
...... boundsPeriodPeriod
..... count Σ0..1positiveIntNumber of times to repeat
..... countMax Σ0..1positiveIntMaximum number of times to repeat
..... duration Σ0..1decimalHow long when it happens
..... durationMax Σ0..1decimalHow long when it happens (Max)
..... durationUnit Σ0..1codes | min | h | d | wk | mo | a - unit of time (UCUM)
Binding: UnitsOfTime (required): A unit of time (units from UCUM).

..... frequency Σ0..1positiveIntEvent occurs frequency times per period
..... frequencyMax Σ0..1positiveIntEvent occurs up to frequencyMax times per period
..... period Σ0..1decimalEvent occurs frequency times per period
..... periodMax Σ0..1decimalUpper limit of period (3-4 hours)
..... periodUnit Σ0..1codes | min | h | d | wk | mo | a - unit of time (UCUM)
Binding: UnitsOfTime (required): A unit of time (units from UCUM).

..... dayOfWeek Σ0..*codemon | tue | wed | thu | fri | sat | sun
Binding: DaysOfWeek (required)
..... timeOfDay Σ0..*timeTime of day for action
..... when Σ0..*codeCode for time period of occurrence
Binding: EventTiming (required): Real world event relating to the schedule.


..... offset Σ0..1unsignedIntMinutes from event (before or after)
.... code Σ0..1CodeableConceptBID | TID | QID | AM | PM | QD | QOD | +
Binding: Medication dose administration frequency (required)
... asNeeded[x] Σ0..1Take "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.

.... asNeededBooleanboolean
.... asNeededCodeableConceptCodeableConcept
... route Σ0..1CodeableConceptHow drug should enter body
Binding: Route (required)
... doseAndRate Σ0..*ElementAmount of medication administered
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... dose[x] Σ0..1Amount of medication per dose
..... doseRangeRange
..... doseQuantityQuantity(SimpleQuantity)
.... rate[x] Σ0..1Amount of medication per unit of time
..... rateRatioRatio
..... rateRangeRange
..... rateQuantityQuantity(SimpleQuantity)
... maxDosePerAdministration Σ0..1SimpleQuantityUpper limit on medication per administration

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Dosage.timing.repeat.durationUnitrequiredUnitsOfTime
http://hl7.org/fhir/ValueSet/units-of-time|4.0.1
from the FHIR Standard
Dosage.timing.repeat.periodUnitrequiredUnitsOfTime
http://hl7.org/fhir/ValueSet/units-of-time|4.0.1
from the FHIR Standard
Dosage.timing.repeat.dayOfWeekrequiredDaysOfWeek
http://hl7.org/fhir/ValueSet/days-of-week|4.0.1
from the FHIR Standard
Dosage.timing.repeat.whenrequiredEventTiming
http://hl7.org/fhir/ValueSet/event-timing|4.0.1
from the FHIR Standard
Dosage.timing.coderequiredDoseAdministrationFrequency
https://standards.digital.health.nz/fhir/ValueSet/sact-dose-administration-frequency
from this IG
Dosage.asNeeded[x]exampleSNOMEDCTMedicationAsNeededReasonCodes
http://hl7.org/fhir/ValueSet/medication-as-needed-reason
from the FHIR Standard
Dosage.routerequiredRoute
https://standards.digital.health.nz/fhir/ValueSet/sact-route
from this IG

This structure is derived from Dosage

Summary

Prohibited: 7 elements

 

Other representations of profile: CSV, Excel, Schematron