{ "resourceType" : "OperationDefinition", "id" : "SDHRParticipationStatusOperation", "text" : { "status" : "generated", "div" : "

Generated Narrative: OperationDefinition SDHRParticipationStatusOperation

URL: [base]/$$participation-status

Parameters

UseNameScopeCardinalityTypeBindingDocumentation
INpatient1..1Reference

Reference must be an NHI Patient URL with format https://api.hip.digital.health.nz/fhir/nhi/v1/Patient/ZZZ1111 or ZZZ11AA

\n
OUTpatient1..1Reference

The patient reference resolved for the participation status lookup.

\n
OUThnzParticipationIndicator1..1boolean

Indicates whether the patient is currently participating in the Shared Digital Health Record service.

\n
OUThasActiveRecords1..1boolean

Indicates whether the patient has active records available in the service.

\n
OUThasArchivedRecords1..1boolean

Indicates whether the patient has archived records in the service.

\n
OUThasAnyRecords1..1boolean

Indicates whether the patient has any records, active or archived, in the service.

\n
OUTenrollmentInformationFound1..1boolean

Indicates whether enrollment information was found for the patient.

\n
OUTenrollmentOrgId0..1string

The enrollment organization identifier, when enrollment information is available for the patient.

\n
OUTenrollmentFacilityId0..1string

The enrollment facility identifier, when enrollment information is available for the patient.

\n
OUTenrollmentNHI0..1string

The enrollment NHI value, when enrollment information is available for the patient.

\n
" }, "url" : "https://fhir-ig.digital.health.nz/sdhr/OperationDefinition/SDHRParticipationStatusOperation", "version" : "1.0.1", "name" : "ParticipationStatus", "status" : "active", "kind" : "operation", "date" : "2026-06-08T23:58:08+00:00", "publisher" : "Health New Zealand", "contact" : [{ "name" : "Health New Zealand", "telecom" : [{ "system" : "url", "value" : "https://github.com/tewhatuora" }] }, { "name" : "HNZ Integration Team", "telecom" : [{ "system" : "email", "value" : "integration@tewhatuora.govt.nz", "use" : "work" }] }], "description" : "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 enrollment 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](./Parameters-ParametersParticipationStatusResponse.html) : This example shows the `Parameters` resource returned by the operation when participation status information is found for a patient.\n- [Parameters resource for participation status response with enrollment details](./Parameters-ParametersParticipationStatusEnrollmentResponse.html) : This example shows the `Parameters` resource returned by the operation when enrollment details are known for a patient.\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.", "code" : "participation-status", "system" : true, "type" : false, "instance" : false, "parameter" : [{ "name" : "patient", "use" : "in", "min" : 1, "max" : "1", "documentation" : "Reference must be an NHI Patient URL with format https://api.hip.digital.health.nz/fhir/nhi/v1/Patient/ZZZ1111 or ZZZ11AA", "type" : "Reference" }, { "name" : "patient", "use" : "out", "min" : 1, "max" : "1", "documentation" : "The patient reference resolved for the participation status lookup.", "type" : "Reference" }, { "name" : "hnzParticipationIndicator", "use" : "out", "min" : 1, "max" : "1", "documentation" : "Indicates whether the patient is currently participating in the Shared Digital Health Record service.", "type" : "boolean" }, { "name" : "hasActiveRecords", "use" : "out", "min" : 1, "max" : "1", "documentation" : "Indicates whether the patient has active records available in the service.", "type" : "boolean" }, { "name" : "hasArchivedRecords", "use" : "out", "min" : 1, "max" : "1", "documentation" : "Indicates whether the patient has archived records in the service.", "type" : "boolean" }, { "name" : "hasAnyRecords", "use" : "out", "min" : 1, "max" : "1", "documentation" : "Indicates whether the patient has any records, active or archived, in the service.", "type" : "boolean" }, { "name" : "enrollmentInformationFound", "use" : "out", "min" : 1, "max" : "1", "documentation" : "Indicates whether enrollment information was found for the patient.", "type" : "boolean" }, { "name" : "enrollmentOrgId", "use" : "out", "min" : 0, "max" : "1", "documentation" : "The enrollment organization identifier, when enrollment information is available for the patient.", "type" : "string" }, { "name" : "enrollmentFacilityId", "use" : "out", "min" : 0, "max" : "1", "documentation" : "The enrollment facility identifier, when enrollment information is available for the patient.", "type" : "string" }, { "name" : "enrollmentNHI", "use" : "out", "min" : 0, "max" : "1", "documentation" : "The enrollment NHI value, when enrollment information is available for the patient.", "type" : "string" }] }