Skip to content
Permalink
master
Switch branches/tags
Go to file
 
 
Cannot retrieve contributors at this time

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
1.26.2021 Production Release*

Production Release Notes

Content Additions – Last updated Q4, 2020

• ZynxCare
· New content update containing 1 plan of care

• ZynxCare Extended
· New content update containing 37 plans of care

• ZynxCare for Chronic Conditions
· New content update containing 1 plan of care
· New content update containing 26 common problems

• ZynxOrder Order Sets
· New content update containing 6 order sets

Content Updates – Last updated Q4, 2020

• ZynxCare
• ZynxCare Extended
• ZynxCare for Chronic Conditions
• ZynxCare for Home Health
• ZynxCare for Rehabilitation
• ZynxOrder Order Sets

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.
ZynxCare Extended
[100+]
Plan of Care Available Now Requires paid license.
ZynxCare for Chronic Conditions
[26]
CCM Available Now Requires paid license.
ZynxCare for Home Health
[50+]
Plan of Care Available Now Requires paid license.
ZynxCare for Rehabilitation
[50+]
Plan of Care Available Now 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: c6afff10-6cbf-4a19-b012-5344bfbf8080

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.

B. Content Examples

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.

Examples can use "https://api.zynx.com/t/zynx.com/connect/1.0.0/PlanDefinition?identifier=http://www.zynxhealth.com/codings/id/zynx/contentid%7C" to access a Plan Definition for a given contentId if the Zynx contentId is known and accessible.
• Order Set content id 795 "https://api.zynx.com/t/zynx.com/connect/1.0.0/PlanDefinition?identifier=http://www.zynxhealth.com/codings/id/zynx/contentid%7C795"
• Plan of Care content id 3811 "https://api.zynx.com/t/zynx.com/connect/1.0.0/PlanDefinition?identifier=http://www.zynxhealth.com/codings/id/zynx/contentid%7C3811"

Examples can use "https://uat-api.zynx.com/t/zynx.com/connect/1.0.0/PlanDefinition?identifier=http://www.zynxhealth.com/codings/id/zynx/contentid%7C&_count=50" to access all Zynx content allowed per your given privileges.

Examples can use "https://uat-api.zynx.com/t/zynx.com/connect/1.0.0/PlanDefinition?identifier=http://www.zynxhealth.com/codings/id/custom/contentid%7C&_count=50" to access all Zynx content allowed per your given privileges.

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/c6afff10-6cbf-4a19-b012-5344bfbf8080

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/c6afff10-6cbf-4a19-b012-5344bfbf8080
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/00b6d5ce-ae02-4436-9311-12a238e4acbb

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/00b6d5ce-ae02-4436-9311-12a238e4acbb
Custom Plan of Care
Example Requests
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/<resourceId>

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/<resourceId>
Example Response

See the full example FHIR response for the Pain Plan of Care, click here.

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.