AU Base Implementation Guide
4.2.2-ci-build - CI Build
AU Base Implementation Guide
4.2.2-ci-build - CI Build
This page is part of the Australian Base IG (v4.2.1-preview: QA Preview) based on FHIR (HL7® FHIR® Standard) R4. The current version which supersedes this version is 4.1.0. 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.2.2-ci-build | |||
| Standards status: Trial-use | Maturity Level: 2 | Computable Name: AUBaseDosage | ||
Copyright/Legal: HL7 Australia© 2018+; Licensed Under Creative Commons No Rights Reserved. |
||||
This profile defines a dosage structure that localises core 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: Clinical Finding  (preferred) | |
| site |
0..1 | CodeableConcept | Body site to administer to Binding: Body Site (preferred) | |
| route |
0..1 | CodeableConcept | How drug should enter body Binding: Route of Administration (preferred) | |
 method |
0..1 | CodeableConcept | Technique for administering medication Binding: SNOMEDCTAdministrationMethodCodes (preferred) | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| Dosage.additionalInstruction | preferred | SNOMEDCTAdditionalDosageInstructionshttp://hl7.org/fhir/ValueSet/additional-instruction-codesfrom the FHIR Standard | |
| Dosage.asNeeded[x] | preferred | ClinicalFinding https://healthterminologies.gov.au/fhir/ValueSet/clinical-finding-1 | |
| Dosage.site | preferred | BodySite https://healthterminologies.gov.au/fhir/ValueSet/body-site-1 | |
| Dosage.route | preferred | RouteOfAdministration https://healthterminologies.gov.au/fhir/ValueSet/route-of-administration-1 | |
| Dosage.method | preferred | SNOMEDCTAdministrationMethodCodeshttp://hl7.org/fhir/ValueSet/administration-method-codesfrom the FHIR Standard |
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Dosage |
0..* | Dosage | Dosage information in an Australian healthcare context | |
 modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
 additionalInstruction |
Σ | 0..* | CodeableConcept | Supplemental instruction or warnings to the patient - e.g. "with meals", "may cause drowsiness" Binding: SNOMEDCTAdditionalDosageInstructions (preferred) |
  asNeeded[x] |
Σ | 0..1 | Take "as needed" (for x) Binding: Clinical Finding (preferred) | |
  asNeededBoolean |
