Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Transaction Specification

URL: PUT /ws/rest/v1/patient/$<pat-ID>

Description: Updates a client’s record in the client registry. This transaction sends a acknowledgement or an error in return if the transaction succeeds or fails.

Request

...

HTTP request body will contain the HL7 v2.5 message, that describes the patient's record, as defined below. The PUT request also contains 1 parameter in the URL that identifies the patient to update.

Parameters

...

$<pat-ID>
This parameter represents a patient's ID. It must be specified in the following format:
<ID-type>-<ID-number>
Where <ID-type> is one of the following:

...

Eg. PUT /ws/rest/v1/patient/NID-1234567890123Message

Data

...

See UC01.002 Maintain Client Registry for the latest data structure for this section.HL7v2 message

Messaging specification

...

The HL7 message will be a HL7 v2.5 ADT_A31 message with the following structure:
See UpdateClient

Response

...

HTTP 200 - OK - If the client record was updated successfully.

Error

...

HTTP 500 - Server Error - If the server encountered an error.

...

This section describes how this transaction is orchestrated through the HIM (interoperability layer) in order to complete this transaction.

  1. Call Update client record

Sample Messaging Implementation

...