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
Official URL: http://hl7.org.nz/fhir/StructureDefinition/CcaDosage | Version: 0.1.0 | |||
Active as of 2024-03-03 | Realm: | Computable Name: CcaDosage |
CCA Regimen Dosage.
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 | How the medication is/was taken or should be taken | |
additionalInstruction | 0..0 | |||
patientInstruction | 0..0 | |||
timing | ||||
code | 0..1 | CodeableConcept | BID | TID | QID | AM | PM | QD | QOD | + Binding: Medication dose administration frequency (required) | |
site | 0..0 | |||
route | 0..1 | CodeableConcept | How drug should enter body Binding: Route (required) | |
method | 0..0 | |||
doseAndRate | ||||
type | 0..0 | |||
maxDosePerPeriod | 0..0 | |||
maxDosePerLifetime | 0..0 | |||
Documentation for this format |
Path | Conformance | ValueSet | URI |
Dosage.timing.code | required | DoseAdministrationFrequencyhttps://standards.digital.health.nz/fhir/ValueSet/sact-dose-administration-frequency from this IG | |
Dosage.route | required | Routehttps://standards.digital.health.nz/fhir/ValueSet/sact-route from this IG |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Dosage | 0..* | Dosage | How the medication is/was taken or should be taken | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
route | Σ | 0..1 | CodeableConcept | How drug should enter body Binding: Route (required) |
Documentation for this format |
Path | Conformance | ValueSet | URI |
Dosage.route | required | Routehttps://standards.digital.health.nz/fhir/ValueSet/sact-route from this IG |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Dosage | 0..* | Dosage | How the medication is/was taken or should be taken | |
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 |
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 | |
bounds[x] | Σ | 0..1 | Length/Range of lengths, or (Start and/or end) limits | |
boundsDuration | Duration | |||
boundsRange | Range | |||
boundsPeriod | Period | |||
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: Medication dose administration frequency (required) |
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 | |||
route | Σ | 0..1 | CodeableConcept | How drug should enter body Binding: Route (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 | |
dose[x] | Σ | 0..1 | Amount of medication per dose | |
doseRange | Range | |||
doseQuantity | Quantity(SimpleQuantity) | |||
rate[x] | Σ | 0..1 | Amount of medication per unit of time | |
rateRatio | Ratio | |||
rateRange | Range | |||
rateQuantity | Quantity(SimpleQuantity) | |||
maxDosePerAdministration | Σ | 0..1 | SimpleQuantity | Upper limit on medication per administration |
Documentation for this format |
Path | Conformance | ValueSet | URI |
Dosage.timing.repeat.durationUnit | required | UnitsOfTimehttp://hl7.org/fhir/ValueSet/units-of-time|4.0.1 from the FHIR Standard | |
Dosage.timing.repeat.periodUnit | required | UnitsOfTimehttp://hl7.org/fhir/ValueSet/units-of-time|4.0.1 from the FHIR Standard | |
Dosage.timing.repeat.dayOfWeek | required | DaysOfWeekhttp://hl7.org/fhir/ValueSet/days-of-week|4.0.1 from the FHIR Standard | |
Dosage.timing.repeat.when | required | EventTiminghttp://hl7.org/fhir/ValueSet/event-timing|4.0.1 from the FHIR Standard | |
Dosage.timing.code | required | DoseAdministrationFrequencyhttps://standards.digital.health.nz/fhir/ValueSet/sact-dose-administration-frequency from this IG | |
Dosage.asNeeded[x] | example | SNOMEDCTMedicationAsNeededReasonCodeshttp://hl7.org/fhir/ValueSet/medication-as-needed-reason from the FHIR Standard | |
Dosage.route | required | Routehttps://standards.digital.health.nz/fhir/ValueSet/sact-route from this IG |
This structure is derived from Dosage
Differential View
This structure is derived from Dosage
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Dosage | 0..* | Dosage | How the medication is/was taken or should be taken | |
additionalInstruction | 0..0 | |||
patientInstruction | 0..0 | |||
timing | ||||
code | 0..1 | CodeableConcept | BID | TID | QID | AM | PM | QD | QOD | + Binding: Medication dose administration frequency (required) | |
site | 0..0 | |||
route | 0..1 | CodeableConcept | How drug should enter body Binding: Route (required) | |
method | 0..0 | |||
doseAndRate | ||||
type | 0..0 | |||
maxDosePerPeriod | 0..0 | |||
maxDosePerLifetime | 0..0 | |||
Documentation for this format |
Path | Conformance | ValueSet | URI |
Dosage.timing.code | required | DoseAdministrationFrequencyhttps://standards.digital.health.nz/fhir/ValueSet/sact-dose-administration-frequency from this IG | |
Dosage.route | required | Routehttps://standards.digital.health.nz/fhir/ValueSet/sact-route from this IG |
Key Elements View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Dosage | 0..* | Dosage | How the medication is/was taken or should be taken | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
route | Σ | 0..1 | CodeableConcept | How drug should enter body Binding: Route (required) |
Documentation for this format |
Path | Conformance | ValueSet | URI |
Dosage.route | required | Routehttps://standards.digital.health.nz/fhir/ValueSet/sact-route from this IG |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Dosage | 0..* | Dosage | How the medication is/was taken or should be taken | |
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 |
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 | |
bounds[x] | Σ | 0..1 | Length/Range of lengths, or (Start and/or end) limits | |
boundsDuration | Duration | |||
boundsRange | Range | |||
boundsPeriod | Period | |||
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: Medication dose administration frequency (required) |
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 | |||
route | Σ | 0..1 | CodeableConcept | How drug should enter body Binding: Route (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 | |
dose[x] | Σ | 0..1 | Amount of medication per dose | |
doseRange | Range | |||
doseQuantity | Quantity(SimpleQuantity) | |||
rate[x] | Σ | 0..1 | Amount of medication per unit of time | |
rateRatio | Ratio | |||
rateRange | Range | |||
rateQuantity | Quantity(SimpleQuantity) | |||
maxDosePerAdministration | Σ | 0..1 | SimpleQuantity | Upper limit on medication per administration |
Documentation for this format |
Path | Conformance | ValueSet | URI |
Dosage.timing.repeat.durationUnit | required | UnitsOfTimehttp://hl7.org/fhir/ValueSet/units-of-time|4.0.1 from the FHIR Standard | |
Dosage.timing.repeat.periodUnit | required | UnitsOfTimehttp://hl7.org/fhir/ValueSet/units-of-time|4.0.1 from the FHIR Standard | |
Dosage.timing.repeat.dayOfWeek | required | DaysOfWeekhttp://hl7.org/fhir/ValueSet/days-of-week|4.0.1 from the FHIR Standard | |
Dosage.timing.repeat.when | required | EventTiminghttp://hl7.org/fhir/ValueSet/event-timing|4.0.1 from the FHIR Standard | |
Dosage.timing.code | required | DoseAdministrationFrequencyhttps://standards.digital.health.nz/fhir/ValueSet/sact-dose-administration-frequency from this IG | |
Dosage.asNeeded[x] | example | SNOMEDCTMedicationAsNeededReasonCodeshttp://hl7.org/fhir/ValueSet/medication-as-needed-reason from the FHIR Standard | |
Dosage.route | required | Routehttps://standards.digital.health.nz/fhir/ValueSet/sact-route from this IG |
This structure is derived from Dosage
Other representations of profile: CSV, Excel, Schematron