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

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