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
{
"resourceType" : "Bundle",
"id" : "ncsr-01",
"meta" : // Bundle for 'data in' from NCSR to MHR
{
"lastUpdated" : "2021-05-22T10:01:00+10:00",
"profile" : [
🔗 "http://ns.electronichealth.net.au/fhir/StructureDefinition/dh-bundle-payload-1"🔗 ,
"http://ns.electronichealth.net.au/fhir/StructureDefinition/dh-bundle-core-1"
]
},
"identifier" : {
"system" : "urn:ietf:rfc:3986",
"value" : "urn:uuid:5a655945-c2b3-4d01-9e88-224873e32d8d"
},
"type" : "collection",
"timestamp" : "2021-05-22T10:01:00+10:00",
"entry" : [
// PATIENT
{
"fullUrl" : "urn:uuid:d66d5b80-5965-4d7c-b17b-0344cf896b89",
"resource" : {
"resourceType" : "Patient",
"id" : "hi-testdata-moss-cleo",
"text" : {
"status" : "extensions",
"div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><a name=\"Patient_hi-testdata-moss-cleo\"> </a><p><b>Generated Narrative: Patient </b><a name=\"hi-testdata-moss-cleo\"> </a><a name=\"hchi-testdata-moss-cleo\"> </a></p><div style=\"display: inline-block; background-color: #d9e0e7; padding: 6px; margin: 4px; border: 1px solid #8da1b4; border-radius: 5px; line-height: 60%\"><p style=\"margin-bottom: 0px\">ResourcePatient "hi-testdata-moss-cleo" </p></div><p><b>Australian Indigenous Status</b>: Neither Aboriginal nor Torres Strait Islander origin (Details: australian-indigenous-status-1 code 4 = ' Neither Aboriginal nor Torres Strait Islander origin ', stated as ' Neither Aboriginal nor Torres Strait Islander origin ')</p><p><b>identifier</b>: IHI/8003608833564735</p><p><b>name</b>: Cleo Moss </p><p><b>telecom</b>: <a href=\"mailto:moss@gmail.com\">moss@gmail.com</a></p><p><b>gender</b>: female</p><p><b>birthDate</b>: 1965-08-23</p><p><b>address</b>: 138 Gateway Ct, CALDER, TAS, 7325(home)</p></div>"
},
"extension" : [
{
"url" : "http://hl7.org.au/fhir/StructureDefinition/indigenous-status",
"valueCoding" : {
"system" : "https://healthterminologies.gov.au/fhir/CodeSystem/australian-indigenous-status-1",
"code" : "4",
"display" : "Neither Aboriginal nor Torres Strait Islander origin"
}
}
],
"identifier" : [
{
"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" : "8003608833564735"
}
],
"name" : [
{
"family" : "Moss",
"given" : [
"Cleo"
],
"suffix" : [
"Esq."
]
}
],
"telecom" : [
{
"system" : "email",
"value" : "moss@gmail.com"
}
],
"gender" : "female",
"birthDate" : "1965-08-23",
"address" : [
{
"use" : "home",
"text" : "138 Gateway Ct, CALDER, TAS, 7325"
}
]
}
},
{
"fullUrl" : "urn:uuid:d574e9a6-99b1-4959-b3fa-463f7b7f8677",
"resource" : {
"resourceType" : "Organization",
"id" : "ncsr-operator",
"text" : {
"status" : "generated",
"div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><a name=\"Organization_ncsr-operator\"> </a><p><b>Generated Narrative: Organization </b><a name=\"ncsr-operator\"> </a><a name=\"hcncsr-operator\"> </a></p><div style=\"display: inline-block; background-color: #d9e0e7; padding: 6px; margin: 4px; border: 1px solid #8da1b4; border-radius: 5px; line-height: 60%\"><p style=\"margin-bottom: 0px\">ResourceOrganization "ncsr-operator" </p></div><p><b>identifier</b>: PAI-O/TBD</p><p><b>name</b>: National Cancer Screening Register system operator</p></div>"
},
"identifier" : [
{
"type" : {
"coding" : [
{
"system" : "http://terminology.hl7.org.au/CodeSystem/v2-0203",
"code" : "NOI",
"display" : "National Organisation Identifier"
}
],
"text" : "PAI-O"
},
"system" : "http://ns.electronichealth.net.au/id/pcehr/paio/1.0",
"value" : "TBD"
}
],
"name" : "National Cancer Screening Register system operator"
}
},
{
"fullUrl" : "urn:uuid:949133cb-de9a-44a7-b3d3-bd0e9d9d2faf",
"resource" : {
"resourceType" : "Observation",
"id" : "ncsp-01",
"meta" : // Scenario: Active screening, next action in 1 year (2021)
Scenario Description: NCSR receives a Cervical result for participant on 22 May 2021.
Status updates to Actively Screening, and their next due date is in 1 year due to the risk category of that participant.
// update to id from pcehr doc registration?
{
"lastUpdated" : "2021-05-22T10:01:00+10:00"
},
"text" : {
"status" : "generated",
"div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><a name=\"Observation_ncsp-01\"> </a><p><b>Generated Narrative: Observation </b><a name=\"ncsp-01\"> </a><a name=\"hcncsp-01\"> </a></p><div style=\"display: inline-block; background-color: #d9e0e7; padding: 6px; margin: 4px; border: 1px solid #8da1b4; border-radius: 5px; line-height: 60%\"><p style=\"margin-bottom: 0px\">ResourceObservation "ncsp-01" Updated"2021-05-22 10:01:00+1000" </p></div><p><b>identifier</b>: <code>urn:ietf:rfc:4122</code>/28c02479-27ed-4d95-957b-d6703c2bcc97</p><p><b>status</b>: final</p><p><b>category</b>: Cancer screening program <span style=\"background: LightGoldenRodYellow; margin: 4px; border: 1px solid khaki\"> (<a href=\"https://build.fhir.org/ig/hl7au/au-fhir-base/CodeSystem-au-observation-category.html\">Observation Category Codes AU</a>#program "Program")</span></p><p><b>code</b>: National Cervical Cancer Screening Program Participation <span style=\"background: LightGoldenRodYellow; margin: 4px; border: 1px solid khaki\"> (<a href=\"https://browser.ihtsdotools.org/\">SNOMED CT</a>#1602101000168102 "National cervical cancer screening program participation")</span></p><p><b>subject</b>: See on this page: urn:uuid:d66d5b80-5965-4d7c-b17b-0344cf896b89</p><p><b>effective</b>: 2021-05-22 10:01:00+1000</p><p><b>performer</b>: See on this page: urn:uuid:d574e9a6-99b1-4959-b3fa-463f7b7f8677</p><blockquote><p><b>component</b></p><p><b>code</b>: Participant status <span style=\"background: LightGoldenRodYellow; margin: 4px; border: 1px solid khaki\"> (<a href=\"https://browser.ihtsdotools.org/\">SNOMED CT</a>#1603781000168102 "Program participation status")</span></p><p><b>value</b>: Actively screening <span style=\"background: LightGoldenRodYellow; margin: 4px; border: 1px solid khaki\"> (<a href=\"https://browser.ihtsdotools.org/\">SNOMED CT</a>#1602001000168101 "Active participation")</span></p></blockquote><blockquote><p><b>component</b></p><p><b>code</b>: Participant status period <span style=\"background: LightGoldenRodYellow; margin: 4px; border: 1px solid khaki\"> (<a href=\"https://browser.ihtsdotools.org/\">SNOMED CT</a>#1603791000168104 "Program participation status period")</span></p><p><b>value</b>: 2021-05-22 --> (ongoing)</p></blockquote><blockquote><p><b>component</b></p><p><b>code</b>: Defer flag <span style=\"background: LightGoldenRodYellow; margin: 4px; border: 1px solid khaki\"> (<a href=\"https://browser.ihtsdotools.org/\">SNOMED CT</a>#1603871000168108 "Program participation suspension indicator")</span></p><p><b>value</b>: false</p></blockquote><blockquote><p><b>component</b></p><p><b>code</b>: Next screening action date <span style=\"background: LightGoldenRodYellow; margin: 4px; border: 1px solid khaki\"> (<a href=\"https://browser.ihtsdotools.org/\">SNOMED CT</a>#1604051000168109 "Program forecast status period")</span></p><p><b>value</b>: 2022-05-22</p></blockquote></div>"
},
"identifier" : [
{
"system" : "urn:ietf:rfc:4122",
"value" : "28c02479-27ed-4d95-957b-d6703c2bcc97"
}
],
"status" : "final",
"category" : [
{
"coding" : [
{
"system" : "http://terminology.hl7.org.au/CodeSystem/observation-category",
"code" : "program",
"display" : "Program"
}
],
"text" : "Cancer screening program"
}
],
"code" : {
"coding" : [
{
"system" : "http://snomed.info/sct",
"code" : "1602101000168102",
"display" : "National cervical cancer screening program participation"
}
],
"text" : "National Cervical Cancer Screening Program Participation"
},
"subject" : {
"reference" : "urn:uuid:d66d5b80-5965-4d7c-b17b-0344cf896b89",
"identifier" : {
"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" : "8003608833564735"
}
},
"effectiveDateTime" : "2021-05-22T10:01:00+10:00",
"performer" : [
{
"reference" : "urn:uuid:d574e9a6-99b1-4959-b3fa-463f7b7f8677",
"identifier" : {
"type" : {
"coding" : [
{
"system" : "http://terminology.hl7.org.au/CodeSystem/v2-0203",
"code" : "NOI",
"display" : "National Organisation Identifier"
}
],
"text" : "PAI-O"
},
"system" : "http://ns.electronichealth.net.au/id/pcehr/paio/1.0",
"value" : "TBD"
}
}
],
"component" : [
{
"code" : {
"coding" : [
{
"system" : "http://snomed.info/sct",
"code" : "1603781000168102",
"display" : "Program participation status"
}
],
"text" : "Participant status"
},
"valueCodeableConcept" : {
"coding" : [
{
"system" : "http://snomed.info/sct",
"code" : "1602001000168101",
"display" : "Active participation"
}
],
"text" : "Actively screening"
}
},
{
"code" : {
"coding" : [
{
"system" : "http://snomed.info/sct",
"code" : "1603791000168104",
"display" : "Program participation status period"
}
],
"text" : "Participant status period"
},
"valuePeriod" : {
"start" : "2021-05-22"
}
},
{
"code" : {
"coding" : [
{
"system" : "http://snomed.info/sct",
"code" : "1603871000168108",
"display" : "Program participation suspension indicator"
}
],
"text" : "Defer flag"
},
"valueBoolean" : false
},
// Patient has not deferred
{
"code" : {
"coding" : [
{
"system" : "http://snomed.info/sct",
"code" : "1604051000168109",
"display" : "Program forecast status period"
}
],
"text" : "Next screening action date"
},
"valueDateTime" : "2022-05-22"
}
]
}
},
// Next screening date for patient is in 1 year
{
"fullUrl" : "urn:uuid:b52df3bf-f723-47ca-bff9-d37f6f409896",
"resource" : {
"resourceType" : "Observation",
"id" : "nbcsp-03",
"meta" : // Scenario: Active screening, next due in 2 years (2021)
Scenario Description: NCSR receives a negative FOBT result for participant. Status updates to Actively Screening, and their next due date is in 2 years
// update to id from pcehr doc registration?
{
"lastUpdated" : "2021-05-22T10:01:00+10:00"
},
"text" : {
"status" : "generated",
"div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><a name=\"Observation_nbcsp-03\"> </a><p><b>Generated Narrative: Observation </b><a name=\"nbcsp-03\"> </a><a name=\"hcnbcsp-03\"> </a></p><div style=\"display: inline-block; background-color: #d9e0e7; padding: 6px; margin: 4px; border: 1px solid #8da1b4; border-radius: 5px; line-height: 60%\"><p style=\"margin-bottom: 0px\">ResourceObservation "nbcsp-03" Updated"2021-05-22 10:01:00+1000" </p></div><p><b>identifier</b>: <code>urn:ietf:rfc:4122</code>/4732293f-40e4-45a3-81b5-9cc2ae8b2f38</p><p><b>status</b>: final</p><p><b>category</b>: Cancer screening program <span style=\"background: LightGoldenRodYellow; margin: 4px; border: 1px solid khaki\"> (<a href=\"https://build.fhir.org/ig/hl7au/au-fhir-base/CodeSystem-au-observation-category.html\">Observation Category Codes AU</a>#program "Program")</span></p><p><b>code</b>: National Bowel Cancer Screening Program Participation <span style=\"background: LightGoldenRodYellow; margin: 4px; border: 1px solid khaki\"> (<a href=\"https://browser.ihtsdotools.org/\">SNOMED CT</a>#1602081000168109 "National bowel cancer screening program participation")</span></p><p><b>subject</b>: See on this page: urn:uuid:d66d5b80-5965-4d7c-b17b-0344cf896b89</p><p><b>effective</b>: 2021-05-22 07:01:00+1000</p><p><b>performer</b>: See on this page: urn:uuid:d574e9a6-99b1-4959-b3fa-463f7b7f8677</p><blockquote><p><b>component</b></p><p><b>code</b>: Participant status <span style=\"background: LightGoldenRodYellow; margin: 4px; border: 1px solid khaki\"> (<a href=\"https://browser.ihtsdotools.org/\">SNOMED CT</a>#1603781000168102 "Program participation status")</span></p><p><b>value</b>: Actively screening <span style=\"background: LightGoldenRodYellow; margin: 4px; border: 1px solid khaki\"> (<a href=\"https://browser.ihtsdotools.org/\">SNOMED CT</a>#1602001000168101 "Active participation")</span></p></blockquote><blockquote><p><b>component</b></p><p><b>code</b>: Participant status period <span style=\"background: LightGoldenRodYellow; margin: 4px; border: 1px solid khaki\"> (<a href=\"https://browser.ihtsdotools.org/\">SNOMED CT</a>#1603791000168104 "Program participation status period")</span></p><p><b>value</b>: 2021-05-22 --> (ongoing)</p></blockquote><blockquote><p><b>component</b></p><p><b>code</b>: Defer flag <span style=\"background: LightGoldenRodYellow; margin: 4px; border: 1px solid khaki\"> (<a href=\"https://browser.ihtsdotools.org/\">SNOMED CT</a>#1603871000168108 "Program participation suspension indicator")</span></p><p><b>value</b>: false</p></blockquote><blockquote><p><b>component</b></p><p><b>code</b>: Next screening action <span style=\"background: LightGoldenRodYellow; margin: 4px; border: 1px solid khaki\"> (<a href=\"https://browser.ihtsdotools.org/\">SNOMED CT</a>#1604041000168107 "Program forecast status")</span></p><p><b>value</b>: Eligible On: <span style=\"background: LightGoldenRodYellow; margin: 4px; border: 1px solid khaki\"> ()</span></p></blockquote><blockquote><p><b>component</b></p><p><b>code</b>: Next screening action date <span style=\"background: LightGoldenRodYellow; margin: 4px; border: 1px solid khaki\"> (<a href=\"https://browser.ihtsdotools.org/\">SNOMED CT</a>#1604051000168109 "Program forecast status period")</span></p><p><b>value</b>: 2023-05-22</p></blockquote></div>"
},
"identifier" : [
{
"system" : "urn:ietf:rfc:4122",
"value" : "4732293f-40e4-45a3-81b5-9cc2ae8b2f38"
}
],
"status" : "final",
"category" : [
{
"coding" : [
{
"system" : "http://terminology.hl7.org.au/CodeSystem/observation-category",
"code" : "program",
"display" : "Program"
}
],
"text" : "Cancer screening program"
}
],
"code" : {
"coding" : [
{
"system" : "http://snomed.info/sct",
"code" : "1602081000168109",
"display" : "National bowel cancer screening program participation"
}
],
"text" : "National Bowel Cancer Screening Program Participation"
},
"subject" : {
"reference" : "urn:uuid:d66d5b80-5965-4d7c-b17b-0344cf896b89",
"identifier" : {
"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" : "8003608833564735"
}
},
"effectiveDateTime" : "2021-05-22T07:01:00+10:00",
"performer" : [
{
"reference" : "urn:uuid:d574e9a6-99b1-4959-b3fa-463f7b7f8677",
"identifier" : {
"type" : {
"coding" : [
{
"system" : "http://terminology.hl7.org.au/CodeSystem/v2-0203",
"code" : "NOI",
"display" : "National Organisation Identifier"
}
],
"text" : "PAI-O"
},
"system" : "http://ns.electronichealth.net.au/id/pcehr/paio/1.0",
"value" : "TBD"
}
}
],
"component" : [
{
"code" : {
"coding" : [
{
"system" : "http://snomed.info/sct",
"code" : "1603781000168102",
"display" : "Program participation status"
}
],
"text" : "Participant status"
},
"valueCodeableConcept" : {
"coding" : [
{
"system" : "http://snomed.info/sct",
"code" : "1602001000168101",
"display" : "Active participation"
}
],
"text" : "Actively screening"
}
},
{
"code" : {
"coding" : [
{
"system" : "http://snomed.info/sct",
"code" : "1603791000168104",
"display" : "Program participation status period"
}
],
"text" : "Participant status period"
},
"valuePeriod" : {
"start" : "2021-05-22"
}
},
{
"code" : {
"coding" : [
{
"system" : "http://snomed.info/sct",
"code" : "1603871000168108",
"display" : "Program participation suspension indicator"
}
],
"text" : "Defer flag"
},
"valueBoolean" : false
},
// Patient has not deferred
{
"code" : {
"coding" : [
{
"system" : "http://snomed.info/sct",
"code" : "1604041000168107",
"display" : "Program forecast status"
}
],
"text" : "Next screening action"
},
"valueCodeableConcept" : {
"text" : "Eligible On:"
}
},
{
"code" : {
"coding" : [
{
"system" : "http://snomed.info/sct",
"code" : "1604051000168109",
"display" : "Program forecast status period"
}
],
"text" : "Next screening action date"
},
"valueDateTime" : "2023-05-22"
}
]
}
}
]
}
IG © 2023+ Australian Digital Health Agency. Package au.digitalhealth.r4#1.2.0-ci-build based on FHIR 4.0.1. Generated 2024-06-11
Links: Table of Contents |
QA Report
| Version History
| Report an issue or propose a change
