AU Base Implementation Guide
6.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 6.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

Table of Contents

Page standards status: Informative
.. 0 Table of Contents
... 1 Home
... 2 Guidance
.... 2.1 General Guidance
.... 2.2 Sex and Gender
.... 2.3 Relationship with other IGs
.... 2.4 Future of AU Base
... 3 FHIR Artefacts
.... 3.1 Artefacts Summary
..... 3.1.1 EncounterDischargeDisposition
..... 3.1.2 AustralianIndigenousStatus
..... 3.1.3 GenderIdentity
..... 3.1.4 AU Base Condition
..... 3.1.5 AU Base Coverage
..... 3.1.6 AU Assertion of No Relevant Finding
..... 3.1.7 AU Base Patient
..... 3.1.8 AU Base Practitioner
..... 3.1.9 AU Base PractitionerRole
..... 3.1.10 AU Base RelatedPerson
..... 3.1.11 AU Base Organization
..... 3.1.12 AU Base Medication
..... 3.1.13 AU Base Encounter
..... 3.1.14 AU Medicine List
..... 3.1.15 AU Base Composition
..... 3.1.16 AU Base Immunization
..... 3.1.17 AU Base MedicationStatement
..... 3.1.18 AU Base MedicationAdministration
..... 3.1.19 AU Base MedicationDispense
..... 3.1.20 AU Base MedicationRequest
..... 3.1.21 AU Base Location
..... 3.1.22 AU Base HealthcareService
..... 3.1.23 AU Base AllergyIntolerance
..... 3.1.24 AU Base BodyStructure
..... 3.1.25 AU Base Diagnostic Result
..... 3.1.26 AU Base Pathology Result
..... 3.1.27 AU Base Diagnostic Imaging Result
..... 3.1.28 AU Base Diagnostic Imaging Report
..... 3.1.29 AU Base DiagnosticReport
..... 3.1.30 AU Base Pathology Report
..... 3.1.31 AU Base Specimen
..... 3.1.32 AU Base Substance
..... 3.1.33 AU Base Procedure
..... 3.1.34 AU Base Diagnostic Request
..... 3.1.35 AU Base ServiceRequest
..... 3.1.36 Australian Address
..... 3.1.37 AU IHI
..... 3.1.38 AU National Provider Identifier At Organisation
..... 3.1.39 AU Medicare Card Number
..... 3.1.40 AU Medicare Provider Number
..... 3.1.41 AU PBS Prescriber Number
..... 3.1.42 AU Medical Record Number
..... 3.1.43 AU HPI-I
..... 3.1.44 AU DVA Number
..... 3.1.45 AU HPI-O
..... 3.1.46 AU Ahpra Registration Number
..... 3.1.47 AU Australian Business Number
..... 3.1.48 AU Australian Registered Body Number
..... 3.1.49 AU PAI-D Identifier
..... 3.1.50 AU PAI-O Identifier
..... 3.1.51 AU Care Agency Employee Identifier
..... 3.1.52 AU ETP Prescription Identifier
..... 3.1.53 AU NATA Accreditation Number
..... 3.1.54 AU NATA Site Number
..... 3.1.55 AU Location Specific Practice Number
..... 3.1.56 AU Employee Number
..... 3.1.57 AU CSP Registration Number
..... 3.1.58 AU Health Care Card Number
..... 3.1.59 AU Australian Company Number
..... 3.1.60 AU Commonwealth Seniors Health Card Number
..... 3.1.61 AU Pensioner Concession Card Number
..... 3.1.62 AU Insurance Member Number
..... 3.1.63 AU Local Prescription Identifier
..... 3.1.64 AU Local Dispense Identifier
..... 3.1.65 AU Base Dosage
..... 3.1.66 AU Delivery Point Identifier
..... 3.1.67 AU G-NAF Identifier
..... 3.1.68 AU Pharmacy Approval Number
..... 3.1.69 AU Patient Internal Identifier
..... 3.1.70 AU Local Order Identifier
..... 3.1.71 AU Local Report Identifier
..... 3.1.72 AU Accession Number
..... 3.1.73 AU Residential Aged Care Service Identifier
..... 3.1.74 HL7 V2 Receiving Application
..... 3.1.75 HL7 V2 Receiving Facility
..... 3.1.76 HL7 V2 Assigning Authority
..... 3.1.77 Encryption Certificate PEM X509
..... 3.1.78 Australian Indigenous Status
..... 3.1.79 Dispense Number
..... 3.1.80 Long Term
..... 3.1.81 Medication Type
..... 3.1.82 Medication Strength
..... 3.1.83 Medication Brand Name
..... 3.1.84 Medication Generic Drug Name
..... 3.1.85 Ethnicity
..... 3.1.86 Closing the Gap Registration
..... 3.1.87 Associated Healthcare Service
..... 3.1.88 Subsidised Concurrent Supply
..... 3.1.89 Encounter Description
..... 3.1.90 Change Description
..... 3.1.91 Author as a RelatedPerson
..... 3.1.92 No Fixed Address
..... 3.1.93 Identifier Routability
..... 3.1.94 IHI Status
..... 3.1.95 IHI Record Status
..... 3.1.96 IHI Verification Date
..... 3.1.97 Date Accuracy Indicator
..... 3.1.98 Information Recipient
..... 3.1.99 Vaccine Vial Serial Number
..... 3.1.100 Australian Veteran Status
..... 3.1.101 Result Copies To
..... 3.1.102 Contact Purpose
..... 3.1.103 Address Identifier
..... 3.1.104 Ahpra Registration Details
..... 3.1.105 Ahpra Profession Details
..... 3.1.106 Australian Time Zone
..... 3.1.107 Australian Time Zone Usage
..... 3.1.108 Name Context
..... 3.1.109 Date of Arrival in Australia
..... 3.1.110 Contact Purpose
..... 3.1.111 ActEncounterCode - AU Extended
..... 3.1.112 hl7VS-identifierType - AU Extended
..... 3.1.113 hl7VS-degreeLicenseCertificate - AU Extended
..... 3.1.114 hl7VS-providerRole - AU Extended
..... 3.1.115 Service Provision Conditions Australian Concepts
..... 3.1.116 PBS Item Codes
..... 3.1.117 MIMS
..... 3.1.118 AMT Medicinal Product and Substances
..... 3.1.119 Medication Type
..... 3.1.120 DVA Entitlement
..... 3.1.121 Accession Number Type
..... 3.1.122 Order Identifier Type
..... 3.1.123 Location Type (Physical) - AU Extended
..... 3.1.124 ServiceDeliveryLocationRoleType - AU Extended
..... 3.1.125 Medicine Item Change
..... 3.1.126 AU Time Zone
..... 3.1.127 Name Context
..... 3.1.128 Jurisdiction ValueSet - AU Extended
..... 3.1.129 AU Recorded Sex or Gender (RSG) Source Document Type
..... 3.1.130 AU Recorded Sex or Gender Type
..... 3.1.131 PBS Item Codes
..... 3.1.132 Monthly Index of Medical Specialties (MIMS)
..... 3.1.133 Medication Type
..... 3.1.134 Service Provision Conditions Australian Concepts
..... 3.1.135 Contact Purpose
..... 3.1.136 ActCode AU
..... 3.1.137 IdentifierType AU
..... 3.1.138 DegreeLicenseCertificate AU
..... 3.1.139 providerRole AU
..... 3.1.140 Location Type (Physical) AU
..... 3.1.141 Location Type AU
..... 3.1.142 Medicine Item Change
..... 3.1.143 AU Recorded Sex or Gender Source Document Type
..... 3.1.144 AU Recorded Sex or Gender Type
..... 3.1.145 Name Context
..... 3.1.146 Observation - Measurement of Hepatitis B surface antibody
..... 3.1.147 Specimen - Serum sample
..... 3.1.148 ServiceRequest - for Hepatitis B surface antibody measurement
..... 3.1.149 ServiceRequest - with multiple result copies to indicated
..... 3.1.150 Condition - with evidence and onset date-time
..... 3.1.151 Coverage - DVA Gold Card
..... 3.1.152 Coverage - private health insurer
..... 3.1.153 Immunization - Non-administration of varicella-zoster live vaccine due to refusal
..... 3.1.154 Immunization - Administration of a vaccine - record compliant with Australian Immunisation Register (AIR)
..... 3.1.155 Immunization - Administration of a vaccine with administering provider and protocol
..... 3.1.156 Immunization - Administration of Pfizer Comirnaty dose 1 for Sarah Simmons
..... 3.1.157 Practitioner - as a Radiologist
..... 3.1.158 AllergyIntolerance - ibuprofen allergy
..... 3.1.159 AllergyIntolerance - self-reported allergy to eggs
..... 3.1.160 AllergyIntolerance - self-reported intolerance to lactose
..... 3.1.161 AllergyIntolerance - no known allergy
..... 3.1.162 BodyStructure - Bone tissue of left shoulder
..... 3.1.163 BodyStructure - Blister of right foot
..... 3.1.164 Device - as a registered repository service
..... 3.1.165 Location - of a Practitioner as a Radiologist
..... 3.1.166 Organization - a typical Organisation the Radiologist belongs to
..... 3.1.167 Organization - Holistic Medical Pty Ltd with ABN and HPI-O
..... 3.1.168 PractitionerRole - a typical Practitioner Role as a Radiologist
..... 3.1.169 HealthcareService - a typical Healthcare Service the Radiologist belongs to
..... 3.1.170 Practitioner - a typical Practitioner as a General Practitioner
..... 3.1.171 Practitioner - a typical Ahpra registered professional
..... 3.1.172 Practitioner - sex and gender
..... 3.1.173 Endpoint - a secure messaging endpoint example
..... 3.1.174 Location - of a Practitioner as a General Practitioner
..... 3.1.175 Organization - a typical Organisation the General Practitioner belongs to
..... 3.1.176 PractitionerRole - a typical Practitioner Role as a General Practitioner
..... 3.1.177 HealthcareService - general practice
..... 3.1.178 Patient - as transgender person with sex and gender
..... 3.1.179 Patient - with IHI, Medicare Card Number, patient internal identifier and the extension for Indigenous Status
..... 3.1.180 Patient - with IHI, DVA Number (with specific card colour) and the extension for Indigenous Status
..... 3.1.181 Patient - with no birth date, and is eligible for Closing the Gap registration
..... 3.1.182 Patient - with birth date and birth time
..... 3.1.183 Patient - as a child born in 2008
..... 3.1.184 Patient - as a mother for the patient in example 4
..... 3.1.185 Patient - as a Culturally and linguistically diverse (CALD) patient 1
..... 3.1.186 Patient - as a Culturally and linguistically diverse (CALD) patient 2
..... 3.1.187 Practitioner - with HPI-I and Prescriber Number
..... 3.1.188 PractitionerRole - with Provider Number and ANZSCO coded role
..... 3.1.189 Organization - with HPI-O
..... 3.1.190 Organization - a Pathology organisation with NATA Number, ARBN, ABN, ACN, HPI-O and PAI-O
..... 3.1.191 Organization - a Pathology organisation with HPI-O and is a parent organization
..... 3.1.192 HealthcareService - with HPI-O with varied contact details
..... 3.1.193 Location - a hospital location with managing organisation of example0
..... 3.1.194 Patient - with Birth Date Accuracy Indicator of AAA
..... 3.1.195 Patient - with Birth Date Accuracy Indicator of AAU
..... 3.1.196 Patient - with Birth Date Accuracy Indicator of UAA
..... 3.1.197 Patient - with Birth Date Accuracy Indicator of UEA
..... 3.1.198 Patient - with Birth Date Accuracy Indicator of UUU
..... 3.1.199 Location - of a Practitioner as a Pathologist
..... 3.1.200 Location - for services delivered by phone, video or online
..... 3.1.201 Location - for mobile services that can be delivered in a person's house, apartment, or unit
..... 3.1.202 Location - for mobile services that can be delivered in schools
..... 3.1.203 Location - for mobile services that can be delivered in residential care facilities
..... 3.1.204 PractitionerRole - as a Pathologist
..... 3.1.205 HealthcareService - of a Pathologist
..... 3.1.206 Practitioner - as a Pathologist
..... 3.1.207 PractitionerRole - with assigning authority
..... 3.1.208 Organization - a hospital with an HPIO
..... 3.1.209 RelatedPerson - as attester party
..... 3.1.210 RelatedPerson - as a carer for an older patient
..... 3.1.211 RelatedPerson - as a mother for the patient in example 4
..... 3.1.212 RelatedPerson - as father
..... 3.1.213 RelatedPerson - as family member with sex and gender
..... 3.1.214 Patient - male born in 1949 with address and contact details
..... 3.1.215 Observation - of no relevant finding of procedure
..... 3.1.216 Observation - of no relevant finding of immunisations
..... 3.1.217 Observation - of no relevant finding of known history of conditions
..... 3.1.218 Observation - of no relevant finding of patient taking any medications
..... 3.1.219 Patient - structured Australian Address
..... 3.1.220 Patient - unstructured Australian Address
..... 3.1.221 Patient - Australian No Fixed Address
..... 3.1.222 Patient - Australian address with identifiers
..... 3.1.223 Patient - indicate IHI validation name context
..... 3.1.224 Practitioner - indicate HPI-I validation name context
..... 3.1.225 Medication - dose based
..... 3.1.226 Medication - Unbranded Product of clarithromycin 500mg tablet
..... 3.1.227 Medication - Unbranded Product of esomeprazole 20mg tablet
..... 3.1.228 Medication - Unbranded product of amoxicillin 500mg capsule
..... 3.1.229 Medication - uncoded medicinal product information
..... 3.1.230 Medication - branded pack
..... 3.1.231 Medication - Generic Pack of paracetamol 500mg (100)
..... 3.1.232 Medication - Branded Pack of Nexium HP7 20;500;500
..... 3.1.233 Medication - Branded Pack With Single Active Ingredient
..... 3.1.234 Medication - with two active ingredients product
..... 3.1.235 Medication - with four or more active ingredients
..... 3.1.236 Medication - Branded Pack with Batch Details
..... 3.1.237 Composition - with multiple information recipients
..... 3.1.238 ​Composition - with some sections having a different section author to the composition author
..... 3.1.239 Composition - Patient’s preference upon death
..... 3.1.240 MedicationStatement - of a record of a patient's use of medication
..... 3.1.241 MedicationStatement - of a record of a patient's long-term use of medication
..... 3.1.242 MedicationStatement - Practitioner reports patient has taken Diflucan in the past but is not taking it any more
..... 3.1.243 MedicationRequest - a prescription for codeine with paracetamol
..... 3.1.244 MedicationRequest - a prescription for Stribild tablet
..... 3.1.245 MedicationRequest - Prescription with brand and generic name extensions
..... 3.1.246 Encounter - with description
..... 3.1.247 Encounter - Annual check up
..... 3.1.248 List - Medicine list with referenced entries
..... 3.1.249 List - Medicine list with no known current medicine
..... 3.1.250 Bundle - Medicine list in a bundle
..... 3.1.251 List - Medicine list with changes
..... 3.1.252 List - Medicine list authored by a related person
..... 3.1.253 MedicationDispense - First dispense for Reaptan
..... 3.1.254 HealthcareService - Leafy Grove Home for the Aged
..... 3.1.255 HealthcareService - Honourable Mark's Home For Aged Men
..... 3.1.256 Location - Leafy Grove Home for the Aged
..... 3.1.257 Location - Leafy Grove Home for the Not Very Aged
..... 3.1.258 MedicationDispense - Second dispense for Reaptan
..... 3.1.259 Organization - The Corporation of the Council of the Ward of Nundah
..... 3.1.260 Substance - body substance of epiglottic mucus
..... 3.1.261 Substance - peanuts as an allergen
..... 3.1.262 Substance - medication substance with two active ingredients
..... 3.1.263 MedicationAdministration - Administration of Chlorsig eye drops
..... 3.1.264 MedicationAdministration - Self-administration of lantus 100 units/mL injection
..... 3.1.265 Procedure - Cryotherapy
..... 3.1.266 Procedure - Cardiac catheterisation
..... 3.1.267 Procedure - Stent placement
.... 3.2 Profiles and Extensions
.... 3.3 Search Parameters
.... 3.4 Terminology
... 4 Examples
... 5 Support
.... 5.1 Downloads
.... 5.2 License and Legal
... 6 Change Log