Permalink
Switch branches/tags
Find file Copy path
160 lines (124 sloc) 8.8 KB

Background

What is the Zynx Health API and FHIR?

The Zynx Health API provides access to Zynx Content in the FHIR standard format. FHIR (Fast Healthcare Interoperability Resources) is a specification for exchanging healthcare data in a modern and developer-friendly way.

Table of Contents

  1. What's New
  2. Production Release Notes
  3. Clinical Decision Support Content
    1. Clinical Glossary
  4. Getting Started
    1. Get your API Key
    2. Make API Calls
    3. Stay Updated

What's New

Date Description
10.25.2017 Added information for Zynx's Value Set
10.27.2017 Beta 2 Release
01.03.2018 Production Release*


* Beta 2 API is being retired completely. It is being replaced by UAT which has production functionality. New Keys will need to be requested for those who had on Beta 2.

Production Release Notes

API Additions and Changes:

  • The API now implements the PlanDefinition resource
  • Each PlanDefinition resource Id is unique to the production environment
  • Get access to and use each unique Id through search as follows:
    • Search by Zynx Content Id to retrieve resource bundles (Access List of Zynx Content Ids here )
    • Search by resouce Id from the response and cache that unique resource Id for faster retrieval of the PlanDefinition
    • (Examples are provided here)

Additional API search parameters available on:

  • lastUpdated, date, description, effectivePeriod, identifier, jurisdiction, name, publisher, status, title, topic, url, version
  • FHIR focus and/or venue which corresponds to topic and care setting

Known Minor Issues:

  • Search by lastUpdate with gt & eq will not return the total # of records
  • Search known to be slower, so normally rely on getting PlanDefinitions by resource Id
    • Example: https://api.zynx.com/t/zynx.com/connect/1.0.0/PlanDefinition/<resource id>

Conformance Information

Clinical Decision Support Content

Order set and plan of care content have Zynx evidence links, custom evidence links, performance measures and key clinical process information embedded. Users without license to ZynxEvidence will not be able to access actual evidence pages.

Trial

Content Type Status Pricing Zynx Content ID
Asthma - Admission to ICU Order Set Available Now Free for approved developers. See developer license agreement for terms. 795
Transition of Care - General Plan of Care Available Now Free for approved developers. See developer license agreement for terms. 3811

For a glossary of clinical terms and Zynx product offerings, click here.

Premium

Product Type Status Pricing
ZynxOrder
[400+]
Order Set Available Now Requires paid license.
ZynxCare
[300+]
Plan of Care Available Now Requires paid license.
Chronic Condition Management (CCM) CCM 14 CCM conditions available: Heart Failure, COPD, Diabetes, and others Requires paid license.

For a glossary of clinical terms and Zynx product offerings, click here.

Getting Started

1. Get your API Key

Each organization will need their own API key. If you haven't done so already, apply for a key.

Wherever API_KEY is referenced below, replace it with the unique key that was emailed to you.

2. SMART on FHIR demonstration app using Zynx API.

Get the code for the demonstration app.

3. Make API Calls

A. Use RESTful API

Field Description Acceptable Value(s)
base Zynx Health API Service Base URL https://api.zynx.com/t/zynx.com/connect/1.0.0/
type Resource type PlanDefinition
id Logical identity of the resource Example: c1d06f95-c9f4-436d-ae8b-4de9c141867b

Presently one resource type will be exposed with Zynx content via the RESTful API of the FHIR workflow module/clinical process:

  • PlanDefinition: This resource allows for the definition of various types of plans as a sharable, consumable, and executable artifact. The resource is general enough to support the description of a broad range of clinical artifacts such as clinical decision support rules, order sets and protocols.
Example Requests

Wherever API_KEY is referenced below, replace it with the unique key that was emailed to you.

Examples are provided for both JSON and XML. Just update the Accept header.

Order Sets
curl --request GET \
--header 'Authorization: Bearer API_KEY' \
--header 'Accept: application/json' \
--header 'cache-control: no-cache' \
https://api.zynx.com/t/zynx.com/connect/1.0.0/PlanDefinition/c1d06f95-c9f4-436d-ae8b-4de9c141867b

curl --request GET \
--header 'Authorization: Bearer API_KEY' \
--header 'Accept: application/xml' \
--header 'cache-control: no-cache' \
https://api.zynx.com/t/zynx.com/connect/1.0.0/PlanDefinition/c1d06f95-c9f4-436d-ae8b-4de9c141867b
Plans of Care
curl --request GET \
--header 'Authorization: Bearer API_KEY' \
--header 'Accept: application/json' \
--header 'cache-control: no-cache' \
https://api.zynx.com/t/zynx.com/connect/1.0.0/PlanDefinition/6d1b044e-17ae-4b72-9e26-f62e187e4e4b

curl --request GET \
--header 'Authorization: Bearer API_KEY' \
--header 'Accept: application/xml' \
--header 'cache-control: no-cache' \
https://api.zynx.com/t/zynx.com/connect/1.0.0/PlanDefinition/6d1b044e-17ae-4b72-9e26-f62e187e4e4b
Postman GUI REST API tool

For instructions about using the Postman GUI REST API tool, click here.

C. More Information

Resource Type Resource Content XML Schema JSON Schema Search Params
PlanDefinition RC XML JSON Search
Zynx's Value Set for Content Item Types
Text or Display Value Code Value Explanation
Section 2 A category used to organize order items (view full explanation)
Orderable (Med) 3 Drug names that can be expressed as medication names or dispensable products (view full explanation)
Reminder 4 An evidence-based note to the clinician at the point of care (view full explanation)
Orderable 5 Non-medication items that can be ordered by a clinician (e.g. nursing orders, laboratory tests, radiology, etc) (view full explanation)
Problem 8 A condition experienced by a patient that can be treated in a clinical care setting (view full explanation)
Outcome 10 Measurable patient-centered conditions/states, behaviors, or perceptions in response to interdisciplinary interventions (view full explanation)
Activity 12 A specific action that the interdisciplinary care team carries out to address a patient problem (view full explanation)
Activitylet 15 Further description or clarification of key concepts for an activity in a plan of care.

4. Stay Updated

Since the Zynx Health API is actively being developed, follow this page to keep up-to-date with the changes.