Australian Digital Health Agency FHIR Implementation Guide
1.2.0-ci-build - draft
Australian Digital Health Agency FHIR Implementation Guide, published by Australian Digital Health Agency. This guide is not an authorized publication; it is the continuous build for version 1.2.0-ci-build built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/AuDigitalHealth/ci-fhir-r4/ and changes regularly. See the Directory of published versions
{
"resourceType" : "DocumentReference",
"id" : "air-01",
"meta" : // Created DocumentReference from 'data in' Bundle | Post from Medicare repository to MHR
// DocumentReference for the set of resources that make up the AIR for Patient Sally FIELD IHI 8003608833357361
{
"profile" : [
🔗 "http://ns.electronichealth.net.au/fhir/StructureDefinition/dh-documentreference-core-1"
]
},
"text" : {
"status" : "generated",
"div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p class=\"res-header-id\"><b>Generated Narrative: DocumentReference air-01</b></p><a name=\"air-01\"> </a><a name=\"hcair-01\"> </a><a name=\"air-01-en-AU\"> </a><p><b>masterIdentifier</b>: <a href=\"http://terminology.hl7.org/5.0.0/NamingSystem-uri.html\" title=\"As defined by RFC 3986 (http://www.ietf.org/rfc/rfc3986.txt)(with many schemes defined in many RFCs). For OIDs and UUIDs, use the URN form (urn:oid:(note: lowercase) and urn:uuid:). See http://www.ietf.org/rfc/rfc3001.txt and http://www.ietf.org/rfc/rfc4122.txt \r\n\r\nThis oid is used as an identifier II.root to indicate the the extension is an absolute URI (technically, an IRI). Typically, this is used for OIDs and GUIDs. Note that when this OID is used with OIDs and GUIDs, the II.extension should start with urn:oid or urn:uuid: \r\n\r\nNote that this OID is created to aid with interconversion between CDA and FHIR - FHIR uses urn:ietf:rfc:3986 as equivalent to this OID. URIs as identifiers appear more commonly in FHIR.\r\n\r\nThis OID may also be used in CD.codeSystem.\">URI</a>/urn:uuid:475db616-dfd5-43f3-b935-9f582233a38d</p><p><b>identifier</b>: <a href=\"http://terminology.hl7.org/5.0.0/NamingSystem-uri.html\" title=\"As defined by RFC 3986 (http://www.ietf.org/rfc/rfc3986.txt)(with many schemes defined in many RFCs). For OIDs and UUIDs, use the URN form (urn:oid:(note: lowercase) and urn:uuid:). See http://www.ietf.org/rfc/rfc3001.txt and http://www.ietf.org/rfc/rfc4122.txt \r\n\r\nThis oid is used as an identifier II.root to indicate the the extension is an absolute URI (technically, an IRI). Typically, this is used for OIDs and GUIDs. Note that when this OID is used with OIDs and GUIDs, the II.extension should start with urn:oid or urn:uuid: \r\n\r\nNote that this OID is created to aid with interconversion between CDA and FHIR - FHIR uses urn:ietf:rfc:3986 as equivalent to this OID. URIs as identifiers appear more commonly in FHIR.\r\n\r\nThis OID may also be used in CD.codeSystem.\">URI</a>/urn:uuid:475db616-dfd5-43f3-b935-9f582233a38d</p><p><b>status</b>: Current</p><p><b>docStatus</b>: Final</p><p><b>type</b>: <span title=\"Codes:{https://healthterminologies.gov.au/fhir/CodeSystem/nctis-data-components-1 100.17042}\">Australian Immunisation Register</span></p><p><b>category</b>: <span title=\"Codes:{https://healthterminologies.gov.au/fhir/CodeSystem/nctis-data-components-1 100.17042}\">Australian Immunisation Register</span></p><p><b>subject</b>: <a href=\"Patient-mhr-field-sally.html\">Sally FIELD Female, DoB: 1999-02-14 ( National unique individual identifier: AustalianIHI#8003608333563104\u00a0(use:\u00a0official,\u00a0))</a></p><p><b>date</b>: 2022-02-15 01:02:00+1000</p><p><b>author</b>: <a href=\"Device-medicare-rs-01.html\">Device: identifier = PAI-D:\u00a0PAID#8003640003000018; type = Medicare register system</a></p><p><b>custodian</b>: <a href=\"Organization-medicare-rs-operator.html\">Organization Medicare Australia repository services operator</a></p><blockquote><p><b>content</b></p><h3>Attachments</h3><table class=\"grid\"><tr><td style=\"display: none\">-</td><td><b>Language</b></td><td><b>Url</b></td></tr><tr><td style=\"display: none\">*</td><td>English (Region=Australia)</td><td><a href=\"http://example.org/mhr/xds/mhd/Binary/b4f868e7-adc8-47b6-9f4e-002315b8e587\">http://example.org/mhr/xds/mhd/Binary/b4f868e7-adc8-47b6-9f4e-002315b8e587</a></td></tr></table></blockquote><blockquote><p><b>context</b></p><p><b>sourcePatientInfo</b>: Identifier: IHI/8003608000228437</p><p><b>related</b>: </p><ul><li><a href=\"http://example.org/mhr/xds/mhd/Flag/475db616-dfd5-43f3-b935-9f582233a38d.1\">http://example.org/mhr/xds/mhd/Flag/475db616-dfd5-43f3-b935-9f582233a38d.1</a></li><li><a href=\"http://example.org/mhr/xds/mhd/Immunization/475db616-dfd5-43f3-b935-9f582233a38d.1\">http://example.org/mhr/xds/mhd/Immunization/475db616-dfd5-43f3-b935-9f582233a38d.1</a></li><li><a href=\"http://example.org/mhr/xds/mhd/Immunization/475db616-dfd5-43f3-b935-9f582233a38d.3\">http://example.org/mhr/xds/mhd/Immunization/475db616-dfd5-43f3-b935-9f582233a38d.3</a></li><li><a href=\"http://example.org/mhr/xds/mhd/Immunization/475db616-dfd5-43f3-b935-9f582233a38d.4\">http://example.org/mhr/xds/mhd/Immunization/475db616-dfd5-43f3-b935-9f582233a38d.4</a></li><li><a href=\"http://example.org/mhr/xds/mhd/Immunization/475db616-dfd5-43f3-b935-9f582233a38d.5\">http://example.org/mhr/xds/mhd/Immunization/475db616-dfd5-43f3-b935-9f582233a38d.5</a></li><li><a href=\"http://example.org/mhr/xds/mhd/Immunization/475db616-dfd5-43f3-b935-9f582233a38d.6\">http://example.org/mhr/xds/mhd/Immunization/475db616-dfd5-43f3-b935-9f582233a38d.6</a></li><li><a href=\"http://example.org/mhr/xds/mhd/Immunization/475db616-dfd5-43f3-b935-9f582233a38d.7\">http://example.org/mhr/xds/mhd/Immunization/475db616-dfd5-43f3-b935-9f582233a38d.7</a></li><li><a href=\"http://example.org/mhr/xds/mhd/Immunization/475db616-dfd5-43f3-b935-9f582233a38d.8\">http://example.org/mhr/xds/mhd/Immunization/475db616-dfd5-43f3-b935-9f582233a38d.8</a></li><li><a href=\"http://example.org/mhr/xds/mhd/Immunization/475db616-dfd5-43f3-b935-9f582233a38d.9\">http://example.org/mhr/xds/mhd/Immunization/475db616-dfd5-43f3-b935-9f582233a38d.9</a></li><li><a href=\"http://example.org/mhr/xds/mhd/Immunization/475db616-dfd5-43f3-b935-9f582233a38d.10\">http://example.org/mhr/xds/mhd/Immunization/475db616-dfd5-43f3-b935-9f582233a38d.10</a></li><li><a href=\"http://example.org/mhr/xds/mhd/Immunization/475db616-dfd5-43f3-b935-9f582233a38d.11\">http://example.org/mhr/xds/mhd/Immunization/475db616-dfd5-43f3-b935-9f582233a38d.11</a></li><li><a href=\"http://example.org/mhr/xds/mhd/Immunization/475db616-dfd5-43f3-b935-9f582233a38d.12\">http://example.org/mhr/xds/mhd/Immunization/475db616-dfd5-43f3-b935-9f582233a38d.12</a></li><li><a href=\"http://example.org/mhr/xds/mhd/Immunization/475db616-dfd5-43f3-b935-9f582233a38d.13\">http://example.org/mhr/xds/mhd/Immunization/475db616-dfd5-43f3-b935-9f582233a38d.13</a></li><li><a href=\"http://example.org/mhr/xds/mhd/Immunization/475db616-dfd5-43f3-b935-9f582233a38d.14\">http://example.org/mhr/xds/mhd/Immunization/475db616-dfd5-43f3-b935-9f582233a38d.14</a></li></ul></blockquote></div>"
},
"masterIdentifier" : {
"system" : "urn:ietf:rfc:3986",
"value" : "urn:uuid:475db616-dfd5-43f3-b935-9f582233a38d"
},
"identifier" : [
{
"system" : "urn:ietf:rfc:3986",
"value" : "urn:uuid:475db616-dfd5-43f3-b935-9f582233a38d"
}
],
"status" : "current",
"docStatus" : "final",
"type" : {
"coding" : [
{
"system" : "https://healthterminologies.gov.au/fhir/CodeSystem/nctis-data-components-1",
"code" : "100.17042",
"display" : "Australian Immunisation Register"
}
]
},
"category" : [
{
"coding" : [
{
"system" : "https://healthterminologies.gov.au/fhir/CodeSystem/nctis-data-components-1",
"code" : "100.17042",
"display" : "Australian Immunisation Register"
}
]
}
],
"subject" : {
🔗 "reference" : "Patient/mhr-field-sally",
"identifier" : // Assume local record number will be used here instead of IHI
{
"type" : {
"coding" : [
{
"system" : "http://terminology.hl7.org/CodeSystem/v2-0203",
"code" : "NI",
"display" : "National unique individual identifier"
}
],
"text" : "IHI"
},
"system" : "http://ns.electronichealth.net.au/id/hi/ihi/1.0",
"value" : "8003608833357361"
}
},
"date" : "2022-02-15T01:02:00+10:00",
"author" : [
// Instant this DocumentReference was created from the uploaded the Bundle | resource
{
🔗 "reference" : "Device/medicare-rs-01"
}
],
"custodian" : {
🔗 "reference" : "Organization/medicare-rs-operator"
},
"content" : [
{
"attachment" : // Assumption that a Binary of the original upload is persisted
{
"language" : "en-AU",
"url" : "http://example.org/mhr/xds/mhd/Binary/b4f868e7-adc8-47b6-9f4e-002315b8e587"
}
}
],
"context" : {
"sourcePatientInfo" : {
"identifier" : {
"type" : {
"coding" : [
{
"system" : "http://terminology.hl7.org/CodeSystem/v2-0203",
"code" : "NI"
}
],
"text" : "IHI"
},
"system" : "http://ns.electronichealth.net.au/id/hi/ihi/1.0",
"value" : "8003608000228437"
}
},
"related" : [
// RELATED RESOURCES - REFERENCING INDIVIDUAL RESOURCES ACROSS THE DB THAT MAKE UP THIS 'DOCUMENT'
// The url identifier scheme used below is nonsense should be replaced with the real scheme. The nonsense convention is document identifier (i.e. Bundle.identifier) + integer
// There is no related reference for a Patient record as this is not persisted - MHR Master Patient record is maintained and when a view or other output is
generated that generation process is to generate a fresh Patient resource according to current data and business rules
{
"reference" : "http://example.org/mhr/xds/mhd/Flag/475db616-dfd5-43f3-b935-9f582233a38d.1"
},
// reference for Flag/air-02
{
"reference" : "http://example.org/mhr/xds/mhd/Immunization/475db616-dfd5-43f3-b935-9f582233a38d.1"
},
// reference for Immunization/air-covid-01
{
"reference" : "http://example.org/mhr/xds/mhd/Immunization/475db616-dfd5-43f3-b935-9f582233a38d.3"
},
// reference for Immunization/air-covid-02
{
"reference" : "http://example.org/mhr/xds/mhd/Immunization/475db616-dfd5-43f3-b935-9f582233a38d.4"
},
// reference for Immunization/air-covid-03
{
"reference" : "http://example.org/mhr/xds/mhd/Immunization/475db616-dfd5-43f3-b935-9f582233a38d.5"
},
// reference for Immunization/air-hepb-01
{
"reference" : "http://example.org/mhr/xds/mhd/Immunization/475db616-dfd5-43f3-b935-9f582233a38d.6"
},
// reference for Immunization/air-dip-01
{
"reference" : "http://example.org/mhr/xds/mhd/Immunization/475db616-dfd5-43f3-b935-9f582233a38d.7"
},
// reference for Immunization/air-dip-02
{
"reference" : "http://example.org/mhr/xds/mhd/Immunization/475db616-dfd5-43f3-b935-9f582233a38d.8"
},
// reference for Immunization/air-dip-03
{
"reference" : "http://example.org/mhr/xds/mhd/Immunization/475db616-dfd5-43f3-b935-9f582233a38d.9"
},
// reference for Immunization/air-dip-04
{
"reference" : "http://example.org/mhr/xds/mhd/Immunization/475db616-dfd5-43f3-b935-9f582233a38d.10"
},
// reference for Immunization/air-dip-05
{
"reference" : "http://example.org/mhr/xds/mhd/Immunization/475db616-dfd5-43f3-b935-9f582233a38d.11"
},
// reference for Immunization/air-infl-01
{
"reference" : "http://example.org/mhr/xds/mhd/Immunization/475db616-dfd5-43f3-b935-9f582233a38d.12"
},
// reference for Immunization/air-infl-02
{
"reference" : "http://example.org/mhr/xds/mhd/Immunization/475db616-dfd5-43f3-b935-9f582233a38d.13"
},
// reference for Immunization/air-infl-03
{
"reference" : "http://example.org/mhr/xds/mhd/Immunization/475db616-dfd5-43f3-b935-9f582233a38d.14"
}
]
}
}IG © 2023+ Australian Digital Health Agency. Package au.digitalhealth.r4#1.2.0-ci-build based on FHIR 4.0.1. Generated 2024-12-19
Links: Table of Contents | QA Report | Version History | Report an issue or propose a change
