New Zealand NES IG
1.4.0-SNAPSHOT - Release

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

Get Enrolment

Get Enrolment by ID


Future scope - this is not currently implemented

The Get Enrolment operation allows an authorised user to retrieve an Enrolment record for a Patient using a known Enrolment record id.

Get Enrolment by IDIntegrating application userIntegrating application userIntegrating applicationIntegrating application<FHIR API> NES<FHIR API> NESEEEEEEEnter Enrolment-idGET[base]/EpisodeOfCare/[enrolment-id]Validate[]RequestReturn NESEnrolmentrecordDisplay Enrolment details

Get Enrolment by ID processing steps:

  1. The user supplies an enrolment-id to be looked up.
  2. The integrating application sends an HTTP GET request for the Enrolment record using the enrolment-id. E.g. GET<Endpoint>/EpisodeOfCare/[Enrolment-id]
  3. The request is validated - ALT: Validation failure. Operation Outcome resource returned
  4. The Enrolment record is retrieved from the NES - ALT: Enrolment Record not found. Operation Outcome resource returned
  5. The response containing the Enrolment record is returned.

Get Enrolment Response Example


Business Rules

  1. A Get Enrolment request must include a valid Enrolment-id