Stays

The Stays feature allows the user view  the list of all the records of all the active or a specific patient stay in the hospital. It allows the user to retrieve clinical information about a patient's time in the hospital. The stayid is the unique identifier for a specific stay. Stays are associated with Visits, which represent billing information about the patient's time in the hospital

The Stays Changed Subscription feature will allow the user to retrieve changes made in the patient stay   (generally new or updated). The user will need to subscribe. 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

Get list of hospital stays

GET
/v1/{practiceid}/stays/all
BETA: Retrieves a list of patient stays in all statuses and may be filtered by date. If no date range is provided then all stays with an "OPEN" or "DISCHARGED" status at the time of the call will be returned.
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
showdeleted boolean By default it will be false. If set to true, stays with "DELETED" status will also be returned
showpending boolean By default it will be false. If set to true, stays with "PENDING" status will also be returned
enddate string Include stays which were in "OPEN" or "DISCHARGED" status on or before this date.
startdate string Include stays which were in "OPEN" or "DISCHARGED" status on or after this date.
showclosed boolean By default it will be false. If set to true, stays with "CLOSED" status will also be returned.
patientid integer Please remember to never disclose this ID to patients since it may result in inadvertent disclosure that a patient exists in a practice already.
limit integer Number of entries to return (default 1500, max 5000)
offset integer Starting point of entries; 0-indexed
THIRDPARTYUSERNAME string User name of the patient in the third party application.
PATIENTFACINGCALL boolean When 'true' is passed we will collect relevant data and store in our database.

Output Parameters

Expand all
admitdate string The date that the patient was admitted to the stay. Returned in mm/dd/yyyy hh24:mi:ss format.
caseids array The surgery case IDs associated with the stay.
dischargedate string The date that the patient was discharged from the stay. Returned in mm/dd/yyyy hh24:mi:ss format.
lastmodified string The date that the stay's data was last modified. Returned in mm/dd/yyyy hh24:mi:ss format.
lastmodifiedby string The username of the person who last modified the stay's data.
patientid integer Please remember to never disclose this ID to patients since it may result in inadvertent disclosure that a patient exists in a practice already.
status string The status of the stay.
stayid integer The stay ID
stayurl string A URL that links to the patient's chart in athenaNet. If the stay is open, the chart will contain information and documentation pertaining to that particular stay at the hospital. If the stay is closed, the URL will direct to the patient's chart outside the context of a stay.
visitid integer The visit ID associated with the stay.
Example Code

Get specific hospital stay details

GET
/v1/{practiceid}/stays/{stayid}
BETA: Retrieves detail information of a specific patient stay in the hospital including a list of department(s) that the patient was in.
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
stayid integer stayid
THIRDPARTYUSERNAME string User name of the patient in the third party application.
PATIENTFACINGCALL boolean When 'true' is passed we will collect relevant data and store in our database.

Output Parameters

Expand all
admitdate string The date that the patient was admitted to the stay. Returned in mm/dd/yyyy hh24:mi:ss format.
admittingproviderid integer The ID of the admitting provider.
attendingproviderid integer The ID of the attending provider. The attending provider can change during the duration of the stay.
caseids array The surgery case IDs associated with the stay.
departments array
dischargedate string The date that the patient was discharged from the stay. Returned in mm/dd/yyyy hh24:mi:ss format.
dischargeproviderid integer The ID of the discharging provider.
lastmodified string The date that the stay's data was last modified. Returned in mm/dd/yyyy hh24:mi:ss format.
lastmodifiedby string The username of the person who last modified the stay's data.
patientid integer Please remember to never disclose this ID to patients since it may result in inadvertent disclosure that a patient exists in a practice already.
patientlocation array
status string The status of the stay.
stayurl string A URL that links to the patient's chart in athenaNet. If the stay is open, the chart will contain information and documentation pertaining to that particular stay at the hospital. If the stay is closed, the URL will direct to the patient's chart outside the context of a stay.
visitid integer The visit ID associated with the stay.
Example Code

Get list of active hospital stays

GET
/v1/{practiceid}/stays/active
BETA: Retrieves alist of all the active patient stays in the hospital.
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
hospitalbedid integer The ID of the bed where the patient's stay is currently located.
hospitalunitid integer The ID of the unit where the patient's stay is currently located.
hospitalroomid integer The ID of the room where the patient's stay is currently located.
departmentid integer The ID of the department where the patient's stay is currently located.
patientid integer Please remember to never disclose this ID to patients since it may result in inadvertent disclosure that a patient exists in a practice already.
limit integer Number of entries to return (default 1500, max 5000)
offset integer Starting point of entries; 0-indexed

