DrChrono

Drchrono API

This document is intended as a detailed reference for the precise behavior of the drchrono API. If this is your first time using the API, start with our…

Other#openapi#customer-relation

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

This document is intended as a detailed reference for the precise behavior of
the drchrono API. If this is your first time using the API, start with our tutorial . If you are upgrading from a previous version, take a look at the changelog section.

Authorization

Initial authorization

There are three main steps in the OAuth 2.0 authentication workflow:

  1. Redirect the provider to the authorization page.
  2. The provider authorizes your application and is redirected back to

your web application.

  1. Your application exchanges the authorization_code that came with

the redirect for an access_token and refresh_token.

Step 1: Redirect to drchrono

The first step is redirecting your user to drchrono, typically with a button
labeled "Connect to drchrono" or "Login with drchrono". This is just a link that
takes your user to the following URL:

https://drchrono.com/o/authorize/?redirect_uri=REDIRECT_URI_ENCODED&response_type=code&client_id=CLIENT_ID_ENCODED&scope=SCOPES_ENCODED

  • REDIRECT_URI_ENCODED is the URL-encoded version of the redirect URI (as registered for your application and used in later steps).
  • CLIENT_ID_ENCODED is the URL-encoded version of your application's client ID.
  • SCOPES_ENCODED is a URL-encoded version of a space-separated list of scopes, which can be found in each endpoint or omitted to default to all scopes.

The scope parameter consists of an optional, space-separated list of scopes your application is requesting.
If omitted, all scopes will be requested.

Scopes are of the form BASE_SCOPE:[read|write] where BASE_SCOPE is any of user, calendar, patients, patients:summary, billing, clinical and labs.
You should request only the scopes you need.
For instance, an application which sends "Happy Birthday!" emails to a doctor's patients on their birthdays would use the scope parameter "patients:summary:read",
while one that allows patients to schedule appointments online would need at least
"patients:summary:read patients:summary:write calendar:read calendar:write clinical:read clinical:write".

Step 2: Provider authorization

After logging in (if necessary), the provider will be presented with a screen
with your application's name and the list of permissions you requested (via the
scope parameter).

When they click the "Authorize" button, they will be redirected to your redirect
URI with a code query parameter appended, which contains an authorization code to be
used in step 3. If they click the "Cancel" button, they will be redirected to
your redirect URI with error=access_denied instead.

Note: This authorization code expires extremely quickly, so you must perform
step 3 immediately, ideally before rendering the resulting page for the end
user.

Step 3: Token exchange

The code obtained from step 2 is usable exactly once to obtain an access token
and refresh token. Here is an example token exchange in Python:

import datetime, pytz, requests

if 'error' in get_params:
raise ValueError('Error authorizing application: %s' % get_params[error])

response = requests.post('https://drchrono.com/o/token/', data={
'code': get_params['code'],
'grant_type': 'authorization_code',
'redirect_uri': 'http://mytestapp.com/redirect_uri',
'client_id': 'abcdefg12345',
'client_secret': 'abcdefg12345',
})
response.raise_for_status()
data = response.json()

Save these in your database associated with the user

access_token = data['access_token']
refresh_token = data['refresh_token']
expires_timestamp = datetime.datetime.now(pytz.utc) + datetime.timedelta(seconds=data['expires_in'])

You now have all you need to make API requests authenticated as that provider.
When using this access token, you'll only be able to access the data that the
user has access to and that you have been granted permissions for.

Refreshing an access token

Access tokens only last 48 hours (given in seconds in the 'expires_in' key in
the token exchange step above), so they occasionally need to be refreshed. It
would be inconvenient to ask the user to re-authorize every time, so instead you
can use the refresh token like the original authorization to obtain a new access
token. Replace the code parameter with refresh_token, change the value
grant_type from authorization_code to refresh_token, and omit the
redirect_uri parameter.

Example in Python:

...
response = requests.post('https://drchrono.com/o/token/', data={
'refresh_token': get_refresh_token(),
'grant_type': 'refresh_token',
'client_id': 'abcdefg12345',
'client_secret': 'abcdefg12345',
})
...

Webhooks

In order to use drchrono API webhooks, you first need to have an API application on file
(even if it is in Test Model).
Each API webhook is associated with one API application, go to
here to set up both API applications and webhooks!

Once you…

Endpoints 263

Administrative

  • GETdoctors_list/api/doctors?cursor=string&page_size=0&doctor=0Retrieve or search doctors within practice group
  • GETdoctors_read/api/doctors/:id?doctor=0Retrieve an existing dcotor
  • GETuser_groups_list/api/user_groups?cursor=string&page_size=0&doctor=0Retrieve or search user groups
  • GETuser_groups_read/api/user_groups/:id?doctor=0Retrieve an existing user group
  • GETusers_list/api/users?cursor=string&page_size=0&doctor=0Retrieve or search users, /api/users/current can be used to identify logged in user, it will redirect to /api/users/{current_user_id}
  • GETusers_read/api/users/:id?doctor=0Retrieve an existing user, /api/users/current can be used to identify logged in user, it will redirect to /api/users/{current_user_id}

