Australian Base Implementation Guide (AU Base 2)

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

1.0 StructureDefinition-au-dosage

AU Dosage [FMM Level 2]

This profile defines a dosage structure including core localisation concepts for use in an Australian context.

Examples

Practitioner reports patient is taking Roferon-A three times a week on Mon Wed Sat

Practitioner reports patient has had Diflucan

1.0.1 Formal Views of Profile Content

The official URL for this profile is: 

http://hl7.org.au/fhir/StructureDefinition/au-dosage

This profile defines a dosage structure including core localisation concepts for use in an Australian context.

This profile builds on Dosage.

This profile was published on Thu Jul 30 13:57:34 AEST 2020 as a draft by Health Level Seven Australia (Medications WG).

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

NameFlagsCard.TypeDescription & Constraintsdoco
.. Dosage 0..*DosageDosage information in an Australian healthcare context
... additionalInstruction 0..*(Slice Definition)Supplemental instruction or warnings to the patient - e.g. "with meals", "may cause drowsiness"
Slice: Unordered, Open by value:coding.system
.... additionalInstruction:snomedAdditionalInstruction 0..*CodeableConceptSNOMED CT Additional Instruction
Binding: SNOMEDCTAdditionalDosageInstructions (preferred)
... asNeeded[x] 0..1(Slice Definition)Take "as needed" (for x)
Slice: Unordered, Closed by type:$this
.... asNeeded[x]:asNeededCodeableConcept 0..1CodeableConceptClinical Finding (SNOMED CT)
Binding: https://healthterminologies.gov.au/fhir/ValueSet/clinical-finding-1 (preferred)
.... asNeeded[x]:asNeededBoolean 0..1booleanTake "as needed" (for x)
... site 0..1CodeableConceptBody site to administer to
Binding: https://healthterminologies.gov.au/fhir/ValueSet/body-site-1 (preferred)
... route 0..1CodeableConceptRoute of Administration (SNOMED CT)
Binding: https://healthterminologies.gov.au/fhir/ValueSet/route-of-administration-1 (preferred)
... method 0..1CodeableConceptSNOMED CT Administration Method
Binding: SNOMEDCTAdministrationMethodCodes (preferred)

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Dosage I0..*DosageDosage information in an Australian healthcare context
... id 0..1stringUnique id for inter-element referencing
... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
... sequence ΣI0..1integerThe order of the dosage instructions
... text ΣI0..1stringFree text dosage instructions e.g. SIG
... additionalInstruction ΣI0..*(Slice Definition)Supplemental instruction or warnings to the patient - e.g. "with meals", "may cause drowsiness"
Slice: Unordered, Open by value:coding.system
Binding: SNOMEDCTAdditionalDosageInstructions (example)
.... additionalInstruction:snomedAdditionalInstruction ΣI0..*CodeableConceptSNOMED CT Additional Instruction
Binding: SNOMEDCTAdditionalDosageInstructions (preferred)
... patientInstruction ΣI0..1stringPatient or consumer oriented instructions
... timing ΣI0..1TimingWhen medication should be administered
... asNeeded[x] ΣI0..1(Slice Definition)Take "as needed" (for x)
Slice: Unordered, Closed by type:$this
Binding: SNOMEDCTMedicationAsNeededReasonCodes (example)
.... asNeededBooleanboolean
.... asNeededCodeableConceptCodeableConcept
.... asNeeded[x]:asNeededCodeableConcept ΣI0..1CodeableConceptClinical Finding (SNOMED CT)
Binding: https://healthterminologies.gov.au/fhir/ValueSet/clinical-finding-1 (preferred)
.... asNeeded[x]:asNeededBoolean ΣI0..1booleanTake "as needed" (for x)
... site ΣI0..1CodeableConceptBody site to administer to
Binding: https://healthterminologies.gov.au/fhir/ValueSet/body-site-1 (preferred)
... route ΣI0..1CodeableConceptRoute of Administration (SNOMED CT)
Binding: https://healthterminologies.gov.au/fhir/ValueSet/route-of-administration-1 (preferred)
... method ΣI0..1CodeableConceptSNOMED CT Administration Method
Binding: SNOMEDCTAdministrationMethodCodes (preferred)
... doseAndRate ΣI0..*ElementAmount of medication administered
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... type ΣI0..1CodeableConceptThe kind of dose or rate specified
Binding: DoseAndRateType (example)
.... dose[x] ΣI0..1Amount of medication per dose
..... doseRangeRange
..... doseQuantityQuantity(SimpleQuantity)
.... rate[x] ΣI0..1Amount of medication per unit of time
..... rateRatioRatio
..... rateRangeRange
..... rateQuantityQuantity(SimpleQuantity)
... maxDosePerPeriod ΣI0..1RatioUpper limit on medication per unit of time
... maxDosePerAdministration ΣI0..1SimpleQuantityUpper limit on medication per administration
... maxDosePerLifetime ΣI0..1SimpleQuantityUpper limit on medication per lifetime of the patient

