Changelog

Keep track of every change to the Server API.

This changelog lists all additions and updates to the Server API released after October 1st, 2022.

2023-03-31

• Added related_prescriptions field in The Appointment object
• Add assigned conversations with assignees unreads endpoint.

2023-03-30

• Add /prescriptions and /prescriptions/{id} to get a list of prescriptions, or get/delete a single one.
• Add a Get openings endpoint to retrieve all the available slots to book an appointment for a list of doctors.

2023-03-29

• Added related_documents field in The Appointment object

2023-03-28

• Create new version 2023-03-28
• In The Availability object, supported_modes no longer return an array of enum ['NABLA_VIDEOCALL', 'EXTERNAL_VIDEOCALL', 'IN_PERSON'] but an array of enum containing only 2 values: 'VIDEOCALL' or 'IN_PERSON'
• In Create an availability, the supported_modes property, in the body params, can be set with an array of enum containing 2 possible values: 'VIDEOCALL' or 'IN_PERSON'
• Add an until parameter in Get all availabilities

2023-03-27

• Phone number no longer need to be unique for patients of a sub-organization.

2023-03-23

• Add a until parameter in get appointments

2023-03-21

• Add assigned conversations with assignees unreads count endpoint.

2023-03-13

• Create new version 2023-03-13
• Providers are no longer updated in conversation updates.

2023-03-07

• Add appointment.note.updated event type.

2023-03-02

• Add note to the create appointment endpoint.

2023-03-01

• Add note to the get appointment endpoint.

2023-02-21

• Add apero_id as integrations' fields to the patient object, and as argument of the create/update endpoints.

2023-02-17

• Add username filter to the get Patients endpoint.

2023-02-16

• Create version 2023-02-16 and remove description field from allergies, conditions, immunizations, medication statements and procedures in POST and PATCH requests and in corresponding response objects.

2023-02-15

• Add is_paid to the Appointment object.
• Update update_appointment endpoint to update is_paid of an Appointment.

2023-02-08

• Create version 2023-02-08 to have multiple assigned providers per conversation instead of only one.
• Update the get conversation endpoint to return an assigned_providers field being a list of provider instead of a single assigned_provider.
• Update the create conversation endpoint to accept an assigned_provider_ids field instead of a single assigned_provider_id.
• Update the update conversation endpoint to accept an assigned_provider_ids field instead of a single assigned_provider_id.
• Add EXTERNAL_VIDEOCALL mode to the Appointment object.
• Add external_videocall_url to the Appointment object.

2023-02-03

• Add PENDING status to the Appointment object.

2023-02-01

• Add from filter to the get_appointments endpoint.

2023-01-31

• Create Availability object.
• Add create_availability endpoint.
• Add get_availability endpoint.
• Add delete_availability endpoint.
• Add get_availabilities endpoint.
• Add a MedicalOrder object with its associated CRUD endpoints.
• Add medical_order.created, medical_order.updated and medical_order.deleted event types.
• Add a medical_order_id field to the Task object and its associated CRUD endpoints.

2023-01-27

• Create version 2023-01-27 to change phone numbers format in patient and provider objects. In this version, they are prefixed with the '+' sign.
• Add mode to the Appointment object (NABLA_VIDEOCALL or IN_PERSON).
• Add location as the provider address to the Appointment objects that are of mode IN_PERSON.
• Add get_appointments endpoint to search for appointments.
• Add get_appointment endpoint to get a single appointment and delete_appointment to drop it.

2023-01-24

• Add status to the Appointment object
• Add update_appointment endpoint to update the status of an Appointment (SCHEDULED, CANCELLED, FINALIZED, NO_SHOW)

2023-01-23

• Add appointment_type to the Appointment object
• Add a get_appointment_types endpoint returning the list of AppointmentType objects
• Remove the deprecated fetch recent events page in favor of the get webhook events page.
• Edit the get webhook events page with more details about our storage policy for events.

2023-01-17

• Add type as query param for the converations end point.
• Add metadata to provider object

2023-01-11

• The MedicalData endpoint now shows family member medical conditions.

2023-01-10

• Update family member enum