Clinical

  • GETallergies_list/api/allergies?cursor=string&page_size=0&patient=0&doctor=0Retrieve or search patient allergies
  • POSTallergies_create/api/allergies?patient=0&doctor=0Create patient allergy
  • GETallergies_read/api/allergies/:id?patient=0&doctor=0Retrieve an existing patient allergy
  • PUTallergies_update/api/allergies/:id?patient=0&doctor=0Update an existing patient allergy
  • PATCHallergies_partial_update/api/allergies/:id?patient=0&doctor=0Update an existing patient allergy
  • GETamendments_list/api/amendments?cursor=string&page_size=0&appointment=0&patient=0&doctor=0Retrieve or search patient amendments. You can only interact with amendments created by your API application
  • POSTamendments_create/api/amendments?appointment=0&patient=0&doctor=0Create patient amendments to a patient's clinical records
  • GETamendments_read/api/amendments/:id?appointment=0&patient=0&doctor=0Retrieve an existing patient amendment, you can only interact with amendments created by your API application
  • PUTamendments_update/api/amendments/:id?appointment=0&patient=0&doctor=0Update an existing patient amendment, you can only interact with amendments created by your API application
  • DELETEamendments_delete/api/amendments/:id?appointment=0&patient=0&doctor=0Delete an existing patient amendment, you can only interact with amendments created by your API application
  • PATCHamendments_partial_update/api/amendments/:id?appointment=0&patient=0&doctor=0Update an existing patient amendment, you can only interact with amendments created by your API application
  • GETappointment_profiles_list/api/appointment_profiles?cursor=string&page_size=0&doctor=0Retrieve or search appointment profiles for a doctor's calendar
  • POSTappointment_profiles_create/api/appointment_profiles?doctor=0Create appointment profiles for a doctor's calendar
  • GETappointment_profiles_read/api/appointment_profiles/:id?doctor=0Retrieve an existing appointment profile
  • PUTappointment_profiles_update/api/appointment_profiles/:id?doctor=0Update an existing appointment profile
  • DELETEappointment_profiles_delete/api/appointment_profiles/:id?doctor=0Delete an existing appointment profile
  • PATCHappointment_profiles_partial_update/api/appointment_profiles/:id?doctor=0Update an existing appointment profile
  • GETappointment_templates_list/api/appointment_templates?cursor=string&page_size=0&profile=0&office=0&doctor=0Retrieve or search appointment templates for a doctor's calendar
  • POSTappointment_templates_create/api/appointment_templates?profile=0&office=0&doctor=0Create appointment templates for a doctor's calendar
  • GETappointment_templates_read/api/appointment_templates/:id?profile=0&office=0&doctor=0Retrieve an existing appointment template
  • PUTappointment_templates_update/api/appointment_templates/:id?profile=0&office=0&doctor=0Update an existing appointment template
  • DELETEappointment_templates_delete/api/appointment_templates/:id?profile=0&office=0&doctor=0Delete an existing appointment template
  • PATCHappointment_templates_partial_update/api/appointment_templates/:id?profile=0&office=0&doctor=0Update an existing appointment template
  • GETappointments_list/api/appointments?cursor=string&page_size=0&status=string&patient=0&office=0&doctor=0&since=string&date_range=string&date=stringRetrieve or search appointment or breaks. <b>Note:</b> Either since, date or date_range parameter must be specified.
  • POSTappointments_create/api/appointments?status=string&patient=0&office=0&doctor=0&since=string&date_range=string&date=stringCreate a new appointment or break on doctor's calendar
  • GETappointments_read/api/appointments/:id?status=string&patient=0&office=0&doctor=0&since=string&date_range=string&date=stringRetrieve an existing appointment or break
  • PUTappointments_update/api/appointments/:id?status=string&patient=0&office=0&doctor=0&since=string&date_range=string&date=stringUpdate an existing appointment or break
  • DELETEappointments_delete/api/appointments/:id?status=string&patient=0&office=0&doctor=0&since=string&date_range=string&date=stringDelete an existing appointment or break
  • PATCHappointments_partial_update/api/appointments/:id?status=string&patient=0&office=0&doctor=0&since=string&date_range=string&date=stringUpdate an existing appointment or break
  • GETcare_plans_list/api/care_plans?cursor=string&page_size=0&patient=0&plan_type=0&doctor=0Retrieve or search care plans
  • GETcare_plans_read/api/care_plans/:id?patient=0&plan_type=0&doctor=0Retrieve an existing care plan
  • GETcare_team_members_list/api/care_team_members?cursor=string&page_size=0&patient=0&appointment=0&doctor=0
  • GETcare_team_members_read/api/care_team_members/:id?patient=0&appointment=0&doctor=0
  • GETclaim_billing_notes_list/api/claim_billing_notes?cursor=string&page_size=0&appointment=0&doctor=0Retrieve or search billing notes
  • POSTclaim_billing_notes_create/api/claim_billing_notes?appointment=0&doctor=0Create a new billing note
  • GETclaim_billing_notes_read/api/claim_billing_notes/:id?appointment=0&doctor=0Retrieve an existing billing note
  • GETclinical_note_field_types_list/api/clinical_note_field_types?cursor=string&page_size=0&clinical_note_template=0&doctor=0Retrieve or search clinical note field types
  • GETclinical_note_field_types_read/api/clinical_note_field_types/:id?clinical_note_template=0&doctor=0Retrieve an existing clinial note field type
  • GETclinical_note_field_values_list/api/clinical_note_field_values?cursor=string&page_size=0&clinical_note_field=0&since=string&appointment=0&clinical_note_template=0&doctor=0Retrieve or search clinical note field values
  • POSTclinical_note_field_values_create/api/clinical_note_field_values?clinical_note_field=0&since=string&appointment=0&clinical_note_template=0&doctor=0Create clinical note field value
  • GETclinical_note_field_values_read/api/clinical_note_field_values/:id?clinical_note_field=0&since=string&appointment=0&clinical_note_template=0&doctor=0Retrieve an existing clinical note field value
  • PUTclinical_note_field_values_update/api/clinical_note_field_values/:id?clinical_note_field=0&since=string&appointment=0&clinical_note_template=0&doctor=0Update an existing clinical note field value
  • PATCHclinical_note_field_values_partial_update/api/clinical_note_field_values/:id?clinical_note_field=0&since=string&appointment=0&clinical_note_template=0&doctor=0Update an existing clinical note field value
  • GETclinical_note_templates_list/api/clinical_note_templates?cursor=string&page_size=0&doctor=0Retrieve or search clinical note templates
  • GETclinical_note_templates_read/api/clinical_note_templates/:id?doctor=0Retrieve an existing clinical note tempalte
  • GETclinical_notes_list/api/clinical_notes?cursor=string&page_size=0&patient=0&office=0&doctor=0&since=string&date_range=string&date=string
  • GETclinical_notes_read/api/clinical_notes/:id?patient=0&office=0&doctor=0&since=string&date_range=string&date=string
  • GETconsent_forms_list/api/consent_forms?cursor=string&page_size=0&doctor=0Retrieve or search patient consent forms
  • POSTconsent_forms_create/api/consent_forms?doctor=0Create a patient consent form
  • GETconsent_forms_read/api/consent_forms/:id?doctor=0Retrieve an existing patient consent form
  • PUTconsent_forms_update/api/consent_forms/:id?doctor=0Update an existing patient consent form
  • PATCHconsent_forms_partial_update/api/consent_forms/:id?doctor=0Update an existing patient consent form
  • POSTconsent_forms_apply_to_appointment/api/consent_forms/:id/apply_to_appointment?doctor=0Assign (apply) a consent form to appointment
  • POSTconsent_forms_unapply_from_appointment/api/consent_forms/:id/unapply_from_appointment?doctor=0Unassign (unapply) a consent form from appointment
  • GETcustom_appointment_fields_list/api/custom_appointment_fields?cursor=string&page_size=0&doctor=0Retrieve or search custom appointment fields
  • POSTcustom_appointment_fields_create/api/custom_appointment_fields?doctor=0Create custom appointment fields
  • GETcustom_appointment_fields_read/api/custom_appointment_fields/:id?doctor=0Retrieve an existing custom appointment field
  • PUTcustom_appointment_fields_update/api/custom_appointment_fields/:id?doctor=0Update an existing custom appointment field
  • PATCHcustom_appointment_fields_partial_update/api/custom_appointment_fields/:id?doctor=0Update an existing custom appointment field
  • GETcustom_demographics_list/api/custom_demographics?cursor=string&page_size=0&doctor=0Retrieve or search custom demographics fields
  • POSTcustom_demographics_create/api/custom_demographics?doctor=0Create custom demographics fields
  • GETcustom_demographics_read/api/custom_demographics/:id?doctor=0Retrieve an existing custom demographics field
  • PUTcustom_demographics_update/api/custom_demographics/:id?doctor=0Update an existing custom demographics field
  • PATCHcustom_demographics_partial_update/api/custom_demographics/:id?doctor=0Update an existing custom demographics field
  • GETcustom_vitals_list/api/custom_vitals?cursor=string&page_size=0&doctor=0Retrieve or search custom vital types
  • GETcustom_vitals_read/api/custom_vitals/:id?doctor=0Retrieve an existing custom vital type
  • GETdocuments_list/api/documents?cursor=string&page_size=0&since=string&patient=0&doctor=0Retrieve or search documents
  • POSTdocuments_create/api/documents?since=string&patient=0&doctor=0Create documents
  • GETdocuments_read/api/documents/:id?since=string&patient=0&doctor=0Retrieve an existing appointment template
  • PUTdocuments_update/api/documents/:id?since=string&patient=0&doctor=0Update an existing appointment template
  • DELETEdocuments_delete/api/documents/:id?since=string&patient=0&doctor=0Delete an existing appointment template
  • PATCHdocuments_partial_update/api/documents/:id?since=string&patient=0&doctor=0Update an existing appointment template
  • GETeobs_list/api/eobs?cursor=string&page_size=0&doctor=0Retrieve or search EOB objects
  • POSTeobs_create/api/eobs?doctor=0Create EOB object
  • GETeobs_read/api/eobs/:id?doctor=0Retrieve an existing EOB object
  • GETfee_schedules_list/api/fee_schedules?cursor=string&page_size=0&code=string&code_type=string&since=string&payer_id=string&doctor=0
  • GETfee_schedules_read/api/fee_schedules/:id?code=string&code_type=string&since=string&payer_id=string&doctor=0
  • GETimplantable_devices_list/api/implantable_devices?cursor=string&page_size=0&mu_date=string&patient=0&mu_date_range=string&doctor=0Retrieve or search implantable devices
  • GETimplantable_devices_read/api/implantable_devices/:id?mu_date=string&patient=0&mu_date_range=string&doctor=0Retrieve an existing implantable device
  • GETinsurances_list/api/insurances?cursor=string&page_size=0&payer_type=string&term=string
  • GETinsurances_read/api/insurances/:id?payer_type=string&term=string
  • GETlab_documents_list/api/lab_documents?cursor=string&page_size=0&since=string&doctor=0Retrieve or search lab order documents
  • POSTlab_documents_create/api/lab_documents?since=string&doctor=0Create lab order documents. An example lab workflow is as following: When you get orders, submit them via /api/lab_orders, such that doctors can see them in…
  • GETlab_documents_read/api/lab_documents/:id?since=string&doctor=0Retrieve an existing lab order document
  • PUTlab_documents_update/api/lab_documents/:id?since=string&doctor=0Update an existing lab order document
  • DELETElab_documents_delete/api/lab_documents/:id?since=string&doctor=0Delete an existing lab order document
  • PATCHlab_documents_partial_update/api/lab_documents/:id?since=string&doctor=0Update an existing lab order document
  • GETlab_orders_list/api/lab_orders?cursor=string&page_size=0&since=string&doctor=0Retrieve or search lab orders
  • POSTlab_orders_create/api/lab_orders?since=string&doctor=0Create lab orders. An example lab workflow is as following: When you get orders, submit them via /api/lab_orders, such that doctors can see them in drchrono.…
  • GETlab_orders_read/api/lab_orders/:id?since=string&doctor=0Retrieve an existing lab order
  • PUTlab_orders_update/api/lab_orders/:id?since=string&doctor=0Update an existing lab order
  • DELETElab_orders_delete/api/lab_orders/:id?since=string&doctor=0Delete an existing lab order
  • PATCHlab_orders_partial_update/api/lab_orders/:id?since=string&doctor=0Update an existing lab order
  • GETlab_orders_summary_list/api/lab_orders_summary?cursor=string&page_size=0&since=string&patient=0&doctor=0
  • GETlab_orders_summary_read/api/lab_orders_summary/:id?since=string&patient=0&doctor=0
  • GETlab_results_list/api/lab_results?cursor=string&page_size=0&order=0&doctor=0Retrieve or search lab results
  • POSTlab_results_create/api/lab_results?order=0&doctor=0Create lab results. An example lab workflow is as following: When you get orders, submit them via /api/lab_orders, such that doctors can see them in drchrono.…
  • GETlab_results_read/api/lab_results/:id?order=0&doctor=0Retrieve an existing lab result
  • PUTlab_results_update/api/lab_results/:id?order=0&doctor=0Update an existing lab result
  • DELETElab_results_delete/api/lab_results/:id?order=0&doctor=0Delete an existing lab result
  • PATCHlab_results_partial_update/api/lab_results/:id?order=0&doctor=0Update an existing lab result
  • GETlab_tests_list/api/lab_tests?cursor=string&page_size=0&order=0&doctor=0Retrieve or search lab tests
  • POSTlab_tests_create/api/lab_tests?order=0&doctor=0Create lab tests. An example lab workflow is as following: When you get orders, submit them via /api/lab_orders, such that doctors can see them in drchrono.…
  • GETlab_tests_read/api/lab_tests/:id?order=0&doctor=0Retrieve an existing lab test
  • PUTlab_tests_update/api/lab_tests/:id?order=0&doctor=0Update an existing lab test
  • DELETElab_tests_delete/api/lab_tests/:id?order=0&doctor=0Delete an existing lab test
  • PATCHlab_tests_partial_update/api/lab_tests/:id?order=0&doctor=0Update an existing lab test
  • GETmedications_list/api/medications?cursor=string&page_size=0&patient=0&doctor=0Retrieve or search patient medications
  • POSTmedications_create/api/medications?patient=0&doctor=0Create patient medications
  • GETmedications_read/api/medications/:id?patient=0&doctor=0Retrieve an existing patient medications
  • PUTmedications_update/api/medications/:id?patient=0&doctor=0Update an existing patient medications
  • PATCHmedications_partial_update/api/medications/:id?patient=0&doctor=0Update an existing patient medications
  • PATCHmedications_append_to_pharmacy_note/api/medications/:id/append_to_pharmacy_note?patient=0&doctor=0Append a message to the "pharmacy_note" section of the prescription, in a new paragraph
  • GETpatient_communications_list/api/patient_communications?cursor=string&page_size=0&patient=0&doctor=0Retrieve or search patient communications for CQM
  • POSTpatient_communications_create/api/patient_communications?patient=0&doctor=0Create patient communication for CQM
  • GETpatient_communications_read/api/patient_communications/:id?patient=0&doctor=0Retrieve an existing patient communication for CQM
  • PUTpatient_communications_update/api/patient_communications/:id?patient=0&doctor=0Update an existing patient communication for CQM
  • PATCHpatient_communications_partial_update/api/patient_communications/:id?patient=0&doctor=0Update an existing patient communication for CQM
  • GETpatient_flag_types_list/api/patient_flag_types?cursor=string&page_size=0&doctor=0Retrieve or search patient flag types
  • POSTpatient_flag_types_create/api/patient_flag_types?doctor=0Create patient flag types
  • GETpatient_flag_types_read/api/patient_flag_types/:id?doctor=0Retrieve an existing patient flag type
  • PUTpatient_flag_types_update/api/patient_flag_types/:id?doctor=0Update an existing patient flag type
  • PATCHpatient_flag_types_partial_update/api/patient_flag_types/:id?doctor=0Update an existing patient flag type
  • GETpatient_interventions_list/api/patient_interventions?cursor=string&page_size=0&patient=0&doctor=0Retrieve or search patient interventions for CQM
  • POSTpatient_interventions_create/api/patient_interventions?patient=0&doctor=0Create patient intervention for CQM
  • GETpatient_interventions_read/api/patient_interventions/:id?patient=0&doctor=0Retrieve an existing patient intervention for CQM
  • PUTpatient_interventions_update/api/patient_interventions/:id?patient=0&doctor=0Update an existing patient intervention for CQM
  • PATCHpatient_interventions_partial_update/api/patient_interventions/:id?patient=0&doctor=0Update an existing patient intervention for CQM
  • GETpatient_lab_results_list/api/patient_lab_results?cursor=string&page_size=0&ordering_doctor=0&since=string&patient=0&doctor=0
  • POSTpatient_lab_results_create/api/patient_lab_results?ordering_doctor=0&since=string&patient=0&doctor=0
  • GETpatient_lab_results_read/api/patient_lab_results/:id?ordering_doctor=0&since=string&patient=0&doctor=0
  • PUTpatient_lab_results_update/api/patient_lab_results/:id?ordering_doctor=0&since=string&patient=0&doctor=0
  • DELETEpatient_lab_results_delete/api/patient_lab_results/:id?ordering_doctor=0&since=string&patient=0&doctor=0
  • PATCHpatient_lab_results_partial_update/api/patient_lab_results/:id?ordering_doctor=0&since=string&patient=0&doctor=0
  • GETpatient_messages_list/api/patient_messages?cursor=string&page_size=0&since=string&patient=0&doctor=0
  • POSTpatient_messages_create/api/patient_messages?since=string&patient=0&doctor=0
  • GETpatient_messages_read/api/patient_messages/:id?since=string&patient=0&doctor=0
  • PUTpatient_messages_update/api/patient_messages/:id?since=string&patient=0&doctor=0
  • PATCHpatient_messages_partial_update/api/patient_messages/:id?since=string&patient=0&doctor=0
  • GETpatient_physical_exams_list/api/patient_physical_exams?cursor=string&page_size=0&patient=0&doctor=0Retrieve or search patient physical exams for CQM
  • POSTpatient_physical_exams_create/api/patient_physical_exams?patient=0&doctor=0Create patient physical exam for CQM
  • GETpatient_physical_exams_read/api/patient_physical_exams/:id?patient=0&doctor=0Retrieve an existing patient physical exam for CQM
  • PUTpatient_physical_exams_update/api/patient_physical_exams/:id?patient=0&doctor=0Update an existing patient physical exam for CQM
  • PATCHpatient_physical_exams_partial_update/api/patient_physical_exams/:id?patient=0&doctor=0Update an existing patient physical exam for CQM
  • GETpatient_risk_assessments_list/api/patient_risk_assessments?cursor=string&page_size=0&patient=0&doctor=0
  • POSTpatient_risk_assessments_create/api/patient_risk_assessments?patient=0&doctor=0
  • GETpatient_risk_assessments_read/api/patient_risk_assessments/:id?patient=0&doctor=0
  • PUTpatient_risk_assessments_update/api/patient_risk_assessments/:id?patient=0&doctor=0
  • PATCHpatient_risk_assessments_partial_update/api/patient_risk_assessments/:id?patient=0&doctor=0
  • GETpatient_vaccine_records_list/api/patient_vaccine_records?cursor=string&page_size=0&cvx_code=string&patient=0&since=string&doctor=0Retrieve or search patient vaccine records
  • POSTpatient_vaccine_records_create/api/patient_vaccine_records?cvx_code=string&patient=0&since=string&doctor=0Create patient vaccine records
  • GETpatient_vaccine_records_read/api/patient_vaccine_records/:id?cvx_code=string&patient=0&since=string&doctor=0Retrieve an existing patient vaccine records
  • PUTpatient_vaccine_records_update/api/patient_vaccine_records/:id?cvx_code=string&patient=0&since=string&doctor=0Update an existing patient vaccine records
  • PATCHpatient_vaccine_records_partial_update/api/patient_vaccine_records/:id?cvx_code=string&patient=0&since=string&doctor=0Update an existing patient vaccine records
  • GETpatients_list/api/patients?cursor=string&page_size=0&first_name=string&last_name=string&preferred_language=string&doctor=0&gender=string&since=string&date_of_birth=string&race=string&chart_id=string&email=string&ethnicity=stringRetrieve or search patients
  • POSTpatients_create/api/patients?first_name=string&last_name=string&preferred_language=string&doctor=0&gender=string&since=string&date_of_birth=string&race=string&chart_id=string&email=string&ethnicity=stringCreate patient
  • GETpatients_read/api/patients/:id?first_name=string&last_name=string&preferred_language=string&doctor=0&gender=string&since=string&date_of_birth=string&race=string&chart_id=string&email=string&ethnicity=stringRetrieve an existing patient
  • PUTpatients_update/api/patients/:id?first_name=string&last_name=string&preferred_language=string&doctor=0&gender=string&since=string&date_of_birth=string&race=string&chart_id=string&email=string&ethnicity=stringUpdate an existing patient
  • DELETEpatients_delete/api/patients/:id?first_name=string&last_name=string&preferred_language=string&doctor=0&gender=string&since=string&date_of_birth=string&race=string&chart_id=string&email=string&ethnicity=stringDelete an existing patient
  • PATCHpatients_partial_update/api/patients/:id?first_name=string&last_name=string&preferred_language=string&doctor=0&gender=string&since=string&date_of_birth=string&race=string&chart_id=string&email=string&ethnicity=stringUpdate an existing patient
  • GETpatients_ccda/api/patients/:id/ccda?first_name=string&last_name=string&preferred_language=string&doctor=0&gender=string&since=string&date_of_birth=string&race=string&chart_id=string&email=string&ethnicity=stringRetrieve patient CCDA
  • GETpatients_onpatient_access_read/api/patients/:id/onpatient_access?first_name=string&last_name=string&preferred_language=string&doctor=0&gender=string&since=string&date_of_birth=string&race=string&chart_id=string&email=string&ethnicity=stringRetrieve or search existing onpatient access invites
  • POSTpatients_onpatient_access_create/api/patients/:id/onpatient_access?first_name=string&last_name=string&preferred_language=string&doctor=0&gender=string&since=string&date_of_birth=string&race=string&chart_id=string&email=string&ethnicity=stringSend new onpatient invite to patient
  • DELETEpatients_onpatient_access_delete/api/patients/:id/onpatient_access?first_name=string&last_name=string&preferred_language=string&doctor=0&gender=string&since=string&date_of_birth=string&race=string&chart_id=string&email=string&ethnicity=stringRevoke sent onpatient invites
  • GETpatients_qrda1/api/patients/:id/qrda1?first_name=string&last_name=string&preferred_language=string&doctor=0&gender=string&since=string&date_of_birth=string&race=string&chart_id=string&email=string&ethnicity=stringRetrieve patient QRDA1
  • GETpatients_summary_list/api/patients_summary?cursor=string&page_size=0&first_name=string&last_name=string&doctor=0&gender=string&since=string&date_of_birth=string
  • POSTpatients_summary_create/api/patients_summary?first_name=string&last_name=string&doctor=0&gender=string&since=string&date_of_birth=string
  • GETpatients_summary_read/api/patients_summary/:id?first_name=string&last_name=string&doctor=0&gender=string&since=string&date_of_birth=string
  • PUTpatients_summary_update/api/patients_summary/:id?first_name=string&last_name=string&doctor=0&gender=string&since=string&date_of_birth=string
  • DELETEpatients_summary_delete/api/patients_summary/:id?first_name=string&last_name=string&doctor=0&gender=string&since=string&date_of_birth=string
  • PATCHpatients_summary_partial_update/api/patients_summary/:id?first_name=string&last_name=string&doctor=0&gender=string&since=string&date_of_birth=string
  • GETprescription_messages_list/api/prescription_messages?cursor=string&page_size=0&parent_message=0&since=string&patient=0&doctor=0Retrieve or search prescription messages
  • GETprescription_messages_read/api/prescription_messages/:id?parent_message=0&since=string&patient=0&doctor=0Retrieve an existing prescription message
  • GETproblems_list/api/problems?cursor=string&page_size=0&patient=0&doctor=0Retrieve or search patient problems
  • POSTproblems_create/api/problems?patient=0&doctor=0Create patient problems
  • GETproblems_read/api/problems/:id?patient=0&doctor=0Retrieve an existing patient problems
  • PUTproblems_update/api/problems/:id?patient=0&doctor=0Update an existing patient problems
  • PATCHproblems_partial_update/api/problems/:id?patient=0&doctor=0Update an existing patient problems
  • GETreminder_profiles_list/api/reminder_profiles?cursor=string&page_size=0&doctor=0Retrieve or search reminder profiles
  • POSTreminder_profiles_create/api/reminder_profiles?doctor=0Create reminder profile
  • GETreminder_profiles_read/api/reminder_profiles/:id?doctor=0Retrieve an existing reminder profile
  • PUTreminder_profiles_update/api/reminder_profiles/:id?doctor=0Update an existing reminder profile
  • DELETEreminder_profiles_delete/api/reminder_profiles/:id?doctor=0Delete an existing reminder profile
  • PATCHreminder_profiles_partial_update/api/reminder_profiles/:id?doctor=0Update an existing reminder profile
  • GETsublabs_list/api/sublabs?cursor=string&page_size=0Retrieve or search sub vendors
  • POSTsublabs_create/api/sublabsCreate sub-vendors When you get orders, submit them via /api/lab_orders, such that doctors can see them in drchrono. When results come in, submit the result…
  • GETsublabs_read/api/sublabs/:idRetrieve an existing sub vendor
  • PUTsublabs_update/api/sublabs/:idUpdate an existing sub vendor
  • DELETEsublabs_delete/api/sublabs/:idDelete an existing sub vendor
  • PATCHsublabs_partial_update/api/sublabs/:idUpdate an existing sub vendor

