| Note |
|---|
This is documentation for the reworked order entry API, so it only applies to Reference Application 2.1+ and Platform 1.10+ |
...
t : Specifies the order type, for drug or test orders the value would be drugorder or testorder respectively.
caresetting : The uuid of the care setting of the orders to match
...
status : Allowed values are of these restricted to the enum values INACTIVE (only return voided orders) and ANY (return all). Note that this has a different behavior from the standard includeAll parameter that is used to include or exclude voided orders.
Retrieve Orderable Concepts
This is only possible for supported in REST Web Services module versions 12.19.0 and above, make the a GET call request for the orderables like as shown below:
| Code Block |
|---|
GET .../CONTEXT-PATH/ws/rest/v1/orderable |
For more details see on details see the orderable resource in the REST API documentation in the legacy UI by navigating to System Administration -> Advanced Administration, select API Documentation from the REST Web Services section.
Place A Plain Order
...
For a full list of the properties you can specify for a plain order, see the order resource in the REST API documentation in the legacy UI by navigating to System Administration -> Advanced Administration, select API Documentation from the REST Web Services section.
Place A DrugOrder
...
This is achieved by placing a new order of the appropriate type with the action property set to REVISE (MUST be uppercase), the previousOrder property set to the uuid of the order you wish to revise and of course setting the new values of the other properties you intent to change. Typically, you want to provide a reason for the revision which can be a concept for the orderReason property (uuid of the concept) or plain text for the orderReasonNonCoded property. For example, if we wanted to change the instructions of an existing test order below is what the request and the submitted payload would look like.
...
Note that the values of the type, patient, careSetting and concept properties of the revised order MUST match those of the order you wish to revise, this implies you always want to copy their values from it. For retrospective data entry where you wish to set the date when the actual revision took place, you can specify the dateActivated property value otherwise it defaults to now.
Discontinue An Order
This is achieved by placing a new order of the appropriate type with the action property set to DISCONTINUE (MUST be uppercase), the previousOrder property set to the uuid of the order you wish to discontinue. Typically you want to provide a reason for the discontinuation which can be a concept for the orderReason property (uuid of the concept) or plain text for the orderReasonNonCoded property. For example, if we wanted to stop an existing test order below is what the request and the submitted payload would look like.
...
Note that the values of the type, patient, careSetting and concept properties of the discontinuation order MUST match those of the order you wish to discontinue, this implies you always want to copy their values from it. For retrospective data entry where you wish to set the date when the actual discontinuation took place, you can specify the dateActivated property value otherwise it defaults to now.