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

Update Entitlement

Update Entitlement for Patient

This operation is used to update a patient’s entitlement.

Current functionality is limited to updating a Community Services Card entitlement.

Scenarios

  1. A person presents with a community services card, however the card returned from the Entitlements service is showing a different card number
  2. A card needs to be ended, as it has been entered in error.
Update EntitlementIntegrating application userIntegrating application userIntegrating applicationIntegrating application<FHIR API> NES Entitlement<FHIR API> NES EntitlementDBDBUpdate a personsEntitlementPUT[base]/Coverage/[entitlement-id]Validate[]UpdateHTTP 200 - EntitlementUpdatedDisplay updatedentitlement details

Update Entitlement processing steps:

  1. The user inputs CSC details to update the entitlement details or end the entitlement.
  2. The integrating application sends a PUT request to the NES Coverage endpoint with a payload containing the NesEntitlement resource to be updated.
  3. The request is validated - ALT: Validation failure. Operation Outcome resource returned
  4. The Entitlement is updated in the database.
  5. The updated NesEntitlement is returned to the client, or the Entitlement is ended.

Update Entitlement Request Example

TBC

Update Entitlement Rules and Errors

For Request rules and errors click here
Rule Error code Error description Error text Http code
An update Entitlement request must include::
  • EntitlementID
  • beneficiary (NHI number of the patient)
  • identifier (the entitlement card number)
  • contained Patient resource
  • organisation approving the entitlement (payor)
  • Termination reason and period end (if ending the entitlement)
    • EM07201
    • EM02002
  • EM07201
  • EM07201
  • EM07201
  • EM07201
  • EM07201
    • Is a required field
    • Cannot be found
  • Is a required field
  • Is a required field
  • Is a required field
  • Is a required field
  • Is a required field
    • EntitlementID is a required field
    • Supplied entitlement-id cannot be found
  • beneficiary is a required field
  • identifier is a required field
  • contained patient is a required field
  • payor is a required field
  • Termination reason is a required field
    • 400 Bad request</li>
    • 400 Bad request</li>
  • 400 Bad request
  • 400 Bad request
  • 400 Bad request
  • 400 Bad request
  • 400 Bad request
The contained patient must match Entitlement beneficiary and validate with the National Health Index
  • EM02008
  • The patient identity information supplied does not match the patient identity information in the NHI.
  • The patient identity information supplied does not match the patient identity information in the NHI.
  • 400 Bad request
The NHI provided must match the NHI associated with the Entitlement.
  • TBC
  • The requested NHI is not consistent with the Entitlement.
  • The requested NHI is not consistent with the Entitlement.
  • 400 Bad request
A request to update an entitlement can be made against any valid NHI Identifier (live or dormant) for that patient.
  • EM02002
  • Cannot be found.
  • NHI number supplied cannot be found.
  • 400 Bad request
An update Patient entitlement request must include a valid CSC Card Number.
  • EM12006
  • The CSC Card Number must be known to Te Whatu Ora.
  • The CSC Card Number must be known to Te Whatu Ora.
  • 400 Bad request
A Patient can only be linked to 1 active Entitlement type i.e. CSC or CSCDependent.
  • EM12001
  • The patient cannot have both CSC and CSCDependent Entitlements active at the same time.
  • The patient cannot have both CSC and CSCDependent Entitlements active at the same time.
  • 400 Bad request
A Patient can have a maximum of one Active CSC Entitlement.
  • EM12002
  • The patient cannot have more than one active CSC Entitlement.
  • The patient cannot have more than one active CSC Entitlement.
  • 400 Bad request
A CSC Entitlement can only be associated to one (non-dependent) Patient.
  • EM12003
  • The CSC Entitlement is already assigned to another patient.
  • The CSC Entitlement is already assigned to another patient.
  • 400 Bad request
A patient can have multiple CSC dependent entitlements.
A CSC Dependent entitlement can only be created for a person 18 or younger.
  • EM12016
  • The patient is not a valid age to be a CSC Dependent.
  • The patient is not a valid age to be a CSC Dependent.
  • 400 Bad request