Post/Submit Resource Status API Overview
This document is a high-level overview about the Resource Status
A resource's current operation level or limitations. Sometimes also referred to as a facility status. API functionality. For more detailed information related to integrating the Resource Status API, refer to Resource Status API.
Juvare provides the Post Resource Status and Submit Resource Status application programming interfaces
A premium feature that allows you to share data between EMResource and a third-party solution. (APIs) that you can use to upload data to EMResource. Using these interfaces to automate data entry saves your staff time, eliminates manual data entry errors, and provides timely operational awareness for all EMResource users. Data is communicated in JSON format.
The Post/Submit Resource Status APIs offer numerous benefits, including:
-
Security: Data is communicated securely using the TLS protocol and it is represented in a JSON schema developed by Juvare.
-
Flexibility: The API is designed to update virtually any status data for any set of resources in EMResource.
-
Configurability: The API is configured based on the requirements and information you specify.
Post Resource Status API is a synchronous process. Submit Resource Status is asynchronous. For details, refer to Resource Status API.
In relation to the Post Resource Status API document and the EMResource solution, there are some common terms that are helpful to keep in mind.
-
Resource: An entity that reports a status. Resources can be facilities, organizations, and agencies that report status information on capabilities, services, and supplies.
-
Status Type: A data element that resources report, such as the number of available staffed ICU beds, ambulance diversion status, or a primary contact’s phone number. These elements can be numeric (for example, gallons of fuel), text (for example, a contact name), dates (for example, last inspection), or multi-select (for example, availability status with options including “Available” and “Unavailable”).
-
Status: A value or option that resources report for a status type.
Examples
| Resource | Status Type | Status |
|---|---|---|
| Memorial Hospital | Available ED Beds | 12 |
| Tamara View Medical Center | NEDOCS (Emergency Department saturation score) | 102 - Overcrowded |
| Methodist Hospital | Available Burn Unit Beds | 3 |
| Alterna Fire Department | Contact Name | Jane Doe |
Status Types
The complete list of status types is dynamic, with more being added regularly. The latest status types are available for EMResource administrators from the Interfaces Summary page, accessed by navigating from the main menu to Interfaces then clicking Multi-Region Interfaces. Once on this page, click the Summary link on the row of the selected interface.
Invoking the API requires a single web service call containing three static parameters.
Juvare supports your development efforts by providing the Resource Status API and examples of request statements. We are also able to assist you with testing the interface.
For more information, contact the Juvare Support Center by sending an email to support@juvare.com or by calling 877-771-0911.
I work with multiple hospitals. How does that work?
APIs are set up individually between a single client and EMResource. This interface can transmit data for multiple facilities. For example, a health system with five hospitals whose data is in one data warehouse may require only one API for all five hospitals. An independently owned single hospital would also require one API.
What does the facility need to do to implement the API?
The client will need to provide a designated point of contact with the hospital or Health System IT staff. This contact will need to be someone with experience programming web service interfaces. Juvare does not write the interface partner code or work within the interface partner’s environment. Interface partners are welcome to ask questions early in the process to determine the feasibility of an API.
In the case of a small hospital without IT capacity, can an API still be done?
In cases where an API is not feasible, a secure file upload (SFTP) site. Excel (XLSX) or comma-separated values (CSV) files containing status updates are generated by your electronic medical record (EMR) or other system and uploaded to the SFTP site.
What is the cost?
The cost is variable depending on several factors including but not limited to the number of status types, the number of facilities, the number of data warehouses sending the data, the type of API, and the degree of customization.
Can a resource or status type be removed if data should no longer be submitted?
Yes, it is generally a simple process to remove resources or status types that no longer should be part of the API.