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