AU Base Implementation Guide
7.0.0-ci-build - CI Build Australia flag

AU Base Implementation Guide, published by HL7 Australia. This guide is not an authorized publication; it is the continuous build for version 7.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/hl7au/au-fhir-base/ and changes regularly. See the Directory of published versions

Data Type Profile: AU Base Dosage

Official URL: http://hl7.org.au/fhir/StructureDefinition/au-dosage Version: 7.0.0-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 Notes

Usages:

You can also check for usages in the FHIR IG Statistics

Changes since version 6.0.0:

  • No changes

    • Formal Views of Profile Content

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

    NameFlagsCard.TypeDescription & Constraints    Filter: doco
    Dosage 0..* Dosage Dosage information in an Australian healthcare context
    Dosage.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
    Dosage.additionalInstruction This element is included in summaries. 0..* CodeableConcept Supplemental instruction or warnings to the patient - e.g. "with meals", "may cause drowsiness"
    Binding: SNOMEDCTAdditionalDosageInstructions (preferred)
    Dosage.asNeeded[x] This element is included in summaries. 0..1 Take "as needed" (for x)
    Binding: Clinical Finding (preferred)
    Dosage.asNeeded[x].asNeededBoolean boolean
    Dosage.asNeeded[x].asNeededCodeableConcept CodeableConcept
    Dosage.site This element is included in summaries. 0..1 CodeableConcept Body site to administer to
    Binding: Body Site (preferred)
    Dosage.route This element is included in summaries. 0..1 CodeableConcept How drug should enter body
    Binding: Route of Administration (preferred)
    Dosage.method This element is included in summaries. 0..1 CodeableConcept Technique for administering medication
    Binding: SNOMEDCTAdministrationMethodCodes (preferred)

    doco Documentation for this format

    Terminology Bindings

    Path Status Usage ValueSet Version Source
    Dosage.additionalInstruction Base preferred SNOMED CT Additional Dosage Instructions 📦4.0.1 FHIR Std.
    Dosage.asNeeded[x] Base preferred Clinical Finding ⏿1.0.2 tx.hl7.org.au
    Dosage.site Base preferred Body Site ⏿1.0.2 tx.hl7.org.au
    Dosage.route Base preferred Route of Administration ⏿1.0.2 tx.hl7.org.au
    Dosage.method Base preferred SNOMED CT Administration Method Codes 📦4.0.1 FHIR Std.

    Constraints

    Id Grade Path(s) Description Expression
    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()

    This structure is derived from Dosage

    NameFlagsCard.TypeDescription & Constraints    Filter: doco
    Dosage 0..* Dosage Dosage information in an Australian healthcare context
    Dosage.additionalInstruction 0..* CodeableConcept Supplemental instruction or warnings to the patient - e.g. "with meals", "may cause drowsiness"
    Binding: SNOMEDCTAdditionalDosageInstructions (preferred)
    Dosage.asNeeded[x] 0..1 boolean, CodeableConcept Take "as needed" (for x)
    Binding: Clinical Finding (preferred)
    Dosage.site 0..1 CodeableConcept Body site to administer to
    Binding: Body Site (preferred)
    Dosage.method 0..1 CodeableConcept Technique for administering medication
    Binding: SNOMEDCTAdministrationMethodCodes (preferred)

    doco Documentation for this format

    Terminology Bindings (Differential)

    Path Status Usage ValueSet Version Source
    Dosage.additionalInstruction Base preferred SNOMED CT Additional Dosage Instructions 📦4.0.1 FHIR Std.
    Dosage.asNeeded[x] Base preferred Clinical Finding ⏿1.0.2 tx.hl7.org.au
    Dosage.site Base preferred Body Site ⏿1.0.2 tx.hl7.org.au
    Dosage.route Base preferred Route of Administration ⏿1.0.2 tx.hl7.org.au
    Dosage.method Base preferred SNOMED CT Administration Method Codes 📦4.0.1 FHIR Std.
    NameFlagsCard.TypeDescription & Constraints    Filter: doco
    Dosage 0..* Dosage Dosage information in an Australian healthcare context
    Dosage.id 0..1 string Unique id for inter-element referencing
    Dosage.extension 0..* Extension Additional content defined by implementations
    Slice: Unordered, Open by value:url
    Dosage.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
    Dosage.sequence This element is included in summaries. 0..1 integer The order of the dosage instructions
    Dosage.text This element is included in summaries. 0..1 string Free text dosage instructions e.g. SIG
    Dosage.additionalInstruction This element is included in summaries. 0..* CodeableConcept Supplemental instruction or warnings to the patient - e.g. "with meals", "may cause drowsiness"
    Binding: SNOMEDCTAdditionalDosageInstructions (preferred)
    Dosage.patientInstruction This element is included in summaries. 0..1 string Patient or consumer oriented instructions
    Dosage.timing This element is included in summaries. 0..1 Timing When medication should be administered
    Dosage.asNeeded[x] This element is included in summaries. 0..1 Take "as needed" (for x)
    Binding: Clinical Finding (preferred)
    Dosage.asNeeded[x].asNeededBoolean boolean
    Dosage.asNeeded[x].asNeededCodeableConcept CodeableConcept
    Dosage.site This element is included in summaries. 0..1 CodeableConcept Body site to administer to
    Binding: Body Site (preferred)
    Dosage.route This element is included in summaries. 0..1 CodeableConcept How drug should enter body
    Binding: Route of Administration (preferred)
    Dosage.method This element is included in summaries. 0..1 CodeableConcept Technique for administering medication
    Binding: SNOMEDCTAdministrationMethodCodes (preferred)
    Dosage.doseAndRate This element is included in summaries. 0..* Element Amount of medication administered
    Dosage.doseAndRate.id 0..1 string Unique id for inter-element referencing
    Dosage.doseAndRate.extension 0..* Extension Additional content defined by implementations
    Slice: Unordered, Open by value:url
    Dosage.doseAndRate.type This element is included in summaries. 0..1 CodeableConcept The kind of dose or rate specified
    Binding: DoseAndRateType (example): The kind of dose or rate specified.
    Dosage.doseAndRate.dose[x] This element is included in summaries. 0..1 Amount of medication per dose
    Dosage.doseAndRate.dose[x].doseRange Range
    Dosage.doseAndRate.dose[x].doseQuantity Quantity(SimpleQuantity)
    Dosage.doseAndRate.rate[x] This element is included in summaries. 0..1 Amount of medication per unit of time
    Dosage.doseAndRate.rate[x].rateRatio Ratio
    Dosage.doseAndRate.rate[x].rateRange Range
    Dosage.doseAndRate.rate[x].rateQuantity Quantity(SimpleQuantity)
    Dosage.maxDosePerPeriod This element is included in summaries. 0..1 Ratio Upper limit on medication per unit of time
    Dosage.maxDosePerAdministration This element is included in summaries. C 0..1 SimpleQuantity(4.0.1) Upper limit on medication per administration
    Constraints: sqty-1
    Dosage.maxDosePerLifetime This element is included in summaries. C 0..1 SimpleQuantity(4.0.1) Upper limit on medication per lifetime of the patient
    Constraints: sqty-1

    doco Documentation for this format

    Terminology Bindings

    Path Status Usage ValueSet Version Source
    Dosage.additionalInstruction Base preferred SNOMED CT Additional Dosage Instructions 📦4.0.1 FHIR Std.
    Dosage.asNeeded[x] Base preferred Clinical Finding ⏿1.0.2 tx.hl7.org.au
    Dosage.site Base preferred Body Site ⏿1.0.2 tx.hl7.org.au
    Dosage.route Base preferred Route of Administration ⏿1.0.2 tx.hl7.org.au
    Dosage.method Base preferred SNOMED CT Administration Method Codes 📦4.0.1 FHIR Std.
    Dosage.doseAndRate.type Base example DoseAndRateType 📍4.0.1 FHIR Std.

    Constraints

    Id Grade Path(s) Description Expression
    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()
    sqty-1 error Dosage.maxDosePerAdministration, Dosage.maxDosePerLifetime The comparator is not used on a SimpleQuantity comparator.empty()

    This structure is derived from Dosage

    Summary

    Maturity: 2

    Key Elements View

    NameFlagsCard.TypeDescription & Constraints    Filter: doco
    Dosage 0..* Dosage Dosage information in an Australian healthcare context
    Dosage.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
    Dosage.additionalInstruction This element is included in summaries. 0..* CodeableConcept Supplemental instruction or warnings to the patient - e.g. "with meals", "may cause drowsiness"
    Binding: SNOMEDCTAdditionalDosageInstructions (preferred)
    Dosage.asNeeded[x] This element is included in summaries. 0..1 Take "as needed" (for x)
    Binding: Clinical Finding (preferred)
    Dosage.asNeeded[x].asNeededBoolean boolean
    Dosage.asNeeded[x].asNeededCodeableConcept CodeableConcept
    Dosage.site This element is included in summaries. 0..1 CodeableConcept Body site to administer to
    Binding: Body Site (preferred)
    Dosage.route This element is included in summaries. 0..1 CodeableConcept How drug should enter body
    Binding: Route of Administration (preferred)
    Dosage.method This element is included in summaries. 0..1 CodeableConcept Technique for administering medication
    Binding: SNOMEDCTAdministrationMethodCodes (preferred)

    doco Documentation for this format

    Terminology Bindings

    Path Status Usage ValueSet Version Source
    Dosage.additionalInstruction Base preferred SNOMED CT Additional Dosage Instructions 📦4.0.1 FHIR Std.
    Dosage.asNeeded[x] Base preferred Clinical Finding ⏿1.0.2 tx.hl7.org.au
    Dosage.site Base preferred Body Site ⏿1.0.2 tx.hl7.org.au
    Dosage.route Base preferred Route of Administration ⏿1.0.2 tx.hl7.org.au
    Dosage.method Base preferred SNOMED CT Administration Method Codes 📦4.0.1 FHIR Std.

    Constraints

    Id Grade Path(s) Description Expression
    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

    NameFlagsCard.TypeDescription & Constraints    Filter: doco
    Dosage 0..* Dosage Dosage information in an Australian healthcare context
    Dosage.additionalInstruction 0..* CodeableConcept Supplemental instruction or warnings to the patient - e.g. "with meals", "may cause drowsiness"
    Binding: SNOMEDCTAdditionalDosageInstructions (preferred)
    Dosage.asNeeded[x] 0..1 boolean, CodeableConcept Take "as needed" (for x)
    Binding: Clinical Finding (preferred)
    Dosage.site 0..1 CodeableConcept Body site to administer to
    Binding: Body Site (preferred)
    Dosage.route 0..1 CodeableConcept How drug should enter body
    Binding: Route of Administration (preferred)
    Dosage.method 0..1 CodeableConcept Technique for administering medication
    Binding: SNOMEDCTAdministrationMethodCodes (preferred)

    doco Documentation for this format

    Terminology Bindings (Differential)

    Path Status Usage ValueSet Version Source
    Dosage.additionalInstruction Base preferred SNOMED CT Additional Dosage Instructions 📦4.0.1 FHIR Std.
    Dosage.asNeeded[x] Base preferred Clinical Finding ⏿1.0.2 tx.hl7.org.au
    Dosage.site Base preferred Body Site ⏿1.0.2 tx.hl7.org.au
    Dosage.route Base preferred Route of Administration ⏿1.0.2 tx.hl7.org.au
    Dosage.method Base preferred SNOMED CT Administration Method Codes 📦4.0.1 FHIR Std.

    Snapshot View

    NameFlagsCard.TypeDescription & Constraints    Filter: doco
    Dosage 0..* Dosage Dosage information in an Australian healthcare context
    Dosage.id 0..1 string Unique id for inter-element referencing
    Dosage.extension 0..* Extension Additional content defined by implementations
    Slice: Unordered, Open by value:url
    Dosage.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
    Dosage.sequence This element is included in summaries. 0..1 integer The order of the dosage instructions
    Dosage.text This element is included in summaries. 0..1 string Free text dosage instructions e.g. SIG
    Dosage.additionalInstruction This element is included in summaries. 0..* CodeableConcept Supplemental instruction or warnings to the patient - e.g. "with meals", "may cause drowsiness"
    Binding: SNOMEDCTAdditionalDosageInstructions (preferred)
    Dosage.patientInstruction This element is included in summaries. 0..1 string Patient or consumer oriented instructions
    Dosage.timing This element is included in summaries. 0..1 Timing When medication should be administered
    Dosage.asNeeded[x] This element is included in summaries. 0..1 Take "as needed" (for x)
    Binding: Clinical Finding (preferred)
    Dosage.asNeeded[x].asNeededBoolean boolean
    Dosage.asNeeded[x].asNeededCodeableConcept CodeableConcept
    Dosage.site This element is included in summaries. 0..1 CodeableConcept Body site to administer to
    Binding: Body Site (preferred)
    Dosage.route This element is included in summaries. 0..1 CodeableConcept How drug should enter body
    Binding: Route of Administration (preferred)
    Dosage.method This element is included in summaries. 0..1 CodeableConcept Technique for administering medication
    Binding: SNOMEDCTAdministrationMethodCodes (preferred)
    Dosage.doseAndRate This element is included in summaries. 0..* Element Amount of medication administered
    Dosage.doseAndRate.id 0..1 string Unique id for inter-element referencing
    Dosage.doseAndRate.extension 0..* Extension Additional content defined by implementations
    Slice: Unordered, Open by value:url
    Dosage.doseAndRate.type This element is included in summaries. 0..1 CodeableConcept The kind of dose or rate specified
    Binding: DoseAndRateType (example): The kind of dose or rate specified.
    Dosage.doseAndRate.dose[x] This element is included in summaries. 0..1 Amount of medication per dose
    Dosage.doseAndRate.dose[x].doseRange Range
    Dosage.doseAndRate.dose[x].doseQuantity Quantity(SimpleQuantity)
    Dosage.doseAndRate.rate[x] This element is included in summaries. 0..1 Amount of medication per unit of time
    Dosage.doseAndRate.rate[x].rateRatio Ratio
    Dosage.doseAndRate.rate[x].rateRange Range
    Dosage.doseAndRate.rate[x].rateQuantity Quantity(SimpleQuantity)
    Dosage.maxDosePerPeriod This element is included in summaries. 0..1 Ratio Upper limit on medication per unit of time
    Dosage.maxDosePerAdministration This element is included in summaries. C 0..1 SimpleQuantity(4.0.1) Upper limit on medication per administration
    Constraints: sqty-1
    Dosage.maxDosePerLifetime This element is included in summaries. C 0..1 SimpleQuantity(4.0.1) Upper limit on medication per lifetime of the patient
    Constraints: sqty-1

    doco Documentation for this format

    Terminology Bindings

    Path Status Usage ValueSet Version Source
    Dosage.additionalInstruction Base preferred SNOMED CT Additional Dosage Instructions 📦4.0.1 FHIR Std.
    Dosage.asNeeded[x] Base preferred Clinical Finding ⏿1.0.2 tx.hl7.org.au
    Dosage.site Base preferred Body Site ⏿1.0.2 tx.hl7.org.au
    Dosage.route Base preferred Route of Administration ⏿1.0.2 tx.hl7.org.au
    Dosage.method Base preferred SNOMED CT Administration Method Codes 📦4.0.1 FHIR Std.
    Dosage.doseAndRate.type Base example DoseAndRateType 📍4.0.1 FHIR Std.

    Constraints

    Id Grade Path(s) Description Expression
    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()
    sqty-1 error Dosage.maxDosePerAdministration, Dosage.maxDosePerLifetime The comparator is not used on a SimpleQuantity comparator.empty()

    This structure is derived from Dosage

    Summary

    Maturity: 2

     

    Other representations of profile: CSV, Excel, Schematron