Jump to Content
API Reference
v2.0
API Reference
API Reference
API Reference
v2.0
API Reference
The Vital Object
All
Pages
Start typing to search…
JUMP TO
Overview
Introduction
API Overview
Getting Started
Authentication
Pagination
Errors
Webhooks
Metadata
Getting Help
Dates
OAUTH API
Get Token
post
Patient Profile API
Patients
The Patient Object
List Patients
get
Create Patient
post
Delete Patient
del
Retrieve Patient
get
Partially Update Patient
patch
Update Patient
put
Problems
The Problem Object
List Problems
get
Create Problem
post
Delete Problem
del
Retrieve Problem
get
Partially Update Problem
patch
Update Problem
put
Allergies
The Allergy Object
List Allergies
get
Create Allergy
post
Delete Allergy
del
Retrieve Allergy
get
Partially Update Allergy
patch
Update Allergy
put
Allergy Documentation (NKDA)
The Allergy Documentation (NKDA) Object
List Allergy Documentations
get
Create Allergy Documentation
post
Delete Allergy Documentation
del
Retrieve Allergy Documentation
get
Drug Intolerances
The Drug Intolerance Object
List Drug Intolerances
get
Create Drug Intolerance
post
Delete Drug Intolerance
del
Retrieve Drug Intolerance
get
Partially Update Drug Intolerance
patch
Update Drug Intolerance
put
Histories
The History Object
List Histories
get
Create History
post
Delete History
del
Retrieve History
get
Family Histories
The Family History Object
List Family Histories
get
Create Family History
post
Delete Family History
del
Retrieve Family History
get
Immunizations
The Immunization Object
List Immunizations
get
Create Immunization
post
Delete Immunization
del
Retrieve Immunization
get
Vaccine
The Vaccine Object
List Vaccines
get
Create Vaccine
post
Delete Vaccine
del
Retrieve Vaccine
get
Insurance Card
The Insurance Card Object
Delete Patients Insurance Card
del
List Patients Insurance Cards
get
Create Patients Insurance Card
post
Provider Team
Patient Provider Team Object
Create Patient Provider Team Member
post
Delete Patient Provider Team Member
del
Partially Update Patient Provider Team Member
patch
Update Patient Provider Team Member
put
List Patient Provider Teams
get
Retrieve Patient Provider Team
get
Retrieve Patient Provider Teams Team Member
get
Retrieve Patients Patient Provider Team
get
Create Patients Patient Provider Team
post
Patient Profile Photo
Patient Photo Object
Retrieve Patients Get Photo
get
Delete Patients Profile Image
del
Retrieve Patients Profile Image
get
Create Patients Profile Image
post
Orders API
Lab Orders
The Lab Order Object
The Lab Order Content Object
List Lab Orders
get
Create Lab Order
post
Delete Lab Order
del
Retrieve Lab Order
get
Partially Update Lab Order
patch
Update Lab Order
put
Retrieve the Printable Lab Order View
get
Ancillary Companies
The Ancillary Company Object
List Ancillary Companies
get
Retrieve Ancillary Company
get
Cardiac Orders
The Cardiac Order Object
List Cardiac Orders
get
Create Cardiac Order
post
Delete Cardiac Order
del
Retrieve Cardiac Order
get
Partially Update Cardiac Order
patch
Update Cardiac Order
put
Cardiac Order Tests
The Cardiac Order Test Object
List Cardiac Order Tests
get
Create Cardiac Order Test
post
Retrieve Cardiac Order Test
get
Delete Cardiac Order Test
del
Cardiac Centers
The Cardiac Center Object
List Cardiac Centers
get
Retrieve Cardiac Center
get
Imaging Orders
The Imaging Order Object
List Imaging Orders
get
Create Imaging Order
post
Delete Imaging Order
del
Retrieve Imaging Order
get
Partially Update Imaging Order
patch
Update Imaging Order
put
Imaging Order Tests
The Imaging Order Test Object
List Imaging Order Tests
get
Create Imaging Order Test
post
Retrieve Imaging Order Test
get
Delete Imaging Order Test
del
Imaging Centers
The Imaging Center Object
List Imaging Centers
get
Retrieve Imaging Center
get
Pulmonary Orders
The Pulmonary Order Object
List Pulmonary Orders
get
Create Pulmonary Order
post
Delete Pulmonary Order
del
Retrieve Pulmonary Order
get
Partially Update Pulmonary Order
patch
Update Pulmonary Order
put
Pulmonary Order Tests
The Pulmonary Order Test Object
List Pulmonary Order Tests
get
Create Pulmonary Order Test
post
Retrieve Pulmonary Order Test
get
Delete Pulmonary Order Test
del
Pulmonary Centers
The Pulmonary Center Object
List Pulmonary Centers
get
Retrieve Pulmonary Center
get
Sleep Orders
The Sleep Order Object
List Sleep Orders
get
Create Sleep Order
post
Delete Sleep Order
del
Retrieve Sleep Order
get
Partially Update Sleep Order
patch
Update Sleep Order
put
Sleep Order Tests
The Sleep Order Test Object
List Sleep Order Tests
get
Create Sleep Order Test
post
Retrieve Sleep Order Test
get
Delete Sleep Order Test
del
Sleep Centers
The Sleep Center Object
List Sleep Centers
get
Retrieve Sleep Center
get
Lab Order Sets
The Lab Order Set Object
List Lab Order Sets
get
Create Lab Order Set
post
Delete Lab Order Set
del
Retrieve Lab Order Set
get
Partially Update Lab Order Set
patch
Update Lab Order Set
put
Lab Order Tests
The Lab Orders Test Object
List Lab Order Tests
get
Create Lab Order Test
post
Delete Lab Order Test
del
Retrieve Lab Order Test
get
Lab Order Compendiums
The Lab Order Compendium Object
List Lab Order Compendiums
get
Create Lab Order Compendium
post
Delete Lab Order Compendium
del
Retrieve Lab Order Compendium
get
Partially Update Lab Order Compendium
patch
Update Lab Order Compendium
put
Lab Vendors
The Lab Vendor Object
List Lab Vendors
get
Create Lab Vendor
post
Delete Lab Vendor
del
Retrieve Lab Vendor
get
Partially Update Lab Vendor
patch
Update Lab Vendor
put
Lab Vendor Patient Sites
The Lab Vendor Patient Site Object
List Lab Vendor Patient Sites
get
Create Lab Vendor Patient Site
post
Delete Lab Vendor Patient Site
del
Retrieve Lab Vendor Patient Site
get
Partially Update Lab Vendor Patient Site
patch
Update Lab Vendor Patient Site
put
Lab Vendor Integrations
Lab Vendor Integration Object
List Lab Vendor Integrations
get
Create Lab Vendor Integration
post
Delete Lab Vendor Integration
del
Retrieve Lab Vendor Integration
get
Partially Update Lab Vendor Integration
patch
Update Lab Vendor Integration
put
Lab Facility Identifiers
The Lab Facility Identifiers Object
List Lab Facility Identifiers
get
Create Lab Facility Identifier
post
Delete Lab Facility Identifier
del
Retrieve Lab Facility Identifier
get
Partially Update Lab Facility Identifier
patch
Update Lab Facility Identifier
put
[PREMIUM] PATIENT INSURANCE API
Insurance Eligibility
The Insurance Eligibility Object
The Insurance Eligibility Full Report Object
Get Eligibility
get
Create Eligibility
post
Get Eligibility Full Report
get
Patient Document API
Document Tags
The Document Tag Object
List Document Tags
get
Create Document Tag
post
Retrieve Document Tag
get
Partially Update Document Tag
patch
Update Document Tag
put
Clinical Documents
The Clinical Document Object
List Clinical Documents
get
Create Clinical Document
post
Delete Clinical Document
del
Retrieve Clinical Document
get
Vitals
The Vital Object
List Vitals
get
Create Vital
post
Retrieve Vital
get
Partially Update Vital
patch
Update Vital
put
Visit Notes
The Visit Note Object
List Visit Notes
get
Create Visit Note
post
Delete Visit Note
del
Retrieve Visit Note
get
Partially Update Visit Note
patch
Update Visit Note
put
Retrieve Visit Notes Clinical Summary
get
Retrieve Visit Notes Visit Summary
get
Non-Visit Notes
The Non-Visit Note Object
List Non Visit Notes
get
Create Non Visit Note
post
Delete Non Visit Note
del
Retrieve Non Visit Note
get
Partially Update Non Visit Note
patch
Update Non Visit Note
put
Medications
The Medication Object
List Medications
get
Create Medication
post
Delete Medication
del
Retrieve Medication
get
Discontinued Medications
The Discontinued Medication Object
List Discontinued Medications
get
Create Discontinued Medication
post
Delete Discontinued Medication
del
Retrieve Discontinued Medication
get
Report Types
The Report Type Object
List Report Types
get
Retrieve Report Type
get
Reports
The Lab Report Object
List Reports
get
Create Report
post
Delete Report
del
Retrieve Report
get
Partially Update Report
patch
Update Report
put
List Reports Files
get
Retrieve Reports File
get
Retrieve a printable view of a report
get
CCDA
The CCDA Object
Retrieve Ccda
get
Referrals
The Letter Object
List Letters
get
Create Letter
post
Retrieve Letter
get
Partially Update Letter
patch
Update Letter
put
The Referral Order Object
List Referral Orders
get
Create Referral Order
post
Retrieve Referral Order
get
Partially Update Referral Order
patch
Update Referral Order
put
Refills
The Refill object
List Medication Refills
get
Retrieve Medication Refill
get
Patient Forms
Patient Form Object
List Patient Forms
get
Retrieve Patient Form
get
Fills
The Prescription Fill object
List Prescription Fills
get
Retrieve Prescription Fill
get
The History Download Fill object
List Medication History Download Fills
get
Retrieve Medication History Download Fill
get
Patient Form Requests
The Patient Form Request Object
List Patient Form Requests
get
Create Patient Form Request
post
Delete Patient Form Request
del
Retrieve Patient Form Request
get
Partially Update Patient Form Request
patch
Update Patient Form Request
put
Patient Form Submissions
The Patient Form Submission object
List Patient Form Submissions
get
Retrieve Patient Form Submission
get
Historical Medication Download Requests
The Historical Medication Download Request Object
List Medication History Downloads
get
Create Medication History Download
post
Retrieve Medication History Download
get
Incoming Files
The incoming file object
List Incoming Files
get
Create Incoming File
post
Retrieve Incoming Files File
get
Retrieve Incoming Files Image
get
Retrieve Incoming File
get
Create a new incoming file
post
Visit Note Types
The Visit Note Type Object
List Visit Note Types
get
Create Visit Note Type
post
Delete Visit Note Type
del
Retrieve Visit Note Type
get
Partially Update Visit Note Type
patch
Update Visit Note Type
put
Visit Note Templates
The Visit Note Template Object
List Visit Note Templates
get
Create Visit Note Template
post
Delete Visit Note Template
del
Retrieve Visit Note Template
get
Partially Update Visit Note Template
patch
Update Visit Note Template
put
Injections (BETA)
The Injection Object
List Injections
get
Retrieve Injection
get
Messaging API
Message Threads
The Message Thread Object
List Message Threads
get
Create Message Thread
post
Delete Message Thread
del
Retrieve Message Thread
get
Partially Update Message Thread
patch
Update Message Thread
put
Thread Messages
The Thread Message Object
List Thread Messages
get
Create Thread Message
post
Delete Thread Message
del
Retrieve Thread Message
get
Thread Members
The Thread Member Object
List Thread Members
get
Create Thread Member
post
Delete Thread Member
del
Retrieve Thread Member
get
Partially Update Thread Member
patch
Update Thread Member
put
Billing API
Bills
The Bill Object
List Bills
get
Create Bill
post
Retrieve Bill
get
Partially Update Bill
patch
Release a Bill to PMS
patch
Outstanding Balance
Update Outstanding Balance
post
Billing Codes
The Billing Code Object
List Billing Codes
get
Create Billing Code
post
Delete Billing Code
del
Retrieve Billing Code
get
Partially Update Billing Code
patch
Update Billing Code
put
Scheduling API
Appointments
The Appointment Object
The Event Object
List Appointments
get
Create Appointment
post
Delete Appointment
del
Retrieve Appointment
get
Partially Update Appointment
patch
Update Appointment
put
Appointment Rooms
The Appointment Room Object
List Appointment Rooms
get
Recurring Event Groups
The Recurring Event Group Object
List Recurring Event Groups
get
Create Recurring Event Group
post
Delete Recurring Event Group
del
Retrieve Recurring Event Group
get
Appointment Types
The Appointment Type Object
List Appointment Types
get
Create Appointment Type
post
Delete Appointment Type
del
Retrieve Appointment Type
get
Partially Update Appointment Type
patch
Update Appointment Type
put
Practice API
Physicians
The Physician Object
List Physicians
get
Retrieve Physician
get
Partially Update Physician
patch
Update Physician
put
The Physician Availabilities Object
Get Physician Availabilities
get
Update Physician Availabilities
put
Service Locations
The Service Location Object
List Service Locations
get
Create Service Location
post
Delete Service Location
del
Retrieve Service Location
get
Partially Update Service Location
patch
Update Service Location
put
Practices
The Practice Object
List Practices
get
Retrieve Practice
get
Partially Update Practice
patch
Update Practice
put
Office Staff
The Office Staff Object
List Office Staffs
get
Retrieve Office Staff
get
Staff Groups
The Staff Group Object
List Staff Groups
get
Create Staff Group
post
Delete Staff Group
del
Retrieve Staff Group
get
Partially Update Staff Group
patch
Update Staff Group
put
Delegate Permissions
The Delegate Permission Object
List Delegate Permissions
get
Create Delegate Permission
post
Delete Delegate Permission
del
Retrieve Delegate Permission
get
Print Headers
The Print Header Object
List Print Headers
get
Delete Print Header
del
Retrieve Print Header
get
Contacts
The Contact Object
List Contacts
get
Create Contact
post
Search Contacts
get
Delete Contact
del
Retrieve Contact
get
Partially Update Contact
patch
Update Contact
put
Medication Order Templates
The Medication Order Template object
List Medication Order Templates
get
Create Medication Order Template
post
Delete Medication Order Template
del
Retrieve Medication Order Template
get
Partially Update Medication Order Template
patch
Update Medication Order Template
put
Handouts
The Handout object
List Handouts
get
Create Handout
post
Delete Handout
del
Retrieve Handout
get
Partially Update Handout
patch
Update Handout
put
Insurance Eligibility Usage
The Insurance Eligibility Usage Object
Get Practice Eligibility Usage
get
Practice Medications
The Practice Medication Object
List Practice Medications
get
Create Practice Medication
post
Delete Practice Medication
del
Retrieve Practice Medication
get
Partially Update Practice Medication
patch
Update Practice Medication
put
Insurance API
Insurance Companies
The Insurance Company Object
Retrieve Insurance Company
get
List Insurance Companies
get
Create Insurance Company
post
Partially Update Insurance Company
patch
Update Insurance Company
put
Delete Insurance Company
del
Insurance Plans
The Insurance Plan Object
Retrieve Insurance Plan
get
List Insurance Plans
get
Create Insurance Plan
post
Partially Update Insurance Plan
patch
Update Insurance Plan
put
Delete Insurance Plan
del
Insurance Policies
The Policy Object
Get Policy
get
Get Policies
get
Create Policies
post
Put Policy
put
Put Policies
put
Delete Policy
del
insurance-cards
Get Card Images By Policy
get
Upsert Insurance Card
post
Delete Insurance Card Image
del
Insurance API FAQ
Migration from Patient Demographics Endpoints to Insurance Versioning Endpoints
Reference Data API
Languages
The Language Object
List Languages
get
Pharmacies
The Pharmacy Object
List Pharmacies
get
Retrieve Pharmacy
get
Reference Medication (Beta)
The Reference Medication Object
List Reference Medications
get
Retrieve Reference Medication
get
Packaged Medication (Beta)
The Packaged Medication Object
List Packaged Medications
get
Retrieve Packaged Medication
get
Packaged Medication Labeler (Beta)
The Packaged Medication Labeler Object
List Packaged Medication Labelers
get
Retrieve Packaged Medication Labeler
get
Care Gaps API
Definitions
Retrieve a filtered page of definitions
get
Create a new definition.
post
Retrieve an existing definition.
get
Delete an existing definition.
del
Caregaps
Retrieve a list of existing caregap.
get
Create a new caregap.
post
Retrieve an existing caregap.
get
Delete an existing caregap.
del
Modifies an existing caregap's closed status.
patch
Event Subscription API
Event Subscriptions
The Subscription object
List Subscriptions
get
Subscribe to a resource updates
post
Delete a Subscription
del
Get a Subscription
get
The Event object
List Published Events
get
Get a Published Event
get
Partially Update App Published Event
patch
Update a Published Event
put
List Published Events
get
Get a Published Event
get
Partially Update Published Event
patch
Update a Published Event
put
List Subscriptions
get
Subscribe to a resource updates
post
Delete a Subscription
del
Get a Subscription
get
User Management API
Users
The User Object
List Users
get
Create User
post
Retrieve User
get
Partially Update User
patch
CHANGELOG
Changelog
Visit Notes API
Notes
List Notes
get
Create Note
post
Delete Note By Id
del
Get Note By Id
get
Update Note By Id
patch
Custom Blocks
List Custom Blocks
get
Powered by
The Vital Object
Ask AI
