# Clinics API Web service that stores information about clinics, clinicians and their patients Version: 1.0 License: BSD-2-Clause ## Servers integration ``` https://external.integration.tidepool.org ``` production ``` https://api.tidepool.org ``` dev1 ``` https://dev1.dev.tidepool.org ``` qa1 ``` https://qa1.development.tidepool.org ``` qa2 ``` https://qa2.development.tidepool.org ``` ## Security ### sessionToken A Tidepool session token Type: apiKey In: header Name: x-tidepool-session-token ## Download OpenAPI description [Clinics API](https://tidepool.redocly.app/_spec/reference/clinic.v1.yaml) ## Clinics Manage clinics, clinians and patients. ### List Clinics - [GET /v1/clinics](https://tidepool.redocly.app/reference/clinic.v1/clinics/listclinics.md): Retrieve the list of clinics ### Create Clinic - [POST /v1/clinics](https://tidepool.redocly.app/reference/clinic.v1/clinics/createclinic.md): Create a new clinic ### Get Clinic by Share Code - [GET /v1/clinics/share_code/{shareCode}](https://tidepool.redocly.app/reference/clinic.v1/clinics/getclinicbysharecode.md): Retrieve a clinic object with a share code ### Get Clinic - [GET /v1/clinics/{clinicId}](https://tidepool.redocly.app/reference/clinic.v1/clinics/getclinic.md): Retrieve a clinic by id ### Update Clinic - [PUT /v1/clinics/{clinicId}](https://tidepool.redocly.app/reference/clinic.v1/clinics/updateclinic.md): Update an existing clinic ### Delete Clinic - [DELETE /v1/clinics/{clinicId}](https://tidepool.redocly.app/reference/clinic.v1/clinics/deleteclinic.md): Deletes a clinic if there are no connected patient accounts (besides demo accounts). ### List Clinicians - [GET /v1/clinics/{clinicId}/clinicians](https://tidepool.redocly.app/reference/clinic.v1/clinics/listclinicians.md): Retrieve the list of clinic members. ### Create Clinician - [POST /v1/clinics/{clinicId}/clinicians](https://tidepool.redocly.app/reference/clinic.v1/clinics/createclinician.md): Internal endpoint to create a new clinician ### View TIDE Report - [GET /v1/clinics/{clinicId}/tide_report](https://tidepool.redocly.app/reference/clinic.v1/clinics/tidereport.md): Retrieve a report of patients with tags by TIDE categories ### List Patients - [GET /v1/clinics/{clinicId}/patients](https://tidepool.redocly.app/reference/clinic.v1/clinics/listpatients.md): Retrieve a list of patients of a clinic ### Create Patient Account - [POST /v1/clinics/{clinicId}/patients](https://tidepool.redocly.app/reference/clinic.v1/clinics/createpatientaccount.md): Create a custodial account for a patient ### Create Patient Tag - [POST /v1/clinics/{clinicId}/patient_tags](https://tidepool.redocly.app/reference/clinic.v1/clinics/createpatienttag.md): Create a new patient tag ### Create a Site - [POST /v1/clinics/{clinicId}/sites](https://tidepool.redocly.app/reference/clinic.v1/clinics/createsite.md): Create a Site ### Update a Site - [PUT /v1/clinics/{clinicId}/sites/{siteId}](https://tidepool.redocly.app/reference/clinic.v1/clinics/updatesite.md): Update a Site ### Delete a Site - [DELETE /v1/clinics/{clinicId}/sites/{siteId}](https://tidepool.redocly.app/reference/clinic.v1/clinics/deletesite.md): Delete a Site ### Merge two sites - [POST /v1/clinics/{clinicId}/sites/{siteId}/merge](https://tidepool.redocly.app/reference/clinic.v1/clinics/mergesite.md): Merge a site, identified in the request body, into the site identified in the URL. ### Get Clinician - [GET /v1/clinics/{clinicId}/clinicians/{clinicianId}](https://tidepool.redocly.app/reference/clinic.v1/clinics/getclinician.md): Retrieve a member of clinic given their user id ### Update Clinician - [PUT /v1/clinics/{clinicId}/clinicians/{clinicianId}](https://tidepool.redocly.app/reference/clinic.v1/clinics/updateclinician.md): Update existing clinician ### Delete Clinician - [DELETE /v1/clinics/{clinicId}/clinicians/{clinicianId}](https://tidepool.redocly.app/reference/clinic.v1/clinics/deleteclinician.md): Removes a clinician from a clinic ### Get Patient - [GET /v1/clinics/{clinicId}/patients/{patientId}](https://tidepool.redocly.app/reference/clinic.v1/clinics/getpatient.md): Retrieve a patient of clinic given their user id ### Create Patient from Existing User - [POST /v1/clinics/{clinicId}/patients/{patientId}](https://tidepool.redocly.app/reference/clinic.v1/clinics/createpatientfromuser.md): Internal endpoint for creating a patient from an existing user ### Update Patient - [PUT /v1/clinics/{clinicId}/patients/{patientId}](https://tidepool.redocly.app/reference/clinic.v1/clinics/updatepatient.md): Update existing patient of a clinic ### Delete Patient - [DELETE /v1/clinics/{clinicId}/patients/{patientId}](https://tidepool.redocly.app/reference/clinic.v1/clinics/deletepatient.md): Deletes patient from a clinic. Requires the request to be made by a clinic admin or the currently authenticated user id to match the patient id. ### Update Patient Tag - [PUT /v1/clinics/{clinicId}/patient_tags/{patientTagId}](https://tidepool.redocly.app/reference/clinic.v1/clinics/updatepatienttag.md): Update existing patient tag ### Delete Patient Tag - [DELETE /v1/clinics/{clinicId}/patient_tags/{patientTagId}](https://tidepool.redocly.app/reference/clinic.v1/clinics/deletepatienttag.md): Removes a patient tag from a clinic and tagged patients ### Convert Patient Tag to Site - [POST /v1/clinics/{clinicId}/patient_tags/{patientTagId}/site](https://tidepool.redocly.app/reference/clinic.v1/clinics/convertpatienttagtosite.md): Convert a patient tag to a site. ### Invite Clinician - [POST /v1/clinics/{clinicId}/invites/clinicians](https://tidepool.redocly.app/reference/clinic.v1/clinics/inviteclinician.md): Send an invite to clinician's email address to join a clinic. ### Resend Clinician Invite - [PATCH /v1/clinics/{clinicId}/invites/clinicians/{inviteId}](https://tidepool.redocly.app/reference/clinic.v1/clinics/resendinvite.md): Resend invite to the email address of the clinician. ### Delete Invite - [DELETE /v1/clinics/{clinicId}/invites/clinicians/{inviteId}](https://tidepool.redocly.app/reference/clinic.v1/clinics/deleteinvite.md): Deletes unaccepted invite ### Associate Clinician to User - [PATCH /v1/clinics/{clinicId}/invites/clinicians/{inviteId}/clinician](https://tidepool.redocly.app/reference/clinic.v1/clinics/associatecliniciantouser.md): Internal endpoint to associate a clinician to a user. ### Delete Invited Clinician - [DELETE /v1/clinics/{clinicId}/invites/clinicians/{inviteId}/clinician](https://tidepool.redocly.app/reference/clinic.v1/clinics/deleteinvitedclinician.md): Internal endpoint to delete an invited clinician object ### Get Invited Clinician - [GET /v1/clinics/{clinicId}/invites/clinicians/{inviteId}/clinician](https://tidepool.redocly.app/reference/clinic.v1/clinics/getinvitedclinician.md): Internal endpoint to retrieve invited clinician. ### Get Patient Invites - [GET /v1/clinics/{clinicId}/invites/patients](https://tidepool.redocly.app/reference/clinic.v1/clinics/getpatientinvites.md): Retrieve the list of all pending invites from users who would like to share their accounts with the clinic and become patients. ### Accept Patient Invitation - [PUT /v1/clinics/{clinicId}/invites/patients/{inviteId}](https://tidepool.redocly.app/reference/clinic.v1/clinics/acceptpatientinvitation.md): Accept a pending invite from a user who would like to share their account with the clinic and become a patient. ### Update Patient Reviews - [PUT /v1/clinics/{clinicId}/patients/{patientId}/reviews](https://tidepool.redocly.app/reference/clinic.v1/clinics/updatepatientreviews.md): Update the patient's last reviewed date and clinician ID ### Delete Patient Reviews - [DELETE /v1/clinics/{clinicId}/patients/{patientId}/reviews](https://tidepool.redocly.app/reference/clinic.v1/clinics/deletepatientreviews.md): Revert the patient's last reviewed date to the previous set ### Update Patient Permissions - [PUT /v1/clinics/{clinicId}/patients/{patientId}/permissions](https://tidepool.redocly.app/reference/clinic.v1/clinics/updatepatientpermissions.md): Update permissions that a clinic has over a patient account. If all permissions are revoked as a result of the update, the patient profile will be removed from the clinic. Only patients can change the permissions. ### Delete Patient Permission - [DELETE /v1/clinics/{clinicId}/patients/{patientId}/permissions/{permission}](https://tidepool.redocly.app/reference/clinic.v1/clinics/deletepatientpermission.md): Remove a single permission that a clinic has over a patient account. If all permissions are revoked as a result of the update, the patient profile will be removed from the clinic. Only patients can change the permissions. ### List Clinics for Patient - [GET /v1/patients/{userId}/clinics](https://tidepool.redocly.app/reference/clinic.v1/clinics/listclinicsforpatient.md): Get all clinics a user is a patient of ### List Clinician Invites - [GET /v1/clinicians/{userId}/invites](https://tidepool.redocly.app/reference/clinic.v1/clinics/listclinicianinvites.md): Retrieve a list of the outstanding invites to join a clinic ### Dismiss Clinician Invite - [DELETE /v1/clinicians/{userId}/invites/{inviteId}](https://tidepool.redocly.app/reference/clinic.v1/clinics/dismissclinicianinvite.md): Dismisses an invite sent from a clinic to clinician ### Accept Clinician Invite - [PUT /v1/clinicians/{userId}/invites/{inviteId}](https://tidepool.redocly.app/reference/clinic.v1/clinics/acceptclinicianinvite.md): Accept an invite to join a clinic as clinician. The clinician will be associated to the currently authenticated user if the email in their profile matches the email of the invite. ### List Clinics for Clinician - [GET /v1/clinicians/{userId}/clinics](https://tidepool.redocly.app/reference/clinic.v1/clinics/listclinicsforclinician.md): Returns a list of all clinics a clinician is a member of ### Migrate Legacy Clinician Patients - [POST /v1/clinics/{clinicId}/migrations](https://tidepool.redocly.app/reference/clinic.v1/clinics/migratelegacyclinicianpatients.md): Migrate the patients of a legacy clinic account. ### Retrieve Migration Status - [GET /v1/clinics/{clinicId}/migrations](https://tidepool.redocly.app/reference/clinic.v1/clinics/listmigrations.md): ListMigrations ### Enable Clinics - [POST /v1/clinicians/{userId}/migrate](https://tidepool.redocly.app/reference/clinic.v1/clinics/enablenewclinicexperience.md): Internal only endpoint to enable new clinic experience for a legacy clinician account. Patients won't be migrated until the clinic details are populated and migration is explicitly kicked-off by blip. ### Trigger initial migration - [POST /v1/clinics/{clinicId}/migrate](https://tidepool.redocly.app/reference/clinic.v1/clinics/triggerinitialmigration.md): Trigger the initial migration ### Get Migration - [GET /v1/clinics/{clinicId}/migrations/{userId}](https://tidepool.redocly.app/reference/clinic.v1/clinics/getmigration.md): Get a migration by user id ### Update Migration - [PATCH /v1/clinics/{clinicId}/migrations/{userId}](https://tidepool.redocly.app/reference/clinic.v1/clinics/updatemigration.md): Internal endpoint to update the status of a migration ### Remove User from Clinics - [DELETE /v1/users/{userId}/clinics](https://tidepool.redocly.app/reference/clinic.v1/clinics/deleteuserfromclinics.md): Internal endpoint that deletes any user associations with clinics they are a patient or a member of. If the user is a patient of a clinic the service will delete the patient-clinic relationship. If the user is one of many admins of any clinic the service will delete the clinician-clinic relationship. If the user is the only admin of a clinic the service will: - delete the clinician record, leaving the clinic without an admin - delete all non-custodial patient relationships of the clinic - keep all custodian relationships, allowing users to claim custodial accounts with an email - keep all custodian accounts and data even if they can’t be claimed when there isn’t an email address associated with the account ### Update User Details - [POST /v1/users/{userId}/clinics](https://tidepool.redocly.app/reference/clinic.v1/clinics/updateclinicuserdetails.md): Internal endpoint to update clinician details. In the future it may be extended to support patient updates. ### List All Clinicians - [GET /v1/clinicians](https://tidepool.redocly.app/reference/clinic.v1/clinics/listallclinicians.md): Returns list of all clinician/clinic relationships in the system. Internal endpoint used for reporting purposes. ### UpdatePatientSummary - [POST /v1/patients/{patientId}/summary](https://tidepool.redocly.app/reference/clinic.v1/clinics/updatepatientsummary.md): Internal endpoint which updates the summary in all patient records which match the user id. ### DeletePatientSummary - [DELETE /v1/summaries/{summaryId}/clinics](https://tidepool.redocly.app/reference/clinic.v1/clinics/deletepatientsummary.md): Internal endpoint which deletes the summary in all patient records which match the summary id. ### Create or update a data source for a patient - [PUT /v1/patients/{userId}/data_sources](https://tidepool.redocly.app/reference/clinic.v1/clinics/updatepatientdatasources.md): Internal endpoint to upsert patient data source provider details in all their associated clinic records. ### Update Tier - [POST /v1/clinics/{clinicId}/tier](https://tidepool.redocly.app/reference/clinic.v1/clinics/updatetier.md): Internal endpoint to update clinic service tier ### Update Suppressed Notifications - [POST /v1/clinics/{clinicId}/suppressed_notifications](https://tidepool.redocly.app/reference/clinic.v1/clinics/updatesuppressednotifications.md): Endpoint to update clinic suppressed notifications ### Send Upload Reminder - [POST /v1/clinics/{clinicId}/patients/{patientId}/upload_reminder](https://tidepool.redocly.app/reference/clinic.v1/clinics/senduploadreminder.md): Sends upload reminder to the patient ### Assign Patient Tag To Clinic Patients - [POST /v1/clinics/{clinicId}/patients/assign_tag/{patientTagId}](https://tidepool.redocly.app/reference/clinic.v1/clinics/assignpatienttagtoclinicpatients.md): Assign a patient tag to a subset of clinic patients ### Delete Patient Tag From Clinic Patients - [POST /v1/clinics/{clinicId}/patients/delete_tag/{patientTagId}](https://tidepool.redocly.app/reference/clinic.v1/clinics/deletepatienttagfromclinicpatients.md): Delete a patient tag from all or a subset of clinic patients ### List Membership Restrictions - [GET /v1/clinics/{clinicId}/membership_restrictions](https://tidepool.redocly.app/reference/clinic.v1/clinics/listmembershiprestrictions.md): Returns a list of the membership restrictions that will be evaluated when a user joins a clinic. Only clinic admins can access this endpoint. ### Update Membership Restrictions - [PUT /v1/clinics/{clinicId}/membership_restrictions](https://tidepool.redocly.app/reference/clinic.v1/clinics/updatemembershiprestrictions.md): An internal endpoint to update clinic membership restrictions ### Redox EHR Endpoint - [POST /v1/redox](https://tidepool.redocly.app/reference/clinic.v1/clinics/processehrmessage.md): An endpoint for incoming Redox messages ### Redox Verify Endpoint - [POST /v1/redox/verify](https://tidepool.redocly.app/reference/clinic.v1/clinics/verifyendpoint.md): Internal endpoint for Redox challenge verification ### Get EHR Settings - [GET /v1/clinics/{clinicId}/settings/ehr](https://tidepool.redocly.app/reference/clinic.v1/clinics/getehrsettings.md): Returns EHR related settings ### Update EHR Settings - [PUT /v1/clinics/{clinicId}/settings/ehr](https://tidepool.redocly.app/reference/clinic.v1/clinics/updateehrsettings.md): Update EHR related settings for a clinic ### Match Clinic and Patient - [POST /v1/redox/match](https://tidepool.redocly.app/reference/clinic.v1/clinics/matchclinicandpatient.md): An internal endpoint used for matching an EHR request (e.g. NewOrder) to a clinic and patient. If a clinic with the provided details cannot be found, the service will return and will not attempt to match patients to the provided details. Due to lack of uniqueness constraints on the MRN and DOB fields it's possible that multiple patient records match the provided attributes. All results will be returned in the response and it's the calling services responsiblity to determine how to handle duplicates records. If a unique match is found, the patient matching criteria will be added to the patient record for future use (e.g. pushing data on a schedule). ### Get MRN Settings - [GET /v1/clinics/{clinicId}/settings/mrn](https://tidepool.redocly.app/reference/clinic.v1/clinics/getmrnsettings.md): Retrieve MRN settings ### Update MRN Settings - [PUT /v1/clinics/{clinicId}/settings/mrn](https://tidepool.redocly.app/reference/clinic.v1/clinics/updatemrnsettings.md): Update MRN Settings ### Get Patient Count Settings - [GET /v1/clinics/{clinicId}/settings/patient_count](https://tidepool.redocly.app/reference/clinic.v1/clinics/getpatientcountsettings.md): Get Patient Count settings ### Update Patient Count Settings - [PUT /v1/clinics/{clinicId}/settings/patient_count](https://tidepool.redocly.app/reference/clinic.v1/clinics/updatepatientcountsettings.md): Update Patient Count Settings ### Get Patient Count - [GET /v1/clinics/{clinicId}/patient_count](https://tidepool.redocly.app/reference/clinic.v1/clinics/getpatientcount.md): Get Patient Count ### Sync EHR Data - [POST /v1/clinics/{clinicId}/ehr/sync](https://tidepool.redocly.app/reference/clinic.v1/clinics/syncehrdata.md): An internal endpoint which will push the latest patient summary statistics and PDF reports for all patients who have an active subscription. The actual data is pushed asynchronously. A successful response means that an asynchronous task has been scheduled for each patient of the clinic with an active subscription. Will return 404 Not Found if the clinic does not have an active EHR connection. ### Find Patients - [GET /v1/patients](https://tidepool.redocly.app/reference/clinic.v1/clinics/findpatients.md): Returns all patients to which the clinician has access to ### Preorder Form Webhook - [POST /v1/xealth/preorder](https://tidepool.redocly.app/reference/clinic.v1/clinics/xealthpreorder.md): The Preorder endpoint can be invoked when a care provider attempts to place an order manually within the EHR. Subscribers can use Preorder Forms to present additional information to, or receive input from, a care provider before an order can be placed. Preorder Forms can also be implemented so as to prevent an order from being placed entirely. https://sandbox.xealth.io/app/api-docs#tag/Digital-Care/paths/preorder/post ### Get Programs - [PUT /v1/xealth/programs](https://tidepool.redocly.app/reference/clinic.v1/clinics/xealthgetprograms.md) ### Get Program Url - [PUT /v1/xealth/program](https://tidepool.redocly.app/reference/clinic.v1/clinics/xealthgetprogramurl.md) ### Notification Webhook - [POST /v1/xealth/notification](https://tidepool.redocly.app/reference/clinic.v1/clinics/xealthnotification.md) ### View PDF Report - [GET /v1/xealth/report/web/viewer.html](https://tidepool.redocly.app/reference/clinic.v1/clinics/viewpdfreport.md): View PDF report for a given patient of a clinic ### Add Service Account - [POST /v1/clinics/{clinicId}/service_accounts](https://tidepool.redocly.app/reference/clinic.v1/clinics/addserviceaccount.md): Adds authentication client's service account as a new clinician member. ### Sync EHR Data for Patient - [POST /v1/patients/{patientId}/ehr/sync](https://tidepool.redocly.app/reference/clinic.v1/clinics/syncehrdataforpatient.md): An internal endpoint which will push the latest patient summary statistics and PDF reports to all EHR enabled clinics for which the patient has an active subscription. The actual data is pushed asynchronously. A successful response means that an asynchronous task has been scheduled. A 404 response will be returned if no active subscriptions can be found for given patient. ### Generate Clinic Merge Report - [POST /v1/clinics/{clinicId}/reports/merge](https://tidepool.redocly.app/reference/clinic.v1/clinics/generatemergereport.md): Generates a spreadsheet report for merging two clinics ### Merge Clinic - [POST /v1/clinics/{clinicId}/merge](https://tidepool.redocly.app/reference/clinic.v1/clinics/mergeclinic.md): Merges tags, patients, clinicians, invites and share codes of the source clinic ### Connect Provider - [POST /v1/clinics/{clinicId}/patients/{patientId}/connect/{providerId}](https://tidepool.redocly.app/reference/clinic.v1/clinics/connectprovider.md): Send a new request to the patient to connect a data provider ### Invite Clinician - [POST /v1/clinics/{clinicId}/invites/clinicians](https://tidepool.redocly.app/reference/clinic.v1/confirmations/inviteclinician.md): Send an invite to clinician's email address to join a clinic. ### Resend Clinician Invite - [PATCH /v1/clinics/{clinicId}/invites/clinicians/{inviteId}](https://tidepool.redocly.app/reference/clinic.v1/confirmations/resendinvite.md): Resend invite to the email address of the clinician. ### Delete Invite - [DELETE /v1/clinics/{clinicId}/invites/clinicians/{inviteId}](https://tidepool.redocly.app/reference/clinic.v1/confirmations/deleteinvite.md): Deletes unaccepted invite ### Get Patient Invites - [GET /v1/clinics/{clinicId}/invites/patients](https://tidepool.redocly.app/reference/clinic.v1/confirmations/getpatientinvites.md): Retrieve the list of all pending invites from users who would like to share their accounts with the clinic and become patients. ### Accept Patient Invitation - [PUT /v1/clinics/{clinicId}/invites/patients/{inviteId}](https://tidepool.redocly.app/reference/clinic.v1/confirmations/acceptpatientinvitation.md): Accept a pending invite from a user who would like to share their account with the clinic and become a patient. ### List Clinician Invites - [GET /v1/clinicians/{userId}/invites](https://tidepool.redocly.app/reference/clinic.v1/confirmations/listclinicianinvites.md): Retrieve a list of the outstanding invites to join a clinic ### Dismiss Clinician Invite - [DELETE /v1/clinicians/{userId}/invites/{inviteId}](https://tidepool.redocly.app/reference/clinic.v1/confirmations/dismissclinicianinvite.md): Dismisses an invite sent from a clinic to clinician ### Accept Clinician Invite - [PUT /v1/clinicians/{userId}/invites/{inviteId}](https://tidepool.redocly.app/reference/clinic.v1/confirmations/acceptclinicianinvite.md): Accept an invite to join a clinic as clinician. The clinician will be associated to the currently authenticated user if the email in their profile matches the email of the invite. ### Migrate Legacy Clinician Patients - [POST /v1/clinics/{clinicId}/migrations](https://tidepool.redocly.app/reference/clinic.v1/internal/migratelegacyclinicianpatients.md): Migrate the patients of a legacy clinic account. ### Retrieve Migration Status - [GET /v1/clinics/{clinicId}/migrations](https://tidepool.redocly.app/reference/clinic.v1/internal/listmigrations.md): ListMigrations ### Enable Clinics - [POST /v1/clinicians/{userId}/migrate](https://tidepool.redocly.app/reference/clinic.v1/internal/enablenewclinicexperience.md): Internal only endpoint to enable new clinic experience for a legacy clinician account. Patients won't be migrated until the clinic details are populated and migration is explicitly kicked-off by blip. ### Trigger initial migration - [POST /v1/clinics/{clinicId}/migrate](https://tidepool.redocly.app/reference/clinic.v1/internal/triggerinitialmigration.md): Trigger the initial migration ### Get Migration - [GET /v1/clinics/{clinicId}/migrations/{userId}](https://tidepool.redocly.app/reference/clinic.v1/internal/getmigration.md): Get a migration by user id ### Update Migration - [PATCH /v1/clinics/{clinicId}/migrations/{userId}](https://tidepool.redocly.app/reference/clinic.v1/internal/updatemigration.md): Internal endpoint to update the status of a migration ### Remove User from Clinics - [DELETE /v1/users/{userId}/clinics](https://tidepool.redocly.app/reference/clinic.v1/internal/deleteuserfromclinics.md): Internal endpoint that deletes any user associations with clinics they are a patient or a member of. If the user is a patient of a clinic the service will delete the patient-clinic relationship. If the user is one of many admins of any clinic the service will delete the clinician-clinic relationship. If the user is the only admin of a clinic the service will: - delete the clinician record, leaving the clinic without an admin - delete all non-custodial patient relationships of the clinic - keep all custodian relationships, allowing users to claim custodial accounts with an email - keep all custodian accounts and data even if they can’t be claimed when there isn’t an email address associated with the account ### Update User Details - [POST /v1/users/{userId}/clinics](https://tidepool.redocly.app/reference/clinic.v1/internal/updateclinicuserdetails.md): Internal endpoint to update clinician details. In the future it may be extended to support patient updates. ### List All Clinicians - [GET /v1/clinicians](https://tidepool.redocly.app/reference/clinic.v1/internal/listallclinicians.md): Returns list of all clinician/clinic relationships in the system. Internal endpoint used for reporting purposes. ### UpdatePatientSummary - [POST /v1/patients/{patientId}/summary](https://tidepool.redocly.app/reference/clinic.v1/internal/updatepatientsummary.md): Internal endpoint which updates the summary in all patient records which match the user id. ### DeletePatientSummary - [DELETE /v1/summaries/{summaryId}/clinics](https://tidepool.redocly.app/reference/clinic.v1/internal/deletepatientsummary.md): Internal endpoint which deletes the summary in all patient records which match the summary id. ### Create or update a data source for a patient - [PUT /v1/patients/{userId}/data_sources](https://tidepool.redocly.app/reference/clinic.v1/internal/updatepatientdatasources.md): Internal endpoint to upsert patient data source provider details in all their associated clinic records. ### Update Tier - [POST /v1/clinics/{clinicId}/tier](https://tidepool.redocly.app/reference/clinic.v1/internal/updatetier.md): Internal endpoint to update clinic service tier ### Assign Patient Tag To Clinic Patients - [POST /v1/clinics/{clinicId}/patients/assign_tag/{patientTagId}](https://tidepool.redocly.app/reference/clinic.v1/internal/assignpatienttagtoclinicpatients.md): Assign a patient tag to a subset of clinic patients ### Delete Patient Tag From Clinic Patients - [POST /v1/clinics/{clinicId}/patients/delete_tag/{patientTagId}](https://tidepool.redocly.app/reference/clinic.v1/internal/deletepatienttagfromclinicpatients.md): Delete a patient tag from all or a subset of clinic patients ### Update Membership Restrictions - [PUT /v1/clinics/{clinicId}/membership_restrictions](https://tidepool.redocly.app/reference/clinic.v1/internal/updatemembershiprestrictions.md): An internal endpoint to update clinic membership restrictions ### Redox EHR Endpoint - [POST /v1/redox](https://tidepool.redocly.app/reference/clinic.v1/internal/processehrmessage.md): An endpoint for incoming Redox messages ### Redox Verify Endpoint - [POST /v1/redox/verify](https://tidepool.redocly.app/reference/clinic.v1/internal/verifyendpoint.md): Internal endpoint for Redox challenge verification ### Get EHR Settings - [GET /v1/clinics/{clinicId}/settings/ehr](https://tidepool.redocly.app/reference/clinic.v1/internal/getehrsettings.md): Returns EHR related settings ### Update EHR Settings - [PUT /v1/clinics/{clinicId}/settings/ehr](https://tidepool.redocly.app/reference/clinic.v1/internal/updateehrsettings.md): Update EHR related settings for a clinic ### Match Clinic and Patient - [POST /v1/redox/match](https://tidepool.redocly.app/reference/clinic.v1/internal/matchclinicandpatient.md): An internal endpoint used for matching an EHR request (e.g. NewOrder) to a clinic and patient. If a clinic with the provided details cannot be found, the service will return and will not attempt to match patients to the provided details. Due to lack of uniqueness constraints on the MRN and DOB fields it's possible that multiple patient records match the provided attributes. All results will be returned in the response and it's the calling services responsiblity to determine how to handle duplicates records. If a unique match is found, the patient matching criteria will be added to the patient record for future use (e.g. pushing data on a schedule). ### Get MRN Settings - [GET /v1/clinics/{clinicId}/settings/mrn](https://tidepool.redocly.app/reference/clinic.v1/internal/getmrnsettings.md): Retrieve MRN settings ### Update MRN Settings - [PUT /v1/clinics/{clinicId}/settings/mrn](https://tidepool.redocly.app/reference/clinic.v1/internal/updatemrnsettings.md): Update MRN Settings ### Update Patient Count Settings - [PUT /v1/clinics/{clinicId}/settings/patient_count](https://tidepool.redocly.app/reference/clinic.v1/internal/updatepatientcountsettings.md): Update Patient Count Settings ### Sync EHR Data - [POST /v1/clinics/{clinicId}/ehr/sync](https://tidepool.redocly.app/reference/clinic.v1/internal/syncehrdata.md): An internal endpoint which will push the latest patient summary statistics and PDF reports for all patients who have an active subscription. The actual data is pushed asynchronously. A successful response means that an asynchronous task has been scheduled for each patient of the clinic with an active subscription. Will return 404 Not Found if the clinic does not have an active EHR connection. ### Preorder Form Webhook - [POST /v1/xealth/preorder](https://tidepool.redocly.app/reference/clinic.v1/internal/xealthpreorder.md): The Preorder endpoint can be invoked when a care provider attempts to place an order manually within the EHR. Subscribers can use Preorder Forms to present additional information to, or receive input from, a care provider before an order can be placed. Preorder Forms can also be implemented so as to prevent an order from being placed entirely. https://sandbox.xealth.io/app/api-docs#tag/Digital-Care/paths/preorder/post ### Get Programs - [PUT /v1/xealth/programs](https://tidepool.redocly.app/reference/clinic.v1/internal/xealthgetprograms.md) ### Get Program Url - [PUT /v1/xealth/program](https://tidepool.redocly.app/reference/clinic.v1/internal/xealthgetprogramurl.md) ### Notification Webhook - [POST /v1/xealth/notification](https://tidepool.redocly.app/reference/clinic.v1/internal/xealthnotification.md) ### View PDF Report - [GET /v1/xealth/report/web/viewer.html](https://tidepool.redocly.app/reference/clinic.v1/internal/viewpdfreport.md): View PDF report for a given patient of a clinic ### Add Service Account - [POST /v1/clinics/{clinicId}/service_accounts](https://tidepool.redocly.app/reference/clinic.v1/internal/addserviceaccount.md): Adds authentication client's service account as a new clinician member. ### Sync EHR Data for Patient - [POST /v1/patients/{patientId}/ehr/sync](https://tidepool.redocly.app/reference/clinic.v1/internal/syncehrdataforpatient.md): An internal endpoint which will push the latest patient summary statistics and PDF reports to all EHR enabled clinics for which the patient has an active subscription. The actual data is pushed asynchronously. A successful response means that an asynchronous task has been scheduled. A 404 response will be returned if no active subscriptions can be found for given patient. ### Merge Clinic - [POST /v1/clinics/{clinicId}/merge](https://tidepool.redocly.app/reference/clinic.v1/internal/mergeclinic.md): Merges tags, patients, clinicians, invites and share codes of the source clinic ### Connect Provider - [POST /v1/clinics/{clinicId}/patients/{patientId}/connect/{providerId}](https://tidepool.redocly.app/reference/clinic.v1/internal/connectprovider.md): Send a new request to the patient to connect a data provider ### Redox EHR Endpoint - [POST /v1/redox](https://tidepool.redocly.app/reference/clinic.v1/redox/processehrmessage.md): An endpoint for incoming Redox messages ### Redox Verify Endpoint - [POST /v1/redox/verify](https://tidepool.redocly.app/reference/clinic.v1/redox/verifyendpoint.md): Internal endpoint for Redox challenge verification ## Confirmations Manage confirmations for account creation, sharing invites, etc. ### Invite Clinician - [POST /v1/clinics/{clinicId}/invites/clinicians](https://tidepool.redocly.app/reference/clinic.v1/clinics/inviteclinician.md): Send an invite to clinician's email address to join a clinic. ### Resend Clinician Invite - [PATCH /v1/clinics/{clinicId}/invites/clinicians/{inviteId}](https://tidepool.redocly.app/reference/clinic.v1/clinics/resendinvite.md): Resend invite to the email address of the clinician. ### Delete Invite - [DELETE /v1/clinics/{clinicId}/invites/clinicians/{inviteId}](https://tidepool.redocly.app/reference/clinic.v1/clinics/deleteinvite.md): Deletes unaccepted invite ### Get Patient Invites - [GET /v1/clinics/{clinicId}/invites/patients](https://tidepool.redocly.app/reference/clinic.v1/clinics/getpatientinvites.md): Retrieve the list of all pending invites from users who would like to share their accounts with the clinic and become patients. ### Accept Patient Invitation - [PUT /v1/clinics/{clinicId}/invites/patients/{inviteId}](https://tidepool.redocly.app/reference/clinic.v1/clinics/acceptpatientinvitation.md): Accept a pending invite from a user who would like to share their account with the clinic and become a patient. ### List Clinician Invites - [GET /v1/clinicians/{userId}/invites](https://tidepool.redocly.app/reference/clinic.v1/clinics/listclinicianinvites.md): Retrieve a list of the outstanding invites to join a clinic ### Dismiss Clinician Invite - [DELETE /v1/clinicians/{userId}/invites/{inviteId}](https://tidepool.redocly.app/reference/clinic.v1/clinics/dismissclinicianinvite.md): Dismisses an invite sent from a clinic to clinician ### Accept Clinician Invite - [PUT /v1/clinicians/{userId}/invites/{inviteId}](https://tidepool.redocly.app/reference/clinic.v1/clinics/acceptclinicianinvite.md): Accept an invite to join a clinic as clinician. The clinician will be associated to the currently authenticated user if the email in their profile matches the email of the invite. ### Invite Clinician - [POST /v1/clinics/{clinicId}/invites/clinicians](https://tidepool.redocly.app/reference/clinic.v1/confirmations/inviteclinician.md): Send an invite to clinician's email address to join a clinic. ### Resend Clinician Invite - [PATCH /v1/clinics/{clinicId}/invites/clinicians/{inviteId}](https://tidepool.redocly.app/reference/clinic.v1/confirmations/resendinvite.md): Resend invite to the email address of the clinician. ### Delete Invite - [DELETE /v1/clinics/{clinicId}/invites/clinicians/{inviteId}](https://tidepool.redocly.app/reference/clinic.v1/confirmations/deleteinvite.md): Deletes unaccepted invite ### Get Clinician Invite - [GET /v1/clinics/{clinicId}/invites/clinicians/{inviteId}](https://tidepool.redocly.app/reference/clinic.v1/confirmations/getclinicianinvite.md): Retrieve an invitation sent to clinician to join the clinic ### Get Patient Invites - [GET /v1/clinics/{clinicId}/invites/patients](https://tidepool.redocly.app/reference/clinic.v1/confirmations/getpatientinvites.md): Retrieve the list of all pending invites from users who would like to share their accounts with the clinic and become patients. ### Accept Patient Invitation - [PUT /v1/clinics/{clinicId}/invites/patients/{inviteId}](https://tidepool.redocly.app/reference/clinic.v1/confirmations/acceptpatientinvitation.md): Accept a pending invite from a user who would like to share their account with the clinic and become a patient. ### List Clinician Invites - [GET /v1/clinicians/{userId}/invites](https://tidepool.redocly.app/reference/clinic.v1/confirmations/listclinicianinvites.md): Retrieve a list of the outstanding invites to join a clinic ### Dismiss Clinician Invite - [DELETE /v1/clinicians/{userId}/invites/{inviteId}](https://tidepool.redocly.app/reference/clinic.v1/confirmations/dismissclinicianinvite.md): Dismisses an invite sent from a clinic to clinician ### Accept Clinician Invite - [PUT /v1/clinicians/{userId}/invites/{inviteId}](https://tidepool.redocly.app/reference/clinic.v1/confirmations/acceptclinicianinvite.md): Accept an invite to join a clinic as clinician. The clinician will be associated to the currently authenticated user if the email in their profile matches the email of the invite. ## Internal APIs intended for internal use by Tidepool. ### Migrate Legacy Clinician Patients - [POST /v1/clinics/{clinicId}/migrations](https://tidepool.redocly.app/reference/clinic.v1/clinics/migratelegacyclinicianpatients.md): Migrate the patients of a legacy clinic account. ### Retrieve Migration Status - [GET /v1/clinics/{clinicId}/migrations](https://tidepool.redocly.app/reference/clinic.v1/clinics/listmigrations.md): ListMigrations ### Enable Clinics - [POST /v1/clinicians/{userId}/migrate](https://tidepool.redocly.app/reference/clinic.v1/clinics/enablenewclinicexperience.md): Internal only endpoint to enable new clinic experience for a legacy clinician account. Patients won't be migrated until the clinic details are populated and migration is explicitly kicked-off by blip. ### Trigger initial migration - [POST /v1/clinics/{clinicId}/migrate](https://tidepool.redocly.app/reference/clinic.v1/clinics/triggerinitialmigration.md): Trigger the initial migration ### Get Migration - [GET /v1/clinics/{clinicId}/migrations/{userId}](https://tidepool.redocly.app/reference/clinic.v1/clinics/getmigration.md): Get a migration by user id ### Update Migration - [PATCH /v1/clinics/{clinicId}/migrations/{userId}](https://tidepool.redocly.app/reference/clinic.v1/clinics/updatemigration.md): Internal endpoint to update the status of a migration ### Remove User from Clinics - [DELETE /v1/users/{userId}/clinics](https://tidepool.redocly.app/reference/clinic.v1/clinics/deleteuserfromclinics.md): Internal endpoint that deletes any user associations with clinics they are a patient or a member of. If the user is a patient of a clinic the service will delete the patient-clinic relationship. If the user is one of many admins of any clinic the service will delete the clinician-clinic relationship. If the user is the only admin of a clinic the service will: - delete the clinician record, leaving the clinic without an admin - delete all non-custodial patient relationships of the clinic - keep all custodian relationships, allowing users to claim custodial accounts with an email - keep all custodian accounts and data even if they can’t be claimed when there isn’t an email address associated with the account ### Update User Details - [POST /v1/users/{userId}/clinics](https://tidepool.redocly.app/reference/clinic.v1/clinics/updateclinicuserdetails.md): Internal endpoint to update clinician details. In the future it may be extended to support patient updates. ### List All Clinicians - [GET /v1/clinicians](https://tidepool.redocly.app/reference/clinic.v1/clinics/listallclinicians.md): Returns list of all clinician/clinic relationships in the system. Internal endpoint used for reporting purposes. ### UpdatePatientSummary - [POST /v1/patients/{patientId}/summary](https://tidepool.redocly.app/reference/clinic.v1/clinics/updatepatientsummary.md): Internal endpoint which updates the summary in all patient records which match the user id. ### DeletePatientSummary - [DELETE /v1/summaries/{summaryId}/clinics](https://tidepool.redocly.app/reference/clinic.v1/clinics/deletepatientsummary.md): Internal endpoint which deletes the summary in all patient records which match the summary id. ### Create or update a data source for a patient - [PUT /v1/patients/{userId}/data_sources](https://tidepool.redocly.app/reference/clinic.v1/clinics/updatepatientdatasources.md): Internal endpoint to upsert patient data source provider details in all their associated clinic records. ### Update Tier - [POST /v1/clinics/{clinicId}/tier](https://tidepool.redocly.app/reference/clinic.v1/clinics/updatetier.md): Internal endpoint to update clinic service tier ### Assign Patient Tag To Clinic Patients - [POST /v1/clinics/{clinicId}/patients/assign_tag/{patientTagId}](https://tidepool.redocly.app/reference/clinic.v1/clinics/assignpatienttagtoclinicpatients.md): Assign a patient tag to a subset of clinic patients ### Delete Patient Tag From Clinic Patients - [POST /v1/clinics/{clinicId}/patients/delete_tag/{patientTagId}](https://tidepool.redocly.app/reference/clinic.v1/clinics/deletepatienttagfromclinicpatients.md): Delete a patient tag from all or a subset of clinic patients ### Update Membership Restrictions - [PUT /v1/clinics/{clinicId}/membership_restrictions](https://tidepool.redocly.app/reference/clinic.v1/clinics/updatemembershiprestrictions.md): An internal endpoint to update clinic membership restrictions ### Redox EHR Endpoint - [POST /v1/redox](https://tidepool.redocly.app/reference/clinic.v1/clinics/processehrmessage.md): An endpoint for incoming Redox messages ### Redox Verify Endpoint - [POST /v1/redox/verify](https://tidepool.redocly.app/reference/clinic.v1/clinics/verifyendpoint.md): Internal endpoint for Redox challenge verification ### Get EHR Settings - [GET /v1/clinics/{clinicId}/settings/ehr](https://tidepool.redocly.app/reference/clinic.v1/clinics/getehrsettings.md): Returns EHR related settings ### Update EHR Settings - [PUT /v1/clinics/{clinicId}/settings/ehr](https://tidepool.redocly.app/reference/clinic.v1/clinics/updateehrsettings.md): Update EHR related settings for a clinic ### Match Clinic and Patient - [POST /v1/redox/match](https://tidepool.redocly.app/reference/clinic.v1/clinics/matchclinicandpatient.md): An internal endpoint used for matching an EHR request (e.g. NewOrder) to a clinic and patient. If a clinic with the provided details cannot be found, the service will return and will not attempt to match patients to the provided details. Due to lack of uniqueness constraints on the MRN and DOB fields it's possible that multiple patient records match the provided attributes. All results will be returned in the response and it's the calling services responsiblity to determine how to handle duplicates records. If a unique match is found, the patient matching criteria will be added to the patient record for future use (e.g. pushing data on a schedule). ### Get MRN Settings - [GET /v1/clinics/{clinicId}/settings/mrn](https://tidepool.redocly.app/reference/clinic.v1/clinics/getmrnsettings.md): Retrieve MRN settings ### Update MRN Settings - [PUT /v1/clinics/{clinicId}/settings/mrn](https://tidepool.redocly.app/reference/clinic.v1/clinics/updatemrnsettings.md): Update MRN Settings ### Update Patient Count Settings - [PUT /v1/clinics/{clinicId}/settings/patient_count](https://tidepool.redocly.app/reference/clinic.v1/clinics/updatepatientcountsettings.md): Update Patient Count Settings ### Sync EHR Data - [POST /v1/clinics/{clinicId}/ehr/sync](https://tidepool.redocly.app/reference/clinic.v1/clinics/syncehrdata.md): An internal endpoint which will push the latest patient summary statistics and PDF reports for all patients who have an active subscription. The actual data is pushed asynchronously. A successful response means that an asynchronous task has been scheduled for each patient of the clinic with an active subscription. Will return 404 Not Found if the clinic does not have an active EHR connection. ### Preorder Form Webhook - [POST /v1/xealth/preorder](https://tidepool.redocly.app/reference/clinic.v1/clinics/xealthpreorder.md): The Preorder endpoint can be invoked when a care provider attempts to place an order manually within the EHR. Subscribers can use Preorder Forms to present additional information to, or receive input from, a care provider before an order can be placed. Preorder Forms can also be implemented so as to prevent an order from being placed entirely. https://sandbox.xealth.io/app/api-docs#tag/Digital-Care/paths/preorder/post ### Get Programs - [PUT /v1/xealth/programs](https://tidepool.redocly.app/reference/clinic.v1/clinics/xealthgetprograms.md) ### Get Program Url - [PUT /v1/xealth/program](https://tidepool.redocly.app/reference/clinic.v1/clinics/xealthgetprogramurl.md) ### Notification Webhook - [POST /v1/xealth/notification](https://tidepool.redocly.app/reference/clinic.v1/clinics/xealthnotification.md) ### View PDF Report - [GET /v1/xealth/report/web/viewer.html](https://tidepool.redocly.app/reference/clinic.v1/clinics/viewpdfreport.md): View PDF report for a given patient of a clinic ### Add Service Account - [POST /v1/clinics/{clinicId}/service_accounts](https://tidepool.redocly.app/reference/clinic.v1/clinics/addserviceaccount.md): Adds authentication client's service account as a new clinician member. ### Sync EHR Data for Patient - [POST /v1/patients/{patientId}/ehr/sync](https://tidepool.redocly.app/reference/clinic.v1/clinics/syncehrdataforpatient.md): An internal endpoint which will push the latest patient summary statistics and PDF reports to all EHR enabled clinics for which the patient has an active subscription. The actual data is pushed asynchronously. A successful response means that an asynchronous task has been scheduled. A 404 response will be returned if no active subscriptions can be found for given patient. ### Merge Clinic - [POST /v1/clinics/{clinicId}/merge](https://tidepool.redocly.app/reference/clinic.v1/clinics/mergeclinic.md): Merges tags, patients, clinicians, invites and share codes of the source clinic ### Connect Provider - [POST /v1/clinics/{clinicId}/patients/{patientId}/connect/{providerId}](https://tidepool.redocly.app/reference/clinic.v1/clinics/connectprovider.md): Send a new request to the patient to connect a data provider ### Migrate Legacy Clinician Patients - [POST /v1/clinics/{clinicId}/migrations](https://tidepool.redocly.app/reference/clinic.v1/internal/migratelegacyclinicianpatients.md): Migrate the patients of a legacy clinic account. ### Retrieve Migration Status - [GET /v1/clinics/{clinicId}/migrations](https://tidepool.redocly.app/reference/clinic.v1/internal/listmigrations.md): ListMigrations ### Enable Clinics - [POST /v1/clinicians/{userId}/migrate](https://tidepool.redocly.app/reference/clinic.v1/internal/enablenewclinicexperience.md): Internal only endpoint to enable new clinic experience for a legacy clinician account. Patients won't be migrated until the clinic details are populated and migration is explicitly kicked-off by blip. ### Trigger initial migration - [POST /v1/clinics/{clinicId}/migrate](https://tidepool.redocly.app/reference/clinic.v1/internal/triggerinitialmigration.md): Trigger the initial migration ### Get Migration - [GET /v1/clinics/{clinicId}/migrations/{userId}](https://tidepool.redocly.app/reference/clinic.v1/internal/getmigration.md): Get a migration by user id ### Update Migration - [PATCH /v1/clinics/{clinicId}/migrations/{userId}](https://tidepool.redocly.app/reference/clinic.v1/internal/updatemigration.md): Internal endpoint to update the status of a migration ### Remove User from Clinics - [DELETE /v1/users/{userId}/clinics](https://tidepool.redocly.app/reference/clinic.v1/internal/deleteuserfromclinics.md): Internal endpoint that deletes any user associations with clinics they are a patient or a member of. If the user is a patient of a clinic the service will delete the patient-clinic relationship. If the user is one of many admins of any clinic the service will delete the clinician-clinic relationship. If the user is the only admin of a clinic the service will: - delete the clinician record, leaving the clinic without an admin - delete all non-custodial patient relationships of the clinic - keep all custodian relationships, allowing users to claim custodial accounts with an email - keep all custodian accounts and data even if they can’t be claimed when there isn’t an email address associated with the account ### Update User Details - [POST /v1/users/{userId}/clinics](https://tidepool.redocly.app/reference/clinic.v1/internal/updateclinicuserdetails.md): Internal endpoint to update clinician details. In the future it may be extended to support patient updates. ### List All Clinicians - [GET /v1/clinicians](https://tidepool.redocly.app/reference/clinic.v1/internal/listallclinicians.md): Returns list of all clinician/clinic relationships in the system. Internal endpoint used for reporting purposes. ### UpdatePatientSummary - [POST /v1/patients/{patientId}/summary](https://tidepool.redocly.app/reference/clinic.v1/internal/updatepatientsummary.md): Internal endpoint which updates the summary in all patient records which match the user id. ### DeletePatientSummary - [DELETE /v1/summaries/{summaryId}/clinics](https://tidepool.redocly.app/reference/clinic.v1/internal/deletepatientsummary.md): Internal endpoint which deletes the summary in all patient records which match the summary id. ### Create or update a data source for a patient - [PUT /v1/patients/{userId}/data_sources](https://tidepool.redocly.app/reference/clinic.v1/internal/updatepatientdatasources.md): Internal endpoint to upsert patient data source provider details in all their associated clinic records. ### Update Tier - [POST /v1/clinics/{clinicId}/tier](https://tidepool.redocly.app/reference/clinic.v1/internal/updatetier.md): Internal endpoint to update clinic service tier ### Assign Patient Tag To Clinic Patients - [POST /v1/clinics/{clinicId}/patients/assign_tag/{patientTagId}](https://tidepool.redocly.app/reference/clinic.v1/internal/assignpatienttagtoclinicpatients.md): Assign a patient tag to a subset of clinic patients ### Delete Patient Tag From Clinic Patients - [POST /v1/clinics/{clinicId}/patients/delete_tag/{patientTagId}](https://tidepool.redocly.app/reference/clinic.v1/internal/deletepatienttagfromclinicpatients.md): Delete a patient tag from all or a subset of clinic patients ### Update Membership Restrictions - [PUT /v1/clinics/{clinicId}/membership_restrictions](https://tidepool.redocly.app/reference/clinic.v1/internal/updatemembershiprestrictions.md): An internal endpoint to update clinic membership restrictions ### Redox EHR Endpoint - [POST /v1/redox](https://tidepool.redocly.app/reference/clinic.v1/internal/processehrmessage.md): An endpoint for incoming Redox messages ### Redox Verify Endpoint - [POST /v1/redox/verify](https://tidepool.redocly.app/reference/clinic.v1/internal/verifyendpoint.md): Internal endpoint for Redox challenge verification ### Get EHR Settings - [GET /v1/clinics/{clinicId}/settings/ehr](https://tidepool.redocly.app/reference/clinic.v1/internal/getehrsettings.md): Returns EHR related settings ### Update EHR Settings - [PUT /v1/clinics/{clinicId}/settings/ehr](https://tidepool.redocly.app/reference/clinic.v1/internal/updateehrsettings.md): Update EHR related settings for a clinic ### Match Clinic and Patient - [POST /v1/redox/match](https://tidepool.redocly.app/reference/clinic.v1/internal/matchclinicandpatient.md): An internal endpoint used for matching an EHR request (e.g. NewOrder) to a clinic and patient. If a clinic with the provided details cannot be found, the service will return and will not attempt to match patients to the provided details. Due to lack of uniqueness constraints on the MRN and DOB fields it's possible that multiple patient records match the provided attributes. All results will be returned in the response and it's the calling services responsiblity to determine how to handle duplicates records. If a unique match is found, the patient matching criteria will be added to the patient record for future use (e.g. pushing data on a schedule). ### Get MRN Settings - [GET /v1/clinics/{clinicId}/settings/mrn](https://tidepool.redocly.app/reference/clinic.v1/internal/getmrnsettings.md): Retrieve MRN settings ### Update MRN Settings - [PUT /v1/clinics/{clinicId}/settings/mrn](https://tidepool.redocly.app/reference/clinic.v1/internal/updatemrnsettings.md): Update MRN Settings ### Update Patient Count Settings - [PUT /v1/clinics/{clinicId}/settings/patient_count](https://tidepool.redocly.app/reference/clinic.v1/internal/updatepatientcountsettings.md): Update Patient Count Settings ### Sync EHR Data - [POST /v1/clinics/{clinicId}/ehr/sync](https://tidepool.redocly.app/reference/clinic.v1/internal/syncehrdata.md): An internal endpoint which will push the latest patient summary statistics and PDF reports for all patients who have an active subscription. The actual data is pushed asynchronously. A successful response means that an asynchronous task has been scheduled for each patient of the clinic with an active subscription. Will return 404 Not Found if the clinic does not have an active EHR connection. ### Preorder Form Webhook - [POST /v1/xealth/preorder](https://tidepool.redocly.app/reference/clinic.v1/internal/xealthpreorder.md): The Preorder endpoint can be invoked when a care provider attempts to place an order manually within the EHR. Subscribers can use Preorder Forms to present additional information to, or receive input from, a care provider before an order can be placed. Preorder Forms can also be implemented so as to prevent an order from being placed entirely. https://sandbox.xealth.io/app/api-docs#tag/Digital-Care/paths/preorder/post ### Get Programs - [PUT /v1/xealth/programs](https://tidepool.redocly.app/reference/clinic.v1/internal/xealthgetprograms.md) ### Get Program Url - [PUT /v1/xealth/program](https://tidepool.redocly.app/reference/clinic.v1/internal/xealthgetprogramurl.md) ### Notification Webhook - [POST /v1/xealth/notification](https://tidepool.redocly.app/reference/clinic.v1/internal/xealthnotification.md) ### View PDF Report - [GET /v1/xealth/report/web/viewer.html](https://tidepool.redocly.app/reference/clinic.v1/internal/viewpdfreport.md): View PDF report for a given patient of a clinic ### Add Service Account - [POST /v1/clinics/{clinicId}/service_accounts](https://tidepool.redocly.app/reference/clinic.v1/internal/addserviceaccount.md): Adds authentication client's service account as a new clinician member. ### Sync EHR Data for Patient - [POST /v1/patients/{patientId}/ehr/sync](https://tidepool.redocly.app/reference/clinic.v1/internal/syncehrdataforpatient.md): An internal endpoint which will push the latest patient summary statistics and PDF reports to all EHR enabled clinics for which the patient has an active subscription. The actual data is pushed asynchronously. A successful response means that an asynchronous task has been scheduled. A 404 response will be returned if no active subscriptions can be found for given patient. ### Merge Clinic - [POST /v1/clinics/{clinicId}/merge](https://tidepool.redocly.app/reference/clinic.v1/internal/mergeclinic.md): Merges tags, patients, clinicians, invites and share codes of the source clinic ### Connect Provider - [POST /v1/clinics/{clinicId}/patients/{patientId}/connect/{providerId}](https://tidepool.redocly.app/reference/clinic.v1/internal/connectprovider.md): Send a new request to the patient to connect a data provider ### Redox EHR Endpoint - [POST /v1/redox](https://tidepool.redocly.app/reference/clinic.v1/redox/processehrmessage.md): An endpoint for incoming Redox messages ### Redox Verify Endpoint - [POST /v1/redox/verify](https://tidepool.redocly.app/reference/clinic.v1/redox/verifyendpoint.md): Internal endpoint for Redox challenge verification ## Redox Public endpoints invoked by Redox. ### Redox EHR Endpoint - [POST /v1/redox](https://tidepool.redocly.app/reference/clinic.v1/clinics/processehrmessage.md): An endpoint for incoming Redox messages ### Redox Verify Endpoint - [POST /v1/redox/verify](https://tidepool.redocly.app/reference/clinic.v1/clinics/verifyendpoint.md): Internal endpoint for Redox challenge verification ### Redox EHR Endpoint - [POST /v1/redox](https://tidepool.redocly.app/reference/clinic.v1/internal/processehrmessage.md): An endpoint for incoming Redox messages ### Redox Verify Endpoint - [POST /v1/redox/verify](https://tidepool.redocly.app/reference/clinic.v1/internal/verifyendpoint.md): Internal endpoint for Redox challenge verification ### Redox EHR Endpoint - [POST /v1/redox](https://tidepool.redocly.app/reference/clinic.v1/redox/processehrmessage.md): An endpoint for incoming Redox messages ### Redox Verify Endpoint - [POST /v1/redox/verify](https://tidepool.redocly.app/reference/clinic.v1/redox/verifyendpoint.md): Internal endpoint for Redox challenge verification