New Zealand NES IG
1.5.0 - Release

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

Search Flag

Search NesFlags for Patient

This is used to get all Nes Flags for a patient

Search Flags for patientSearch Flags for patientFHIR ClientNES EEEFHIR ClientFHIR ClientNESNESEEEEEEGET[base]/Flag?subject=ZJM9397ValidatequeryNESFlag Response

Search Nes Flags for Patient processing steps:

  1. A FHIR Client sends a GET request to the NES Flag endpoint with the 'subject' query parameter specifying the patient's NHI number
  2. The request is validated - ALT: Validation failure. Operation Outcome resource returned
  3. NES Flags for this NHI are retrieved from the NES database
  4. A bundle of NESFlags is returned to the client - ALT: Empty bundle returned

Search Flags Response Example

search-flag-response-message-1

Business Rules

  1. A Flag search request must include a valid nhi-id

Get and Search Flag for Patient Business Rules and Errors

Business Rule HTTP error EM error Codesystem displayname Additional description
NHI number is a required search parameter 400 Bad request
The subject parameter must be a valid nhi-id 404 Not found EM02002 Cannot be found The NHI is invalid or does not exist