Billing

  • GETbilling_profiles_list/api/billing_profiles?cursor=string&page_size=0&doctor=0Retrieve or search billing profiles
  • GETbilling_profiles_read/api/billing_profiles/:id?doctor=0Retrieve an existing billing profiles
  • GETcomm_logs_list/api/comm_logs?cursor=string&page_size=0&since=string&patient=0&doctor=0Retrieve or search communicatioin (phone call) logs
  • POSTcomm_logs_create/api/comm_logs?since=string&patient=0&doctor=0Create communication (phone call) logs
  • GETcomm_logs_read/api/comm_logs/:id?since=string&patient=0&doctor=0Retrieve an existing communication (phone call) logs
  • PUTcomm_logs_update/api/comm_logs/:id?since=string&patient=0&doctor=0Update an existing communication (phone call) logs
  • PATCHcomm_logs_partial_update/api/comm_logs/:id?since=string&patient=0&doctor=0Update an existing communication (phone call) logs
  • GETcustom_insurance_plan_names_list/api/custom_insurance_plan_names?cursor=string&page_size=0&since=string&user=0&name=string&doctor=0Retrieve or search custom insurance plan names
  • GETcustom_insurance_plan_names_read/api/custom_insurance_plan_names/:id?since=string&user=0&name=string&doctor=0Retrieve an existing custom insurance plan name
  • GETeligibility_checks_list/api/eligibility_checks?cursor=string&page_size=0&appointment=0&appointment_date=string&doctor=0&query_date_range=string&appointment_date_range=string&query_date=string&patient=0Retrieve or search past eligibility checks for patient
  • GETeligibility_checks_read/api/eligibility_checks/:id?appointment=0&appointment_date=string&doctor=0&query_date_range=string&appointment_date_range=string&query_date=string&patient=0Retrieve an existing past eligibility check
  • GETline_items_list/api/line_items?cursor=string&page_size=0&posted_date=string&patient=0&office=0&doctor=0&since=string&appointment=0&service_date=stringRetrieve or search billing line items
  • POSTline_items_create/api/line_items?posted_date=string&patient=0&office=0&doctor=0&since=string&appointment=0&service_date=stringCreate billing line item for appointments
  • GETline_items_read/api/line_items/:id?posted_date=string&patient=0&office=0&doctor=0&since=string&appointment=0&service_date=stringRetrieve an existing billing line item
  • PUTline_items_update/api/line_items/:id?posted_date=string&patient=0&office=0&doctor=0&since=string&appointment=0&service_date=string
  • DELETEline_items_delete/api/line_items/:id?posted_date=string&patient=0&office=0&doctor=0&since=string&appointment=0&service_date=string
  • PATCHline_items_partial_update/api/line_items/:id?posted_date=string&patient=0&office=0&doctor=0&since=string&appointment=0&service_date=string
  • GETpatient_payment_log_list/api/patient_payment_log?cursor=string&page_size=0&since=string&office=0&doctor=0Retrieve or search patient payment logs
  • GETpatient_payment_log_read/api/patient_payment_log/:id?since=string&office=0&doctor=0Retrieve an existing patient payment log
  • GETpatient_payments_list/api/patient_payments?cursor=string&page_size=0&since=string&patient=0&doctor=0Retrieve or search patient payments
  • POSTpatient_payments_create/api/patient_payments?since=string&patient=0&doctor=0Create patient payment
  • GETpatient_payments_read/api/patient_payments/:id?since=string&patient=0&doctor=0Retrieve an existing patient payment
  • GETprocedures_list/api/procedures?cursor=string&page_size=0&mu_date=string&patient=0&doctor=0&mu_date_range=string&appointment=0&service_date=string
  • GETprocedures_read/api/procedures/:id?mu_date=string&patient=0&doctor=0&mu_date_range=string&appointment=0&service_date=string
  • GETtransactions_list/api/transactions?cursor=string&page_size=0&line_item=0&posted_date=string&appointment=0&since=string&doctor=0Retrieve or search insurance transactions associated with billing line items
  • GETtransactions_read/api/transactions/:id?line_item=0&posted_date=string&appointment=0&since=string&doctor=0Retrieve an existing insurance transaction

