POST v1/order/submitORM

Submit ORM: Submit an ORM to EMR-Link for transmission to service provider.

Request Information

URI Parameters

None.

Body Parameters

ORM to be submitted.

ORM
NameDescriptionTypeAdditional information
ORMMessage

Contains the HL7 ORM message text

string

None.

Request Formats

application/json, text/json

Sample:
{
  "ORMMessage": "sample string 1"
}

application/xml, text/xml

Sample:
<ORM xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <ORMMessage>sample string 1</ORMMessage>
</ORM>

Response Information

Resource Description

SubmitORMResponse
NameDescriptionTypeAdditional information
ACKMessage

HL7 ACK Message

string

None.

ResponseMessage

Optional message if request is successful but there was a non-fatal error. (e.g. Not able to send the order on to the lab because of missing, required fields).

string

None.

Error

Will be set to True if any errors occur during the processing of the API method.

boolean

None.

ErrorMessage

Will contain an error message string if Error is True.

string

None.

Response Formats

application/json, text/json

Sample:
{
  "ACKMessage": "sample string 1",
  "ResponseMessage": "sample string 2",
  "Error": true,
  "ErrorMessage": "sample string 4"
}

application/xml, text/xml

Sample:
<SubmitORMResponse xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <Error>true</Error>
  <ErrorMessage>sample string 4</ErrorMessage>
  <ACKMessage>sample string 1</ACKMessage>
  <ResponseMessage>sample string 2</ResponseMessage>
</SubmitORMResponse>