Register new patient
Registers a new patient with the Client Registry.
Transaction Specification
URL: POST /ws/rest/v1/patients/
Description: Registers a new client/patient in the client registry.
Request
HTTP request body will contain an HL7 v2.5 message that contains all of a patient information (demographic and identifying etc.) as defined below.
Data
See UC01.002 Maintain Client Registry for the latest data structure for this section.
Message specification
The HL7 message will be a HL7 v2.5 ADT_A28 message with the following structure:
See Register-or-Query-Client
Response
HTTP 201 - Created - If the client was saved.
The location (URI) of the newly created resource should be returned in the location header.
Error
HTTP 500 - Server Error - If the server encountered an error.
HTTP 400 - Bad Request - If the HL7 v2.5 message is malformed.
Orchestration
This section describes how this transaction is orchestrated through the HIM (interoperability layer) in order to complete this transaction.
- Call Register new client
Sample Messaging Implementation
Scenario 1
Registers a new patient from the Rwandan MoH's OpenMRS implementation with the Client Registry.
User Interface
TODO
(@Ishimwe, could you please insert images of the filled in user interface from OpenMRS when you have this completed)
Sample Request Message
Note: This message is very incomplete and requires revision:
POST https://hie.jembi.org:5000/ws/rest/v1/patients HTTP/1.1
<?xml version="1.0"?> <ADT_A05 xmlns="urn:hl7-org:v2xml"> <MSH> <MSH.1>|</MSH.1> <MSH.2>^~\&</MSH.2> <MSH.3> <HD.1>null</HD.1> </MSH.3> <MSH.7> <TS.1>20120626</TS.1> </MSH.7> <MSH.9> <MSG.1>ADT</MSG.1> <MSG.2>A05</MSG.2> <MSG.3>ADT^A05^ADT^A05</MSG.3> </MSH.9> <MSH.13>123</MSH.13> </MSH> <PID> <PID.3> <CX.1>1198770004587986</CX.1> <CX.5>NID number</CX.5> </PID.3> <PID.5> <XPN.1> <FN.1>Claudine</FN.1> </XPN.1> <XPN.2>Ishimwe</XPN.2> </PID.5> <PID.7> <TS.1>19870101</TS.1> </PID.7> <PID.8>F</PID.8> <PID.11> <XAD.1> <SAD.1>Mumararungu</SAD.1> </XAD.1> <XAD.3>Rwezamenyo</XAD.3> <XAD.4>Kigali Province</XAD.4> </PID.11> <PID.30>false</PID.30> </PID> <PD1 /> <NK1> <NK1.4> <XAD.1> <SAD.1>Mumararungu</SAD.1> </XAD.1> <XAD.3>Rwezamenyo</XAD.3> <XAD.4>Kigali Province</XAD.4> <XAD.6>Rwanda</XAD.6> </NK1.4> </NK1> <PV1> <PV1.1>1</PV1.1> <PV1.2>U</PV1.2> </PV1> <OBX /> </ADT_A05>
Sample Response Message
HTTP/1.1 201 Created