PracticeManagement

  • GETinventory_categories_list/api/inventory_categories?cursor=string&page_size=0&since=string&doctor=0Retrieve or search inventory categories
  • GETinventory_categories_read/api/inventory_categories/:id?since=string&doctor=0Retrieve an existing inventory category
  • GETinventory_vaccines_list/api/inventory_vaccines?cursor=string&page_size=0&status=string&cvx_code=string&since=string&doctor=0Retrieve or search vaccine inventories
  • POSTinventory_vaccines_create/api/inventory_vaccines?status=string&cvx_code=string&since=string&doctor=0Create vaccine inventory
  • GETinventory_vaccines_read/api/inventory_vaccines/:id?status=string&cvx_code=string&since=string&doctor=0Retrieve an existing vaccine inventory
  • GETmessages_list/api/messages?cursor=string&page_size=0&patient=0&doctor=0&responsible_user=0&updated_since=string&received_since=string&owner=0&type=stringRetrieve or search messages in doctor's message center
  • POSTmessages_create/api/messages?patient=0&doctor=0&responsible_user=0&updated_since=string&received_since=string&owner=0&type=stringCreate messages in doctor's message center
  • GETmessages_read/api/messages/:id?patient=0&doctor=0&responsible_user=0&updated_since=string&received_since=string&owner=0&type=stringRetrieve an existing message in doctor's message center
  • PUTmessages_update/api/messages/:id?patient=0&doctor=0&responsible_user=0&updated_since=string&received_since=string&owner=0&type=stringUpdate an existing message in doctor's message center
  • DELETEmessages_delete/api/messages/:id?patient=0&doctor=0&responsible_user=0&updated_since=string&received_since=string&owner=0&type=stringDelete an existing message in doctor's message center
  • PATCHmessages_partial_update/api/messages/:id?patient=0&doctor=0&responsible_user=0&updated_since=string&received_since=string&owner=0&type=stringUpdate an existing message in doctor's message center
  • GEToffices_list/api/offices?cursor=string&page_size=0&doctor=0Retrieve or search offices
  • GEToffices_read/api/offices/:id?doctor=0Retrieve an existing office
  • PUToffices_update/api/offices/:id?doctor=0Update an existing office
  • PATCHoffices_partial_update/api/offices/:id?doctor=0Update an existing office
  • POSToffices_add_exam_room/api/offices/:id/add_exam_room?doctor=0Add an exam room to the office
  • GETtask_categories_list/api/task_categories?cursor=string&page_size=0&since=stringRetrieve or search task categories
  • POSTtask_categories_create/api/task_categories?since=stringCreate a task category
  • GETtask_categories_read/api/task_categories/:id?since=stringRetrieve an existing task category
  • PUTtask_categories_update/api/task_categories/:id?since=stringUpdate an existing task category
  • PATCHtask_categories_partial_update/api/task_categories/:id?since=stringUpdate an existing task category
  • GETtask_notes_list/api/task_notes?cursor=string&page_size=0&task=0&since=stringRetrieve or search task notes
  • POSTtask_notes_create/api/task_notes?task=0&since=stringCreate a task note
  • GETtask_notes_read/api/task_notes/:id?task=0&since=stringRetrieve an existing task note
  • PUTtask_notes_update/api/task_notes/:id?task=0&since=stringUpdate an existing task note
  • PATCHtask_notes_partial_update/api/task_notes/:id?task=0&since=stringUpdate an existing task note
  • GETtask_statuses_list/api/task_statuses?cursor=string&page_size=0&since=stringRetrieve or search task statuses
  • POSTtask_statuses_create/api/task_statuses?since=stringCreate a task status
  • GETtask_statuses_read/api/task_statuses/:id?since=stringRetrieve an existing task status
  • PUTtask_statuses_update/api/task_statuses/:id?since=stringUpdate an existing task status
  • PATCHtask_statuses_partial_update/api/task_statuses/:id?since=stringUpdate an existing task status
  • GETtask_templates_list/api/task_templates?cursor=string&page_size=0&assignee_user=0&status=0&assignee_group=0&since=string&category=0Retrieve or search task templates
  • POSTtask_templates_create/api/task_templates?assignee_user=0&status=0&assignee_group=0&since=string&category=0Create a task template
  • GETtask_templates_read/api/task_templates/:id?assignee_user=0&status=0&assignee_group=0&since=string&category=0Retrieve an existing task template
  • PUTtask_templates_update/api/task_templates/:id?assignee_user=0&status=0&assignee_group=0&since=string&category=0Update an existing task template
  • PATCHtask_templates_partial_update/api/task_templates/:id?assignee_user=0&status=0&assignee_group=0&since=string&category=0Update an existing task template
  • GETtasks_list/api/tasks?cursor=string&page_size=0&status=0&category=0&due_at_date=string&due_at_unknown=string&since=string&due_at_since=string&assignee_user=0&assignee_group=0&due_at_range=stringRetrieve or search tasks
  • POSTtasks_create/api/tasks?status=0&category=0&due_at_date=string&due_at_unknown=string&since=string&due_at_since=string&assignee_user=0&assignee_group=0&due_at_range=stringCreate a task
  • GETtasks_read/api/tasks/:id?status=0&category=0&due_at_date=string&due_at_unknown=string&since=string&due_at_since=string&assignee_user=0&assignee_group=0&due_at_range=stringRetrieve an existing task
  • PUTtasks_update/api/tasks/:id?status=0&category=0&due_at_date=string&due_at_unknown=string&since=string&due_at_since=string&assignee_user=0&assignee_group=0&due_at_range=stringUpdate an existing task
  • PATCHtasks_partial_update/api/tasks/:id?status=0&category=0&due_at_date=string&due_at_unknown=string&since=string&due_at_since=string&assignee_user=0&assignee_group=0&due_at_range=stringUpdate an existing task

