V4 Change Log

2024-11-01

• Add feature to prevent duplicate patient creation via the Patients API. Enable the api_prevent_patient_duplicate feature flag to receive a validation error "Potential duplicate patient(s) found." when a duplicate is detected. The check validates the patient's first name, last name, date of birth, and gender. To override this check, include the allow_duplicates field in the request with a value of True.

2021-11-17

• Add the /api/patients_list endpoint. This is used for requesting batches of patients.

2023-11-15

• Fixed the verbose functionality in the /api/appointments_list endpoint to provide the verbose field listing

2023-10-11

• PUT/PATCH/POST preferred_pharmacies will not work temporarily while we work on a fix.

2023-10-09

• Add occurred_since filter to /api/appointments endpoint

2023-08-04

• The default preferred pharmacy for a patient will be returned as the first item in the preferred_pharmacies field.

2023-07-26

• Add /api/staff endpoint

2023-07-12

• The share_communications permission has been updated to allow for the sharing of communication data strictly via the API. Previously, the share_communications permission, when enabled, shared data across the entire practice on both web and API. The option to only share via the API has now been included. Communication data includes data found in the api/messages and api/lab_results endpoints. The permission is only editable by DrChrono employees. Please reach out to api@drchrono.com for assistance on updating.

2023-05-31

When introducing the preferred_pharmacies field while retaining the default_pharmacy field, we need to ensure backward compatibility. The following behavior will be implemented:

1. Existing Default Pharmacy:

   • If a patient already has a value set for the default_pharmacy field and the NCPDP ID of the default pharmacy exists in the preferred_pharmacies list, it will be automatically added to the preferred_pharmacies list.  
   • If the NCPDP ID of the default pharmacy does not exist in the preferred_pharmacies list or is an invalid value, the default pharmacy will be set to an empty string in the patient's data.
   • Users will not be able to exclude the default pharmacy directly. They can remove the default pharmacy by either using the UI or removing all pharmacies from the preferred_pharmacies list.

2. Default Pharmacy Updates:

   • If the default pharmacy is updated, the new value will be automatically added to the preferred_pharmacies list if it is not already present. 
   • If the new default pharmacy is already present in the preferred_pharmacies list, there will be no duplication.

Note: The default_pharmacy field will be deprecated in a future version. It is recommended to use the preferred_pharmacies field to manage the patient's pharmacies. Please ensure that the NCPDP ID of the default pharmacy is valid and exists to avoid the default pharmacy being set to an empty string in the patient's data.

This backward compatibility ensures that the existing functionality of the default_pharmacy field is maintained while allowing users to manage their preferred pharmacies through the preferred_pharmacies list.

2023-05-31

• Fixed an issue in the /api/care_plans endpoint. A bug caused the endpoint to incorrectly filter care plans, resulting in an empty response for some affected users. The issue has been resolved, and the endpoint now correctly retrieves and returns care plans for all users.

2023-05-12

• Update to api/patients endpoint. Added the preferred_pharmacies field, allowing the patient to have an array of multiple preferred pharmacies. This field will replace the default_pharmacy field functionality, as the default pharmacy feature has been deprecated in DrChrono in place of preferred pharmacies.

2022-06-23

• Update to api/patients endpoint. The chart_id field now requires the format of AAAA000000.

2021-10-01

• Add the /api/appointments_list endpoint

2021-07-08

• Add the fields parameter to /api/appointments endpoint. This parameter allows users to select the fields returned in the response.

2020-02-24

• Add ins1_status and ins2_status field to /api/appointments endpoint

2020-02-05

• Add vendor_name field to /api/sublabs endpoint

2019-12-13

• Add tax_id_number_professional field to /api/office endpoint

2019-12-12

• Add /api/claim_billing_notes endpoint
• Add /api/eobs endpoint

2019-12-02

• Add ndc field to /api/medications endpoint

2019-11-15

• Add is_virtual_base field to /api/appointments endpoint

2019-10-01

• Add /api/patient_messages endpoint

2019-09-18

• Add auto_accident_insurance and workers_comp_insurance to /api/patients field

2019-09-17

• Add referring_doctor field to /api/patients endpoint

2019-09-02

• Add /api/billing_profiles endpoint
• Add /api/consent_forms endpoint

2019-08-28

• Add assigned_by field to /api/tasks endpoint
• Add status_transitions field to /api/appointments endpoint

2019-08-09

• Add insurance_status to /api/line_items endpoint

2019-07-25

• Add archived field to /api/documents endpoint
• Add profile_picture to /api/doctors endpoint

2019-07-16

• Add allowed_values field to /api/clinical_note_field_types endpoint
• Add since filter to /api/transactions endpoint

2019-04-04

• Add status filter to /api/appointments endpoint

2019-01-04

• Add /api/task_notes endpoint

2018-10-16

• Add show_persistent filter to /api/clinical_note_field_values
• Updated webhook verification process. This will only effect future webhook implementations.

2018-10-15

• Deprecate week_day field of /api/appointment_templates, use week_days field instead.

2018-09-25 From V3

• We've changed the behavior of /api/lab_results endpoint a bit.

  • It used to require clinical scope, now it requires labs scope instead.
  • obs_code field renamed to observation_code
  • obs_description field renamed to observation_description
  • result_code field renamed to group_code
  • test field deprecated
  • document field now returns an integer ID instead of the document object.

• Remove /api/staff endpoint

• /api/transactions endpoint renamed to /api/line_items

• /api/line_item_transactions endpoint renamed to /api/transactions

• A new scope named settings introduced, and the following endpionts scopes requirements have changed.

  • /api/appointment_templates, now requires both calendar and settings
  • /api/appointment_profiles, now requires both calendar and settings
  • /api/custom_appointment_fields, now requires both clinical and settings
  • /api/custom_vitals, now requires both clinical and settings
  • /api/custom_demographics, now requires both patients and settings
  • /api/patient_flag_types, now requires both patients and settings
  • /api/custom_insurance_names, now requires settings instead of patients

• Deprecate week_day field in /api/appointment_templates. Use week_days instead.

2018-09-18

Starting this day, we will be using a new version naming mechanism. Instead of calling the versions by dates, we will be using numerical versions. Please checkout our version map here for more information.

2019-10-01

• Add /api/patient_messages endpoint