Surgery Cases
Surgery Cases Changed Subscription feature allows the user to retrieve any changes made to the surgery 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
-
Subscription
Get list of changes in surgical cases based on subscribed events
GET
/v1/{practiceid}/surgerycases/changed
BETA: Retrieves a list of new or updated surgical cases.
Was this information helpful?
Yes | No
Thank you for your feedback!
What went wrong?
Incomplete or incorrect information |
Irrelevant Content
| Others
Submit
Input Parameters
Expand all❙ required
practiceid
integer
practiceid
leaveunprocessed
boolean
For testing purposes, do not mark records as processed
departmentid
integer
The ID of the department.
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 processed messages will eventually be deleted.
limit
integer
Number of entries to return (default 1500, max 5000)
offset
integer
Starting point of entries; 0-indexed
Output Parameters
Expand all
caseid
integer
Case id associated with the procedure.
duration
string
The duration of the surgery in number of minutes.
endtime
string
The time when the surgery is to end ('HH:MI AM' format).
orcaseid
integer
Booking id representing the surgery.
orcaselocation
string
The room where the booking is scheduled to take place
patientid
integer
The id of the patient being operated.
procedurecodes
array
An Array of IDs for the clinical order type (also referred to as the procedure).
proceduredesc
array
An Array of the names of the procedures.
scheduledstarttime
string
The date and time that the procedure is scheduled to start.('MM/DD/YYYY 24HH:MM' format).
starttime
string
The time when the surgery is to begin ('HH:MI AM' format).
stayid
integer
Stay ID associated with the booking.
surgeonid
integer
The provider id of the primary surgeon on the booking
surgeonname
string
The name of the primary surgeon on the booking
surgerystatus
string
Text holding active state information regarding the surgery case.
visitid
integer
Visit ID associated with the booking.
Example Code
Get list of hospital surgical cases change events to which you can subscribe
GET
/v1/{practiceid}/surgerycases/changed/subscription/events
BETA: Returns list of events you can subscribe to when surgical 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
Input Parameters
Expand all❙ required
practiceid
integer
practiceid
Output Parameters
Expand all
departmentids
array
List of Departmentids subscribed
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
Get list of subscribed events for changes in hospital surgical cases
GET
/v1/{practiceid}/surgerycases/changed/subscription
BETA: Retrieves list of events applicable for hospital stays changes
Was this information helpful?
Yes | No
Thank you for your feedback!
What went wrong?
Incomplete or incorrect information |
Irrelevant Content
| Others
Submit
Input Parameters
Expand all❙ required
practiceid
integer
practiceid
Output Parameters
Expand all
departmentids
array
List of Departmentids subscribed
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 surgical cases
POST
/v1/{practiceid}/surgerycases/changed/subscription
BETA: Subscribes for change events for hospital surgical cases
Was this information helpful?
Yes | No
Thank you for your feedback!
What went wrong?
Incomplete or incorrect information |
Irrelevant Content
| Others
Submit
Input Parameters
Expand all❙ required
practiceid
integer
practiceid
Content-Type
string
Content type of the payload
Output Parameters
Expand all
success
string
Returns if the call to manipulate subscriptions for surgerycases was successful.
Example Code
Unsubscribe to all/specific change events for hospital surgical cases
DELETE
/v1/{practiceid}/surgerycases/changed/subscription
BETA: 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
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 surgerycases was successful.
Example Code