AU Base Implementation Guide
4.1.2-preview - Preview Australia flag

This page is part of the Australian Base IG (v4.1.2-preview: AU Base) based on FHIR R4. For a full list of available versions, see the Directory of published versions

Data Type Profile: AU Base Dosage

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

Formal Views of Profile Content

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

NameFlagsCard.TypeDescription & Constraintsdoco
.. Dosage 0..*DosageDosage information in an Australian healthcare context
... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
... additionalInstruction Σ0..*CodeableConceptSupplemental instruction or warnings to the patient - e.g. "with meals", "may cause drowsiness"
Binding: SNOMEDCTAdditionalDosageInstructions (preferred)
... asNeeded[x] Σ0..1Take "as needed" (for x)
Binding: https://healthterminologies.gov.au/fhir/ValueSet/clinical-finding-1 (preferred)
.... asNeededBooleanboolean
.... asNeededCodeableConceptCodeableConcept
... route Σ0..1CodeableConceptHow drug should enter body
Binding: https://healthterminologies.gov.au/fhir/ValueSet/route-of-administration-1 (preferred)
... method Σ0..1CodeableConceptTechnique for administering medication
Binding: SNOMEDCTAdministrationMethodCodes (preferred)

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
Dosage.additionalInstructionpreferredSNOMEDCTAdditionalDosageInstructions
Dosage.asNeeded[x]preferredhttps://healthterminologies.gov.au/fhir/ValueSet/clinical-finding-1
Dosage.sitepreferredhttps://healthterminologies.gov.au/fhir/ValueSet/body-site-1
Dosage.routepreferredhttps://healthterminologies.gov.au/fhir/ValueSet/route-of-administration-1
Dosage.methodpreferredSNOMEDCTAdministrationMethodCodes

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..*DosageDosage information in an Australian healthcare context
... id 0..1stringUnique id for inter-element referencing
... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
... text Σ0..1stringFree text dosage instructions e.g. SIG
... additionalInstruction Σ0..*CodeableConceptSupplemental instruction or warnings to the patient - e.g. "with meals", "may cause drowsiness"
Binding: SNOMEDCTAdditionalDosageInstructions (preferred)
... patientInstruction Σ0..1stringPatient or consumer oriented instructions
... timing Σ0..1TimingWhen medication should be administered
... asNeeded[x] Σ0..1Take "as needed" (for x)
Binding: https://healthterminologies.gov.au/fhir/ValueSet/clinical-finding-1 (preferred)
.... asNeededBooleanboolean
.... asNeededCodeableConceptCodeableConcept
... site Σ0..1CodeableConceptBody site to administer to
Binding: https://healthterminologies.gov.au/fhir/ValueSet/body-site-1 (preferred)
... route Σ0..1CodeableConceptHow drug should enter body
Binding: https://healthterminologies.gov.au/fhir/ValueSet/route-of-administration-1 (preferred)
... method Σ0..1CodeableConceptTechnique for administering medication
Binding: SNOMEDCTAdministrationMethodCodes (preferred)
... doseAndRate Σ0..*ElementAmount of medication administered
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... type Σ0..1CodeableConceptThe kind of dose or rate specified
Binding: DoseAndRateType (example): The kind of dose or rate specified.

