Operating Room (OR) Cases

Operating Room (OR) Cases  Changed Subscription feature allows the user to retrieve any changes made to the OR cases  since the last time this request was run. The user will need to initiate subscription. For more information about subscriptions, please refer Changed Data Subscriptions

Was this information helpful? Yes | No Thank you for your feedback! What went wrong? Incomplete or incorrect information | Irrelevant Content | Others
Submit

Endpoints

Get list of changes in OR-cases based on subscribed events
GET
/v1/{practiceid}/orcase/changed

Retrieves a list of new or updated OR-cases.

Was this information helpful? Yes | No Thank you for your feedback! What went wrong? Incomplete or incorrect information | Irrelevant Content | Others
Submit
Try in Postman

Input Parameters

Expand all

❙ required

practiceid integer practiceid
leaveunprocessed boolean For testing purposes, do not mark records as processed.
showprocessedenddatetime string See showprocessedstartdatetime.
showprocessedstartdatetime string Show already processed changes. This will show changes that you previously retrieved at some point after this datetime mm/dd/yyyy hh24:mi:ss (Eastern). Can be used to refetch data if there was an error, such as a timeout, and records are marked as already retrieved. This is intended to be used with showprocessedenddatetime and for a short period of time only. Also note that all messages will eventually be deleted.
limit integer Number of entries to return (default 1000, max 10000)Please note that this endpoint has a different default and max than normal.
offset integer Starting point of entries; 0-indexed

Output Parameters

Expand all
cancellationdatetime string The date and time that the procedure was canceled. MM/DD/YYYY 24HH:MM. Note: Preference cards will be an empty array for canceled OR cases.
orcaseid integer Booking id associated with the procedure.
orcaselocation string The room where the booking is scheduled to take place
patientid integer The id of the patient the booking is for.
preferencecards array An array of case preference cards. (an empty array if the OR case has been canceled)
primarysurgeonname string The name of the primary surgeon on the booking
primarysurgeonproviderid integer The id of the primary surgeon on the booking.
startdatetime string The date and time that the procedure is scheduled to start. MM/DD/YYYY 24HH:MM
Example Code
Get list of subscribed events for changes in hospital OR-cases
GET
/v1/{practiceid}/orcase/changed/subscription

Retrieves list of events applicable for hospital OR-cases changes

Was this information helpful? Yes | No Thank you for your feedback! What went wrong? Incomplete or incorrect information | Irrelevant Content | Others
Submit
Try in Postman

Input Parameters

Expand all

❙ required

practiceid integer practiceid

Output Parameters

Expand all
status string Will return one of following statuses: ACTIVE, INACTIVE, or PARTIAL. The PARTIAL status means that not all events are subscribed to. In the event of a problem, UNKNOWN may be returned.
subscriptions array List of events you are subscribed to.
Example Code
Subscribe to all/specific change events for hospital OR-cases
POST
/v1/{practiceid}/orcase/changed/subscription

Subscribes for change events for hospital OR-cases

Was this information helpful? Yes | No Thank you for your feedback! What went wrong? Incomplete or incorrect information | Irrelevant Content | Others
Submit
Try in Postman

Input Parameters

Expand all

❙ required

practiceid integer practiceid
Content-Type string Content type of the payload

❙ Request Body

Expand all
eventname string By default, you are subscribed to all possible events. If you only wish to subscribe to an individual event, pass the event name with this argument.

Output Parameters

Expand all
success string Returns if the call to manipulate subscriptions for orcase was successful.
Example Code
Unsubscribe to all/specific change events for hospital OR-cases
DELETE
/v1/{practiceid}/orcase/changed/subscription

Delete a specific event which is no longer required

Was this information helpful? Yes | No Thank you for your feedback! What went wrong? Incomplete or incorrect information | Irrelevant Content | Others
Submit
Try in Postman

Input Parameters

Expand all

❙ required

practiceid integer practiceid
eventname string By default, you are unsubscribed from all possible events. If you only wish to unsubscribe from an individual event, pass the event name with this argument.

Output Parameters

Expand all
success string Returns if the call to manipulate subscriptions for orcase was successful.
Example Code
Get list of hospital OR-cases change events to which you can subscribe
GET
/v1/{practiceid}/orcase/changed/subscription/events

Retrieves a list of events you can subscribe to when OR-cases are added or updated.

Was this information helpful? Yes | No Thank you for your feedback! What went wrong? Incomplete or incorrect information | Irrelevant Content | Others
Submit
Try in Postman

Input Parameters

Expand all

❙ required

practiceid integer practiceid

Output Parameters

Expand all
status string Will return one of following statuses: ACTIVE, INACTIVE, or PARTIAL. The PARTIAL status means that not all events are subscribed to. In the event of a problem, UNKNOWN may be returned.
subscriptions array List of events you are subscribed to.
Example Code