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