Generated Narrative: OperationDefinition SDHRParticipationStatusOperation
URL: [base]/$participation-status
| Use | Name | Scope | Cardinality | Type | Binding | Documentation |
| IN | patient | 1..1 | Reference | Reference must be an NHI Patient URL with format https://api.hip.digital.health.nz/fhir/nhi/v1/Patient/ZZZ1111 or ZZZ11AA | ||
| OUT | patient | 1..1 | Reference | The patient reference resolved for the participation status lookup. | ||
| OUT | consentFound | 1..1 | boolean | Indicates whether a consent record was found for the patient in the Shared Digital Health Record service. | ||
| OUT | hnzParticipationIndicator | 1..1 | boolean | Indicates whether the patient is currently participating in the Shared Digital Health Record service. | ||
| OUT | hasActiveRecords | 1..1 | boolean | Indicates whether the patient has active records available in the service. | ||
| OUT | hasArchivedRecords | 1..1 | boolean | Indicates whether the patient has archived records in the service. | ||
| OUT | hasAnyRecords | 1..1 | boolean | Indicates whether the patient has any records, active or archived, in the service. | ||
| OUT | enrolmentInformationFound | 1..1 | boolean | Indicates whether enrolment information was found for the patient. | ||
| OUT | enrolmentOrgId | 0..1 | string | The enrolment organisation identifier, when enrolment information is available for the patient. | ||
| OUT | enrolmentFacilityId | 0..1 | string | The enrolment facility identifier, when enrolment information is available for the patient. | ||
| OUT | enrolmentNHI | 0..1 | string | The enrolment NHI value, when enrolment information is available for the patient. | ||
| OUT | enrolmentFacilityParticipation | 0..* | The facility-level participation status for facilities associated with the patient's enrolment. Only present when enrolment information is found. | |||
| OUT | enrolmentFacilityParticipation.facilityId | 1..1 | Reference | The HPI Location reference for the enrolled facility. | ||
| OUT | enrolmentFacilityParticipation.participationIndicator | 1..1 | boolean | Whether the patient is participating at this enrolled facility. | ||
| OUT | facilityParticipation | 0..* | The facility-level participation status for all facilities where the patient has an explicit participation record. | |||
| OUT | facilityParticipation.facilityId | 1..1 | Reference | The HPI Location reference for the facility. | ||
| OUT | facilityParticipation.participationIndicator | 1..1 | boolean | Whether the patient is participating at this facility. |