2023-01-05

• Add support for PT

2022-12-22

• Add a delete document endpoint
• Add a get document endpoint, returning the requested Document
• Add a create document endpoint, returning the created Document
• Add a get documents endpoint, returning a list of Document
• Can now create conditions for a patient family member. They are retrievable through the Family Member History endpoint.

2022-12-20

• Create version 2022-12-20.
• Deprecate text and attachment in Message create and replace them with content, a composite type that can be either a text or an attachment (but not both at the same time)
• In QuestionnaireResponses create and update operations, data parameter is renamed into items.
• In Patient create and update operations, patient_field_values parameter is renamed into custom_fields.

2022-12-16

• Remove SURGICAL value from the category enum of the Condition object
• Un-deprecate call_duration_minutes in /web_call_invitations.

2022-12-14

• Create version 2022-12-14.

From this version, every request to update an object must be done with the HTTP PATCH method. It means that only the fields specified in the body of a request will be updated.
All the missing fields will be ignored (they won't reset the property to a null value, they will leave it unchanged). HTTP PUT is deprecated.

Ex.: If you just want to update the last name of a patient, you just need this property in your request:

curl --request PATCH
     --url https://api.nabla.com/v1/server/patients/98FCE1EF-DBCA-41EF-8BC7-4D1621AC07C6 \
     --header 'accept: application/json' \
     --header 'authorization: Bearer <SERVER_JWT_TOKEN>' \
     --header 'content-type: application/json' \
     --data '
{
     "last_name": "Doe"
}
'

2022-12-08

• Create version 2022-12-08
• Add appointment.scheduled webhook event, replacing appointment.created (deprecated in 2022-12-08).
• Add appointment.completed webhook event, replacing appointment.finalized (deprecated in 2022-12-08).
• Add appointment.no_show webhook event.
• Add patient_field_values field on patient. These values will be shown to the practitioners on the Nabla Console, where they will be able to edit them.

2022-12-07

• Add date_of_birth in the Patient object

2022-11-29

• Add appointment_type_id to /appointments and /web_call_invitations.
• Add appointment_category_id to /web_call_invitations.

2022-11-25

• Add MedicalData endpoint.

2022-11-18

• Add Task endpoints.
• Add new types of webhook events task.created, task.updated and task.deleted.
• Add isPatientTask field on task which allows tasks to be assigned to the patient instead of the provider. A patient task can't have a provider assigned to it.

2022-11-15

• In the Patient object, add an optional summary
• Add new types of webhook events conversation.locked and conversation.unlocked. They are sent when a conversation is locked/unlocked.
• Add locked field on conversation which describes whether a conversation is locked or not. A locked conversation can't receive new messages from the patient, providers, nor the system. (2022-10-19 only)

2022-11-04

• Fix API calls that didn't use correctly the default pinned version.
• In the Patient object, group all the address fields in a same object

2022-11-02

• Add console_status in params to update and create a conversation (2022-10-19 only)
• In the Patient object, add a maximum length constraint of 256 to city and state, of 10 to zip_code

2022-10-31

• Create version 2022-10-19 for conversation (see upgrades)
  • In the conversation object:
    • the patient field is deprecated and replaced by patients, which contains the list of patients included in the conversation
  • In Create a conversation, in body params:
    • patient_id is deprecated and replaced by patient_ids, which contains the list of patients included in the conversation.
    • A new field is required, type, to categorize the conversation with 2 possible values:
      • individual_conversation, when there's a single patient with one or several practitioners
      • group_conversation for conversation with several patients.
  • In Update a conversation, in body params:
    • a new field can be used in the params: patient_ids, if you want to add new patients in a "group conversation"

2022-10-26

• Add healthcare_system_identifier to the Patient object (also available on create & update)

2022-10-24

• Add an endpoint to create an appointment

2022-10-20

• Add biography and ephemeral_url to the Provider object. (biography is also available on create and update)

2022-10-11

• Add an endpoint to create, update, read one, or read all for a patient, and delete a QuestionnaireResponse object

2022-10-06

• Add Authentication endpoints that provide JWT tokens to log in a user.