Australian Digital Health Agency FHIR Implementation Guide
1.2.0-ci-build - draft
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
<Bundle xmlns="http://hl7.org/fhir">
<id value="ncspv-doc-03"/>
<!-- Bundle for 'data out' from MHR to CIS -->
<meta>
<lastUpdated value="2022-02-15T07:15:15+10:00"/>
<profile
value="http://ns.electronichealth.net.au/fhir/StructureDefinition/dh-bundle-document-1"/>
</meta>
<identifier>
<system value="urn:ietf:rfc:3986"/>
<value value="urn:uuid:bc7db961-b74e-4f76-955d-8948d14cee24"/>
</identifier>
<type value="document"/>
<timestamp value="2022-05-16T13:45:15+10:00"/>
<!-- COMPOSITION -->
<entry>
<fullUrl value="urn:uuid:3f25cb71-1ecc-406d-94fc-012308834145"/>
<resource>
<Composition>
<id value="ncspv-03"/>
<meta>
<profile
value="http://ns.electronichealth.net.au/fhir/StructureDefinition/dh-composition-document-1"/>
</meta>
<language value="en-AU"/>
<!-- Workaround to trigger IG Publisher generated narrative -->
<text>
<status value="generated"/>
<div xmlns="http://www.w3.org/1999/xhtml" xml:lang="en-AU" lang="en-AU">
<h1>National Cancer Screening Register Program View</h1>
<h3>16/02/2022 | 01:45 PM | My Health Record</h3>
<p><b>View metadata</b>: id: urn:uuid:75e5fe3d-7520-4a74-8eff-ab39f148c835s <b>status</b>: final</p>
</div>
</text>
<identifier>
<system value="urn:ietf:rfc:3986"/>
<value value="urn:uuid:75e5fe3d-7520-4a74-8eff-ab39f148c835"/>
</identifier>
<status value="final"/>
<type>
<coding>
<system
value="https://healthterminologies.gov.au/fhir/CodeSystem/nctis-data-components-1"/>
<code value="100.32040"/>
<display
value="National Cancer Screening Program Participation View"/>
</coding>
</type>
<category>
<coding>
<system
value="https://healthterminologies.gov.au/fhir/CodeSystem/nctis-data-components-1"/>
<code value="100.32039"/>
<display value="Disease Screening Program Participation Record"/>
</coding>
</category>
<subject>
<reference value="urn:uuid:5262f368-8f3e-43ae-be0f-f54541d4329e"/>
<identifier>
<type>
<coding>
<system
value="http://terminology.hl7.org/CodeSystem/v2-0203"/>
<code value="NI"/>
<display value="National unique individual identifier"/>
</coding>
<text value="IHI"/>
</type>
<system value="http://ns.electronichealth.net.au/id/hi/ihi/1.0"/>
<value value="8003608000228437"/>
</identifier>
</subject>
<date value="2022-05-16T13:45:15+10:00"/>
<author>
<reference value="urn:uuid:12247b36-1383-42ca-abb4-daa0ebbd82d2"/>
<identifier>
<type>
<coding>
<system
value="http://terminology.hl7.org.au/CodeSystem/v2-0203"/>
<code value="NDI"/>
<display value="National Device Identifier"/>
</coding>
<text value="PAI-D"/>
</type>
<system
value="http://ns.electronichealth.net.au/id/pcehr/paid/1.0"/>
<value value="8003640003000026"/>
</identifier>
</author>
<title value="National Cancer Screening Register Program View"/>
<custodian>
<reference value="urn:uuid:d0bc0370-08f3-4b6d-b32d-e463535982f7"/>
<identifier>
<type>
<coding>
<system
value="http://terminology.hl7.org.au/CodeSystem/v2-0203"/>
<code value="NOI"/>
<display value="National Organisation Identifier"/>
</coding>
<text value="PAI-O"/>
</type>
<system
value="http://ns.electronichealth.net.au/id/pcehr/paio/1.0"/>
<value value="8003640001000036"/>
</identifier>
</custodian>
<section>
<title value="Programs"/>
<code>
<coding>
<system
value="https://healthterminologies.gov.au/fhir/CodeSystem/nctis-data-components-1"/>
<code value="101.32046"/>
<display value="Health Program Information"/>
</coding>
</code>
<text>
<status value="generated"/>
<div xmlns="http://www.w3.org/1999/xhtml">
<table style="border-collapse:collapse;border-spacing:0;width:100%;">
<caption>National Bowel Cancer Screening Program Participation</caption>
<tr>
<th style="border-collapse:collapse;border-spacing:0;font-family:Arial, sans-serif;font-size:14px;font-weight:normal;padding:10px 5px;border-style:solid;border-width:1px;overflow:hidden;word-break:normal;border-color:black;font-weight:bold;background-color:#9b9b9b;border-color:#000000;text-align:left;vertical-align:top">Participant Status</th>
<th style="border-collapse:collapse;border-spacing:0;font-family:Arial, sans-serif;font-size:14px;font-weight:normal;padding:10px 5px;border-style:solid;border-width:1px;overflow:hidden;word-break:normal;border-color:black;font-weight:bold;background-color:#9b9b9b;border-color:#000000;text-align:left;vertical-align:top">Participant Status Period</th>
<th style="border-collapse:collapse;border-spacing:0;font-family:Arial, sans-serif;font-size:14px;font-weight:normal;padding:10px 5px;border-style:solid;border-width:1px;overflow:hidden;word-break:normal;border-color:black;font-weight:bold;background-color:#9b9b9b;border-color:#000000;text-align:left;vertical-align:top">Defer flag</th>
<th style="border-collapse:collapse;border-spacing:0;font-family:Arial, sans-serif;font-size:14px;font-weight:normal;padding:10px 5px;border-style:solid;border-width:1px;overflow:hidden;word-break:normal;border-color:black;font-weight:bold;background-color:#9b9b9b;border-color:#000000;text-align:left;vertical-align:top">Next Action</th>
</tr>
<tr>
<td style="border-collapse:collapse;border-spacing:0;font-family:Arial, sans-serif;font-size:14px;padding:10px 5px;border-style:solid;border-width:1px;overflow:hidden;word-break:normal;border-color:black;border-color:#000000;text-align:left;vertical-align:top">New to Screening</td>
<td style="border-collapse:collapse;border-spacing:0;font-family:Arial, sans-serif;font-size:14px;padding:10px 5px;border-style:solid;border-width:1px;overflow:hidden;word-break:normal;border-color:black;border-color:#000000;text-align:left;vertical-align:top">05/02/2022 to 05/08/2022</td>
<td style="border-collapse:collapse;border-spacing:0;font-family:Arial, sans-serif;font-size:14px;padding:10px 5px;border-style:solid;border-width:1px;overflow:hidden;word-break:normal;border-color:black;border-color:#000000;text-align:left;vertical-align:top">Yes</td>
<td style="border-collapse:collapse;border-spacing:0;font-family:Arial, sans-serif;font-size:14px;padding:10px 5px;border-style:solid;border-width:1px;overflow:hidden;word-break:normal;border-color:black;border-color:#000000;text-align:left;vertical-align:top">Due Now (eligible since 50th birthday)</td>
</tr>
</table>
</div>
</text>
<entry>
<reference value="urn:uuid:c722b26d-cbde-4a61-9d73-de71e117dcfd"/>
</entry>
</section>
</Composition>
</resource>
</entry>
<!-- PATIENT -->
<entry>
<fullUrl value="urn:uuid:5262f368-8f3e-43ae-be0f-f54541d4329e"/>
<resource>
<Patient>
<id value="mhr-zhang-wei"/>
<text>
<status value="generated"/>
<div xmlns="http://www.w3.org/1999/xhtml">
<h3>
<b>Mr Zhang Wei</b>
</h3>
<p>
<b>IHI:</b> 8003608000228437 <b>Medicare Number:</b> 29533070311
</p>
<p>
<b>Date Of Birth:</b> 1972-05-03
</p>
<p>
<b>Country of Birth:</b> China <b>Year of Arrival:</b> 2017
</p>
<p>
<b>Indigenous Status:</b> Neither Aboriginal nor Torres Strait Islander origin
</p>
<p>
<b>Interpreter Required?</b> Yes <b>Preferred Language:</b> Cantonese (yue)
</p>
</div>
</text>
<extension
url="http://hl7.org/fhir/StructureDefinition/patient-birthPlace">
<valueAddress>
<text value="China"/>
<country value="CHN"/>
</valueAddress>
</extension>
<extension
url="http://hl7.org.au/fhir/StructureDefinition/indigenous-status">
<valueCoding>
<system
value="https://healthterminologies.gov.au/fhir/CodeSystem/australian-indigenous-status-1"/>
<code value="4"/>
<display
value="Neither Aboriginal nor Torres Strait Islander origin"/>
</valueCoding>
</extension>
<extension
url="http://hl7.org/fhir/StructureDefinition/patient-interpreterRequired">
<valueBoolean value="true"/>
</extension>
<extension
url="http://hl7.org.au/fhir/StructureDefinition/date-of-arrival">
<valueDate value="2017"/>
</extension>
<identifier>
<extension
url="http://hl7.org.au/fhir/StructureDefinition/ihi-status">
<valueCoding>
<system
value="https://healthterminologies.gov.au/fhir/CodeSystem/ihi-status-1"/>
<code value="active"/>
</valueCoding>
</extension>
<extension
url="http://hl7.org.au/fhir/StructureDefinition/ihi-record-status">
<valueCoding>
<system
value="https://healthterminologies.gov.au/fhir/CodeSystem/ihi-record-status-1"/>
<code value="verified"/>
<display value="verified"/>
</valueCoding>
</extension>
<type>
<coding>
<system value="http://terminology.hl7.org/CodeSystem/v2-0203"/>
<code value="NI"/>
</coding>
<text value="IHI"/>
</type>
<system value="http://ns.electronichealth.net.au/id/hi/ihi/1.0"/>
<value value="8003608000228437"/>
</identifier>
<identifier>
<type>
<coding>
<system value="http://terminology.hl7.org/CodeSystem/v2-0203"/>
<code value="MC"/>
</coding>
<text value="Medicare Number"/>
</type>
<system
value="http://ns.electronichealth.net.au/id/medicare-number"/>
<value value="29533070311"/>
</identifier>
<name>
<family value="Zhang"/>
<given value="Wei"/>
<prefix value="Mr"/>
</name>
<gender value="male"/>
<birthDate value="1972-05-03">
<extension
url="http://hl7.org.au/fhir/StructureDefinition/date-accuracy-indicator">
<valueCoding>
<system
value="https://healthterminologies.gov.au/fhir/CodeSystem/date-accuracy-indicator-1"/>
<code value="AAA"/>
<display value="Day, month and year are accurate"/>
</valueCoding>
</extension>
</birthDate>
<communication>
<language>
<coding>
<system value="urn:ietf:bcp:47"/>
<code value="yue"/>
</coding>
<text value="Cantonese"/>
</language>
<preferred value="true"/>
</communication>
</Patient>
</resource>
</entry>
<!-- DEVICE MHR -->
<entry>
<fullUrl value="urn:uuid:12247b36-1383-42ca-abb4-daa0ebbd82d2"/>
<resource>
<Device>
<id value="mhr-01"/>
<text>
<status value="generated"/>
<div xmlns="http://www.w3.org/1999/xhtml"><a name="Device_mhr-01"> </a><p class="res-header-id"><b>Generated Narrative: Device mhr-01</b></p><a name="mhr-01"> </a><a name="hcmhr-01"> </a><a name="mhr-01-en-AU"> </a><p><b>identifier</b>: PAI-D/8003640003000026</p><h3>DeviceNames</h3><table class="grid"><tr><td style="display: none">-</td><td><b>Name</b></td><td><b>Type</b></td></tr><tr><td style="display: none">*</td><td>My Health Record system</td><td>other</td></tr></table><p><b>type</b>: <span title="Codes:{http://snomed.info/sct 1084991000168108}">My Health Record system</span></p><p><b>owner</b>: <a href="Bundle-ncspv-doc-03.html#urn-uuid-d0bc0370-08f3-4b6d-b32d-e463535982f7">Bundle: identifier = UUID:bc7db961-b74e-4f76-955d-8948d14cee24; type = document; timestamp = 2022-05-16 13:45:15+1000</a></p></div>
</text>
<identifier>
<type>
<coding>
<system
value="http://terminology.hl7.org.au/CodeSystem/v2-0203"/>
<code value="NDI"/>
<display value="National Device Identifier"/>
</coding>
<text value="PAI-D"/>
</type>
<system
value="http://ns.electronichealth.net.au/id/pcehr/paid/1.0"/>
<value value="8003640003000026"/>
</identifier>
<deviceName>
<name value="My Health Record system"/>
<type value="other"/>
</deviceName>
<type>
<coding>
<system value="http://snomed.info/sct"/>
<code value="1084991000168108"/>
<display value="My Health Record system"/>
</coding>
<text value="My Health Record system"/>
</type>
<owner>
<reference value="urn:uuid:d0bc0370-08f3-4b6d-b32d-e463535982f7"/>
</owner>
</Device>
</resource>
</entry>
<!-- ORGANIZATION MHR -->
<entry>
<fullUrl value="urn:uuid:d0bc0370-08f3-4b6d-b32d-e463535982f7"/>
<resource>
<Organization>
<id value="mhr-operator"/>
<text>
<status value="generated"/>
<div xmlns="http://www.w3.org/1999/xhtml"><a name="Organization_mhr-operator"> </a><p class="res-header-id"><b>Generated Narrative: Organization mhr-operator</b></p><a name="mhr-operator"> </a><a name="hcmhr-operator"> </a><a name="mhr-operator-en-AU"> </a><p><b>identifier</b>: PAI-O/8003640001000036</p><p><b>name</b>: My Health Record system operator</p></div>
</text>
<identifier>
<type>
<coding>
<system
value="http://terminology.hl7.org.au/CodeSystem/v2-0203"/>
<code value="NOI"/>
<display value="National Organisation Identifier"/>
</coding>
<text value="PAI-O"/>
</type>
<system
value="http://ns.electronichealth.net.au/id/pcehr/paio/1.0"/>
<value value="8003640001000036"/>
</identifier>
<name value="My Health Record system operator"/>
</Organization>
</resource>
</entry>
<!-- ORGANIZATION NCSR -->
<entry>
<fullUrl value="urn:uuid:eaadd89b-cded-4872-a1ff-d1230e9e7495"/>
<resource>
<Organization>
<id value="ncsr-operator"/>
<text>
<status value="generated"/>
<div xmlns="http://www.w3.org/1999/xhtml"><a name="Organization_ncsr-operator"> </a><p class="res-header-id"><b>Generated Narrative: Organization ncsr-operator</b></p><a name="ncsr-operator"> </a><a name="hcncsr-operator"> </a><a name="ncsr-operator-en-AU"> </a><p><b>identifier</b>: PAI-O/TBD</p><p><b>name</b>: National Cancer Screening Register system operator</p><p><b>partOf</b>: <a href="Bundle-ncspv-doc-03.html#urn-uuid-a73db507-e5ed-4865-a20e-45062fb2c7f4">Bundle: identifier = UUID:bc7db961-b74e-4f76-955d-8948d14cee24; type = document; timestamp = 2022-05-16 13:45:15+1000</a></p></div>
</text>
<identifier>
<type>
<coding>
<system
value="http://terminology.hl7.org.au/CodeSystem/v2-0203"/>
<code value="NOI"/>
<display value="National Organisation Identifier"/>
</coding>
<text value="PAI-O"/>
</type>
<system
value="http://ns.electronichealth.net.au/id/pcehr/paio/1.0"/>
<value value="TBD"/>
</identifier>
<name value="National Cancer Screening Register system operator"/>
<partOf>
<reference value="urn:uuid:a73db507-e5ed-4865-a20e-45062fb2c7f4"/>
</partOf>
</Organization>
</resource>
</entry>
<!-- ORGANIZATION Services Australia -->
<entry>
<fullUrl value="urn:uuid:a73db507-e5ed-4865-a20e-45062fb2c7f4"/>
<resource>
<Organization>
<id value="servicesau"/>
<text>
<status value="generated"/>
<div xmlns="http://www.w3.org/1999/xhtml"><a name="Organization_servicesau"> </a><p class="res-header-id"><b>Generated Narrative: Organization servicesau</b></p><a name="servicesau"> </a><a name="hcservicesau"> </a><a name="servicesau-en-AU"> </a><p><b>identifier</b>: ABN/90794605008</p><p><b>type</b>: <span title="Codes:">Commonwealth Government Entity</span></p><p><b>name</b>: Services Australia</p><p><b>telecom</b>: <a href="https://www.servicesaustralia.gov.au/">https://www.servicesaustralia.gov.au/</a></p></div>
</text>
<identifier>
<type>
<coding>
<system value="http://terminology.hl7.org/CodeSystem/v2-0203"/>
<code value="XX"/>
</coding>
<text value="ABN"/>
</type>
<system value="http://hl7.org.au/id/abn"/>
<value value="90794605008"/>
</identifier>
<type>
<text value="Commonwealth Government Entity"/>
</type>
<name value="Services Australia"/>
<telecom>
<system value="url"/>
<value value="https://www.servicesaustralia.gov.au/"/>
<use value="work"/>
</telecom>
</Organization>
</resource>
</entry>
<!-- OBSERVATION -->
<entry>
<fullUrl value="urn:uuid:c722b26d-cbde-4a61-9d73-de71e117dcfd"/>
<!-- 14. Forecast status validity period is not provided in this scenario -->
<resource>
<Observation>
<id value="nbcsp-02"/>
<text>
<status value="generated"/>
<div xmlns="http://www.w3.org/1999/xhtml"><a name="Observation_nbcsp-02"> </a><p class="res-header-id"><b>Generated Narrative: Observation nbcsp-02</b></p><a name="nbcsp-02"> </a><a name="hcnbcsp-02"> </a><a name="nbcsp-02-en-AU"> </a><p><b>identifier</b>: <code>urn:ietf:rfc:4122</code>/24fd20c0-5a07-4e5e-98da-d7d3d498613a</p><p><b>status</b>: Final</p><p><b>category</b>: <span title="Codes:{http://terminology.hl7.org.au/CodeSystem/observation-category program}">Cancer screening program</span></p><p><b>code</b>: <span title="Codes:{http://snomed.info/sct 1602081000168109}">National Bowel Cancer Screening Program Participation</span></p><p><b>subject</b>: <a href="Bundle-ncspv-doc-03.html#urn-uuid-5262f368-8f3e-43ae-be0f-f54541d4329e">Bundle: identifier = UUID:bc7db961-b74e-4f76-955d-8948d14cee24; type = document; timestamp = 2022-05-16 13:45:15+1000</a></p><p><b>effective</b>: 2022-05-14</p><p><b>performer</b>: <a href="Bundle-ncspv-doc-03.html#urn-uuid-eaadd89b-cded-4872-a1ff-d1230e9e7495">Bundle: identifier = UUID:bc7db961-b74e-4f76-955d-8948d14cee24; type = document; timestamp = 2022-05-16 13:45:15+1000</a></p><blockquote><p><b>component</b></p><p><b>code</b>: <span title="Codes:{http://snomed.info/sct 1603781000168102}">Participant status</span></p><p><b>value</b>: <span title="Codes:{http://snomed.info/sct 1602001000168101}">Actively Screening</span></p></blockquote><blockquote><p><b>component</b></p><p><b>code</b>: <span title="Codes:{http://snomed.info/sct 1603791000168104}">Participant status period</span></p><p><b>value</b>: 2022-02-05 --> 2022-08-05</p></blockquote><blockquote><p><b>component</b></p><p><b>code</b>: <span title="Codes:{http://snomed.info/sct 1603871000168108}">Defer flag</span></p><p><b>value</b>: true</p></blockquote><blockquote><p><b>component</b></p><p><b>code</b>: <span title="Codes:{http://snomed.info/sct 1604041000168107}">Next screening action</span></p><p><b>value</b>: <span title="Codes:">Due Now (eligible since 50th birthday)</span></p></blockquote></div>
</text>
<!-- Scenario: New to NBCSP, deferred participation (2022)
Scenario Description: Patient is aged 50 and first Bowel Program round has opened.
Person has been sent invitation, but defers for 6 months as they are travelling overseas. Date deferral was recorded is 10 Feb 2022. -->
<!-- update to id from pcehr doc registration? -->
<identifier>
<system value="urn:ietf:rfc:4122"/>
<value value="24fd20c0-5a07-4e5e-98da-d7d3d498613a"/>
</identifier>
<status value="final"/>
<category>
<coding>
<system
value="http://terminology.hl7.org.au/CodeSystem/observation-category"/>
<code value="program"/>
<display value="Program"/>
</coding>
<text value="Cancer screening program"/>
</category>
<code>
<coding>
<system value="http://snomed.info/sct"/>
<code value="1602081000168109"/>
<display
value="National bowel cancer screening program participation"/>
</coding>
<text
value="National Bowel Cancer Screening Program Participation"/>
</code>
<subject>
<reference value="urn:uuid:5262f368-8f3e-43ae-be0f-f54541d4329e"/>
<identifier>
<type>
<coding>
<system
value="http://terminology.hl7.org/CodeSystem/v2-0203"/>
<code value="NI"/>
<display value="National unique individual identifier"/>
</coding>
<text value="IHI"/>
</type>
<system value="http://ns.electronichealth.net.au/id/hi/ihi/1.0"/>
<value value="8003608000228437"/>
</identifier>
</subject>
<!-- Records date this program participation information is asserted as 'true' -->
<effectiveDateTime value="2022-05-14"/>
<performer>
<reference value="urn:uuid:eaadd89b-cded-4872-a1ff-d1230e9e7495"/>
<identifier>
<type>
<coding>
<system
value="http://terminology.hl7.org.au/CodeSystem/v2-0203"/>
<code value="NOI"/>
<display value="National Organisation Identifier"/>
</coding>
<text value="PAI-O"/>
</type>
<system
value="http://ns.electronichealth.net.au/id/pcehr/paio/1.0"/>
<value value="TBD"/>
</identifier>
</performer>
<!-- 1. Program participation status -->
<component>
<code>
<coding>
<system value="http://snomed.info/sct"/>
<code value="1603781000168102"/>
<display value="Program participation status"/>
</coding>
<text value="Participant status"/>
</code>
<valueCodeableConcept>
<coding>
<system value="http://snomed.info/sct"/>
<code value="1602001000168101"/>
<display value="Active participation"/>
</coding>
<text value="Actively Screening"/>
</valueCodeableConcept>
</component>
<!-- 2. Program participation status validity period -->
<component>
<code>
<coding>
<system value="http://snomed.info/sct"/>
<code value="1603791000168104"/>
<display value="Program participation status period"/>
</coding>
<text value="Participant status period"/>
</code>
<!-- Patient deferred for 6 months so keeps status of New to screening for a 6 month period -->
<valuePeriod>
<start value="2022-02-05"/>
<end value="2022-08-05"/>
</valuePeriod>
</component>
<!-- 3. Suspension of program participation -->
<component>
<code>
<coding>
<system value="http://snomed.info/sct"/>
<code value="1603871000168108"/>
<display value="Program participation suspension indicator"/>
</coding>
<text value="Defer flag"/>
</code>
<!-- Patient deferred -->
<valueBoolean value="true"/>
</component>
<!-- 13. Forecast status -->
<component>
<code>
<coding>
<system value="http://snomed.info/sct"/>
<code value="1604041000168107"/>
<display value="Program forecast status"/>
</coding>
<text value="Next screening action"/>
</code>
<valueCodeableConcept>
<text value="Due Now (eligible since 50th birthday)"/>
</valueCodeableConcept>
</component>
</Observation>
</resource>
</entry>
</Bundle>
IG © 2023+ Australian Digital Health Agency. Package au.digitalhealth.r4#1.2.0-ci-build based on FHIR 4.0.1. Generated 2024-09-12
Links: Table of Contents |
QA Report
| Version History
| Report an issue or propose a change
