Making GET requests on the SHR adapter module

A GET request is made on the SHR Adapter module for the purpose of retriving data stored in its database as hl7 messages.

The user may specify various mandatory and optional parameters to filter his GET request.

These parameters are -

Parameter name	is mandatory	description
patientId	yes	The ID of the patient whose encounters you wish to retrive
idType	yes	The idType of the provided patient id. Currently, the only supported ID type is 'ECID'
encounterUniqueId	no	The UUID of a specific encounter you wish to retrive
elid	no	The Enterprise Location Identifier (ELID) used to filter results
dateStart	no	A start date to filter encounters
dateEnd	no	A end date to filter encounters

If the user specified an encounterUinqueId (UUID) , the GET request will only return a single encounter, provided that the said encounter compiles with other parameters passed in.

Based on other parameters, one or many encounters may be retrived as a single hl7 message.

The elid, or Enterprise Location Identifier is also used to filter results.

If a user specifies an elid in his get request, then the retrieved message will return all matching encounters whose elid's are NOT equal to the one specified by the user.

A successful GET request will result in a hl7 message. This message will be retrrieved in an XML format.

A sample message that the user may expect to receive can be seen here here.

For sample error messages that a GET request may result in, see here.