New Zealand NES IG - Local Development build (v1.4.6) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

Update Enrolment

Update Enrolment for Patient

The Operation is used to update an enrolment record - and is currently limited to ending an enrolment for:

• FLS-NF enrolment (First Level Services not funded).
• WCTO enrolment nomination (Well child Tamariki Ora services).
• LMC enrolment (Lead Maternity Carer).

Update Enrolment processing steps:

1. A FHIR Client sends a PUT request to the NES EpisodeOfCare endpoint with the enrolment id in the path, and a payload containing the NesEnrolment resource to be updated
2. The request is validated - ALT: Validation failure. Operation Outcome resource returned
3. The Enrolment EEE database is replaced in the with the enrolment resource described in the update payload
4. The updated NESEnrolment is returned to the client

Update Enrolment Request Example

update to end enrolment request

Update enrolment rules and errors

</tr> </table>

For Request rules and errors click here
Updates to enrolments are currently limited to ending the enrolment only. Update enrolment details is future scope.

Rule	Error code	Error description	Error text	Http code
An update enrolment request must contain: An enrolment id (active) Contained PractitonerRole resource (Facility, Organisation and Pracitioner if present) Contained Patient resource Health service code (type) Enrolment status Enrolment-owner-org End Period and Termination reason code (if ending the enrolment) </ul> </td>	EM07201	Is a required field	Is a required field	400 Bad request
An enrolment can only be updated by creating Organisation	EM01203	An enrolment can only be updated by a user representing the authorised organisation for the enrolment	An enrolment can only be updated by a user representing the authorised organisation for the enrolment	400 Bad request