boolean | |||
| asNeededCodeableConcept |
CodeableConcept | |||
| site |
Σ | 0..1 | CodeableConcept | Body site to administer to Binding: Body Site (preferred) |
| route |
Σ | 0..1 | CodeableConcept | How drug should enter body Binding: Route of Administration (preferred) |
| method |
Σ | 0..1 | CodeableConcept | Technique for administering medication Binding: SNOMEDCTAdministrationMethodCodes (preferred) |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| Dosage.additionalInstruction | preferred | SNOMEDCTAdditionalDosageInstructionshttp://hl7.org/fhir/ValueSet/additional-instruction-codesfrom the FHIR Standard | |
| Dosage.asNeeded[x] | preferred | ClinicalFinding https://healthterminologies.gov.au/fhir/ValueSet/clinical-finding-1 | |
| Dosage.site | preferred | BodySite https://healthterminologies.gov.au/fhir/ValueSet/body-site-1 | |
| Dosage.route | preferred | RouteOfAdministration https://healthterminologies.gov.au/fhir/ValueSet/route-of-administration-1 | |
| Dosage.method | preferred | SNOMEDCTAdministrationMethodCodeshttp://hl7.org/fhir/ValueSet/administration-method-codesfrom 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() |
| 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: Clinical Finding (preferred) | |
| asNeededBoolean |
boolean | |||
| asNeededCodeableConcept |
CodeableConcept | |||
| site |
Σ | 0..1 | CodeableConcept | Body site to administer to Binding: Body Site (preferred) |
| route |
Σ | 0..1 | CodeableConcept | How drug should enter body Binding: Route of Administration (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 | URI |
| Dosage.additionalInstruction | preferred | SNOMEDCTAdditionalDosageInstructionshttp://hl7.org/fhir/ValueSet/additional-instruction-codesfrom the FHIR Standard | |
| Dosage.asNeeded[x] | preferred | ClinicalFinding https://healthterminologies.gov.au/fhir/ValueSet/clinical-finding-1 | |
| Dosage.site | preferred | BodySite https://healthterminologies.gov.au/fhir/ValueSet/body-site-1 | |
| Dosage.route | preferred | RouteOfAdministration https://healthterminologies.gov.au/fhir/ValueSet/route-of-administration-1 | |
| Dosage.method | preferred | SNOMEDCTAdministrationMethodCodeshttp://hl7.org/fhir/ValueSet/administration-method-codesfrom the FHIR Standard | |
| Dosage.doseAndRate.type | example | DoseAndRateTypehttp://hl7.org/fhir/ValueSet/dose-rate-typefrom 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() |
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: Clinical Finding (preferred) | |
| site |
0..1 | CodeableConcept | Body site to administer to Binding: Body Site (preferred) | |
| route |
0..1 | CodeableConcept | How drug should enter body Binding: Route of Administration (preferred) | |
| method |
0..1 | CodeableConcept | Technique for administering medication Binding: SNOMEDCTAdministrationMethodCodes (preferred) | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| Dosage.additionalInstruction | preferred | SNOMEDCTAdditionalDosageInstructionshttp://hl7.org/fhir/ValueSet/additional-instruction-codesfrom the FHIR Standard | |
| Dosage.asNeeded[x] | preferred | ClinicalFinding https://healthterminologies.gov.au/fhir/ValueSet/clinical-finding-1 | |
| Dosage.site | preferred | BodySite https://healthterminologies.gov.au/fhir/ValueSet/body-site-1 | |
| Dosage.route | preferred | RouteOfAdministration https://healthterminologies.gov.au/fhir/ValueSet/route-of-administration-1 | |
| Dosage.method | preferred | SNOMEDCTAdministrationMethodCodeshttp://hl7.org/fhir/ValueSet/administration-method-codesfrom the FHIR Standard |
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Dosage |
0..* | Dosage | Dosage information in an Australian healthcare context | |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| additionalInstruction |
Σ | 0..* | CodeableConcept | Supplemental instruction or warnings to the patient - e.g. "with meals", "may cause drowsiness" Binding: SNOMEDCTAdditionalDosageInstructions (preferred) |
| asNeeded[x] |
Σ | 0..1 | Take "as needed" (for x) Binding: Clinical Finding (preferred) | |
| asNeededBoolean |
boolean | |||
| asNeededCodeableConcept |
CodeableConcept | |||
| site |
Σ | 0..1 | CodeableConcept | Body site to administer to Binding: Body Site (preferred) |
| route |
Σ | 0..1 | CodeableConcept | How drug should enter body Binding: Route of Administration (preferred) |
| method |
Σ | 0..1 | CodeableConcept | Technique for administering medication Binding: SNOMEDCTAdministrationMethodCodes (preferred) |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| Dosage.additionalInstruction | preferred | SNOMEDCTAdditionalDosageInstructionshttp://hl7.org/fhir/ValueSet/additional-instruction-codesfrom the FHIR Standard | |
| Dosage.asNeeded[x] | preferred | ClinicalFinding https://healthterminologies.gov.au/fhir/ValueSet/clinical-finding-1 | |
| Dosage.site | preferred | BodySite https://healthterminologies.gov.au/fhir/ValueSet/body-site-1 | |
| Dosage.route | preferred | RouteOfAdministration https://healthterminologies.gov.au/fhir/ValueSet/route-of-administration-1 | |
| Dosage.method | preferred | SNOMEDCTAdministrationMethodCodeshttp://hl7.org/fhir/ValueSet/administration-method-codesfrom 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() |
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: Clinical Finding (preferred) | |
| asNeededBoolean |
boolean | |||
| asNeededCodeableConcept |
CodeableConcept | |||
| site |
Σ | 0..1 | CodeableConcept | Body site to administer to Binding: Body Site (preferred) |
| route |
Σ | 0..1 | CodeableConcept | How drug should enter body Binding: Route of Administration (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 | URI |
| Dosage.additionalInstruction | preferred | SNOMEDCTAdditionalDosageInstructionshttp://hl7.org/fhir/ValueSet/additional-instruction-codesfrom the FHIR Standard | |
| Dosage.asNeeded[x] | preferred | ClinicalFinding https://healthterminologies.gov.au/fhir/ValueSet/clinical-finding-1 | |
| Dosage.site | preferred | BodySite https://healthterminologies.gov.au/fhir/ValueSet/body-site-1 | |
| Dosage.route | preferred | RouteOfAdministration https://healthterminologies.gov.au/fhir/ValueSet/route-of-administration-1 | |
| Dosage.method | preferred | SNOMEDCTAdministrationMethodCodeshttp://hl7.org/fhir/ValueSet/administration-method-codesfrom the FHIR Standard | |
| Dosage.doseAndRate.type | example | DoseAndRateTypehttp://hl7.org/fhir/ValueSet/dose-rate-typefrom 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() |
Other representations of profile: CSV, Excel, Schematron
IG © 2017+ HL7 Australia. Package hl7.fhir.au.base#4.2.2-ci-build based on FHIR 4.0.1. Generated 2024-08-02
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change