Fetches a single patient by ID.

Transaction Specification

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

Description: This transaction fetches a client specified by the ID supplied.

Request

The GET request contains one required parameter for patient ID.

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:

• NID - for a national identification number
• MUT - Mutuelle number
• RAM - Rama number
• OMRS<fosaid of facility> - OpenMRS identifier eg, OMRS357-123456789

Eg. GET /ws/rest/v1/patient/NID-1234567890123

Response

HTTP 200 - OK

Data

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

Messaging specification

The HL7 message will be a HL7 v2.5 ADT_A28 message with the following structure:
See Register-or-Query-Client

Error

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

HTTP 404 - Not Found - If the patient cannot be found

Orchestration

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

1. Call Get client

Sample Messaging Implementation

Scenario 1

Fetches a single patient by ID

User Interface

TODO

Sample Request Message

GET https://hie.jembi.org:5000/ws/rest/v1/patient/1234567890 HTTP/1.1

Sample Response Message

Note: This message is very incomplete and requires revision:

<ADT_A05 xmlns="urn:hl7-org:v2xml">
   <MSH>
      <MSH.1>|</MSH.1>
      <MSH.2>^~\&amp;</MSH.2>
      <MSH.7>
         <TS.1>20120322120032.479+0200</TS.1>
      </MSH.7>
      <MSH.9>
         <MSG.1>ADT</MSG.1>
         <MSG.2>A28</MSG.2>
         <MSG.3>ADT_A05</MSG.3>
      </MSH.9>
      <MSH.10>2</MSH.10>
      <MSH.11>
         <PT.1>T</PT.1>
      </MSH.11>
      <MSH.12>
         <VID.1>2.5</VID.1>
      </MSH.12>
   </MSH>
</ADT_A05>