openapi: 3.0.0 info: version: v4 - Hunt Valley description: RESTful API for the drchrono EHR platform providing access to patient records, clinical encounters, appointments, prescriptions, billing, lab orders, and practice administration with OAuth 2.0 authentication and HIPAA-compliant data exchange. x-logo: url: https://www.drchrono.com/site_media/images/logos/drchrono-black-wpadding.png altText: DrChrono Logo title: DrChrono EHR REST Administrative Clinical API servers: - url: https://app.drchrono.com tags: - description: Create and manage clinical resources name: Clinical paths: /api/claim_billing_notes: post: responses: '201': content: application/json: schema: $ref: '#/components/schemas/ClaimBillingNotes' description: Created '405': content: {} description: Method Not Allowed '404': content: {} description: Not Found '403': content: {} description: Permission Denied '401': content: {} description: Unauthorized '400': content: {} description: Bad Request '500': content: {} description: Internal Server Error parameters: - schema: type: integer description: '' title: appointment required: false description: '' name: appointment in: query - schema: type: integer description: '' title: doctor required: false description: '' name: doctor in: query tags: - Clinical x-permissions: - billing - show-billing-tab x-practice-access: '"share_patients" need to be set for data access among practice' security: - drchrono_oauth2: - billing:read - billing:write operationId: claim_billing_notes_create description: Create a new billing note get: responses: '200': content: application/json: schema: title: '' type: object description: Paginated Result properties: previous: type: string description: Previous paginated page title: previous data: items: $ref: '#/components/schemas/ClaimBillingNotes' type: array description: result data title: data next: type: string description: Next Paginated page title: next description: OK '405': content: {} description: Method Not Allowed '404': content: {} description: Not Found '403': content: {} description: Permission Denied '401': content: {} description: Unauthorized '400': content: {} description: Bad Request '500': content: {} description: Internal Server Error parameters: - schema: type: string description: The pagination cursor value. title: Cursor required: false name: cursor in: query - schema: type: integer description: Number of results to return per page. title: Page size required: false name: page_size in: query - schema: type: integer description: '' title: appointment required: false description: '' name: appointment in: query - schema: type: integer description: '' title: doctor required: false description: '' name: doctor in: query tags: - Clinical x-permissions: - billing - show-billing-tab x-practice-access: '"share_patients" need to be set for data access among practice' security: - drchrono_oauth2: - billing:read - billing:write operationId: claim_billing_notes_list description: Retrieve or search billing notes /api/signed_consent_forms: post: responses: '201': content: application/json: schema: $ref: '#/components/schemas/SignedConsentForm' description: Created '405': content: {} description: Method Not Allowed '404': content: {} description: Not Found '403': content: {} description: Permission Denied '401': content: {} description: Unauthorized '400': content: {} description: Bad Request '500': content: {} description: Internal Server Error parameters: - schema: type: integer title: patient required: true description: ID of the patient to associate with the consent form name: patient in: query - schema: type: integer title: appointment required: true description: ID of the appointment to associate with the consent form name: appointment in: query - schema: type: integer title: consent_form required: true description: ID of the consent form that was signed name: consent_form in: query - schema: type: file title: signature_file required: false description: File containing the patient's signature name: signature_file in: query tags: - Clinical description: Create a signed consent form record for a patient and consent form x-permissions: - manage-patients summary: signed_consent_forms Create requestBody: content: multipart/form-data: schema: $ref: '#/components/schemas/SignedConsentFormUpdate' x-practice-access: '"share_consent_forms" need to be set for data access among practice' security: - drchrono_oauth2: - patients:read - patients:write operationId: signed_consent_forms_create patch: responses: '204': content: {} description: No Content '405': content: {} description: Method Not Allowed '404': content: {} description: Not Found '403': content: {} description: Permission Denied '401': content: {} description: Unauthorized '400': content: {} description: Bad Request '500': content: {} description: Internal Server Error parameters: - schema: type: integer description: ID of the consent form signature to update title: id required: true name: id in: query - schema: type: integer title: patient required: false description: ID of the patient to filter by name: patient in: query tags: - Clinical description: Update an existing consent form signature x-permissions: - manage-patients summary: signed_consent_forms Update requestBody: content: multipart/form-data: schema: type: object properties: archived: type: boolean description: Whether to archive the consent form signature appointment: type: integer description: ID of the appointment to assign the consent form signature to id: type: integer description: ID of the consent form signature to update signature_file: type: string description: Base64-encoded signature file to update format: binary examples: ArchiveSignature: value: archived: true id: 12345 AssignToDifferentAppointment: value: appointment: 67890 id: 12345 UpdateSignatureFile: value: id: 12345 signature_file: base64-encoded-signature-file x-practice-access: '"share_consent_forms" need to be set for data access among practice' security: - drchrono_oauth2: - patients:read - patients:write operationId: signed_consent_forms_partial_update get: responses: '200': content: application/json: schema: title: '' type: object description: Paginated Result properties: previous: type: string description: Previous paginated page title: previous results: items: $ref: '#/components/schemas/SignedConsentForm' type: array description: List of consent form signatures title: results next: type: string description: Next Paginated page title: next description: OK '405': content: {} description: Method Not Allowed '404': content: {} description: Not Found '403': content: {} description: Permission Denied '401': content: {} description: Unauthorized '400': content: {} description: Bad Request '500': content: {} description: Internal Server Error parameters: - schema: type: string description: The pagination cursor value. title: Cursor required: false name: cursor in: query - schema: type: integer description: Number of results to return per page. title: Page size required: false name: page_size in: query - schema: type: integer description: ID of the patient to filter by title: patient required: false description: '' name: patient in: query - schema: type: integer description: ID of the doctor to filter by title: doctor required: false description: '' name: doctor in: query tags: - Clinical description: Retrieve or search signed consent forms x-permissions: - manage-patients summary: signed_consent_forms Get requestBody: content: application/json: examples: example1: description: Example of filtering by patient value: patient: 12345 schema: $ref: '#/components/schemas/SignedConsentForm' x-practice-access: '"share_consent_forms" need to be set for data access among practice' security: - drchrono_oauth2: - patients:read - patients:write operationId: signed_consent_forms_list /api/custom_appointment_fields: post: responses: '201': content: application/json: schema: $ref: '#/components/schemas/CustomAppointmentFieldType' description: Created '405': content: {} description: Method Not Allowed '404': content: {} description: Not Found '403': content: {} description: Permission Denied '401': content: {} description: Unauthorized '400': content: {} description: Bad Request '500': content: {} description: Internal Server Error parameters: - schema: type: integer description: '' title: doctor required: false description: '' name: doctor in: query tags: - Clinical x-permissions: - clinical-notes - settings x-practice-access: '"share_patients" need to be set for data access among practice' security: - drchrono_oauth2: - clinical:read - clinical:write - settings:read - settings:write operationId: custom_appointment_fields_create description: Create custom appointment fields get: responses: '200': content: application/json: schema: title: '' type: object description: Paginated Result properties: previous: type: string description: Previous paginated page title: previous data: items: $ref: '#/components/schemas/CustomAppointmentFieldType' type: array description: result data title: data next: type: string description: Next Paginated page title: next description: OK '405': content: {} description: Method Not Allowed '404': content: {} description: Not Found '403': content: {} description: Permission Denied '401': content: {} description: Unauthorized '400': content: {} description: Bad Request '500': content: {} description: Internal Server Error parameters: - schema: type: string description: The pagination cursor value. title: Cursor required: false name: cursor in: query - schema: type: integer description: Number of results to return per page. title: Page size required: false name: page_size in: query - schema: type: integer description: '' title: doctor required: false description: '' name: doctor in: query tags: - Clinical x-permissions: - clinical-notes - settings x-practice-access: '"share_patients" need to be set for data access among practice' security: - drchrono_oauth2: - clinical:read - clinical:write - settings:read - settings:write operationId: custom_appointment_fields_list description: Retrieve or search custom appointment fields /api/lab_orders/{id}: put: responses: '204': content: {} description: No Content '405': content: {} description: Method Not Allowed '404': content: {} description: Not Found '403': content: {} description: Permission Denied '401': content: {} description: Unauthorized '400': content: {} description: Bad Request '500': content: {} description: Internal Server Error parameters: - schema: type: string description: '' title: '' required: true name: id in: path - schema: type: string description: '' title: since required: false description: '' name: since in: query - schema: type: integer description: '' title: doctor required: false description: '' name: doctor in: query tags: - Clinical x-permissions: [] x-practice-access: '"share_patients" need to be set for data access among practice' security: - drchrono_oauth2: - labs:read - labs:write operationId: lab_orders_update description: Update an existing lab order patch: responses: '204': content: {} description: No Content '405': content: {} description: Method Not Allowed '404': content: {} description: Not Found '403': content: {} description: Permission Denied '401': content: {} description: Unauthorized '400': content: {} description: Bad Request '500': content: {} description: Internal Server Error parameters: - schema: type: string description: '' title: '' required: true name: id in: path - schema: type: string description: '' title: since required: false description: '' name: since in: query - schema: type: integer description: '' title: doctor required: false description: '' name: doctor in: query tags: - Clinical x-permissions: [] x-practice-access: '"share_patients" need to be set for data access among practice' security: - drchrono_oauth2: - labs:read - labs:write operationId: lab_orders_partial_update description: Update an existing lab order get: responses: '200': content: application/json: schema: $ref: '#/components/schemas/LabOrder' description: OK '405': content: {} description: Method Not Allowed '404': content: {} description: Not Found '403': content: {} description: Permission Denied '401': content: {} description: Unauthorized '400': content: {} description: Bad Request '500': content: {} description: Internal Server Error parameters: - schema: type: string description: '' title: '' required: true name: id in: path - schema: type: string description: '' title: since required: false description: '' name: since in: query - schema: type: integer description: '' title: doctor required: false description: '' name: doctor in: query tags: - Clinical x-permissions: [] x-practice-access: '"share_patients" need to be set for data access among practice' security: - drchrono_oauth2: - labs:read - labs:write operationId: lab_orders_read description: Retrieve an existing lab order delete: responses: '204': content: {} description: No Content '405': content: {} description: Method Not Allowed '404': content: {} description: Not Found '403': content: {} description: Permission Denied '401': content: {} description: Unauthorized '400': content: {} description: Bad Request '500': content: {} description: Internal Server Error parameters: - schema: type: string description: '' title: '' required: true name: id in: path - schema: type: string description: '' title: since required: false description: '' name: since in: query - schema: type: integer description: '' title: doctor required: false description: '' name: doctor in: query tags: - Clinical x-permissions: [] x-practice-access: '"share_patients" need to be set for data access among practice' security: - drchrono_oauth2: - labs:read - labs:write operationId: lab_orders_delete description: Delete an existing lab order /api/clinical_notes_list: post: responses: '201': content: application/json: schema: properties: status: type: string description: Status of the request. Upon creation this will be "In progress" title: status uuid: type: string description: UUID of the batch of patients. title: uuid description: type: string description: Contains link to load the batch by UUID description: Created '404': content: {} description: Not Found '403': content: {} description: Permission Denied '401': content: {} description: Unauthorized '400': content: {} description: Bad Request '500': content: {} description: Internal Server Error parameters: - schema: type: string title: order_by required: false description: 'Order results by a specific field. Valid options include [id, updated_at]. Default: id.' name: order_by in: query - schema: type: integer description: Number of results to return per page. Value between 1 and 1000. title: Page size required: false name: page_size in: query - schema: type: integer description: Number of page to return. Value between 1 and max number of pages in result set. title: Page required: false name: page in: query - schema: type: integer description: Patient ID filter title: patient required: false description: Patient ID filter name: patient in: query - schema: type: integer description: Office ID filter title: office required: false description: Office ID filter name: office in: query - schema: type: integer description: Doctor ID filter title: doctor required: false description: Doctor ID filter name: doctor in: query - schema: type: string description: Inclusive lower bound on clinical note updated/created time. title: since required: false description: Inclusive lower bound on clinical note updated/created time. name: since in: query - schema: type: string description: Inclusive bounded date range on appointment scheduled date title: date_range required: false description: Inclusive bounded date range on appointment scheduled date name: date_range in: query - schema: type: string description: Filter on specific appointment scheduled date title: date required: false description: Filter on specific appointment scheduled date name: date in: query - schema: type: boolean description: When `true` includes yellow notes title: verbose required: false description: When `true` includes yellow notes name: verbose in: query tags: - Clinical x-permissions: - clinical-notes x-practice-access: '"share_clinical_templates" need to be set for data access among practice' security: - drchrono_oauth2: - clinical:read - clinical:write operationId: clinical_notes_list_create description: 'Create clinical note list request. Use the UUID returned in the response to retrieve the batch of records. Results returned in order of ID. ' get: responses: '200': content: application/json: schema: title: '' type: object description: Paginated Result properties: status: type: string description: 'Status of the request. Possible values are "Complete" or "In progress". ' title: status pagination: properties: count: type: int description: the count of all records in the result set. title: count pages: type: int description: the total pages of all pages in the result set. title: pages page: type: int description: the current page (starting with 1) in the total pages. title: page type: object description: information on the total pages, current page and total count. title: pagination results: items: $ref: '#/components/schemas/ClinicalNote' type: array description: result data. only presented when the status is "Complete" title: data uuid: type: string description: UUID of the batch of patients. title: uuid description: OK '404': content: {} description: Not Found '403': content: {} description: Permission Denied '401': content: {} description: Unauthorized '400': content: {} description: Bad Request '500': content: application/json: schema: $ref: '#/components/schemas/AsyncResourceError' description: Internal Server Error parameters: - schema: type: string description: '' title: uuid required: false description: 'The UUID token for the batch of clinical notes. This is returned in the response of the `create` endpoint. ' name: uuid in: query tags: - Clinical x-permissions: - clinical-notes x-practice-access: '"share_patients" need to be set for data access among practice' security: - drchrono_oauth2: - clinical:read operationId: clinical_notes_list_list description: Retrieve or search clinical notes in batches. Results returned in order of ID. /api/custom_vitals/{id}: get: responses: '200': content: application/json: schema: $ref: '#/components/schemas/CustomVitalType' description: OK '405': content: {} description: Method Not Allowed '404': content: {} description: Not Found '403': content: {} description: Permission Denied '401': content: {} description: Unauthorized '400': content: {} description: Bad Request '500': content: {} description: Internal Server Error parameters: - schema: type: string description: '' title: '' required: true name: id in: path - schema: type: integer description: '' title: doctor required: false description: '' name: doctor in: query tags: - Clinical x-permissions: - clinical-notes - settings x-practice-access: '"share_clinical_templates" need to be set for data access among practice' security: - drchrono_oauth2: - clinical:read - clinical:write - settings:read - settings:write operationId: custom_vitals_read description: Retrieve an existing custom vital type /api/sublabs/{id}: put: responses: '204': content: {} description: No Content '405': content: {} description: Method Not Allowed '404': content: {} description: Not Found '403': content: {} description: Permission Denied '401': content: {} description: Unauthorized '400': content: {} description: Bad Request '500': content: {} description: Internal Server Error parameters: - schema: type: integer description: A unique integer value identifying this lab vendor location. title: ID required: true name: id in: path tags: - Clinical x-permissions: [] x-practice-access: Data access among practice is available security: - drchrono_oauth2: - labs:read - labs:write operationId: sublabs_update description: Update an existing sub vendor patch: responses: '204': content: {} description: No Content '405': content: {} description: Method Not Allowed '404': content: {} description: Not Found '403': content: {} description: Permission Denied '401': content: {} description: Unauthorized '400': content: {} description: Bad Request '500': content: {} description: Internal Server Error parameters: - schema: type: integer description: A unique integer value identifying this lab vendor location. title: ID required: true name: id in: path tags: - Clinical x-permissions: [] x-practice-access: Data access among practice is available security: - drchrono_oauth2: - labs:read - labs:write operationId: sublabs_partial_update description: Update an existing sub vendor get: responses: '200': content: application/json: schema: $ref: '#/components/schemas/LabVendorLocation' description: OK '405': content: {} description: Method Not Allowed '404': content: {} description: Not Found '403': content: {} description: Permission Denied '401': content: {} description: Unauthorized '400': content: {} description: Bad Request '500': content: {} description: Internal Server Error parameters: - schema: type: integer description: A unique integer value identifying this lab vendor location. title: ID required: true name: id in: path tags: - Clinical x-permissions: [] x-practice-access: Data access among practice is available security: - drchrono_oauth2: - labs:read - labs:write operationId: sublabs_read description: Retrieve an existing sub vendor delete: responses: '204': content: {} description: No Content '405': content: {} description: Method Not Allowed '404': content: {} description: Not Found '403': content: {} description: Permission Denied '401': content: {} description: Unauthorized '400': content: {} description: Bad Request '500': content: {} description: Internal Server Error parameters: - schema: type: integer description: A unique integer value identifying this lab vendor location. title: ID required: true name: id in: path tags: - Clinical x-permissions: [] x-practice-access: Data access among practice is available security: - drchrono_oauth2: - labs:read - labs:write operationId: sublabs_delete description: Delete an existing sub vendor /api/patients/{id}/qrda1: get: responses: '200': content: application/xml: schema: type: object description: '' title: '' description: OK '405': content: {} description: Method Not Allowed '404': content: {} description: Not Found '403': content: {} description: Permission Denied '401': content: {} description: Unauthorized '400': content: {} description: Bad Request '500': content: {} description: Internal Server Error parameters: - schema: type: string description: '' title: '' required: true name: id in: path - schema: type: string description: '' title: first_name required: false description: '' name: first_name in: query - schema: type: string description: '' title: last_name required: false description: '' name: last_name in: query - schema: type: string description: '' title: preferred_language required: false description: '' name: preferred_language in: query - schema: type: integer description: '' title: doctor required: false description: '' name: doctor in: query - schema: type: string description: '' title: gender required: false description: '' name: gender in: query - schema: type: string description: '' title: since required: false description: '' name: since in: query - schema: type: string description: '' title: date_of_birth required: false description: '' name: date_of_birth in: query - schema: type: string description: '' title: race required: false description: '' name: race in: query - schema: type: string description: '' title: chart_id required: false description: '' name: chart_id in: query - schema: type: string description: '' title: email required: false description: '' name: email in: query - schema: type: string description: '' title: ethnicity required: false description: '' name: ethnicity in: query tags: - Clinical x-permissions: - manage-patients x-practice-access: '"share_patients" need to be set for data access among practice' security: - drchrono_oauth2: - patients:read - patients:write operationId: patients_qrda1 description: Retrieve patient QRDA1 /api/problems: post: responses: '201': content: application/json: schema: $ref: '#/components/schemas/PatientProblem' description: Created '405': content: {} description: Method Not Allowed '404': content: {} description: Not Found '403': content: {} description: Permission Denied '401': content: {} description: Unauthorized '400': content: {} description: Bad Request '500': content: {} description: Internal Server Error parameters: - schema: type: integer description: '' title: patient required: false description: '' name: patient in: query - schema: type: integer description: '' title: doctor required: false description: '' name: doctor in: query tags: - Clinical x-permissions: - clinical-notes x-practice-access: '"share_patients" need to be set for data access among practice' security: - drchrono_oauth2: - clinical:read - clinical:write operationId: problems_create description: Create patient problems get: responses: '200': content: application/json: schema: title: '' type: object description: Paginated Result properties: previous: type: string description: Previous paginated page title: previous data: items: $ref: '#/components/schemas/PatientProblem' type: array description: result data title: data next: type: string description: Next Paginated page title: next description: OK '405': content: {} description: Method Not Allowed '404': content: {} description: Not Found '403': content: {} description: Permission Denied '401': content: {} description: Unauthorized '400': content: {} description: Bad Request '500': content: {} description: Internal Server Error parameters: - schema: type: string description: The pagination cursor value. title: Cursor required: false name: cursor in: query - schema: type: integer description: Number of results to return per page. title: Page size required: false name: page_size in: query - schema: type: integer description: '' title: patient required: false description: '' name: patient in: query - schema: type: integer description: '' title: doctor required: false description: '' name: doctor in: query tags: - Clinical x-permissions: - clinical-notes x-practice-access: '"share_patients" need to be set for data access among practice' security: - drchrono_oauth2: - clinical:read - clinical:write operationId: problems_list description: Retrieve or search patient problems /api/staff: get: responses: '200': content: application/json: schema: title: '' type: object description: Paginated Result properties: previous: type: string description: Previous paginated page title: previous data: items: $ref: '#/components/schemas/Staff' type: array description: result data title: data next: type: string description: Next Paginated page title: next description: OK '405': content: {} description: Method Not Allowed '404': content: {} description: Not Found '403': content: {} description: Permission Denied '401': content: {} description: Unauthorized '400': content: {} description: Bad Request '500': content: {} description: Internal Server Error parameters: - schema: type: string description: The pagination cursor value. title: Cursor required: false name: cursor in: query - schema: type: integer description: Number of results to return per page. title: Page size required: false name: page_size in: query - schema: type: integer description: '' title: doctor required: false description: '' name: doctor in: query tags: - Clinical x-permissions: [] x-practice-access: Data access among practice is available security: - drchrono_oauth2: [] operationId: staff_list /api/patient_messages/{id}: put: responses: '204': content: {} description: No Content '405': content: {} description: Method Not Allowed '404': content: {} description: Not Found '403': content: {} description: Permission Denied '401': content: {} description: Unauthorized '400': content: {} description: Bad Request '500': content: {} description: Internal Server Error parameters: - schema: type: string description: '' title: '' required: true name: id in: path - schema: type: string description: '' title: since required: false description: '' name: since in: query - schema: type: integer description: '' title: patient required: false description: '' name: patient in: query - schema: type: integer description: '' title: doctor required: false description: '' name: doctor in: query tags: - Clinical x-permissions: - manage-patients - message-center x-practice-access: '"share_communications" need to be set for data access among practice' security: - drchrono_oauth2: - patients:read - patients:write - messages:read - messages:write operationId: patient_messages_update patch: responses: '204': content: {} description: No Content '405': content: {} description: Method Not Allowed '404': content: {} description: Not Found '403': content: {} description: Permission Denied '401': content: {} description: Unauthorized '400': content: {} description: Bad Request '500': content: {} description: Internal Server Error parameters: - schema: type: string description: '' title: '' required: true name: id in: path - schema: type: string description: '' title: since required: false description: '' name: since in: query - schema: type: integer description: '' title: patient required: false description: '' name: patient in: query - schema: type: integer description: '' title: doctor required: false description: '' name: doctor in: query tags: - Clinical x-permissions: - manage-patients - message-center x-practice-access: '"share_communications" need to be set for data access among practice' security: - drchrono_oauth2: - patients:read - patients:write - messages:read - messages:write operationId: patient_messages_partial_update get: responses: '200': content: application/json: schema: $ref: '#/components/schemas/PatientMessage' description: OK '405': content: {} description: Method Not Allowed '404': content: {} description: Not Found '403': content: {} description: Permission Denied '401': content: {} description: Unauthorized '400': content: {} description: Bad Request '500': content: {} description: Internal Server Error parameters: - schema: type: string description: '' title: '' required: true name: id in: path - schema: type: string description: '' title: since required: false description: '' name: since in: query - schema: type: integer description: '' title: patient required: false description: '' name: patient in: query - schema: type: integer description: '' title: doctor required: false description: '' name: doctor in: query tags: - Clinical x-permissions: - manage-patients - message-center x-practice-access: '"share_communications" need to be set for data access among practice' security: - drchrono_oauth2: - patients:read - patients:write - messages:read - messages:write operationId: patient_messages_read /api/yellow_notepad: post: responses: '201': content: application/json: schema: $ref: '#/components/schemas/YellowNotepad' description: Success - content created/updated '405': content: {} description: Method not allowed '404': content: {} description: Not Found - invalid appointment_id or template_id, or not visible to user '403': content: {} description: Forbidden - insufficient permissions, suspended account, or light suspended account attempting write '500': content: {} description: Internal Server Error '401': content: {} description: Unauthorized '400': content: application/json: examples: invalid_params: value: - template_id must be an integer summary: Invalid parameter types missing_content: value: content: - This field is required. summary: Missing content field missing_params: value: - both appointment_id and template_id must be specified summary: Missing required parameters description: Bad Request - missing/invalid parameters or content field '409': content: application/json: examples: locked_note: value: detail: Cannot modify a locked clinical note. summary: Clinical note is locked description: Conflict - the associated clinical note is locked and cannot be modified parameters: - schema: type: integer description: ID of the appointment. Must be visible to the authenticated user. title: Appointment ID required: true name: appointment_id in: query - schema: type: integer description: ID of the clinical note template. Must belong to the authenticated user. title: Template ID required: true name: template_id in: query tags: - Clinical x-permissions: - clinical-notes requestBody: content: application/json: schema: required: - content type: object properties: content: type: string description: The yellow notepad content. Can be empty string. required: true x-practice-access: '"share_patients" need to be set for data access among practice' security: - drchrono_oauth2: - clinical:read - clinical:write operationId: yellow_notepad_create description: 'Create or update yellow notepad content for a specific appointment and template combination. This endpoint has different behavior based on the template''s workflow_key: Regular templates (workflow_key != ''hp_meds_allergies''): - Automatically includes this template in the note - Content is appointment-specific Medications/Allergies templates (workflow_key == ''hp_meds_allergies''): - Content is patient-level (shared across appointments) Both appointment_id and template_id must be provided as query parameters. Content is normalized to use consistent newline characters. ' get: responses: '200': content: application/json: schema: $ref: '#/components/schemas/YellowNotepad' description: Success - returns yellow notepad content '405': content: {} description: Method not allowed '404': content: {} description: Not Found - invalid appointment_id or template_id, or not visible to user '403': content: {} description: Forbidden - insufficient permissions or suspended account '401': content: {} description: Unauthorized '400': content: application/json: examples: invalid_params: value: - appointment_id must be an integer summary: Invalid parameter types missing_params: value: - both appointment_id and template_id must be specified summary: Missing required parameters description: Bad Request - missing or invalid query parameters '500': content: {} description: Internal Server Error parameters: - schema: type: integer description: ID of the appointment. Must be visible to the authenticated user. title: Appointment ID required: true name: appointment_id in: query - schema: type: integer description: ID of the clinical note template. Must belong to the authenticated user. title: Template ID required: true name: template_id in: query tags: - Clinical x-permissions: - clinical-notes x-practice-access: '"share_patients" need to be set for data access among practice' security: - drchrono_oauth2: - clinical:read - clinical:write operationId: yellow_notepad_retrieve description: 'Retrieve yellow notepad content for a specific appointment and template combination. Both appointment_id and template_id must be provided as query parameters. ' /api/medications: post: responses: '201': content: application/json: schema: $ref: '#/components/schemas/PatientDrug' description: Created '405': content: {} description: Method Not Allowed '404': content: {} description: Not Found '403': content: {} description: Permission Denied '401': content: {} description: Unauthorized '400': content: {} description: Bad Request '500': content: {} description: Internal Server Error parameters: - schema: type: integer description: '' title: patient required: false description: '' name: patient in: query - schema: type: integer description: '' title: doctor required: false description: '' name: doctor in: query tags: - Clinical x-permissions: - clinical-notes x-practice-access: '"share_patients" need to be set for data access among practice' security: - drchrono_oauth2: - clinical:read - clinical:write operationId: medications_create description: Create patient medications get: responses: '200': content: application/json: schema: title: '' type: object description: Paginated Result properties: previous: type: string description: Previous paginated page title: previous data: items: $ref: '#/components/schemas/PatientDrug' type: array description: result data title: data next: type: string description: Next Paginated page title: next description: OK '405': content: {} description: Method Not Allowed '404': content: {} description: Not Found '403': content: {} description: Permission Denied '401': content: {} description: Unauthorized '400': content: {} description: Bad Request '500': content: {} description: Internal Server Error parameters: - schema: type: string description: The pagination cursor value. title: Cursor required: false name: cursor in: query - schema: type: integer description: Number of results to return per page. title: Page size required: false name: page_size in: query - schema: type: integer description: '' title: patient required: false description: '' name: patient in: query - schema: type: integer description: '' title: doctor required: false description: '' name: doctor in: query tags: - Clinical x-permissions: - clinical-notes x-practice-access: '"share_patients" need to be set for data access among practice' security: - drchrono_oauth2: - clinical:read - clinical:write operationId: medications_list description: Retrieve or search patient medications /api/custom_demographics: post: responses: '201': content: application/json: schema: $ref: '#/components/schemas/CustomPatientFieldType' description: Created '405': content: {} description: Method Not Allowed '404': content: {} description: Not Found '403': content: {} description: Permission Denied '401': content: {} description: Unauthorized '400': content: {} description: Bad Request '500': content: {} description: Internal Server Error parameters: - schema: type: integer description: '' title: doctor required: false description: '' name: doctor in: query tags: - Clinical x-permissions: - manage-patients - settings x-practice-access: '"share_patients" need to be set for data access among practice' security: - drchrono_oauth2: - patients:read - patients:write - settings:read - settings:write operationId: custom_demographics_create description: Create custom demographics fields get: responses: '200': content: application/json: schema: title: '' type: object description: Paginated Result properties: previous: type: string description: Previous paginated page title: previous data: items: $ref: '#/components/schemas/CustomPatientFieldType' type: array description: result data title: data next: type: string description: Next Paginated page title: next description: OK '405': content: {} description: Method Not Allowed '404': content: {} description: Not Found '403': content: {} description: Permission Denied '401': content: {} description: Unauthorized '400': content: {} description: Bad Request '500': content: {} description: Internal Server Error parameters: - schema: type: string description: The pagination cursor value. title: Cursor required: false name: cursor in: query - schema: type: integer description: Number of results to return per page. title: Page size required: false name: page_size in: query - schema: type: integer description: '' title: doctor required: false description: '' name: doctor in: query tags: - Clinical x-permissions: - manage-patients - settings x-practice-access: '"share_patients" need to be set for data access among practice' security: - drchrono_oauth2: - patients:read - patients:write - settings:read - settings:write operationId: custom_demographics_list description: Retrieve or search custom demographics fields /api/appointments_list: post: responses: '201': content: application/json: schema: $ref: '#/components/schemas/Appointment' description: Created '405': content: {} description: Method Not Allowed '404': content: {} description: Not Found '403': content: {} description: Permission Denied '500': content: {} description: Internal Server Error '401': content: {} description: Unauthorized '400': content: {} description: Bad Request '409': content: {} description: Scheduled time overlaps with an existing appointment parameters: - schema: type: string description: '' title: status required: false description: '' name: status in: query - schema: type: integer description: '' title: patient required: false description: '' name: patient in: query - schema: type: integer description: '' title: office required: false description: '' name: office in: query - schema: type: integer description: '' title: doctor required: false description: '' name: doctor in: query - schema: type: string description: '' title: since required: false description: '' name: since in: query - schema: type: string description: '' title: date_range required: false description: '' name: date_range in: query - schema: type: string title: order_by required: false description: 'Order results by a specific field. Valid options include [scheduled_time, updated_at]. Default: scheduled_time.' name: order_by in: query - schema: type: string description: '' title: date required: false description: '' name: date in: query - schema: type: boolean description: Include archived or deleted appointments in the response title: show_archived required: false description: set to `true` or `1` to include deleted or archived appointments name: show_archived in: query tags: - Clinical x-permissions: - scheduling - clinical-notes x-practice-access: '"share_patients" need to be set for data access among practice' security: - drchrono_oauth2: - calendar:read - calendar:write - clinical:read - clinical:write operationId: appointments_list_create get: responses: '200': content: application/json: schema: title: '' type: object description: Paginated Result properties: previous: type: string description: Previous paginated page title: previous data: items: $ref: '#/components/schemas/Appointment' type: array description: result data title: data next: type: string description: Next Paginated page title: next description: OK '405': content: {} description: Method Not Allowed '404': content: {} description: Not Found '403': content: {} description: Permission Denied '401': content: {} description: Unauthorized '400': content: {} description: Bad Request '500': content: application/json: schema: $ref: '#/components/schemas/AsyncResourceError' description: Internal Server Error parameters: - schema: type: string description: The pagination cursor value. title: Cursor required: false name: cursor in: query - schema: type: integer description: Number of results to return per page. title: Page size required: false name: page_size in: query - schema: type: string description: '' title: status required: false description: '' name: status in: query - schema: type: integer description: '' title: patient required: false description: '' name: patient in: query - schema: type: integer description: '' title: office required: false description: '' name: office in: query - schema: type: integer description: '' title: doctor required: false description: '' name: doctor in: query - schema: type: string description: '' title: since required: false description: '' name: since in: query - schema: type: string description: '' title: date_range required: false description: '' name: date_range in: query - schema: type: string description: '' title: date required: false description: '' name: date in: query - schema: type: boolean description: Include archived or deleted appointments in the response title: show_archived required: false description: set to `true` or `1` to include deleted or archived appointments name: show_archived in: query tags: - Clinical x-permissions: - scheduling - clinical-notes x-practice-access: '"share_patients" need to be set for data access among practice' security: - drchrono_oauth2: - calendar:read - calendar:write - clinical:read - clinical:write operationId: appointments_list_list /api/appointment_profiles: post: responses: '201': content: application/json: schema: $ref: '#/components/schemas/AppointmentProfile' description: Created '405': content: {} description: Method Not Allowed '404': content: {} description: Not Found '403': content: {} description: Permission Denied '401': content: {} description: Unauthorized '400': content: {} description: Bad Request '500': content: {} description: Internal Server Error parameters: - schema: type: integer description: '' title: doctor required: false description: '' name: doctor in: query tags: - Clinical x-permissions: - scheduling - settings x-practice-access: '"share_appointment_profiles" need to be set for data access among practice' security: - drchrono_oauth2: - calendar:read - calendar:write - settings:read - settings:write operationId: appointment_profiles_create description: Create appointment profiles for a doctor's calendar get: responses: '200': content: application/json: schema: title: '' type: object description: Paginated Result properties: previous: type: string description: Previous paginated page title: previous data: items: $ref: '#/components/schemas/AppointmentProfile' type: array description: result data title: data next: type: string description: Next Paginated page title: next description: OK '405': content: {} description: Method Not Allowed '404': content: {} description: Not Found '403': content: {} description: Permission Denied '401': content: {} description: Unauthorized '400': content: {} description: Bad Request '500': content: {} description: Internal Server Error parameters: - schema: type: string description: The pagination cursor value. title: Cursor required: false name: cursor in: query - schema: type: integer description: Number of results to return per page. title: Page size required: false name: page_size in: query - schema: type: integer description: '' title: doctor required: false description: '' name: doctor in: query tags: - Clinical x-permissions: - scheduling - settings x-practice-access: '"share_appointment_profiles" need to be set for data access among practice' security: - drchrono_oauth2: - calendar:read - calendar:write - settings:read - settings:write operationId: appointment_profiles_list description: Retrieve or search appointment profiles for a doctor's calendar /api/patient_communications: post: responses: '201': content: application/json: schema: $ref: '#/components/schemas/PatientCommunication' description: Created '405': content: {} description: Method Not Allowed '404': content: {} description: Not Found '403': content: {} description: Permission Denied '401': content: {} description: Unauthorized '400': content: {} description: Bad Request '500': content: {} description: Internal Server Error parameters: - schema: type: integer description: '' title: patient required: false description: '' name: patient in: query - schema: type: integer description: '' title: doctor required: false description: '' name: doctor in: query tags: - Clinical x-permissions: - clinical-notes x-practice-access: '"share_patients" need to be set for data access among practice' security: - drchrono_oauth2: - clinical:read - clinical:write operationId: patient_communications_create description: Create patient communication for CQM get: responses: '200': content: application/json: schema: title: '' type: object description: Paginated Result properties: previous: type: string description: Previous paginated page title: previous data: items: $ref: '#/components/schemas/PatientCommunication' type: array description: result data title: data next: type: string description: Next Paginated page title: next description: OK '405': content: {} description: Method Not Allowed '404': content: {} description: Not Found '403': content: {} description: Permission Denied '401': content: {} description: Unauthorized '400': content: {} description: Bad Request '500': content: {} description: Internal Server Error parameters: - schema: type: string description: The pagination cursor value. title: Cursor required: false name: cursor in: query - schema: type: integer description: Number of results to return per page. title: Page size required: false name: page_size in: query - schema: type: integer description: '' title: patient required: false description: '' name: patient in: query - schema: type: integer description: '' title: doctor required: false description: '' name: doctor in: query tags: - Clinical x-permissions: - clinical-notes x-practice-access: '"share_patients" need to be set for data access among practice' security: - drchrono_oauth2: - clinical:read - clinical:write operationId: patient_communications_list description: Retrieve or search patient communications for CQM /api/appointment_profiles/{id}: put: responses: '204': content: {} description: No Content '405': content: {} description: Method Not Allowed '404': content: {} description: Not Found '403': content: {} description: Permission Denied '401': content: {} description: Unauthorized '400': content: {} description: Bad Request '500': content: {} description: Internal Server Error parameters: - schema: type: string description: '' title: '' required: true name: id in: path - schema: type: integer description: '' title: doctor required: false description: '' name: doctor in: query tags: - Clinical x-permissions: - scheduling - settings x-practice-access: '"share_appointment_profiles" need to be set for data access among practice' security: - drchrono_oauth2: - calendar:read - calendar:write - settings:read - settings:write operationId: appointment_profiles_update description: Update an existing appointment profile patch: responses: '204': content: {} description: No Content '405': content: {} description: Method Not Allowed '404': content: {} description: Not Found '403': content: {} description: Permission Denied '401': content: {} description: Unauthorized '400': content: {} description: Bad Request '500': content: {} description: Internal Server Error parameters: - schema: type: string description: '' title: '' required: true name: id in: path - schema: type: integer description: '' title: doctor required: false description: '' name: doctor in: query tags: - Clinical x-permissions: - scheduling - settings x-practice-access: '"share_appointment_profiles" need to be set for data access among practice' security: - drchrono_oauth2: - calendar:read - calendar:write - settings:read - settings:write operationId: appointment_profiles_partial_update description: Update an existing appointment profile get: responses: '200': content: application/json: schema: $ref: '#/components/schemas/AppointmentProfile' description: OK '405': content: {} description: Method Not Allowed '404': content: {} description: Not Found '403': content: {} description: Permission Denied '401': content: {} description: Unauthorized '400': content: {} description: Bad Request '500': content: {} description: Internal Server Error parameters: - schema: type: string description: '' title: '' required: true name: id in: path - schema: type: integer description: '' title: doctor required: false description: '' name: doctor in: query tags: - Clinical x-permissions: - scheduling - settings x-practice-access: '"share_appointment_profiles" need to be set for data access among practice' security: - drchrono_oauth2: - calendar:read - calendar:write - settings:read - settings:write operationId: appointment_profiles_read description: Retrieve an existing appointment profile delete: responses: '204': content: {} description: No Content '405': content: {} description: Method Not Allowed '404': content: {} description: Not Found '403': content: {} description: Permission Denied '401': content: {} description: Unauthorized '400': content: {} description: Bad Request '500': content: {} description: Internal Server Error parameters: - schema: type: string description: '' title: '' required: true name: id in: path - schema: type: integer description: '' title: doctor required: false description: '' name: doctor in: query tags: - Clinical x-permissions: - scheduling - settings x-practice-access: '"share_appointment_profiles" need to be set for data access among practice' security: - drchrono_oauth2: - calendar:read - calendar:write - settings:read - settings:write operationId: appointment_profiles_delete description: Delete an existing appointment profile /api/clinical_note_field_values/{id}: put: responses: '204': content: {} description: No Content '405': content: {} description: Method Not Allowed '404': content: {} description: Not Found '403': content: {} description: Permission Denied '401': content: {} description: Unauthorized '400': content: {} description: Bad Request '500': content: {} description: Internal Server Error parameters: - schema: type: string description: '' title: '' required: true name: id in: path - schema: type: integer description: '' title: clinical_note_field required: false description: '' name: clinical_note_field in: query - schema: type: string description: '' title: since required: false description: '' name: since in: query - schema: type: integer description: '' title: appointment required: false description: '' name: appointment in: query - schema: type: integer description: '' title: clinical_note_template required: false description: '' name: clinical_note_template in: query - schema: type: integer description: '' title: doctor required: false description: '' name: doctor in: query tags: - Clinical x-permissions: - clinical-notes x-practice-access: '"share_patients" need to be set for data access among practice' security: - drchrono_oauth2: - clinical:read - clinical:write operationId: clinical_note_field_values_update description: Update an existing clinical note field value patch: responses: '204': content: {} description: No Content '405': content: {} description: Method Not Allowed '404': content: {} description: Not Found '403': content: {} description: Permission Denied '401': content: {} description: Unauthorized '400': content: {} description: Bad Request '500': content: {} description: Internal Server Error parameters: - schema: type: string description: '' title: '' required: true name: id in: path - schema: type: integer description: '' title: clinical_note_field required: false description: '' name: clinical_note_field in: query - schema: type: string description: '' title: since required: false description: '' name: since in: query - schema: type: integer description: '' title: appointment required: false description: '' name: appointment in: query - schema: type: integer description: '' title: clinical_note_template required: false description: '' name: clinical_note_template in: query - schema: type: integer description: '' title: doctor required: false description: '' name: doctor in: query tags: - Clinical x-permissions: - clinical-notes x-practice-access: '"share_patients" need to be set for data access among practice' security: - drchrono_oauth2: - clinical:read - clinical:write operationId: clinical_note_field_values_partial_update description: Update an existing clinical note field value get: responses: '200': content: application/json: schema: $ref: '#/components/schemas/SoapNoteLineItemFieldValue' description: OK '405': content: {} description: Method Not Allowed '404': content: {} description: Not Found '403': content: {} description: Permission Denied '401': content: {} description: Unauthorized '400': content: {} description: Bad Request '500': content: {} description: Internal Server Error parameters: - schema: type: string description: '' title: '' required: true name: id in: path - schema: type: integer description: '' title: clinical_note_field required: false description: '' name: clinical_note_field in: query - schema: type: string description: '' title: since required: false description: '' name: since in: query - schema: type: integer description: '' title: appointment required: false description: '' name: appointment in: query - schema: type: integer description: '' title: clinical_note_template required: false description: '' name: clinical_note_template in: query - schema: type: integer description: '' title: doctor required: false description: '' name: doctor in: query tags: - Clinical x-permissions: - clinical-notes x-practice-access: '"share_patients" need to be set for data access among practice' security: - drchrono_oauth2: - clinical:read - clinical:write operationId: clinical_note_field_values_read description: Retrieve an existing clinical note field value /api/fee_schedules_v2: get: responses: '200': content: application/json: schema: title: '' type: object description: Paginated Result properties: previous: type: string description: Previous paginated page title: previous data: items: $ref: '#/components/schemas/FeeSchedule' type: array description: result data title: data next: type: string description: Next Paginated page title: next description: OK '405': content: {} description: Method Not Allowed '404': content: {} description: Not Found '403': content: {} description: Permission Denied '401': content: {} description: Unauthorized '400': content: {} description: Bad Request '500': content: {} description: Internal Server Error parameters: - schema: type: string description: The pagination cursor value. title: Cursor required: false name: cursor in: query - schema: type: integer description: Number of results to return per page. title: Page size required: false name: page_size in: query - schema: type: string description: CSV of payer_ids title: payer_id required: false name: payer_id in: query - schema: type: string description: Name of the plan title: plan_name required: false name: plan_name in: query - schema: type: string description: CSV of specialities title: specialities required: false name: specialities in: query - schema: type: string description: CSV of assignees title: assignees required: false name: assignees in: query - schema: type: string description: Type of fee schedule, individual|speciality title: assignee_type required: false name: assignee_type in: query - schema: type: string description: '' title: since required: false name: effective_date in: query - schema: type: string description: '' title: since required: false name: ineffective_date in: query tags: - Clinical x-permissions: - billing - show-billing-tab x-practice-access: '' security: - drchrono_oauth2: - billing:read - billing:write operationId: fee_schedules_v2_list /api/care_team_members: get: responses: '200': content: application/json: schema: title: '' type: object description: Paginated Result properties: previous: type: string description: Previous paginated page title: previous data: items: $ref: '#/components/schemas/CareTeamMember' type: array description: result data title: data next: type: string description: Next Paginated page title: next description: OK '405': content: {} description: Method Not Allowed '404': content: {} description: Not Found '403': content: {} description: Permission Denied '401': content: {} description: Unauthorized '400': content: {} description: Bad Request '500': content: {} description: Internal Server Error parameters: - schema: type: string description: The pagination cursor value. title: Cursor required: false name: cursor in: query - schema: type: integer description: Number of results to return per page. title: Page size required: false name: page_size in: query - schema: type: integer description: '' title: patient required: false description: '' name: patient in: query - schema: type: integer description: '' title: appointment required: false description: '' name: appointment in: query - schema: type: integer description: '' title: doctor required: false description: '' name: doctor in: query tags: - Clinical x-permissions: - clinical-notes x-practice-access: '"share_patients" need to be set for data access among practice' security: - drchrono_oauth2: - clinical:read - clinical:write operationId: care_team_members_list /api/consent_forms/{id}/unapply_from_appointment: post: responses: '204': content: {} description: No Content '405': content: {} description: Method Not Allowed '404': content: {} description: Not Found '403': content: {} description: Permission Denied '401': content: {} description: Unauthorized '400': content: {} description: Bad Request '500': content: {} description: Internal Server Error parameters: - schema: type: string description: '' title: '' required: true name: id in: path - schema: type: integer description: '' title: doctor required: false description: '' name: doctor in: query tags: - Clinical x-permissions: - manage-patients x-practice-access: '"share_consent_forms" need to be set for data access among practice' security: - drchrono_oauth2: - patients:read - patients:write operationId: consent_forms_unapply_from_appointment description: Unassign (unapply) a consent form from appointment /api/consent_forms/{id}/apply_to_appointment: post: responses: '204': content: {} description: No Content '405': content: {} description: Method Not Allowed '404': content: {} description: Not Found '403': content: {} description: Permission Denied '401': content: {} description: Unauthorized '400': content: {} description: Bad Request '500': content: {} description: Internal Server Error parameters: - schema: type: string description: '' title: '' required: true name: id in: path - schema: type: integer description: '' title: doctor required: false description: '' name: doctor in: query tags: - Clinical x-permissions: - manage-patients x-practice-access: '"share_consent_forms" need to be set for data access among practice' security: - drchrono_oauth2: - patients:read - patients:write operationId: consent_forms_apply_to_appointment description: Assign (apply) a consent form to appointment /api/consent_forms: post: responses: '201': content: application/json: schema: $ref: '#/components/schemas/ConsentForm' description: Created '405': content: {} description: Method Not Allowed '404': content: {} description: Not Found '403': content: {} description: Permission Denied '401': content: {} description: Unauthorized '400': content: {} description: Bad Request '500': content: {} description: Internal Server Error parameters: - schema: type: integer description: '' title: doctor required: false description: '' name: doctor in: query tags: - Clinical x-permissions: - manage-patients x-practice-access: '"share_consent_forms" need to be set for data access among practice' security: - drchrono_oauth2: - patients:read - patients:write operationId: consent_forms_create description: Create a patient consent form get: responses: '200': content: application/json: schema: title: '' type: object description: Paginated Result properties: previous: type: string description: Previous paginated page title: previous data: items: $ref: '#/components/schemas/ConsentForm' type: array description: result data title: data next: type: string description: Next Paginated page title: next description: OK '405': content: {} description: Method Not Allowed '404': content: {} description: Not Found '403': content: {} description: Permission Denied '401': content: {} description: Unauthorized '400': content: {} description: Bad Request '500': content: {} description: Internal Server Error parameters: - schema: type: string description: The pagination cursor value. title: Cursor required: false name: cursor in: query - schema: type: integer description: Number of results to return per page. title: Page size required: false name: page_size in: query - schema: type: integer description: '' title: doctor required: false description: '' name: doctor in: query tags: - Clinical x-permissions: - manage-patients x-practice-access: '"share_consent_forms" need to be set for data access among practice' security: - drchrono_oauth2: - patients:read - patients:write operationId: consent_forms_list description: Retrieve or search patient consent forms /api/reminder_profiles/{id}: put: responses: '204': content: {} description: No Content '405': content: {} description: Method Not Allowed '404': content: {} description: Not Found '403': content: {} description: Permission Denied '401': content: {} description: Unauthorized '400': content: {} description: Bad Request '500': content: {} description: Internal Server Error parameters: - schema: type: string description: '' title: '' required: true name: id in: path - schema: type: integer description: '' title: doctor required: false description: '' name: doctor in: query tags: - Clinical x-permissions: - scheduling x-practice-access: '"share_reminder_profile" need to be set for data access among practice' security: - drchrono_oauth2: - calendar:read - calendar:write operationId: reminder_profiles_update description: Update an existing reminder profile patch: responses: '204': content: {} description: No Content '405': content: {} description: Method Not Allowed '404': content: {} description: Not Found '403': content: {} description: Permission Denied '401': content: {} description: Unauthorized '400': content: {} description: Bad Request '500': content: {} description: Internal Server Error parameters: - schema: type: string description: '' title: '' required: true name: id in: path - schema: type: integer description: '' title: doctor required: false description: '' name: doctor in: query tags: - Clinical x-permissions: - scheduling x-practice-access: '"share_reminder_profile" need to be set for data access among practice' security: - drchrono_oauth2: - calendar:read - calendar:write operationId: reminder_profiles_partial_update description: Update an existing reminder profile get: responses: '200': content: application/json: schema: $ref: '#/components/schemas/ReminderProfile' description: OK '405': content: {} description: Method Not Allowed '404': content: {} description: Not Found '403': content: {} description: Permission Denied '401': content: {} description: Unauthorized '400': content: {} description: Bad Request '500': content: {} description: Internal Server Error parameters: - schema: type: string description: '' title: '' required: true name: id in: path - schema: type: integer description: '' title: doctor required: false description: '' name: doctor in: query tags: - Clinical x-permissions: - scheduling x-practice-access: '"share_reminder_profile" need to be set for data access among practice' security: - drchrono_oauth2: - calendar:read - calendar:write operationId: reminder_profiles_read description: Retrieve an existing reminder profile delete: responses: '204': content: {} description: No Content '405': content: {} description: Method Not Allowed '404': content: {} description: Not Found '403': content: {} description: Permission Denied '401': content: {} description: Unauthorized '400': content: {} description: Bad Request '500': content: {} description: Internal Server Error parameters: - schema: type: string description: '' title: '' required: true name: id in: path - schema: type: integer description: '' title: doctor required: false description: '' name: doctor in: query tags: - Clinical x-permissions: - scheduling x-practice-access: '"share_reminder_profile" need to be set for data access among practice' security: - drchrono_oauth2: - calendar:read - calendar:write operationId: reminder_profiles_delete description: Delete an existing reminder profile /api/patients_list: post: responses: '201': content: application/json: schema: properties: status: type: string description: 'Status of the request. Possible values are "In progress" or "Complete". ' title: status uuid: type: string description: UUID of the batch of patients. title: uuid description: type: string description: Contains link to load the batch by UUID description: Created '403': content: {} description: Permission Denied '500': content: {} description: Internal Server Error '401': content: {} description: Unauthorized '400': content: {} description: Bad Request parameters: - schema: type: string title: order_by required: false description: 'Order results by a specific field. Valid options include [id, updated_at]. Default: id.' name: order_by in: query - schema: minimum: 1 type: integer description: Number of results to return per page. Number between 1 and 1000. maximum: 1000 title: Page size required: false name: page_size in: query - schema: type: string description: Filter the list for the patient's first name. title: first_name required: false description: '' name: first_name in: query - schema: type: string description: Filter the list for the patient's last name. title: last_name required: false description: '' name: last_name in: query - schema: type: string description: Filter the list for the patient's preferred language. title: preferred_language required: false description: '' name: preferred_language in: query - schema: type: string description: '' title: gender required: false description: Filter the list for the patient's gender. name: gender in: query - schema: type: string description: '' title: since required: false description: 'Filter the list for when the patient was created or updated. The value should be a date in the format YYYY-MM-DD. For example, to filter for patients created or updated on or after 2019-01-01, use the value 2019-01-01. ' name: since in: query - schema: type: string description: '' title: date_of_birth required: false description: 'Filter the list for the patient''s date of birth. The value should be a date in the format YYYY-MM-DD. For example, to filter for patients born on 2019-01-01, use the value 2019-01-01. ' name: date_of_birth in: query - schema: type: string description: '' title: race required: false description: Filter the list for the patients' race. name: race in: query - schema: type: string description: '' title: chart_id required: false description: Filter the list for the patients' chart id. name: chart_id in: query - schema: type: string description: '' title: email required: false description: Filter the list for the patients' email. name: email in: query - schema: type: string description: '' title: ethnicity required: false description: Filter the list for the patients' ethnicity. name: ethnicity in: query - schema: type: boolean description: '' title: ethnicity required: false description: when `true` include additional verbose fields in the response. name: verbose in: query tags: - Clinical x-permissions: - manage-patients x-practice-access: '"share_patients" need to be set for data access among practice' security: - drchrono_oauth2: - patients:read operationId: patients_list_create description: 'Submit patient list request. Use the UUID returned in the response to retrieve the batch of patients. ' get: responses: '200': content: application/json: schema: properties: status: type: string description: Status of the request. Possible values are "In progress" or "Complete". title: status results: items: $ref: '#/components/schemas/Patient' type: array description: result data. only presented when the status is "Complete" title: data uuid: type: string description: UUID of the batch request. title: uuid type: object description: Paginated Result title: '' description: OK '404': content: {} description: Not Found. The UUID is not found, or, it has expired. UUIDs have a 1 hour lifetime. '403': content: {} description: Permission Denied '401': content: {} description: Unauthorized '400': content: {} description: Bad Request. '500': content: application/json: schema: $ref: '#/components/schemas/AsyncResourceError' description: Internal Server Error parameters: - schema: type: string description: '' title: uuid description: 'The UUID token for submitted batch request. This is returned in the response of the create request. ' required: true name: uuid in: query tags: - Clinical x-permissions: - manage-patients x-practice-access: '"share_patients" need to be set for data access among practice' x-verbose-required: - auto_accident_insurance - custom_demographics - patient_flags - patient_flags_attached - primary_insurance - referring_doctor - secondary_insurance - tertiary_insurance - workers_comp_insurance security: - drchrono_oauth2: - patients:read operationId: patients_list_list description: 'Retrieve or search patients in batches. This resource returns identical data to `GET /api/patients` but uses an asynchronous batch-based approach to data delivery. This is an efficient choice for large historical record loading use cases. Retrieve the results/status of a previously created patient_list request using the UUID returned in the response. Results are ordered by patient ID number. ' /api/patient_interventions: post: responses: '201': content: application/json: schema: $ref: '#/components/schemas/PatientIntervention' description: Created '405': content: {} description: Method Not Allowed '404': content: {} description: Not Found '403': content: {} description: Permission Denied '401': content: {} description: Unauthorized '400': content: {} description: Bad Request '500': content: {} description: Internal Server Error parameters: - schema: type: integer description: '' title: patient required: false description: '' name: patient in: query - schema: type: integer description: '' title: doctor required: false description: '' name: doctor in: query tags: - Clinical x-permissions: - clinical-notes x-practice-access: '"share_patients" need to be set for data access among practice' security: - drchrono_oauth2: - clinical:read - clinical:write operationId: patient_interventions_create description: Create patient intervention for CQM get: responses: '200': content: application/json: schema: title: '' type: object description: Paginated Result properties: previous: type: string description: Previous paginated page title: previous data: items: $ref: '#/components/schemas/PatientIntervention' type: array description: result data title: data next: type: string description: Next Paginated page title: next description: OK '405': content: {} description: Method Not Allowed '404': content: {} description: Not Found '403': content: {} description: Permission Denied '401': content: {} description: Unauthorized '400': content: {} description: Bad Request '500': content: {} description: Internal Server Error parameters: - schema: type: string description: The pagination cursor value. title: Cursor required: false name: cursor in: query - schema: type: integer description: Number of results to return per page. title: Page size required: false name: page_size in: query - schema: type: integer description: '' title: patient required: false description: '' name: patient in: query - schema: type: integer description: '' title: doctor required: false description: '' name: doctor in: query tags: - Clinical x-permissions: - clinical-notes x-practice-access: '"share_patients" need to be set for data access among practice' security: - drchrono_oauth2: - clinical:read - clinical:write operationId: patient_interventions_list description: Retrieve or search patient interventions for CQM /api/patient_messages: post: responses: '201': content: application/json: schema: $ref: '#/components/schemas/PatientMessage' description: Created '405': content: {} description: Method Not Allowed '404': content: {} description: Not Found '403': content: {} description: Permission Denied '401': content: {} description: Unauthorized '400': content: {} description: Bad Request '500': content: {} description: Internal Server Error parameters: - schema: type: string description: '' title: since required: false description: '' name: since in: query - schema: type: integer description: '' title: patient required: false description: '' name: patient in: query - schema: type: integer description: '' title: doctor required: false description: '' name: doctor in: query tags: - Clinical x-permissions: - manage-patients - message-center x-practice-access: '"share_communications" need to be set for data access among practice' security: - drchrono_oauth2: - patients:read - patients:write - messages:read - messages:write operationId: patient_messages_create get: responses: '200': content: application/json: schema: title: '' type: object description: Paginated Result properties: previous: type: string description: Previous paginated page title: previous data: items: $ref: '#/components/schemas/PatientMessage' type: array description: result data title: data next: type: string description: Next Paginated page title: next description: OK '405': content: {} description: Method Not Allowed '404': content: {} description: Not Found '403': content: {} description: Permission Denied '401': content: {} description: Unauthorized '400': content: {} description: Bad Request '500': content: {} description: Internal Server Error parameters: - schema: type: string description: The pagination cursor value. title: Cursor required: false name: cursor in: query - schema: type: integer description: Number of results to return per page. title: Page size required: false name: page_size in: query - schema: type: string description: '' title: since required: false description: '' name: since in: query - schema: type: integer description: '' title: patient required: false description: '' name: patient in: query - schema: type: integer description: '' title: doctor required: false description: '' name: doctor in: query tags: - Clinical x-permissions: - manage-patients - message-center x-practice-access: '"share_communications" need to be set for data access among practice' security: - drchrono_oauth2: - patients:read - patients:write - messages:read - messages:write operationId: patient_messages_list /api/patient_physical_exams/{id}: put: responses: '204': content: {} description: No Content '405': content: {} description: Method Not Allowed '404': content: {} description: Not Found '403': content: {} description: Permission Denied '401': content: {} description: Unauthorized '400': content: {} description: Bad Request '500': content: {} description: Internal Server Error parameters: - schema: type: string description: '' title: '' required: true name: id in: path - schema: type: integer description: '' title: patient required: false description: '' name: patient in: query - schema: type: integer description: '' title: doctor required: false description: '' name: doctor in: query tags: - Clinical x-permissions: - clinical-notes x-practice-access: '"share_patients" need to be set for data access among practice' security: - drchrono_oauth2: - clinical:read - clinical:write operationId: patient_physical_exams_update description: Update an existing patient physical exam for CQM patch: responses: '204': content: {} description: No Content '405': content: {} description: Method Not Allowed '404': content: {} description: Not Found '403': content: {} description: Permission Denied '401': content: {} description: Unauthorized '400': content: {} description: Bad Request '500': content: {} description: Internal Server Error parameters: - schema: type: string description: '' title: '' required: true name: id in: path - schema: type: integer description: '' title: patient required: false description: '' name: patient in: query - schema: type: integer description: '' title: doctor required: false description: '' name: doctor in: query tags: - Clinical x-permissions: - clinical-notes x-practice-access: '"share_patients" need to be set for data access among practice' security: - drchrono_oauth2: - clinical:read - clinical:write operationId: patient_physical_exams_partial_update description: Update an existing patient physical exam for CQM get: responses: '200': content: application/json: schema: $ref: '#/components/schemas/PatientPhysicalExam' description: OK '405': content: {} description: Method Not Allowed '404': content: {} description: Not Found '403': content: {} description: Permission Denied '401': content: {} description: Unauthorized '400': content: {} description: Bad Request '500': content: {} description: Internal Server Error parameters: - schema: type: string description: '' title: '' required: true name: id in: path - schema: type: integer description: '' title: patient required: false description: '' name: patient in: query - schema: type: integer description: '' title: doctor required: false description: '' name: doctor in: query tags: - Clinical x-permissions: - clinical-notes x-practice-access: '"share_patients" need to be set for data access among practice' security: - drchrono_oauth2: - clinical:read - clinical:write operationId: patient_physical_exams_read description: Retrieve an existing patient physical exam for CQM /api/clinical_note_field_values: post: responses: '201': content: application/json: schema: $ref: '#/components/schemas/SoapNoteLineItemFieldValue' description: Created '405': content: {} description: Method Not Allowed '404': content: {} description: Not Found '403': content: {} description: Permission Denied '401': content: {} description: Unauthorized '400': content: {} description: Bad Request '500': content: {} description: Internal Server Error parameters: - schema: type: integer description: '' title: clinical_note_field required: false description: '' name: clinical_note_field in: query - schema: type: string description: '' title: since required: false description: '' name: since in: query - schema: type: integer description: '' title: appointment required: false description: '' name: appointment in: query - schema: type: integer description: '' title: clinical_note_template required: false description: '' name: clinical_note_template in: query - schema: type: integer description: '' title: doctor required: false description: '' name: doctor in: query tags: - Clinical x-permissions: - clinical-notes x-practice-access: '"share_patients" need to be set for data access among practice' security: - drchrono_oauth2: - clinical:read - clinical:write operationId: clinical_note_field_values_create description: Create clinical note field value get: responses: '200': content: application/json: schema: title: '' type: object description: Paginated Result properties: previous: type: string description: Previous paginated page title: previous data: items: $ref: '#/components/schemas/SoapNoteLineItemFieldValue' type: array description: result data title: data next: type: string description: Next Paginated page title: next description: OK '405': content: {} description: Method Not Allowed '404': content: {} description: Not Found '403': content: {} description: Permission Denied '401': content: {} description: Unauthorized '400': content: {} description: Bad Request '500': content: {} description: Internal Server Error parameters: - schema: type: string description: The pagination cursor value. title: Cursor required: false name: cursor in: query - schema: type: integer description: Number of results to return per page. title: Page size required: false name: page_size in: query - schema: type: integer description: '' title: clinical_note_field required: false description: '' name: clinical_note_field in: query - schema: type: string description: '' title: since required: false description: '' name: since in: query - schema: type: integer description: '' title: appointment required: false description: '' name: appointment in: query - schema: type: integer description: '' title: clinical_note_template required: false description: '' name: clinical_note_template in: query - schema: type: integer description: '' title: doctor required: false description: '' name: doctor in: query tags: - Clinical x-permissions: - clinical-notes x-practice-access: '"share_patients" need to be set for data access among practice' security: - drchrono_oauth2: - clinical:read - clinical:write operationId: clinical_note_field_values_list description: Retrieve or search clinical note field values /api/patients: post: responses: '201': content: application/json: schema: $ref: '#/components/schemas/Patient' description: Created '405': content: {} description: Method Not Allowed '404': content: {} description: Not Found '403': content: {} description: Permission Denied '401': content: {} description: Unauthorized '400': content: {} description: Bad Request '500': content: {} description: Internal Server Error parameters: - schema: type: string description: '' title: first_name required: false description: '' name: first_name in: query - schema: type: string description: '' title: last_name required: false description: '' name: last_name in: query - schema: type: string description: '' title: preferred_language required: false description: '' name: preferred_language in: query - schema: type: integer description: '' title: doctor required: false description: '' name: doctor in: query - schema: type: string description: '' title: gender required: false description: '' name: gender in: query - schema: type: string description: '' title: since required: false description: '' name: since in: query - schema: type: string description: '' title: date_of_birth required: false description: '' name: date_of_birth in: query - schema: type: string description: '' title: race required: false description: '' name: race in: query - schema: type: string description: '' title: chart_id required: false description: '' name: chart_id in: query - schema: type: string description: '' title: email required: false description: '' name: email in: query - schema: type: string description: '' title: ethnicity required: false description: '' name: ethnicity in: query - schema: type: boolean description: Set to true to allow duplicate patient creation title: allow_duplicates required: false description: Override duplicate check name: allow_duplicates in: query tags: - Clinical x-permissions: - manage-patients x-practice-access: '"share_patients" need to be set for data access among practice' security: - drchrono_oauth2: - patients:read - patients:write operationId: patients_create description: Create patient get: responses: '200': content: application/json: schema: title: '' type: object description: Paginated Result properties: previous: type: string description: Previous paginated page title: previous data: items: $ref: '#/components/schemas/Patient' type: array description: result data title: data next: type: string description: Next Paginated page title: next description: OK '405': content: {} description: Method Not Allowed '404': content: {} description: Not Found '403': content: {} description: Permission Denied '401': content: {} description: Unauthorized '400': content: {} description: Bad Request '500': content: {} description: Internal Server Error parameters: - schema: type: string description: The pagination cursor value. title: Cursor required: false name: cursor in: query - schema: type: integer description: Number of results to return per page. title: Page size required: false name: page_size in: query - schema: type: string description: '' title: first_name required: false description: '' name: first_name in: query - schema: type: string description: created_at filter in format YYYY-MM-DD title: created_at required: false description: '' name: created_at in: query - schema: type: string description: '' title: last_name required: false description: '' name: last_name in: query - schema: type: string description: '' title: preferred_language required: false description: '' name: preferred_language in: query - schema: type: integer description: '' title: doctor required: false description: '' name: doctor in: query - schema: type: string description: '' title: gender required: false description: '' name: gender in: query - schema: type: string description: '' title: since required: false description: '' name: since in: query - schema: type: string description: '' title: date_of_birth required: false description: '' name: date_of_birth in: query - schema: type: string description: '' title: race required: false description: '' name: race in: query - schema: type: string description: '' title: chart_id required: false description: '' name: chart_id in: query - schema: type: string description: '' title: email required: false description: '' name: email in: query - schema: type: string description: '' title: ethnicity required: false description: '' name: ethnicity in: query tags: - Clinical x-permissions: - manage-patients x-practice-access: '"share_patients" need to be set for data access among practice' security: - drchrono_oauth2: - patients:read - patients:write operationId: patients_list description: Retrieve or search patients /api/implantable_devices/{id}: get: responses: '200': content: application/json: schema: $ref: '#/components/schemas/ImplantableDevice' description: OK '405': content: {} description: Method Not Allowed '404': content: {} description: Not Found '403': content: {} description: Permission Denied '401': content: {} description: Unauthorized '400': content: {} description: Bad Request '500': content: {} description: Internal Server Error parameters: - schema: type: string description: '' title: '' required: true name: id in: path - schema: type: string description: '' title: mu_date required: false description: '' name: mu_date in: query - schema: type: integer description: '' title: patient required: false description: '' name: patient in: query - schema: type: string description: '' title: mu_date_range required: false description: '' name: mu_date_range in: query - schema: type: integer description: '' title: doctor required: false description: '' name: doctor in: query tags: - Clinical x-permissions: - clinical-notes x-practice-access: '"share_patients" need to be set for data access among practice' security: - drchrono_oauth2: - clinical:read - clinical:write operationId: implantable_devices_read description: Retrieve an existing implantable device /api/patient_communications/{id}: put: responses: '204': content: {} description: No Content '405': content: {} description: Method Not Allowed '404': content: {} description: Not Found '403': content: {} description: Permission Denied '401': content: {} description: Unauthorized '400': content: {} description: Bad Request '500': content: {} description: Internal Server Error parameters: - schema: type: string description: '' title: '' required: true name: id in: path - schema: type: integer description: '' title: patient required: false description: '' name: patient in: query - schema: type: integer description: '' title: doctor required: false description: '' name: doctor in: query tags: - Clinical x-permissions: - clinical-notes x-practice-access: '"share_patients" need to be set for data access among practice' security: - drchrono_oauth2: - clinical:read - clinical:write operationId: patient_communications_update description: Update an existing patient communication for CQM patch: responses: '204': content: {} description: No Content '405': content: {} description: Method Not Allowed '404': content: {} description: Not Found '403': content: {} description: Permission Denied '401': content: {} description: Unauthorized '400': content: {} description: Bad Request '500': content: {} description: Internal Server Error parameters: - schema: type: string description: '' title: '' required: true name: id in: path - schema: type: integer description: '' title: patient required: false description: '' name: patient in: query - schema: type: integer description: '' title: doctor required: false description: '' name: doctor in: query tags: - Clinical x-permissions: - clinical-notes x-practice-access: '"share_patients" need to be set for data access among practice' security: - drchrono_oauth2: - clinical:read - clinical:write operationId: patient_communications_partial_update description: Update an existing patient communication for CQM get: responses: '200': content: application/json: schema: $ref: '#/components/schemas/PatientCommunication' description: OK '405': content: {} description: Method Not Allowed '404': content: {} description: Not Found '403': content: {} description: Permission Denied '401': content: {} description: Unauthorized '400': content: {} description: Bad Request '500': content: {} description: Internal Server Error parameters: - schema: type: string description: '' title: '' required: true name: id in: path - schema: type: integer description: '' title: patient required: false description: '' name: patient in: query - schema: type: integer description: '' title: doctor required: false description: '' name: doctor in: query tags: - Clinical x-permissions: - clinical-notes x-practice-access: '"share_patients" need to be set for data access among practice' security: - drchrono_oauth2: - clinical:read - clinical:write operationId: patient_communications_read description: Retrieve an existing patient communication for CQM /api/prescription_messages/{id}: get: responses: '200': content: application/json: schema: $ref: '#/components/schemas/PrescriptionMessage' description: OK '405': content: {} description: Method Not Allowed '404': content: {} description: Not Found '403': content: {} description: Permission Denied '401': content: {} description: Unauthorized '400': content: {} description: Bad Request '500': content: {} description: Internal Server Error parameters: - schema: type: string description: '' title: '' required: true name: id in: path - schema: type: integer description: '' title: parent_message required: false description: '' name: parent_message in: query - schema: type: string description: '' title: since required: false description: '' name: since in: query - schema: type: integer description: '' title: patient required: false description: '' name: patient in: query - schema: type: integer description: '' title: doctor required: false description: '' name: doctor in: query tags: - Clinical x-permissions: - clinical-notes x-practice-access: '"share_patients" need to be set for data access among practice' security: - drchrono_oauth2: - clinical:read - clinical:write operationId: prescription_messages_read description: Retrieve an existing prescription message /api/implantable_devices: get: responses: '200': content: application/json: schema: title: '' type: object description: Paginated Result properties: previous: type: string description: Previous paginated page title: previous data: items: $ref: '#/components/schemas/ImplantableDevice' type: array description: result data title: data next: type: string description: Next Paginated page title: next description: OK '405': content: {} description: Method Not Allowed '404': content: {} description: Not Found '403': content: {} description: Permission Denied '401': content: {} description: Unauthorized '400': content: {} description: Bad Request '500': content: {} description: Internal Server Error parameters: - schema: type: string description: The pagination cursor value. title: Cursor required: false name: cursor in: query - schema: type: integer description: Number of results to return per page. title: Page size required: false name: page_size in: query - schema: type: string description: '' title: mu_date required: false description: '' name: mu_date in: query - schema: type: integer description: '' title: patient required: false description: '' name: patient in: query - schema: type: string description: '' title: mu_date_range required: false description: '' name: mu_date_range in: query - schema: type: integer description: '' title: doctor required: false description: '' name: doctor in: query tags: - Clinical x-permissions: - clinical-notes x-practice-access: '"share_patients" need to be set for data access among practice' security: - drchrono_oauth2: - clinical:read - clinical:write operationId: implantable_devices_list description: Retrieve or search implantable devices /api/patient_risk_assessments: post: responses: '201': content: application/json: schema: $ref: '#/components/schemas/PatientRiskAssessment' description: Created '405': content: {} description: Method Not Allowed '404': content: {} description: Not Found '403': content: {} description: Permission Denied '401': content: {} description: Unauthorized '400': content: {} description: Bad Request '500': content: {} description: Internal Server Error parameters: - schema: type: integer description: '' title: patient required: false description: '' name: patient in: query - schema: type: integer description: '' title: doctor required: false description: '' name: doctor in: query tags: - Clinical x-permissions: - clinical-notes x-practice-access: '"share_patients" need to be set for data access among practice' security: - drchrono_oauth2: - clinical:read - clinical:write operationId: patient_risk_assessments_create get: responses: '200': content: application/json: schema: title: '' type: object description: Paginated Result properties: previous: type: string description: Previous paginated page title: previous data: items: $ref: '#/components/schemas/PatientRiskAssessment' type: array description: result data title: data next: type: string description: Next Paginated page title: next description: OK '405': content: {} description: Method Not Allowed '404': content: {} description: Not Found '403': content: {} description: Permission Denied '401': content: {} description: Unauthorized '400': content: {} description: Bad Request '500': content: {} description: Internal Server Error parameters: - schema: type: string description: The pagination cursor value. title: Cursor required: false name: cursor in: query - schema: type: integer description: Number of results to return per page. title: Page size required: false name: page_size in: query - schema: type: integer description: '' title: patient required: false description: '' name: patient in: query - schema: type: integer description: '' title: doctor required: false description: '' name: doctor in: query tags: - Clinical x-permissions: - clinical-notes x-practice-access: '"share_patients" need to be set for data access among practice' security: - drchrono_oauth2: - clinical:read - clinical:write operationId: patient_risk_assessments_list /api/patients_summary: post: responses: '201': content: application/json: schema: $ref: '#/components/schemas/Patient' description: Created '405': content: {} description: Method Not Allowed '404': content: {} description: Not Found '403': content: {} description: Permission Denied '401': content: {} description: Unauthorized '400': content: {} description: Bad Request '500': content: {} description: Internal Server Error parameters: - schema: type: string description: '' title: first_name required: false description: '' name: first_name in: query - schema: type: string description: '' title: last_name required: false description: '' name: last_name in: query - schema: type: integer description: '' title: doctor required: false description: '' name: doctor in: query - schema: type: string description: '' title: gender required: false description: '' name: gender in: query - schema: type: string description: '' title: since required: false description: '' name: since in: query - schema: type: string description: '' title: date_of_birth required: false description: '' name: date_of_birth in: query tags: - Clinical x-permissions: - manage-patients x-practice-access: '"share_patients" need to be set for data access among practice' security: - drchrono_oauth2: - patients:summary:read - patients:summary:write operationId: patients_summary_create get: responses: '200': content: application/json: schema: title: '' type: object description: Paginated Result properties: previous: type: string description: Previous paginated page title: previous data: items: $ref: '#/components/schemas/Patient' type: array description: result data title: data next: type: string description: Next Paginated page title: next description: OK '405': content: {} description: Method Not Allowed '404': content: {} description: Not Found '403': content: {} description: Permission Denied '401': content: {} description: Unauthorized '400': content: {} description: Bad Request '500': content: {} description: Internal Server Error parameters: - schema: type: string description: The pagination cursor value. title: Cursor required: false name: cursor in: query - schema: type: integer description: Number of results to return per page. title: Page size required: false name: page_size in: query - schema: type: string description: '' title: first_name required: false description: '' name: first_name in: query - schema: type: string description: '' title: last_name required: false description: '' name: last_name in: query - schema: type: integer description: '' title: doctor required: false description: '' name: doctor in: query - schema: type: string description: '' title: gender required: false description: '' name: gender in: query - schema: type: string description: '' title: since required: false description: '' name: since in: query - schema: type: string description: '' title: date_of_birth required: false description: '' name: date_of_birth in: query tags: - Clinical x-permissions: - manage-patients x-practice-access: '"share_patients" need to be set for data access among practice' security: - drchrono_oauth2: - patients:summary:read - patients:summary:write operationId: patients_summary_list /api/documents/{id}: put: responses: '204': content: {} description: No Content '405': content: {} description: Method Not Allowed '404': content: {} description: Not Found '403': content: {} description: Permission Denied '401': content: {} description: Unauthorized '400': content: {} description: Bad Request '500': content: {} description: Internal Server Error parameters: - schema: type: string description: '' title: '' required: true name: id in: path - schema: type: string description: '' title: since required: false description: '' name: since in: query - schema: type: integer description: '' title: patient required: false description: '' name: patient in: query - schema: type: integer description: '' title: doctor required: false description: '' name: doctor in: query tags: - Clinical x-permissions: - manage-patients x-practice-access: '"share_patients" need to be set for data access among practice' security: - drchrono_oauth2: - patients:read - patients:write operationId: documents_update description: Update an existing patient document patch: responses: '204': content: {} description: No Content '405': content: {} description: Method Not Allowed '404': content: {} description: Not Found '403': content: {} description: Permission Denied '401': content: {} description: Unauthorized '400': content: {} description: Bad Request '500': content: {} description: Internal Server Error parameters: - schema: type: string description: '' title: '' required: true name: id in: path - schema: type: string description: '' title: since required: false description: '' name: since in: query - schema: type: integer description: '' title: patient required: false description: '' name: patient in: query - schema: type: integer description: '' title: doctor required: false description: '' name: doctor in: query tags: - Clinical x-permissions: - manage-patients x-practice-access: '"share_patients" need to be set for data access among practice' security: - drchrono_oauth2: - patients:read - patients:write operationId: documents_partial_update description: Update an existing patient document get: responses: '200': content: application/json: schema: $ref: '#/components/schemas/ScannedClinicalDocument' description: OK '405': content: {} description: Method Not Allowed '404': content: {} description: Not Found '403': content: {} description: Permission Denied '401': content: {} description: Unauthorized '400': content: {} description: Bad Request '500': content: {} description: Internal Server Error parameters: - schema: type: string description: '' title: '' required: true name: id in: path - schema: type: string description: '' title: since required: false description: '' name: since in: query - schema: type: integer description: '' title: patient required: false description: '' name: patient in: query - schema: type: integer description: '' title: doctor required: false description: '' name: doctor in: query tags: - Clinical x-permissions: - manage-patients x-practice-access: '"share_patients" need to be set for data access among practice' security: - drchrono_oauth2: - patients:read - patients:write operationId: documents_read description: Retrieve an existing patient document delete: responses: '204': content: {} description: No Content '405': content: {} description: Method Not Allowed '404': content: {} description: Not Found '403': content: {} description: Permission Denied '401': content: {} description: Unauthorized '400': content: {} description: Bad Request '500': content: {} description: Internal Server Error parameters: - schema: type: string description: '' title: '' required: true name: id in: path - schema: type: string description: '' title: since required: false description: '' name: since in: query - schema: type: integer description: '' title: patient required: false description: '' name: patient in: query - schema: type: integer description: '' title: doctor required: false description: '' name: doctor in: query tags: - Clinical x-permissions: - manage-patients x-practice-access: '"share_patients" need to be set for data access among practice' security: - drchrono_oauth2: - patients:read - patients:write operationId: documents_delete description: Delete an existing appointment template /api/patients/{id}/onpatient_access: post: responses: '201': content: application/json: schema: $ref: '#/components/schemas/Patient' description: Created '405': content: {} description: Method Not Allowed '404': content: {} description: Not Found '403': content: {} description: Permission Denied '401': content: {} description: Unauthorized '400': content: {} description: Bad Request '500': content: {} description: Internal Server Error parameters: - schema: type: string description: '' title: '' required: true name: id in: path - schema: type: string description: '' title: first_name required: false description: '' name: first_name in: query - schema: type: string description: '' title: last_name required: false description: '' name: last_name in: query - schema: type: string description: '' title: preferred_language required: false description: '' name: preferred_language in: query - schema: type: integer description: '' title: doctor required: false description: '' name: doctor in: query - schema: type: string description: '' title: gender required: false description: '' name: gender in: query - schema: type: string description: '' title: since required: false description: '' name: since in: query - schema: type: string description: '' title: date_of_birth required: false description: '' name: date_of_birth in: query - schema: type: string description: '' title: race required: false description: '' name: race in: query - schema: type: string description: '' title: chart_id required: false description: '' name: chart_id in: query - schema: type: string description: '' title: email required: false description: '' name: email in: query - schema: type: string description: '' title: ethnicity required: false description: '' name: ethnicity in: query tags: - Clinical x-permissions: - manage-patients x-practice-access: '"share_patients" need to be set for data access among practice' security: - drchrono_oauth2: - patients:read - patients:write operationId: patients_onpatient_access_create description: Send new onpatient invite to patient get: responses: '200': content: application/json: schema: $ref: '#/components/schemas/Patient' description: OK '405': content: {} description: Method Not Allowed '404': content: {} description: Not Found '403': content: {} description: Permission Denied '401': content: {} description: Unauthorized '400': content: {} description: Bad Request '500': content: {} description: Internal Server Error parameters: - schema: type: string description: '' title: '' required: true name: id in: path - schema: type: string description: '' title: first_name required: false description: '' name: first_name in: query - schema: type: string description: '' title: last_name required: false description: '' name: last_name in: query - schema: type: string description: '' title: preferred_language required: false description: '' name: preferred_language in: query - schema: type: integer description: '' title: doctor required: false description: '' name: doctor in: query - schema: type: string description: '' title: gender required: false description: '' name: gender in: query - schema: type: string description: '' title: since required: false description: '' name: since in: query - schema: type: string description: '' title: date_of_birth required: false description: '' name: date_of_birth in: query - schema: type: string description: '' title: race required: false description: '' name: race in: query - schema: type: string description: '' title: chart_id required: false description: '' name: chart_id in: query - schema: type: string description: '' title: email required: false description: '' name: email in: query - schema: type: string description: '' title: ethnicity required: false description: '' name: ethnicity in: query tags: - Clinical x-permissions: - manage-patients x-practice-access: '"share_patients" need to be set for data access among practice' security: - drchrono_oauth2: - patients:read - patients:write operationId: patients_onpatient_access_read description: Retrieve or search existing onpatient access invites delete: responses: '204': content: {} description: No Content '405': content: {} description: Method Not Allowed '404': content: {} description: Not Found '403': content: {} description: Permission Denied '401': content: {} description: Unauthorized '400': content: {} description: Bad Request '500': content: {} description: Internal Server Error parameters: - schema: type: string description: '' title: '' required: true name: id in: path - schema: type: string description: '' title: first_name required: false description: '' name: first_name in: query - schema: type: string description: '' title: last_name required: false description: '' name: last_name in: query - schema: type: string description: '' title: preferred_language required: false description: '' name: preferred_language in: query - schema: type: integer description: '' title: doctor required: false description: '' name: doctor in: query - schema: type: string description: '' title: gender required: false description: '' name: gender in: query - schema: type: string description: '' title: since required: false description: '' name: since in: query - schema: type: string description: '' title: date_of_birth required: false description: '' name: date_of_birth in: query - schema: type: string description: '' title: race required: false description: '' name: race in: query - schema: type: string description: '' title: chart_id required: false description: '' name: chart_id in: query - schema: type: string description: '' title: email required: false description: '' name: email in: query - schema: type: string description: '' title: ethnicity required: false description: '' name: ethnicity in: query tags: - Clinical x-permissions: - manage-patients x-practice-access: '"share_patients" need to be set for data access among practice' security: - drchrono_oauth2: - patients:read - patients:write operationId: patients_onpatient_access_delete description: Revoke sent onpatient invites /api/lab_results/{id}: put: responses: '204': content: {} description: No Content '405': content: {} description: Method Not Allowed '404': content: {} description: Not Found '403': content: {} description: Permission Denied '401': content: {} description: Unauthorized '400': content: {} description: Bad Request '500': content: {} description: Internal Server Error parameters: - schema: type: string description: '' title: '' required: true name: id in: path - schema: type: integer description: '' title: order required: false description: '' name: order in: query - schema: type: integer description: '' title: doctor required: false description: '' name: doctor in: query tags: - Clinical x-permissions: [] x-practice-access: '"share_patients" need to be set for data access among practice' security: - drchrono_oauth2: - labs:read - labs:write operationId: lab_results_update description: Update an existing lab result patch: responses: '204': content: {} description: No Content '405': content: {} description: Method Not Allowed '404': content: {} description: Not Found '403': content: {} description: Permission Denied '401': content: {} description: Unauthorized '400': content: {} description: Bad Request '500': content: {} description: Internal Server Error parameters: - schema: type: string description: '' title: '' required: true name: id in: path - schema: type: integer description: '' title: order required: false description: '' name: order in: query - schema: type: integer description: '' title: doctor required: false description: '' name: doctor in: query tags: - Clinical x-permissions: [] x-practice-access: '"share_patients" need to be set for data access among practice' security: - drchrono_oauth2: - labs:read - labs:write operationId: lab_results_partial_update description: Update an existing lab result get: responses: '200': content: application/json: schema: $ref: '#/components/schemas/LabResult' description: OK '405': content: {} description: Method Not Allowed '404': content: {} description: Not Found '403': content: {} description: Permission Denied '401': content: {} description: Unauthorized '400': content: {} description: Bad Request '500': content: {} description: Internal Server Error parameters: - schema: type: string description: '' title: '' required: true name: id in: path - schema: type: integer description: '' title: order required: false description: '' name: order in: query - schema: type: integer description: '' title: doctor required: false description: '' name: doctor in: query tags: - Clinical x-permissions: [] x-practice-access: '"share_patients" need to be set for data access among practice' security: - drchrono_oauth2: - labs:read - labs:write operationId: lab_results_read description: Retrieve an existing lab result delete: responses: '204': content: {} description: No Content '405': content: {} description: Method Not Allowed '404': content: {} description: Not Found '403': content: {} description: Permission Denied '401': content: {} description: Unauthorized '400': content: {} description: Bad Request '500': content: {} description: Internal Server Error parameters: - schema: type: string description: '' title: '' required: true name: id in: path - schema: type: integer description: '' title: order required: false description: '' name: order in: query - schema: type: integer description: '' title: doctor required: false description: '' name: doctor in: query tags: - Clinical x-permissions: [] x-practice-access: '"share_patients" need to be set for data access among practice' security: - drchrono_oauth2: - labs:read - labs:write operationId: lab_results_delete description: Delete an existing lab result /api/medications/{id}: put: responses: '204': content: {} description: No Content '405': content: {} description: Method Not Allowed '404': content: {} description: Not Found '403': content: {} description: Permission Denied '401': content: {} description: Unauthorized '400': content: {} description: Bad Request '500': content: {} description: Internal Server Error parameters: - schema: type: string description: '' title: '' required: true name: id in: path - schema: type: integer description: '' title: patient required: false description: '' name: patient in: query - schema: type: integer description: '' title: doctor required: false description: '' name: doctor in: query tags: - Clinical x-permissions: - clinical-notes x-practice-access: '"share_patients" need to be set for data access among practice' security: - drchrono_oauth2: - clinical:read - clinical:write operationId: medications_update description: Update an existing patient medications patch: responses: '204': content: {} description: No Content '405': content: {} description: Method Not Allowed '404': content: {} description: Not Found '403': content: {} description: Permission Denied '401': content: {} description: Unauthorized '400': content: {} description: Bad Request '500': content: {} description: Internal Server Error parameters: - schema: type: string description: '' title: '' required: true name: id in: path - schema: type: integer description: '' title: patient required: false description: '' name: patient in: query - schema: type: integer description: '' title: doctor required: false description: '' name: doctor in: query tags: - Clinical x-permissions: - clinical-notes x-practice-access: '"share_patients" need to be set for data access among practice' security: - drchrono_oauth2: - clinical:read - clinical:write operationId: medications_partial_update description: Update an existing patient medications get: responses: '200': content: application/json: schema: $ref: '#/components/schemas/PatientDrug' description: OK '405': content: {} description: Method Not Allowed '404': content: {} description: Not Found '403': content: {} description: Permission Denied '401': content: {} description: Unauthorized '400': content: {} description: Bad Request '500': content: {} description: Internal Server Error parameters: - schema: type: string description: '' title: '' required: true name: id in: path - schema: type: integer description: '' title: patient required: false description: '' name: patient in: query - schema: type: integer description: '' title: doctor required: false description: '' name: doctor in: query tags: - Clinical x-permissions: - clinical-notes x-practice-access: '"share_patients" need to be set for data access among practice' security: - drchrono_oauth2: - clinical:read - clinical:write operationId: medications_read description: Retrieve an existing patient medications /api/medications/{id}/append_to_pharmacy_note: patch: responses: '204': content: {} description: No Content '405': content: {} description: Method Not Allowed '404': content: {} description: Not Found '403': content: {} description: Permission Denied '401': content: {} description: Unauthorized '400': content: {} description: Bad Request '500': content: {} description: Internal Server Error parameters: - schema: type: string description: '' title: '' required: true name: id in: path - schema: type: integer description: '' title: patient required: false description: '' name: patient in: query - schema: type: integer description: '' title: doctor required: false description: '' name: doctor in: query tags: - Clinical x-permissions: - clinical-notes x-practice-access: '"share_patients" need to be set for data access among practice' security: - drchrono_oauth2: - clinical:read - clinical:write operationId: medications_append_to_pharmacy_note description: Append a message to the "pharmacy_note" section of the prescription, in a new paragraph /api/patient_vaccine_records/{id}: put: responses: '204': content: {} description: No Content '405': content: {} description: Method Not Allowed '404': content: {} description: Not Found '403': content: {} description: Permission Denied '401': content: {} description: Unauthorized '400': content: {} description: Bad Request '500': content: {} description: Internal Server Error parameters: - schema: type: string description: '' title: '' required: true name: id in: path - schema: type: string description: '' title: cvx_code required: false description: '' name: cvx_code in: query - schema: type: integer description: '' title: patient required: false description: '' name: patient in: query - schema: type: string description: '' title: since required: false description: '' name: since in: query - schema: type: integer description: '' title: doctor required: false description: '' name: doctor in: query tags: - Clinical x-permissions: - clinical-notes x-practice-access: '"share_inventory", "share_patients" need to be set for data access among practice' security: - drchrono_oauth2: - clinical:read - clinical:write operationId: patient_vaccine_records_update description: Update an existing patient vaccine records patch: responses: '204': content: {} description: No Content '405': content: {} description: Method Not Allowed '404': content: {} description: Not Found '403': content: {} description: Permission Denied '401': content: {} description: Unauthorized '400': content: {} description: Bad Request '500': content: {} description: Internal Server Error parameters: - schema: type: string description: '' title: '' required: true name: id in: path - schema: type: string description: '' title: cvx_code required: false description: '' name: cvx_code in: query - schema: type: integer description: '' title: patient required: false description: '' name: patient in: query - schema: type: string description: '' title: since required: false description: '' name: since in: query - schema: type: integer description: '' title: doctor required: false description: '' name: doctor in: query tags: - Clinical x-permissions: - clinical-notes x-practice-access: '"share_inventory", "share_patients" need to be set for data access among practice' security: - drchrono_oauth2: - clinical:read - clinical:write operationId: patient_vaccine_records_partial_update description: Update an existing patient vaccine records get: responses: '200': content: application/json: schema: $ref: '#/components/schemas/PatientVaccineRecord' description: OK '405': content: {} description: Method Not Allowed '404': content: {} description: Not Found '403': content: {} description: Permission Denied '401': content: {} description: Unauthorized '400': content: {} description: Bad Request '500': content: {} description: Internal Server Error parameters: - schema: type: string description: '' title: '' required: true name: id in: path - schema: type: string description: '' title: cvx_code required: false description: '' name: cvx_code in: query - schema: type: integer description: '' title: patient required: false description: '' name: patient in: query - schema: type: string description: '' title: since required: false description: '' name: since in: query - schema: type: integer description: '' title: doctor required: false description: '' name: doctor in: query tags: - Clinical x-permissions: - clinical-notes x-practice-access: '"share_inventory", "share_patients" need to be set for data access among practice' security: - drchrono_oauth2: - clinical:read - clinical:write operationId: patient_vaccine_records_read description: Retrieve an existing patient vaccine records /api/patient_flag_types/{id}: put: responses: '204': content: {} description: No Content '405': content: {} description: Method Not Allowed '404': content: {} description: Not Found '403': content: {} description: Permission Denied '401': content: {} description: Unauthorized '400': content: {} description: Bad Request '500': content: {} description: Internal Server Error parameters: - schema: type: string description: '' title: '' required: true name: id in: path - schema: type: integer description: '' title: doctor required: false description: '' name: doctor in: query tags: - Clinical x-permissions: - manage-patients - settings x-practice-access: '"share_patients" need to be set for data access among practice' security: - drchrono_oauth2: - patients:read - patients:write - settings:read - settings:write operationId: patient_flag_types_update description: Update an existing patient flag type patch: responses: '204': content: {} description: No Content '405': content: {} description: Method Not Allowed '404': content: {} description: Not Found '403': content: {} description: Permission Denied '401': content: {} description: Unauthorized '400': content: {} description: Bad Request '500': content: {} description: Internal Server Error parameters: - schema: type: string description: '' title: '' required: true name: id in: path - schema: type: integer description: '' title: doctor required: false description: '' name: doctor in: query tags: - Clinical x-permissions: - manage-patients - settings x-practice-access: '"share_patients" need to be set for data access among practice' security: - drchrono_oauth2: - patients:read - patients:write - settings:read - settings:write operationId: patient_flag_types_partial_update description: Update an existing patient flag type get: responses: '200': content: application/json: schema: $ref: '#/components/schemas/PatientFlagType' description: OK '405': content: {} description: Method Not Allowed '404': content: {} description: Not Found '403': content: {} description: Permission Denied '401': content: {} description: Unauthorized '400': content: {} description: Bad Request '500': content: {} description: Internal Server Error parameters: - schema: type: string description: '' title: '' required: true name: id in: path - schema: type: integer description: '' title: doctor required: false description: '' name: doctor in: query tags: - Clinical x-permissions: - manage-patients - settings x-practice-access: '"share_patients" need to be set for data access among practice' security: - drchrono_oauth2: - patients:read - patients:write - settings:read - settings:write operationId: patient_flag_types_read description: Retrieve an existing patient flag type /api/clinical_note_field_types/{id}: patch: responses: '204': content: {} description: No Content '405': content: {} description: Method Not Allowed '404': content: {} description: Not Found '403': content: {} description: Permission Denied '401': content: {} description: Unauthorized '400': content: {} description: Bad Request '500': content: {} description: Internal Server Error parameters: - schema: type: string required: true name: id in: path tags: - Clinical x-permissions: - clinical-notes requestBody: content: application/json: schema: type: object properties: freedraw_image_size: enum: - '' - 150x300 - 300x600 - 450x900 - 600x1200 - 750x1500 type: string description: "Size setting for the free-draw image field:\n - \"\" = Actual size (native resolution)\n - \"150x300\" = Extra Small\n - \"300x600\" = Small\n - \"450x900\" = Medium\n - \"600x1200\" = Large\n - \"750x1500\" = Extra Large\n" required: true x-practice-access: '"share_clinical_templates" need to be set for data access among practice' security: - drchrono_oauth2: - clinical:read - clinical:write operationId: clinical_note_field_types_update description: Update the `freedraw_image_size` of an existing clinical note FreeDraw Field get: responses: '200': content: application/json: schema: $ref: '#/components/schemas/SoapNoteLineItemFieldType' description: OK '405': content: {} description: Method Not Allowed '404': content: {} description: Not Found '403': content: {} description: Permission Denied '401': content: {} description: Unauthorized '400': content: {} description: Bad Request '500': content: {} description: Internal Server Error parameters: - schema: type: string description: '' title: '' required: true name: id in: path - schema: type: integer description: '' title: clinical_note_template required: false description: '' name: clinical_note_template in: query - schema: type: integer description: '' title: doctor required: false description: '' name: doctor in: query tags: - Clinical x-permissions: - clinical-notes x-practice-access: '"share_clinical_templates" need to be set for data access among practice' security: - drchrono_oauth2: - clinical:read - clinical:write operationId: clinical_note_field_types_read description: Retrieve an existing clinial note field type /api/fee_schedules: get: responses: '200': content: application/json: schema: title: '' type: object description: Paginated Result properties: previous: type: string description: Previous paginated page title: previous data: items: $ref: '#/components/schemas/DoctorFeeSchedule' type: array description: result data title: data next: type: string description: Next Paginated page title: next description: OK '405': content: {} description: Method Not Allowed '404': content: {} description: Not Found '403': content: {} description: Permission Denied '401': content: {} description: Unauthorized '400': content: {} description: Bad Request '500': content: {} description: Internal Server Error parameters: - schema: type: string description: The pagination cursor value. title: Cursor required: false name: cursor in: query - schema: type: integer description: Number of results to return per page. title: Page size required: false name: page_size in: query - schema: type: string description: '' title: code required: false description: '' name: code in: query - schema: type: string description: '' title: code_type required: false description: '' name: code_type in: query - schema: type: string description: '' title: since required: false description: '' name: since in: query - schema: type: string description: '' title: payer_id required: false description: '' name: payer_id in: query - schema: type: integer description: '' title: doctor required: false description: '' name: doctor in: query tags: - Clinical x-permissions: - billing - show-billing-tab x-practice-access: '"share_fee_schedules" need to be set for data access among practice' security: - drchrono_oauth2: - billing:read - billing:write operationId: fee_schedules_list /api/patient_risk_assessments/{id}: put: responses: '204': content: {} description: No Content '405': content: {} description: Method Not Allowed '404': content: {} description: Not Found '403': content: {} description: Permission Denied '401': content: {} description: Unauthorized '400': content: {} description: Bad Request '500': content: {} description: Internal Server Error parameters: - schema: type: string description: '' title: '' required: true name: id in: path - schema: type: integer description: '' title: patient required: false description: '' name: patient in: query - schema: type: integer description: '' title: doctor required: false description: '' name: doctor in: query tags: - Clinical x-permissions: - clinical-notes x-practice-access: '"share_patients" need to be set for data access among practice' security: - drchrono_oauth2: - clinical:read - clinical:write operationId: patient_risk_assessments_update patch: responses: '204': content: {} description: No Content '405': content: {} description: Method Not Allowed '404': content: {} description: Not Found '403': content: {} description: Permission Denied '401': content: {} description: Unauthorized '400': content: {} description: Bad Request '500': content: {} description: Internal Server Error parameters: - schema: type: string description: '' title: '' required: true name: id in: path - schema: type: integer description: '' title: patient required: false description: '' name: patient in: query - schema: type: integer description: '' title: doctor required: false description: '' name: doctor in: query tags: - Clinical x-permissions: - clinical-notes x-practice-access: '"share_patients" need to be set for data access among practice' security: - drchrono_oauth2: - clinical:read - clinical:write operationId: patient_risk_assessments_partial_update get: responses: '200': content: application/json: schema: $ref: '#/components/schemas/PatientRiskAssessment' description: OK '405': content: {} description: Method Not Allowed '404': content: {} description: Not Found '403': content: {} description: Permission Denied '401': content: {} description: Unauthorized '400': content: {} description: Bad Request '500': content: {} description: Internal Server Error parameters: - schema: type: string description: '' title: '' required: true name: id in: path - schema: type: integer description: '' title: patient required: false description: '' name: patient in: query - schema: type: integer description: '' title: doctor required: false description: '' name: doctor in: query tags: - Clinical x-permissions: - clinical-notes x-practice-access: '"share_patients" need to be set for data access among practice' security: - drchrono_oauth2: - clinical:read - clinical:write operationId: patient_risk_assessments_read /api/lab_documents/{id}: put: responses: '204': content: {} description: No Content '405': content: {} description: Method Not Allowed '404': content: {} description: Not Found '403': content: {} description: Permission Denied '401': content: {} description: Unauthorized '400': content: {} description: Bad Request '500': content: {} description: Internal Server Error parameters: - schema: type: string description: '' title: '' required: true name: id in: path - schema: type: string description: '' title: since required: false description: '' name: since in: query - schema: type: integer description: '' title: doctor required: false description: '' name: doctor in: query tags: - Clinical x-permissions: [] x-practice-access: '"share_patients" need to be set for data access among practice' security: - drchrono_oauth2: - labs:read - labs:write operationId: lab_documents_update description: Update an existing lab order document patch: responses: '204': content: {} description: No Content '405': content: {} description: Method Not Allowed '404': content: {} description: Not Found '403': content: {} description: Permission Denied '401': content: {} description: Unauthorized '400': content: {} description: Bad Request '500': content: {} description: Internal Server Error parameters: - schema: type: string description: '' title: '' required: true name: id in: path - schema: type: string description: '' title: since required: false description: '' name: since in: query - schema: type: integer description: '' title: doctor required: false description: '' name: doctor in: query tags: - Clinical x-permissions: [] x-practice-access: '"share_patients" need to be set for data access among practice' security: - drchrono_oauth2: - labs:read - labs:write operationId: lab_documents_partial_update description: Update an existing lab order document get: responses: '200': content: application/json: schema: $ref: '#/components/schemas/LabOrderDocument' description: OK '405': content: {} description: Method Not Allowed '404': content: {} description: Not Found '403': content: {} description: Permission Denied '401': content: {} description: Unauthorized '400': content: {} description: Bad Request '500': content: {} description: Internal Server Error parameters: - schema: type: string description: '' title: '' required: true name: id in: path - schema: type: string description: '' title: since required: false description: '' name: since in: query - schema: type: integer description: '' title: doctor required: false description: '' name: doctor in: query tags: - Clinical x-permissions: [] x-practice-access: '"share_patients" need to be set for data access among practice' security: - drchrono_oauth2: - labs:read - labs:write operationId: lab_documents_read description: Retrieve an existing appointment template delete: responses: '204': content: {} description: No Content '405': content: {} description: Method Not Allowed '404': content: {} description: Not Found '403': content: {} description: Permission Denied '401': content: {} description: Unauthorized '400': content: {} description: Bad Request '500': content: {} description: Internal Server Error parameters: - schema: type: string description: '' title: '' required: true name: id in: path - schema: type: string description: '' title: since required: false description: '' name: since in: query - schema: type: integer description: '' title: doctor required: false description: '' name: doctor in: query tags: - Clinical x-permissions: [] x-practice-access: '"share_patients" need to be set for data access among practice' security: - drchrono_oauth2: - labs:read - labs:write operationId: lab_documents_delete description: Delete an existing lab order document /api/appointment_templates/{id}: put: responses: '204': content: {} description: No Content '405': content: {} description: Method Not Allowed '404': content: {} description: Not Found '403': content: {} description: Permission Denied '401': content: {} description: Unauthorized '400': content: {} description: Bad Request '500': content: {} description: Internal Server Error parameters: - schema: type: string description: '' title: '' required: true name: id in: path - schema: type: integer description: '' title: profile required: false description: '' name: profile in: query - schema: type: integer description: '' title: office required: false description: '' name: office in: query - schema: type: integer description: '' title: doctor required: false description: '' name: doctor in: query tags: - Clinical x-permissions: - scheduling - settings x-practice-access: '"share_appointment_profiles" need to be set for data access among practice' security: - drchrono_oauth2: - calendar:read - calendar:write - settings:read - settings:write operationId: appointment_templates_update description: Update an existing appointment template patch: responses: '204': content: {} description: No Content '405': content: {} description: Method Not Allowed '404': content: {} description: Not Found '403': content: {} description: Permission Denied '401': content: {} description: Unauthorized '400': content: {} description: Bad Request '500': content: {} description: Internal Server Error parameters: - schema: type: string description: '' title: '' required: true name: id in: path - schema: type: integer description: '' title: profile required: false description: '' name: profile in: query - schema: type: integer description: '' title: office required: false description: '' name: office in: query - schema: type: integer description: '' title: doctor required: false description: '' name: doctor in: query tags: - Clinical x-permissions: - scheduling - settings x-practice-access: '"share_appointment_profiles" need to be set for data access among practice' security: - drchrono_oauth2: - calendar:read - calendar:write - settings:read - settings:write operationId: appointment_templates_partial_update description: Update an existing appointment template get: responses: '200': content: application/json: schema: $ref: '#/components/schemas/AppointmentTemplate' description: OK '405': content: {} description: Method Not Allowed '404': content: {} description: Not Found '403': content: {} description: Permission Denied '401': content: {} description: Unauthorized '400': content: {} description: Bad Request '500': content: {} description: Internal Server Error parameters: - schema: type: string description: '' title: '' required: true name: id in: path - schema: type: integer description: '' title: profile required: false description: '' name: profile in: query - schema: type: integer description: '' title: office required: false description: '' name: office in: query - schema: type: integer description: '' title: doctor required: false description: '' name: doctor in: query tags: - Clinical x-permissions: - scheduling - settings x-practice-access: '"share_appointment_profiles" need to be set for data access among practice' security: - drchrono_oauth2: - calendar:read - calendar:write - settings:read - settings:write operationId: appointment_templates_read description: Retrieve an existing appointment template delete: responses: '204': content: {} description: No Content '405': content: {} description: Method Not Allowed '404': content: {} description: Not Found '403': content: {} description: Permission Denied '401': content: {} description: Unauthorized '400': content: {} description: Bad Request '500': content: {} description: Internal Server Error parameters: - schema: type: string description: '' title: '' required: true name: id in: path - schema: type: integer description: '' title: profile required: false description: '' name: profile in: query - schema: type: integer description: '' title: office required: false description: '' name: office in: query - schema: type: integer description: '' title: doctor required: false description: '' name: doctor in: query tags: - Clinical x-permissions: - scheduling - settings x-practice-access: '"share_appointment_profiles" need to be set for data access among practice' security: - drchrono_oauth2: - calendar:read - calendar:write - settings:read - settings:write operationId: appointment_templates_delete description: Delete an existing appointment template /api/patient_interventions/{id}: put: responses: '204': content: {} description: No Content '405': content: {} description: Method Not Allowed '404': content: {} description: Not Found '403': content: {} description: Permission Denied '401': content: {} description: Unauthorized '400': content: {} description: Bad Request '500': content: {} description: Internal Server Error parameters: - schema: type: string description: '' title: '' required: true name: id in: path - schema: type: integer description: '' title: patient required: false description: '' name: patient in: query - schema: type: integer description: '' title: doctor required: false description: '' name: doctor in: query tags: - Clinical x-permissions: - clinical-notes x-practice-access: '"share_patients" need to be set for data access among practice' security: - drchrono_oauth2: - clinical:read - clinical:write operationId: patient_interventions_update description: Update an existing patient intervention for CQM patch: responses: '204': content: {} description: No Content '405': content: {} description: Method Not Allowed '404': content: {} description: Not Found '403': content: {} description: Permission Denied '401': content: {} description: Unauthorized '400': content: {} description: Bad Request '500': content: {} description: Internal Server Error parameters: - schema: type: string description: '' title: '' required: true name: id in: path - schema: type: integer description: '' title: patient required: false description: '' name: patient in: query - schema: type: integer description: '' title: doctor required: false description: '' name: doctor in: query tags: - Clinical x-permissions: - clinical-notes x-practice-access: '"share_patients" need to be set for data access among practice' security: - drchrono_oauth2: - clinical:read - clinical:write operationId: patient_interventions_partial_update description: Update an existing patient intervention for CQM get: responses: '200': content: application/json: schema: $ref: '#/components/schemas/PatientIntervention' description: OK '405': content: {} description: Method Not Allowed '404': content: {} description: Not Found '403': content: {} description: Permission Denied '401': content: {} description: Unauthorized '400': content: {} description: Bad Request '500': content: {} description: Internal Server Error parameters: - schema: type: string description: '' title: '' required: true name: id in: path - schema: type: integer description: '' title: patient required: false description: '' name: patient in: query - schema: type: integer description: '' title: doctor required: false description: '' name: doctor in: query tags: - Clinical x-permissions: - clinical-notes x-practice-access: '"share_patients" need to be set for data access among practice' security: - drchrono_oauth2: - clinical:read - clinical:write operationId: patient_interventions_read description: Retrieve an existing patient intervention for CQM /api/allergies/{id}: put: responses: '204': content: {} description: No Content '405': content: {} description: Method Not Allowed '404': content: {} description: Not Found '403': content: {} description: Permission Denied '401': content: {} description: Unauthorized '400': content: {} description: Bad Request '500': content: {} description: Internal Server Error parameters: - schema: type: string description: '' title: '' required: true name: id in: path - schema: type: integer description: '' title: patient required: false description: '' name: patient in: query - schema: type: integer description: '' title: doctor required: false description: '' name: doctor in: query tags: - Clinical x-permissions: - clinical-notes x-practice-access: '"share_patients" need to be set for data access among practice' security: - drchrono_oauth2: - clinical:read - clinical:write operationId: allergies_update description: Update an existing patient allergy patch: responses: '204': content: {} description: No Content '405': content: {} description: Method Not Allowed '404': content: {} description: Not Found '403': content: {} description: Permission Denied '401': content: {} description: Unauthorized '400': content: {} description: Bad Request '500': content: {} description: Internal Server Error parameters: - schema: type: string description: '' title: '' required: true name: id in: path - schema: type: integer description: '' title: patient required: false description: '' name: patient in: query - schema: type: integer description: '' title: doctor required: false description: '' name: doctor in: query tags: - Clinical x-permissions: - clinical-notes x-practice-access: '"share_patients" need to be set for data access among practice' security: - drchrono_oauth2: - clinical:read - clinical:write operationId: allergies_partial_update description: Update an existing patient allergy get: responses: '200': content: application/json: schema: $ref: '#/components/schemas/PatientAllergy' description: OK '405': content: {} description: Method Not Allowed '404': content: {} description: Not Found '403': content: {} description: Permission Denied '401': content: {} description: Unauthorized '400': content: {} description: Bad Request '500': content: {} description: Internal Server Error parameters: - schema: type: string description: '' title: '' required: true name: id in: path - schema: type: integer description: '' title: patient required: false description: '' name: patient in: query - schema: type: integer description: '' title: doctor required: false description: '' name: doctor in: query tags: - Clinical x-permissions: - clinical-notes x-practice-access: '"share_patients" need to be set for data access among practice' security: - drchrono_oauth2: - clinical:read - clinical:write operationId: allergies_read description: Retrieve an existing patient allergy /api/patients/{id}/ccda: get: responses: '200': content: application/xml: schema: type: object description: '' title: '' description: OK '405': content: {} description: Method Not Allowed '404': content: {} description: Not Found '403': content: {} description: Permission Denied '401': content: {} description: Unauthorized '400': content: {} description: Bad Request '500': content: {} description: Internal Server Error parameters: - schema: type: string description: '' title: '' required: true name: id in: path - schema: type: string description: '' title: first_name required: false description: '' name: first_name in: query - schema: type: string description: '' title: last_name required: false description: '' name: last_name in: query - schema: type: string description: '' title: preferred_language required: false description: '' name: preferred_language in: query - schema: type: integer description: '' title: doctor required: false description: '' name: doctor in: query - schema: type: string description: '' title: gender required: false description: '' name: gender in: query - schema: type: string description: '' title: since required: false description: '' name: since in: query - schema: type: string description: '' title: date_of_birth required: false description: '' name: date_of_birth in: query - schema: type: string description: '' title: race required: false description: '' name: race in: query - schema: type: string description: '' title: chart_id required: false description: '' name: chart_id in: query - schema: type: string description: '' title: email required: false description: '' name: email in: query - schema: type: string description: '' title: ethnicity required: false description: '' name: ethnicity in: query tags: - Clinical x-permissions: - manage-patients x-practice-access: '"share_patients" need to be set for data access among practice' security: - drchrono_oauth2: - patients:read - patients:write operationId: patients_ccda description: Retrieve patient CCDA /api/lab_orders_summary: get: responses: '200': content: application/json: schema: title: '' type: object description: Paginated Result properties: previous: type: string description: Previous paginated page title: previous data: items: $ref: '#/components/schemas/LabOrder' type: array description: result data title: data next: type: string description: Next Paginated page title: next description: OK '405': content: {} description: Method Not Allowed '404': content: {} description: Not Found '403': content: {} description: Permission Denied '401': content: {} description: Unauthorized '400': content: {} description: Bad Request '500': content: {} description: Internal Server Error parameters: - schema: type: string description: The pagination cursor value. title: Cursor required: false name: cursor in: query - schema: type: integer description: Number of results to return per page. title: Page size required: false name: page_size in: query - schema: type: string description: '' title: since required: false description: '' name: since in: query - schema: type: integer description: '' title: patient required: false description: '' name: patient in: query - schema: type: integer description: '' title: doctor required: false description: '' name: doctor in: query tags: - Clinical x-permissions: - clinical-notes x-practice-access: '"share_patients" need to be set for data access among practice' security: - drchrono_oauth2: - clinical:read - clinical:write operationId: lab_orders_summary_list /api/clinical_note_field_values_list: get: responses: '200': content: application/json: schema: title: '' type: object description: Paginated Result properties: status: type: string description: 'Status of the request. Possible values are "Complete" or "In progress". ' title: status pagination: properties: count: type: int description: the count of all records in the result set. title: count pages: type: int description: the total pages of all pages in the result set. title: pages page: type: int description: the current page (starting with 1) in the total pages. title: page type: object description: information on the total pages, current page and total count. title: pagination results: items: $ref: '#/components/schemas/SoapNoteLineItemFieldValue' type: array description: result data. only presented when the status is "Complete" title: data uuid: type: string description: UUID of the batch of patients. title: uuid description: OK '404': content: {} description: Not Found '403': content: {} description: Permission Denied '401': content: {} description: Unauthorized '400': content: {} description: Bad Request '500': content: application/json: schema: $ref: '#/components/schemas/AsyncResourceError' description: Internal Server Error parameters: - schema: type: string description: '' title: uuid required: false description: 'The UUID token for the batch of requested data. This is returned in the response of the `create` endpoint. ' name: uuid in: query tags: - Clinical x-permissions: - clinical-notes x-practice-access: '"share_patients" need to be set for data access among practice' security: - drchrono_oauth2: - clinical:read operationId: clinical_note_field_values_list_list description: Retrieve or search clinical note values (soap notes) in batches. Results returned in order of ID or by updated_at. /api/care_plans/{id}: get: responses: '200': content: application/json: schema: $ref: '#/components/schemas/CarePlan' description: OK '405': content: {} description: Method Not Allowed '404': content: {} description: Not Found '403': content: {} description: Permission Denied '401': content: {} description: Unauthorized '400': content: {} description: Bad Request '500': content: {} description: Internal Server Error parameters: - schema: type: string description: '' title: '' required: true name: id in: path - schema: type: integer description: '' title: patient required: false description: '' name: patient in: query - schema: type: integer description: '' title: plan_type required: false description: '' name: plan_type in: query - schema: type: integer description: '' title: doctor required: false description: '' name: doctor in: query tags: - Clinical x-permissions: - clinical-notes x-practice-access: '"share_patients" need to be set for data access among practice' security: - drchrono_oauth2: - clinical:read - clinical:write operationId: care_plans_read description: Retrieve an existing care plan /api/fee_schedules/{id}: get: responses: '200': content: application/json: schema: $ref: '#/components/schemas/DoctorFeeSchedule' description: OK '405': content: {} description: Method Not Allowed '404': content: {} description: Not Found '403': content: {} description: Permission Denied '401': content: {} description: Unauthorized '400': content: {} description: Bad Request '500': content: {} description: Internal Server Error parameters: - schema: type: string description: '' title: '' required: true name: id in: path - schema: type: string description: '' title: code required: false description: '' name: code in: query - schema: type: string description: '' title: code_type required: false description: '' name: code_type in: query - schema: type: string description: '' title: since required: false description: '' name: since in: query - schema: type: string description: '' title: payer_id required: false description: '' name: payer_id in: query - schema: type: integer description: '' title: doctor required: false description: '' name: doctor in: query tags: - Clinical x-permissions: - billing - show-billing-tab x-practice-access: '"share_fee_schedules" need to be set for data access among practice' security: - drchrono_oauth2: - billing:read - billing:write operationId: fee_schedules_read /api/appointments/{id}: put: responses: '404': content: {} description: Not Found '403': content: {} description: Permission Denied '409': content: {} description: Scheduled time overlaps with an existing appointment '401': content: {} description: Unauthorized '400': content: {} description: Bad Request '500': content: {} description: Internal Server Error parameters: - schema: type: string description: '' title: '' description: Appointment ID required: true name: id in: path tags: - Clinical x-permissions: - scheduling - clinical-notes requestBody: content: application/json: schema: $ref: '#/components/schemas/Appointment' required: true x-practice-access: '"share_patients" need to be set for data access among practice' security: - drchrono_oauth2: - calendar:read - calendar:write - clinical:read - clinical:write operationId: appointments_update description: Update an existing appointment or break patch: responses: '204': content: {} description: No Content '404': content: {} description: Not Found '403': content: {} description: Permission Denied '500': content: {} description: Internal Server Error '401': content: {} description: Unauthorized '400': content: {} description: Bad Request '409': content: {} description: Scheduled time overlaps with an existing appointment parameters: - schema: type: string description: '' title: '' description: Appointment ID required: true name: id in: path tags: - Clinical x-permissions: - scheduling - clinical-notes requestBody: content: application/json: schema: $ref: '#/components/schemas/Appointment' required: true x-practice-access: '"share_patients" need to be set for data access among practice' security: - drchrono_oauth2: - calendar:read - calendar:write - clinical:read - clinical:write operationId: appointments_partial_update description: Update an existing appointment or break get: responses: '200': content: application/json: schema: $ref: '#/components/schemas/Appointment' description: OK '404': content: {} description: Not Found '403': content: {} description: Permission Denied '500': content: {} description: Internal Server Error '401': content: {} description: Unauthorized parameters: - schema: type: string description: '' title: '' required: true name: id in: path tags: - Clinical x-permissions: - scheduling - clinical-notes x-practice-access: '"share_patients" need to be set for data access among practice' security: - drchrono_oauth2: - calendar:read - calendar:write - clinical:read - clinical:write operationId: appointments_read description: Retrieve an existing appointment or break delete: responses: '404': content: {} description: Not Found '403': content: {} description: Permission Denied '500': content: {} description: Internal Server Error '401': content: {} description: Unauthorized parameters: - schema: type: string description: '' title: '' description: Appointment ID. Can be in the form of date_id where date is the day of the appointment and ID is the recurring appointment ID. If not recurring this is just the ID number. required: true name: id in: path tags: - Clinical x-permissions: - scheduling - clinical-notes x-practice-access: '"share_patients" need to be set for data access among practice' security: - drchrono_oauth2: - calendar:read - calendar:write - clinical:read - clinical:write operationId: appointments_delete description: Delete an existing appointment or break /api/telehealth_appointments: post: responses: '201': content: application/json: schema: $ref: '#/components/schemas/TelemedicineAppointment' description: Created '405': content: {} description: Method Not Allowed '404': content: {} description: Not Found '403': content: {} description: Permission Denied '401': content: {} description: Unauthorized '400': content: {} description: Bad Request '500': content: {} description: Internal Server Error parameters: - schema: type: integer description: '' title: appointment required: false description: '' name: appointment in: query - schema: type: integer description: '' title: doctor required: false description: '' name: doctor in: query tags: - Clinical x-permissions: - scheduling - clinical-notes x-practice-access: '"share_patients" need to be set for data access among practice' security: - drchrono_oauth2: - calendar:read - calendar:write - clinical:read - clinical:write operationId: telehealth_appointments_create get: responses: '200': content: application/json: schema: title: '' type: object description: Paginated Result properties: previous: type: string description: Previous paginated page title: previous data: items: $ref: '#/components/schemas/TelemedicineAppointment' type: array description: result data title: data next: type: string description: Next Paginated page title: next description: OK '405': content: {} description: Method Not Allowed '404': content: {} description: Not Found '403': content: {} description: Permission Denied '401': content: {} description: Unauthorized '400': content: {} description: Bad Request '500': content: {} description: Internal Server Error parameters: - schema: type: string description: The pagination cursor value. title: Cursor required: false name: cursor in: query - schema: type: integer description: Number of results to return per page. title: Page size required: false name: page_size in: query - schema: type: integer description: '' title: appointment required: false description: '' name: appointment in: query - schema: type: integer description: '' title: doctor required: false description: '' name: doctor in: query tags: - Clinical x-permissions: - scheduling - clinical-notes x-practice-access: '"share_patients" need to be set for data access among practice' security: - drchrono_oauth2: - calendar:read - calendar:write - clinical:read - clinical:write operationId: telehealth_appointments_list /api/care_plans: get: responses: '200': content: application/json: schema: title: '' type: object description: Paginated Result properties: previous: type: string description: Previous paginated page title: previous data: items: $ref: '#/components/schemas/CarePlan' type: array description: result data title: data next: type: string description: Next Paginated page title: next description: OK '405': content: {} description: Method Not Allowed '404': content: {} description: Not Found '403': content: {} description: Permission Denied '401': content: {} description: Unauthorized '400': content: {} description: Bad Request '500': content: {} description: Internal Server Error parameters: - schema: type: string description: The pagination cursor value. title: Cursor required: false name: cursor in: query - schema: type: integer description: Number of results to return per page. title: Page size required: false name: page_size in: query - schema: type: integer description: '' title: patient required: false description: '' name: patient in: query - schema: type: integer description: '' title: plan_type required: false description: '' name: plan_type in: query - schema: type: integer description: '' title: doctor required: false description: '' name: doctor in: query tags: - Clinical x-permissions: - clinical-notes x-practice-access: '"share_patients" need to be set for data access among practice' security: - drchrono_oauth2: - clinical:read - clinical:write operationId: care_plans_list description: Retrieve or search care plans /api/patient_physical_exams: post: responses: '201': content: application/json: schema: $ref: '#/components/schemas/PatientPhysicalExam' description: Created '405': content: {} description: Method Not Allowed '404': content: {} description: Not Found '403': content: {} description: Permission Denied '401': content: {} description: Unauthorized '400': content: {} description: Bad Request '500': content: {} description: Internal Server Error parameters: - schema: type: integer description: '' title: patient required: false description: '' name: patient in: query - schema: type: integer description: '' title: doctor required: false description: '' name: doctor in: query tags: - Clinical x-permissions: - clinical-notes x-practice-access: '"share_patients" need to be set for data access among practice' security: - drchrono_oauth2: - clinical:read - clinical:write operationId: patient_physical_exams_create description: Create patient physical exam for CQM get: responses: '200': content: application/json: schema: title: '' type: object description: Paginated Result properties: previous: type: string description: Previous paginated page title: previous data: items: $ref: '#/components/schemas/PatientPhysicalExam' type: array description: result data title: data next: type: string description: Next Paginated page title: next description: OK '405': content: {} description: Method Not Allowed '404': content: {} description: Not Found '403': content: {} description: Permission Denied '401': content: {} description: Unauthorized '400': content: {} description: Bad Request '500': content: {} description: Internal Server Error parameters: - schema: type: string description: The pagination cursor value. title: Cursor required: false name: cursor in: query - schema: type: integer description: Number of results to return per page. title: Page size required: false name: page_size in: query - schema: type: integer description: '' title: patient required: false description: '' name: patient in: query - schema: type: integer description: '' title: doctor required: false description: '' name: doctor in: query tags: - Clinical x-permissions: - clinical-notes x-practice-access: '"share_patients" need to be set for data access among practice' security: - drchrono_oauth2: - clinical:read - clinical:write operationId: patient_physical_exams_list description: Retrieve or search patient physical exams for CQM /api/signed_consent_forms/{id}: get: responses: '200': content: application/json: schema: $ref: '#/components/schemas/SignedConsentForm' description: OK '405': content: {} description: Method Not Allowed '404': content: {} description: Not Found '403': content: {} description: Permission Denied '401': content: {} description: Unauthorized '400': content: {} description: Bad Request '500': content: {} description: Internal Server Error parameters: - schema: type: string description: '' title: '' required: true name: id in: path tags: - Clinical description: Retrieve a single signed consent form record by id x-permissions: - manage-patients summary: signed_consent_forms Read x-practice-access: '"share_consent_forms" need to be set for data access among practice' security: - drchrono_oauth2: - patients:read - patients:write operationId: signed_consent_forms_read /api/clinical_note_templates/{id}: get: responses: '200': content: application/json: schema: $ref: '#/components/schemas/SoapNoteCustomReport' description: OK '405': content: {} description: Method Not Allowed '404': content: {} description: Not Found '403': content: {} description: Permission Denied '401': content: {} description: Unauthorized '400': content: {} description: Bad Request '500': content: {} description: Internal Server Error parameters: - schema: type: string description: '' title: '' required: true name: id in: path - schema: type: integer description: '' title: doctor required: false description: '' name: doctor in: query tags: - Clinical x-permissions: - clinical-notes x-practice-access: '"share_clinical_templates" need to be set for data access among practice' security: - drchrono_oauth2: - clinical:read - clinical:write operationId: clinical_note_templates_read description: Retrieve an existing clinical note tempalte /api/lab_results: post: responses: '201': content: application/json: schema: $ref: '#/components/schemas/LabResult' description: Created '405': content: {} description: Method Not Allowed '404': content: {} description: Not Found '403': content: {} description: Permission Denied '401': content: {} description: Unauthorized '400': content: {} description: Bad Request '500': content: {} description: Internal Server Error parameters: - schema: type: integer description: '' title: order required: false description: '' name: order in: query - schema: type: integer description: '' title: doctor required: false description: '' name: doctor in: query tags: - Clinical x-permissions: [] x-practice-access: '"share_patients" need to be set for data access among practice' security: - drchrono_oauth2: - labs:read - labs:write operationId: lab_results_create description: 'Create 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. - When results come in, submit the result document PDF via `/api/lab_documents` and submit the results data via `/api/lab_results` - Update `/api/lab_orders` status ' get: responses: '200': content: application/json: schema: title: '' type: object description: Paginated Result properties: previous: type: string description: Previous paginated page title: previous data: items: $ref: '#/components/schemas/LabResult' type: array description: result data title: data next: type: string description: Next Paginated page title: next description: OK '405': content: {} description: Method Not Allowed '404': content: {} description: Not Found '403': content: {} description: Permission Denied '401': content: {} description: Unauthorized '400': content: {} description: Bad Request '500': content: {} description: Internal Server Error parameters: - schema: type: string description: The pagination cursor value. title: Cursor required: false name: cursor in: query - schema: type: integer description: Number of results to return per page. title: Page size required: false name: page_size in: query - schema: type: integer description: '' title: order required: false description: '' name: order in: query - schema: type: integer description: '' title: doctor required: false description: '' name: doctor in: query tags: - Clinical x-permissions: [] x-practice-access: '"share_patients" need to be set for data access among practice' security: - drchrono_oauth2: - labs:read - labs:write operationId: lab_results_list description: Retrieve or search lab results /api/problems/{id}: put: responses: '204': content: {} description: No Content '405': content: {} description: Method Not Allowed '404': content: {} description: Not Found '403': content: {} description: Permission Denied '401': content: {} description: Unauthorized '400': content: {} description: Bad Request '500': content: {} description: Internal Server Error parameters: - schema: type: string description: '' title: '' required: true name: id in: path - schema: type: integer description: '' title: patient required: false description: '' name: patient in: query - schema: type: integer description: '' title: doctor required: false description: '' name: doctor in: query tags: - Clinical x-permissions: - clinical-notes x-practice-access: '"share_patients" need to be set for data access among practice' security: - drchrono_oauth2: - clinical:read - clinical:write operationId: problems_update description: Update an existing patient problems patch: responses: '204': content: {} description: No Content '405': content: {} description: Method Not Allowed '404': content: {} description: Not Found '403': content: {} description: Permission Denied '401': content: {} description: Unauthorized '400': content: {} description: Bad Request '500': content: {} description: Internal Server Error parameters: - schema: type: string description: '' title: '' required: true name: id in: path - schema: type: integer description: '' title: patient required: false description: '' name: patient in: query - schema: type: integer description: '' title: doctor required: false description: '' name: doctor in: query tags: - Clinical x-permissions: - clinical-notes x-practice-access: '"share_patients" need to be set for data access among practice' security: - drchrono_oauth2: - clinical:read - clinical:write operationId: problems_partial_update description: Update an existing patient problems get: responses: '200': content: application/json: schema: $ref: '#/components/schemas/PatientProblem' description: OK '405': content: {} description: Method Not Allowed '404': content: {} description: Not Found '403': content: {} description: Permission Denied '401': content: {} description: Unauthorized '400': content: {} description: Bad Request '500': content: {} description: Internal Server Error parameters: - schema: type: string description: '' title: '' required: true name: id in: path - schema: type: integer description: '' title: patient required: false description: '' name: patient in: query - schema: type: integer description: '' title: doctor required: false description: '' name: doctor in: query tags: - Clinical x-permissions: - clinical-notes x-practice-access: '"share_patients" need to be set for data access among practice' security: - drchrono_oauth2: - clinical:read - clinical:write operationId: problems_read description: Retrieve an existing patient problems /api/amendments: post: responses: '201': content: application/json: schema: $ref: '#/components/schemas/PatientAmendment' description: Created '405': content: {} description: Method Not Allowed '404': content: {} description: Not Found '403': content: {} description: Permission Denied '401': content: {} description: Unauthorized '400': content: {} description: Bad Request '500': content: {} description: Internal Server Error parameters: - schema: type: integer description: '' title: appointment required: false description: '' name: appointment in: query - schema: type: integer description: '' title: patient required: false description: '' name: patient in: query - schema: type: integer description: '' title: doctor required: false description: '' name: doctor in: query tags: - Clinical x-permissions: - clinical-notes x-practice-access: '"share_patients" need to be set for data access among practice' security: - drchrono_oauth2: - clinical:read - clinical:write operationId: amendments_create description: Create patient amendments to a patient's clinical records get: responses: '200': content: application/json: schema: title: '' type: object description: Paginated Result properties: previous: type: string description: Previous paginated page title: previous data: items: $ref: '#/components/schemas/PatientAmendment' type: array description: result data title: data next: type: string description: Next Paginated page title: next description: OK '405': content: {} description: Method Not Allowed '404': content: {} description: Not Found '403': content: {} description: Permission Denied '401': content: {} description: Unauthorized '400': content: {} description: Bad Request '500': content: {} description: Internal Server Error parameters: - schema: type: string description: The pagination cursor value. title: Cursor required: false name: cursor in: query - schema: type: integer description: Number of results to return per page. title: Page size required: false name: page_size in: query - schema: type: integer description: '' title: appointment required: false description: '' name: appointment in: query - schema: type: integer description: '' title: patient required: false description: '' name: patient in: query - schema: type: integer description: '' title: doctor required: false description: '' name: doctor in: query tags: - Clinical x-permissions: - clinical-notes x-practice-access: '"share_patients" need to be set for data access among practice' security: - drchrono_oauth2: - clinical:read - clinical:write operationId: amendments_list description: Retrieve or search patient amendments. You can only interact with amendments created by your API application /api/lab_orders: post: responses: '201': content: application/json: schema: $ref: '#/components/schemas/LabOrder' description: Created '405': content: {} description: Method Not Allowed '404': content: {} description: Not Found '403': content: {} description: Permission Denied '401': content: {} description: Unauthorized '400': content: {} description: Bad Request '500': content: {} description: Internal Server Error parameters: - schema: type: string description: '' title: since required: false description: '' name: since in: query - schema: type: integer description: '' title: doctor required: false description: '' name: doctor in: query tags: - Clinical x-permissions: [] x-practice-access: '"share_patients" need to be set for data access among practice' security: - drchrono_oauth2: - labs:read - labs:write operationId: lab_orders_create description: 'Create 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. - When results come in, submit the result document PDF via `/api/lab_documents` and submit the results data via `/api/lab_results` - Update `/api/lab_orders` status ' get: responses: '200': content: application/json: schema: title: '' type: object description: Paginated Result properties: previous: type: string description: Previous paginated page title: previous data: items: $ref: '#/components/schemas/LabOrder' type: array description: result data title: data next: type: string description: Next Paginated page title: next description: OK '405': content: {} description: Method Not Allowed '404': content: {} description: Not Found '403': content: {} description: Permission Denied '401': content: {} description: Unauthorized '400': content: {} description: Bad Request '500': content: {} description: Internal Server Error parameters: - schema: type: string description: The pagination cursor value. title: Cursor required: false name: cursor in: query - schema: type: integer description: Number of results to return per page. title: Page size required: false name: page_size in: query - schema: type: string description: '' title: since required: false description: '' name: since in: query - schema: type: integer description: '' title: doctor required: false description: '' name: doctor in: query tags: - Clinical x-permissions: [] x-practice-access: '"share_patients" need to be set for data access among practice' security: - drchrono_oauth2: - labs:read - labs:write operationId: lab_orders_list description: Retrieve or search lab orders /api/patient_flag_types: post: responses: '201': content: application/json: schema: $ref: '#/components/schemas/PatientFlagType' description: Created '405': content: {} description: Method Not Allowed '404': content: {} description: Not Found '403': content: {} description: Permission Denied '401': content: {} description: Unauthorized '400': content: {} description: Bad Request '500': content: {} description: Internal Server Error parameters: - schema: type: integer description: '' title: doctor required: false description: '' name: doctor in: query tags: - Clinical x-permissions: - manage-patients - settings x-practice-access: '"share_patients" need to be set for data access among practice' security: - drchrono_oauth2: - patients:read - patients:write - settings:read - settings:write operationId: patient_flag_types_create description: Create patient flag types get: responses: '200': content: application/json: schema: title: '' type: object description: Paginated Result properties: previous: type: string description: Previous paginated page title: previous data: items: $ref: '#/components/schemas/PatientFlagType' type: array description: result data title: data next: type: string description: Next Paginated page title: next description: OK '405': content: {} description: Method Not Allowed '404': content: {} description: Not Found '403': content: {} description: Permission Denied '401': content: {} description: Unauthorized '400': content: {} description: Bad Request '500': content: {} description: Internal Server Error parameters: - schema: type: string description: The pagination cursor value. title: Cursor required: false name: cursor in: query - schema: type: integer description: Number of results to return per page. title: Page size required: false name: page_size in: query - schema: type: integer description: '' title: doctor required: false description: '' name: doctor in: query tags: - Clinical x-permissions: - manage-patients - settings x-practice-access: '"share_patients" need to be set for data access among practice' security: - drchrono_oauth2: - patients:read - patients:write - settings:read - settings:write operationId: patient_flag_types_list description: Retrieve or search patient flag types /api/custom_appointment_fields/{id}: put: responses: '204': content: {} description: No Content '405': content: {} description: Method Not Allowed '404': content: {} description: Not Found '403': content: {} description: Permission Denied '401': content: {} description: Unauthorized '400': content: {} description: Bad Request '500': content: {} description: Internal Server Error parameters: - schema: type: string description: '' title: '' required: true name: id in: path - schema: type: integer description: '' title: doctor required: false description: '' name: doctor in: query tags: - Clinical x-permissions: - clinical-notes - settings x-practice-access: '"share_patients" need to be set for data access among practice' security: - drchrono_oauth2: - clinical:read - clinical:write - settings:read - settings:write operationId: custom_appointment_fields_update description: Update an existing custom appointment field patch: responses: '204': content: {} description: No Content '405': content: {} description: Method Not Allowed '404': content: {} description: Not Found '403': content: {} description: Permission Denied '401': content: {} description: Unauthorized '400': content: {} description: Bad Request '500': content: {} description: Internal Server Error parameters: - schema: type: string description: '' title: '' required: true name: id in: path - schema: type: integer description: '' title: doctor required: false description: '' name: doctor in: query tags: - Clinical x-permissions: - clinical-notes - settings x-practice-access: '"share_patients" need to be set for data access among practice' security: - drchrono_oauth2: - clinical:read - clinical:write - settings:read - settings:write operationId: custom_appointment_fields_partial_update description: Update an existing custom appointment field get: responses: '200': content: application/json: schema: $ref: '#/components/schemas/CustomAppointmentFieldType' description: OK '405': content: {} description: Method Not Allowed '404': content: {} description: Not Found '403': content: {} description: Permission Denied '401': content: {} description: Unauthorized '400': content: {} description: Bad Request '500': content: {} description: Internal Server Error parameters: - schema: type: string description: '' title: '' required: true name: id in: path - schema: type: integer description: '' title: doctor required: false description: '' name: doctor in: query tags: - Clinical x-permissions: - clinical-notes - settings x-practice-access: '"share_patients" need to be set for data access among practice' security: - drchrono_oauth2: - clinical:read - clinical:write - settings:read - settings:write operationId: custom_appointment_fields_read description: Retrieve an existing custom appointment field /api/eobs: post: responses: '201': content: application/json: schema: $ref: '#/components/schemas/EOBObject' description: Created '405': content: {} description: Method Not Allowed '404': content: {} description: Not Found '403': content: {} description: Permission Denied '401': content: {} description: Unauthorized '400': content: {} description: Bad Request '500': content: {} description: Internal Server Error parameters: - schema: type: integer description: '' title: doctor required: false description: '' name: doctor in: query tags: - Clinical x-permissions: - billing - show-billing-tab x-practice-access: '"share_patients" need to be set for data access among practice' security: - drchrono_oauth2: - billing:read - billing:write operationId: eobs_create description: Create EOB object get: responses: '200': content: application/json: schema: title: '' type: object description: Paginated Result properties: previous: type: string description: Previous paginated page title: previous data: items: $ref: '#/components/schemas/EOBObject' type: array description: result data title: data next: type: string description: Next Paginated page title: next description: OK '405': content: {} description: Method Not Allowed '404': content: {} description: Not Found '403': content: {} description: Permission Denied '401': content: {} description: Unauthorized '400': content: {} description: Bad Request '500': content: {} description: Internal Server Error parameters: - schema: type: string description: The pagination cursor value. title: Cursor required: false name: cursor in: query - schema: type: integer description: Number of results to return per page. title: Page size required: false name: page_size in: query - schema: type: integer description: '' title: doctor required: false description: '' name: doctor in: query tags: - Clinical x-permissions: - billing - show-billing-tab x-practice-access: '"share_patients" need to be set for data access among practice' security: - drchrono_oauth2: - billing:read - billing:write operationId: eobs_list description: Retrieve or search EOB objects /api/insurances: get: responses: '200': content: application/json: schema: title: '' type: object description: Paginated Result properties: previous: type: string description: Previous paginated page title: previous data: items: $ref: '#/components/schemas/Insurance' type: array description: result data title: data next: type: string description: Next Paginated page title: next description: OK '405': content: {} description: Method Not Allowed '404': content: {} description: Not Found '403': content: {} description: Permission Denied '401': content: {} description: Unauthorized '400': content: {} description: Bad Request '500': content: {} description: Internal Server Error parameters: - schema: type: string description: The pagination cursor value. title: Cursor required: false name: cursor in: query - schema: type: integer description: Number of results to return per page. title: Page size required: false name: page_size in: query - schema: type: string description: '' title: '' required: true description: One of `"emdeon"`, `"gateway"`, `"ihcfa"` name: payer_type in: query - schema: type: string description: '' title: '' required: false description: Search term, which can be either a partial name, partial ID or the state. name: term in: query tags: - Clinical x-permissions: [] x-practice-access: Data access among practice is available security: - drchrono_oauth2: - user:read - user:write operationId: insurances_list /api/telehealth_appointment_history: post: responses: '201': content: application/json: schema: $ref: '#/components/schemas/TelemedicineAppointmentEventLog' description: Created '405': content: {} description: Method Not Allowed '404': content: {} description: Not Found '403': content: {} description: Permission Denied '401': content: {} description: Unauthorized '400': content: {} description: Bad Request '500': content: {} description: Internal Server Error parameters: - schema: type: integer description: '' title: doctor required: false description: '' name: doctor in: query tags: - Clinical x-permissions: - scheduling - clinical-notes x-practice-access: Data access among practice is available security: - drchrono_oauth2: - calendar:read - calendar:write - clinical:read - clinical:write operationId: telehealth_appointment_history_create get: responses: '200': content: application/json: schema: title: '' type: object description: Paginated Result properties: previous: type: string description: Previous paginated page title: previous data: items: $ref: '#/components/schemas/TelemedicineAppointmentEventLog' type: array description: result data title: data next: type: string description: Next Paginated page title: next description: OK '405': content: {} description: Method Not Allowed '404': content: {} description: Not Found '403': content: {} description: Permission Denied '401': content: {} description: Unauthorized '400': content: {} description: Bad Request '500': content: {} description: Internal Server Error parameters: - schema: type: string description: The pagination cursor value. title: Cursor required: false name: cursor in: query - schema: type: integer description: Number of results to return per page. title: Page size required: false name: page_size in: query - schema: type: integer description: '' title: doctor required: false description: '' name: doctor in: query tags: - Clinical x-permissions: - scheduling - clinical-notes x-practice-access: Data access among practice is available security: - drchrono_oauth2: - calendar:read - calendar:write - clinical:read - clinical:write operationId: telehealth_appointment_history_list /api/patients_summary/{id}: put: responses: '204': content: {} description: No Content '405': content: {} description: Method Not Allowed '404': content: {} description: Not Found '403': content: {} description: Permission Denied '401': content: {} description: Unauthorized '400': content: {} description: Bad Request '500': content: {} description: Internal Server Error parameters: - schema: type: string description: '' title: '' required: true name: id in: path - schema: type: string description: '' title: first_name required: false description: '' name: first_name in: query - schema: type: string description: '' title: last_name required: false description: '' name: last_name in: query - schema: type: integer description: '' title: doctor required: false description: '' name: doctor in: query - schema: type: string description: '' title: gender required: false description: '' name: gender in: query - schema: type: string description: '' title: since required: false description: '' name: since in: query - schema: type: string description: '' title: date_of_birth required: false description: '' name: date_of_birth in: query tags: - Clinical x-permissions: - manage-patients x-practice-access: '"share_patients" need to be set for data access among practice' security: - drchrono_oauth2: - patients:summary:read - patients:summary:write operationId: patients_summary_update patch: responses: '204': content: {} description: No Content '405': content: {} description: Method Not Allowed '404': content: {} description: Not Found '403': content: {} description: Permission Denied '401': content: {} description: Unauthorized '400': content: {} description: Bad Request '500': content: {} description: Internal Server Error parameters: - schema: type: string description: '' title: '' required: true name: id in: path - schema: type: string description: '' title: first_name required: false description: '' name: first_name in: query - schema: type: string description: '' title: last_name required: false description: '' name: last_name in: query - schema: type: integer description: '' title: doctor required: false description: '' name: doctor in: query - schema: type: string description: '' title: gender required: false description: '' name: gender in: query - schema: type: string description: '' title: since required: false description: '' name: since in: query - schema: type: string description: '' title: date_of_birth required: false description: '' name: date_of_birth in: query tags: - Clinical x-permissions: - manage-patients x-practice-access: '"share_patients" need to be set for data access among practice' security: - drchrono_oauth2: - patients:summary:read - patients:summary:write operationId: patients_summary_partial_update get: responses: '200': content: application/json: schema: $ref: '#/components/schemas/Patient' description: OK '405': content: {} description: Method Not Allowed '404': content: {} description: Not Found '403': content: {} description: Permission Denied '401': content: {} description: Unauthorized '400': content: {} description: Bad Request '500': content: {} description: Internal Server Error parameters: - schema: type: string description: '' title: '' required: true name: id in: path - schema: type: string description: '' title: first_name required: false description: '' name: first_name in: query - schema: type: string description: '' title: last_name required: false description: '' name: last_name in: query - schema: type: integer description: '' title: doctor required: false description: '' name: doctor in: query - schema: type: string description: '' title: gender required: false description: '' name: gender in: query - schema: type: string description: '' title: since required: false description: '' name: since in: query - schema: type: string description: '' title: date_of_birth required: false description: '' name: date_of_birth in: query tags: - Clinical x-permissions: - manage-patients x-practice-access: '"share_patients" need to be set for data access among practice' security: - drchrono_oauth2: - patients:summary:read - patients:summary:write operationId: patients_summary_read delete: responses: '204': content: {} description: No Content '405': content: {} description: Method Not Allowed '404': content: {} description: Not Found '403': content: {} description: Permission Denied '401': content: {} description: Unauthorized '400': content: {} description: Bad Request '500': content: {} description: Internal Server Error parameters: - schema: type: string description: '' title: '' required: true name: id in: path - schema: type: string description: '' title: first_name required: false description: '' name: first_name in: query - schema: type: string description: '' title: last_name required: false description: '' name: last_name in: query - schema: type: integer description: '' title: doctor required: false description: '' name: doctor in: query - schema: type: string description: '' title: gender required: false description: '' name: gender in: query - schema: type: string description: '' title: since required: false description: '' name: since in: query - schema: type: string description: '' title: date_of_birth required: false description: '' name: date_of_birth in: query tags: - Clinical x-permissions: - manage-patients x-practice-access: '"share_patients" need to be set for data access among practice' security: - drchrono_oauth2: - patients:summary:read - patients:summary:write operationId: patients_summary_delete /api/lab_documents: post: responses: '201': content: application/json: schema: $ref: '#/components/schemas/LabOrderDocument' description: Created '405': content: {} description: Method Not Allowed '404': content: {} description: Not Found '403': content: {} description: Permission Denied '401': content: {} description: Unauthorized '400': content: {} description: Bad Request '500': content: {} description: Internal Server Error parameters: - schema: type: string description: '' title: since required: false description: '' name: since in: query - schema: type: integer description: '' title: doctor required: false description: '' name: doctor in: query tags: - Clinical x-permissions: [] x-practice-access: '"share_patients" need to be set for data access among practice' security: - drchrono_oauth2: - labs:read - labs:write operationId: lab_documents_create description: 'Create 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 drchrono. - When results come in, submit the result document PDF via `/api/lab_documents` and submit the results data via `/api/lab_results` - Update `/api/lab_orders` status ' get: responses: '200': content: application/json: schema: title: '' type: object description: Paginated Result properties: previous: type: string description: Previous paginated page title: previous data: items: $ref: '#/components/schemas/LabOrderDocument' type: array description: result data title: data next: type: string description: Next Paginated page title: next description: OK '405': content: {} description: Method Not Allowed '404': content: {} description: Not Found '403': content: {} description: Permission Denied '401': content: {} description: Unauthorized '400': content: {} description: Bad Request '500': content: {} description: Internal Server Error parameters: - schema: type: string description: The pagination cursor value. title: Cursor required: false name: cursor in: query - schema: type: integer description: Number of results to return per page. title: Page size required: false name: page_size in: query - schema: type: string description: '' title: since required: false description: '' name: since in: query - schema: type: integer description: '' title: doctor required: false description: '' name: doctor in: query tags: - Clinical x-permissions: [] x-practice-access: '"share_patients" need to be set for data access among practice' security: - drchrono_oauth2: - labs:read - labs:write operationId: lab_documents_list description: Retrieve or search lab order documents /api/consent_forms/{id}: put: responses: '204': content: {} description: No Content '405': content: {} description: Method Not Allowed '404': content: {} description: Not Found '403': content: {} description: Permission Denied '401': content: {} description: Unauthorized '400': content: {} description: Bad Request '500': content: {} description: Internal Server Error parameters: - schema: type: string description: '' title: '' required: true name: id in: path - schema: type: integer description: '' title: doctor required: false description: '' name: doctor in: query tags: - Clinical x-permissions: - manage-patients x-practice-access: '"share_consent_forms" need to be set for data access among practice' security: - drchrono_oauth2: - patients:read - patients:write operationId: consent_forms_update description: Update an existing patient consent form patch: responses: '204': content: {} description: No Content '405': content: {} description: Method Not Allowed '404': content: {} description: Not Found '403': content: {} description: Permission Denied '401': content: {} description: Unauthorized '400': content: {} description: Bad Request '500': content: {} description: Internal Server Error parameters: - schema: type: string description: '' title: '' required: true name: id in: path - schema: type: integer description: '' title: doctor required: false description: '' name: doctor in: query tags: - Clinical x-permissions: - manage-patients x-practice-access: '"share_consent_forms" need to be set for data access among practice' security: - drchrono_oauth2: - patients:read - patients:write operationId: consent_forms_partial_update description: Update an existing patient consent form get: responses: '200': content: application/json: schema: $ref: '#/components/schemas/ConsentForm' description: OK '405': content: {} description: Method Not Allowed '404': content: {} description: Not Found '403': content: {} description: Permission Denied '401': content: {} description: Unauthorized '400': content: {} description: Bad Request '500': content: {} description: Internal Server Error parameters: - schema: type: string description: '' title: '' required: true name: id in: path - schema: type: integer description: '' title: doctor required: false description: '' name: doctor in: query tags: - Clinical x-permissions: - manage-patients x-practice-access: '"share_consent_forms" need to be set for data access among practice' security: - drchrono_oauth2: - patients:read - patients:write operationId: consent_forms_read description: Retrieve an existing patient consent form /api/lab_tests/{id}: put: responses: '204': content: {} description: No Content '405': content: {} description: Method Not Allowed '404': content: {} description: Not Found '403': content: {} description: Permission Denied '401': content: {} description: Unauthorized '400': content: {} description: Bad Request '500': content: {} description: Internal Server Error parameters: - schema: type: string description: '' title: '' required: true name: id in: path - schema: type: integer description: '' title: order required: false description: '' name: order in: query - schema: type: integer description: '' title: doctor required: false description: '' name: doctor in: query tags: - Clinical x-permissions: [] x-practice-access: '"share_patients" need to be set for data access among practice' security: - drchrono_oauth2: - labs:read - labs:write operationId: lab_tests_update description: Update an existing lab test patch: responses: '204': content: {} description: No Content '405': content: {} description: Method Not Allowed '404': content: {} description: Not Found '403': content: {} description: Permission Denied '401': content: {} description: Unauthorized '400': content: {} description: Bad Request '500': content: {} description: Internal Server Error parameters: - schema: type: string description: '' title: '' required: true name: id in: path - schema: type: integer description: '' title: order required: false description: '' name: order in: query - schema: type: integer description: '' title: doctor required: false description: '' name: doctor in: query tags: - Clinical x-permissions: [] x-practice-access: '"share_patients" need to be set for data access among practice' security: - drchrono_oauth2: - labs:read - labs:write operationId: lab_tests_partial_update description: Update an existing lab test get: responses: '200': content: application/json: schema: $ref: '#/components/schemas/LabTest' description: OK '405': content: {} description: Method Not Allowed '404': content: {} description: Not Found '403': content: {} description: Permission Denied '401': content: {} description: Unauthorized '400': content: {} description: Bad Request '500': content: {} description: Internal Server Error parameters: - schema: type: string description: '' title: '' required: true name: id in: path - schema: type: integer description: '' title: order required: false description: '' name: order in: query - schema: type: integer description: '' title: doctor required: false description: '' name: doctor in: query tags: - Clinical x-permissions: [] x-practice-access: '"share_patients" need to be set for data access among practice' security: - drchrono_oauth2: - labs:read - labs:write operationId: lab_tests_read description: Retrieve an existing lab test delete: responses: '204': content: {} description: No Content '405': content: {} description: Method Not Allowed '404': content: {} description: Not Found '403': content: {} description: Permission Denied '401': content: {} description: Unauthorized '400': content: {} description: Bad Request '500': content: {} description: Internal Server Error parameters: - schema: type: string description: '' title: '' required: true name: id in: path - schema: type: integer description: '' title: order required: false description: '' name: order in: query - schema: type: integer description: '' title: doctor required: false description: '' name: doctor in: query tags: - Clinical x-permissions: [] x-practice-access: '"share_patients" need to be set for data access among practice' security: - drchrono_oauth2: - labs:read - labs:write operationId: lab_tests_delete description: Delete an existing lab test /api/prescription_messages_list: post: responses: '201': content: application/json: schema: properties: status: type: string description: Status of the request. Upon creation this will be "In progress" title: status uuid: type: string description: UUID of the batch. title: uuid description: type: string description: Contains link to load the batch by UUID description: Created '404': content: {} description: Not Found '403': content: {} description: Permission Denied '401': content: {} description: Unauthorized '400': content: {} description: Bad Request '500': content: {} description: Internal Server Error parameters: - schema: type: string title: order_by required: false description: 'Order results by a specific field. Valid options include [id, updated_at]. Default: id.' name: order_by in: query - schema: type: integer title: Page size description: Number of results to return per page. Value between 1 and 1000. required: false name: page_size in: query - schema: type: integer title: page description: Number of page to return. Value between 1 and max number of pages in result set. required: false name: page in: query - schema: type: string title: since description: Inclusive lower bound on record updated/created time required: false name: since in: query - schema: type: integer title: patient description: Patient ID filter required: false name: patient in: query - schema: type: integer title: doctor description: Prescribing doctor ID filter required: false name: doctor in: query - schema: type: string title: created_at description: Filter on specific creation date required: false name: created_at in: query - schema: type: integer title: parent_message description: Filter on associated parent prescription message ID required: false name: parent_message in: query tags: - Clinical x-permissions: - clinical-notes x-practice-access: '"share_patients" need to be set for data access among practice' security: - drchrono_oauth2: - clinical:read - clinical:write operationId: prescription_messages_list_create description: 'Create prescription messages list request. Use the UUID returned in the response to retrieve the batch of records. Results returned in order of id or updated_at. ' get: responses: '200': content: application/json: schema: title: '' type: object description: Paginated Result properties: status: type: string description: 'Status of the request. Possible values are "Complete" or "In progress". ' title: status pagination: properties: count: type: int description: the count of all records in the result set. title: count pages: type: int description: the total pages of all pages in the result set. title: pages page: type: int description: the current page (starting with 1) in the total pages. title: page type: object description: information on the total pages, current page and total count. title: pagination results: items: $ref: '#/components/schemas/PrescriptionMessage' type: array description: result data. only presented when the status is "Complete" title: data uuid: type: string description: UUID of the batch. title: uuid description: OK '404': content: {} description: Not Found '403': content: {} description: Permission Denied '401': content: {} description: Unauthorized '400': content: {} description: Bad Request '500': content: application/json: schema: $ref: '#/components/schemas/AsyncResourceError' description: Internal Server Error parameters: - schema: type: string description: '' title: uuid required: false description: 'The UUID token for the batch of prescription messages. This is returned in the response of the `create` endpoint. ' name: uuid in: query tags: - Clinical x-permissions: - clinical x-practice-access: '"share_patients" need to be set for data access among practice' security: - drchrono_oauth2: - clinical:read operationId: prescription_messages_list_list description: Retrieve or search prescription messages in batches. Results returned in order of ID or updated_at. /api/patients/{id}: put: responses: '204': content: {} description: No Content '405': content: {} description: Method Not Allowed '404': content: {} description: Not Found '403': content: {} description: Permission Denied '401': content: {} description: Unauthorized '400': content: {} description: Bad Request '500': content: {} description: Internal Server Error parameters: - schema: type: string description: '' title: '' required: true name: id in: path - schema: type: string description: '' title: first_name required: false description: '' name: first_name in: query - schema: type: string description: '' title: last_name required: false description: '' name: last_name in: query - schema: type: string description: '' title: preferred_language required: false description: '' name: preferred_language in: query - schema: type: integer description: '' title: doctor required: false description: '' name: doctor in: query - schema: type: string description: '' title: gender required: false description: '' name: gender in: query - schema: type: string description: '' title: since required: false description: '' name: since in: query - schema: type: string description: '' title: date_of_birth required: false description: '' name: date_of_birth in: query - schema: type: string description: '' title: race required: false description: '' name: race in: query - schema: type: string description: '' title: chart_id required: false description: '' name: chart_id in: query - schema: type: string description: '' title: email required: false description: '' name: email in: query - schema: type: string description: '' title: ethnicity required: false description: '' name: ethnicity in: query tags: - Clinical x-permissions: - manage-patients x-practice-access: '"share_patients" need to be set for data access among practice' security: - drchrono_oauth2: - patients:read - patients:write operationId: patients_update description: Update an existing patient patch: responses: '204': content: {} description: No Content '405': content: {} description: Method Not Allowed '404': content: {} description: Not Found '403': content: {} description: Permission Denied '401': content: {} description: Unauthorized '400': content: {} description: Bad Request '500': content: {} description: Internal Server Error parameters: - schema: type: string description: '' title: '' required: true name: id in: path - schema: type: string description: '' title: first_name required: false description: '' name: first_name in: query - schema: type: string description: '' title: last_name required: false description: '' name: last_name in: query - schema: type: string description: '' title: preferred_language required: false description: '' name: preferred_language in: query - schema: type: integer description: '' title: doctor required: false description: '' name: doctor in: query - schema: type: string description: '' title: gender required: false description: '' name: gender in: query - schema: type: string description: '' title: since required: false description: '' name: since in: query - schema: type: string description: '' title: date_of_birth required: false description: '' name: date_of_birth in: query - schema: type: string description: '' title: race required: false description: '' name: race in: query - schema: type: string description: '' title: chart_id required: false description: '' name: chart_id in: query - schema: type: string description: '' title: email required: false description: '' name: email in: query - schema: type: string description: '' title: ethnicity required: false description: '' name: ethnicity in: query tags: - Clinical x-permissions: - manage-patients x-practice-access: '"share_patients" need to be set for data access among practice' security: - drchrono_oauth2: - patients:read - patients:write operationId: patients_partial_update description: Update an existing patient get: responses: '200': content: application/json: schema: $ref: '#/components/schemas/Patient' description: OK '405': content: {} description: Method Not Allowed '404': content: {} description: Not Found '403': content: {} description: Permission Denied '401': content: {} description: Unauthorized '400': content: {} description: Bad Request '500': content: {} description: Internal Server Error parameters: - schema: type: string description: '' title: '' required: true name: id in: path - schema: type: string description: '' title: first_name required: false description: '' name: first_name in: query - schema: type: string description: '' title: last_name required: false description: '' name: last_name in: query - schema: type: string description: '' title: preferred_language required: false description: '' name: preferred_language in: query - schema: type: integer description: '' title: doctor required: false description: '' name: doctor in: query - schema: type: string description: '' title: gender required: false description: '' name: gender in: query - schema: type: string description: '' title: since required: false description: '' name: since in: query - schema: type: string description: '' title: date_of_birth required: false description: '' name: date_of_birth in: query - schema: type: string description: '' title: race required: false description: '' name: race in: query - schema: type: string description: '' title: chart_id required: false description: '' name: chart_id in: query - schema: type: string description: '' title: email required: false description: '' name: email in: query - schema: type: string description: '' title: ethnicity required: false description: '' name: ethnicity in: query tags: - Clinical x-permissions: - manage-patients x-practice-access: '"share_patients" need to be set for data access among practice' security: - drchrono_oauth2: - patients:read - patients:write operationId: patients_read description: Retrieve an existing patient delete: responses: '204': content: {} description: No Content '405': content: {} description: Method Not Allowed '404': content: {} description: Not Found '403': content: {} description: Permission Denied '401': content: {} description: Unauthorized '400': content: {} description: Bad Request '500': content: {} description: Internal Server Error parameters: - schema: type: string description: '' title: '' required: true name: id in: path - schema: type: string description: '' title: first_name required: false description: '' name: first_name in: query - schema: type: string description: '' title: last_name required: false description: '' name: last_name in: query - schema: type: string description: '' title: preferred_language required: false description: '' name: preferred_language in: query - schema: type: integer description: '' title: doctor required: false description: '' name: doctor in: query - schema: type: string description: '' title: gender required: false description: '' name: gender in: query - schema: type: string description: '' title: since required: false description: '' name: since in: query - schema: type: string description: '' title: date_of_birth required: false description: '' name: date_of_birth in: query - schema: type: string description: '' title: race required: false description: '' name: race in: query - schema: type: string description: '' title: chart_id required: false description: '' name: chart_id in: query - schema: type: string description: '' title: email required: false description: '' name: email in: query - schema: type: string description: '' title: ethnicity required: false description: '' name: ethnicity in: query tags: - Clinical x-permissions: - manage-patients x-practice-access: '"share_patients" need to be set for data access among practice' security: - drchrono_oauth2: - patients:read - patients:write operationId: patients_delete description: Delete an existing patient /api/patients/{id}/ccda_async: get: responses: '200': content: application/xml: schema: type: object description: '' title: '' description: OK '405': content: {} description: Method Not Allowed '404': content: {} description: Not Found '403': content: {} description: Permission Denied '401': content: {} description: Unauthorized '400': content: {} description: Bad Request '500': content: {} description: Internal Server Error parameters: - schema: type: string description: '' title: '' required: true name: id in: path - schema: type: string description: '' title: first_name required: false description: '' name: first_name in: query - schema: type: string description: '' title: last_name required: false description: '' name: last_name in: query - schema: type: string description: '' title: preferred_language required: false description: '' name: preferred_language in: query - schema: type: integer description: '' title: doctor required: false description: '' name: doctor in: query - schema: type: string description: '' title: gender required: false description: '' name: gender in: query - schema: type: string description: '' title: created_at required: false description: '' name: created_at in: query - schema: type: string description: '' title: since required: false description: '' name: since in: query - schema: type: string description: '' title: date_of_birth required: false description: '' name: date_of_birth in: query - schema: type: string description: '' title: race required: false description: '' name: race in: query - schema: type: string description: '' title: chart_id required: false description: '' name: chart_id in: query - schema: type: string description: '' title: email required: false description: '' name: email in: query - schema: type: string description: '' title: ethnicity required: false description: '' name: ethnicity in: query tags: - Clinical x-permissions: - manage-patients x-practice-access: '"share_patients" need to be set for data access among practice' security: - drchrono_oauth2: - patients:read - patients:write operationId: patients_ccda_async description: Retrieve patient CCDA async. /api/custom_vitals: get: responses: '200': content: application/json: schema: title: '' type: object description: Paginated Result properties: previous: type: string description: Previous paginated page title: previous data: items: $ref: '#/components/schemas/CustomVitalType' type: array description: result data title: data next: type: string description: Next Paginated page title: next description: OK '405': content: {} description: Method Not Allowed '404': content: {} description: Not Found '403': content: {} description: Permission Denied '401': content: {} description: Unauthorized '400': content: {} description: Bad Request '500': content: {} description: Internal Server Error parameters: - schema: type: string description: The pagination cursor value. title: Cursor required: false name: cursor in: query - schema: type: integer description: Number of results to return per page. title: Page size required: false name: page_size in: query - schema: type: integer description: '' title: doctor required: false description: '' name: doctor in: query tags: - Clinical x-permissions: - clinical-notes - settings x-practice-access: '"share_clinical_templates" need to be set for data access among practice' security: - drchrono_oauth2: - clinical:read - clinical:write - settings:read - settings:write operationId: custom_vitals_list description: Retrieve or search custom vital types /api/schedule_blocks: post: responses: '201': content: application/json: schema: $ref: '#/components/schemas/ScheduleBlock' description: Created '403': content: {} description: Permission Denied '500': content: {} description: Internal Server Error '401': content: {} description: Unauthorized '400': content: {} description: Bad Request - Invalid data (e.g., start_time must be before end_time) tags: - Clinical description: Create a new schedule block to block off time on a provider's calendar. This prevents appointments from being scheduled during the specified time period. Use this to block time for lunch breaks, meetings, administrative tasks, PTO, or other activities. x-permissions: - calendar summary: Create a schedule block requestBody: content: application/json: examples: pto: value: description: PTO - Personal Day office: 200 color: '#9B59B6' start_time: '2024-04-01T08:00:00' end_time: '2024-04-01T17:00:00' provider: 100 summary: Create a PTO (paid time off) schedule block lunchBreak: value: description: Lunch Break office: 200 color: '#FF5733' start_time: '2024-03-15T12:00:00' exam_room: 1 end_time: '2024-03-15T13:00:00' provider: 100 summary: Create a lunch break schedule block staffMeeting: value: description: Staff Meeting - Q1 Review office: 200 color: '#3498DB' start_time: '2024-03-20T14:00:00' end_time: '2024-03-20T15:30:00' provider: 100 summary: Create a staff meeting schedule block schema: $ref: '#/components/schemas/ScheduleBlock' required: true security: - drchrono_oauth2: - calendar:read - calendar:write operationId: schedule_blocks_create get: responses: '200': content: application/json: schema: title: '' type: object description: Paginated Result properties: previous: type: string description: Previous paginated page title: previous data: items: $ref: '#/components/schemas/ScheduleBlock' type: array description: result data title: data next: type: string description: Next Paginated page title: next description: OK '403': content: {} description: Permission Denied '500': content: {} description: Internal Server Error '401': content: {} description: Unauthorized '400': content: {} description: Bad Request parameters: - schema: type: string description: The pagination cursor value. title: Cursor required: false name: cursor in: query - schema: type: integer description: Number of results to return per page. title: Page size required: false name: page_size in: query - schema: type: integer description: ID of the provider or doctor title: doctor required: false description: Filter by doctor/provider ID name: doctor in: query - schema: type: integer description: ID of the office title: office required: false description: Filter by office ID name: office in: query - schema: type: string description: Specific date to filter schedule blocks title: date required: false description: Filter by specific date (YYYY-MM-DD format) name: date in: query - schema: type: string description: Inclusive date range to filter schedule blocks title: date_range required: false description: Filter by date range (YYYY-MM-DD/YYYY-MM-DD format) name: date_range in: query tags: - Clinical description: Retrieve or search schedule blocks. Schedule blocks are used to block off time on a provider's calendar to prevent appointments from being scheduled. Use this to retrieve existing blocks for lunch breaks, meetings, PTO, or other non-appointment activities. Either `date` or `date_range` parameter is recommended for efficient querying. x-permissions: - calendar summary: Retrieve and search schedule blocks security: - drchrono_oauth2: - calendar:read - calendar:write operationId: schedule_blocks_list /api/care_team_members/{id}: get: responses: '200': content: application/json: schema: $ref: '#/components/schemas/CareTeamMember' description: OK '405': content: {} description: Method Not Allowed '404': content: {} description: Not Found '403': content: {} description: Permission Denied '401': content: {} description: Unauthorized '400': content: {} description: Bad Request '500': content: {} description: Internal Server Error parameters: - schema: type: string description: '' title: '' required: true name: id in: path - schema: type: integer description: '' title: patient required: false description: '' name: patient in: query - schema: type: integer description: '' title: appointment required: false description: '' name: appointment in: query - schema: type: integer description: '' title: doctor required: false description: '' name: doctor in: query tags: - Clinical x-permissions: - clinical-notes x-practice-access: '"share_patients" need to be set for data access among practice' security: - drchrono_oauth2: - clinical:read - clinical:write operationId: care_team_members_read /api/claim_billing_notes/{id}: get: responses: '200': content: application/json: schema: $ref: '#/components/schemas/ClaimBillingNotes' description: OK '405': content: {} description: Method Not Allowed '404': content: {} description: Not Found '403': content: {} description: Permission Denied '401': content: {} description: Unauthorized '400': content: {} description: Bad Request '500': content: {} description: Internal Server Error parameters: - schema: type: string description: '' title: '' required: true name: id in: path - schema: type: integer description: '' title: appointment required: false description: '' name: appointment in: query - schema: type: integer description: '' title: doctor required: false description: '' name: doctor in: query tags: - Clinical x-permissions: - billing - show-billing-tab x-practice-access: '"share_patients" need to be set for data access among practice' security: - drchrono_oauth2: - billing:read - billing:write operationId: claim_billing_notes_read description: Retrieve an existing billing note /api/patient_lab_results/{id}: put: responses: '204': content: {} description: No Content '405': content: {} description: Method Not Allowed '404': content: {} description: Not Found '403': content: {} description: Permission Denied '401': content: {} description: Unauthorized '400': content: {} description: Bad Request '500': content: {} description: Internal Server Error parameters: - schema: type: string description: '' title: '' required: true name: id in: path - schema: type: integer description: '' title: ordering_doctor required: false description: '' name: ordering_doctor in: query - schema: type: string description: '' title: since required: false description: '' name: since in: query - schema: type: integer description: '' title: patient required: false description: '' name: patient in: query - schema: type: integer description: '' title: doctor required: false description: '' name: doctor in: query tags: - Clinical x-permissions: - manage-patients x-practice-access: '"share_patients" need to be set for data access among practice' security: - drchrono_oauth2: - labs:read - labs:write - patients:read - patients:write operationId: patient_lab_results_update patch: responses: '204': content: {} description: No Content '405': content: {} description: Method Not Allowed '404': content: {} description: Not Found '403': content: {} description: Permission Denied '401': content: {} description: Unauthorized '400': content: {} description: Bad Request '500': content: {} description: Internal Server Error parameters: - schema: type: string description: '' title: '' required: true name: id in: path - schema: type: integer description: '' title: ordering_doctor required: false description: '' name: ordering_doctor in: query - schema: type: string description: '' title: since required: false description: '' name: since in: query - schema: type: integer description: '' title: patient required: false description: '' name: patient in: query - schema: type: integer description: '' title: doctor required: false description: '' name: doctor in: query tags: - Clinical x-permissions: - manage-patients x-practice-access: '"share_patients" need to be set for data access among practice' security: - drchrono_oauth2: - labs:read - labs:write - patients:read - patients:write operationId: patient_lab_results_partial_update get: responses: '200': content: application/json: schema: $ref: '#/components/schemas/PatientLabResultSet' description: OK '405': content: {} description: Method Not Allowed '404': content: {} description: Not Found '403': content: {} description: Permission Denied '401': content: {} description: Unauthorized '400': content: {} description: Bad Request '500': content: {} description: Internal Server Error parameters: - schema: type: string description: '' title: '' required: true name: id in: path - schema: type: integer description: '' title: ordering_doctor required: false description: '' name: ordering_doctor in: query - schema: type: string description: '' title: since required: false description: '' name: since in: query - schema: type: integer description: '' title: patient required: false description: '' name: patient in: query - schema: type: integer description: '' title: doctor required: false description: '' name: doctor in: query tags: - Clinical x-permissions: - manage-patients x-practice-access: '"share_patients" need to be set for data access among practice' security: - drchrono_oauth2: - labs:read - labs:write - patients:read - patients:write operationId: patient_lab_results_read delete: responses: '204': content: {} description: No Content '405': content: {} description: Method Not Allowed '404': content: {} description: Not Found '403': content: {} description: Permission Denied '401': content: {} description: Unauthorized '400': content: {} description: Bad Request '500': content: {} description: Internal Server Error parameters: - schema: type: string description: '' title: '' required: true name: id in: path - schema: type: integer description: '' title: ordering_doctor required: false description: '' name: ordering_doctor in: query - schema: type: string description: '' title: since required: false description: '' name: since in: query - schema: type: integer description: '' title: patient required: false description: '' name: patient in: query - schema: type: integer description: '' title: doctor required: false description: '' name: doctor in: query tags: - Clinical x-permissions: - manage-patients x-practice-access: '"share_patients" need to be set for data access among practice' security: - drchrono_oauth2: - labs:read - labs:write - patients:read - patients:write operationId: patient_lab_results_delete /api/amendments/{id}: put: responses: '204': content: {} description: No Content '405': content: {} description: Method Not Allowed '404': content: {} description: Not Found '403': content: {} description: Permission Denied '401': content: {} description: Unauthorized '400': content: {} description: Bad Request '500': content: {} description: Internal Server Error parameters: - schema: type: string description: '' title: '' required: true name: id in: path - schema: type: integer description: '' title: appointment required: false description: '' name: appointment in: query - schema: type: integer description: '' title: patient required: false description: '' name: patient in: query - schema: type: integer description: '' title: doctor required: false description: '' name: doctor in: query tags: - Clinical x-permissions: - clinical-notes x-practice-access: '"share_patients" need to be set for data access among practice' security: - drchrono_oauth2: - clinical:read - clinical:write operationId: amendments_update description: Update an existing patient amendment, you can only interact with amendments created by your API application patch: responses: '204': content: {} description: No Content '405': content: {} description: Method Not Allowed '404': content: {} description: Not Found '403': content: {} description: Permission Denied '401': content: {} description: Unauthorized '400': content: {} description: Bad Request '500': content: {} description: Internal Server Error parameters: - schema: type: string description: '' title: '' required: true name: id in: path - schema: type: integer description: '' title: appointment required: false description: '' name: appointment in: query - schema: type: integer description: '' title: patient required: false description: '' name: patient in: query - schema: type: integer description: '' title: doctor required: false description: '' name: doctor in: query tags: - Clinical x-permissions: - clinical-notes x-practice-access: '"share_patients" need to be set for data access among practice' security: - drchrono_oauth2: - clinical:read - clinical:write operationId: amendments_partial_update description: Update an existing patient amendment, you can only interact with amendments created by your API application get: responses: '200': content: application/json: schema: $ref: '#/components/schemas/PatientAmendment' description: OK '405': content: {} description: Method Not Allowed '404': content: {} description: Not Found '403': content: {} description: Permission Denied '401': content: {} description: Unauthorized '400': content: {} description: Bad Request '500': content: {} description: Internal Server Error parameters: - schema: type: string description: '' title: '' required: true name: id in: path - schema: type: integer description: '' title: appointment required: false description: '' name: appointment in: query - schema: type: integer description: '' title: patient required: false description: '' name: patient in: query - schema: type: integer description: '' title: doctor required: false description: '' name: doctor in: query tags: - Clinical x-permissions: - clinical-notes x-practice-access: '"share_patients" need to be set for data access among practice' security: - drchrono_oauth2: - clinical:read - clinical:write operationId: amendments_read description: Retrieve an existing patient amendment, you can only interact with amendments created by your API application delete: responses: '204': content: {} description: No Content '405': content: {} description: Method Not Allowed '404': content: {} description: Not Found '403': content: {} description: Permission Denied '401': content: {} description: Unauthorized '400': content: {} description: Bad Request '500': content: {} description: Internal Server Error parameters: - schema: type: string description: '' title: '' required: true name: id in: path - schema: type: integer description: '' title: appointment required: false description: '' name: appointment in: query - schema: type: integer description: '' title: patient required: false description: '' name: patient in: query - schema: type: integer description: '' title: doctor required: false description: '' name: doctor in: query tags: - Clinical x-permissions: - clinical-notes x-practice-access: '"share_patients" need to be set for data access among practice' security: - drchrono_oauth2: - clinical:read - clinical:write operationId: amendments_delete description: Delete an existing patient amendment, you can only interact with amendments created by your API application /api/lab_tests: post: responses: '201': content: application/json: schema: $ref: '#/components/schemas/LabTest' description: Created '405': content: {} description: Method Not Allowed '404': content: {} description: Not Found '403': content: {} description: Permission Denied '401': content: {} description: Unauthorized '400': content: {} description: Bad Request '500': content: {} description: Internal Server Error parameters: - schema: type: integer description: '' title: order required: false description: '' name: order in: query - schema: type: integer description: '' title: doctor required: false description: '' name: doctor in: query tags: - Clinical x-permissions: [] x-practice-access: '"share_patients" need to be set for data access among practice' security: - drchrono_oauth2: - labs:read - labs:write operationId: lab_tests_create description: 'Create 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. - When results come in, submit the result document PDF via `/api/lab_documents` and submit the results data via `/api/lab_results` - Update `/api/lab_orders` status ' get: responses: '200': content: application/json: schema: title: '' type: object description: Paginated Result properties: previous: type: string description: Previous paginated page title: previous data: items: $ref: '#/components/schemas/LabTest' type: array description: result data title: data next: type: string description: Next Paginated page title: next description: OK '405': content: {} description: Method Not Allowed '404': content: {} description: Not Found '403': content: {} description: Permission Denied '401': content: {} description: Unauthorized '400': content: {} description: Bad Request '500': content: {} description: Internal Server Error parameters: - schema: type: string description: The pagination cursor value. title: Cursor required: false name: cursor in: query - schema: type: integer description: Number of results to return per page. title: Page size required: false name: page_size in: query - schema: type: integer description: '' title: order required: false description: '' name: order in: query - schema: type: integer description: '' title: doctor required: false description: '' name: doctor in: query tags: - Clinical x-permissions: [] x-practice-access: '"share_patients" need to be set for data access among practice' security: - drchrono_oauth2: - labs:read - labs:write operationId: lab_tests_list description: Retrieve or search lab tests /api/appointments_list/{id}: put: responses: '204': content: {} description: No Content '405': content: {} description: Method Not Allowed '404': content: {} description: Not Found '403': content: {} description: Permission Denied '500': content: {} description: Internal Server Error '401': content: {} description: Unauthorized '400': content: {} description: Bad Request '409': content: {} description: Scheduled time overlaps with an existing appointment parameters: - schema: type: string description: '' title: '' required: true name: id in: path - schema: type: string description: '' title: status required: false description: '' name: status in: query - schema: type: integer description: '' title: patient required: false description: '' name: patient in: query - schema: type: integer description: '' title: office required: false description: '' name: office in: query - schema: type: integer description: '' title: doctor required: false description: '' name: doctor in: query - schema: type: string description: '' title: since required: false description: '' name: since in: query - schema: type: string description: '' title: date_range required: false description: '' name: date_range in: query - schema: type: string description: '' title: date required: false description: '' name: date in: query tags: - Clinical x-permissions: - scheduling - clinical-notes x-practice-access: '"share_patients" need to be set for data access among practice' security: - drchrono_oauth2: - calendar:read - calendar:write - clinical:read - clinical:write operationId: appointments_list_update patch: responses: '204': content: {} description: No Content '405': content: {} description: Method Not Allowed '404': content: {} description: Not Found '403': content: {} description: Permission Denied '500': content: {} description: Internal Server Error '401': content: {} description: Unauthorized '400': content: {} description: Bad Request '409': content: {} description: Scheduled time overlaps with an existing appointment parameters: - schema: type: string description: '' title: '' required: true name: id in: path - schema: type: string description: '' title: status required: false description: '' name: status in: query - schema: type: integer description: '' title: patient required: false description: '' name: patient in: query - schema: type: integer description: '' title: office required: false description: '' name: office in: query - schema: type: integer description: '' title: doctor required: false description: '' name: doctor in: query - schema: type: string description: '' title: since required: false description: '' name: since in: query - schema: type: string description: '' title: date_range required: false description: '' name: date_range in: query - schema: type: string description: '' title: date required: false description: '' name: date in: query tags: - Clinical x-permissions: - scheduling - clinical-notes x-practice-access: '"share_patients" need to be set for data access among practice' security: - drchrono_oauth2: - calendar:read - calendar:write - clinical:read - clinical:write operationId: appointments_list_partial_update get: responses: '200': content: application/json: schema: $ref: '#/components/schemas/Appointment' description: OK '405': content: {} description: Method Not Allowed '404': content: {} description: Not Found '403': content: {} description: Permission Denied '401': content: {} description: Unauthorized '400': content: {} description: Bad Request '500': content: {} description: Internal Server Error parameters: - schema: type: string description: '' title: '' required: true name: id in: path - schema: type: string description: '' title: status required: false description: '' name: status in: query - schema: type: integer description: '' title: patient required: false description: '' name: patient in: query - schema: type: integer description: '' title: office required: false description: '' name: office in: query - schema: type: integer description: '' title: doctor required: false description: '' name: doctor in: query - schema: type: string description: '' title: since required: false description: '' name: since in: query - schema: type: string description: '' title: date_range required: false description: '' name: date_range in: query - schema: type: string description: '' title: date required: false description: '' name: date in: query tags: - Clinical x-permissions: - scheduling - clinical-notes x-practice-access: '"share_patients" need to be set for data access among practice' security: - drchrono_oauth2: - calendar:read - calendar:write - clinical:read - clinical:write operationId: appointments_list_read delete: responses: '204': content: {} description: No Content '405': content: {} description: Method Not Allowed '404': content: {} description: Not Found '403': content: {} description: Permission Denied '401': content: {} description: Unauthorized '400': content: {} description: Bad Request '500': content: {} description: Internal Server Error parameters: - schema: type: string description: '' title: '' required: true name: id in: path - schema: type: string description: '' title: status required: false description: '' name: status in: query - schema: type: integer description: '' title: patient required: false description: '' name: patient in: query - schema: type: integer description: '' title: office required: false description: '' name: office in: query - schema: type: integer description: '' title: doctor required: false description: '' name: doctor in: query - schema: type: string description: '' title: since required: false description: '' name: since in: query - schema: type: string description: '' title: date_range required: false description: '' name: date_range in: query - schema: type: string description: '' title: date required: false description: '' name: date in: query tags: - Clinical x-permissions: - scheduling - clinical-notes x-practice-access: '"share_patients" need to be set for data access among practice' security: - drchrono_oauth2: - calendar:read - calendar:write - clinical:read - clinical:write operationId: appointments_list_delete /api/patient_lab_results: post: responses: '201': content: application/json: schema: $ref: '#/components/schemas/PatientLabResultSet' description: Created '405': content: {} description: Method Not Allowed '404': content: {} description: Not Found '403': content: {} description: Permission Denied '401': content: {} description: Unauthorized '400': content: {} description: Bad Request '500': content: {} description: Internal Server Error parameters: - schema: type: integer description: '' title: ordering_doctor required: false description: '' name: ordering_doctor in: query - schema: type: string description: '' title: since required: false description: '' name: since in: query - schema: type: integer description: '' title: patient required: false description: '' name: patient in: query - schema: type: integer description: '' title: doctor required: false description: '' name: doctor in: query tags: - Clinical x-permissions: - manage-patients x-practice-access: '"share_patients" need to be set for data access among practice' security: - drchrono_oauth2: - labs:read - labs:write - patients:read - patients:write operationId: patient_lab_results_create get: responses: '200': content: application/json: schema: title: '' type: object description: Paginated Result properties: previous: type: string description: Previous paginated page title: previous data: items: $ref: '#/components/schemas/PatientLabResultSet' type: array description: result data title: data next: type: string description: Next Paginated page title: next description: OK '405': content: {} description: Method Not Allowed '404': content: {} description: Not Found '403': content: {} description: Permission Denied '401': content: {} description: Unauthorized '400': content: {} description: Bad Request '500': content: {} description: Internal Server Error parameters: - schema: type: string description: The pagination cursor value. title: Cursor required: false name: cursor in: query - schema: type: integer description: Number of results to return per page. title: Page size required: false name: page_size in: query - schema: type: integer description: '' title: ordering_doctor required: false description: '' name: ordering_doctor in: query - schema: type: string description: '' title: since required: false description: '' name: since in: query - schema: type: integer description: '' title: patient required: false description: '' name: patient in: query - schema: type: integer description: '' title: doctor required: false description: '' name: doctor in: query tags: - Clinical x-permissions: - manage-patients x-practice-access: '"share_patients" need to be set for data access among practice' security: - drchrono_oauth2: - labs:read - labs:write - patients:read - patients:write operationId: patient_lab_results_list /api/fee_schedules_v2/{id}: get: responses: '200': content: application/json: schema: $ref: '#/components/schemas/FeeSchedule' description: OK '405': content: {} description: Method Not Allowed '404': content: {} description: Not Found '403': content: {} description: Permission Denied '401': content: {} description: Unauthorized '400': content: {} description: Bad Request '500': content: {} description: Internal Server Error parameters: - schema: type: string description: '' title: '' required: true name: id in: path tags: - Clinical x-permissions: - billing - show-billing-tab x-practice-access: '' security: - drchrono_oauth2: - billing:read - billing:write operationId: fee_schedules_v2_read /api/insurances/{id}: get: responses: '200': content: application/json: schema: $ref: '#/components/schemas/Insurance' description: OK '405': content: {} description: Method Not Allowed '404': content: {} description: Not Found '403': content: {} description: Permission Denied '401': content: {} description: Unauthorized '400': content: {} description: Bad Request '500': content: {} description: Internal Server Error parameters: - schema: type: string description: '' title: '' required: true name: id in: path - schema: type: string description: '' title: '' required: true description: One of `"emdeon"`, `"gateway"`, `"ihcfa"` name: payer_type in: query - schema: type: string description: '' title: '' required: false description: Search term, which can be either a partial name, partial ID or the state. name: term in: query tags: - Clinical x-permissions: [] x-practice-access: Data access among practice is available security: - drchrono_oauth2: - user:read - user:write operationId: insurances_read /api/clinical_notes: get: responses: '200': content: application/json: schema: title: '' type: object description: Paginated Result properties: previous: type: string description: Previous paginated page title: previous data: items: $ref: '#/components/schemas/ClinicalNote' type: array description: result data title: data next: type: string description: Next Paginated page title: next description: OK '405': content: {} description: Method Not Allowed '404': content: {} description: Not Found '403': content: {} description: Permission Denied '401': content: {} description: Unauthorized '400': content: {} description: Bad Request '500': content: {} description: Internal Server Error parameters: - schema: type: string description: The pagination cursor value. title: Cursor required: false name: cursor in: query - schema: type: integer description: Number of results to return per page. title: Page size required: false name: page_size in: query - schema: type: integer description: '' title: patient required: false description: '' name: patient in: query - schema: type: integer description: '' title: office required: false description: '' name: office in: query - schema: type: integer description: '' title: doctor required: false description: '' name: doctor in: query - schema: type: string description: created_at filter in format YYYY-MM-DD title: created_at required: false description: '' name: created_at in: query - schema: type: string description: '' title: since required: false description: '' name: since in: query - schema: type: string description: '' title: date_range required: false description: '' name: date_range in: query - schema: type: string description: '' title: date required: false description: '' name: date in: query tags: - Clinical x-permissions: - clinical-notes x-practice-access: '"share_patients" need to be set for data access among practice' security: - drchrono_oauth2: - clinical:read - clinical:write operationId: clinical_notes_list /api/eligibility_checks_list: post: responses: '201': content: application/json: schema: properties: status: type: string description: Status of the request. Upon creation this will be "In progress" title: status uuid: type: string description: UUID of the batch of patients. title: uuid description: type: string description: Contains link to load the batch by UUID description: Created '404': content: {} description: Not Found '403': content: {} description: Permission Denied '401': content: {} description: Unauthorized '400': content: {} description: Bad Request '500': content: {} description: Internal Server Error parameters: - schema: type: string title: order_by required: false description: 'Order results by a specific field. Valid options include [id, updated_at]. Default: id.' name: order_by in: query - schema: type: integer title: Page size description: Number of results to return per page. Value between 1 and 1000. required: false name: page_size in: query - schema: type: integer title: page description: Number of page to return. Value between 1 and max number of pages in result set. required: false name: page in: query - schema: type: string title: since description: Inclusive lower bound on record updated/created time required: false name: since in: query - schema: type: integer title: patient description: Patient ID filter required: false name: patient in: query - schema: type: string title: appointment_date_range description: Inclusive bounded date range on appointment scheduled date required: false name: appointment_date_range in: query - schema: type: string title: appointment_date description: Filter on specific appointment scheduled date required: false name: appointment_date in: query - schema: type: string title: date_range description: Inclusive bounded date range on eligibility check date required: false name: query_date_range in: query - schema: type: string title: query_date description: Filter on specific eligibility check date required: false name: query_date in: query - schema: type: string title: service_types description: Filter for checks included within a comma-separated list of service type codes (STCs) required: false name: service_types in: query - schema: type: boolean title: verbose description: When True includes full coverage details required: false name: verbose in: query tags: - Clinical x-permissions: - clinical-notes x-practice-access: '"share_patients" need to be set for data access among practice' security: - drchrono_oauth2: - clinical:read - clinical:write operationId: eligibility_checks_list_create description: 'Create eligibility checks list request. Use the UUID returned in the response to retrieve the batch of records. Results returned in order of id or updated_at. ' /api/telehealth_appointment_history/{id}: get: responses: '200': content: application/json: schema: $ref: '#/components/schemas/TelemedicineAppointmentEventLog' description: OK '405': content: {} description: Method Not Allowed '404': content: {} description: Not Found '403': content: {} description: Permission Denied '401': content: {} description: Unauthorized '400': content: {} description: Bad Request '500': content: {} description: Internal Server Error parameters: - schema: type: string description: '' title: '' required: true name: id in: path - schema: type: integer description: '' title: doctor required: false description: '' name: doctor in: query tags: - Clinical x-permissions: - scheduling - clinical-notes x-practice-access: Data access among practice is available security: - drchrono_oauth2: - calendar:read - calendar:write - clinical:read - clinical:write operationId: telehealth_appointment_history_read /api/clinical_notes/{id}: get: responses: '200': content: application/json: schema: $ref: '#/components/schemas/ClinicalNote' description: OK '405': content: {} description: Method Not Allowed '404': content: {} description: Not Found '403': content: {} description: Permission Denied '401': content: {} description: Unauthorized '400': content: {} description: Bad Request '500': content: {} description: Internal Server Error parameters: - schema: type: string description: '' title: '' required: true name: id in: path - schema: type: integer description: '' title: patient required: false description: '' name: patient in: query - schema: type: integer description: '' title: office required: false description: '' name: office in: query - schema: type: integer description: '' title: doctor required: false description: '' name: doctor in: query - schema: type: string description: '' title: since required: false description: '' name: since in: query - schema: type: string description: '' title: date_range required: false description: '' name: date_range in: query - schema: type: string description: '' title: date required: false description: '' name: date in: query tags: - Clinical x-permissions: - clinical-notes x-practice-access: '"share_patients" need to be set for data access among practice' security: - drchrono_oauth2: - clinical:read - clinical:write operationId: clinical_notes_read /api/clinical_note_field_types: get: responses: '200': content: application/json: schema: title: '' type: object description: Paginated Result properties: previous: type: string description: Previous paginated page title: previous data: items: $ref: '#/components/schemas/SoapNoteLineItemFieldType' type: array description: result data title: data next: type: string description: Next Paginated page title: next description: OK '405': content: {} description: Method Not Allowed '404': content: {} description: Not Found '403': content: {} description: Permission Denied '401': content: {} description: Unauthorized '400': content: {} description: Bad Request '500': content: {} description: Internal Server Error parameters: - schema: type: string description: The pagination cursor value. title: Cursor required: false name: cursor in: query - schema: type: integer description: Number of results to return per page. title: Page size required: false name: page_size in: query - schema: type: integer description: '' title: clinical_note_template required: false description: '' name: clinical_note_template in: query - schema: type: integer description: '' title: doctor required: false description: '' name: doctor in: query tags: - Clinical x-permissions: - clinical-notes x-practice-access: '"share_clinical_templates" need to be set for data access among practice' security: - drchrono_oauth2: - clinical:read - clinical:write operationId: clinical_note_field_types_list description: Retrieve or search clinical note field types /api/documents: post: responses: '201': content: application/json: schema: $ref: '#/components/schemas/ScannedClinicalDocument' description: Created '405': content: {} description: Method Not Allowed '404': content: {} description: Not Found '403': content: {} description: Permission Denied '401': content: {} description: Unauthorized '400': content: {} description: Bad Request '500': content: {} description: Internal Server Error parameters: - schema: type: string description: '' title: since required: false description: '' name: since in: query - schema: type: integer description: '' title: patient required: false description: '' name: patient in: query - schema: type: integer description: '' title: doctor required: false description: '' name: doctor in: query tags: - Clinical x-permissions: - manage-patients x-practice-access: '"share_patients" need to be set for data access among practice' security: - drchrono_oauth2: - patients:read - patients:write operationId: documents_create description: Create documents get: responses: '200': content: application/json: schema: title: '' type: object description: Paginated Result properties: previous: type: string description: Previous paginated page title: previous data: items: $ref: '#/components/schemas/ScannedClinicalDocument' type: array description: result data title: data next: type: string description: Next Paginated page title: next description: OK '405': content: {} description: Method Not Allowed '404': content: {} description: Not Found '403': content: {} description: Permission Denied '401': content: {} description: Unauthorized '400': content: {} description: Bad Request '500': content: {} description: Internal Server Error parameters: - schema: type: string description: The pagination cursor value. title: Cursor required: false name: cursor in: query - schema: type: integer description: Number of results to return per page. title: Page size required: false name: page_size in: query - schema: type: string description: '' title: since required: false description: '' name: since in: query - schema: type: integer description: '' title: patient required: false description: '' name: patient in: query - schema: type: integer description: '' title: doctor required: false description: '' name: doctor in: query tags: - Clinical x-permissions: - manage-patients x-practice-access: '"share_patients" need to be set for data access among practice' security: - drchrono_oauth2: - patients:read - patients:write operationId: documents_list description: Retrieve or search documents /api/staff/{id}: get: responses: '200': content: application/json: schema: $ref: '#/components/schemas/Staff' description: OK '405': content: {} description: Method Not Allowed '404': content: {} description: Not Found '403': content: {} description: Permission Denied '401': content: {} description: Unauthorized '400': content: {} description: Bad Request '500': content: {} description: Internal Server Error parameters: - schema: type: string description: '' title: '' required: true name: id in: path - schema: type: integer description: '' title: doctor required: false description: '' name: doctor in: query tags: - Clinical x-permissions: [] x-practice-access: Data access among practice is available security: - drchrono_oauth2: [] operationId: staff_read /api/schedule_blocks/{id}: put: responses: '200': content: application/json: schema: $ref: '#/components/schemas/ScheduleBlock' description: OK - Schedule block updated '204': content: {} description: No Content - Schedule block updated (alternative response) '404': content: {} description: Not Found '403': content: {} description: Permission Denied '401': content: {} description: Unauthorized '400': content: {} description: Bad Request - Invalid data or missing required fields '500': content: {} description: Internal Server Error parameters: - schema: type: string description: '' title: '' description: Schedule block ID required: true name: id in: path tags: - Clinical description: Update an existing schedule block. Unlike PATCH, PUT requires all fields to be provided. Use this when you want to completely replace the schedule block data. x-permissions: - calendar summary: Update a schedule block requestBody: content: application/json: examples: fullUpdate: value: description: Early Lunch - Staff Training office: 200 color: '#16A085' start_time: '2024-03-15T11:00:00' exam_room: 1 end_time: '2024-03-15T12:30:00' provider: 100 summary: Complete update of schedule block schema: $ref: '#/components/schemas/ScheduleBlock' required: true security: - drchrono_oauth2: - calendar:read - calendar:write operationId: schedule_blocks_update patch: responses: '200': content: application/json: schema: $ref: '#/components/schemas/ScheduleBlock' description: OK - Schedule block updated '204': content: {} description: No Content - Schedule block updated (alternative response) '404': content: {} description: Not Found '403': content: {} description: Permission Denied '401': content: {} description: Unauthorized '400': content: {} description: Bad Request - Invalid data '500': content: {} description: Internal Server Error parameters: - schema: type: string description: '' title: '' description: Schedule block ID required: true name: id in: path tags: - Clinical description: Partially update an existing schedule block. You can modify the time, description, color, or other properties. Use this to reschedule a block or change its details. x-permissions: - calendar summary: Partially update a schedule block requestBody: content: application/json: examples: updateExamRoom: value: exam_room: 4 summary: Update exam room association updateTime: value: start_time: '2024-03-15T12:30:00' end_time: '2024-03-15T13:30:00' summary: Update schedule block time updateDescription: value: color: '#E74C3C' description: Extended Lunch Break - Team Building summary: Update schedule block description and color schema: $ref: '#/components/schemas/ScheduleBlock' required: true security: - drchrono_oauth2: - calendar:read - calendar:write operationId: schedule_blocks_partial_update get: responses: '200': content: application/json: schema: $ref: '#/components/schemas/ScheduleBlock' description: OK '404': content: {} description: Not Found '403': content: {} description: Permission Denied '500': content: {} description: Internal Server Error '401': content: {} description: Unauthorized parameters: - schema: type: string description: '' title: '' description: Schedule block ID required: true name: id in: path tags: - Clinical description: Retrieve an existing schedule block by ID x-permissions: - calendar summary: Retrieve a schedule block security: - drchrono_oauth2: - calendar:read - calendar:write operationId: schedule_blocks_read delete: responses: '500': content: {} description: Internal Server Error '404': content: {} description: Not Found '403': content: {} description: Permission Denied '204': content: {} description: No Content - Schedule block successfully deleted '401': content: {} description: Unauthorized parameters: - schema: type: string description: '' title: '' description: Schedule block ID required: true name: id in: path tags: - Clinical description: Delete an existing schedule block. This will remove the block from the provider's calendar and allow appointments to be scheduled during that time period again. x-permissions: - calendar summary: Delete a schedule block security: - drchrono_oauth2: - calendar:read - calendar:write operationId: schedule_blocks_delete /api/lab_orders_summary/{id}: get: responses: '200': content: application/json: schema: $ref: '#/components/schemas/LabOrder' description: OK '405': content: {} description: Method Not Allowed '404': content: {} description: Not Found '403': content: {} description: Permission Denied '401': content: {} description: Unauthorized '400': content: {} description: Bad Request '500': content: {} description: Internal Server Error parameters: - schema: type: string description: '' title: '' required: true name: id in: path - schema: type: string description: '' title: since required: false description: '' name: since in: query - schema: type: integer description: '' title: patient required: false description: '' name: patient in: query - schema: type: integer description: '' title: doctor required: false description: '' name: doctor in: query tags: - Clinical x-permissions: - clinical-notes x-practice-access: '"share_patients" need to be set for data access among practice' security: - drchrono_oauth2: - clinical:read - clinical:write operationId: lab_orders_summary_read /api/custom_demographics/{id}: put: responses: '204': content: {} description: No Content '405': content: {} description: Method Not Allowed '404': content: {} description: Not Found '403': content: {} description: Permission Denied '401': content: {} description: Unauthorized '400': content: {} description: Bad Request '500': content: {} description: Internal Server Error parameters: - schema: type: string description: '' title: '' required: true name: id in: path - schema: type: integer description: '' title: doctor required: false description: '' name: doctor in: query tags: - Clinical x-permissions: - manage-patients - settings x-practice-access: '"share_patients" need to be set for data access among practice' security: - drchrono_oauth2: - patients:read - patients:write - settings:read - settings:write operationId: custom_demographics_update description: Update an existing custom demographics field patch: responses: '204': content: {} description: No Content '405': content: {} description: Method Not Allowed '404': content: {} description: Not Found '403': content: {} description: Permission Denied '401': content: {} description: Unauthorized '400': content: {} description: Bad Request '500': content: {} description: Internal Server Error parameters: - schema: type: string description: '' title: '' required: true name: id in: path - schema: type: integer description: '' title: doctor required: false description: '' name: doctor in: query tags: - Clinical x-permissions: - manage-patients - settings x-practice-access: '"share_patients" need to be set for data access among practice' security: - drchrono_oauth2: - patients:read - patients:write - settings:read - settings:write operationId: custom_demographics_partial_update description: Update an existing custom demographics field get: responses: '200': content: application/json: schema: $ref: '#/components/schemas/CustomPatientFieldType' description: OK '405': content: {} description: Method Not Allowed '404': content: {} description: Not Found '403': content: {} description: Permission Denied '401': content: {} description: Unauthorized '400': content: {} description: Bad Request '500': content: {} description: Internal Server Error parameters: - schema: type: string description: '' title: '' required: true name: id in: path - schema: type: integer description: '' title: doctor required: false description: '' name: doctor in: query tags: - Clinical x-permissions: - manage-patients - settings x-practice-access: '"share_patients" need to be set for data access among practice' security: - drchrono_oauth2: - patients:read - patients:write - settings:read - settings:write operationId: custom_demographics_read description: Retrieve an existing custom demographics field /api/eobs/{id}: get: responses: '200': content: application/json: schema: $ref: '#/components/schemas/EOBObject' description: OK '405': content: {} description: Method Not Allowed '404': content: {} description: Not Found '403': content: {} description: Permission Denied '401': content: {} description: Unauthorized '400': content: {} description: Bad Request '500': content: {} description: Internal Server Error parameters: - schema: type: string description: '' title: '' required: true name: id in: path - schema: type: integer description: '' title: doctor required: false description: '' name: doctor in: query tags: - Clinical x-permissions: - billing - show-billing-tab x-practice-access: '"share_patients" need to be set for data access among practice' security: - drchrono_oauth2: - billing:read - billing:write operationId: eobs_read description: Retrieve an existing EOB object /api/allergies: post: responses: '201': content: application/json: schema: $ref: '#/components/schemas/PatientAllergy' description: Created '405': content: {} description: Method Not Allowed '404': content: {} description: Not Found '403': content: {} description: Permission Denied '401': content: {} description: Unauthorized '400': content: {} description: Bad Request '500': content: {} description: Internal Server Error parameters: - schema: type: integer description: '' title: patient required: false description: '' name: patient in: query - schema: type: integer description: '' title: doctor required: false description: '' name: doctor in: query tags: - Clinical x-permissions: - clinical-notes x-practice-access: '"share_patients" need to be set for data access among practice' security: - drchrono_oauth2: - clinical:read - clinical:write operationId: allergies_create description: Create patient allergy get: responses: '200': content: application/json: schema: title: '' type: object description: Paginated Result properties: previous: type: string description: Previous paginated page title: previous data: items: $ref: '#/components/schemas/PatientAllergy' type: array description: result data title: data next: type: string description: Next Paginated page title: next description: OK '405': content: {} description: Method Not Allowed '404': content: {} description: Not Found '403': content: {} description: Permission Denied '401': content: {} description: Unauthorized '400': content: {} description: Bad Request '500': content: {} description: Internal Server Error parameters: - schema: type: string description: The pagination cursor value. title: Cursor required: false name: cursor in: query - schema: type: integer description: Number of results to return per page. title: Page size required: false name: page_size in: query - schema: type: integer description: '' title: patient required: false description: '' name: patient in: query - schema: type: integer description: '' title: doctor required: false description: '' name: doctor in: query tags: - Clinical x-permissions: - clinical-notes x-practice-access: '"share_patients" need to be set for data access among practice' security: - drchrono_oauth2: - clinical:read - clinical:write operationId: allergies_list description: Retrieve or search patient allergies /api/appointments: post: responses: '201': content: application/json: schema: $ref: '#/components/schemas/Appointment' description: Created '403': content: {} description: Permission Denied '409': content: {} description: Scheduled time overlaps with an existing appointment '401': content: {} description: Unauthorized '400': content: {} description: Bad Request '500': content: {} description: Internal Server Error tags: - Clinical x-permissions: - scheduling - clinical-notes requestBody: content: application/json: schema: $ref: '#/components/schemas/Appointment' required: true x-practice-access: '"share_patients" need to be set for data access among practice' security: - drchrono_oauth2: - calendar:read - calendar:write - clinical:read - clinical:write operationId: appointments_create description: Create a new appointment or break on doctor's calendar get: responses: '200': content: application/json: schema: title: '' type: object description: Paginated Result properties: previous: type: string description: Previous paginated page title: previous data: items: $ref: '#/components/schemas/Appointment' type: array description: result data title: data next: type: string description: Next Paginated page title: next description: OK '403': content: {} description: Permission Denied '500': content: {} description: Internal Server Error '401': content: {} description: Unauthorized '400': content: {} description: Bad Request parameters: - schema: type: string description: The pagination cursor value. title: Cursor required: false name: cursor in: query - schema: minimum: 1 type: integer description: Number of results to return per page. maximum: 250 title: Page size required: false name: page_size in: query - schema: type: string description: '' title: status required: false description: Appointment status name name: status in: query - schema: type: integer description: '' title: patient required: false description: Patient ID name: patient in: query - schema: type: integer description: '' title: office required: false description: Office ID name: office in: query - schema: type: integer description: '' title: doctor required: false description: Doctor ID name: doctor in: query - schema: type: string description: '' title: since required: false description: Lower bound inclusive date filter for appointment updated/created date name: since in: query - schema: type: string description: Filter appointments based on scheduled time title: occurred_since required: false description: Filter appointments based on scheduled time name: occurred_since in: query - schema: type: string description: '' title: date_range required: false description: 'Inclusive upper and lower bound filter for appointment scheduled date. Format: yyyy-mm-dd/yyyy-mm-dd. Max window size 190 days' name: date_range in: query - schema: type: boolean description: '' title: verbose required: false description: set to `true` to include clinical_note, custom_fields, custom_vitals, extended_updated_at, reminders, status_transitions, vitals but limit page_size to 25 name: verbose in: query - schema: type: string description: '' title: date required: false description: Specific date filter for appointment scheduled date name: date in: query - schema: type: boolean description: Do not include virtual appointments that have not yet been materialized. This is useful when you need to get a list of appointments that are materialized and ready to be used. title: ignore_virtual required: false description: set to `true` to ignore virtual appointments that have not yet been materialized name: ignore_virtual in: query - schema: type: boolean description: Include archived or deleted appointments in the response title: show_archived required: false description: set to `true` or `1` to include deleted or archived appointments name: show_archived in: query tags: - Clinical x-permissions: - scheduling - clinical-notes x-practice-access: '"share_patients" need to be set for data access among practice' security: - drchrono_oauth2: - calendar:read - calendar:write - clinical:read - clinical:write operationId: appointments_list description: "Retrieve or search appointment or breaks.\nNote: Either `since`, `occurred_since`, `date` or `date_range` parameter must be specified.\n results returned in order of scheduled date.\n " /api/clinical_note_templates: get: responses: '200': content: application/json: schema: title: '' type: object description: Paginated Result properties: previous: type: string description: Previous paginated page title: previous data: items: $ref: '#/components/schemas/SoapNoteCustomReport' type: array description: result data title: data next: type: string description: Next Paginated page title: next description: OK '405': content: {} description: Method Not Allowed '404': content: {} description: Not Found '403': content: {} description: Permission Denied '401': content: {} description: Unauthorized '400': content: {} description: Bad Request '500': content: {} description: Internal Server Error parameters: - schema: type: string description: The pagination cursor value. title: Cursor required: false name: cursor in: query - schema: type: integer description: Number of results to return per page. title: Page size required: false name: page_size in: query - schema: type: integer description: '' title: doctor required: false description: '' name: doctor in: query tags: - Clinical x-permissions: - clinical-notes x-practice-access: '"share_clinical_templates" need to be set for data access among practice' security: - drchrono_oauth2: - clinical:read - clinical:write operationId: clinical_note_templates_list description: Retrieve or search clinical note templates /api/reminder_profiles: post: responses: '201': content: application/json: schema: $ref: '#/components/schemas/ReminderProfile' description: Created '405': content: {} description: Method Not Allowed '404': content: {} description: Not Found '403': content: {} description: Permission Denied '401': content: {} description: Unauthorized '400': content: {} description: Bad Request '500': content: {} description: Internal Server Error parameters: - schema: type: integer description: '' title: doctor required: false description: '' name: doctor in: query tags: - Clinical x-permissions: - scheduling x-practice-access: '"share_reminder_profile" need to be set for data access among practice' security: - drchrono_oauth2: - calendar:read - calendar:write operationId: reminder_profiles_create description: Create reminder profile get: responses: '200': content: application/json: schema: title: '' type: object description: Paginated Result properties: previous: type: string description: Previous paginated page title: previous data: items: $ref: '#/components/schemas/ReminderProfile' type: array description: result data title: data next: type: string description: Next Paginated page title: next description: OK '405': content: {} description: Method Not Allowed '404': content: {} description: Not Found '403': content: {} description: Permission Denied '401': content: {} description: Unauthorized '400': content: {} description: Bad Request '500': content: {} description: Internal Server Error parameters: - schema: type: string description: The pagination cursor value. title: Cursor required: false name: cursor in: query - schema: type: integer description: Number of results to return per page. title: Page size required: false name: page_size in: query - schema: type: integer description: '' title: doctor required: false description: '' name: doctor in: query tags: - Clinical x-permissions: - scheduling x-practice-access: '"share_reminder_profile" need to be set for data access among practice' security: - drchrono_oauth2: - calendar:read - calendar:write operationId: reminder_profiles_list description: Retrieve or search reminder profiles /api/appointment_templates: post: responses: '201': content: application/json: schema: $ref: '#/components/schemas/AppointmentTemplate' description: Created '405': content: {} description: Method Not Allowed '404': content: {} description: Not Found '403': content: {} description: Permission Denied '401': content: {} description: Unauthorized '400': content: {} description: Bad Request '500': content: {} description: Internal Server Error parameters: - schema: type: integer description: '' title: profile required: false description: '' name: profile in: query - schema: type: integer description: '' title: office required: false description: '' name: office in: query - schema: type: integer description: '' title: doctor required: false description: '' name: doctor in: query tags: - Clinical x-permissions: - scheduling - settings x-practice-access: '"share_appointment_profiles" need to be set for data access among practice' security: - drchrono_oauth2: - calendar:read - calendar:write - settings:read - settings:write operationId: appointment_templates_create description: Create appointment templates for a doctor's calendar get: responses: '200': content: application/json: schema: title: '' type: object description: Paginated Result properties: previous: type: string description: Previous paginated page title: previous data: items: $ref: '#/components/schemas/AppointmentTemplate' type: array description: result data title: data next: type: string description: Next Paginated page title: next description: OK '405': content: {} description: Method Not Allowed '404': content: {} description: Not Found '403': content: {} description: Permission Denied '401': content: {} description: Unauthorized '400': content: {} description: Bad Request '500': content: {} description: Internal Server Error parameters: - schema: type: string description: 'The date for which the template is available. The week day will be set to the week day of the date specified. Format: yyyy-mm-dd' title: Available required: false name: available in: query - schema: items: type: integer description: '' title: '' type: array description: Array of integers that indicate week days in ISO Format (`0` = Monday, ..., `6` = Sunday) title: Week days required: false name: week_days in: query - schema: type: string description: The pagination cursor value. title: Cursor required: false name: cursor in: query - schema: type: integer description: Number of results to return per page. title: Page size required: false name: page_size in: query - schema: type: integer description: '' title: profile required: false description: '' name: profile in: query - schema: type: integer description: '' title: office required: false description: '' name: office in: query - schema: type: integer description: '' title: doctor required: false description: '' name: doctor in: query tags: - Clinical x-permissions: - scheduling - settings x-practice-access: '"share_appointment_profiles" need to be set for data access among practice' security: - drchrono_oauth2: - calendar:read - calendar:write - settings:read - settings:write operationId: appointment_templates_list description: Retrieve or search appointment templates for a doctor's calendar /api/patient_vaccine_records: post: responses: '201': content: application/json: schema: $ref: '#/components/schemas/PatientVaccineRecord' description: Created '405': content: {} description: Method Not Allowed '404': content: {} description: Not Found '403': content: {} description: Permission Denied '401': content: {} description: Unauthorized '400': content: {} description: Bad Request '500': content: {} description: Internal Server Error parameters: - schema: type: string description: '' title: cvx_code required: false description: '' name: cvx_code in: query - schema: type: integer description: '' title: patient required: false description: '' name: patient in: query - schema: type: string description: '' title: since required: false description: '' name: since in: query - schema: type: integer description: '' title: doctor required: false description: '' name: doctor in: query tags: - Clinical x-permissions: - clinical-notes x-practice-access: '"share_inventory", "share_patients" need to be set for data access among practice' security: - drchrono_oauth2: - clinical:read - clinical:write operationId: patient_vaccine_records_create description: Create patient vaccine records get: responses: '200': content: application/json: schema: title: '' type: object description: Paginated Result properties: previous: type: string description: Previous paginated page title: previous data: items: $ref: '#/components/schemas/PatientVaccineRecord' type: array description: result data title: data next: type: string description: Next Paginated page title: next description: OK '405': content: {} description: Method Not Allowed '404': content: {} description: Not Found '403': content: {} description: Permission Denied '401': content: {} description: Unauthorized '400': content: {} description: Bad Request '500': content: {} description: Internal Server Error parameters: - schema: type: string description: The pagination cursor value. title: Cursor required: false name: cursor in: query - schema: type: integer description: Number of results to return per page. title: Page size required: false name: page_size in: query - schema: type: string description: '' title: cvx_code required: false description: '' name: cvx_code in: query - schema: type: integer description: '' title: patient required: false description: '' name: patient in: query - schema: type: string description: '' title: since required: false description: '' name: since in: query - schema: type: integer description: '' title: doctor required: false description: '' name: doctor in: query tags: - Clinical x-permissions: - clinical-notes x-practice-access: '"share_inventory", "share_patients" need to be set for data access among practice' security: - drchrono_oauth2: - clinical:read - clinical:write operationId: patient_vaccine_records_list description: Retrieve or search patient vaccine records /api/telehealth_appointments/{id}: put: responses: '204': content: {} description: No Content '405': content: {} description: Method Not Allowed '404': content: {} description: Not Found '403': content: {} description: Permission Denied '401': content: {} description: Unauthorized '400': content: {} description: Bad Request '500': content: {} description: Internal Server Error parameters: - schema: type: string description: '' title: '' required: true name: id in: path - schema: type: integer description: '' title: appointment required: false description: '' name: appointment in: query - schema: type: integer description: '' title: doctor required: false description: '' name: doctor in: query tags: - Clinical x-permissions: - scheduling - clinical-notes x-practice-access: '"share_patients" need to be set for data access among practice' security: - drchrono_oauth2: - calendar:read - calendar:write - clinical:read - clinical:write operationId: telehealth_appointments_update patch: responses: '204': content: {} description: No Content '405': content: {} description: Method Not Allowed '404': content: {} description: Not Found '403': content: {} description: Permission Denied '401': content: {} description: Unauthorized '400': content: {} description: Bad Request '500': content: {} description: Internal Server Error parameters: - schema: type: string description: '' title: '' required: true name: id in: path - schema: type: integer description: '' title: appointment required: false description: '' name: appointment in: query - schema: type: integer description: '' title: doctor required: false description: '' name: doctor in: query tags: - Clinical x-permissions: - scheduling - clinical-notes x-practice-access: '"share_patients" need to be set for data access among practice' security: - drchrono_oauth2: - calendar:read - calendar:write - clinical:read - clinical:write operationId: telehealth_appointments_partial_update get: responses: '200': content: application/json: schema: $ref: '#/components/schemas/TelemedicineAppointment' description: OK '405': content: {} description: Method Not Allowed '404': content: {} description: Not Found '403': content: {} description: Permission Denied '401': content: {} description: Unauthorized '400': content: {} description: Bad Request '500': content: {} description: Internal Server Error parameters: - schema: type: string description: '' title: '' required: true name: id in: path - schema: type: integer description: '' title: appointment required: false description: '' name: appointment in: query - schema: type: integer description: '' title: doctor required: false description: '' name: doctor in: query tags: - Clinical x-permissions: - scheduling - clinical-notes x-practice-access: '"share_patients" need to be set for data access among practice' security: - drchrono_oauth2: - calendar:read - calendar:write - clinical:read - clinical:write operationId: telehealth_appointments_read /api/prescription_messages: get: responses: '200': content: application/json: schema: title: '' type: object description: Paginated Result properties: previous: type: string description: Previous paginated page title: previous data: items: $ref: '#/components/schemas/PrescriptionMessage' type: array description: result data title: data next: type: string description: Next Paginated page title: next description: OK '405': content: {} description: Method Not Allowed '404': content: {} description: Not Found '403': content: {} description: Permission Denied '401': content: {} description: Unauthorized '400': content: {} description: Bad Request '500': content: {} description: Internal Server Error parameters: - schema: type: string description: The pagination cursor value. title: Cursor required: false name: cursor in: query - schema: type: integer description: Number of results to return per page. title: Page size required: false name: page_size in: query - schema: type: integer description: '' title: parent_message required: false description: '' name: parent_message in: query - schema: type: string description: '' title: since required: false description: '' name: since in: query - schema: type: integer description: '' title: patient required: false description: '' name: patient in: query - schema: type: string description: created_at filter in format YYYY-MM-DD title: created_at required: false description: '' name: created_at in: query - schema: type: integer description: '' title: doctor required: false description: '' name: doctor in: query tags: - Clinical x-permissions: - clinical-notes x-practice-access: '"share_patients" need to be set for data access among practice' security: - drchrono_oauth2: - clinical:read - clinical:write operationId: prescription_messages_list description: Retrieve or search prescription messages /api/sublabs: post: responses: '201': content: application/json: schema: $ref: '#/components/schemas/LabVendorLocation' description: Created '405': content: {} description: Method Not Allowed '404': content: {} description: Not Found '403': content: {} description: Permission Denied '401': content: {} description: Unauthorized '400': content: {} description: Bad Request '500': content: {} description: Internal Server Error tags: - Clinical x-permissions: [] x-practice-access: Data access among practice is available security: - drchrono_oauth2: - labs:read - labs:write operationId: sublabs_create description: 'Create 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 document PDF via `/api/lab_documents` and submit the results data via `/api/lab_results` - Update `/api/lab_orders` status ' get: responses: '200': content: application/json: schema: title: '' type: object description: Paginated Result properties: previous: type: string description: Previous paginated page title: previous data: items: $ref: '#/components/schemas/LabVendorLocation' type: array description: result data title: data next: type: string description: Next Paginated page title: next description: OK '405': content: {} description: Method Not Allowed '404': content: {} description: Not Found '403': content: {} description: Permission Denied '401': content: {} description: Unauthorized '400': content: {} description: Bad Request '500': content: {} description: Internal Server Error parameters: - schema: type: string description: The pagination cursor value. title: Cursor required: false name: cursor in: query - schema: type: integer description: Number of results to return per page. title: Page size required: false name: page_size in: query tags: - Clinical x-permissions: [] x-practice-access: Data access among practice is available security: - drchrono_oauth2: - labs:read - labs:write operationId: sublabs_list description: Retrieve or search sub vendors components: schemas: SoapNoteCustomReport: required: [] type: object properties: archived: readOnly: true type: boolean description: Indicates that the doctor has soft-deleted this template, and will not use it for future appointments title: Archived workflow_key: readOnly: true type: string description: Identifier for this template. If it's a workflow form, it will be one of `"hp_cc_history_present_illness"`, `"hp_med_fam_social_history"`, `"hp_review_of_systems"`, `"hp_physical_exam"`, `"hp_assessment"`, `"hp_plan"`, `"hp_meds_allergies"`, `"soap_subjective"`, `"soap_objective"`, `"soap_assessment"`, `"soap_plan"`, `"onpatient_additional_info"`, or `"onpatient_reasons_for_visit"`. Otherwise, it will be `"custom_{id}".` title: Workflow Key name: type: string description: '' title: Name doctor: readOnly: true type: string description: '' title: Doctor updated_at: readOnly: true type: string description: '' title: Updated at is_persistent: type: boolean description: If this is true, this report will be the same across all notes title: Is persistent clinical_note_fields: items: title: Clinical Note Field type: object description: Array of field objects properties: archived: type: boolean description: Indicates that the field has been soft-deleted by the doctor title: Archived name: type: string description: '' title: Name data_type: type: string description: One of `""`, `"Checkbox"`, `"NullCheckbox"`, `"String"`, `"TwoStrings"`, `"FreeDraw"`, `"Photo"`, `"Header"`, `"Subheader"` title: Data Type required: type: boolean description: Indicates that a note should not be locked unless a value is provided for this field title: Required allowed_values: items: type: string description: '' title: '' type: array description: '' title: Allowed Values clinical_note_template: type: integer description: '' title: Clinical Note Template type: array description: clinical note fields title: Clinical Note Fields is_onpatient: type: boolean description: '' title: Is onpatient order: title: SoapNoteCustomReport type: object description: Order of templates properties: on_complete_note: type: integer description: Order of the template on complete notes title: On complete note on_ipad: type: integer description: Order of the template on iPad title: On ipad id: readOnly: true type: integer description: '' title: ID x-verbose-required: - clinical_note_fields AppointmentProfile: x-verbose-required: [] required: - name - color - online_scheduling type: object description: Appointment profiles are for common kinds of appointments a doctor might have, such as "physical exam", which have a standard duration and should show up as the same color on the calendar. properties: archived: readOnly: true type: boolean description: Indicates that the object has been soft-deleted and should not be used title: Archived name: type: string description: '' title: Name doctor: type: integer description: '' title: Doctor color: type: string description: '' title: Color reason: type: string description: '' title: Reason sort_order: type: integer description: Override the usual ordering ordering of appointments in the patient's appointments page. Lower values are shown at the top title: Sort order duration: type: integer description: Length of an appointment in minutes title: Duration id: readOnly: true type: integer description: '' title: ID online_scheduling: type: boolean description: Whether this profile should be available for online scheduling title: Online scheduling PatientAmendment: required: - patient - doctor - amendment_name - amendment_file type: object properties: amendment_name: type: string description: '' title: Amendment name appointment: type: integer description: ID of the appointment to which the amendment applies, if any. If present, the `amendment_file` will be appended to the clinical note for this appointment. title: Appointment doctor: type: integer description: ID of the doctor who owns the amendment title: Doctor comments: type: string description: '' title: Comments amendment_file: type: string description: A PDF file containing the amended information for the patient's record title: Amendment file patient: type: integer description: ID of the patient to whom the amendment applies title: Patient id: readOnly: true type: integer description: '' title: ID x-verbose-required: [] ReminderProfile: required: - doctor - reminders type: object properties: reminders: items: title: ReminderTemplate type: object description: Array of reminders properties: amount: type: integer description: '' title: Amount type: enum: - email - sms - phone - auto_call type: string description: One of `"email"`, `"sms"` or `"auto_call"` title: Type unit: enum: - minutes - hours - days - weeks type: string description: One of `"email"`, `"sms"` or `"auto_call"` title: Unit type: array description: Reminders set in the profile title: Reminders id: readOnly: true type: integer description: '' title: ID name: type: string description: '' title: Name doctor: type: integer description: Doctor who created the profile. Other doctors in the practice group may have access to their profiles title: Doctor x-verbose-required: [] Patient: required: - gender - doctor type: object properties: medication_history_consent: type: string description: '' title: Medication history consent last_name: type: string description: '' title: Last name emergency_contact_phone: type: string description: '' title: Emergency contact phone primary_care_physician: type: string description: Referring doctor for this patient title: Primary care physician date_of_first_appointment: type: string description: Date of first patient visit. title: Date of first appointment tertiary_insurance: title: TertiaryInsurance type: object description: '**Warning:** Changing insurance information may make past appointments unbillable. Insurance data is also **unvalidated**; you should use the [`/api/insurances`](#apiinsurances) endpoint to find the appropriate insurance payer.' properties: insurance_group_name: type: string description: '' title: Insurance group name insurance_id_number: type: string description: '' title: Insurance id number insurance_claim_office_number: type: string description: Insurance office phone number title: Insurance claim office number subscriber_address: type: string description: '' title: Subscriber address subscriber_state: enum: - AL - AK - AS - AZ - AR - AA - AE - AP - CA - CO - CT - DE - DC - FL - GA - GU - HI - ID - IL - IN - IA - KS - KY - LA - ME - MD - MA - MI - MN - MS - MO - MT - NE - NV - NH - NJ - NM - NY - NC - ND - MP - OH - OK - OR - PA - PR - RI - SC - SD - TN - TX - UT - VT - VI - VA - WA - WV - WI - WY type: string description: Two-letter state code title: Subscriber state subscriber_social_security: type: string description: '' title: Subscriber social security photo_front: type: string description: Photo of front of insurance card title: Photo front subscriber_last_name: type: string description: '' title: Subscriber last name subscriber_middle_name: type: string description: '' title: Subscriber middle name subscriber_date_of_birth: type: string description: '' title: Subscriber date of birth insurance_company: type: string description: '' title: Insurance company is_subscriber_the_patient: type: boolean description: True if the insurance policy is under patient's own name. Defaults to true title: Is subscriber the patient insurance_plan_name: type: string description: Name of insurance plan. title: Insurance plan name patient_relationship_to_subscriber: enum: - '' - '01' - '04' - '05' - '07' - '10' - '15' - '17' - '19' - '20' - '21' - '22' - '23' - '24' - '29' - '32' - '33' - '36' - '39' - '40' - '41' - '43' - '53' - '76' - G8 type: string description: HCFA/1500 individual relationship code title: Patient relationship to subscriber subscriber_gender: enum: - '' - Male - Female - Other - UNK - ASKU type: string description: One of `"Male"` or `"Female"` title: Subscriber gender photo_back: type: string description: Photo of back of insurance card title: Photo back subscriber_suffix: type: string description: E.g. `"II"` or `"III"` title: Subscriber suffix subscriber_zip_code: type: string description: '' title: Subscriber zip code subscriber_city: type: string description: '' title: Subscriber city insurance_plan_type: enum: - '' - AM - BL - CH - CI - '17' - DS - '14' - FI - HM - '16' - '15' - LM - MC - MA - MB - ZZ - OF - '11' - '13' - '12' - TV - VA - WC type: string description: '' title: Insurance plan type insurance_payer_id: type: string description: '' title: Insurance payer id subscriber_country: enum: - '' - AF - AX - AL - DZ - AS - AD - AO - AI - AQ - AG - AR - AM - AW - AU - AT - AZ - BS - BH - BD - BB - BY - BE - BZ - BJ - BM - BT - BO - BQ - BA - BW - BV - BR - IO - BN - BG - BF - BI - KH - CM - CA - CV - KY - CF - TD - CL - CN - CX - CC - CO - KM - CG - CD - CK - CR - CI - HR - CU - CW - CY - CZ - CYM - DK - DJ - DM - DO - EC - EG - SV - GQ - ER - EE - ET - FK - FO - FJ - FI - FR - GF - PF - TF - GA - GM - GE - DE - GH - GI - GR - GL - GD - GP - GU - GT - GG - GN - GW - GY - HT - HM - VA - HN - HK - HU - IS - IN - ID - IR - IQ - IE - IM - IL - IT - JM - JP - JE - JO - KZ - KE - KI - KP - KR - XK - KW - KG - LA - LV - LB - LS - LR - LY - LI - LT - LU - MO - MK - MG - MW - MY - MV - ML - MT - MH - MQ - MR - MU - YT - MX - FM - MD - MC - MN - ME - MS - MA - MZ - MM - NA - NR - NP - NL - NC - NZ - NI - NE - NG - NU - NF - MP - 'NO' - OM - PK - PW - PS - PA - PG - PY - PE - PH - PN - PL - PT - PR - QA - RE - RO - RU - RW - BL - SH - KN - LC - MF - PM - VC - WS - SM - ST - SA - SN - RS - SC - SL - SG - SX - SK - SI - SB - SO - ZA - GS - SS - ES - LK - SD - SR - SJ - SZ - SE - CH - SY - TW - TJ - TZ - TH - TL - TG - TK - TO - TT - TN - TR - TM - TC - TV - UG - UA - AE - GB - US - UM - UY - UZ - VU - VE - VN - VG - VI - WF - EH - YE - ZM - ZW type: string description: Two-letter country code title: Subscriber country subscriber_first_name: type: string description: '' title: Subscriber first name insurance_group_number: type: string description: '' title: Insurance group number patient_flags_attached: items: title: PatientFlag type: object description: Array of patient flag objects properties: archived: readOnly: true type: boolean description: '' title: Archived flag_text: type: string description: Description of the patient flag title: Flag text created_at: readOnly: true type: string description: '' title: Created at flag_type: type: integer description: ID of the associated `/api/patient_flag_types` object title: Flag type updated_at: readOnly: true type: string description: '' title: Updated at id: readOnly: true type: integer description: '' title: ID type: array description: Patient flags attached to the patient title: Patient flags attached updated_at: readOnly: true type: string description: '' title: Updated at custom_demographics: items: title: CustomPatientFieldValue type: object description: Custom demographic values the patient has properties: field_type: type: integer description: ID of the `/api/custom_demographics` object title: Field type updated_at: readOnly: true type: string description: '' title: Updated at value: type: string description: '' title: Value type: array description: '' title: Custom demographics referring_source: type: string description: Referring source. title: Referring source responsible_party_relation: type: string description: '' title: Responsible party relation zip_code: type: string description: '' title: Zip code id: readOnly: true type: integer description: '' title: ID employer_city: type: string description: '' title: Employer city employer_state: type: string description: Two-letter abbreviation title: Employer state city: type: string description: '' title: City first_name: type: string description: '' title: First name middle_name: type: string description: '' title: Middle name doctor: type: integer description: '' title: Doctor race_subcategories: items: title: RaceSubcategories type: object description: '' properties: code: type: string description: '' title: Code description: type: string description: '' title: Description type: array description: '' title: Race subcategories disable_sms_messages: type: boolean description: 'If True, suppress SMS/Txt messages to this patient even if we have a cell phone # for them.' title: Disable sms messages employer: type: string description: '' title: Employer preferred_language_description: readOnly: true type: string description: '' title: Preferred language description patient_flags: items: title: PatientFlagType type: object description: Array of patien flag type objects properties: archived: readOnly: true type: boolean description: '' title: Archived name: type: string description: '' title: Name doctor: type: integer description: ID of doctor who owns the flag title: Doctor color: type: string description: '' title: Color created_at: readOnly: true type: string description: '' title: Created at updated_at: readOnly: true type: string description: '' title: Updated at priority: type: integer description: '' title: Priority id: readOnly: true type: integer description: '' title: ID readOnly: true type: array description: Possible patient flag type that can be attached to the patient title: Patient flags date_of_birth: type: string description: '' title: Date of birth ethnicity: enum: - blank - hispanic - not_hispanic - declined type: string description: One of `"blank"`, `"hispanic"`, `"not_hispanic"` or `"declined"` title: Ethnicity home_phone: type: string description: '' title: Home phone pronouns: enum: - '' - LA29518-0 - LA29519-8 - LA29520-6 - LA29523-0 - LA29521-4 - LA29515-6 - LA29516-4 - LA29517-2 - LA29522-2 - LA29524-8 type: string description: '' title: Pronouns patient_status: enum: - A - I - D type: string description: One of `"A"` (active), `"I"` (inactive), `"D"` (inactive-deceased) title: Patient status patient_photo_date: type: string description: Cannot be passed without `patient_photo` title: Patient photo date gender_identity_description: readOnly: true type: string description: '' title: Gender Identity description email: type: string description: '' title: Email responsible_party_email: type: string description: '' title: Responsible party email patient_photo: type: string description: '' title: Patient photo responsible_party_phone: type: string description: '' title: Responsible party phone state: type: string description: Two-letter abbreviation title: State secondary_insurance: title: SecondaryInsurance type: object description: '**Warning:** Changing insurance information may make past appointments unbillable. Insurance data is also **unvalidated**; you should use the [`/api/insurances`](#apiinsurances) endpoint to find the appropriate insurance payer.' properties: insurance_group_name: type: string description: '' title: Insurance group name insurance_id_number: type: string description: '' title: Insurance id number insurance_claim_office_number: type: string description: Insurance office phone number title: Insurance claim office number subscriber_address: type: string description: '' title: Subscriber address subscriber_state: enum: - AL - AK - AS - AZ - AR - AA - AE - AP - CA - CO - CT - DE - DC - FL - GA - GU - HI - ID - IL - IN - IA - KS - KY - LA - ME - MD - MA - MI - MN - MS - MO - MT - NE - NV - NH - NJ - NM - NY - NC - ND - MP - OH - OK - OR - PA - PR - RI - SC - SD - TN - TX - UT - VT - VI - VA - WA - WV - WI - WY type: string description: Two-letter state code title: Subscriber state subscriber_social_security: type: string description: '' title: Subscriber social security photo_front: type: string description: Photo of front of insurance card title: Photo front subscriber_last_name: type: string description: '' title: Subscriber last name subscriber_middle_name: type: string description: '' title: Subscriber middle name subscriber_date_of_birth: type: string description: '' title: Subscriber date of birth insurance_company: type: string description: '' title: Insurance company is_subscriber_the_patient: type: boolean description: True if the insurance policy is under patient's own name. Defaults to true title: Is subscriber the patient insurance_plan_name: type: string description: Name of insurance plan. title: Insurance plan name patient_relationship_to_subscriber: enum: - '' - '01' - '04' - '05' - '07' - '10' - '15' - '17' - '19' - '20' - '21' - '22' - '23' - '24' - '29' - '32' - '33' - '36' - '39' - '40' - '41' - '43' - '53' - '76' - G8 type: string description: HCFA/1500 individual relationship code title: Patient relationship to subscriber subscriber_gender: enum: - '' - Male - Female - Other - UNK - ASKU type: string description: One of `"Male"` or `"Female"` title: Subscriber gender photo_back: type: string description: Photo of back of insurance card title: Photo back subscriber_suffix: type: string description: E.g. `"II"` or `"III"` title: Subscriber suffix subscriber_zip_code: type: string description: '' title: Subscriber zip code subscriber_city: type: string description: '' title: Subscriber city insurance_plan_type: enum: - '' - AM - BL - CH - CI - '17' - DS - '14' - FI - HM - '16' - '15' - LM - MC - MA - MB - ZZ - OF - '11' - '13' - '12' - TV - VA - WC type: string description: '' title: Insurance plan type insurance_payer_id: type: string description: '' title: Insurance payer id subscriber_country: enum: - '' - AF - AX - AL - DZ - AS - AD - AO - AI - AQ - AG - AR - AM - AW - AU - AT - AZ - BS - BH - BD - BB - BY - BE - BZ - BJ - BM - BT - BO - BQ - BA - BW - BV - BR - IO - BN - BG - BF - BI - KH - CM - CA - CV - KY - CF - TD - CL - CN - CX - CC - CO - KM - CG - CD - CK - CR - CI - HR - CU - CW - CY - CZ - CYM - DK - DJ - DM - DO - EC - EG - SV - GQ - ER - EE - ET - FK - FO - FJ - FI - FR - GF - PF - TF - GA - GM - GE - DE - GH - GI - GR - GL - GD - GP - GU - GT - GG - GN - GW - GY - HT - HM - VA - HN - HK - HU - IS - IN - ID - IR - IQ - IE - IM - IL - IT - JM - JP - JE - JO - KZ - KE - KI - KP - KR - XK - KW - KG - LA - LV - LB - LS - LR - LY - LI - LT - LU - MO - MK - MG - MW - MY - MV - ML - MT - MH - MQ - MR - MU - YT - MX - FM - MD - MC - MN - ME - MS - MA - MZ - MM - NA - NR - NP - NL - NC - NZ - NI - NE - NG - NU - NF - MP - 'NO' - OM - PK - PW - PS - PA - PG - PY - PE - PH - PN - PL - PT - PR - QA - RE - RO - RU - RW - BL - SH - KN - LC - MF - PM - VC - WS - SM - ST - SA - SN - RS - SC - SL - SG - SX - SK - SI - SB - SO - ZA - GS - SS - ES - LK - SD - SR - SJ - SZ - SE - CH - SY - TW - TJ - TZ - TH - TL - TG - TK - TO - TT - TN - TR - TM - TC - TV - UG - UA - AE - GB - US - UM - UY - UZ - VU - VE - VN - VG - VI - WF - EH - YE - ZM - ZW type: string description: Two-letter country code title: Subscriber country subscriber_first_name: type: string description: '' title: Subscriber first name insurance_group_number: type: string description: '' title: Insurance group number date_of_last_appointment: type: string description: Date of previous patient visit title: Date of last appointment preferred_language_code: readOnly: true type: string description: '' title: Preferred language code patient_payment_profile: enum: - '' - Cash - Insurance - Insurance Out of Network - Auto Accident - Worker's Comp type: string description: One of `""`, `"Cash"`, `"Insurance"`, `"Insurance Out of Network"`, `"Auto Accident"` or `"Worker's Comp"`.
**Note:** Patient must already have either `primary_insurance` or `secondary_insurance` or new `primary_insurance` or `secondary_insurance` is passed in request if `Insurance`, `Auto Accident` or `Worker's Comp` payment profiles are chosen. title: Patient payment profile date_of_death: type: string description: Available when show_inactive is passed title: Date of death social_security_number: type: string description: '' title: Social security number auto_accident_insurance: title: AutoAccidentInsurance type: object description: '' properties: auto_accident_claim_rep_city: type: string description: '' title: Auto accident claim rep city auto_accident_claim_rep_state: enum: - AL - AK - AS - AZ - AR - AA - AE - AP - CA - CO - CT - DE - DC - FL - GA - GU - HI - ID - IL - IN - IA - KS - KY - LA - ME - MD - MA - MI - MN - MS - MO - MT - NE - NV - NH - NJ - NM - NY - NC - ND - MP - OH - OK - OR - PA - PR - RI - SC - SD - TN - TX - UT - VT - VI - VA - WA - WV - WI - WY type: string description: '' title: Auto accident claim rep state auto_accident_claim_rep_address: type: string description: '' title: Auto accident claim rep address auto_accident_will_require_therapy_rec: type: string description: '' title: Auto accident will require therapy rec auto_accident_subscriber_middle_name: type: string description: '' title: Auto accident subscriber middle name auto_accident_still_under_care: type: boolean description: Is patient still under your care for this condition? title: Auto accident still under care auto_accident_significant_injury_notes: type: string description: '' title: Auto accident significant injury notes auto_accident_subscriber_first_name: type: string description: '' title: Auto accident subscriber first name auto_accident_subscriber_address: type: string description: '' title: Auto accident subscriber address auto_accident_disabled_from_date: type: string description: Patient was disabled (unable to work) from title: Auto accident disabled from date auto_accident_company: type: string description: '' title: Auto accident company auto_accident_disabled_to_date: type: string description: Patient was disabled (unable to work) to title: Auto accident disabled to date auto_accident_similar_condition_date: type: string description: Date of same or similar condition title: Auto accident similar condition date auto_accident_case_number: type: string description: '' title: Auto accident case number auto_accident_claim_rep_is_insurer: type: boolean description: Is the insurer's claim representative the insurer? title: Auto accident claim rep is insurer auto_accident_payer_address: type: string description: '' title: Auto accident payer address auto_accident_subscriber_last_name: type: string description: '' title: Auto accident subscriber last name auto_accident_subscriber_social_security: type: string description: '' title: Auto accident subscriber social security auto_accident_subscriber_phone_number: type: string description: '' title: Auto accident subscriber phone number auto_accident_subscriber_city: type: string description: '' title: Auto accident subscriber city auto_accident_significant_injury: enum: - 'YES' - 'NO' - N\A type: string description: '' title: Auto accident significant injury auto_accident_similar_condition_notes: type: string description: '' title: Auto accident similar condition notes auto_accident_payer_id: type: string description: Auto Accident Payer ID title: Auto accident payer id auto_accident_payer_state: enum: - AL - AK - AS - AZ - AR - AA - AE - AP - CA - CO - CT - DE - DC - FL - GA - GU - HI - ID - IL - IN - IA - KS - KY - LA - ME - MD - MA - MI - MN - MS - MO - MT - NE - NV - NH - NJ - NM - NY - NC - ND - MP - OH - OK - OR - PA - PR - RI - SC - SD - TN - TX - UT - VT - VI - VA - WA - WV - WI - WY type: string description: '' title: Auto accident payer state auto_accident_subscriber_zip_code: type: string description: '' title: Auto accident subscriber zip code auto_accident_payer_zip: type: string description: '' title: Auto accident payer zip auto_accident_payer_city: type: string description: '' title: Auto accident payer city auto_accident_will_require_therapy: type: boolean description: Will the patient require rehabilitation and/or occupational therapy as a result of the injuries sustained in this accident? title: Auto accident will require therapy auto_accident_date_of_accident: type: string description: '' title: Auto accident date of accident auto_accident_subscriber_date_of_birth: type: string description: '' title: Auto accident subscriber date of birth auto_accident_subscriber_suffix: type: string description: '' title: Auto accident subscriber suffix auto_accident_subscriber_state: enum: - AL - AK - AS - AZ - AR - AA - AE - AP - CA - CO - CT - DE - DC - FL - GA - GU - HI - ID - IL - IN - IA - KS - KY - LA - ME - MD - MA - MI - MN - MS - MO - MT - NE - NV - NH - NJ - NM - NY - NC - ND - MP - OH - OK - OR - PA - PR - RI - SC - SD - TN - TX - UT - VT - VI - VA - WA - WV - WI - WY type: string description: '' title: Auto accident subscriber state auto_accident_return_to_work_date: type: string description: If still disabled, patient should be able to return to work on title: Auto accident return to work date auto_accident_notes: type: string description: '' title: Auto accident notes auto_accident_policy_number: type: string description: '' title: Auto accident policy number auto_accident_is_subscriber_the_patient: type: boolean description: True if the insurance policy is under patient's own name. title: Auto accident is subscriber the patient auto_accident_claim_rep_zip: type: string description: '' title: Auto accident claim rep zip auto_accident_state_of_occurrence: enum: - AL - AK - AS - AZ - AR - AA - AE - AP - CA - CO - CT - DE - DC - FL - GA - GU - HI - ID - IL - IN - IA - KS - KY - LA - ME - MD - MA - MI - MN - MS - MO - MT - NE - NV - NH - NJ - NM - NY - NC - ND - MP - OH - OK - OR - PA - PR - RI - SC - SD - TN - TX - UT - VT - VI - VA - WA - WV - WI - WY type: string description: '' title: Auto accident state of occurrence auto_accident_treatment_duration: type: string description: '' title: Auto accident treatment duration auto_accident_had_similar_condition: type: boolean description: Has the patient had same or similar condition? title: Auto accident had similar condition auto_accident_patient_relationship_to_subscriber: enum: - '' - '01' - '04' - '05' - '07' - '10' - '15' - '17' - '19' - '20' - '21' - '22' - '23' - '24' - '29' - '32' - '33' - '36' - '39' - '40' - '41' - '43' - '53' - '76' - G8 type: string description: '' title: Auto accident patient relationship to subscriber auto_accident_claim_rep_name: type: string description: '' title: Auto accident claim rep name address: type: string description: '' title: Address chart_id: type: string description: Automatically set using first & last name if absent title: Chart id referring_doctor: title: Patient type: object description: '' properties: fax: type: string description: Should follow format "xxx-xx-xxxx" title: Fax last_name: type: string description: '' title: Last name middle_name: type: string description: '' title: Middle name suffix: type: string description: '' title: Suffix first_name: type: string description: '' title: First name provider_number: type: string description: '' title: Provider number specialty: enum: - '' - Acupuncture - Advanced Practice Midwife - Aesthetic Medicine - Aesthetician - Allergist/Immunologist - Anesthesiologist - Cardiac Electrophysiologist - Cardiologist - Cardiothoracic Surgeon - Child/Adolescent Psychiatry - Chiropractor - Clinical Social Worker - Colorectal Surgeon - Correactology - Cosmetic Medicine - Counselor Mental Health - Counselor Professional - Counselor - Dentist - Diabetology - Dermatologist - Diagnostic Medical Sonographer - Dietitian, Registered - Ear-Nose-Throat Specialist (ENT) - Emergency Medicine Physician - Endocrinologist - Endodontist - Epidemiologist - Family Practitioner - Gastroenterologist - General Practice - General Surgeon - Geneticist - Geriatrician - Gerontologist - Gynecologist (no OB) - Gynegologic Oncologist - Hand Surgeon - Hematologist - Home Care - Hospice - Hospitalist - Infectious Disease Specialist - Integrative and Functional Medicine - Integrative Medicine - Internist - Interventional Radiology - Laboratory Medicine Specialist - Laser Surgery - Massage Therapist - Naturopathic Physician - Neonatologist - Nephrologist - Neurologist - Neuropsychology - Neurosurgeon - Not Actively Practicing - Nuclear Medicine Specialist - Nurse Practitioner - Nursing - Nutritionist - Obstetrician/Gynecologist - Occupational Medicine - Occupational Therapist - Oncologist - Ophthalmologist - Optometrist - Oral Surgeon - Orofacial Pain - Orthodontist - Orthopedic Surgeon - Orthotist - Other - Pain Management Specialist - Pathologist - Pediatric Dentist - Pediatric Gastroenterology - Pediatric Surgeon - Pediatrician - Perinatologist - Periodontist - Physical Medicine and Rehab Specialist - Physical Therapist - Physician Assistant - Plastic Surgeon - Podiatrist - Preventive-Aging Medicine - Preventive Medicine/Occupational-Environmental Medicine - Primary Care Physician - Prosthetist - Prosthodontist - Psychiatrist - Psychologist - Public Health Professional - Pulmonologist - Radiation Oncologist - Radiologist - Registered Nurse - Religious Nonmedical Practitioner - Reproductive Endocrinologist - Reproductive Medicine - Rheumatologist - Sleep Medicine - Speech-Language Pathologist - Sports Medicine Specialist - Urologist - Urgent Care - Vascular Surgeon type: string description: Can be one of following, `''`, `'Acupuncture'`, `'Advanced Practice Midwife'`, `'Aesthetic Medicine'`, `'Aesthetician'`, `'Allergist/Immunologist'`, `'Anesthesiologist'`, `'Cardiac Electrophysiologist'`, `'Cardiologist'`, `'Cardiothoracic Surgeon'`, `'Child/Adolescent Psychiatry'`, `'Chiropractor'`, `'Clinical Social Worker'`, `'Colorectal Surgeon'`, `'Correactology'`, `'Cosmetic Medicine'`, `'Counselor Mental Health'`, `'Counselor Professional'`, `'Counselor'`, `'Dentist'`, `'Diabetology'`, `'Dermatologist'`, `'Diagnostic Medical Sonographer'`, `'Dietitian, Registered'`, `'Ear-Nose-Throat Specialist (ENT)'`, `'Emergency Medicine Physician'`, `'Endocrinologist'`, `'Endodontist'`, `'Epidemiologist'`, `'Family Practitioner'`, `'Gastroenterologist'`, `'General Practice'`, `'General Surgeon'`, `'Geneticist'`, `'Geriatrician'`, `'Gerontologist'`, `'Gynecologist (no OB)'`, `'Gynegologic Oncologist'`, `'Hand Surgeon'`, `'Hematologist'`, `'Home Care'`, `'Hospice'`, `'Hospitalist'`, `'Infectious Disease Specialist'`, `'Integrative and Functional Medicine'`, `'Integrative Medicine'`, `'Internist'`, `'Interventional Radiology'`, `'Laboratory Medicine Specialist'`, `'Laser Surgery'`, `'Massage Therapist'`, `'Naturopathic Physician'`, `'Neonatologist'`, `'Nephrologist'`, `'Neurologist'`, `'Neuropsychology'`, `'Neurosurgeon'`, `'Not Actively Practicing'`, `'Nuclear Medicine Specialist'`, `'Nurse Practitioner'`, `'Nursing'`, `'Nutritionist'`, `'Obstetrician/Gynecologist'`, `'Occupational Medicine'`, `'Occupational Therapist'`, `'Oncologist'`, `'Ophthalmologist'`, `'Optometrist'`, `'Oral Surgeon'`, `'Orofacial Pain'`, `'Orthodontist'`, `'Orthopedic Surgeon'`, `'Orthotist'`, `'Other'`, `'Pain Management Specialist'`, `'Pathologist'`, `'Pediatric Dentist'`, `'Pediatric Gastroenterology'`, `'Pediatric Surgeon'`, `'Pediatrician'`, `'Perinatologist'`, `'Periodontist'`, `'Physical Medicine and Rehab Specialist'`, `'Physical Therapist'`, `'Physician Assistant'`, `'Plastic Surgeon'`, `'Podiatrist'`, `'Preventive-Aging Medicine'`, `'Preventive Medicine/Occupational-Environmental Medicine'`, `'Primary Care Physician'`, `'Prosthetist'`, `'Prosthodontist'`, `'Psychiatrist'`, `'Psychologist'`, `'Public Health Professional'`, `'Pulmonologist'`, `'Radiation Oncologist'`, `'Radiologist'`, `'Registered Nurse'`, `'Religious Nonmedical Practitioner'`, `'Reproductive Endocrinologist'`, `'Reproductive Medicine'`, `'Rheumatologist'`, `'Sleep Medicine'`, `'Speech-Language Pathologist'`, `'Sports Medicine Specialist'`, `'Urologist'`, `'Urgent Care'`, `'Vascular Surgeon'` title: Specialty provider_qualifier: enum: - '' - 0B - 1G - G2 type: string description: 'Can be one of following, `''''`, `''0B''`(State License #), `''1G''`(Provider UPIN #), `''G2''`(Provider Commercial #)' title: Provider qualifier phone: type: string description: Should follow format "xxx-xx-xxxx" title: Phone address: type: string description: '' title: Address npi: type: string description: '' title: Npi email: type: string description: '' title: Email primary_insurance: title: PrimaryInsurance type: object description: '**Warning:** Changing insurance information may make past appointments unbillable. Insurance data is also **unvalidated**; you should use the [`/api/insurances`](#apiinsurances) endpoint to find the appropriate insurance payer.' properties: insurance_group_name: type: string description: '' title: Insurance group name insurance_id_number: type: string description: '' title: Insurance id number insurance_claim_office_number: type: string description: Insurance office phone number title: Insurance claim office number subscriber_address: type: string description: '' title: Subscriber address subscriber_state: enum: - AL - AK - AS - AZ - AR - AA - AE - AP - CA - CO - CT - DE - DC - FL - GA - GU - HI - ID - IL - IN - IA - KS - KY - LA - ME - MD - MA - MI - MN - MS - MO - MT - NE - NV - NH - NJ - NM - NY - NC - ND - MP - OH - OK - OR - PA - PR - RI - SC - SD - TN - TX - UT - VT - VI - VA - WA - WV - WI - WY type: string description: Two-letter state code title: Subscriber state subscriber_social_security: type: string description: '' title: Subscriber social security photo_front: type: string description: Photo of front of insurance card title: Photo front subscriber_last_name: type: string description: '' title: Subscriber last name subscriber_middle_name: type: string description: '' title: Subscriber middle name subscriber_date_of_birth: type: string description: '' title: Subscriber date of birth insurance_company: type: string description: '' title: Insurance company is_subscriber_the_patient: type: boolean description: True if the insurance policy is under patient's own name. Defaults to true title: Is subscriber the patient insurance_plan_name: type: string description: Name of insurance plan. title: Insurance plan name patient_relationship_to_subscriber: enum: - '' - '01' - '04' - '05' - '07' - '10' - '15' - '17' - '19' - '20' - '21' - '22' - '23' - '24' - '29' - '32' - '33' - '36' - '39' - '40' - '41' - '43' - '53' - '76' - G8 type: string description: HCFA/1500 individual relationship code title: Patient relationship to subscriber subscriber_gender: enum: - '' - Male - Female - Other - UNK - ASKU type: string description: One of `"Male"` or `"Female"` title: Subscriber gender photo_back: type: string description: Photo of back of insurance card title: Photo back subscriber_suffix: type: string description: E.g. `"II"` or `"III"` title: Subscriber suffix subscriber_zip_code: type: string description: '' title: Subscriber zip code subscriber_city: type: string description: '' title: Subscriber city insurance_plan_type: enum: - '' - AM - BL - CH - CI - '17' - DS - '14' - FI - HM - '16' - '15' - LM - MC - MA - MB - ZZ - OF - '11' - '13' - '12' - TV - VA - WC type: string description: '' title: Insurance plan type insurance_payer_id: type: string description: '' title: Insurance payer id subscriber_country: enum: - '' - AF - AX - AL - DZ - AS - AD - AO - AI - AQ - AG - AR - AM - AW - AU - AT - AZ - BS - BH - BD - BB - BY - BE - BZ - BJ - BM - BT - BO - BQ - BA - BW - BV - BR - IO - BN - BG - BF - BI - KH - CM - CA - CV - KY - CF - TD - CL - CN - CX - CC - CO - KM - CG - CD - CK - CR - CI - HR - CU - CW - CY - CZ - CYM - DK - DJ - DM - DO - EC - EG - SV - GQ - ER - EE - ET - FK - FO - FJ - FI - FR - GF - PF - TF - GA - GM - GE - DE - GH - GI - GR - GL - GD - GP - GU - GT - GG - GN - GW - GY - HT - HM - VA - HN - HK - HU - IS - IN - ID - IR - IQ - IE - IM - IL - IT - JM - JP - JE - JO - KZ - KE - KI - KP - KR - XK - KW - KG - LA - LV - LB - LS - LR - LY - LI - LT - LU - MO - MK - MG - MW - MY - MV - ML - MT - MH - MQ - MR - MU - YT - MX - FM - MD - MC - MN - ME - MS - MA - MZ - MM - NA - NR - NP - NL - NC - NZ - NI - NE - NG - NU - NF - MP - 'NO' - OM - PK - PW - PS - PA - PG - PY - PE - PH - PN - PL - PT - PR - QA - RE - RO - RU - RW - BL - SH - KN - LC - MF - PM - VC - WS - SM - ST - SA - SN - RS - SC - SL - SG - SX - SK - SI - SB - SO - ZA - GS - SS - ES - LK - SD - SR - SJ - SZ - SE - CH - SY - TW - TJ - TZ - TH - TL - TG - TK - TO - TT - TN - TR - TM - TC - TV - UG - UA - AE - GB - US - UM - UY - UZ - VU - VE - VN - VG - VI - WF - EH - YE - ZM - ZW type: string description: Two-letter country code title: Subscriber country subscriber_first_name: type: string description: '' title: Subscriber first name insurance_group_number: type: string description: '' title: Insurance group number preferred_language: enum: - blank - eng - zho - fra - ita - jpn - por - rus - spa - other - unknown - declined type: string description: Use ISO 639 alpha-3 codes title: Preferred language responsible_party_name: type: string description: '' title: Responsible party name nick_name: type: string description: Common name for patient, should be used instead of first name if supplied. title: Nick name copay: type: string description: '' title: Copay created_at: readOnly: true type: string description: '' title: Created at emergency_contact_relation: type: string description: '' title: Emergency contact relation gender_identity_code: readOnly: true type: string description: '' title: Gender Identity code office_phone: type: string description: '' title: Office phone employer_address: type: string description: '' title: Employer address race: enum: - blank - indian - asian - black - hawaiian - white - other - declined type: string description: One of `"blank"`, `"indian"`, `"asian"`, `"black"`, `"hawaiian"`, `"white"` or `"declined"` title: Race offices: items: type: integer description: '' title: '' type: array description: IDs of every office this patient has been to title: Offices preferred_pharmacies: items: type: string description: '' title: '' enum: - - string type: array description: ncpdp id of patient's preferred pharmacies title: Preferred pharmacies emergency_contact_name: type: string description: '' title: Emergency contact name gender: enum: - '' - Male - Female - Other - UNK - ASKU type: string description: One of `"Male"`, `"Female"`, or `"Other"` title: Gender default_pharmacy: type: string description: ncpdp id of patient's default pharmacy title: Default pharmacy cell_phone: type: string description: '' title: Cell phone employer_zip_code: type: string description: '' title: Employer zip code workers_comp_insurance: title: WorkerCompInsurance type: object description: '' properties: workers_comp_payer_city: type: string description: '' title: Workers comp payer city workers_comp_payer_id: type: string description: '' title: Workers comp payer id workers_comp_group_name: type: string description: '' title: Workers comp group name workers_comp_wcb: type: string description: '' title: Workers comp wcb workers_comp_carrier_code: type: string description: '' title: Workers comp carrier code workers_comp_notes: type: string description: '' title: Workers comp notes property_and_casualty_agency_claim_number: type: string description: '' title: Property and casualty agency claim number workers_comp_state_of_occurrence: enum: - AL - AK - AS - AZ - AR - AA - AE - AP - CA - CO - CT - DE - DC - FL - GA - GU - HI - ID - IL - IN - IA - KS - KY - LA - ME - MD - MA - MI - MN - MS - MO - MT - NE - NV - NH - NJ - NM - NY - NC - ND - MP - OH - OK - OR - PA - PR - RI - SC - SD - TN - TX - UT - VT - VI - VA - WA - WV - WI - WY type: string description: '' title: Workers comp state of occurrence workers_comp_payer_zip: type: string description: '' title: Workers comp payer zip workers_comp_wcb_rating_code: type: string description: '' title: Workers comp wcb rating code workers_comp_case_number: type: string description: '' title: Workers comp case number workers_comp_group_number: type: string description: '' title: Workers comp group number workers_comp_company: type: string description: '' title: Workers comp company workers_comp_payer_address: type: string description: '' title: Workers comp payer address workers_comp_date_of_accident: type: string description: '' title: Workers comp date of accident workers_comp_payer_state: enum: - AL - AK - AS - AZ - AR - AA - AE - AP - CA - CO - CT - DE - DC - FL - GA - GU - HI - ID - IL - IN - IA - KS - KY - LA - ME - MD - MA - MI - MN - MS - MO - MT - NE - NV - NH - NJ - NM - NY - NC - ND - MP - OH - OK - OR - PA - PR - RI - SC - SD - TN - TX - UT - VT - VI - VA - WA - WV - WI - WY type: string description: '' title: Workers comp payer state x-verbose-required: - auto_accident_insurance - custom_demographics - patient_flags - patient_flags_attached - primary_insurance - referring_doctor - secondary_insurance - tertiary_insurance - workers_comp_insurance LabTest: required: - lab_order type: object properties: report_notes: type: string description: Notes which are not meant for labs, but are copied on the results. title: Report notes status: enum: - P - I - C - F - X type: string description: One of `"preliminary"`, `"pending"`, `"correction"`, `"final"` or `"canceled"`. Defaults to `"preliminary"` title: Status code: type: string description: '' title: Code description: type: string description: Short description of the ICD-10 code title: Description specimen_condition: type: string description: '' title: Specimen condition collection_date: type: string description: The date the specimen were collected title: Collection date internal_notes: type: string description: Notes which are meant for, and read by, the labs title: Internal notes specimen_total_volume: type: number description: '' title: Specimen total volume specimen_source: type: string description: '' title: Specimen source lab_order: type: integer description: ID of associated lab order title: Lab order id: readOnly: true type: integer description: '' title: ID name: type: string description: Name for the test title: Name x-verbose-required: [] DoctorFeeSchedule: required: [] type: object properties: code_type: enum: - CPT - HCPCS - Custom - ICD9 - ICD10 - Revenue type: string description: '' title: Code type insured_out_of_network_price: type: number description: '' title: Insured out of network price office: type: integer description: '' title: Office updated_at: readOnly: true type: string description: '' title: Updated at code: type: string description: '' title: Code billing_description: type: string description: '' title: Billing description id: readOnly: true type: integer description: '' title: ID picklist_category: type: string description: 'Optional: Category to organize the code into.' title: Picklist category allowed_amount: type: number description: Typical allowed amount for payer. Not used if blank. title: Allowed amount ndc_quantity: type: number description: '' title: NDC Quantity cash_price: type: number description: '' title: Cash price plan_name: type: string description: Name of insurance plan. title: Plan name description: type: string description: '' title: Description ndc_units: enum: - F2 - GR - ME - ML - UN type: string description: '' title: NDC Units ndc_code: type: string description: '' title: NDC Code payer_id: type: string description: Fee Schedule pricing specific to this payer, if null, then applies as default to all payers without a more specific fee schedule. title: Payer id cpt_hcpcs_modifier2: enum: - '' - '17' - 1D - '22' - '23' - '24' - '25' - '26' - '27' - '29' - '32' - '33' - '47' - '50' - '51' - '52' - '53' - '54' - '55' - '56' - '57' - '58' - '59' - '62' - '63' - '66' - '73' - '74' - '76' - '77' - '78' - '79' - '80' - '81' - '82' - '83' - '90' - '91' - '92' - '93' - '95' - '96' - '97' - '99' - A1 - A2 - A3 - A4 - A5 - A6 - A7 - A8 - A9 - AA - AB - AD - AE - AF - AG - AH - AI - AJ - AK - AM - AO - AP - AQ - AR - AS - AT - AU - AV - AW - AX - AY - AZ - BA - BL - BO - BP - BR - BU - CA - CB - CC - CD - CE - CF - CG - CH - CI - CJ - CK - CL - CM - CN - CO - CP - CQ - CR - CS - CT - DA - E1 - E2 - E3 - E4 - EA - EB - EC - ED - EE - EJ - EM - EP - ER - ET - EX - EY - F1 - F2 - F3 - F4 - F5 - F6 - F7 - F8 - F9 - FA - FB - FC - FS - FP - FQ - FR - FX - FY - G0 - G1 - G2 - G3 - G4 - G5 - G6 - G7 - G8 - G9 - GA - GB - GC - GD - GE - GF - GG - GH - GJ - GK - GL - GM - GN - GO - GP - GQ - GR - GS - GT - GU - GV - GW - GX - GY - GZ - H9 - HA - HB - HC - HD - HE - HF - HG - HH - HI - HJ - HK - HL - HM - HN - HO - HP - HQ - HR - HS - HT - HU - HV - HW - HX - HY - HZ - J1 - J2 - J3 - J4 - JA - JB - JC - JD - JE - JF - JG - JW - JZ - K0 - K1 - K2 - K3 - K4 - KA - KB - KC - KD - KE - KF - KG - KH - KI - KJ - KK - KL - KM - KN - KO - KP - KQ - KR - KS - KT - KU - KV - KW - KX - KY - KZ - L1 - LC - LD - LL - LM - LR - LS - LT - LU - M2 - ME - MI - MR - MS - N1 - N2 - N3 - NB - NH - NM - NR - NU - P1 - P2 - P3 - P4 - P5 - P6 - PA - PB - PC - PD - PE - PI - PL - PM - PN - PO - PS - PT - Q0 - Q1 - Q2 - Q3 - Q4 - Q5 - Q6 - Q7 - Q8 - Q9 - QA - QB - QC - QD - QE - QF - QG - QH - QJ - QK - QL - QM - QN - QP - QQ - QR - QS - QT - QU - QV - QW - QX - QY - QZ - RA - RB - RC - RD - RE - RI - RP - RR - RT - SA - SB - SC - SD - SE - SF - SG - SH - SJ - SK - SL - SM - SN - SP - SQ - SS - ST - SU - SV - SW - SY - SZ - T1 - T2 - T3 - T4 - T5 - T6 - T7 - T8 - T9 - TA - TB - TC - TD - TE - TF - TG - TH - TJ - TK - TL - TM - TN - TP - TQ - TR - TS - TT - TU - TV - TW - TX - U1 - U2 - U3 - U4 - U5 - U6 - U7 - U8 - U9 - UA - UB - UC - UD - UE - UF - UG - UH - UJ - UK - UN - UP - UQ - UR - US - V1 - V2 - V3 - V4 - V5 - V6 - V7 - V8 - V9 - VP - VR - W1 - W5 - W6 - W7 - W8 - W9 - WC - WH - WP - X1 - X2 - X3 - X4 - X5 - XE - XP - XS - XU - VM - ZA - ZB - ZL - ZS - 1P - 2P - 3P - 8P type: string description: '' title: 'CPT/HCPCS Modifier #2' cpt_hcpcs_modifier3: enum: - '' - '17' - 1D - '22' - '23' - '24' - '25' - '26' - '27' - '29' - '32' - '33' - '47' - '50' - '51' - '52' - '53' - '54' - '55' - '56' - '57' - '58' - '59' - '62' - '63' - '66' - '73' - '74' - '76' - '77' - '78' - '79' - '80' - '81' - '82' - '83' - '90' - '91' - '92' - '93' - '95' - '96' - '97' - '99' - A1 - A2 - A3 - A4 - A5 - A6 - A7 - A8 - A9 - AA - AB - AD - AE - AF - AG - AH - AI - AJ - AK - AM - AO - AP - AQ - AR - AS - AT - AU - AV - AW - AX - AY - AZ - BA - BL - BO - BP - BR - BU - CA - CB - CC - CD - CE - CF - CG - CH - CI - CJ - CK - CL - CM - CN - CO - CP - CQ - CR - CS - CT - DA - E1 - E2 - E3 - E4 - EA - EB - EC - ED - EE - EJ - EM - EP - ER - ET - EX - EY - F1 - F2 - F3 - F4 - F5 - F6 - F7 - F8 - F9 - FA - FB - FC - FS - FP - FQ - FR - FX - FY - G0 - G1 - G2 - G3 - G4 - G5 - G6 - G7 - G8 - G9 - GA - GB - GC - GD - GE - GF - GG - GH - GJ - GK - GL - GM - GN - GO - GP - GQ - GR - GS - GT - GU - GV - GW - GX - GY - GZ - H9 - HA - HB - HC - HD - HE - HF - HG - HH - HI - HJ - HK - HL - HM - HN - HO - HP - HQ - HR - HS - HT - HU - HV - HW - HX - HY - HZ - J1 - J2 - J3 - J4 - JA - JB - JC - JD - JE - JF - JG - JW - JZ - K0 - K1 - K2 - K3 - K4 - KA - KB - KC - KD - KE - KF - KG - KH - KI - KJ - KK - KL - KM - KN - KO - KP - KQ - KR - KS - KT - KU - KV - KW - KX - KY - KZ - L1 - LC - LD - LL - LM - LR - LS - LT - LU - M2 - ME - MI - MR - MS - N1 - N2 - N3 - NB - NH - NM - NR - NU - P1 - P2 - P3 - P4 - P5 - P6 - PA - PB - PC - PD - PE - PI - PL - PM - PN - PO - PS - PT - Q0 - Q1 - Q2 - Q3 - Q4 - Q5 - Q6 - Q7 - Q8 - Q9 - QA - QB - QC - QD - QE - QF - QG - QH - QJ - QK - QL - QM - QN - QP - QQ - QR - QS - QT - QU - QV - QW - QX - QY - QZ - RA - RB - RC - RD - RE - RI - RP - RR - RT - SA - SB - SC - SD - SE - SF - SG - SH - SJ - SK - SL - SM - SN - SP - SQ - SS - ST - SU - SV - SW - SY - SZ - T1 - T2 - T3 - T4 - T5 - T6 - T7 - T8 - T9 - TA - TB - TC - TD - TE - TF - TG - TH - TJ - TK - TL - TM - TN - TP - TQ - TR - TS - TT - TU - TV - TW - TX - U1 - U2 - U3 - U4 - U5 - U6 - U7 - U8 - U9 - UA - UB - UC - UD - UE - UF - UG - UH - UJ - UK - UN - UP - UQ - UR - US - V1 - V2 - V3 - V4 - V5 - V6 - V7 - V8 - V9 - VP - VR - W1 - W5 - W6 - W7 - W8 - W9 - WC - WH - WP - X1 - X2 - X3 - X4 - X5 - XE - XP - XS - XU - VM - ZA - ZB - ZL - ZS - 1P - 2P - 3P - 8P type: string description: '' title: 'CPT/HCPCS Modifier #3' cpt_hcpcs_modifier1: type: string description: '' title: Cpt hcpcs modifier1 cpt_hcpcs_modifier4: enum: - '' - '17' - 1D - '22' - '23' - '24' - '25' - '26' - '27' - '29' - '32' - '33' - '47' - '50' - '51' - '52' - '53' - '54' - '55' - '56' - '57' - '58' - '59' - '62' - '63' - '66' - '73' - '74' - '76' - '77' - '78' - '79' - '80' - '81' - '82' - '83' - '90' - '91' - '92' - '93' - '95' - '96' - '97' - '99' - A1 - A2 - A3 - A4 - A5 - A6 - A7 - A8 - A9 - AA - AB - AD - AE - AF - AG - AH - AI - AJ - AK - AM - AO - AP - AQ - AR - AS - AT - AU - AV - AW - AX - AY - AZ - BA - BL - BO - BP - BR - BU - CA - CB - CC - CD - CE - CF - CG - CH - CI - CJ - CK - CL - CM - CN - CO - CP - CQ - CR - CS - CT - DA - E1 - E2 - E3 - E4 - EA - EB - EC - ED - EE - EJ - EM - EP - ER - ET - EX - EY - F1 - F2 - F3 - F4 - F5 - F6 - F7 - F8 - F9 - FA - FB - FC - FS - FP - FQ - FR - FX - FY - G0 - G1 - G2 - G3 - G4 - G5 - G6 - G7 - G8 - G9 - GA - GB - GC - GD - GE - GF - GG - GH - GJ - GK - GL - GM - GN - GO - GP - GQ - GR - GS - GT - GU - GV - GW - GX - GY - GZ - H9 - HA - HB - HC - HD - HE - HF - HG - HH - HI - HJ - HK - HL - HM - HN - HO - HP - HQ - HR - HS - HT - HU - HV - HW - HX - HY - HZ - J1 - J2 - J3 - J4 - JA - JB - JC - JD - JE - JF - JG - JW - JZ - K0 - K1 - K2 - K3 - K4 - KA - KB - KC - KD - KE - KF - KG - KH - KI - KJ - KK - KL - KM - KN - KO - KP - KQ - KR - KS - KT - KU - KV - KW - KX - KY - KZ - L1 - LC - LD - LL - LM - LR - LS - LT - LU - M2 - ME - MI - MR - MS - N1 - N2 - N3 - NB - NH - NM - NR - NU - P1 - P2 - P3 - P4 - P5 - P6 - PA - PB - PC - PD - PE - PI - PL - PM - PN - PO - PS - PT - Q0 - Q1 - Q2 - Q3 - Q4 - Q5 - Q6 - Q7 - Q8 - Q9 - QA - QB - QC - QD - QE - QF - QG - QH - QJ - QK - QL - QM - QN - QP - QQ - QR - QS - QT - QU - QV - QW - QX - QY - QZ - RA - RB - RC - RD - RE - RI - RP - RR - RT - SA - SB - SC - SD - SE - SF - SG - SH - SJ - SK - SL - SM - SN - SP - SQ - SS - ST - SU - SV - SW - SY - SZ - T1 - T2 - T3 - T4 - T5 - T6 - T7 - T8 - T9 - TA - TB - TC - TD - TE - TF - TG - TH - TJ - TK - TL - TM - TN - TP - TQ - TR - TS - TT - TU - TV - TW - TX - U1 - U2 - U3 - U4 - U5 - U6 - U7 - U8 - U9 - UA - UB - UC - UD - UE - UF - UG - UH - UJ - UK - UN - UP - UQ - UR - US - V1 - V2 - V3 - V4 - V5 - V6 - V7 - V8 - V9 - VP - VR - W1 - W5 - W6 - W7 - W8 - W9 - WC - WH - WP - X1 - X2 - X3 - X4 - X5 - XE - XP - XS - XU - VM - ZA - ZB - ZL - ZS - 1P - 2P - 3P - 8P type: string description: '' title: 'CPT/HCPCS Modifier #4' created_at: readOnly: true type: string description: '' title: Created at doctor: type: integer description: '' title: Doctor insured_price: type: number description: '' title: Insured price base_price: type: number description: '' title: Base price x-verbose-required: [] PatientMessage: required: - doctor - patient - subject type: object properties: body: type: string description: '' title: Body patient: type: integer description: '' title: Patient attachments: items: title: PatientMessageAttachment type: object description: '' properties: updated_at: readOnly: true type: string description: '' title: Updated at created_at: readOnly: true type: string description: '' title: Created at attachment: type: string description: '' title: Attachment doctor: type: integer description: '' title: Doctor type: array description: '' title: Attachments doctor: type: integer description: '' title: Doctor created_at: readOnly: true type: string description: '' title: Created at updated_at: readOnly: true type: string description: '' title: Updated at message: readOnly: true type: string description: '' title: Message id: readOnly: true type: integer description: '' title: ID subject: type: string description: '' title: Subject x-verbose-required: [] PatientIntervention: required: - doctor - patient type: object properties: value_name: readOnly: true type: string description: Description of value title: Value name value_code_system: type: string description: Can be `SNOMEDCT`, `ICD10CM`, `LOINC` title: Value code system code: type: string description: Code from different code system title: Code appointment: readOnly: true type: string description: '' title: Appointment name: readOnly: true type: string description: Description of intervention title: Name doctor: type: integer description: '' title: Doctor created_at: readOnly: true type: string description: '' title: Created at effective_time: type: string description: '' title: Effective time value_code: type: string description: Code from different code system represent intervention value title: Value code patient: type: integer description: '' title: Patient id: readOnly: true type: integer description: '' title: ID code_system: type: string description: Can be `SNOMEDCT`, `HCPCS`, `CPT`, `ICD10CM` title: Code system x-verbose-required: [] Staff: required: [] type: object properties: username: readOnly: true type: string description: '' title: Username first_name: readOnly: true type: string description: '' title: First name last_name: readOnly: true type: string description: '' title: Last name user_id: readOnly: true type: string description: '' title: User id doctor: readOnly: true type: string description: '' title: Doctor created_at: readOnly: true type: string description: '' title: Created at updated_at: readOnly: true type: string description: '' title: Updated at id: readOnly: true type: integer description: '' title: ID home_phone: readOnly: true type: string description: '' title: Home phone active: readOnly: true type: string description: '' title: Active cell_phone: readOnly: true type: string description: '' title: Cell phone email: readOnly: true type: string description: An account registration email will be sent to this address. title: Email x-verbose-required: [] CustomVitalType: required: [] type: object properties: archived: type: boolean description: Indicates that the object has been soft-deleted and should not be used title: Archived description: type: string description: '' title: Description data_type: enum: - text - number - single_sel type: string description: One of `text`, `number`, or `single_sel` title: Data type doctor: readOnly: true type: string description: ID of the doctor who created the custom vital title: Doctor is_fraction_field: type: boolean description: '' title: Is fraction field fraction_delimiter: type: string description: If `is_fraction_field` is true, this is the character separating the numerator and denominator title: Fraction delimiter allowed_values: items: type: string description: '' title: '' type: array description: If `data_type` is `single_sel`, this is the array of values in the select's dropdown. title: Allowed values id: readOnly: true type: integer description: '' title: ID unit: type: string description: '' title: Unit name: type: string description: '' title: Name x-verbose-required: [] EOBObject: required: - doctor - insurance_payer_id - insurance_payer_name - insurance_payer_trace_number type: object properties: posted_date: readOnly: true type: string description: '' title: Posted date insurance_payer_name: type: string description: '' title: Insurance payer name doctor: type: integer description: '' title: Doctor payment_method: enum: - '' - ACH - BOPCCP - BOPCTX - CHK - FWT - VPAY - NON type: string description: '`""` - Unknown, `"ACH"` - Automated Clearing House (ACH), `"BOPCCP"` - Cash Concentration/Disbursement plus Addenda (CCD+) (ACH), `"BOPCTX"` - Corporate Trade Exchange (CTX) (ACH), `"CHK"` - Check, `"FWT"` - Federal Reserve Funds/Wire Transfer - Nonrepetitive, `"VPAY"` - vPayment, `"NON"` - Non-Payment Data' title: Payment method deposit_date: type: string description: Date when EOB gets deposited. title: Deposit date updated_at: readOnly: true type: string description: '' title: Updated at insurance_payer_id: type: string description: '' title: Insurance payer id scanned_eob: type: string description: '' title: Scanned eob insurance_payer_trace_number: type: string description: '' title: Insurance payer trace number total_paid: type: number description: Total amount paid. If missing, default to 0.00 title: Total paid check_date: type: string description: Date of check. If missing, default to the date when the request is made title: Check date id: readOnly: true type: integer description: '' title: ID x-verbose-required: [] TelemedicineAppointmentEventLog: required: [] type: object properties: timestamp: readOnly: true type: string description: '' title: Timestamp description: readOnly: true type: string description: '' title: Description event_type: readOnly: true type: string description: '' title: Event type x-verbose-required: [] LabResult: required: - document - lab_test - test_performed - status - value type: object properties: status: enum: - P - I - C - F - X type: string description: ' Value | Notes ----- | ----- `''P''` | `''preliminary''` `''I''` | `''pending''` `''C''` | `''correction''` `''F''` | `''final''` `''X''` | `''canceled''` ' title: Status group_code: type: string description: This is the code used for grouping result data. title: Group code observation_description: type: string description: For example, ``"Blood Urea Nitrogen (BUN)"`` title: Observation description is_abnormal: type: string description: If true, the result will be flagged for the doctor's attention title: Is abnormal observation_code: type: string description: '' title: Observation code specimen_received: type: string description: '' title: Specimen received comments: type: string description: '' title: Comments normal_range: type: string description: When ``value_is_numeric`` is True, this parameter must be a string of the form ``" ", where both lower and upper are numerical`` title: Normal range test_performed: type: string description: '' title: Test performed value: type: string description: '' title: Value abnormal_status: enum: - L - LL - H - HH - < - '>' - A - AA - S - R - I - NEG - POS - N - '' type: string description: ' Value | Notes ----- | ----- `''L''` | `''low''` `''LL''` | `''alert low''` `''H''` | `''high''` `''HH''` | `''alert high''` `''<''` | `''panic low''` `''>''` | `''panic high''` `''A''` | `''abnormal''` `''AA''` | `''very abnormal''` `''S''` | `''susceptible''` `''R''` | `''resistant''` `''I''` | `''intermediate''` `''NEG''` | `''negative''` `''POS''` | `''positive''` `''N''` | `''normal''` `''''` | `''no comment''` ' title: Abnormal status lab_order: readOnly: true type: string description: ID of `/lab_orders` object the result belongs to title: Lab order value_is_numeric: type: boolean description: Default to `False` title: Value is numeric document: type: integer description: ID of `/lab_documents` object for the result title: Document lab_test: type: integer description: ID of `/lab_tests` object for the result title: Lab test id: readOnly: true type: integer description: '' title: ID unit: type: string description: Unit used for the value title: Unit x-verbose-required: [] PatientAllergy: required: - doctor - patient type: object properties: status: enum: - active - inactive type: string description: One of `"active"`, `"inactive"`. If absent in `POST`, default to `"active"` title: Status reaction: type: string description: Short description of the patient's allergic reaction, such as `"Hives"` title: Reaction patient: type: integer description: '' title: Patient description: type: string description: Description of the allergy, such as `"Cat hair"` title: Description doctor: type: integer description: Id of the doctor who diagnosed the allergy title: Doctor snomed_reaction: enum: - '' - '14669001' - '4448006' - '39579001' - '57676002' - '43724002' - '49727002' - '386661006' - '25064002' - '247472004' - '271795006' - '68962001' - '68235000' - '422587007' - '95388000' - '271807003' - '271825005' - '64531003' - '267036007' - '162397003' - '65124004' type: string description: SNOMED code for the reaction. For possible SnoMED codes, please see [this link from PHIN VADS](https://phinvads.cdc.gov/vads/ViewValueSet.action?id=896AABB4-5ACD-DE11-913D-0015173D1785) title: Snomed reaction notes: type: string description: Any additional notes from the provider title: Notes verification_status: enum: - confirmed - unconfirmed - refuted - entered-in-error type: string description: One of `"confirmed"`, `"unconfirmed"`, `"refuted" or `"entered-in-error"` title: Verification status snomed_code: type: string description: SNOMED code for the allergy title: Snomed code rxnorm: type: string description: If the allergy is a drug allergy, this is the RxNorm code of the drug title: Rxnorm id: readOnly: true type: integer description: '' title: ID x-verbose-required: - description PatientPhysicalExam: required: - doctor - patient type: object properties: value_name: readOnly: true type: string description: Description of value title: Value name value_code_system: type: string description: Can be `SNOMEDCT`, `ICD10CM`, `LOINC` title: Value code system code: type: string description: Code from different code system title: Code appointment: readOnly: true type: string description: '' title: Appointment name: readOnly: true type: string description: Description of physical exam title: Name doctor: type: integer description: '' title: Doctor created_at: readOnly: true type: string description: '' title: Created at effective_time: type: string description: '' title: Effective time value_code: type: string description: Code from different code system represent physical exam value title: Value code patient: type: integer description: '' title: Patient id: readOnly: true type: integer description: '' title: ID code_system: type: string description: Can be `SNOMEDCT`, `LOINC` title: Code system x-verbose-required: [] CareTeamMember: required: [] type: object properties: patient: readOnly: true type: string description: '' title: Patient created_at: readOnly: true type: string description: '' title: Created at appointment: readOnly: true type: string description: '' title: Appointment id: readOnly: true type: integer description: '' title: ID user: readOnly: true type: string description: '' title: User x-verbose-required: [] SignedConsentFormUpdate: type: object properties: appointment: type: integer description: ID of the appointment that the consent form is signed for title: Appointment archived: type: boolean description: Indicates that the consent form has been archived and should not be used title: Archived consent_form: type: integer description: ID of the consent form that is signed title: Consent form patient: type: integer description: ID of the patient who signed the consent form title: Patient signature_file: format: binary type: string description: File with the signature of the patient title: Signature file x-verbose-required: [] ImplantableDevice: required: [] type: object properties: status: readOnly: true enum: - active - inactive type: string description: One of `'active'` or `'inactive'` title: Status lot_number: readOnly: true type: string description: '' title: Device lot number archived: readOnly: true type: boolean description: '' title: Archived manufacturing_date: readOnly: true type: string description: '' title: Manufacturing date patient: readOnly: true type: string description: '' title: Patient expiration_date: readOnly: true type: string description: '' title: Expiration date created_at: readOnly: true type: string description: '' title: Created at brand_name: readOnly: true type: string description: '' title: Brand name updated_at: readOnly: true type: string description: '' title: Updated at gmdn_pt_name: readOnly: true type: string description: '"GMDN PT Name" or "SNOMED CT Description" mapped to the attribute in the "GMDN PT Name"' title: GMDN PT Name version_or_model: readOnly: true type: string description: '' title: Version or model serial_number: readOnly: true type: string description: '' title: Serial number udi: readOnly: true type: string description: '' title: Unique Device Identifier id: readOnly: true type: integer description: '' title: ID procedure: readOnly: true type: string description: ID of `/api/procedures` object title: Procedure company_name: readOnly: true type: string description: '' title: Company name x-verbose-required: [] CarePlan: required: [] type: object properties: code: readOnly: true type: string description: '' title: Code appointment: readOnly: true type: string description: '' title: Appointment description: readOnly: true type: string description: '' title: Description title: readOnly: true type: string description: '' title: Title created_at: readOnly: true type: string description: '' title: Created at plan_type: readOnly: true enum: - '1' - '2' - '3' - '4' - '5' - '6' type: string description: 'Can be one of the following: `1`(Goal), `2`(Patient education), `3`(Patient decision aid), `4`(Patient clinical instruction), `5`(Referral to other doctor), `6`(Health concerns)' title: Plan type updated_at: readOnly: true type: string description: '' title: Updated at scheduled_date: readOnly: true type: string description: '' title: Scheduled date patient: readOnly: true type: string description: '' title: Patient id: readOnly: true type: integer description: '' title: ID code_system: readOnly: true type: string description: '' title: Code system instructions: readOnly: true type: string description: '' title: Instructions x-verbose-required: [] ConsentForm: required: - assign_by_default - doctor - is_mandatory - title - uri type: object properties: archived: readOnly: true type: boolean description: '' title: Archived is_mandatory: type: boolean description: If true, consent form must be signed prior to appointment check in title: Is mandatory uri: type: string description: Files are passed using `multipart/form-data` encoding, but returned as URLs. title: Uri doctor: type: integer description: '' title: Doctor updated_at: readOnly: true type: string description: '' title: Updated at created_at: readOnly: true type: string description: '' title: Created at title: type: string description: '' title: Title assign_by_default: type: boolean description: If true, consent form will always be automatically assigned to appointments title: Assign by default order: readOnly: true type: integer description: The order of consent forms that will show in management screen title: Order id: readOnly: true type: integer description: '' title: ID x-verbose-required: [] PatientCommunication: required: - doctor - patient type: object properties: value_name: readOnly: true type: string description: Description of value title: Value name value_code_system: type: string description: Can be `SNOMEDCT`, `ICD10CM`, `LOINC` title: Value code system code: type: string description: Code from different code system title: Code appointment: readOnly: true type: string description: '' title: Appointment name: readOnly: true type: string description: '' title: Name doctor: type: integer description: '' title: Doctor created_at: readOnly: true type: string description: '' title: Created at effective_time: type: string description: '' title: Effective time value_code: type: string description: Code from different code system represent communication value title: Value code patient: type: integer description: '' title: Patient id: readOnly: true type: integer description: '' title: ID code_system: type: string description: Can be `SNOMEDCT`, `LOINC` title: Code system x-verbose-required: [] FeeSchedule: required: [] type: object properties: ineffective_date: type: string description: End date that this schedule is valid. If null, then it is applied until an end date is set title: Ineffective date assignees: type: array description: Schedule specific to these assignees, if null, then applies as default to all assignees without a more specific fee schedule. title: Assignees items: type: array description: Items that belong to this fee schedule (this field is only available for single requests) title: Items created_at: readOnly: true type: string description: '' title: Created at payer_id: type: string description: Fee Schedule pricing specific to this payer, if null, then applies as default to all payers without a more specific fee schedule. title: Payer id updated_at: readOnly: true type: string description: '' title: Updated at assignee_type: enum: - Individual - Speciality type: string description: Type of assignee title: Assignee Type specialities: type: array description: Schedule specific to these specialities, if null, then applies as default to all specialities without a more specific fee schedule. title: Specialities effective_date: type: string description: Start date that this schedule is valid. If null, then since the beginning of time title: Effective date plan_name: type: string description: Name of insurance plan. title: Plan name id: readOnly: true type: integer description: '' title: ID x-verbose-required: [] CustomAppointmentFieldType: required: [] type: object properties: archived: readOnly: true type: boolean description: Indicates that the object has been soft-deleted and should not be used title: Archived doctor: readOnly: true type: string description: '' title: Doctor created_at: readOnly: true type: string description: '' title: Created at updated_at: readOnly: true type: string description: '' title: Updated at order: readOnly: true type: integer description: displayed order in patient's demographic page title: Order field_desc: type: string description: Description of the custom field title: Field desc field_name: type: string description: '' title: Field name id: readOnly: true type: integer description: '' title: ID x-verbose-required: [] PatientDrug: required: - doctor - patient type: object properties: dispense_quantity: type: number description: '' title: Dispense quantity prn: type: boolean description: If `True`, the medication should be taken when necessary title: Prn pharmacy_note: type: string description: '' title: Pharmacy note number_refills: type: integer description: '' title: Number refills patient: type: integer description: '' title: Patient id: readOnly: true type: integer description: '' title: ID dosage_quantity: type: string description: Please note, this used to be an decimal field, you can still pass decimal value to it. Or you can pass in some formatted string if needed. title: Dosage quantity doctor: type: integer description: Prescribing doctor ID title: Doctor date_started_taking: type: string description: '' title: Date started taking dosage_units: type: string description: '' title: Dosage units date_stopped_taking: type: string description: '' title: Date stopped taking order_status: enum: - '' - Administered during visit - Discontinued - Electronic eRx Sent - Faxed to Pharmacy - Ordered - Over the Counter - Paper Rx - Phoned into Pharmacy - Prescribed by other Dr - Prescription Printed type: string description: One of `""`, `"Ordered"`, `"Administered during visit"`, `"Electronic eRx Sent"`, `"Phoned into Pharmacy"`, `"Faxed to Pharmacy"`, `"Paper Rx"`, `"Prescription Printed"`, `"Discontinued"`, `"Prescribed by other Dr"` or `"Over the Counter"`. If omitted in writing, default to `""` title: Order status status: enum: - active - inactive type: string description: If present, one of `"active"` or `"inactive"`. If omitted in writing, default to `"active"` title: Status appointment: type: integer description: Appointment ID corresponding to the initial prescription title: Appointment daw: type: boolean description: If true, the prescription should be dispensed as written and not substituted title: Daw rxnorm: type: string description: RxNorm code for the medication title: Rxnorm date_prescribed: type: string description: '' title: Date prescribed name: type: string description: '' title: Name ndc: type: string description: '' title: Ndc notes: type: string description: Any additional notes from the provider title: Notes frequency: type: string description: Frequency pf administration title: Frequency indication: type: string description: '' title: Indication signature_note: type: string description: '' title: Signature note route: type: string description: Route of administration title: Route x-verbose-required: [] PatientProblem: required: - doctor - patient type: object properties: category: readOnly: true type: string description: The category of the problem. Either `problem-list-item` or `health-concern` title: Category icd_code: type: string description: ICD9 or ICD10 code for the problem title: Icd code icd_version: enum: - '9' - '10' type: string description: Either `9` or `10`. If omitted in writing, default to 10. title: Icd version appointment: type: integer description: '' title: Appointment description: type: string description: '' title: Description info_url: readOnly: true type: string description: External URL with more information about the problem, intended for patient education title: Info url doctor: type: integer description: '' title: Doctor notes: type: string description: Any additional notes by the provider title: Notes verification_status: enum: - '' - unconfirmed - provisional - differential - confirmed - refuted - entered-in-error description: 'The verification status of the problem: - `unconfirmed` - `provisional` - `differential` - `confirmed` - `refuted` - `entered-in-error` ' status: enum: - active - inactive - resolved type: string description: Either `active`, `inactive` or `resolved`. If omitted in writing, default to `active` title: Status snomed_ct_code: type: string description: SnoMED code for the problem title: SnoMED CT code abatement_date: readOnly: true title: Abatement Date type: string description: The problem's resolution date. format: date date_onset: type: string description: '' title: Date onset date_diagnosis: type: string description: '' title: Date diagnosis date_changed: type: string description: '' title: Date changed patient: type: integer description: '' title: Patient problem_type: readOnly: true enum: - '' - sdoh - functional status - disability status - cognitive status type: string description: 'The type of problem: - `sdoh`: Social Determinants of Health (SDOH). - `functional status`: Functional Status. - `disability status`: Disability Status. - `cognitive status`: Cognitive Status. ' title: Problem Type id: readOnly: true type: integer description: '' title: ID name: type: string description: Name of the problem title: Name x-verbose-required: [] ClinicalNote: required: [] type: object properties: patient: readOnly: true type: string description: '' title: Patient archived: type: boolean description: '' title: Archived clinical_note_sections: items: title: Clinical Note Section type: object description: '' properties: values: items: title: Value type: object description: '' properties: clinical_note_field: type: integer description: '' title: Clinical Note Field id: type: integer description: '' title: Id value: type: string description: '' title: '' type: array description: '' title: Values clinical_note_template: type: integer description: '' title: Clinical Note Template name: type: string description: '' title: Name type: array description: '' title: Clinical Note Sections appointment: readOnly: true type: string description: '' title: Appointment signee: title: ClinicalNote type: object description: '' properties: locked_by: readOnly: true type: string description: '' title: Locked by supervisor_locked_by: readOnly: true type: string description: '' title: Supervisor locked by x-verbose-required: [] SoapNoteLineItemFieldValue: x-verbose-required: [] required: - appointment - clinical_note_field - value type: object description: Values entered by doctor when charting a particular appointment properties: clinical_note_field: type: integer description: ID of `/api/clinical_note_field_types` object that indicates type of the value title: Clinical note field created_at: readOnly: true type: string description: '' title: Created at updated_at: readOnly: true type: string description: '' title: Updated at value: type: string description: "Value of the field. Interpretation varies by field type.\n`clinical_note_field.data_type` | Value | Description\n------------------------------- | ----- | -----------\n`\"Header\"` | string | \n`\"SubHeader\"` | string |\n`\"String\"` | string | If field is single/multiple select field, make sure value presents in allowed values set.\n`\"TwoStrings\"` | string | String is seperated by `\"/\"`\n`\"NullCheckbox\"` | string | Can be `\"0\"`, `\"1\"`, `\"2\"`, `\"0\"`-`Not selected`, `\"1\"`-`No`, `\"2\"`-`Yes`\n`\"Checkbox\"` | string | Can be `\"True\"`, `\"False\"`\n" title: Value appointment: type: integer description: ID of appointment that the value applies to title: Appointment id: readOnly: true type: integer description: '' title: ID PatientRiskAssessment: required: - doctor - patient type: object properties: value_name: readOnly: true type: string description: '' title: Value name value_code_system: type: string description: '' title: Value code system code: type: string description: '' title: Code appointment: readOnly: true type: string description: '' title: Appointment name: readOnly: true type: string description: '' title: Name doctor: type: integer description: '' title: Doctor created_at: readOnly: true type: string description: '' title: Created at effective_time: type: string description: '' title: Effective time value_code: type: string description: '' title: Value code patient: type: integer description: '' title: Patient id: readOnly: true type: integer description: '' title: ID code_system: type: string description: '' title: Code system x-verbose-required: [] PrescriptionMessage: required: [] type: object properties: message_status: readOnly: true type: string description: 'Message status for Incoming and Outgoing values. Success message for message_type are: `NewRx` : `Sent`, `RefillRequest` : `Received`, `RefillResponse` : `Sent`.' title: Message status patient: type: integer description: An optional field which refers to a patient. title: Patient doctor: type: integer description: '' title: Doctor message_type: type: string description: Possible values are `NewRx` for outgoing new prescriptions, `RefillRequest` for incoming refill requests, `RefillResponse` for outgoing refill responses, `Error` for incoming errors, `Status` and `Verify` for incoming status reports from Surescripts. title: Message type created_at: readOnly: true type: string description: '' title: Created at parent_message: readOnly: true type: string description: Refers to the parent message, used for refill responses and incoming error/status reports. title: Parent message message_direction: readOnly: true enum: - I - O type: string description: Possible values are `Outgoing` and `Incoming`. title: Message direction pharmacy: type: string description: 'NCPDPID allocated #ID of the Pharmacy' title: Pharmacy json_data: readOnly: true type: string description: Data sent along with `NewRx`, `RefillRequest`, and `RefillResponses` messages. The format varies, but most likely it will contain `BenefitsCoordination` section with insurance info and `MedicationPrescribed` with medication info. `Patient`, `Pharmacy`, and `Prescriber` are also usually present. title: Json data id: readOnly: true type: integer description: '' title: ID x-verbose-required: [] ScannedClinicalDocument: required: - doctor - description - date - document - patient type: object properties: archived: readOnly: true type: boolean description: '`DELETE` operation will set this field to `true`' title: Archived patient: type: integer description: ID of the patient the document concerns title: Patient description: type: string description: '' title: Description doctor: type: integer description: ID of the doctor who owns the document title: Doctor metatags: type: string description: Array of tags represented as string. This should be quoted--e.g. `'["a", "b"]'`--since this endpoint requires `multipart/form-data` encoding title: Metatags updated_at: readOnly: true type: string description: '' title: Updated at date: type: string description: '' title: Date document: type: string description: When creating, if you receive response as 201, but this field is `null`, please send a `GET` request with the created object's ID to retrieve the updated file URL title: Document id: readOnly: true type: integer description: '' title: ID x-verbose-required: [] ScheduleBlock: example: description: Lunch Break office: 200 color: '#FF5733' practice_group: 1 start_time: '2024-03-15T12:00:00' exam_room: 1 series: null end_time: '2024-03-15T13:00:00' provider: 100 id: 12345 appointment_break: null required: - provider - office - start_time - end_time type: object description: Schedule blocks are used to block off time on a provider's calendar, preventing appointments from being scheduled during those times. They can be associated with a specific provider, office, and exam room. Common use cases include blocking time for lunch breaks, meetings, administrative tasks, PTO, or other non-appointment activities. properties: description: type: string description: Description or reason for the schedule block (e.g., "Lunch Break", "Staff Meeting", "PTO") title: Description office: type: integer description: ID of the office where the schedule block is applied title: Office color: type: string description: Custom color associated with the schedule block for calendar display title: Color practice_group: type: integer description: ID of the practice group for the associated provider (doctor) title: Practice group start_time: format: date-time type: string description: Start time of the schedule block in ISO 8601 format title: Start time exam_room: type: integer description: ID of the exam room where the schedule block is applied title: Exam room series: type: integer description: Series ID if the schedule block is part of a recurring series title: Series end_time: format: date-time type: string description: End time of the schedule block in ISO 8601 format title: End time provider: type: integer description: ID of the provider or doctor who owns this schedule block title: Provider id: readOnly: true type: integer description: Unique identifier for the schedule block title: ID appointment_break: readOnly: true type: integer description: ID of an associated appointment break, if applicable title: Appointment break PatientVaccineRecord: required: - patient - cvx_code - name type: object properties: lot_number: type: string description: Lot/batch number of the vaccine dose site: type: string description: '' title: Site ordering_doctor: type: integer description: '' title: Ordering doctor doses: items: title: VaccineDose type: object description: Vaccine dose ID properties: min_age_months: type: integer description: '' title: Min age months id: readOnly: true type: integer description: '' title: ID max_age_months: type: integer description: '' title: Max age months title: type: string description: '' title: Title type: array description: Vaccine dose IDs received in consent form signed hook title: Doses id: readOnly: true type: integer description: '' title: ID next_dose_date: type: string description: Date for next dose of vaccine title: Date for next dose cpt_code: type: string description: Vaccine cpt code title: Cpt code completion_status: enum: - CP - RE - NA - PA type: string description: Vaccination status, can be `CP`(Complete), `RE`(Refused), `NA`(Not administered), `PA`(Partially administered) title: Vaccination Status administered_at: type: integer description: ID of `/api/offices` where the administration happened title: Administered at comments: type: string description: '' title: Comments funding_eligibility: enum: - V01 - V02 - V03 - V04 - V05 - V07 type: string description: The funding program that should pay for a given immunization title: Funding Eligibility units: type: string description: '' title: Units entered_by: readOnly: true type: string description: ID of user who created the record title: Entered by patient: type: integer description: '' title: Patient administration_start: type: string description: Datetime when the administration starts title: Administration start record_source: enum: - '00' - '01' - '02' - '03' - '04' - '05' - '06' - '07' - 08 type: string description: '' title: Record Type updated_at: readOnly: true type: string description: '' title: Updated at consent_form: type: integer description: Consent form related with vaccine record title: Consent form manufacturer: type: string description: Manufacturer of the vaccine administered_by: type: string description: ID of `/api/users` who performs the administration title: Administered by name: type: string description: '' title: Name vis: readOnly: true type: string description: Related vaccine information statement title: Vis created_at: readOnly: true type: string description: '' title: Created at observed_immunity: enum: - '398102009' - '409498004' - '397428000' - '18624000' - '91428005' - '271511000' - '240532009' - '6142004' - '52947006' - '14189004' - '23511006' - '36989005' - '27836007' - '16814004' - '14168008' - '36653000' - '76902006' - '66071002' - '4834000' - '111852003' - '38907003' - '40468003' - '16541001' type: string description: '' title: Observed Immunity amount: type: number description: Amount of vaccine administered title: Amount vaccine_inventory: type: integer description: ID of `/api/vaccine_inventories` the vaccine is from title: Vaccine inventory route: type: string description: '' title: Route cvx_code: type: string description: Vaccine cvx code title: Cvx code x-verbose-required: [] Insurance: required: [] type: object properties: payer_name: type: string description: '' title: payer_name state: type: string description: '' title: state payer_id: type: string description: '' title: payer_id SignedConsentForm: required: - patient - appointment - consent_form type: object properties: date_signed: readOnly: true type: string description: Date when the consent form is signed. Automatically set when the record is created title: Date signed archived: type: boolean description: Indicates that the consent form has been archived and should not be used title: Archived appointment: type: integer description: ID of the appointment that the consent form is signed for title: Appointment signature_file: format: binary type: string description: File with the signature of the patient title: Signature file updated_at: readOnly: true type: string description: Date and time when the signature was last updated title: Updated at patient: type: integer description: ID of the patient who signed the consent form title: Patient consent_form: type: integer description: ID of the consent form that is signed title: Consent form id: readOnly: true type: integer description: ID consent form signature title: ID x-verbose-required: [] PatientLabResultSet: required: - ordering_doctor - patient type: object properties: doctor_signoff: type: boolean description: Check this box when the doctor has reviewed the lab result and taken appropriate action. title: Doctor signoff loinc_code: type: string description: '' title: LOINC code patient: type: integer description: '' title: Patient ordering_doctor: type: integer description: '' title: Ordering doctor lab_abnormal_flag: enum: - '' - L - H - LL - HH - < - '>' - N - A - AA - 'null' - U - D - B - W - S - R - I - MS - VS type: string description: HL7 codified abnormal flag for the result. title: Abnormal flag lab_normal_range_units: type: string description: '' title: Normal range units created_at: readOnly: true type: string description: '' title: Created at lab_normal_range: type: string description: '' title: Normal range doctor_comments: type: string description: Comment from the doctor on lab result. title: Comments date_test_performed: type: string description: Date of lab test. title: Date test performed updated_at: readOnly: true type: string description: '' title: Updated at lab_result_value: type: string description: '' title: Result value lab_result_value_as_float: type: number description: '' title: Lab result value as float scanned_in_result: readOnly: true type: string description: Scanned in PDF for this lab result (optional). title: Scanned in result title: type: string description: '' title: Title lab_order_status: enum: - '' - Order Entered - Discontinued - In Progress - Results Received - Results Reviewed with Patient - Paper Order type: string description: Status of the lab order. title: Status lab_imported_from_ccr: readOnly: true type: string description: Imported CCR document that contains lab results. title: Lab imported from ccr id: readOnly: true type: integer description: '' title: ID lab_result_value_units: type: string description: '' title: Result units x-verbose-required: [] LabVendorLocation: required: - name - facility_code type: object properties: vendor_name: readOnly: true type: string description: '' title: Vendor name facility_code: type: string description: Used for identifying the lab in orders and results title: Facility code id: readOnly: true type: integer description: '' title: ID name: type: string description: '' title: Name x-verbose-required: [] LabOrder: required: - sublab - doctor - patient type: object properties: status: type: string description: 'Equivalent to HL7''s ORC.5. Defaults to `"N"`. Value | Notes ----- | ----- `"N"` | not sent | `"Q"` | queued for processing | `"A"` | `ABN (Advance Beneficiary Notice)` required | `"S"` | send | `"R"` | results received | `"E"` | error | ' title: Status documents: items: type: string description: ID of an associated lab document title: '' readOnly: true type: array description: Associated `/lab_documents` objects title: Documents patient: type: integer description: '' title: Patient doctor: type: integer description: '' title: Doctor timestamp: readOnly: true type: string description: Time at which the order was submitted. Defaults to now title: Timestamp notes: type: string description: '' title: Notes accession_number: type: string description: For external use only title: Accession number requisition_id: readOnly: true type: string description: The ID printed on the requisition PDF. Generally the same as id. title: Requisition id external_requisition_id: type: string description: Alternative requisition ID field for orders created outside of DrChrono. title: External Requisition ID priority: enum: - N - S type: string description: '`"Normal"` or `"STAT"`. Default `"Normal"`' title: Priority icd10_codes: items: title: ICD10Code type: object description: '' properties: code: type: string description: The numeric ICD-10 code title: Code description: readOnly: true type: string description: Short description of the ICD-10 code title: Description type: array description: ICD-10 codes of the conditions which the tests concerns. title: Icd10 codes sublab: type: integer description: '' title: Sublab id: readOnly: true type: integer description: '' title: ID x-verbose-required: [] TelemedicineAppointment: x-verbose-required: [] required: - appointment type: object description: The Telehealth Appointment endpoint is an extension of the existing Appointment endpoint. properties: sent_patient_email: description: Whether a confirmation email was sent to the Patient or not appointment: type: integer description: The Appointment related to the Telehealth Appointment, analagous to the /api/appointments resource id title: Appointment created_at: readOnly: true type: string description: UTC Timestamp for when the Telehealth Appointment was created title: Created at updated_at: readOnly: true type: string description: UTC Timestamp for when the Telehealth Appointment was updated title: Updated at overlapping_duration: type: string description: The duration that counts only if patient and doctor are in the video room title: Overlapping duration duration: readOnly: true type: integer description: Length of an appointment in minutes title: Duration telehealth_url: readOnly: true type: string description: URL used to access Telehealth Appointment title: Telehealth url AsyncResourceError: properties: status: type: string description: Either "Error" or "Failed" title: Status uuid: type: string description: The UUID used to get the data for the asynchronous request title: UUID detail: type: string description: Instructions on what to do next title: Detail AppointmentTemplate: x-verbose-required: - open_slots required: - office - exam_room - scheduled_time - profile type: object description: Appointment templates are blocks of time during which a doctor usually sees appointments with the same profile. These may have a longer duration then the corresponding profile, in which case they may allow multiple appointments to be booked during that period. properties: profile: type: integer description: ID of the appointment profile to default to title: Profile scheduled_time: type: string description: '' title: Scheduled time archived: readOnly: true type: boolean description: Indicats that the object has been soft-deleted and should not be used title: Archived week_days: items: type: integer description: '' title: '' type: array description: Array of integers that indicate week days (`0` = Monday, ..., `6` = Sunday) title: Week days office: type: integer description: '' title: Office open_slots: items: title: Open Slot type: object description: '' properties: start: type: string description: '' title: Start end: type: string description: '' title: End type: array description: Array of time intervals during which the template is available. Only computed if the available and verbose query parameters are passed. Note that only slots long enough to fit an appointment with the corresponding profile are included. title: Open Slots date_end: type: string description: '' title: Date end date_start: type: string description: '' title: Date start exam_room: type: integer description: '**1-based** index for the exam room' title: Exam room duration: type: integer description: Length of an appointment in minutes title: Duration id: readOnly: true type: integer description: '' title: ID Appointment: required: - doctor - exam_room - office - patient - scheduled_time type: object properties: status: enum: - '' - Arrived - Checked In - Checked In Online - In Room - In Session - Complete - Confirmed - Not Confirmed - Rescheduled - Cancelled - No Show type: string description: One of ``, `Arrived`, `Checked In`, `In Room`, `Cancelled`, `Complete`, `Confirmed`, `In Session`, `No Show`, `Not Confirmed`, or `Rescheduled`. Or one of the custom statuses. title: Status icd9_codes: items: type: string description: '' title: '' type: array description: '' title: ICD9 Codes office: type: integer description: Office ID title: Office base_recurring_appointment: readOnly: true type: string description: ID of base appointment of a recurring series title: Base recurring appointment color: type: string description: '' title: Color vitals: title: SystemVitals type: object description: Clinical vitals associated with the appointment properties: height_units: type: string description: '' title: Height units weight_units: type: string description: '' title: Weight units pain: type: string description: 0-10 pain scale. title: Pain temperature: type: number description: '' title: Temperature weight: type: number description: '' title: Weight smoking_status: enum: - blank - '449868002' - '428041000124106' - '8517006' - '266919005' - '77176002' - '266927001' - '428071000124103' - '428061000124105' type: string description: '' title: Smoking status head_circumference: type: number description: '' title: Head circumference bmi: readOnly: true type: string description: '' title: Bmi head_circumference_units: type: string description: '' title: Head circumference units blood_pressure_2: type: integer description: '' title: Blood pressure 2 blood_pressure_1: type: integer description: '' title: Blood pressure 1 height: type: number description: '' title: Height pulse: type: integer description: Beats per minute. title: Pulse oxygen_saturation: type: number description: '' title: Oxygen saturation respiratory_rate: type: integer description: Breathes per minute. title: Respiratory rate temperature_units: type: string description: '' title: Temperature units first_billed_date: readOnly: true type: string description: '' title: First billed date last_billed_date: readOnly: true type: string description: '' title: Last billed date billing_status: type: string description: Should be one of `Auto Accident Claim`, `Balance Due`, `Bill Insurance`, `Bill Secondary Insurance`, `Durable Medical Equipment Claim`, `Internal Review`, `Paid In Full`, `Settled`, `Worker's Comp Claim` or one of the custom billing status title: Billing status primary_insurer_payer_id: readOnly: true type: string description: '' title: Primary insurer payer id duration: type: integer description: Length of the appointment in minutes. Optional if `profile` is provided. title: Duration appt_is_break: type: boolean description: '' title: Appt is break id: readOnly: true type: string description: Unique identifier. Usually numeric, but not always title: Id custom_fields: items: title: CustomAppointmentFieldValue type: object description: '' properties: field_type: type: integer description: '' title: Field type created_at: readOnly: true type: string description: '' title: Created at updated_at: readOnly: true type: string description: '' title: Updated at field_value: type: string description: '' title: Field value type: array description: Custom appointment fields title: Custom fields scheduled_time: type: string description: The starting time of the appointment title: Scheduled time secondary_insurer_name: readOnly: true type: string description: '' title: Secondary insurer name doctor: type: integer description: Doctor ID title: Doctor recur_start_date: type: string description: For recurring appointments, the start date of the recurring series title: Recur start date primary_insurance_id_number: readOnly: true type: string description: '' title: Primary insurance id number created_by: readOnly: true type: string description: '' title: Created by ins2_status: readOnly: true enum: - '' - Incomplete Information - In Process Emdeon - Rejected Emdeon - Rejected EPS - Rejected Jopari - In Process Payor - Rejected Waystar Professional - Rejected Waystar Institutional - In Process Payer - Payer Acknowledged - Rejected Payor - Rejected Payer - Paid in Full - Partially Paid - Coordination of Benefits - ERA Received - ERA Denied - HCFA Form Faxed type: string description: Billing status of secondary insurer title: Ins2 status first_edi_date: readOnly: true type: string description: '' title: First edi date billing_notes: items: title: ClaimBillingNotes type: object description: Structure of a billing note properties: text: type: string description: Content of the note title: Text created_at: readOnly: true type: string description: '' title: Created at appointment: type: integer description: '' title: Appointment id: readOnly: true type: integer description: ID of the billing note title: ID created_by: readOnly: true type: string description: '' title: Created by readOnly: true type: array description: Billing notes of the appointment. For writing, check `/api/claim_billing_notes` title: Billing notes is_walk_in: type: boolean description: Whether the appointment is a walk-in appointment title: Is walk in billing_provider: type: string description: '' title: Billing provider reminder_profile: type: string description: Write-only. ID of an `/api/reminder_profiles` instance. Set this to apply a reminder profile to the appointment. Cannot be applied to an appointment with reminders. title: Reminder profile primary_insurer_name: readOnly: true type: string description: '' title: Primary insurer name profile: type: integer description: ID of an `/api/appointment_profiles` instance. The profile sets default values for `color`, `duration`, and `reason` on creation, which can be overriden by setting these values explicitly. title: Profile resubmit_claim_original_id: type: integer description: ID of this claim id. title: resubmit_claim_original_id patient: type: integer description: ID of this appointment's patient. Breaks have a null patient field. title: Patient recurrence_instance_key: readOnly: true nullable: true type: string description: A stable identifier for a recurring appointment instance, in the format `{rootSeriesId}_{YYYYMMDD}` where `YYYYMMDD` is the original occurrence date, not the current scheduled date. This value remains consistent across materialization, series splits, and rescheduling, so it should be treated as an opaque identifier rather than a source for display dates. Returns null for non-recurring appointments. Only present when the `consistent_recurrence_id` feature flag is enabled. title: Recurrence instance key cloned_from: type: integer description: ID of the original appointment which this appointment cloned from. Will be null if the appointment is not cloned. title: Cloned From extended_updated_at: readOnly: true type: string description: The most recent update time among appointment itself, its vitals and its custom vitals title: Extended updated at exam_room: type: integer description: Index of the exam room that this appointment occurs in. See `/api/offices` title: Exam room updated_at: readOnly: true type: string description: '' title: Updated at reason: type: string description: Default to `""` title: Reason last_edi_date: readOnly: true type: string description: '' title: Last edi date secondary_insurer_payer_id: readOnly: true type: string description: '' title: Secondary insurer payer id allow_overlapping: type: boolean description: Bypass overlap check. title: Allow overlapping payment_profile: type: string description: Appointment Payment Profile title: Payment profile secondary_insurance_id_number: readOnly: true type: string description: '' title: Secondary insurance id number clinical_note: title: ClinicalNote type: object description: Associated clinical note object properties: pdf: readOnly: true type: string description: '' title: Pdf locked: type: boolean description: '' title: Locked updated_at: type: string description: '' title: Updated at custom_vitals: items: title: CustomVitalValue type: object description: '' properties: value: type: string description: '' title: Value vital_type: type: integer description: '' title: Vital type type: array description: Custom vitals associated with this appointment. title: Custom vitals is_virtual_base: readOnly: true type: boolean description: '' title: Is virtual base recurring_appointment: type: boolean description: Whether the appointment is a recurring appointment or not title: Recurring appointment supervising_provider: type: string description: Supervising provider of appointment if set. title: Supervising provider recurring_days: type: array description: For recurring appointments, the days of the week on which the appointment recurs. Can include Monday, Tuesday, Wednesday, Thursday, Friday, Saturday or Sunday title: Recurring days status_transitions: items: title: AppointmentStatusTransition type: object description: '' properties: appointment: readOnly: true type: string description: '' title: Appointment to_status: readOnly: true type: string description: '' title: To status from_status: readOnly: true type: string description: '' title: From status datetime: readOnly: true type: string description: '' title: Datetime readOnly: true type: array description: '' title: Status transitions created_at: readOnly: true type: string description: '' title: Created at reminders: items: title: SimpleReminder type: object description: '' properties: scheduled_time: readOnly: true type: string description: '' title: Scheduled time type: enum: - email - sms - phone - auto_call type: string description: '' title: Type id: readOnly: true type: integer description: '' title: ID readOnly: true type: array description: Scheduled reminders of the appointment title: Reminders ins1_status: readOnly: true enum: - '' - Incomplete Information - In Process Emdeon - Rejected Emdeon - Rejected EPS - Rejected Jopari - In Process Payor - Rejected Waystar Professional - Rejected Waystar Institutional - In Process Payer - Payer Acknowledged - Rejected Payor - Rejected Payer - Paid in Full - Partially Paid - Coordination of Benefits - ERA Received - ERA Denied - HCFA Form Faxed type: string description: Billing status of primary insurer title: Ins1 status custom_status: type: string description: AppointmentStatus Name title: AppointmentStatus recur_end_date: type: string description: For recurring appointments, the end date of the recurring series title: Recur end date icd10_codes: items: type: string description: '' title: '' type: array description: '' title: Icd10 codes deleted_flag: readOnly: true type: boolean description: Whether the appointment is deleted. title: Deleted flag notes: type: string description: '' title: Notes recurs_every: type: integer description: For recurring appointments, the number of weeks between recurrences. For example, if this is 2, the appointment recurs every other week. title: Recurs every x-verbose-required: - reminders - vitals - custom_fields - custom_vitals - clinical_note - extended_updated_at - status_transitions CustomPatientFieldType: required: - doctor - name type: object properties: archived: type: boolean description: Indicates that the object has been soft-deleted, and should not be used title: Archived description: type: string description: '' title: Description doctor: type: integer description: '' title: Doctor template_name: type: string description: Custom Patient Demographics with `template_name` set can be inserted into clinical notes via Form Builder. Only letters (a-z or A-Z), numbers (0-9) or underscore(_) are allowed for template name. title: Template name allowed_values: type: string description: Allowed values if needed. Values must be separated by comma `,` title: Allowed values id: readOnly: true type: integer description: '' title: ID name: type: string description: '' title: Name x-verbose-required: [] YellowNotepad: required: - appointment_id - template_id - content type: object properties: content: type: string description: The yellow notepad text content title: Content template_id: readOnly: true type: integer description: ID of the associated clinical note template title: Template ID appointment_id: readOnly: true type: integer description: ID of the associated appointment title: Appointment ID ClaimBillingNotes: required: - appointment type: object properties: text: type: string description: '' title: Text created_at: readOnly: true type: string description: '' title: Created at appointment: type: integer description: '' title: Appointment id: readOnly: true type: integer description: '' title: ID created_by: readOnly: true type: string description: ID of `/users` when created the note title: Created by x-verbose-required: [] LabOrderDocument: required: - lab_order - document - type type: object properties: hl7: type: string description: The HL7 data that the document was generated from title: HL7 timestamp: readOnly: true type: string description: Time at which the document was uploaded title: Timestamp lab_order: type: integer description: ID of the order this document is associated with title: Lab order document: type: string description: '' title: Document type: enum: - REQ - ABN - R-A - RES type: string description: ' Value | Notes ----- | ----- `"REQ"` | requisition form | `"ABN"` | `ABN (Advance Beneficiary Notice)` | `"R-A"` | requisition form and :abbr:`ABN (Advance Beneficiary Notice)` | `"RES"` | lab results | ' title: Type id: readOnly: true type: integer description: '' title: ID x-verbose-required: [] PatientFlagType: required: - doctor - name type: object properties: archived: readOnly: true type: boolean description: Indicates the flag type is soft-deleted and should not be used title: Archived name: type: string description: Name of the patient flag type title: Name doctor: type: integer description: Doctor who owns the flag type title: Doctor color: type: string description: '' title: Color created_at: readOnly: true type: string description: '' title: Created at updated_at: readOnly: true type: string description: '' title: Updated at priority: type: integer description: Priority of the flag type title: Priority id: readOnly: true type: integer description: '' title: ID x-verbose-required: [] SoapNoteLineItemFieldType: required: [] type: object properties: comment: type: string description: Comment title: Comment archived: type: boolean description: Indicates that the field has been soft-deleted by the doctor and will not be used in future notes title: Archived clinical_note_template: readOnly: true type: string description: ID of the `/api/clinical_note_templates` object that the field belongs to title: Clinical note template data_type: type: string description: One of `""`, `"Checkbox"`, `"NullCheckbox"`, `"String"`, `"TwoStrings"`, `"FreeDraw"`, `"Photo"`, `"Header"`, `"Subheader"` title: Data type required: type: boolean description: Indicates that a note should not be locked unless a value is provided for this field title: Required allowed_values: items: type: string description: Value option title: '' type: array description: Value options the field type relies on if applicable, otherwise it will be an empty array title: Allowed values id: readOnly: true type: integer description: '' title: ID name: type: string description: '' title: Name x-verbose-required: [] securitySchemes: drchrono_oauth2: type: oauth2 description: '' flows: authorizationCode: scopes: billing:patient-payment:read: View patient payment information billing:read: View billing information. patients:read: View detailed patient information. user:write: Edit select account information, such as creating new exam rooms. messages:write: Create and modify messages in your message center. messages:read: View messages in your message center. tasks:write: Create and modify tasks in your tasks center tasks:read: View tasks in your tasks center labs:write: Create and modify patient lab orders and results. patients:write: Create patients and modify detailed patient information. settings:write: Create resources that requires Settings permission, such as custom fields. billing:patient-payment:write: Modify patient payment information clinical:write: Create and modify clinical information, such as vitals, clinical notes, medications and diagnoses. patients:summary:write: Create new patients and set their name, chart_id, age, and gender. calendar:read: View your appointments. user:read: View your basic information. billing:write: Modify billing information. settings:read: View resources that requires Settings permission, such as custom fields. labs:read: View patient lab orders and results. calendar:write: Schedule appointments and modify the data associated with them. patients:summary:read: View summary information about your patients. This includes patients' name, chart_id, age, and gender. clinical:read: View clinical information, such as vitals, clinical notes, medications and diagnoses. tokenUrl: https://app.drchrono.com/o/token/ authorizationUrl: https://app.drchrono.com/o/authorize/