Output Parameters

Expand all
admitdate string The date that the patient was admitted to the stay. Returned in mm/dd/yyyy hh24:mi:ss format.
admittingproviderid integer The ID of the admitting provider.
attendingproviderid integer The ID of the attending provider. The attending provider can change during the duration of the stay.
caseids array The surgery case IDs associated with the stay.
departmentid integer The ID of the department where the patient's stay is currently located.
dischargedate string The date that the patient was discharged from the stay. Returned in mm/dd/yyyy hh24:mi:ss format.
dischargeproviderid integer The ID of the discharging provider.
hospitalbedid integer The ID of the bed the stay is currently located in.
hospitalbedname string The name of the bed the stay is currently located in.
hospitalroomid integer The ID of the room the stay is currently located in.
hospitalroomname string The name of the room the stay is currently located in.
hospitalunitid integer The ID of the unit the stay is currently located in.
hospitalunitname string The name of the unit the stay is currently located in.
lastmodified string The date that the stay's data was last modified. Returned in mm/dd/yyyy hh24:mi:ss format.
lastmodifiedby string The username of the person who last modified the stay's data.
patientid integer Please remember to never disclose this ID to patients since it may result in inadvertent disclosure that a patient exists in a practice already.
status string Whether the stay is open or discharged. Returns "OPEN" or "DISCHARGED" depending on the status.
stayid integer The stay ID.
stayurl string A URL that links to the patient's chart in athenaNet. If the stay is open, the chart will contain information and documentation pertaining to that particular stay at the hospital. If the stay is closed, the URL will direct to the patient's chart outside the context of a stay.
visitid integer The visit ID associated with the stay.
Example Code

Get list of changes in hospital stays based on subscribed events

GET
/v1/{practiceid}/stays/changed
BETA: Retrieves the list of changes in hospital stays
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
admitdate string The date that the patient was admitted to the stay. Returned in mm/dd/yyyy hh24:mi:ss format.
admittingproviderid integer The ID of the admitting provider.
attendingproviderid integer The ID of the attending provider. The attending provider can change during the duration of the stay.
caseids array The surgery case IDs associated with the stay.
departmentid integer The ID of the department that the stay was most recently associated with.
dischargedate string The date that the patient was discharged from the stay. Returned in mm/dd/yyyy hh24:mi:ss format.
dischargeproviderid integer The ID of the discharging provider.
hospitalbedid integer The ID of the Hospital bed that the stay was most recently associated with.
hospitalbedname string The name of the Hospital bed that the stay was most recently associated with.
hospitalroomid integer The ID of the Hospital room that the stay was most recently associated with.
hospitalroomname string The name of the Hospital room that the stay was most recently associated with.
hospitalunitid integer The ID of the Hospital unit that the stay was most recently associated with.
hospitalunitname string The name of the Hospital unit that the stay was most recently associated with.
lastmodified string The date that the stay's data was last modified. Returned in mm/dd/yyyy hh24:mi:ss format.
lastmodifiedby string The username of the person who last modified the stay's data.
patientid integer The ID of the patient associated with the stay.
status string The status of the stay.
stayid integer The stay ID.
stayurl string A URL that links to the patient's chart in athenaNet. If the stay is open, the chart will contain information and documentation pertaining to that particular stay at the hospital. If the stay is closed, the URL will direct to the patient's chart outside the context of a stay.
visitid integer The visit ID associated with the stay.
Example Code

Get list of hospital stays change events to which you can subscribe

GET
/v1/{practiceid}/stays/changed/subscription/events
BETA: Retrieves the list of events you can subscribe to for when stays requests are worked.
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
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 stays

GET
/v1/{practiceid}/stays/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
Try in Postman

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 stays

POST
/v1/{practiceid}/stays/changed/subscription
BETA: Subscribes for change events for single inpatient hospital stays
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

Output Parameters

Expand all
success string Returns if the call to manipulate subscriptions for stays was successful.
Example Code

Unsubscribe to all/specific change events for hospital stays

DELETE
/v1/{practiceid}/stays/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
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 stays was successful.
Example Code