AU Base Implementation Guide
5.0.1-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 5.0.1-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: 5.0.1-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

Usage:

Changes since version 5.0.0:

  • No changes

    • 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..* 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)
    ... method 0..1 CodeableConcept Technique for administering medication
    Binding: SNOMEDCTAdministrationMethodCodes (preferred)

    doco Documentation for this format

    Terminology Bindings (Differential)

    PathConformanceValueSetURI
    Dosage.additionalInstructionpreferredSNOMEDCTAdditionalDosageInstructions
    http://hl7.org/fhir/ValueSet/additional-instruction-codes
    from the FHIR Standard
    Dosage.asNeeded[x]preferredClinicalFinding .
    https://healthterminologies.gov.au/fhir/ValueSet/clinical-finding-1
    Dosage.sitepreferredBodySite .
    https://healthterminologies.gov.au/fhir/ValueSet/body-site-1
    Dosage.routepreferredRouteOfAdministration .
    https://healthterminologies.gov.au/fhir/ValueSet/route-of-administration-1
    Dosage.methodpreferredSNOMEDCTAdministrationMethodCodes
    http://hl7.org/fhir/ValueSet/administration-method-codes
    from the FHIR Standard
    NameFlagsCard.TypeDescription & Constraintsdoco
    .. Dosage 0..* Dosage Dosage information in an Australian healthcare context
    ele-1: All FHIR elements must have a @value or children
    ... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
    ele-1: All FHIR elements must have a @value or children
    ext-1: Must have either extensions or value[x], not both
    ... additionalInstruction Σ 0..* CodeableConcept Supplemental instruction or warnings to the patient - e.g. "with meals", "may cause drowsiness"
    Binding: SNOMEDCTAdditionalDosageInstructions (preferred)
    ele-1: All FHIR elements must have a @value or children
    ... asNeeded[x] Σ 0..1 Take "as needed" (for x)
    Binding: Clinical Finding . (preferred)
    ele-1: All FHIR elements must have a @value or children
    .... asNeededBoolean boolean
    .... asNeededCodeableConcept CodeableConcept
    ... route Σ 0..1 CodeableConcept How drug should enter body
    Binding: Route of Administration . (preferred)
    ele-1: All FHIR elements must have a @value or children
    ... method Σ 0..1 CodeableConcept Technique for administering medication
    Binding: SNOMEDCTAdministrationMethodCodes (preferred)
    ele-1: All FHIR elements must have a @value or children

    doco Documentation for this format

    Terminology Bindings

    PathConformanceValueSetURI
    Dosage.additionalInstructionpreferredSNOMEDCTAdditionalDosageInstructions
    http://hl7.org/fhir/ValueSet/additional-instruction-codes
    from the FHIR Standard
    Dosage.asNeeded[x]preferredClinicalFinding .
    https://healthterminologies.gov.au/fhir/ValueSet/clinical-finding-1
    Dosage.sitepreferredBodySite .
    https://healthterminologies.gov.au/fhir/ValueSet/body-site-1
    Dosage.routepreferredRouteOfAdministration .
    https://healthterminologies.gov.au/fhir/ValueSet/route-of-administration-1
    Dosage.methodpreferredSNOMEDCTAdministrationMethodCodes
    http://hl7.org/fhir/ValueSet/administration-method-codes
    from the FHIR Standard

    Constraints

    IdGradePath(s)DetailsRequirements
    ele-1error**ALL** elementsAll FHIR elements must have a @value or children
    : hasValue() or (children().count() > id.count())
    ext-1error**ALL** extensionsMust have either extensions or value[x], not both
    : extension.exists() != value.exists()
    NameFlagsCard.TypeDescription & Constraintsdoco
    .. 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
    ... 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

    doco Documentation for this format

    Terminology Bindings

    PathConformanceValueSetURI
    Dosage.additionalInstructionpreferredSNOMEDCTAdditionalDosageInstructions
    http://hl7.org/fhir/ValueSet/additional-instruction-codes
    from the FHIR Standard
    Dosage.asNeeded[x]preferredClinicalFinding .
    https://healthterminologies.gov.au/fhir/ValueSet/clinical-finding-1
    Dosage.sitepreferredBodySite .
    https://healthterminologies.gov.au/fhir/ValueSet/body-site-1
    Dosage.routepreferredRouteOfAdministration .
    https://healthterminologies.gov.au/fhir/ValueSet/route-of-administration-1
    Dosage.methodpreferredSNOMEDCTAdministrationMethodCodes
    http://hl7.org/fhir/ValueSet/administration-method-codes
    from the FHIR Standard
    Dosage.doseAndRate.typeexampleDoseAndRateType
    http://hl7.org/fhir/ValueSet/dose-rate-type
    from the FHIR Standard

    Constraints

    IdGradePath(s)DetailsRequirements
    ele-1error**ALL** elementsAll FHIR elements must have a @value or children
    : hasValue() or (children().count() > id.count())
    ext-1error**ALL** extensionsMust have either extensions or value[x], not both
    : extension.exists() != value.exists()

    This structure is derived from Dosage

    Summary

    Maturity: 2

    Differential View

    This structure is derived from Dosage

    NameFlagsCard.TypeDescription & Constraintsdoco
    .. 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)
    ... method 0..1 CodeableConcept Technique for administering medication
    Binding: SNOMEDCTAdministrationMethodCodes (preferred)

    doco Documentation for this format

    Terminology Bindings (Differential)

    PathConformanceValueSetURI
    Dosage.additionalInstructionpreferredSNOMEDCTAdditionalDosageInstructions
    http://hl7.org/fhir/ValueSet/additional-instruction-codes
    from the FHIR Standard
    Dosage.asNeeded[x]preferredClinicalFinding .
    https://healthterminologies.gov.au/fhir/ValueSet/clinical-finding-1
    Dosage.sitepreferredBodySite .
    https://healthterminologies.gov.au/fhir/ValueSet/body-site-1
    Dosage.routepreferredRouteOfAdministration .
    https://healthterminologies.gov.au/fhir/ValueSet/route-of-administration-1
    Dosage.methodpreferredSNOMEDCTAdministrationMethodCodes
    http://hl7.org/fhir/ValueSet/administration-method-codes
    from the FHIR Standard

    Key Elements View

    NameFlagsCard.TypeDescription & Constraintsdoco
    .. Dosage 0..* Dosage Dosage information in an Australian healthcare context
    ele-1: All FHIR elements must have a @value or children
    ... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
    ele-1: All FHIR elements must have a @value or children
    ext-1: Must have either extensions or value[x], not both
    ... additionalInstruction Σ 0..* CodeableConcept Supplemental instruction or warnings to the patient - e.g. "with meals", "may cause drowsiness"
    Binding: SNOMEDCTAdditionalDosageInstructions (preferred)
    ele-1: All FHIR elements must have a @value or children
    ... asNeeded[x] Σ 0..1 Take "as needed" (for x)
    Binding: Clinical Finding . (preferred)
    ele-1: All FHIR elements must have a @value or children
    .... asNeededBoolean boolean
    .... asNeededCodeableConcept CodeableConcept
    ... route Σ 0..1 CodeableConcept How drug should enter body
    Binding: Route of Administration . (preferred)
    ele-1: All FHIR elements must have a @value or children
    ... method Σ 0..1 CodeableConcept Technique for administering medication
    Binding: SNOMEDCTAdministrationMethodCodes (preferred)
    ele-1: All FHIR elements must have a @value or children

    doco Documentation for this format

    Terminology Bindings

    PathConformanceValueSetURI
    Dosage.additionalInstructionpreferredSNOMEDCTAdditionalDosageInstructions
    http://hl7.org/fhir/ValueSet/additional-instruction-codes
    from the FHIR Standard
    Dosage.asNeeded[x]preferredClinicalFinding .
    https://healthterminologies.gov.au/fhir/ValueSet/clinical-finding-1
    Dosage.sitepreferredBodySite .
    https://healthterminologies.gov.au/fhir/ValueSet/body-site-1
    Dosage.routepreferredRouteOfAdministration .
    https://healthterminologies.gov.au/fhir/ValueSet/route-of-administration-1
    Dosage.methodpreferredSNOMEDCTAdministrationMethodCodes
    http://hl7.org/fhir/ValueSet/administration-method-codes
    from the FHIR Standard

    Constraints

    IdGradePath(s)DetailsRequirements
    ele-1error**ALL** elementsAll FHIR elements must have a @value or children
    : hasValue() or (children().count() > id.count())
    ext-1error**ALL** extensionsMust have either extensions or value[x], not both
    : extension.exists() != value.exists()

    Snapshot View

    NameFlagsCard.TypeDescription & Constraintsdoco
    .. 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
    ... 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

    doco Documentation for this format

    Terminology Bindings

    PathConformanceValueSetURI
    Dosage.additionalInstructionpreferredSNOMEDCTAdditionalDosageInstructions
    http://hl7.org/fhir/ValueSet/additional-instruction-codes
    from the FHIR Standard
    Dosage.asNeeded[x]preferredClinicalFinding .
    https://healthterminologies.gov.au/fhir/ValueSet/clinical-finding-1
    Dosage.sitepreferredBodySite .
    https://healthterminologies.gov.au/fhir/ValueSet/body-site-1
    Dosage.routepreferredRouteOfAdministration .
    https://healthterminologies.gov.au/fhir/ValueSet/route-of-administration-1
    Dosage.methodpreferredSNOMEDCTAdministrationMethodCodes
    http://hl7.org/fhir/ValueSet/administration-method-codes
    from the FHIR Standard
    Dosage.doseAndRate.typeexampleDoseAndRateType
    http://hl7.org/fhir/ValueSet/dose-rate-type
    from the FHIR Standard

    Constraints

    IdGradePath(s)DetailsRequirements
    ele-1error**ALL** elementsAll FHIR elements must have a @value or children
    : hasValue() or (children().count() > id.count())
    ext-1error**ALL** extensionsMust have either extensions or value[x], not both
    : extension.exists() != value.exists()

    This structure is derived from Dosage

    Summary

    Maturity: 2

     

    Other representations of profile: CSV, Excel, Schematron