NZ Shared Digital Health Record API
1.0.2 - release
NZ Shared Digital Health Record API
1.0.2 - release
NZ Shared Digital Health Record API - Local Development build (v1.0.2) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions
| Active as of 2026-06-30 |
@prefix fhir: <http://hl7.org/fhir/> .
@prefix owl: <http://www.w3.org/2002/07/owl#> .
@prefix rdfs: <http://www.w3.org/2000/01/rdf-schema#> .
@prefix xsd: <http://www.w3.org/2001/XMLSchema#> .
# - resource -------------------------------------------------------------------
<http://hl7.org/fhir/OperationDefinition/SDHRParticipationStatusOperation> a fhir:OperationDefinition ;
fhir:nodeRole fhir:treeRoot ;
fhir:Resource.id [ fhir:value "SDHRParticipationStatusOperation"] ;
fhir:DomainResource.text [
fhir:Narrative.status [ fhir:value "generated" ] ;
fhir:Narrative.div "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p class=\"res-header-id\"><b>Generated Narrative: OperationDefinition SDHRParticipationStatusOperation</b></p><a name=\"SDHRParticipationStatusOperation\"> </a><a name=\"hcSDHRParticipationStatusOperation\"> </a><p>URL: [base]/$participation-status</p><h3>Parameters</h3><table class=\"grid\"><tr><td><b>Use</b></td><td><b>Name</b></td><td><b>Scope</b></td><td><b>Cardinality</b></td><td><b>Type</b></td><td><b>Binding</b></td><td><b>Documentation</b></td></tr><tr><td>IN</td><td>patient</td><td/><td>1..1</td><td><a href=\"http://hl7.org/fhir/R4/references.html#Reference\">Reference</a></td><td/><td><div><p>Reference must be an NHI Patient URL with format https://api.hip.digital.health.nz/fhir/nhi/v1/Patient/ZZZ1111 or ZZZ11AA</p>\n</div></td></tr><tr><td>OUT</td><td>patient</td><td/><td>1..1</td><td><a href=\"http://hl7.org/fhir/R4/references.html#Reference\">Reference</a></td><td/><td><div><p>The patient reference resolved for the participation status lookup.</p>\n</div></td></tr><tr><td>OUT</td><td>consentFound</td><td/><td>1..1</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#boolean\">boolean</a></td><td/><td><div><p>Indicates whether a consent record was found for the patient in the Shared Digital Health Record service.</p>\n</div></td></tr><tr><td>OUT</td><td>hnzParticipationIndicator</td><td/><td>1..1</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#boolean\">boolean</a></td><td/><td><div><p>Indicates whether the patient is currently participating in the Shared Digital Health Record service.</p>\n</div></td></tr><tr><td>OUT</td><td>hasActiveRecords</td><td/><td>1..1</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#boolean\">boolean</a></td><td/><td><div><p>Indicates whether the patient has active records available in the service.</p>\n</div></td></tr><tr><td>OUT</td><td>hasArchivedRecords</td><td/><td>1..1</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#boolean\">boolean</a></td><td/><td><div><p>Indicates whether the patient has archived records in the service.</p>\n</div></td></tr><tr><td>OUT</td><td>hasAnyRecords</td><td/><td>1..1</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#boolean\">boolean</a></td><td/><td><div><p>Indicates whether the patient has any records, active or archived, in the service.</p>\n</div></td></tr><tr><td>OUT</td><td>enrolmentInformationFound</td><td/><td>1..1</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#boolean\">boolean</a></td><td/><td><div><p>Indicates whether enrolment information was found for the patient.</p>\n</div></td></tr><tr><td>OUT</td><td>enrolmentOrgId</td><td/><td>0..1</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#string\">string</a></td><td/><td><div><p>The enrolment organisation identifier, when enrolment information is available for the patient.</p>\n</div></td></tr><tr><td>OUT</td><td>enrolmentFacilityId</td><td/><td>0..1</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#string\">string</a></td><td/><td><div><p>The enrolment facility identifier, when enrolment information is available for the patient.</p>\n</div></td></tr><tr><td>OUT</td><td>enrolmentNHI</td><td/><td>0..1</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#string\">string</a></td><td/><td><div><p>The enrolment NHI value, when enrolment information is available for the patient.</p>\n</div></td></tr><tr><td>OUT</td><td>enrolmentFacilityParticipation</td><td/><td>0..*</td><td/><td/><td><div><p>The facility-level participation status for facilities associated with the patient's enrolment. Only present when enrolment information is found.</p>\n</div></td></tr><tr><td>OUT</td><td>enrolmentFacilityParticipation.facilityId</td><td/><td>1..1</td><td><a href=\"http://hl7.org/fhir/R4/references.html#Reference\">Reference</a></td><td/><td><div><p>The HPI Location reference for the enrolled facility.</p>\n</div></td></tr><tr><td>OUT</td><td>enrolmentFacilityParticipation.participationIndicator</td><td/><td>1..1</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#boolean\">boolean</a></td><td/><td><div><p>Whether the patient is participating at this enrolled facility.</p>\n</div></td></tr><tr><td>OUT</td><td>facilityParticipation</td><td/><td>0..*</td><td/><td/><td><div><p>The facility-level participation status for all facilities where the patient has an explicit participation record.</p>\n</div></td></tr><tr><td>OUT</td><td>facilityParticipation.facilityId</td><td/><td>1..1</td><td><a href=\"http://hl7.org/fhir/R4/references.html#Reference\">Reference</a></td><td/><td><div><p>The HPI Location reference for the facility.</p>\n</div></td></tr><tr><td>OUT</td><td>facilityParticipation.participationIndicator</td><td/><td>1..1</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#boolean\">boolean</a></td><td/><td><div><p>Whether the patient is participating at this facility.</p>\n</div></td></tr></table></div>"
] ;
fhir:OperationDefinition.url [ fhir:value "https://fhir-ig.digital.health.nz/sdhr/OperationDefinition/SDHRParticipationStatusOperation"] ;
fhir:OperationDefinition.version [ fhir:value "1.0.2"] ;
fhir:OperationDefinition.name [ fhir:value "ParticipationStatus"] ;
fhir:OperationDefinition.status [ fhir:value "active"] ;
fhir:OperationDefinition.kind [ fhir:value "operation"] ;
fhir:OperationDefinition.date [ fhir:value "2026-06-30T04:46:48+00:00"^^xsd:dateTime] ;
fhir:OperationDefinition.publisher [ fhir:value "Health New Zealand"] ;
fhir:OperationDefinition.contact [
fhir:index 0 ;
fhir:ContactDetail.name [ fhir:value "Health New Zealand" ] ;
fhir:ContactDetail.telecom [
fhir:index 0 ;
fhir:ContactPoint.system [ fhir:value "url" ] ;
fhir:ContactPoint.value [ fhir:value "https://github.com/tewhatuora" ]
]
], [
fhir:index 1 ;
fhir:ContactDetail.name [ fhir:value "HNZ Integration Team" ] ;
fhir:ContactDetail.telecom [
fhir:index 0 ;
fhir:ContactPoint.system [ fhir:value "email" ] ;
fhir:ContactPoint.value [ fhir:value "integration@tewhatuora.govt.nz" ] ;
fhir:ContactPoint.use [ fhir:value "work" ]
]
] ;
fhir:OperationDefinition.description [ fhir:value "This operation retrieves a patient's Shared Digital Health Record participation status.\nThis operation should be used by data providers in the Shared Digital Health Record ecosystem such as Patient Management Systems (PMS) or Electronic Health Record (EHR) systems.\nIt returns whether the patient is participating in the service, whether enrolment information was found, and whether the patient has active, archived, or any records available in the service. The scope of the status returned is the API consumer, for example an HPI Facility where patient data is held.\n\nFor an example response payload for this operation see:\n- [Parameters resource for participation status response - not participating](./Parameters-ParametersParticipationStatusResponse.html) : No consent, enrolment, or records found for the patient.\n- [Parameters resource for participation status response - enrolment found, not participating](./Parameters-ParametersParticipationStatusEnrolmentResponse.html) : Enrolment information is found but the patient is not currently participating.\n- [Parameters resource for participation status response - actively participating](./Parameters-ParametersParticipationStatusActiveResponse.html) : Patient is actively participating with active records at a facility.\n- [Parameters resource for participation status response - actively participating with enrolment](./Parameters-ParametersParticipationStatusEnrolmentActiveResponse.html) : Patient is actively participating with enrolment information and facility-level participation details.\n\nTo make a request to this operation the API Consumer must POST a `Parameters` payload to the operation URL (e.g. `POST https://api.sdhr.digital.health.nz/s2s/$participation-status`).\n\nThe operation is idempotent, meaning that multiple requests with the same parameters will have the same effect as a single request.\nThe operation is expected to be called by a healthcare provider on behalf of the patient, and the patient must be identified by their NHI.\nThe operation will return a `Parameters` resource containing the patient reference and participation status indicators."] ;
fhir:OperationDefinition.code [ fhir:value "participation-status"] ;
fhir:OperationDefinition.system [ fhir:value "true"^^xsd:boolean] ;
fhir:OperationDefinition.type [ fhir:value "false"^^xsd:boolean] ;
fhir:OperationDefinition.instance [ fhir:value "false"^^xsd:boolean] ;
fhir:OperationDefinition.parameter [
fhir:index 0 ;
fhir:OperationDefinition.parameter.name [ fhir:value "patient" ] ;
fhir:OperationDefinition.parameter.use [ fhir:value "in" ] ;
fhir:OperationDefinition.parameter.min [ fhir:value "1"^^xsd:integer ] ;
fhir:OperationDefinition.parameter.max [ fhir:value "1" ] ;
fhir:OperationDefinition.parameter.documentation [ fhir:value "Reference must be an NHI Patient URL with format https://api.hip.digital.health.nz/fhir/nhi/v1/Patient/ZZZ1111 or ZZZ11AA" ] ;
fhir:OperationDefinition.parameter.type [ fhir:value "Reference" ]
], [
fhir:index 1 ;
fhir:OperationDefinition.parameter.name [ fhir:value "patient" ] ;
fhir:OperationDefinition.parameter.use [ fhir:value "out" ] ;
fhir:OperationDefinition.parameter.min [ fhir:value "1"^^xsd:integer ] ;
fhir:OperationDefinition.parameter.max [ fhir:value "1" ] ;
fhir:OperationDefinition.parameter.documentation [ fhir:value "The patient reference resolved for the participation status lookup." ] ;
fhir:OperationDefinition.parameter.type [ fhir:value "Reference" ]
], [
fhir:index 2 ;
fhir:OperationDefinition.parameter.name [ fhir:value "consentFound" ] ;
fhir:OperationDefinition.parameter.use [ fhir:value "out" ] ;
fhir:OperationDefinition.parameter.min [ fhir:value "1"^^xsd:integer ] ;
fhir:OperationDefinition.parameter.max [ fhir:value "1" ] ;
fhir:OperationDefinition.parameter.documentation [ fhir:value "Indicates whether a consent record was found for the patient in the Shared Digital Health Record service." ] ;
fhir:OperationDefinition.parameter.type [ fhir:value "boolean" ]
], [
fhir:index 3 ;
fhir:OperationDefinition.parameter.name [ fhir:value "hnzParticipationIndicator" ] ;
fhir:OperationDefinition.parameter.use [ fhir:value "out" ] ;
fhir:OperationDefinition.parameter.min [ fhir:value "1"^^xsd:integer ] ;
fhir:OperationDefinition.parameter.max [ fhir:value "1" ] ;
fhir:OperationDefinition.parameter.documentation [ fhir:value "Indicates whether the patient is currently participating in the Shared Digital Health Record service." ] ;
fhir:OperationDefinition.parameter.type [ fhir:value "boolean" ]
], [
fhir:index 4 ;
fhir:OperationDefinition.parameter.name [ fhir:value "hasActiveRecords" ] ;
fhir:OperationDefinition.parameter.use [ fhir:value "out" ] ;
fhir:OperationDefinition.parameter.min [ fhir:value "1"^^xsd:integer ] ;
fhir:OperationDefinition.parameter.max [ fhir:value "1" ] ;
fhir:OperationDefinition.parameter.documentation [ fhir:value "Indicates whether the patient has active records available in the service." ] ;
fhir:OperationDefinition.parameter.type [ fhir:value "boolean" ]
], [
fhir:index 5 ;
fhir:OperationDefinition.parameter.name [ fhir:value "hasArchivedRecords" ] ;
fhir:OperationDefinition.parameter.use [ fhir:value "out" ] ;
fhir:OperationDefinition.parameter.min [ fhir:value "1"^^xsd:integer ] ;
fhir:OperationDefinition.parameter.max [ fhir:value "1" ] ;
fhir:OperationDefinition.parameter.documentation [ fhir:value "Indicates whether the patient has archived records in the service." ] ;
fhir:OperationDefinition.parameter.type [ fhir:value "boolean" ]
], [
fhir:index 6 ;
fhir:OperationDefinition.parameter.name [ fhir:value "hasAnyRecords" ] ;
fhir:OperationDefinition.parameter.use [ fhir:value "out" ] ;
fhir:OperationDefinition.parameter.min [ fhir:value "1"^^xsd:integer ] ;
fhir:OperationDefinition.parameter.max [ fhir:value "1" ] ;
fhir:OperationDefinition.parameter.documentation [ fhir:value "Indicates whether the patient has any records, active or archived, in the service." ] ;
fhir:OperationDefinition.parameter.type [ fhir:value "boolean" ]
], [
fhir:index 7 ;
fhir:OperationDefinition.parameter.name [ fhir:value "enrolmentInformationFound" ] ;
fhir:OperationDefinition.parameter.use [ fhir:value "out" ] ;
fhir:OperationDefinition.parameter.min [ fhir:value "1"^^xsd:integer ] ;
fhir:OperationDefinition.parameter.max [ fhir:value "1" ] ;
fhir:OperationDefinition.parameter.documentation [ fhir:value "Indicates whether enrolment information was found for the patient." ] ;
fhir:OperationDefinition.parameter.type [ fhir:value "boolean" ]
], [
fhir:index 8 ;
fhir:OperationDefinition.parameter.name [ fhir:value "enrolmentOrgId" ] ;
fhir:OperationDefinition.parameter.use [ fhir:value "out" ] ;
fhir:OperationDefinition.parameter.min [ fhir:value "0"^^xsd:integer ] ;
fhir:OperationDefinition.parameter.max [ fhir:value "1" ] ;
fhir:OperationDefinition.parameter.documentation [ fhir:value "The enrolment organisation identifier, when enrolment information is available for the patient." ] ;
fhir:OperationDefinition.parameter.type [ fhir:value "string" ]
], [
fhir:index 9 ;
fhir:OperationDefinition.parameter.name [ fhir:value "enrolmentFacilityId" ] ;
fhir:OperationDefinition.parameter.use [ fhir:value "out" ] ;
fhir:OperationDefinition.parameter.min [ fhir:value "0"^^xsd:integer ] ;
fhir:OperationDefinition.parameter.max [ fhir:value "1" ] ;
fhir:OperationDefinition.parameter.documentation [ fhir:value "The enrolment facility identifier, when enrolment information is available for the patient." ] ;
fhir:OperationDefinition.parameter.type [ fhir:value "string" ]
], [
fhir:index 10 ;
fhir:OperationDefinition.parameter.name [ fhir:value "enrolmentNHI" ] ;
fhir:OperationDefinition.parameter.use [ fhir:value "out" ] ;
fhir:OperationDefinition.parameter.min [ fhir:value "0"^^xsd:integer ] ;
fhir:OperationDefinition.parameter.max [ fhir:value "1" ] ;
fhir:OperationDefinition.parameter.documentation [ fhir:value "The enrolment NHI value, when enrolment information is available for the patient." ] ;
fhir:OperationDefinition.parameter.type [ fhir:value "string" ]
], [
fhir:index 11 ;
fhir:OperationDefinition.parameter.name [ fhir:value "enrolmentFacilityParticipation" ] ;
fhir:OperationDefinition.parameter.use [ fhir:value "out" ] ;
fhir:OperationDefinition.parameter.min [ fhir:value "0"^^xsd:integer ] ;
fhir:OperationDefinition.parameter.max [ fhir:value "*" ] ;
fhir:OperationDefinition.parameter.documentation [ fhir:value "The facility-level participation status for facilities associated with the patient's enrolment. Only present when enrolment information is found." ] ;
fhir:OperationDefinition.parameter.part [
fhir:index 0 ;
fhir:OperationDefinition.parameter.name [ fhir:value "facilityId" ] ;
fhir:OperationDefinition.parameter.use [ fhir:value "out" ] ;
fhir:OperationDefinition.parameter.min [ fhir:value "1"^^xsd:integer ] ;
fhir:OperationDefinition.parameter.max [ fhir:value "1" ] ;
fhir:OperationDefinition.parameter.documentation [ fhir:value "The HPI Location reference for the enrolled facility." ] ;
fhir:OperationDefinition.parameter.type [ fhir:value "Reference" ]
], [
fhir:index 1 ;
fhir:OperationDefinition.parameter.name [ fhir:value "participationIndicator" ] ;
fhir:OperationDefinition.parameter.use [ fhir:value "out" ] ;
fhir:OperationDefinition.parameter.min [ fhir:value "1"^^xsd:integer ] ;
fhir:OperationDefinition.parameter.max [ fhir:value "1" ] ;
fhir:OperationDefinition.parameter.documentation [ fhir:value "Whether the patient is participating at this enrolled facility." ] ;
fhir:OperationDefinition.parameter.type [ fhir:value "boolean" ]
]
], [
fhir:index 12 ;
fhir:OperationDefinition.parameter.name [ fhir:value "facilityParticipation" ] ;
fhir:OperationDefinition.parameter.use [ fhir:value "out" ] ;
fhir:OperationDefinition.parameter.min [ fhir:value "0"^^xsd:integer ] ;
fhir:OperationDefinition.parameter.max [ fhir:value "*" ] ;
fhir:OperationDefinition.parameter.documentation [ fhir:value "The facility-level participation status for all facilities where the patient has an explicit participation record." ] ;
fhir:OperationDefinition.parameter.part [
fhir:index 0 ;
fhir:OperationDefinition.parameter.name [ fhir:value "facilityId" ] ;
fhir:OperationDefinition.parameter.use [ fhir:value "out" ] ;
fhir:OperationDefinition.parameter.min [ fhir:value "1"^^xsd:integer ] ;
fhir:OperationDefinition.parameter.max [ fhir:value "1" ] ;
fhir:OperationDefinition.parameter.documentation [ fhir:value "The HPI Location reference for the facility." ] ;
fhir:OperationDefinition.parameter.type [ fhir:value "Reference" ]
], [
fhir:index 1 ;
fhir:OperationDefinition.parameter.name [ fhir:value "participationIndicator" ] ;
fhir:OperationDefinition.parameter.use [ fhir:value "out" ] ;
fhir:OperationDefinition.parameter.min [ fhir:value "1"^^xsd:integer ] ;
fhir:OperationDefinition.parameter.max [ fhir:value "1" ] ;
fhir:OperationDefinition.parameter.documentation [ fhir:value "Whether the patient is participating at this facility." ] ;
fhir:OperationDefinition.parameter.type [ fhir:value "boolean" ]
]
] .
# - ontology header ------------------------------------------------------------
<http://hl7.org/fhir/OperationDefinition/SDHRParticipationStatusOperation.ttl> a owl:Ontology ;
owl:imports fhir:fhir.ttl ;
owl:versionIRI <http://build.fhir.org/OperationDefinition/SDHRParticipationStatusOperation.ttl> .
IG © 2025+ Health New Zealand. Package tewhatuora.fhir.nz-shared-digital-health-record#1.0.2 based on FHIR 4.0.1. Generated 2026-06-30
Links: Table of Contents |
QA Report