GET 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’s GET Resource Status application programming interface (API) is a web service interface you can use to retrieve resource status data from EMResource. Our API interfaces with third-party data analytics software to meet various client needs.

The Post Resource Status API offers numerous benefits, including:

  • Security: Data is encrypted, both in transit (using the TLS 1.2 protocol) and at rest (using the AES-256 algorithm), in compliance with industry standards. Fine-grained access control limits the set of data that each web service user can retrieve.

  • Flexibility: The API is designed to retrieve virtually any status data for any set of resources in EMResource.

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

In relation to the GET Resource Status API document and EMResource, 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 type of status that resources record, such as availability, date, quantity, score, or description.

  • Status: A value or option that resources report for a status type.

Examples

Resource Status Type Status
Memorial Hospital ED (status of the Emergency Department) Fully Operational Options: Fully Operational, Experiencing Limitations, Closed
Tamara View Medical Center NEDOCS (Emergency Department saturation score) 102 - Overcrowded
West Campus ICC (Incident Command Center status) Activated Options: Activated, Not Activated
Generator 12 Fuel (capacity in liters) 40
Stony Creek EMS Agency EMS Services (service availability) Limited Availability Options: Available, Limited Availability, Out of Service, Weather Delays
Miller Building Situation (campus building status) Locked Down Options: Open, Closed, Locked Down
Student Activity Center County (resource’s county) Springfield
County West Hospital Pharmacist (currently available) 2
Clearwater Medical Center MCI Red (mass casualty incident red triage patients the facility can accommodate) 4
Methodist Hospital Burn unit beds (currently available) 3
Alterna Fire Department BLS – 1 hour (BLS-level ambulances can be on scene in one hour) 1
Carmichael Hospital Mental Health (unit availability) Divert Female Options: Available, Divert Female, Divert Mail, Divert All
Hawkeye EMS Agency Adult Ventilators (currently available) 5

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 and authentication credentials provided by Juvare.

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.

What information will be transferred via the API, and for which facilities?

The API can transfer virtually any status types for any resource. The above table provides examples. Clients frequently retrieve data from hospitals, long-term care facilities, first responders, and many more.

What do I need to do, and what does the third party have to do to implement the API?

The client may need to serve as a liaison with the third party and have their own account or license with the third-party software.

The interface partner work will need to be performed by 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.

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 receiving 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, removing resources or status types that are no longer part of the API is generally a simple process.