Hospital Systems Visit

Hospital system visit  feature allows the user  to  record and view visit charges  for  a specific patient stay in the hospital.

The Hospital System visit  Changed Subscription feature will allow the user to retrieve changes made   (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

Endpoints

Get list of hospital visits (with filters)
GET
/v1/{practiceid}/visits

This endpoint retrieves visits based on a variety of filters.

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 Boolean flag to include deleted visits in the output.
nodepartment boolean Boolean flag to include visits where department ID is null.
showvisitcharges boolean Boolean flag to also return visit charges in the output.
statusids array Only return visits that match one of these statuses
visitids array Only return these visit IDs.
departmentid integer Department ID to filter on.
unregistered boolean Boolean flag to only return visits where the registration has not been completed.
patientid integer Patient ID to find visits for.
visitcaseids array Array of VisitCase IDs to filter on.
limit integer Number of entries to return (default 1500, max 5000)
offset integer Starting point of entries; 0-indexed

Output Parameters

Expand all
accommodationid integer Accommodation ID attached to this visit.
admissionsourcecode string Admission Source Code attached to this visit.
admissionsourceid integer Admission Source ID attached to this visit.
admissionsourcename string Admission Source Name attached to this visit.
admissiontypecode string Admission Type Code attached to this visit.
admissiontypeid integer Admission Type ID attached to this visit.
admissiontypename string Admission Type Name attached to this visit.
admittingproviderid integer Admitting Provider ID attached to this visit.
allergies string String of allergies.
attendingproviderid integer Attending Provider ID for this visit.
checkindate string Date checked in.
createddate string Date created.
currentvisitsegmentid integer Current Visit Segment ID.
deleteddate string Date the visit was deleted.
deletednote string Note recording the reason for deletion of the visit.
departmentid integer Department ID of this visit.
departmentname string Department name for this visit.
dischargedate string Date discharged.
dischargedispositioncode string Discharge Disposition Code of this visit.
dischargedispositionid integer Discharge Disposition ID for this visit.
dischargedispositionname string Discharge Disposition Name for this visit.
dischargeproviderid integer Discharge Provider ID for this visit.
firstvisitsegmentid integer First Visit Segment ID.
hospitalbedid integer Hospital Bed ID.
hospitalroomid integer Hospital Room ID.
lastmodifieddate string Date the visit was modified last.
levelofcareid integer Level Of Care ID.
levelofcarename string Level Of Care Name.
maincomplaint string Main Complaint.
mspinsurancetypeid integer MSP Insurance Type ID.
mspinsurancetypesetyn string MSP Insurance Type Set.
operatingproviderid integer Operating Provider ID.
otheroperatingproviderid integer Other Operating Provider ID.
patientid integer Patient ID.
primarypatientinsuranceid integer Primary Patient Insurance ID.
problemlist string String of problems for the patient for this visit.
razorencounterid integer Razor Encounter ID.
razoriser integer Indicates if the razor encounter is an ER encounter.
registereddate string Date registered.
registrationcompleteyn string Indicates whether or not registration is complete for this visit.
secondarypatientinsuranceid integer Secondary Patient Insurance ID.
statusid integer Status ID of the visit.
statusname string Status Name.
statusshortname string Status Short Name.
transfervisitid integer Transfer Visit ID.
visitbillids array Visit Bill IDs.
visitcaseid integer Visit Case ID.
visitcharges array Visit Charges.
visitid integer ID of this visit.
Example Code
Add charge to a hospital visit
POST
/v1/{practiceid}/visits/{visitid}/visitcharge

Create a record of visit charge to a Hospital visit

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
visitid integer visitid
Content-Type string Content type of the payload

❙ Request Body

Expand all
chargedate string Date of the charge. Formatted as MM/DD/YYYY.
renderingproviderid integer The rendering provider's ID.
servicedepartmentid integer The department where the service happened.
username string Username of who is creating the charge.
visitcharges array An array of charges to be added to a Visit.

Output Parameters

Expand all
errormessage string If the operation failed, this will contain any error messages.
success string Whether the operation was successful.
visitchargeids array If the operation succeeded, this will contain the IDs of any visit charges that were created.
Example Code
Get list of changes in hospital visits based on subscribed events
GET
/v1/{practiceid}/visits/changed

Retrieves the list of changes in hospital visits

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.
departmentid array Department ID. Multiple departments are allowed, either comma separated or with multiple values.
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
checkindate string Timestamp for when the patient was checked in as MM/DD/YYY.
departmentid integer The department ID this visit is associated with.
dischargedate string Timestamp for when the patient was discharged as MM/DD/YYY.
hospitalbed string The hospital bed associated with the visit.
hospitalroom string The hospital room associated with the visit.
patientname string The name of the patient for whom this visit belongs to.
visitcaseid integer The ID of the visitcase associated with this visit. This is the Visit number shown at the top of the Patient Access and Billing views of a hospital visit.
visitid integer The ID of this visit. Although it can be the same, this is not the Visit number shown at the top of the Patient Access and Billing views of a hospital visit.
visitstatus string The current status of the visit.
Example Code
Subscribe to all/specific change events for hospital visits
POST
/v1/{practiceid}/visits/changed/subscription

Subscribes for changed hospital visits events

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
departmentids array For every New/Update Subscriptions complete list of departmentids should be passed. NOTE: Without DepartmentIDs entire Context/Practice will be subscribed.
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 visits was successful.
Example Code
Unsubscribe to all/specific change events for hospital visits
DELETE
/v1/{practiceid}/visits/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 visits was successful.
Example Code
Get list of subscribed events for changes in hospital visits
GET
/v1/{practiceid}/visits/changed/subscription

Retrieves list of events applicable for hospital visit 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
Get list of hospital visits change events to which you can subscribe
GET
/v1/{practiceid}/visits/changed/subscription/events

Retrieves a list of events you can subscribe to for when visits are updated or checked 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

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