Jump to Content

API Reference

Overview

Introduction
API Overview
Getting Started
Authentication
Pagination
Errors
Webhooks
Metadata
Getting Help
Dates

OAUTH API

Get Tokenpost

PATIENT PROFILE API

PATIENT
PROBLEM
ALLERGY
ALLERGY DOCUMENTATION (NKDA)
DRUG INTOLERANCE
HISTORY
FAMILY HISTORY
IMMUNIZATION
VACCINE
INSURANCE CARD
PROVIDER TEAM
Patient Profile Photo

ORDERS API

LAB ORDER
ANCILLARY COMPANY
CARDIAC ORDER
CARDIAC ORDER TEST
CARDIAC CENTER
IMAGING ORDER
IMAGING ORDER TEST
IMAGING CENTER
PULMONARY ORDER
PULMONARY ORDER TEST
PULMONARY CENTER
SLEEP ORDER
SLEEP ORDER TEST
SLEEP CENTER
LAB ORDER SET
LAB ORDER TEST
LAB ORDER COMPENDIUM
LAB VENDOR
LAB VENDOR PATIENT SITE
LAB VENDOR INTEGRATION
LAB FACILITY IDENTIFIERS

[PREMIUM] PATIENT INSURANCE API

INSURANCE ELIGIBILITY

PATIENT DOCUMENT API

DOCUMENT TAG
CLINICAL DOCUMENT
VITALS
VISIT NOTE
NON-VISIT NOTE
MEDICATION
DISCONTINUED MEDICATION
REPORT TYPE
REPORT
CCDA
- The CCDA Object
- Get CCDAget
REFERRALS
REFILLS
PATIENT FORM
FILLS
Patient Form Request
Patient Form Submission
HISTORICAL MEDICATION DOWNLOAD REQUESTS
INCOMING FILE
VISIT NOTE TYPES
VISIT NOTE TEMPLATES
INJECTION (BETA)

MESSAGING API

MESSAGE THREAD
THREAD MESSAGE
THREAD MEMBER

SCHEDULING API

APPOINTMENT
APPOINTMENT ROOM
- The Appointment Room Object
- Find Appointment Roomsget
EVENT
RECURRING EVENT GROUP
APPOINTMENT TYPES

BILLING API

BILL
OUTSTANDING BALANCE
- Updating Outstanding Balancepost
BILLING CODES

INSURANCE API

INSURANCE COMPANY
INSURANCE PLAN

PRACTICE API

PHYSICIAN
SERVICE LOCATION
PRACTICE
OFFICE STAFF
STAFF GROUPS
DELEGATE PERMISSIONS
PRINT HEADERS
CONTACTS
MEDICATION ORDER TEMPLATES
HANDOUTS
INSURANCE ELIGIBILITY USAGE
- The Insurance Eligibility Usage Object
- Find Insurance Eligibility Usageget
PRACTICE MEDICATIONS

Reference Data API

LANGUAGE
- The Language Object
- Find Languagesget
PHARMACY
- The Pharmacy Object
- Get Pharmacyget
REFERENCE MEDICATION (BETA)
PACKAGED MEDICATION (BETA)
PACKAGED MEDICATION LABELER (BETA)

Care Gaps API

Definitions
Caregaps

Event Subscription API

The Subscription object
Find Subscriptionsget
Subscribe to a resource updatespost
Delete a Subscriptiondelete
The Event object
Find published eventsget
Get published eventget
Update published eventput
Update published eventpatch

User Management API

The User Object
Create Userpost
Update Userpatch

CHANGELOG

Changelog

Visit Notes API

Notes
Custom Blocks
- List Custom Blocksget

Powered by

The CCDA Object

Object Definition

{
  "base64_ccda": "PD94bWwgdmVyc2lvbj0iMS4wIj8+....................."
}

Patient chart exported as CCDA as base64-encoded string.

Table of Contents
- Object Definition