MediRecords FHIR Implementation Guide
1.4.2 - release


Table of Contents

.. 0 Table of Contents
... 1 Home
... 2 REST API
.... 2.1 AllergyIntolerance
.... 2.2 Condition
.... 2.3 Consent
.... 2.4 DiagnosticReport
.... 2.5 DocumentReference
.... 2.6 Encounter
.... 2.7 EpisodeOfCare
.... 2.8 FamilyMemberHistory
.... 2.9 HealthcareService
.... 2.10 Immunization
.... 2.11 Location
.... 2.12 MedicationRequest
.... 2.13 MedicationAdministration
.... 2.14 Observation
.... 2.15 Organization
.... 2.16 Patient
.... 2.17 Practitioner
.... 2.18 PractitionerRole
.... 2.19 QuestionnaireResponse
.... 2.20 ServiceRequest
.... 2.21 Task
... 3 Webhooks
... 4 Profiles
... 5 Extensions
... 6 Terminology
... 7 SMART App Launch Integration
.... 7.1 smart-configuration
.... 7.2 authorize
.... 7.3 token
... 8 Downloads
... 9 Artifacts Summary
.... 9.1 MediRecords FHIR Capability API Statement
.... 9.2 MR DocumentReference
.... 9.3 AU Core Pregnancy Status
.... 9.4 AU Core Waist Circumference
.... 9.5 MR AllergyIntolerance
.... 9.6 MR CareTeam
.... 9.7 MR Condition
.... 9.8 MR Consent
.... 9.9 MR Coverage
.... 9.10 MR DiagnosticReport
.... 9.11 MR DiagnosticReport Imaging
.... 9.12 MR DiagnosticReport Pathology
.... 9.13 MR DiagnosticReport Pathology Result
.... 9.14 MR DiagnosticRequest
.... 9.15 MR DocumentReference Admission
.... 9.16 MR DocumentReference Attachment
.... 9.17 MR DocumentReference Consent
.... 9.18 MR DocumentReference Consultation
.... 9.19 MR DocumentReference In
.... 9.20 MR DocumentReference Out
.... 9.21 MR DocumentReference Out Write
.... 9.22 MR DocumentReference Prescription
.... 9.23 MR Encounter
.... 9.24 MR Encounter Admission
.... 9.25 MR EpisodeOfCare
.... 9.26 MR FamilyMemberHistory
.... 9.27 MR HealthcareService
.... 9.28 MR Immunisation
.... 9.29 MR Location
.... 9.30 MR Location Admission
.... 9.31 MR Medication
.... 9.32 MR Medication Admission
.... 9.33 MR Medication Admission Intravenous
.... 9.34 MR Medication Draft
.... 9.35 MR MedicationAdministration Admission
.... 9.36 MR MedicationAdministration Admission Intravenous
.... 9.37 MR MedicationRequest
.... 9.38 MR MedicationRequest Admission
.... 9.39 MR MedicationRequest Admission Documented
.... 9.40 MR MedicationRequest Admission Intravenous
.... 9.41 MR MedicationRequest Draft
.... 9.42 MR Observation Generic Clinical
.... 9.43 MR Observation Vital Sign Blood Pressure
.... 9.44 MR Observation Vital Sign Body Height
.... 9.45 MR Observation Vital Sign Body Length
.... 9.46 MR Observation Vital Sign Body Mass Index
.... 9.47 MR Observation Vital Sign Body Temperature
.... 9.48 MR Observation Vital Sign Body Weight
.... 9.49 MR Observation Vital Sign Head Circumference
.... 9.50 MR Observation Vital Sign Heart Rate
.... 9.51 MR Observation Vital Sign Oxygen Saturation
.... 9.52 MR Observation Vital Sign Respiratory Rate
.... 9.53 MR Observation Vital Sign Waist Circumference
.... 9.54 MR Observation Vital Signs
.... 9.55 MR OperationOutcome
.... 9.56 MR Organisation
.... 9.57 MR Organisation Service Provider
.... 9.58 MR Patient
.... 9.59 MR Practitioner
.... 9.60 MR Practitioner Contact
.... 9.61 MR PractitionerRole
.... 9.62 MR PractitionerRole Contact
.... 9.63 MR Procedure
.... 9.64 MR Questionnaire
.... 9.65 MR QuestionnaireResponse
.... 9.66 MR RelatedPerson
.... 9.67 MR Task DiagnosticRequest Fulfillment
.... 9.68 MR Address
.... 9.69 MR Address AU
.... 9.70 MR Address Foreign
.... 9.71 MR Dosage
.... 9.72 MR Dosage Admission
.... 9.73 MR Dosage Admission Documented
.... 9.74 MR Dosage Admission Intravenous
.... 9.75 MR Meta DataType
.... 9.76 Address Is Primary Extension
.... 9.77 ATSI Skin Extension
.... 9.78 Condition Active status as mentioned for a Family Member Extension
.... 9.79 Consent source reference extension
.... 9.80 CTG Co Payment Relief Extension
.... 9.81 DiagnosticReport note
.... 9.82 Encounter plannedEndDate
.... 9.83 Encounter plannedStartDate
.... 9.84 English As Second Language Indicator Extension
.... 9.85 Extemporaneous compounded medicines indicator extension
.... 9.86 Ingredient Strength as text
.... 9.87 Language Spoken At Home Extension
.... 9.88 Medication Dosage String Extension
.... 9.89 MediRecords Consent source reference extension
.... 9.90 MediRecords Medication Pack Size
.... 9.91 MediRecords Occupation Extension
.... 9.92 MediRecords Service Request Fasting
.... 9.93 MR Comment Note Extension
.... 9.94 MR DiagnosticReport Checked extension
.... 9.95 MR DiagnosticReport Recipient Interpretation extension
.... 9.96 MR DocumentReference Recipient Extension
.... 9.97 MR DocumentReference Title Extension
.... 9.98 MR Episode Number Sessions Extension
.... 9.99 MR Episode Priority Extension
.... 9.100 MR Episode Topic Extension
.... 9.101 MR Generic Recipient Extension
.... 9.102 MR Patient Note Extension
.... 9.103 MR Referenced Document Extension
.... 9.104 Note Extension with Name label
.... 9.105 Outbound Details
.... 9.106 Prescription Approval Status Extension
.... 9.107 Prescription Authority Details Extension
.... 9.108 Prescription CTG/PBS Copayment Extension
.... 9.109 Prescription Last Date Extension
.... 9.110 Prescription Type Extension
.... 9.111 Prescription Unusal Dose Extension
.... 9.112 Questionnaire Display Category
.... 9.113 RelatedPerson to contact Extension
.... 9.114 Result Copies To
.... 9.115 Vaccine Serial Number Extension
.... 9.116 Draft Prescription Priority ValueSet
.... 9.117 Draft Prescription Type ValueSet
.... 9.118 MediRecords Admission Attachment Categories ValueSet
.... 9.119 MediRecords Admission Encounter Class
.... 9.120 MediRecords Admission Encounter Location PhysicalType
.... 9.121 MediRecords Admission Encounter Status
.... 9.122 MediRecords Admission Note Category ValueSet
.... 9.123 MediRecords ATSI Skin Code ValueSet
.... 9.124 MediRecords Coverage Type ValueSet
.... 9.125 MediRecords Designation ValueSet
.... 9.126 MediRecords Diagnostic Report Status
.... 9.127 MediRecords Diagnostic Request BodySite ValueSet
.... 9.128 MediRecords Diagnostic Request Categories
.... 9.129 MediRecords DiagnosticReport Recipient Interpretation ValueSet
.... 9.130 MediRecords Document Reference Attachment Category
.... 9.131 MediRecords Document Reference Attachment Content Type
.... 9.132 MediRecords Document Reference Attachment Type
.... 9.133 MediRecords Document Reference Letter Attachment Type
.... 9.134 MediRecords Document Reference Letter Category
.... 9.135 MediRecords Document Reference Letter Type
.... 9.136 MediRecords DocumentReference Admission Type ValueSet
.... 9.137 MediRecords Dose and Rate Type ValueSet IV
.... 9.138 MediRecords Encounter Class ValueSet
.... 9.139 MediRecords Family Member Relationship Type ValueSet
.... 9.140 MediRecords Healthcare Organisation Role Type
.... 9.141 MediRecords Heart Rate Rhythm ValueSet
.... 9.142 MediRecords Industrial Classification ValueSet
.... 9.143 MediRecords Inpatient Handover Type ValueSet
.... 9.144 MediRecords Job Code ValueSet
.... 9.145 MediRecords Language Code ValueSet
.... 9.146 MediRecords Location Bed Status ValueSet
.... 9.147 MediRecords Location Physical Type ValueSet
.... 9.148 MediRecords Location Ward Specialty ValueSet
.... 9.149 MediRecords Medication Administration Performer Function ValueSet for Intravenous Infusion
.... 9.150 MediRecords Medication Administration Status ValueSet
.... 9.151 MediRecords Medication Administration Status ValueSet for Intravenous Infusion
.... 9.152 Medirecords Medication Request Admission Status Reason ValueSet
.... 9.153 MediRecords Medication Type ValueSet
.... 9.154 MediRecords MedicationAdministration Category ValueSet Admission
.... 9.155 MediRecords MedicationRequest Category ValueSet Admission
.... 9.156 MediRecords MedicationRequest Category ValueSet Consult
.... 9.157 MediRecords Occupations Classification ValueSet
.... 9.158 MediRecords Outbound Status ValueSet
.... 9.159 MediRecords Patient Contact Type ValueSet
.... 9.160 MediRecords Patient Ethnicity ValueSet
.... 9.161 MediRecords Patient Importance ValueSet
.... 9.162 MediRecords Patient's Name Title Code ValueSet
.... 9.163 MediRecords Progress Note Type ValueSet
.... 9.164 MediRecords Questionnaire Status ValueSet
.... 9.165 MediRecords Questionnaire UseContext Category ValueSet
.... 9.166 MediRecords QuestionnaireResponse Status ValueSet
.... 9.167 MediRecords Service Provider Type ValueSet
.... 9.168 Medirecords Temperature Body Site Valueset
.... 9.169 MediRecords Transfer Mode
.... 9.170 MediRecords Triage Priority
.... 9.171 MR Episode Type ValueSet
.... 9.172 Pregnancy Status
.... 9.173 Prescription Approval Status ValueSet
.... 9.174 Prescription Type ValueSet
.... 9.175 MediRecords ATSI Language CodeSystem
.... 9.176 MediRecords ATSI Skin CodeSystem
.... 9.177 MediRecords Bed Status CodeSystem
.... 9.178 MediRecords DocumentReference Category CodeSystem
.... 9.179 MediRecords Encounter Class CodeSystem
.... 9.180 MediRecords Job Type CodeSystem
.... 9.181 MediRecords Medication Administration Performer Function CodeSystem
.... 9.182 MediRecords Outbound Status
.... 9.183 MediRecords Patient Ethnicity CodeSystem
.... 9.184 MediRecords Patient Importance CodeSystem
.... 9.185 MediRecords Patient's Name Title CodeSystem
.... 9.186 MediRecords Questionnaire Use Context Type
.... 9.187 MediRecords Questionnaire Use Context Value
.... 9.188 MediRecords Recipient Interpretation CodeSystem
.... 9.189 MediRecords Service Provider Type CodeSystem
.... 9.190 MediRecords Transfer Mode
.... 9.191 MediRecords Ward Specialty CodeSystem
.... 9.192 MR Episode Type CodeSystem
.... 9.193 MR Identifier Type CodeSystem
.... 9.194 Prescription Approval Status CodeSystem
.... 9.195 Prescription Type CodeSystem
.... 9.196 AllergyIntolerance Category FHIR To MediRecords ConceptMap
.... 9.197 Country Code FHIR To MediRecords ConceptMap
.... 9.198 Patient Gender FHIR To MediRecords ConceptMap
.... 9.199 Patient Indigenous Status Australian Codes To MediRecords ConceptMap
.... 9.200 Practitioner Specialty AU To MediRecords ConceptMap
.... 9.201 Abrasion, hip Problem resolved Example
.... 9.202 Ambulatory Encounter Example
.... 9.203 Australian Health Service Organization Example
.... 9.204 Bad Request Error Example
.... 9.205 Bundle including matching Organization resources to indicate search result returned
.... 9.206 Bundle including matching Patient resources to indicate search result returned
.... 9.207 Bundle including OperationOutcome to indicate no search result returned
.... 9.208 Conflict Error Example
.... 9.209 Deleted resource read error example
.... 9.210 Diagnostic Imaging Report via Inbox with PDF attachment
.... 9.211 Diagnostic Imaging Report via Inbox, HTML display format not included
.... 9.212 Diagnostic Imaging Report via Secure Messaging
.... 9.213 Diagnostic Imaging Report with manually uploaded image
.... 9.214 Diagnostic Pathology Report uploaded in UI
.... 9.215 Diagnostic Pathology Report uploaded in UI
.... 9.216 Diagnostic Pathology Report via Secure Messaging
.... 9.217 Diagnostic Request Imaging
.... 9.218 Diagnostic Request Pathology
.... 9.219 Diarrhoea Diagnosis Example
.... 9.220 EpisodeOfCare example with contained CareTeam
.... 9.221 Example Discharge Summary DocumentReference Out from Admissions
.... 9.222 Example Document Reference Admission Handover Note
.... 9.223 Example Document Reference Admission Progress Note
.... 9.224 Example Document Reference Consent Attachment
.... 9.225 Example Document Reference Consult Attachment
.... 9.226 Example Document Reference Consultation with PDF attachment
.... 9.227 Example Document Reference In with no attachment
.... 9.228 Example Document Reference In with PDF attachment
.... 9.229 Example Document Reference Out with no attachment
.... 9.230 Example Document Reference Out with PDF attachment
.... 9.231 Example Document Reference Prescription with PDF attachment
.... 9.232 Example Document Reference Write with PDF attachment
.... 9.233 Example of a HealthcareService
.... 9.234 Example of a provider location
.... 9.235 Example of a usual doctor
.... 9.236 Example of a usual doctor
.... 9.237 Example of Admission Bed within a Room Location
.... 9.238 Example of Admission Bed within a Ward Location
.... 9.239 Example of Admission Room Location within a Ward
.... 9.240 Example of Admission Room Location within an Organization
.... 9.241 Example of Admission Ward Location
.... 9.242 Example of Consent
.... 9.243 Example of overseas provider location
.... 9.244 Example Practitioner with prescriber number
.... 9.245 External Health Professional Contact
.... 9.246 Falls Risk Assessment Questionnaire
..... 9.246.1 ValueSet
..... 9.246.2 ValueSet
..... 9.246.3 ValueSet
.... 9.247 Forbidden Error Example
.... 9.248 General Practice Organization Example
.... 9.249 Generic Condition Consultation Example
.... 9.250 Generic Observation Hip Measurement Example
.... 9.251 High Temperature Condition Example
.... 9.252 Immunisation Administered Example
.... 9.253 Internal Server Error Example
.... 9.254 Lost apetite Condition Consultation Example
.... 9.255 lost apetite Condition Example
.... 9.256 Medication Example with brand, strength and pack size
.... 9.257 Medication product with amt code and medication-strength extension
.... 9.258 MediRecords Admission Intravenous Infusion Example with Additive and Bolus dose
.... 9.259 MediRecords Admission Intravenous Infusion Example, no Additive and no Bolus dose
.... 9.260 MediRecords Admission Once Only and Immediate Prescription Example
.... 9.261 MediRecords Admission Once Only, Telephone Order Prescription Example
.... 9.262 MediRecords Admission Pre-hospital Prescription Example
.... 9.263 MediRecords Admission Pre-hospital Prescription Example, minimal
.... 9.264 MediRecords Admission PRN Prescription Example
.... 9.265 MediRecords Admission Regular Prescription Ceased Example
.... 9.266 MediRecords Admission Regular Prescription Example
.... 9.267 MediRecords Allergy on Specific Product Example
.... 9.268 MediRecords ATSI Patient
.... 9.269 MediRecords Diagnostic Request Fulfillment Task
.... 9.270 MediRecords Draft Prescription Example for a Recipe
.... 9.271 MediRecords Draft Prescription Example with amt and pbs codes and minimal fields provided
.... 9.272 MediRecords Draft Prescription Example with amt and pbs codes with all supported fields
.... 9.273 MediRecords Draft Prescription Example with amt code only and minimal fields provided
.... 9.274 MediRecords Drug Class Allergy Example
.... 9.275 Medirecords FamilyMemberHistory Example
.... 9.276 MediRecords General Patient
.... 9.277 MediRecords Ingredient Allergy Example
.... 9.278 MediRecords Medication Administered Example
.... 9.279 MediRecords Medication Infusion End Example
.... 9.280 MediRecords Medication Infusion Start Example
.... 9.281 MediRecords Medication Not Given Example
.... 9.282 MediRecords Non-Drug Allergy Example
.... 9.283 MediRecords Other Allergy Example
.... 9.284 MediRecords Patient with contacts
.... 9.285 MediRecords Prescription Example with medication dosage instruction
.... 9.286 MediRecords Prescription with a Delivery Service Prescribing Identifier Example
.... 9.287 MediRecords RelatedPerson Example
.... 9.288 MediRecords stopped Prescription Example
.... 9.289 Method Not Allowed Error Example
.... 9.290 MR Admissions Emergency Encounter Admitted Example
.... 9.291 MR Admissions Emergency Encounter Cancelled Example
.... 9.292 MR Admissions Emergency Encounter Discharge Example
.... 9.293 MR Admissions Planned Encounter Admitted Example
.... 9.294 MR Admissions Planned Encounter Cancelled Example
.... 9.295 MR Admissions Planned Encounter Discharged Example
.... 9.296 MR Admissions Planned Encounter Discharged/Transferred to Another Facility Example
.... 9.297 MR Admissions Planned Encounter Pre-admitted Example
.... 9.298 MR Admissions Urgent Encounter Admitted Example
.... 9.299 MR Admissions Urgent Encounter Cancelled Example
.... 9.300 MR Admissions Urgent Encounter Discharge Example
.... 9.301 MR Allergy Intolerance No Known Allergy
.... 9.302 Not Found Error Example
.... 9.303 Observation Panel General Examination Example
.... 9.304 Observation Panel Vital Sign Example
.... 9.305 Organization AU Service Provider Example
.... 9.306 Organization HealthCare Provider Example
.... 9.307 Organization Service Provider Example
.... 9.308 Overseas Health Service Organization Example
.... 9.309 Overseas Organisation Service Provider Example
.... 9.310 Precondition Failed Error Example
.... 9.311 Primary GP Practice Example
.... 9.312 Secondary GP Practice Example
.... 9.313 Specific Mental Health Screening Consultation
.... 9.314 The request has been accepted for processing example
.... 9.315 Unauthorized Error Example
.... 9.316 Unprocessable Entity Error Example
.... 9.317 Unprocessable Patient resource Error Example
.... 9.318 Uploaded Diagnostic Pathology Report linked to request
.... 9.319 Vital Sign Body Height Example
.... 9.320 Vital Sign Body Length Example
.... 9.321 Vital Sign Body Mass Index Example
.... 9.322 Vital Sign Body Temperature Example
.... 9.323 Vital Sign Body Weight Example
.... 9.324 Vital Sign Head Circumference Example
.... 9.325 Vital Sign Heart Rate Example
.... 9.326 Vital Sign Heart Rate Example with component Heart Rate Rhythm
.... 9.327 Vital Sign Lying Blood Pressure Example
.... 9.328 Vital Sign Oxygen Saturation Example
.... 9.329 Vital Sign Respiratory Rate Example
.... 9.330 Vital Sign Sitting Blood Pressure Example
.... 9.331 Vital Sign Standing Blood Pressure Example
.... 9.332 Waist Measurement Example
.... 9.333 Webhook Bundle for allergy-intolerance.created event
.... 9.334 Webhook Bundle for condition.created event
.... 9.335 Webhook Bundle for consent.created event
.... 9.336 Webhook Bundle for diagnostic-report.created event
.... 9.337 Webhook Bundle for diagnostic-report.deleted event
.... 9.338 Webhook Bundle for diagnostic-request.created event
.... 9.339 Webhook Bundle for document-reference-admission.created event for DocumentReference Admission
.... 9.340 Webhook Bundle for document-reference-attachment.create event for DocumentReference Consultation Attachment
.... 9.341 Webhook Bundle for document-reference.created event for DocumentReference In
.... 9.342 Webhook Bundle for document-reference.created event for DocumentReference Out
.... 9.343 Webhook Bundle for document-reference.created event for DocumentReference Out
.... 9.344 Webhook Bundle for encounter-admission.created event
.... 9.345 Webhook Bundle for encounter.created event
.... 9.346 Webhook Bundle for episode-of-care.created event
.... 9.347 Webhook Bundle for familymemberhistory.created event
.... 9.348 Webhook Bundle for immunization.created event
.... 9.349 Webhook Bundle for medication-administration-admission.created event in Admissions
.... 9.350 Webhook Bundle for medication-administration-admission.created event in Admissions Intravenous Infusion Chart
.... 9.351 Webhook Bundle for medication-request-admission.created event in Admissions
.... 9.352 Webhook Bundle for medication-request-admission.created event in Admissions Intravenous Infusion Chart
.... 9.353 Webhook Bundle for medication-request.created event
.... 9.354 Webhook Bundle for observation.created event - general examination panel
.... 9.355 Webhook Bundle for observation.created event - vital signs
.... 9.356 Webhook Bundle for observation.created event - vital signs - no clinical template
.... 9.357 Webhook Bundle for observation.created event - vital signs panel
.... 9.358 Webhook Bundle for observation.deleted event from admission clinical charts (ADDS, Neurovascular, Fluid Dynamics)
.... 9.359 Webhook Bundle for observation.deleted event from clinical template
.... 9.360 Webhook Bundle for patient.created event
.... 9.361 Webhook Bundle for patient.deleted event
.... 9.362 Wrist Pain Condition as Text Example
.... 9.363 Example Condition - 9bf648c6-20b9-11ec-9621-0242ac130006
.... 9.364 Example Observation - 1e5cae20-85bf-11s8-b401-ffccd711ad9g
.... 9.365 Example Observation - 2c870f5b-b88b-4d85-9ef7-5e70990b7ce4
.... 9.366 Example PractitionerRole - 6d6d7ce8-65c2-11e9-a20e-7b5deed40056