doco Documentation for this format

Differential View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Dosage 0..*DosageDosage information in an Australian healthcare context
... additionalInstruction 0..*(Slice Definition)Supplemental instruction or warnings to the patient - e.g. "with meals", "may cause drowsiness"
Slice: Unordered, Open by value:coding.system
.... additionalInstruction:snomedAdditionalInstruction 0..*CodeableConceptSNOMED CT Additional Instruction
Binding: SNOMEDCTAdditionalDosageInstructions (preferred)
... asNeeded[x] 0..1(Slice Definition)Take "as needed" (for x)
Slice: Unordered, Closed by type:$this
.... asNeeded[x]:asNeededCodeableConcept 0..1CodeableConceptClinical Finding (SNOMED CT)
Binding: https://healthterminologies.gov.au/fhir/ValueSet/clinical-finding-1 (preferred)
.... asNeeded[x]:asNeededBoolean 0..1booleanTake "as needed" (for x)
... site 0..1CodeableConceptBody site to administer to
Binding: https://healthterminologies.gov.au/fhir/ValueSet/body-site-1 (preferred)
... route 0..1CodeableConceptRoute of Administration (SNOMED CT)
Binding: https://healthterminologies.gov.au/fhir/ValueSet/route-of-administration-1 (preferred)
... method 0..1CodeableConceptSNOMED CT Administration Method
Binding: SNOMEDCTAdministrationMethodCodes (preferred)

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Dosage I0..*DosageDosage information in an Australian healthcare context
... id 0..1stringUnique id for inter-element referencing
... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
... sequence ΣI0..1integerThe order of the dosage instructions
... text ΣI0..1stringFree text dosage instructions e.g. SIG
... additionalInstruction ΣI0..*(Slice Definition)Supplemental instruction or warnings to the patient - e.g. "with meals", "may cause drowsiness"
Slice: Unordered, Open by value:coding.system
Binding: SNOMEDCTAdditionalDosageInstructions (example)
.... additionalInstruction:snomedAdditionalInstruction ΣI0..*CodeableConceptSNOMED CT Additional Instruction
Binding: SNOMEDCTAdditionalDosageInstructions (preferred)
... patientInstruction ΣI0..1stringPatient or consumer oriented instructions
... timing ΣI0..1TimingWhen medication should be administered
... asNeeded[x] ΣI0..1(Slice Definition)Take "as needed" (for x)
Slice: Unordered, Closed by type:$this
Binding: SNOMEDCTMedicationAsNeededReasonCodes (example)
.... asNeededBooleanboolean
.... asNeededCodeableConceptCodeableConcept
.... asNeeded[x]:asNeededCodeableConcept ΣI0..1CodeableConceptClinical Finding (SNOMED CT)
Binding: https://healthterminologies.gov.au/fhir/ValueSet/clinical-finding-1 (preferred)
.... asNeeded[x]:asNeededBoolean ΣI0..1booleanTake "as needed" (for x)
... site ΣI0..1CodeableConceptBody site to administer to
Binding: https://healthterminologies.gov.au/fhir/ValueSet/body-site-1 (preferred)
... route ΣI0..1CodeableConceptRoute of Administration (SNOMED CT)
Binding: https://healthterminologies.gov.au/fhir/ValueSet/route-of-administration-1 (preferred)
... method ΣI0..1CodeableConceptSNOMED CT Administration Method
Binding: SNOMEDCTAdministrationMethodCodes (preferred)
... doseAndRate ΣI0..*ElementAmount of medication administered
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... type ΣI0..1CodeableConceptThe kind of dose or rate specified
Binding: DoseAndRateType (example)
.... dose[x] ΣI0..1Amount of medication per dose
..... doseRangeRange
..... doseQuantityQuantity(SimpleQuantity)
.... rate[x] ΣI0..1Amount of medication per unit of time
..... rateRatioRatio
..... rateRangeRange
..... rateQuantityQuantity(SimpleQuantity)
... maxDosePerPeriod ΣI0..1RatioUpper limit on medication per unit of time
... maxDosePerAdministration ΣI0..1SimpleQuantityUpper limit on medication per administration
... maxDosePerLifetime ΣI0..1SimpleQuantityUpper limit on medication per lifetime of the patient

doco Documentation for this format

Downloads: StructureDefinition: (XML, JSON), Schema: XML Schematron

 

1.0.2 Quick Start

Below is an overview of the required search and read operations.

Summary of Search Criteria for StructureDefinition-au-dosage

none defined