POST Resource Status API Overview

This document is a high-level overview about the Resource Status API functionality. For more detailed information related to integrating the Resource Status API, refer to Resource Status Partner Interoperability.

Juvare provides the POST Resource Status application programming interface (API) as a web service interface you can use to upload data to the EMResource. Using this interface 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 using XML.

The POST Resource Status API offers numerous benefits, including:

  • Security: Data is communicated securely using the TLS 1.2 protocol, in compliance with XML data standards, and it is represented in an XML schema developed by Juvare.

  • Flexibility: The API is designed to update virtually any status data for any set of resources in EMResource. Data can be uploaded using either of the most commonly used protocols (JSON via REST or XML via SOAP using an XML schema developed by Juvare).

  • Configurability: The API is configured based on the requirements and information you specify.

POST Resource Status API is a synchronous process. If you want to perform the same actions using an asynchronous process, refer to Resource Status Partner Interoperability.

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 BLS – 1 hour (BLS-level ambulances can be on scene in one hour) 1

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 within the solution by opening the Setup menu and clicking Status Types.

Invoking the API requires a single web service call containing three static parameters.

Juvare supports your development efforts by providing the Resource Status Partner Interoperability 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, an alternative is an Automated Data Uploader. The Automated Data Uploader is a service installed on a virtual machine or server located behind a facility’s firewall. Excel (XLSX) or comma-separated values (CSV) files containing status updates are generated by your electronic medical record (EMR) or other system and placed in a specific computer folder.

The files are automatically picked up by the ADU service and applied in EMResource. Note there still is some IT capability required on the part of the facility as the ADU is based on a Microsoft PowerShell script and scheduled task.

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.