CareCloud integration guide
VerifiedHow to connect CareCloud to WEXTL and use its 12 triggers and 63 actions in your workflows. About CareCloud: Manage patients, appointments, charges and referrals in CareCloud.
- 12 triggers
- 41 searches
- 22 actions
- Polling
- Auth: OAuth
AI-assisted documentation24 min read
This documentation is compiled from our integration source code, internal specs for CareCloud, its official API documentation and anonymized requests logs we collect from our support team[2].
Requirements
Get your CareCloud credentials
You’ll be redirected to sign in and approve access. Your password is never shared with WEXTL.
- API KeytextRequired
Sign in to the CareCloud Developer Portal, select Add New App, configure and submit the OAuth application, and register the WEXTL OAuth Redirect URL shown above the Client ID field as its redirect URL. After completing any required CareCloud security approval, copy the Client ID shown on the My App page of the application and enter it here. These credentials are not available in a regular CareCloud practice account.[1]
- Secret KeypasswordRequired
On the My App page of the registered application in the CareCloud Developer Portal, copy the Client Secret displayed with the Client ID and enter it here. If you do not have one, create an application and complete any required CareCloud security approval first. Store the secret securely.[1]
Connect CareCloud in WEXTL
- Log in to your WEXTL account, add the CareCloud node module to your workflow, and click Create new credential.
- Optional: In the Credential name field, enter a name for the credential.
- Enter the authentication credentials you copied from your CareCloud account, or follow the on-screen instructions to create the credential.
- If prompted, authenticate your account and confirm access.
- If you want to make changes to your credential in the future, follow the steps in Manage credentials →
CareCloud triggers and actions on WEXTL
The list below is a reference of every CareCloud node module the integration supports. You will be able to pick any of them on the workflow canvas while building automations.
Open any CareCloud node module below to inspect its input parameters, outputs, and connection requirements.
Watch Appointment Confirmations
TriggerFires when a visit gains a confirmation.
| Field | Type |
|---|---|
| Appointment Confirmation | object |
| Appointment Id | number |
| Comments | text |
| Communication Method | text |
| Communication Method Description | text |
| Communication Outcome | text |
| Created At | date |
| Date Confirmed | date |
| Id | number |
| Updated At | date |
Watch Appointment Notes
TriggerFires when a visit gains a comment.
| Field | Type |
|---|---|
| Id | number |
| Text | text |
| Note Trigger | object |
| Actions | array |
| Expires At | text |
Watch Appointment Recalls
TriggerFires for each recall newly created in CareCloud.
| Field | Type |
|---|---|
| Id | number |
| Comments | text |
| Recall At | date |
| Recall Type | object |
| Id | number |
| Name | text |
| Description | text |
| Recall Status | object |
| Name | text |
| Code | text |
| Patient | object |
| Id | text |
| Preferred Communication Method | text |
Watch Appointment Resources
TriggerFires when a bookable room or device appears.
| Field | Type |
|---|---|
| Resource | object |
| Appointment Confirmation | text |
| Business Entity Id | number |
| Code | text |
| Created At | date |
| Created By | number |
| Description | text |
| Id | number |
| Is For Requests | boolean |
| Name | text |
| Sort Code | number |
Watch Appointments for Today
TriggerFires for new visits on the daily list.
| Field | Type |
|---|---|
| Appointment | object |
| Id | text |
| Appointment Status | object |
| Patient | object |
| Location | object |
| Cancellation Details | object |
| Chief Complaint | text |
| Appointment Cancellation Reason Id | text |
| Arrived At | date |
| Business Entity Id | number |
| Comments | text |
Watch Document Sources
TriggerFires when a document origin is defined.
| Field | Type |
|---|---|
| Id | number |
| Name | text |
| Code | text |
| Description | text |
| Status | text |
| Sort Code | number |
| Created At | date |
| Updated At | date |
| Is Custom | boolean |
Watch Employers
TriggerFires when a search finds a new employer.
| Field | Type |
|---|---|
| Id | number |
| Name | text |
| Phone | object |
| Id | number |
| Phone Number | text |
| Phone Type Code | number |
| Extension | text |
| Address | object |
| Id | number |
| Line1 | text |
| Line2 | text |
| City | text |
| State | text |
| State Code | text |
| Zip Code | text |
| Country Name | text |
Watch Patient Charges
TriggerCharge feed that follows a single patient.
| Field | Type |
|---|---|
| Id | number |
| Amount | text |
| Balance | text |
| Unapplied Credit | number |
| Effective Date | date |
| Service Date | date |
| Posting Date | date |
| Transaction Type | text |
| Transaction Status | text |
| Location Id | number |
| Provider Id | number |
| Procedure Code | text |
| Units | text |
| Diagnosis Code S | text |
| Description | text |
Watch Patient Notes
TriggerFires when a chart gains a comment.
| Field | Type |
|---|---|
| Id | number |
| Text | text |
| Note Trigger | object |
| Actions | array |
| Expires At | text |
Watch Patient Transactions
TriggerAccount posting feed for a patient.
| Field | Type |
|---|---|
| Id | number |
| Amount | text |
| Balance | text |
| Unapplied Credit | number |
| Effective Date | date |
| Service Date | date |
| Posting Date | date |
| Transaction Type | text |
| Transaction Status | text |
| Location Id | number |
| Provider Id | number |
| Procedure Code | text |
| Units | text |
| Diagnosis Code S | text |
| Description | text |
Watch Payers
TriggerFires when a search finds a new insurer.
| Field | Type |
|---|---|
| Id | number |
| Name | text |
| Sender Number | text |
| Addresses | array |
| Phones | array |
| Plans | array |
Watch Waitlist Entries
TriggerWaitlist changes for a cancelled slot.
| Field | Type |
|---|---|
| Value | text |
Create a Patient Charge
SearchBills a procedure to a patient.
| Field | Type |
|---|---|
Patient IdRequired | choice |
ChargeRequired | object |
| Provider Id | choice |
| Insurance Profile Id | text |
| Referring Physician Id | text |
| Authorization Id | text |
| Clinical Case Id | text |
| Location Id | choice |
| Encounter Id | text |
Start TimeRequired | text |
End TimeRequired | text |
UnitsRequired | text |
LimitRequired | number |
| Field | Type |
|---|---|
| Id | number |
| Encounter Id | number |
Get a CCDA Request
ActionResult of an earlier document request.
| Field | Type |
|---|---|
Ccda IdRequired | text |
| Field | Type |
|---|---|
| Response | object |
Get an Appointment Recall
ActionSingle recall looked up by its record ID.
| Field | Type |
|---|---|
IdRequired | choice |
| Field | Type |
|---|---|
| Recall | object |
| Id | number |
| Comments | text |
| Recall At | text |
| Recall Type | object |
| Recall Status | object |
| Patient | object |
List Appointment Blockouts
SearchBlocked time windows on a schedule.
| Field | Type |
|---|---|
| Location Id | choice |
| Resource Id | choice |
| Start Date | date |
| End Date | date |
LimitRequired | number |
| Field | Type |
|---|---|
| Appointment Blockout | object |
| Business Entity Id | number |
| Created At | text |
| Description | text |
| Effective From | text |
| Effective To | text |
| End Minutes | number |
| Id | number |
| Name | text |
| Start At | number |
| End At | number |
List Appointment Cancellation Reasons
SearchReasons selectable when cancelling a visit.
| Field | Type |
|---|---|
| Global Only | boolean |
LimitRequired | number |
| Field | Type |
|---|---|
| Appointment Cancellation Reason | object |
| Business Entity Id | text |
| Code | text |
| Created At | text |
| Description | text |
| Id | number |
| Is Default | boolean |
| Name | text |
| Sort Code | number |
| Updated At | text |
List Appointment Confirmations
SearchConfirmation history of a single visit.
| Field | Type |
|---|---|
Appointment IdRequired | choice |
LimitRequired | number |
| Field | Type |
|---|---|
| Appointment Confirmation | object |
| Appointment Id | number |
| Comments | text |
| Communication Method | text |
| Communication Method Description | text |
| Communication Outcome | text |
| Created At | text |
| Date Confirmed | text |
| Id | number |
| Updated At | text |
List Appointment Notes
SearchComments attached to a visit.
| Field | Type |
|---|---|
Appointment IdRequired | choice |
LimitRequired | number |
| Field | Type |
|---|---|
| Id | number |
| Text | text |
| Note Trigger | object |
| Actions | array |
| Expires At | text |
List Appointment Recall Types
SearchRecall type values available in CareCloud.
| Field | Type |
|---|---|
LimitRequired | number |
| Field | Type |
|---|---|
| Recall Type | object |
| Id | number |
| Description | text |
| Name | text |
| Created At | text |
| Updated At | text |
List Appointment Recalls
SearchRecalls filtered by date range and status.
| Field | Type |
|---|---|
| Start Date | date |
| End Date | date |
| Recall Status | text |
LimitRequired | number |
| Field | Type |
|---|---|
| Recall | object |
| Id | number |
| Comments | text |
| Recall At | text |
| Recall Type | object |
| Recall Status | object |
| Patient | object |
List Appointment Resources
SearchSchedulable resources from the CareCloud calendar.
| Field | Type |
|---|---|
LimitRequired | number |
| Field | Type |
|---|---|
| Resource | object |
| Appointment Confirmation | text |
| Business Entity Id | number |
| Code | text |
| Created At | text |
| Created By | number |
| Description | text |
| Id | number |
| Is For Requests | boolean |
| Name | text |
| Sort Code | number |
List Appointment Resources for a Visit Reason
SearchBookable resources valid for a reason.
| Field | Type |
|---|---|
Visit Reason IdRequired | choice |
LimitRequired | number |
| Field | Type |
|---|---|
| Resource | object |
| Appointment Confirmation | text |
| Business Entity Id | number |
| Code | text |
| Created At | text |
| Created By | number |
| Description | text |
| Id | number |
| Is For Requests | boolean |
| Name | text |
| Sort Code | number |
List Appointment Statuses
SearchStatus values a visit can carry.
| Field | Type |
|---|---|
LimitRequired | number |
| Field | Type |
|---|---|
| Appointment Status | object |
| Code | text |
| Id | text |
| Name | text |
List Appointment Templates
SearchSchedule patterns across locations.
| Field | Type |
|---|---|
| Start Date | date |
| End Date | date |
| Location Id | choice |
| Resource Id | choice |
LimitRequired | number |
| Field | Type |
|---|---|
| Appointment Template | object |
| Id | number |
| Name | text |
| Locations | array |
| Resources | array |
| Visit Reasons | array |
| Business Entity Id | number |
| Description | text |
| Timezone Name | text |
| Effective From | text |
| Effective To | text |
List Appointment Templates by Resource
SearchSchedule patterns that apply to one resource.
| Field | Type |
|---|---|
| Start Date | date |
| End Date | date |
| Location Id | choice |
Resource IdRequired | choice |
LimitRequired | number |
| Field | Type |
|---|---|
| Appointment Template | object |
| Id | number |
| Name | text |
| Locations | array |
| Resources | array |
| Visit Reasons | array |
| Business Entity Id | number |
| Description | text |
| Timezone Name | text |
| Effective From | text |
| Effective To | text |
List Appointments
SearchScheduled visits matching your filters.
| Field | Type |
|---|---|
| Location Id | choice |
| Resource Id | choice |
| Start Date | date |
| End Date | date |
| Visit Reason Ids | text |
| Patient Ids | choice |
LimitRequired | number |
| Field | Type |
|---|---|
| Appointment | object |
| Id | text |
| Appointment Status | object |
| Patient | object |
| Location | object |
| Cancellation Details | object |
| Chief Complaint | text |
| Appointment Cancellation Reason Id | text |
| Arrived At | text |
| Business Entity Id | number |
| Comments | text |
List Available Appointment Time Slots
SearchOpen times grouped by location and resource.
| Field | Type |
|---|---|
Start DateRequired | date |
Visit Reason IdRequired | choice |
Location IdsRequired | choice |
Resource IdsRequired | choice |
End DateRequired | date |
| Meridian | text |
| Dow | text |
| Duration | text |
LimitRequired | number |
| Field | Type |
|---|---|
| Location | object |
| Id | number |
| Name | text |
| Visit Reason | object |
| Id | number |
| Name | text |
| Resource | object |
| Id | number |
| Name | text |
| Slots | array |
List Document Sources
SearchOrigins available for stored documents.
| Field | Type |
|---|---|
LimitRequired | number |
| Field | Type |
|---|---|
| Id | number |
| Name | text |
| Code | text |
| Description | text |
| Status | text |
| Sort Code | number |
| Created At | date |
| Updated At | date |
| Is Custom | boolean |
List Employers
SearchEmployers kept in the directory.
| Field | Type |
|---|---|
| Id | number |
LimitRequired | number |
| Field | Type |
|---|---|
| Id | number |
| Name | text |
| Phone | object |
| Id | number |
| Phone Number | text |
| Phone Type Code | number |
| Extension | text |
| Address | object |
| Id | number |
| Line1 | text |
| Line2 | text |
| City | text |
| State | text |
| State Code | text |
| Zip Code | text |
| Country Name | text |
List Locations
SearchPractice sites and their service codes.
| Field | Type |
|---|---|
| All Public | boolean |
LimitRequired | number |
| Field | Type |
|---|---|
| Id | text |
| Name | text |
| Is Visible Appointment Scheduler | text |
| Place Of Service Code | text |
| Address | object |
| Line1 | text |
| Line2 | text |
| Line3 | text |
| City | text |
| Zip Code | text |
| County Name | text |
| Latitude | text |
| Longitude | text |
| State Name | text |
| Phones | array |
List Patient Charges
SearchBilled items for a patient over time.
| Field | Type |
|---|---|
Patient IdRequired | choice |
| Start Date | date |
| End Date | date |
LimitRequired | number |
| Field | Type |
|---|---|
| Id | number |
| Amount | text |
| Balance | text |
| Unapplied Credit | number |
| Effective Date | date |
| Service Date | date |
| Posting Date | date |
| Transaction Type | text |
| Transaction Status | text |
| Location Id | number |
| Provider Id | number |
| Procedure Code | text |
| Units | text |
| Diagnosis Code S | text |
| Description | text |
List Patient Notes
SearchComments written on a chart.
| Field | Type |
|---|---|
Patient IdRequired | choice |
LimitRequired | number |
| Field | Type |
|---|---|
| Id | number |
| Text | text |
| Note Trigger | object |
| Actions | array |
| Expires At | text |
List Patient Transactions
SearchAccount postings for a patient.
| Field | Type |
|---|---|
Patient IdRequired | choice |
| Start Date | date |
| End Date | date |
LimitRequired | number |
| Field | Type |
|---|---|
| Id | number |
| Amount | text |
| Balance | text |
| Unapplied Credit | number |
| Effective Date | date |
| Service Date | date |
| Posting Date | date |
| Transaction Type | text |
| Transaction Status | text |
| Location Id | number |
| Provider Id | number |
| Procedure Code | text |
| Units | text |
| Diagnosis Code S | text |
| Description | text |
List Payers
SearchInsurers known to the practice.
| Field | Type |
|---|---|
LimitRequired | number |
| Field | Type |
|---|---|
| Payer | object |
| Id | number |
| Name | text |
| Sender Number | text |
| Addresses | array |
| Phones | array |
| Plans | array |
List Providers
SearchClinicians with contact details.
| Field | Type |
|---|---|
LimitRequired | number |
| Field | Type |
|---|---|
| Id | text |
| Npi | text |
| Name | text |
| Phone Number | text |
| Specialty | object |
| Name | text |
| Taxonomy Code | text |
List Visit Reasons
SearchAppointment purposes with descriptions.
| Field | Type |
|---|---|
| Request Types Only | boolean |
LimitRequired | number |
| Field | Type |
|---|---|
| Id | text |
| Name | text |
| Description | text |
List Visit Reasons for an Appointment Resource
SearchPurposes that one resource supports.
| Field | Type |
|---|---|
Resource IdRequired | choice |
| Request Types Only | boolean |
LimitRequired | number |
| Field | Type |
|---|---|
| Id | text |
| Name | text |
| Description | text |
Read the Waitlist
SearchPatients waiting for a freed slot.
| Field | Type |
|---|---|
Appointment IdRequired | choice |
LimitRequired | number |
| Field | Type |
|---|---|
| Id | number |
| Business Entity Id | text |
| Appointment Id | number |
| Appointment External Id | text |
| Priority | number |
| Created At | date |
| Updated At | date |
| Appointment Request | object |
| Visit Reason Id | number |
| Show Alert | number |
| Calendars | array |
| Weekday | object |
| Part Of Day | object |
| Appointment | object |
Search Employers
SearchEmployers that match your terms.
| Field | Type |
|---|---|
TermsRequired | array |
| Term | text |
LimitRequired | number |
| Field | Type |
|---|---|
| Employer | object |
| Id | number |
| Name | text |
| Phone | object |
| Address | object |
Search Patients
SearchCharts matched by terms and demographics.
| Field | Type |
|---|---|
LimitRequired | number |
SearchRequired | object |
Created FromRequired | text |
Created ToRequired | text |
TermsRequired | array |
| Term | text |
FieldsRequired | object |
First NameRequired | text |
Last NameRequired | text |
DobRequired | text |
GenderRequired | text |
Phone NumberRequired | text |
LimitRequired | number |
| Field | Type |
|---|---|
| Patients | object |
| Id | text |
| External Id | text |
| First Name | text |
| Last Name | text |
| Middle Initial | text |
| Name | text |
| Dob | text |
| Account Balance | text |
| Chart Number | text |
| Last Seen Date | text |
Search Patients by Creation Date
SearchCharts registered within a date window.
| Field | Type |
|---|---|
Created FromRequired | date |
Created ToRequired | date |
LimitRequired | number |
| Field | Type |
|---|---|
| Patients | object |
| Id | text |
| External Id | text |
| First Name | text |
| Last Name | text |
| Middle Initial | text |
| Name | text |
| Dob | text |
| Account Balance | text |
| Chart Number | text |
| Last Seen Date | text |
Search Patients by Fields
SearchCharts found through demographic details.
| Field | Type |
|---|---|
| First Name | text |
| Last Name | text |
| Date of Birth | date |
| Gender | choice |
| Phone Number | text |
LimitRequired | number |
| Field | Type |
|---|---|
| Patients | object |
| Id | text |
| External Id | text |
| First Name | text |
| Last Name | text |
| Middle Initial | text |
| Name | text |
| Dob | text |
| Account Balance | text |
| Chart Number | text |
| Last Seen Date | text |
Search Payers
SearchInsurers matched on your terms.
| Field | Type |
|---|---|
TermsRequired | array |
| Term | text |
LimitRequired | number |
| Field | Type |
|---|---|
| Payer | object |
| Id | number |
| Name | text |
| Sender Number | text |
| Addresses | array |
| Phones | array |
| Plans | array |
Search Referral Locations
SearchReferral destinations matching a name.
| Field | Type |
|---|---|
| Name | text |
LimitRequired | number |
| Field | Type |
|---|---|
| Location Id | text |
| Location Name | text |
| Addresses | array |
| Phones | array |
Search Referral Sources
SearchReferrers matched by name and type.
| Field | Type |
|---|---|
NameRequired | text |
Referral Source Type IdRequired | text |
LimitRequired | number |
| Field | Type |
|---|---|
| First Name | text |
| Last Name | text |
| Tax Id | text |
| Npi | text |
| Referral Source Type Id | text |
| Addresses | array |
| Phones | array |
Show a Patient
ActionEverything stored on one person.
| Field | Type |
|---|---|
Patient IdRequired | choice |
| Field | Type |
|---|---|
| Patient | object |
| Id | text |
| First Name | text |
| Last Name | text |
| Middle Initial | text |
| Prefix | text |
| Suffix | text |
| Preferred Name | text |
| Ssn | text |
| Name | text |
| Dob | text |
Show a Physician
ActionDoctor found through an NPI number.
| Field | Type |
|---|---|
NpiRequired | text |
| Field | Type |
|---|---|
| Physician | object |
| Npi | text |
| Prefix | text |
| First Name | text |
| Middle Initial | text |
| Last Name | text |
| Suffix | text |
| Phone Number | text |
| Gender Code | text |
| Deactivation Date | text |
Show an Appointment
ActionFull detail of one scheduled visit.
| Field | Type |
|---|---|
Appointment IdRequired | choice |
| Field | Type |
|---|---|
| Appointment | object |
| Id | text |
| Appointment Status | object |
| Patient | object |
| Location | object |
| Cancellation Details | object |
| Chief Complaint | text |
| Appointment Cancellation Reason Id | text |
| Arrived At | text |
| Business Entity Id | number |
| Comments | text |
Show an Appointment Resource
SearchDetails of a single bookable resource.
| Field | Type |
|---|---|
Resource IdRequired | choice |
LimitRequired | number |
| Field | Type |
|---|---|
| Resource | object |
| Id | number |
| Business Entity Id | number |
| Name | text |
| Code | text |
| Description | text |
| Status | text |
| Sort Code | number |
| Created At | text |
| Updated At | text |
| Is For Requests | boolean |
Show Patient Insurances
ActionCoverage profiles and policies for a patient.
| Field | Type |
|---|---|
Patient IdRequired | choice |
| Field | Type |
|---|---|
| Id | text |
| Name | text |
| Self Pay | boolean |
| Default | boolean |
| Insurance Policies | array |
Show the Balance for a Patient
SearchAged balance summary for one patient.
| Field | Type |
|---|---|
Patient IdRequired | choice |
LimitRequired | number |
| Field | Type |
|---|---|
| Balance Type | text |
| Unapplied Credit | text |
| Unbilled | text |
| Current | text |
| Greater Than 30 | text |
| Greater Than 60 | text |
| Greater Than 90 | text |
| Greater Than 120 | text |
| Total | text |
Update an Appointment Recall
SearchChanges the status and comments of a recall.
| Field | Type |
|---|---|
IdRequired | choice |
Recall StatusRequired | choice |
CommentsRequired | text |
LimitRequired | number |
| Field | Type |
|---|---|
| Recall | object |
| Id | number |
| Comments | text |
| Recall At | text |
| Recall Type | object |
| Recall Status | object |
| Patient | object |
Book an Appointment from the Waitlist
ActionTurns a waitlist request into a booked slot.
| Field | Type |
|---|---|
Appointment IdRequired | choice |
Waitlist Request IdRequired | text |
Cancel an Appointment
ActionCancels one visit and stores the reason.
| Field | Type |
|---|---|
Appointment IdRequired | choice |
Appointment Cancellation Reason IdRequired | choice |
Cancellation CommentsRequired | text |
| Communication Method | text |
| Field | Type |
|---|---|
| Appointment Id | text |
| Start Time | date |
| Appointment Cancellation Request Id | text |
| Cancellation Details | text |
| Cancellation Comments | text |
| Updated At | date |
Change an Appointment Status to Pending
ActionReverts a booked visit to its pending state.
| Field | Type |
|---|---|
Appointment IdRequired | choice |
| Field | Type |
|---|---|
| Appointment | object |
| Id | text |
| Appointment Status | object |
| Patient | object |
| Location | object |
| Cancellation Details | object |
| Chief Complaint | text |
| Appointment Cancellation Reason Id | text |
| Arrived At | text |
| Business Entity Id | number |
| Comments | text |
Check In an Appointment
ActionMarks a patient as arrived for a visit.
| Field | Type |
|---|---|
Appointment IdRequired | choice |
| Field | Type |
|---|---|
| Appointment | object |
| Id | text |
| Appointment Status | object |
| Patient | object |
| Location | object |
| Cancellation Details | object |
| Chief Complaint | text |
| Appointment Cancellation Reason Id | text |
| Arrived At | text |
| Business Entity Id | number |
| Comments | text |
Check Out an Appointment
ActionMarks a visit as completed on departure.
| Field | Type |
|---|---|
Appointment IdRequired | choice |
| Field | Type |
|---|---|
| Appointment | object |
| Id | text |
| Appointment Status | object |
| Patient | object |
| Location | object |
| Cancellation Details | object |
| Chief Complaint | text |
| Appointment Cancellation Reason Id | text |
| Arrived At | text |
| Business Entity Id | number |
| Comments | text |
Confirm an Appointment
ActionMarks a visit as confirmed by the patient.
| Field | Type |
|---|---|
Appointment IdRequired | choice |
Date ConfirmedRequired | date |
Communication Method DescriptionRequired | text |
CommentsRequired | text |
Communication MethodRequired | text |
| Field | Type |
|---|---|
| Appointment Id | number |
| Comments | text |
| Communication Method | text |
| Communication Method Description | text |
| Communication Outcome | text |
| Created At | date |
| Date Confirmed | text |
| Id | number |
| Updated At | date |
Create a CCDA Request
ActionAsks CareCloud to build a clinical document.
| Field | Type |
|---|---|
| Date | date |
| Start Date | date |
| End Date | date |
| Patient Ids | choice |
| Sections | array |
| Section | text |
| Field | Type |
|---|---|
| Business Entity Id | number |
| Created At | date |
| Created By | number |
| Document Id | text |
| Document Name | text |
| Document Url | url |
| Guid | text |
| Id | number |
| Job Id | text |
| Provider Id | number |
| Updated At | date |
| Updated By | number |
| Status | object |
| Time | number |
| Status | text |
| Uuid | text |
| Options | text |
| Name | text |
| Message | text |
Create a Patient
ActionNew chart for someone seeking care.
| Field | Type |
|---|---|
PatientRequired | object |
| First Name | text |
| Last Name | text |
| Middle Initial | text |
| Prefix | text |
| Suffix | text |
| Ssn | text |
| Chart Number | text |
| Drivers License Number | text |
| Account Number | text |
AddressesRequired | array |
PhonesRequired | array |
| Field | Type |
|---|---|
| Patient | text |
Create a Patient Insurance
ActionCoverage profile stored for a patient.
| Field | Type |
|---|---|
Patient IdRequired | choice |
Insurance ProfileRequired | object |
Responsible Party RelationshipRequired | text |
Is DefaultRequired | boolean |
Responsible PartyRequired | object |
Primary Insurance PolicyRequired | object |
Secondary Insurance PolicyRequired | object |
Tertiary Insurance PolicyRequired | object |
Quaternary Insurance PolicyRequired | object |
| Field | Type |
|---|---|
| Insurance Profile | object |
| Id | number |
| Is Default | boolean |
| Name | text |
Create a Patient Note
ActionComment saved against a patient.
| Field | Type |
|---|---|
Patient IdRequired | choice |
TextRequired | text |
| Note Trigger | object |
ActionsRequired | array |
Expires AtRequired | text |
| Field | Type |
|---|---|
| Id | number |
| Text | text |
| Note Trigger | object |
| Actions | array |
| Expires At | text |
Create a Referral Location
ActionReferral destination with a mailing address.
| Field | Type |
|---|---|
Location NameRequired | text |
Effective FromRequired | text |
AddressRequired | object |
Line1Required | text |
Line2Required | text |
CityRequired | text |
State CodeRequired | text |
Zip CodeRequired | text |
| Phones | array |
| Field | Type |
|---|---|
| Location Id | text |
Create a Referral Source
ActionReferrer linked to a patient.
| Field | Type |
|---|---|
Referral NameRequired | text |
Referral Location IdRequired | choice |
Effective FromRequired | text |
Patient IdRequired | choice |
Referral ProviderRequired | object |
First NameRequired | text |
Last NameRequired | text |
NpiRequired | text |
| Tax Id | text |
Referral Source Type IdRequired | text |
| Field | Type |
|---|---|
| Referral Source | text |
Create an Appointment
ActionNew scheduled visit in CareCloud.
| Field | Type |
|---|---|
AppointmentRequired | object |
Start TimeRequired | text |
End TimeRequired | text |
| Appointment Status Id | choice |
Location IdRequired | choice |
Provider IdRequired | choice |
Visit Reason IdRequired | choice |
Resource IdRequired | choice |
| Chief Complaint | text |
| Comments | text |
PatientRequired | object |
| Field | Type |
|---|---|
| Appointment | text |
Create an Appointment Note
ActionComment attached to a scheduled visit.
| Field | Type |
|---|---|
Appointment IdRequired | choice |
TextRequired | text |
| Note Trigger | object |
ActionsRequired | array |
Expires AtRequired | text |
| Field | Type |
|---|---|
| Id | number |
| Text | text |
| Note Trigger | object |
| Actions | array |
| Expires At | text |
Create an Employer
ActionAdds a workplace entry with phone and address.
| Field | Type |
|---|---|
EmployerRequired | object |
NameRequired | text |
| Phone | object |
| Address | object |
| Field | Type |
|---|---|
| Employer Id | text |
Log an Appointment Communication
ActionContact attempt saved on an appointment.
| Field | Type |
|---|---|
Appointment IdRequired | choice |
Communication Method DescriptionRequired | text |
CommentsRequired | text |
Communication MethodRequired | text |
Communication OutcomeRequired | text |
| Field | Type |
|---|---|
| Appointment Id | number |
| Comments | text |
| Communication Method | text |
| Communication Method Description | text |
| Communication Outcome | text |
| Created At | date |
| Id | number |
| Updated At | date |
Make an API Call
universalCustom CareCloud REST API request.
| Field | Type |
|---|---|
URLRequired | text |
MethodRequired | choice |
| Headers | array |
| Query String | array |
| Body | text |
| Field | Type |
|---|---|
| Body | text |
| Headers | object |
| Status Code | number |
Merge Clinical Transcriptions
ActionAdds dictated sections to an encounter note.
| Field | Type |
|---|---|
Encounter IdRequired | text |
Chief ComplaintRequired | array |
| Chief Complaint | text |
History Of Present IllnessRequired | array |
| History Of Present Illnes | text |
TherapyRequired | array |
| Therapy | text |
Surgical HistoryRequired | array |
| Surgical History | text |
Social HistoryRequired | array |
| Social History | text |
Past Medical HistoryRequired | array |
| Past Medical History | text |
Current MedicationsRequired | array |
| Current Medication | text |
AllergiesRequired | array |
| Allergie | text |
Family HistoryRequired | array |
| Family History | text |
Review Of SystemsRequired | array |
| Review Of System | text |
Physical ExaminationRequired | array |
| Physical Examination | text |
Diagnostic ImagingRequired | array |
| Diagnostic Imaging | text |
Impression PlanRequired | array |
| Impression Plan | text |
Update a Patient
ActionAlters details stored on a chart.
| Field | Type |
|---|---|
Patient IdRequired | choice |
PatientRequired | object |
| First Name | text |
| Last Name | text |
| Middle Initial | text |
| Prefix | text |
| Suffix | text |
| Ssn | text |
| Chart Number | text |
| Drivers License Number | text |
| Account Number | text |
AddressesRequired | array |
PhonesRequired | array |
Update a Patient Insurance Policy
ActionPolicy edits inside a coverage profile.
| Field | Type |
|---|---|
Patient IdRequired | choice |
Insurance Profile IdRequired | text |
Insurance Policy IdRequired | text |
Insurance PolicyRequired | object |
Insured Person RelationshipRequired | text |
Insurance Policy TypeRequired | text |
Member NumberRequired | text |
Group NumberRequired | text |
| Group Name | text |
Effective DateRequired | text |
| Termination Date | text |
| Requires Authorization | boolean |
| Co Payment | text |
| Deductible | text |
| Field | Type |
|---|---|
| Insurance Profile | object |
| Id | number |
| Name | text |
| Insurance Policy | object |
| Id | number |
| Priority | number |
| Payer Pending Approval | boolean |
| Updated At | text |
Templates
Look for CareCloud templates in the WEXTL template library.
Browse templates →Other support integrations on WEXTL
CharmHealth[2]Cloud EHR for patients, appointments, encounters, and clinical records.
Clio GrowManage contacts, matters, inbox leads, lead sources, and locations in Clio Grow client intake.
DaySmart VetCloud veterinary practice management for scheduling, records, and client communication.
Clio ManageManage matters, contacts, tasks, billing, documents, and calendars in Clio Manage legal practice management.
FrontShared inbox for customer email, chat, and SMS conversations.
References
- WEXTL® CareCloud Source Code connector implementation.
- Our users use cases and automations.
- Official API Documentation for CareCloud.
- WEXTL® visual workflow builder data.
Last updated: Nov 14, 2026 08:28
How we write our apps documentation
How we compile these docs: sources, the role of AI, and how we verify.





