.... dose[x] Σ0..1Amount of medication per dose
..... doseRangeRange
..... doseQuantityQuantity(SimpleQuantity)
.... rate[x] Σ0..1Amount of medication per unit of time
..... rateRatioRatio
..... rateRangeRange
..... rateQuantityQuantity(SimpleQuantity)
... maxDosePerPeriod Σ0..1RatioUpper limit on medication per unit of time
... maxDosePerAdministration Σ0..1SimpleQuantityUpper limit on medication per administration
... maxDosePerLifetime Σ0..1SimpleQuantityUpper limit on medication per lifetime of the patient

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
Dosage.additionalInstructionpreferredSNOMEDCTAdditionalDosageInstructions
Dosage.asNeeded[x]preferredhttps://healthterminologies.gov.au/fhir/ValueSet/clinical-finding-1
Dosage.sitepreferredhttps://healthterminologies.gov.au/fhir/ValueSet/body-site-1
Dosage.routepreferredhttps://healthterminologies.gov.au/fhir/ValueSet/route-of-administration-1
Dosage.methodpreferredSNOMEDCTAdministrationMethodCodes
Dosage.doseAndRate.typeexampleDoseAndRateType

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

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Dosage 0..*DosageDosage information in an Australian healthcare context
... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
... additionalInstruction Σ0..*CodeableConceptSupplemental instruction or warnings to the patient - e.g. "with meals", "may cause drowsiness"
Binding: SNOMEDCTAdditionalDosageInstructions (preferred)
... asNeeded[x] Σ0..1Take "as needed" (for x)
Binding: https://healthterminologies.gov.au/fhir/ValueSet/clinical-finding-1 (preferred)
.... asNeededBooleanboolean
.... asNeededCodeableConceptCodeableConcept
... route Σ0..1CodeableConceptHow drug should enter body
Binding: https://healthterminologies.gov.au/fhir/ValueSet/route-of-administration-1 (preferred)
... method Σ0..1CodeableConceptTechnique for administering medication
Binding: SNOMEDCTAdministrationMethodCodes (preferred)

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
Dosage.additionalInstructionpreferredSNOMEDCTAdditionalDosageInstructions
Dosage.asNeeded[x]preferredhttps://healthterminologies.gov.au/fhir/ValueSet/clinical-finding-1
Dosage.sitepreferredhttps://healthterminologies.gov.au/fhir/ValueSet/body-site-1
Dosage.routepreferredhttps://healthterminologies.gov.au/fhir/ValueSet/route-of-administration-1
Dosage.methodpreferredSNOMEDCTAdministrationMethodCodes

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..*DosageDosage information in an Australian healthcare context
... id 0..1stringUnique id for inter-element referencing
... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
... text Σ0..1stringFree text dosage instructions e.g. SIG
... additionalInstruction Σ0..*CodeableConceptSupplemental instruction or warnings to the patient - e.g. "with meals", "may cause drowsiness"
Binding: SNOMEDCTAdditionalDosageInstructions (preferred)
... patientInstruction Σ0..1stringPatient or consumer oriented instructions
... timing Σ0..1TimingWhen medication should be administered
... asNeeded[x] Σ0..1Take "as needed" (for x)
Binding: https://healthterminologies.gov.au/fhir/ValueSet/clinical-finding-1 (preferred)
.... asNeededBooleanboolean
.... asNeededCodeableConceptCodeableConcept
... site Σ0..1CodeableConceptBody site to administer to
Binding: https://healthterminologies.gov.au/fhir/ValueSet/body-site-1 (preferred)
... route Σ0..1CodeableConceptHow drug should enter body
Binding: https://healthterminologies.gov.au/fhir/ValueSet/route-of-administration-1 (preferred)
... method Σ0..1CodeableConceptTechnique for administering medication
Binding: SNOMEDCTAdministrationMethodCodes (preferred)
... doseAndRate Σ0..*ElementAmount of medication administered
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... type Σ0..1CodeableConceptThe kind of dose or rate specified
Binding: DoseAndRateType (example): The kind of dose or rate specified.

.... dose[x] Σ0..1Amount of medication per dose
..... doseRangeRange
..... doseQuantityQuantity(SimpleQuantity)
.... rate[x] Σ0..1Amount of medication per unit of time
..... rateRatioRatio
..... rateRangeRange
..... rateQuantityQuantity(SimpleQuantity)
... maxDosePerPeriod Σ0..1RatioUpper limit on medication per unit of time
... maxDosePerAdministration Σ0..1SimpleQuantityUpper limit on medication per administration
... maxDosePerLifetime Σ0..1SimpleQuantityUpper limit on medication per lifetime of the patient

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
Dosage.additionalInstructionpreferredSNOMEDCTAdditionalDosageInstructions
Dosage.asNeeded[x]preferredhttps://healthterminologies.gov.au/fhir/ValueSet/clinical-finding-1
Dosage.sitepreferredhttps://healthterminologies.gov.au/fhir/ValueSet/body-site-1
Dosage.routepreferredhttps://healthterminologies.gov.au/fhir/ValueSet/route-of-administration-1
Dosage.methodpreferredSNOMEDCTAdministrationMethodCodes
Dosage.doseAndRate.typeexampleDoseAndRateType

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