AU Base Implementation Guide
4.1.0-ballot - CI Build
AU
This page is part of AU Base v4.1.0 based on FHIR R4. For a full list of available versions, see the Directory of published versions
Official URL: http://hl7.org.au/fhir/StructureDefinition/au-dosage | Version: 4.1.0-ballot | |||
Draft as of 2022-11-10 | Maturity Level: 2 | Computable Name: AUBaseDosage | ||
Copyright/Legal: HL7 Australia© 2018+; Licensed Under Creative Commons No Rights Reserved. |
This profile defines a dosage structure including core localisation concepts for use in an Australian context.
The purpose of this profile is to provide national level agreement on core localised concepts.
This profile does not force conformance to core localised concepts. It enables implementers and modellers to make their own rules, i.e. profiling, about how to support these concepts for specific implementation needs.
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 | Dosage information in an Australian healthcare context | |
additionalInstruction | 0..* | CodeableConcept | Supplemental instruction or warnings to the patient - e.g. "with meals", "may cause drowsiness" Binding: SNOMEDCTAdditionalDosageInstructions (preferred) | |
asNeeded[x] | 0..1 | boolean, CodeableConcept | Take "as needed" (for x) Binding: https://healthterminologies.gov.au/fhir/ValueSet/clinical-finding-1 (preferred) | |
site | 0..1 | CodeableConcept | Body site to administer to Binding: https://healthterminologies.gov.au/fhir/ValueSet/body-site-1 (preferred) | |
route | 0..1 | CodeableConcept | How drug should enter body Binding: https://healthterminologies.gov.au/fhir/ValueSet/route-of-administration-1 (preferred) | |
method | 0..1 | CodeableConcept | Technique for administering medication Binding: SNOMEDCTAdministrationMethodCodes (preferred) | |
Documentation for this format |
Path | Conformance | ValueSet |
Dosage.additionalInstruction | preferred | SNOMEDCTAdditionalDosageInstructions |
Dosage.asNeeded[x] | preferred | https://healthterminologies.gov.au/fhir/ValueSet/clinical-finding-1 |
Dosage.site | preferred | https://healthterminologies.gov.au/fhir/ValueSet/body-site-1 |
Dosage.route | preferred | https://healthterminologies.gov.au/fhir/ValueSet/route-of-administration-1 |
Dosage.method | preferred | SNOMEDCTAdministrationMethodCodes |
Path | Conformance | ValueSet |
Dosage.additionalInstruction | preferred | SNOMEDCTAdditionalDosageInstructions |
Dosage.asNeeded[x] | preferred | https://healthterminologies.gov.au/fhir/ValueSet/clinical-finding-1 |
Dosage.site | preferred | https://healthterminologies.gov.au/fhir/ValueSet/body-site-1 |
Dosage.route | preferred | https://healthterminologies.gov.au/fhir/ValueSet/route-of-administration-1 |
Dosage.method | preferred | SNOMEDCTAdministrationMethodCodes |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Dosage | 0..* | Dosage | Dosage information in an Australian healthcare context | |
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 (preferred) |
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: https://healthterminologies.gov.au/fhir/ValueSet/clinical-finding-1 (preferred) | |
asNeededBoolean | boolean | |||
asNeededCodeableConcept | CodeableConcept | |||
site | Σ | 0..1 | CodeableConcept | Body site to administer to Binding: https://healthterminologies.gov.au/fhir/ValueSet/body-site-1 (preferred) |
route | Σ | 0..1 | CodeableConcept | How drug should enter body Binding: https://healthterminologies.gov.au/fhir/ValueSet/route-of-administration-1 (preferred) |
method | Σ | 0..1 | CodeableConcept | Technique for administering medication Binding: SNOMEDCTAdministrationMethodCodes (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 | |||
doseQuantity | Quantity(SimpleQuantity) | |||
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 |
Dosage.additionalInstruction | preferred | SNOMEDCTAdditionalDosageInstructions |
Dosage.asNeeded[x] | preferred | https://healthterminologies.gov.au/fhir/ValueSet/clinical-finding-1 |
Dosage.site | preferred | https://healthterminologies.gov.au/fhir/ValueSet/body-site-1 |
Dosage.route | preferred | https://healthterminologies.gov.au/fhir/ValueSet/route-of-administration-1 |
Dosage.method | preferred | SNOMEDCTAdministrationMethodCodes |
Dosage.doseAndRate.type | example | DoseAndRateType |
Differential View
This structure is derived from Dosage
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Dosage | 0..* | Dosage | Dosage information in an Australian healthcare context | |
additionalInstruction | 0..* | CodeableConcept | Supplemental instruction or warnings to the patient - e.g. "with meals", "may cause drowsiness" Binding: SNOMEDCTAdditionalDosageInstructions (preferred) | |
asNeeded[x] | 0..1 | boolean, CodeableConcept | Take "as needed" (for x) Binding: https://healthterminologies.gov.au/fhir/ValueSet/clinical-finding-1 (preferred) | |
site | 0..1 | CodeableConcept | Body site to administer to Binding: https://healthterminologies.gov.au/fhir/ValueSet/body-site-1 (preferred) | |
route | 0..1 | CodeableConcept | How drug should enter body Binding: https://healthterminologies.gov.au/fhir/ValueSet/route-of-administration-1 (preferred) | |
method | 0..1 | CodeableConcept | Technique for administering medication Binding: SNOMEDCTAdministrationMethodCodes (preferred) | |
Documentation for this format |
Path | Conformance | ValueSet |
Dosage.additionalInstruction | preferred | SNOMEDCTAdditionalDosageInstructions |
Dosage.asNeeded[x] | preferred | https://healthterminologies.gov.au/fhir/ValueSet/clinical-finding-1 |
Dosage.site | preferred | https://healthterminologies.gov.au/fhir/ValueSet/body-site-1 |
Dosage.route | preferred | https://healthterminologies.gov.au/fhir/ValueSet/route-of-administration-1 |
Dosage.method | preferred | SNOMEDCTAdministrationMethodCodes |
Key Elements View
Path | Conformance | ValueSet |
Dosage.additionalInstruction | preferred | SNOMEDCTAdditionalDosageInstructions |
Dosage.asNeeded[x] | preferred | https://healthterminologies.gov.au/fhir/ValueSet/clinical-finding-1 |
Dosage.site | preferred | https://healthterminologies.gov.au/fhir/ValueSet/body-site-1 |
Dosage.route | preferred | https://healthterminologies.gov.au/fhir/ValueSet/route-of-administration-1 |
Dosage.method | preferred | SNOMEDCTAdministrationMethodCodes |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Dosage | 0..* | Dosage | Dosage information in an Australian healthcare context | |
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 (preferred) |
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: https://healthterminologies.gov.au/fhir/ValueSet/clinical-finding-1 (preferred) | |
asNeededBoolean | boolean | |||
asNeededCodeableConcept | CodeableConcept | |||
site | Σ | 0..1 | CodeableConcept | Body site to administer to Binding: https://healthterminologies.gov.au/fhir/ValueSet/body-site-1 (preferred) |
route | Σ | 0..1 | CodeableConcept | How drug should enter body Binding: https://healthterminologies.gov.au/fhir/ValueSet/route-of-administration-1 (preferred) |
method | Σ | 0..1 | CodeableConcept | Technique for administering medication Binding: SNOMEDCTAdministrationMethodCodes (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 | |||
doseQuantity | Quantity(SimpleQuantity) | |||
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 |
Dosage.additionalInstruction | preferred | SNOMEDCTAdditionalDosageInstructions |
Dosage.asNeeded[x] | preferred | https://healthterminologies.gov.au/fhir/ValueSet/clinical-finding-1 |
Dosage.site | preferred | https://healthterminologies.gov.au/fhir/ValueSet/body-site-1 |
Dosage.route | preferred | https://healthterminologies.gov.au/fhir/ValueSet/route-of-administration-1 |
Dosage.method | preferred | SNOMEDCTAdministrationMethodCodes |
Dosage.doseAndRate.type | example | DoseAndRateType |
Other representations of profile: CSV, Excel, Schematron
none defined