Health NZ | Te Whatu Ora FHIR Screening Implementation Guide
0.9.2 - draft
Health NZ | Te Whatu Ora FHIR Screening Implementation Guide
0.9.2 - draft
Health NZ | Te Whatu Ora FHIR Screening Implementation Guide, published by Health New Zealand | Te Whatu Ora. This guide is not an authorized publication; it is the continuous build for version 0.9.2 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/tewhatuora/fhir-screening/ and changes regularly. See the Directory of published versions
{
"resourceType" : "Bundle",
"type" : "searchset",
"total" : 1,
"link" : [
{
"relation" : "self",
"url" : "https://fhir.api-test.digital.health.nz/R4/DocumentReference?category=http%3A%2F%2Fsnomed.info%2Fsct%7C1230046007&subject%3Aidentifier=ZCQ3240&_include=DocumentReference%3Asubject"
}
],
"entry" : [
{
"fullUrl" : "https://fhir.api-test.digital.health.nz/R4/DocumentReference/9f966515-f908-4892-a5f7-340e15507233",
"resource" : {
"resourceType" : "DocumentReference",
"id" : "9f966515-f908-4892-a5f7-340e15507233",
"meta" : {
"profile" : [
🔗 "https://fhir-ig.digital.health.nz/screening/StructureDefinition/nz-screening-summary"
]
},
"masterIdentifier" : {
"use" : "official",
"value" : "1",
"assigner" : {
"type" : "Organization",
"identifier" : {
"value" : "National Screening Unit"
},
"display" : "National Screening Unit"
}
},
"identifier" : [
{
"use" : "official",
"value" : "1",
"assigner" : {
"type" : "Organization",
"identifier" : {
"value" : "National Screening Unit"
},
"display" : "National Screening Unit"
}
}
],
"status" : "current",
"type" : {
"coding" : [
{
"system" : "http://snomed.info/sct",
"code" : "422735006",
"display" : "Summary clinical document (record artifact)"
}
]
},
"category" : [
{
"coding" : [
{
"system" : "http://snomed.info/sct",
"code" : "1230046007",
"display" : "Cervical cancer screening service (qualifier value)"
}
]
}
],
"subject" : {
🔗 "reference" : "Patient/KassandraTemahoe",
"type" : "Patient",
"identifier" : {
"use" : "official",
"system" : "https://standards.digital.health.nz/ns/nhi-id",
"value" : "ZCQ3240"
},
"display" : "Kassandra Temahoe"
},
"custodian" : {
"type" : "Organization",
"identifier" : {
"value" : "National Screening Unit"
},
"display" : "National Screening Unit"
},
"content" : [
{
"attachment" : {
"contentType" : "text/html",
"data" : "PGgxIGlkPSJuYXRpb25hbC1jZXJ2aWNhbC1zY3JlZW5pbmctcHJvZ3JhbW1lIj5OYXRpb25hbCBDZXJ2aWNhbCBTY3JlZW5pbmcgUHJvZ3JhbW1lPC9oMT4KPGgyIGlkPSJzY3JlZW5pbmctaGlzdG9yeS1yZXBvcnQiPlNjcmVlbmluZyBIaXN0b3J5IFJlcG9ydDwvaDI+CjxwPjxlbT5BcyBhdCAwNi0wMy0yMDI0PC9lbT48L3A+Cgo8aDMgaWQ9InBhcnRpY2lwYW50LWRldGFpbHMiPlBhcnRpY2lwYW50IERldGFpbHM8L2gzPgoKPHRhYmxlPgogIDx0aGVhZD4KICAgIDx0cj4KICAgICAgPHRoIHN0eWxlPSJ0ZXh0LWFsaWduOiBsZWZ0Ij4gPC90aD4KICAgICAgPHRoIHN0eWxlPSJ0ZXh0LWFsaWduOiBsZWZ0Ij4gPC90aD4KICAgICAgPHRoIHN0eWxlPSJ0ZXh0LWFsaWduOiByaWdodCI+IDwvdGg+CiAgICAgIDx0aCBzdHlsZT0idGV4dC1hbGlnbjogbGVmdCI+IDwvdGg+CiAgICA8L3RyPgogIDwvdGhlYWQ+CiAgPHRib2R5PgogICAgPHRyPgogICAgICA8dGQgc3R5bGU9InRleHQtYWxpZ246IGxlZnQiPjxzdHJvbmc+RnVsbCBOYW1lPC9zdHJvbmc+PC90ZD4KICAgICAgPHRkIHN0eWxlPSJ0ZXh0LWFsaWduOiBsZWZ0Ij5NaWtpIE1haG9lPC90ZD4KICAgICAgPHRkIHN0eWxlPSJ0ZXh0LWFsaWduOiByaWdodCI+RGF0ZSBvZiBCaXJ0aDwvdGQ+CiAgICAgIDx0ZCBzdHlsZT0idGV4dC1hbGlnbjogbGVmdCI+MjQtMTEtMTk2ODwvdGQ+CiAgICA8L3RyPgogICAgPHRyPgogICAgICA8dGQgc3R5bGU9InRleHQtYWxpZ246IGxlZnQiPjxzdHJvbmc+RXRobmljaXR5PC9zdHJvbmc+PC90ZD4KICAgICAgPHRkIHN0eWxlPSJ0ZXh0LWFsaWduOiBsZWZ0Ij5NxIFvcmk8L3RkPgogICAgICA8dGQgc3R5bGU9InRleHQtYWxpZ246IHJpZ2h0Ij5OSEkgTnVtYmVyPC90ZD4KICAgICAgPHRkIHN0eWxlPSJ0ZXh0LWFsaWduOiBsZWZ0Ij5TQ0Y3ODI2PC90ZD4KICAgIDwvdHI+CiAgICA8dHI+CiAgICAgIDx0ZCBzdHlsZT0idGV4dC1hbGlnbjogbGVmdCI+PHN0cm9uZz5HZW5kZXI8L3N0cm9uZz48L3RkPgogICAgICA8dGQgc3R5bGU9InRleHQtYWxpZ246IGxlZnQiPk1hbGUgKEdlbmRlciBkaXZlcnNlKTwvdGQ+CiAgICAgIDx0ZCBzdHlsZT0idGV4dC1hbGlnbjogcmlnaHQiPlNleCBhc3NpZ25lZDxiciAvPmF0IGJpcnRoPC90ZD4KICAgICAgPHRkIHN0eWxlPSJ0ZXh0LWFsaWduOiBsZWZ0Ij5GZW1hbGU8L3RkPgogICAgPC90cj4KICAgIDx0cj4KICAgICAgPHRkIHN0eWxlPSJ0ZXh0LWFsaWduOiBsZWZ0Ij48c3Ryb25nPkFkZHJlc3M8L3N0cm9uZz48L3RkPgogICAgICA8dGQgc3R5bGU9InRleHQtYWxpZ246IGxlZnQiPjM3MyBKYWNrc29uIFN0cmVldCwgPGJyIC8+UGV0b25lLDxiciAvPkxvd2VyIEh1dHQgNTAxMiw8YnIgLz5OZXcgWmVhbGFuZDwvdGQ+CiAgICAgIDx0ZCBzdHlsZT0idGV4dC1hbGlnbjogcmlnaHQiPiA8L3RkPgogICAgICA8dGQgc3R5bGU9InRleHQtYWxpZ246IGxlZnQiPiA8L3RkPgogICAgPC90cj4KICA8L3Rib2R5Pgo8L3RhYmxlPgoKPGgzIGlkPSJwYXJ0aWNpcGFudC1zdW1tYXJ5Ij5QYXJ0aWNpcGFudCBTdW1tYXJ5PC9oMz4KCjx0YWJsZT4KICA8dGhlYWQ+CiAgICA8dHI+CiAgICAgIDx0aCBzdHlsZT0idGV4dC1hbGlnbjogbGVmdCI+IDwvdGg+CiAgICAgIDx0aCBzdHlsZT0idGV4dC1hbGlnbjogbGVmdCI+IDwvdGg+CiAgICAgIDx0aD4gPC90aD4KICAgICAgPHRoPiA8L3RoPgogICAgPC90cj4KICA8L3RoZWFkPgogIDx0Ym9keT4KICAgIDx0cj4KICAgICAgPHRkIHN0eWxlPSJ0ZXh0LWFsaWduOiBsZWZ0Ij48c3Ryb25nPlBhdGh3YXkgU3RhdHVzPC9zdHJvbmc+PC90ZD4KICAgICAgPHRkIHN0eWxlPSJ0ZXh0LWFsaWduOiBsZWZ0Ij5VbmVucm9sbGVkPC90ZD4KICAgICAgPHRkPiA8L3RkPgogICAgICA8dGQ+IDwvdGQ+CiAgICA8L3RyPgogICAgPHRyPgogICAgICA8dGQgc3R5bGU9InRleHQtYWxpZ246IGxlZnQiPjxzdHJvbmc+VW5lbnJvbGxlZCByZWFzb248L3N0cm9uZz48L3RkPgogICAgICA8dGQgc3R5bGU9InRleHQtYWxpZ246IGxlZnQiPjxzdHJvbmc+REVDRUFTRUQ8L3N0cm9uZz48L3RkPgogICAgICA8dGQ+IDwvdGQ+CiAgICAgIDx0ZD4gPC90ZD4KICAgIDwvdHI+CiAgICA8dHI+CiAgICAgIDx0ZCBzdHlsZT0idGV4dC1hbGlnbjogbGVmdCI+PHN0cm9uZz5OZXh0IEV4cGVjdGVkIEV2ZW50PC9zdHJvbmc+PC90ZD4KICAgICAgPHRkIHN0eWxlPSJ0ZXh0LWFsaWduOiBsZWZ0Ij5Ob3QgYXBwbGljYWJsZSBmb3Igc3RhdHVzPC90ZD4KICAgICAgPHRkPiA8L3RkPgogICAgICA8dGQ+IDwvdGQ+CiAgICA8L3RyPgogICAgPHRyPgogICAgICA8dGQgc3R5bGU9InRleHQtYWxpZ246IGxlZnQiPjxzdHJvbmc+TmV4dCBFdmVudCBEdWUgRGF0ZTwvc3Ryb25nPjwvdGQ+CiAgICAgIDx0ZCBzdHlsZT0idGV4dC1hbGlnbjogbGVmdCI+Tm90IGFwcGxpY2FibGUgZm9yIHN0YXR1czwvdGQ+CiAgICAgIDx0ZD4gPC90ZD4KICAgICAgPHRkPiA8L3RkPgogICAgPC90cj4KICAgIDx0cj4KICAgICAgPHRkIHN0eWxlPSJ0ZXh0LWFsaWduOiBsZWZ0Ij48c3Ryb25nPlNlbmQgcHJvZ3JhbW1lPC9zdHJvbmc+PGJyIC8+PHN0cm9uZz5jb3JyZXNwb25kZW5jZTwvc3Ryb25nPjwvdGQ+CiAgICAgIDx0ZCBzdHlsZT0idGV4dC1hbGlnbjogbGVmdCI+Tm88L3RkPgogICAgICA8dGQ+IDwvdGQ+CiAgICAgIDx0ZD4gPC90ZD4KICAgIDwvdHI+CiAgPC90Ym9keT4KPC90YWJsZT4KCjxociAvPgoKPGgyIGlkPSJzY3JlZW5pbmctaGlzdG9yeSI+U2NyZWVuaW5nIEhpc3Rvcnk8L2gyPgoKPGgzIGlkPSJjeXRvbG9neS10ZXN0LXNwZWNpbWVuLXRha2VuLTI3LTAxLTIwMTkiPkN5dG9sb2d5IFRlc3QsIHNwZWNpbWVuIHRha2VuIDI3LTAxLTIwMTk8L2gzPgoKPHRhYmxlPgogIDx0aGVhZD4KICAgIDx0cj4KICAgICAgPHRoIHN0eWxlPSJ0ZXh0LWFsaWduOiBsZWZ0Ij4gPC90aD4KICAgICAgPHRoIHN0eWxlPSJ0ZXh0LWFsaWduOiBsZWZ0Ij4gPC90aD4KICAgIDwvdHI+CiAgPC90aGVhZD4KICA8dGJvZHk+CiAgICA8dHI+CiAgICAgIDx0ZCBzdHlsZT0idGV4dC1hbGlnbjogbGVmdCI+PHN0cm9uZz5TcGVjaW1lbiBUeXBlPC9zdHJvbmc+PC90ZD4KICAgICAgPHRkIHN0eWxlPSJ0ZXh0LWFsaWduOiBsZWZ0Ij5MQkMgLSBMaXF1aWQgYmFzZWQgY3l0b2xvZ3k8L3RkPgogICAgPC90cj4KICAgIDx0cj4KICAgICAgPHRkIHN0eWxlPSJ0ZXh0LWFsaWduOiBsZWZ0Ij48c3Ryb25nPlNwZWNpbWVuIElkPC9zdHJvbmc+PC90ZD4KICAgICAgPHRkIHN0eWxlPSJ0ZXh0LWFsaWduOiBsZWZ0Ij5aS0oyMjY5PC90ZD4KICAgIDwvdHI+CiAgICA8dHI+CiAgICAgIDx0ZCBzdHlsZT0idGV4dC1hbGlnbjogbGVmdCI+PHN0cm9uZz5TaXRlIENvZGU8L3N0cm9uZz48L3RkPgogICAgICA8dGQgc3R5bGU9InRleHQtYWxpZ246IGxlZnQiPlItIENlcnZpY2FsPC90ZD4KICAgIDwvdHI+CiAgICA8dHI+CiAgICAgIDx0ZCBzdHlsZT0idGV4dC1hbGlnbjogbGVmdCI+PHN0cm9uZz5TcGVjaW1lbiBUYWtlcjwvc3Ryb25nPjwvdGQ+CiAgICAgIDx0ZCBzdHlsZT0idGV4dC1hbGlnbjogbGVmdCI+TWlja2V5IERlZTwvdGQ+CiAgICA8L3RyPgogICAgPHRyPgogICAgICA8dGQgc3R5bGU9InRleHQtYWxpZ246IGxlZnQiPjxzdHJvbmc+UmVxdWVzdGVkIEJ5IEZhY2lsaXR5PC9zdHJvbmc+PC90ZD4KICAgICAgPHRkIHN0eWxlPSJ0ZXh0LWFsaWduOiBsZWZ0Ij5EciBKYW5lIEpvaG4gU3VyZ2VyeTwvdGQ+CiAgICA8L3RyPgogICAgPHRyPgogICAgICA8dGQgc3R5bGU9InRleHQtYWxpZ246IGxlZnQiPjxzdHJvbmc+UmVjZWl2ZWQgQnkgRmFjaWxpdHk8L3N0cm9uZz48L3RkPgogICAgICA8dGQgc3R5bGU9InRleHQtYWxpZ246IGxlZnQiPkFsbGFuYSBGYW1pbHkgUGxhbm5pbmcgQ2xpbmljPC90ZD4KICAgIDwvdHI+CiAgICA8dHI+CiAgICAgIDx0ZCBzdHlsZT0idGV4dC1hbGlnbjogbGVmdCI+PHN0cm9uZz5BZGVxdWFjeTwvc3Ryb25nPjwvdGQ+CiAgICAgIDx0ZCBzdHlsZT0idGV4dC1hbGlnbjogbGVmdCI+UzEgLSBUaGUgc3BlY2ltZW4gaXMgc2F0aXNmYWN0b3J5IGZvciBldmFsdWF0aW9uPC90ZD4KICAgIDwvdHI+CiAgICA8dHI+CiAgICAgIDx0ZCBzdHlsZT0idGV4dC1hbGlnbjogbGVmdCI+PHN0cm9uZz5JbnRlcnByZXRhdGlvbjwvc3Ryb25nPjwvdGQ+CiAgICAgIDx0ZCBzdHlsZT0idGV4dC1hbGlnbjogbGVmdCI+MDIgLSBUaGVyZSBhcmUgZnVuZ2FsIG9yZ2FuaXNtcyBtb3JwaG9sb2dpY2FsbHkgY29uc2lzdGVudCB3aXRoIENhbmRpZGEgc3BlY2llczwvdGQ+CiAgICA8L3RyPgogICAgPHRyPgogICAgICA8dGQgc3R5bGU9InRleHQtYWxpZ246IGxlZnQiPjxzdHJvbmc+R2VuZXJhbCBDYXRlZ29yeTwvc3Ryb25nPjwvdGQ+CiAgICAgIDx0ZCBzdHlsZT0idGV4dC1hbGlnbjogbGVmdCI+RzEgLSBDWVRPTE9HWTogTkVHQVRJVkUgRk9SIElOVFJBRVBJVEhFTElBTCBMRVNJT04gT1IgTUFMSUdOQUNZPC90ZD4KICAgIDwvdHI+CiAgICA8dHI+CiAgICAgIDx0ZCBzdHlsZT0idGV4dC1hbGlnbjogbGVmdCI+PHN0cm9uZz5SZWNvbW1lbmRhdGlvbjwvc3Ryb25nPjwvdGQ+CiAgICAgIDx0ZCBzdHlsZT0idGV4dC1hbGlnbjogbGVmdCI+SDEgLSBQbGVhc2UgcmVjYWxsIGluIHRocmVlIHllYXJzIGZvciBIUFYgcHJpbWFyeSBzY3JlZW5pbmcgdGVzdCwgb3IgaW4gMTIgbW9udGhzIGlmIHRoZSBzY3JlZW5pbmcgcGFydGljaXBhbnQgaXMgaW1tdW5lIGRlZmljaWVudDwvdGQ+CiAgICA8L3RyPgogICAgPHRyPgogICAgICA8dGQgc3R5bGU9InRleHQtYWxpZ246IGxlZnQiPjxzdHJvbmc+R3JhZGU8L3N0cm9uZz48L3RkPgogICAgICA8dGQgc3R5bGU9InRleHQtYWxpZ246IGxlZnQiPk4tIE5lZ2F0aXZlPC90ZD4KICAgIDwvdHI+CiAgPC90Ym9keT4KPC90YWJsZT4KCg==",
"size" : 4924,
"title" : "National Cervical Screening Programme - screening summary as at March 6 2024",
"creation" : "2024-03-06T01:00:00Z"
}
}
]
},
"search" : {
"mode" : "match"
}
},
{
"fullUrl" : "https://fhir.api-test.digital.health.nz/R4/Patient/14a27af4-d621-4068-b678-e878246cbaba",
"resource" : {
"resourceType" : "Patient",
"id" : "14a27af4-d621-4068-b678-e878246cbaba",
"meta" : {
"profile" : [
🔗 "http://hl7.org.nz/fhir/StructureDefinition/NzPatient"
]
},
"extension" : [
{
"url" : "http://hl7.org.nz/fhir/StructureDefinition/nz-ethnicity",
"valueCodeableConcept" : {
"coding" : [
{
"system" : "https://standards.digital.health.nz/ns/ethnic-group-level-4-code",
"code" : "21111",
"display" : "Māori"
}
]
}
},
{
"url" : "http://hl7.org.nz/fhir/StructureDefinition/sex-at-birth",
"valueCodeableConcept" : {
"coding" : [
{
"system" : "http://hl7.org/fhir/administrative-gender",
"code" : "female",
"display" : "female"
}
]
}
}
],
"identifier" : [
{
"use" : "official",
"system" : "https://standards.digital.health.nz/ns/nhi-id",
"value" : "ZCQ3240"
}
],
"name" : [
{
"use" : "usual",
"family" : "Temahoe",
"given" : [
"Kassandra"
]
}
],
"gender" : "other",
"_gender" : {
"extension" : [
{
"url" : "http://hl7.org.nz/fhir/StructureDefinition/gender-original-text",
"valueString" : "Gender Diverse"
}
]
},
"birthDate" : "1968-11-24",
"deceasedBoolean" : true,
"address" : [
{
"use" : "home",
"text" : "375 Jackson Street, Petone, Lower Hutt 5012, New Zealand",
"line" : [
"375 Jackson Street",
"Petone"
],
"city" : "Lower Hutt",
"postalCode" : "5012",
"country" : "NZL"
}
]
},
"search" : {
"mode" : "include"
}
}
]
}