API details

Base URL
https://app.drchrono.com
Authentication
OAuth 2.0 (authorization code flow) with 22 scopes
Operations
263 operations on 131 pathsGET 127POST 44PATCH 38PUT 37DELETE 17
Main resources
Clinical 190PracticeManagement 41Billing 26Administrative 6
Response formats
application/json application/xml
Description format
OpenAPI 3.0.0, API version v4 (Hunt Valley)
Listed from
APIs.guru OpenAPI Directory (CC0-1.0)
Source updated

How to test the Drchrono API in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the Drchrono API collection, without the publisher's secrets.
  3. Add your credentialsThis API uses OAuth 2.0 (authorization code flow) with 22 scopes. Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “doctors_list” (GET /api/doctors?cursor=string&page_size=0&doctor=0), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the Drchrono API?

This document is intended as a detailed reference for the precise behavior of the drchrono API. If this is your first time using the API, start with our… It is listed under Other and has 263 endpoints.

Who publishes the Drchrono API?

It is listed from DrChrono's public API description (an OpenAPI document), not published by DrChrono on Swastik Codes. Anyone who controls drchrono.com can claim the profile by adding a DNS TXT record.

What is the base URL of the Drchrono API?

Requests go to https://app.drchrono.com. Endpoint paths are added to this base URL.

How do I authenticate with the Drchrono API?

With OAuth 2.0 (authorization code flow) with 22 scopes.

How many endpoints does the Drchrono API have?

263 operations on 131 paths (127 GET, 44 POST, 38 PATCH, 37 PUT, 17 DELETE). The largest groups are Clinical, PracticeManagement, Billing, Administrative.

Is forking the Drchrono API free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.