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.
- What's New
- Production Release Notes
- Clinical Decision Support Content
- Getting Started
- Functionality by Content Type \ Content Item Type
| Date | Description |
|---|---|
| 2024.6.3 | Production Release |
• ZynxCare
• ZynxCare Extended
• ZynxCare for Home Health
• ZynxCare for Rehabilitation
• ZynxOrder
• Content update containing 27 plans of care
• Content update containing 7 assessments
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.
| 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 |
| Opioid Use Disorder | CCM | Available Now | Free for approved developers. See developer license agreement for terms. | CCM13 |
For a glossary of clinical terms and Zynx product offerings, click here.
| 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.
Each organization will need their own API key. If you haven't done so already, apply for a key.
Wherever
API_KEYis referenced below, replace it with the unique key that was emailed to you.
Get the code for the demonstration app.
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: a263fc5f-a8e5-4c15-8505-ad993967677c |
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.
Wherever
API_KEYis 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%7C0:" 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%7C0:795"
• 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%7C0:3811"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&_count=50" to access all Zynx content allowed per your given privileges per token or with Trial token.
Examples can use "https://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 Custom content allowed per your given privileges per token.
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/a263fc5f-a8e5-4c15-8505-ad993967677c
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/a263fc5f-a8e5-4c15-8505-ad993967677c
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/8ac80263-4468-48f4-af20-e47157599e7e
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/8ac80263-4468-48f4-af20-e47157599e7e
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>
See the full example FHIR response for the Pain Plan of Care, click here.
For instructions about using the Postman GUI REST API tool, click here.
| Resource Type | Resource Content | XML Schema | JSON Schema | Search Params |
|---|---|---|---|---|
| PlanDefinition | RC | XML | JSON | Search |
| (Parameter) | Description | Type | Required | Accepted Value | Example |
|---|---|---|---|---|---|
| count | Returns the resource count specified that are available for the privileges of the token used | (Number) | No | 1-200 | ?_count=50 |
| identifier | Returns content / Plan Definition for given contentId | N\A | No | Zynx contentIds | \?identifier=http://www.zynxhealth.com/codings/id/zynx/ contentid%7C0:<AuthorSpace contentId> Trial Order Set 795 example: \?identifier=http://www.zynxhealth.com/codings/id/zynx/ contentid%7C0:795 |
| lastUpdated | Returns resources updated for given date or date range in results | (Date) | No | Date Format YYYY-MM-DD | ?_lastUpdated=2021-04 returns content updated in a given month ?_lastUpdated=2021 returns content updated in a given year ?_lastUpdated=2021-05-01 returns content updated in a given day ?_lastUpdated=gt2021-04 returns content updated after given date specified when (Prefix) gt is used |
| title | Returns a content / Plan Definition resource with specified title | (String) | No | Characters | ?title=Asthma - Admission to ICU |
| status | The current status of the plan definition | (Token) | No | active, or retired | ?status=active or ?status=retired |
Click here for detailed funtionality within given content item types.
| FHIR Display Value \ [Description] | 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 \ [Patient Engagement] | 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 \ [Goal] | 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 \ [Activity Detail] | 15 | Further description or clarification of key concepts for an activity in a plan of care. |
| Frequency \ [Activity Frequency] | 16 | Frequency for an activity in a plan of care. |
Since the Zynx Health API is actively being developed, follow this page to keep up-to-date with the changes.