V3 Change Log

Note: dates are based on when the change was made, which will generally be a week before the change reaches production.

From v2

• Scopes that provide access to information covered by user permissions on the web interface now respect those permissions.
• Insurances endpoint now properly checks for the user scope
• Verbose flag on all endpoints will return a paginated response with smaller page sizes

2016-09-06

• Added primary_insurance/photo_front, primary_insurance/photo_back, secondary_insurance/photo_front, secondary_insurance/photo_back, tertiary_insurace/photo_front ,tertiary_insurace/photo_back to /api/patients

2016-09-13

• Removed global daily rate limit. Hourly limit still in effect.

2016-11-01

• Made custom_demographics endpoint writable

2016-11-03

• In the api/appointments endpoint, added the since parameter to the required filtering parameters

2016-11-17

• Added `/api/patients/:id/qrda1 to return QRDA-1 XML for the patient

2016-11-18

• Added message_notes field to /api/messages. Message Notes can be added using POST and PATCH requests and retrieved using GET requests.

2016-12-12

• Added created_at field to /api/appointments.
• Exposed primary and secondary insurance details over api/appointments
• Added posted_date to /api/transactions.

2016-12-21

• Added /api/prescription_messages endpoint. The endpoint supports GET only.
• Added updated_at to /api/messages along with a updated_since filter for the same field
• Added default_pharmacy field to /api/patients endpoint

2017-01-17

• Added fax_number field to /api/offices endpoint

2017-04-27

• Added permissions field to /api/users endpoint

2017-05-19

• Added show_archived filter parameter to /api/appointments endpoint

2017-05-24

• Added is_accont_suspended field to /api/doctors endpoint

2017-05-25

• Added cloned_from field to /api/appointments endpoint

2017-06-06

• Added snomed_ct_code field to /api/problems endpoint
• Expose POST, PUT, PATCH, methods on /api/problems, /api/medications and /api/allergies endpoints

2017-06-20

• Added extended_updated_at field to /api/appointment endpoint

2017-07-02

• Added recurring_appointment field and base_recurring_appointment field to /api/appointment endpoint

2017-07-21

• Added is_walk_in field to /api/appointment endpoint

2017-08-11

• New endpoint /api/fee_schedules added

2017-08-15

• Added nick_name field to /api/patients endpoint

2017-08-21

• Add patient_flags to /api/patients endpoint

2017-08-21

• Added billing_provider field to /api/appointments endpoint

2017_09-18

• billing_status in /api/appointments endpoint now is writable.

2017-09-18

• Endpoint permission change! Read on the following endpoints, /api/patients, /api/documents, /api/custom_demographics, now requires the same scope as write to those endpoints.

2017-09-29

• Added doctor field to /api/patient_payment_log endpoint

2017-10-18

• Add /api/comm_logs endpoint

2017-10-24

• Added source field to /api/patient_payment_log endpoint
• Open /api/patient_payments endpoint

2017-11-04

• Added /api/custom_insurance_plan_names endpoint

2017-12-01

• Added /api/inventory_categories, /api/inventory_vaccines, /api/patient_vaccine_records endpoints

2017-12-14

• Added patient_status field to /api/patients endpoint

2018-01-02

• Added patient_flags_attched to /api/patients endpoint

2018-01-05

• Added referring_source field to /api/patients endpoint
• Added billing_notes field to /api/appointments endpoint

2018-01-09

• Added practice_group_name field to /api/doctors endpoint

2018-01-11

• Added supervising_provider field to /api/appointments endpoint

2018-01-31

• Added endpoints related to Task system

2018-02-01

• Added timezone field to /api/doctors endpoint

2018-02-09

• Added show_inactive filter to /api/patients endpoint

2018-03-13

• Patient CCDA can be filtered with date and date_range filter parameters

2018-03-26

• Add since filter parameter to /api/clinical_note_field_values

2018-04-04

• Added appointment, patient, posted_date filter to /api/transactions endpoint

2018-04-10

• Added service_date filter to /api/transactions endpoint

2018-04-17

• Added /api/line_item_transactions endpoint

2018-04-27

• Added /api/custom_appointment_fields endpoint and custom_fields in /api/appointments endpoint

2018-04-30

• Open write access to /api/clinical_note_field_values endpoint

2018-05-09

• Open CQM entries endpoints. /api/patient_interventions, /api/patient_physical_exams, /api/patient_risk_assessments, /api/patient_communications

2018-05-23

• Open read-only /api/lab_results endpoint

2018-06-05

• Added /api/patients/:id/onpatient_access detail endpoint

2018-08-01

• Added /api/staff endpoint
• Added /api/procedures endpoint

2018-08-02

• Added /api/implantable_devices endpoint

2018-08-03

• Added /api/care_plans endpoint

2018-08-03

• Added /api/eligibilities endpoint

2018-09-25

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.

• Added lab workflow.

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

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

• Updated webhook verification process

2018-10-16

• Add show_persistent filter to /api/clinical_note_field_values

2019-01-04

• Add /api/task_notes endpoint.

2019-07-16

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

2019-07-25

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

2019-08-09

• Add insurance_status field to /api/transactions endpoint

2019-08-28

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

2019-09-02

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

2019-09-17

• Add referring_doctor field to /api/patients endpoint

2019-09-18

• Add auto_accident_insurance and workers_comp_insurance to /api/patients field

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.

2024-03-28

Making the billing_provider and supervising_provider fields writable.