JUMP TOOverviewIntroductionAPI OverviewGetting StartedAuthenticationPaginationErrorsWebhooksMetadataGetting HelpDatesOAUTH APIGet TokenpostPATIENT PROFILE APIPATIENTThe Patient ObjectFind PatientsgetGet PatientgetCreate PatientpostUpdate PatientputUpdate PatientpatchDelete PatientdeletePROBLEMThe Problem ObjectFind ProblemsgetGet ProblemgetCreate ProblempostUpdate ProblempatchDelete ProblemdeleteALLERGYThe Allergy ObjectFind AllergiesgetGet AllergygetCreate AllergypostUpdate AllergyputDelete AllergydeleteALLERGY DOCUMENTATION (NKDA)The Allergy Documentation (NKDA) ObjectFind Allergy Documentation (NKDA)getCreate Allergy Documentation (NKDA)postGet Allergy Documentation (NKDA)getDelete Allergy Documentation (NKDA)deleteDRUG INTOLERANCEThe Drug Intolerance ObjectFind Drug IntolerancesgetGet Drug IntolerancegetDelete Drug IntolerancedeleteHISTORYThe History ObjectFind HistoriesgetGet HistorygetCreate HistorypostDelete HistorydeleteAPPOINTMENT TYPESThe Appointment Type ObjectFind Appointment TypesgetGet Appointment TypegetUpdate Appointment TypepatchDelete Appointment TypedeleteFAMILY HISTORYThe Family History ObjectFind Family HistoriesgetGet Family HistorygetDelete Family HistorydeleteCreate Family HistorypostIMMUNIZATIONThe Immunization ObjectFind ImmunizationsgetGet ImmunizationgetCreate ImmunizationpostDelete ImmunizationdeleteVACCINEThe Vaccine ObjectGet VaccinegetDelete VaccinedeleteINSURANCE CARDThe Insurance Card ObjectGet Insurance CardsgetCreate Insurance CardpostDelete Insurance CarddeletePROVIDER TEAMPatient Provider Team ObjectList Provider TeamsgetList Team Members for a given teamgetCreate a Provider Team MemberpostUpdate Team MemberpatchDelete a Team MemberdeleteCreate a Provider Team for a given PatientpostList the Team Members for a given PatientgetPatient Profile PhotoPatient Photo ObjectGet Patient PhotogetCreate Patient PhotopostDelete Patient PhotodeleteList implantable devicesORDERS APILAB ORDERThe Lab Order ObjectThe Lab Order Content ObjectFind Lab OrdersgetGet Lab OrdergetCreate Lab OrderpostUpdate Lab OrderputUpdate Lab OrderpatchDelete Lab OrderdeleteRetrieve the Printable Lab Order ViewgetANCILLARY COMPANYThe Ancillary Company ObjectFind Ancillary CompaniesgetGet Ancillary CompanygetCARDIAC ORDERThe Cardiac Order ObjectFind Cardiac OrdersgetGet Cardiac OrdergetCreate Cardiac OrderpostUpdate Cardiac OrderputUpdate Cardiac OrderpatchDelete Cardiac OrderdeleteCARDIAC ORDER TESTThe Cardiac Order Test ObjectFind Cardiac Order TestsgetGet Cardiac Order TestgetCreate Cardiac Order TestpostCARDIAC CENTERThe Cardiac Center ObjectFind Cardiac CentersgetGet Cardiac CentergetIMAGING ORDERThe Imaging Order ObjectFind Imaging OrdersgetGet Imaging OrdergetCreate Imaging OrderpostUpdate Imaging OrderputUpdate Imaging OrderpatchDelete Imaging OrderdeleteIMAGING ORDER TESTThe Imaging Order Test ObjectFind Imaging Order TestsgetGet Imaging Order TestgetCreate Imaging Order TestpostIMAGING CENTERThe Imaging Center ObjectFind Imaging CentersgetGet Imaging CentergetPULMONARY ORDERThe Pulmonary Order ObjectFind Pulmonary OrdersgetGet Pulmonary OrdergetCreate Pulmonary OrderpostUpdate Pulmonary OrderputUpdate Pulmonary OrderpatchDelete Pulmonary OrderdeletePULMONARY ORDER TESTThe Pulmonary Order Test ObjectFind Pulmonary Order TestsgetGet Pulmonary Order TestgetCreate Pulmonary Order TestpostPULMONARY CENTERThe Pulmonary Center ObjectFind Pulmonary CentersgetGet Pulmonary CentergetSLEEP ORDERThe Sleep Order ObjectFind Sleep OrdersgetGet Sleep OrdergetCreate Sleep OrderpostUpdate Sleep OrderputUpdate Sleep OrderpatchDelete Sleep OrderdeleteSLEEP ORDER TESTThe Sleep Order Test ObjectFind Sleep Order TestsgetGet Sleep Order TestgetCreate Sleep Order TestpostSLEEP CENTERThe Sleep Center ObjectFind Sleep CentersgetGet Sleep CentergetLAB ORDER SETThe Lab Order Set ObjectFind Lab Order SetsgetGet Lab Order SetsgetCreate Lab Order SetpostUpdate Lab Order SetputUpdate Lab Order SetpatchDelete Lab Order SetsdeleteLAB ORDER TESTThe Lab Orders Test ObjectGet Lab Order TestsgetFind Lab Order TestsgetCreate Lab Order TestpostDelete Lab Order TestdeleteLAB ORDER COMPENDIUMThe Lab Order Compendium ObjectGet Lab Order CompendiumgetFind Lab Order CompendiumgetCreate Lab Order CompendiumpostUpdate Lab Order CompendiumpatchUpdate Lab Order CompendiumputDelete Lab Order CompendiumdeleteLAB VENDORThe Lab Vendor ObjectGet Lab VendorgetFind Lab VendorgetCreate Lab VendorpostUpdate Lab VendorputUpdate Lab VendorpatchDelete Lab VendordeleteLAB VENDOR PATIENT SITEThe Lab Vendor Patient Site ObjectGet Lab Vendor Patient SitegetFind Lab Vendor Patient SitegetCreate Lab Vendor Patient SitepostPut Lab Vendor Patient SiteputPatch Lab Vendor Patient SitepatchDelete Lab Vendor Patient SitedeleteLAB VENDOR INTEGRATIONLab Vendor Integration ObjectGet Lab Vendor IntegrationgetFind Lab Vendor IntegrationgetCreate Lab Vendor IntegrationpostPut Lab Vendor IntegrationputPatch Lab Vendor IntegrationpatchDelete Lab Vendor IntegrationdeleteLAB FACILITY IDENTIFIERSThe Lab Facility Identifiers ObjectGet Lab Facility IdentifiersgetFind Lab Facility IdentifiersgetCreate Lab Facility IdentifierspostPut Lab Facility IdentifiersputPatch Lab Facility IdentifierspatchDelete Lab Facility Identifiersdelete[PREMIUM] PATIENT INSURANCE APIINSURANCE ELIGIBILITYThe Insurance Eligibility Full Report ObjectThe Insurance Eligibility ObjectGet EligibilitygetCreate EligibilitypostGet Eligibility Full ReportgetPATIENT DOCUMENT APIDOCUMENT TAGThe Document Tag ObjectFind Document TagsgetGet Document TaggetCreate Document TagpostUpdate Document TagpatchUpdate Document TagputCLINICAL DOCUMENTThe Clinical Document ObjectFind Clinical DocumentsgetGet Clinical DocumentgetCreate Clinical DocumentpostVITALSThe Vital ObjectFind VitalsgetGet VitalgetCreate VitalspostUpdate VitalsputUpdate VitalspatchVISIT NOTEThe Visit Note ObjectFind Visit NotesgetGet Visit NotegetDelete Visit NotedeleteCreate Visit NotepostSign Visit NotepatchNON-VISIT NOTEThe Non-Visit Note ObjectFind Non-Visit NotesgetGet Non-Visit NotegetCreate Non-Visit NotepostUpdate Non-Visit NoteputUpdate Non-Visit NotepatchDelete Non-Visit NotedeleteMEDICATIONThe Medication ObjectFind MedicationsgetGet MedicationgetCreate MedicationpostDISCONTINUED MEDICATIONThe Discontinued Medication ObjectFind Discontinued MedicationsgetCreate Discontinued MedicationspostGet Discontinued MedicationgetREPORT TYPEThe Report Type ObjectFind Report TypesgetGet Report TypegetREPORTThe Lab Report ObjectThe External Report ObjectFind ReportsgetGet ReportgetCreate ReportpostDelete ReportdeleteSign ReportpatchRetrieve the Printable Report ViewgetCCDAThe CCDA ObjectGet CCDAgetREFERRALSThe Letter ObjectFind LettersgetGet LettergetThe Referral Order ObjectGet Referral OrdergetPost LetterpostUpdate LetterputUpdate LetterpatchPost Referral OrderpostUpdate Referral OrderputUpdate Referral OrderpatchREFILLSThe Refill objectFind RefillsgetGet RefillgetPATIENT FORMPatient Form ObjectFind Patient FormsgetGet Patient FormgetFILLSThe Prescription Fill objectFind Prescription FillsgetGet Prescription FillgetThe History Download Fill objectFind History Download FillsgetGet History Download FillgetPatient Form RequestThe Patient Form Request ObjectGet Patient Form RequestgetList Patient Form RequestsgetCreate Patient Form RequestpostUpdate Patient Forms RequestputDelete Patient Form RequestdeleteHISTORICAL MEDICATION DOWNLOAD REQUESTSThe Historical Medication Download Request ObjectFind Historical Medication Download RequestsgetCreate an Historical Medication Download RequestpostGet Historical Medication Download RequestsgetINCOMING FILEThe incoming file objectFind incoming filesgetGet incoming filegetCreate Incoming FilespostVISIT NOTE TYPESThe Visit Note Type ObjectFind Visit Note TypesgetGet Visit Note TypegetUpdate Visit Note TypepatchDelete Visit Note TypedeleteVISIT NOTE TEMPLATESThe Visit Note Template ObjectFind Visit Note TemplatesgetGet Visit Note TemplategetUpdate Visit Note TemplatepatchDelete Visit Note TemplatedeleteThe Patient Form Submission objectPatient Form SubmissionMESSAGING APIMESSAGE THREADThe Message Thread ObjectGet Message ThreadgetFind Message ThreadsgetCreate Message ThreadpostUpdate Message ThreadpatchDelete Message ThreaddeleteTHREAD MESSAGEThe Thread Message ObjectGet Thread MessagegetFind Thread MessagesgetCreate Thread MessagepostDelete Thread MessagedeleteTHREAD MEMBERThe Thread Member ObjectGet Thread MembergetFind Thread MembersgetCreate Thread MemberpostUpdate Thread MemberpatchDelete Thread MemberdeleteSCHEDULING APIAPPOINTMENTThe Appointment ObjectFind AppointmentsgetGet AppointmentgetCreate AppointmentpostUpdate AppointmentputUpdate AppointmentpatchDelete AppointmentdeleteAPPOINTMENT ROOMThe Appointment Room ObjectFind Appointment RoomsgetEVENTThe Event ObjectFind EventsgetGet EventgetCreate EventpostUpdate EventputUpdate EventpatchDelete EventdeleteRECURRING EVENT GROUPThe Recurring Event Group ObjectFind Recurring Event GroupsgetGet Recurring Event GroupgetCreate Recurring Event GrouppostUpdate Recurring Event GroupputDelete Recurring Event GroupdeleteBILLING APIBILLThe Bill ObjectFind BillsgetGet BillgetCreate BillpostUpdate BillpatchRelease a Bill To PMSpatchOUTSTANDING BALANCEUpdating Outstanding BalancepostBILLING CODES (CPT)The Billing Code ObjectCreate a Billing CodepostGet a Billing CodegetGet Billing CodesgetUpdate a Billing CodepatchGet Billing CodesINSURANCE APIINSURANCE COMPANYThe Insurance Company ObjectFind Insurance CompaniesgetGet Insurance CompanygetCreate Insurance CompanypostUpdate Insurance CompanyputUpdate Insurance CompanypatchDelete Insurance CompanydeleteINSURANCE PLANThe Insurance Plan ObjectFind Insurance PlansgetGet Insurance PlangetCreate Insurance PlanpostUpdate Insurance PlanputUpdate Insurance PlanpatchDelete Insurance PlandeletePRACTICE APIPHYSICIANThe Physician ObjectFind PhysiciansgetGet PhysiciangetUpdate PhysicianputUpdate PhysicianpatchThe Physician Availabilities ObjectGet Physician AvailabilitiesgetUpdate Physician AvailabilitiesputSERVICE LOCATIONThe Service Location ObjectFind Service LocationgetGet Service LocationgetCreate Service LocationpostUpdate Service LocationputUpdate Service LocationpatchDelete Service LocationdeletePRACTICEThe Practice ObjectFind PracticesgetGet PracticegetUpdate PracticeputUpdate PracticepatchOFFICE STAFFThe Office Staff ObjectFind Office StaffgetGet Office StaffgetSTAFF GROUPSThe Staff Group ObjectFind Staff GroupgetGet Staff GroupgetCreate Staff GrouppostUpdate Staff GroupputDelete a Staff GroupdeleteDELEGATE PERMISSIONSThe Delegate Permission ObjectFind Delegate PermissionsgetGet Delegate PermissionsgetCreate Delegate PermissionspostUpdate Delegate PermissionsputDelete a Delegate PermissiondeletePRINT HEADERSThe Print Header ObjectFind Print HeadersgetGet Print HeadergetCONTACTSThe Contact ObjectSearch ContactsgetList ContactsgetFetch ContactgetCreate ContactpostUpdate ContactsputUpdate ContactspatchDelete ContactsdeleteMEDICATION ORDER TEMPLATESThe Medication Order Template objectGet Medication Order TemplategetFind Medication Order TemplatesgetCreate Medication Order TemplatepostUpdate an existing Medication Order TemplateputUpdate an existing Medication Order TemplatepatchDelete Medication Order TemplatedeleteHANDOUTSThe Handout objectFind HandoutsgetGet HandoutsgetCreate HandoutpostUpdate HandoutputUpdate HandoutpatchDelete HandoutdeleteINSURANCE ELIGIBILITY USAGEThe Insurance Eligibility Usage ObjectFind Insurance Eligibility UsagegetPRACTICE MEDICATIONSThe Practice Medication ObjectFind Practice MedicationsgetCreate Practice MedicationpostObsolete Practice MedicationpatchFetch Practice MedicationgetReference Data APILANGUAGEThe Language ObjectFind LanguagesgetPHARMACYThe Pharmacy ObjectGet PharmacygetCare Gaps APIDefinitionsRetrieve a filtered page of definitionsgetCreate a new definition.postRetrieve an existing definition.getDelete an existing definition.deleteCaregapsRetrieve a list of existing caregap.getCreate a new caregap.postRetrieve an existing caregap.getDelete an existing caregap.deleteModifies an existing caregap's closed status.patchEvent Subscription APIThe Subscription objectFind SubscriptionsgetSubscribe to a resource updatespostDelete a SubscriptiondeleteThe Event objectFind published eventsgetGet published eventgetUpdate published eventputUpdate published eventpatchUser Management APIThe User ObjectCreate UserpostUpdate UserpatchCHANGELOGChangelogPowered by The CCDA ObjectObject Definition JSON{ "base64_ccda": "PD94bWwgdmVyc2lvbj0iMS4wIj8+....................." } Patient chart exported as CCDA as base64-encoded string.
