CharmHealth icon

CharmHealth

Cloud EHR for patients, appointments, encounters, and clinical records.

6 triggers18 searches1 actionPollingAuth: OAuth

AI-assisted documentation10 min read

This documentation is compiled from our integration source code, internal specs for CharmHealth, its official API documentation and anonymized requests logs we collect from our support team[2].

Open CharmHealth on WEXTL →

Before you set up the credential, make sure you have an active CharmHealth account and OAuth client credentials, granted by signing in with your account ready.[3]

You’ll be redirected to sign in and approve access — your password is never shared with WEXTL.

  • Client IDtext

    Log in to your account and go to the Developer / API settings page.

    [1]
  • Client Secretpassword

    Log in to your account and go to the Developer / API settings page.

    [1]
Integration requests 70 permissions:
patient/AllergyIntolerance.readpatient/Appointment.readpatient/CarePlan.readpatient/CareTeam.readpatient/Condition.readpatient/Device.readpatient/DiagnosticReport.readpatient/DocumentReference.readpatient/Encounter.readpatient/FamilyMemberHistory.readpatient/Goal.readpatient/Immunization.readpatient/MedicationAdministration.readpatient/MedicationRequest.readpatient/Observation.readpatient/Patient.readpatient/Procedure.readpatient/QuestionnaireResponse.readpatient/RelatedPerson.readuser/AllergyIntolerance.readuser/Appointment.readuser/CarePlan.readuser/CareTeam.readuser/Condition.readuser/Device.readuser/DiagnosticReport.readuser/DocumentReference.readuser/Encounter.readuser/FamilyMemberHistory.readuser/Goal.readuser/Immunization.readuser/Location.readuser/MedicationAdministration.readuser/MedicationRequest.readuser/Observation.readuser/Organization.readuser/Patient.readuser/Practitioner.readuser/Procedure.readuser/Provenance.readuser/QuestionnaireResponse.readuser/RelatedPerson.readsystem/AllergyIntolerance.readsystem/Appointment.readsystem/CarePlan.readsystem/CareTeam.readsystem/Condition.readsystem/Device.readsystem/DiagnosticReport.readsystem/DocumentReference.readsystem/Encounter.readsystem/FamilyMemberHistory.readsystem/Goal.readsystem/Immunization.readsystem/Location.readsystem/MedicationAdministration.readsystem/MedicationRequest.readsystem/Observation.readsystem/Organization.readsystem/Patient.readsystem/Practitioner.readsystem/Procedure.readsystem/Provenance.readsystem/QuestionnaireResponse.readsystem/RelatedPerson.readlaunchlaunch/patientopenidfhirUseroffline_access
  1. Log in to your WEXTL account, add the CharmHealth node module to your workflow, and click Create new credential.
  2. Optional: In the Credential name field, enter a name for the credential.
  3. Enter the authentication credentials you copied from your CharmHealth account, or follow the on-screen instructions to create the credential.
  4. If prompted, authenticate your account and confirm access.
  5. If you want to make changes to your credential in the future, follow the steps in Manage credentials →
Connecting CharmHealth to WEXTL®
Video slide demonstrates how to integrate CharmHealth in the WEXTL visual workflow builder.[4]

Notes

Credentials are org-scoped; share them with teammates from the Credentials picker on any of its nodes.For detailed information on connecting an application, see Connect an application →

Watch AppointmentsTrigger
Output fields[3]
FieldType
Resource typetext
IDtext
Metaobject
Last updatedtext
Identifierarray
Statustext
Service typearray
Appointment typeobject
Codingarray
Texttext
Descriptiontext
Startdate
Enddate
Commenttext
Patient instructiontext
Participantarray
Watch Diagnostic ReportsTrigger
Output fields[3]
FieldType
Full URLurl
Resourceobject
Resource typetext
IDtext
Metaobject
Statustext
Categoryarray
Codeobject
Subjectobject
Encounterobject
Effective date timedate
Issueddate
Watch EncountersTrigger
Output fields[3]
FieldType
Full URLurl
Resourceobject
Resource typetext
IDtext
Metaobject
Identifierarray
Statustext
Classobject
Typearray
Subjectobject
Participantarray
Periodobject
Watch PatientsTrigger
Output fields[3]
FieldType
Resource typetext
IDtext
Metaobject
Last updatedtext
Typetext
Totalnumber
Linkarray
Entryarray
Watch ProceduresTrigger
Output fields[3]
FieldType
Full URLurl
Resourceobject
Resource typetext
IDtext
Statustext
Codeobject
Subjectobject
Performed periodobject
Recorderobject
Reportarray
Watch Questionnaire ResponsesTrigger
Output fields[3]
FieldType
Resource typetext
IDtext
Statustext
Subjectobject
Referencetext
Encounterobject
Referencetext
Authoreddate
Authorobject
Referencetext
Sourceobject
Referencetext
Itemarray
Get a Care PlanAction
Input fields[3]
FieldType
IDRequired
choice
Output fields[3]
FieldType
Full URLtext
Resourceobject
Resource typetext
IDtext
Textobject
Statustext
Intenttext
Categoryarray
Subjectobject
Encounterobject
Get a Care TeamAction
Input fields[3]
FieldType
IDRequired
choice
Output fields[3]
FieldType
Resource typetext
IDtext
Statustext
Subjectobject
Referencetext
Participantarray
Get a Diagnostic ReportAction
Input fields[3]
FieldType
IDRequired
choice
Output fields[3]
FieldType
Full URLurl
Resourceobject
Resource typetext
IDtext
Metaobject
Statustext
Categoryarray
Codeobject
Subjectobject
Encounterobject
Effective date timedate
Issueddate
Get a PatientAction
Input fields[3]
FieldType
IDRequired
choice
Output fields[3]
FieldType
Resource typetext
IDtext
Metaobject
Last updatedtext
Extensionarray
Identifierarray
Activeboolean
Namearray
Telecomarray
Gendertext
Birth datedate
Addressarray
Marital statusobject
Codingarray
Texttext
Communicationarray
Get a PractitionerAction
Input fields[3]
FieldType
IDRequired
choice
Output fields[3]
FieldType
Resource typetext
IDtext
Identifierarray
Activeboolean
Namearray
Telecomarray
Addressarray
Gendertext
Get a ProcedureAction
Input fields[3]
FieldType
IDRequired
choice
Output fields[3]
FieldType
Resource typetext
IDtext
Statustext
Codeobject
Codingarray
Texttext
Subjectobject
Referencetext
Performed periodobject
Extensionarray
Recorderobject
Referencetext
Reportarray
Get a Questionnaire ResponseAction
Input fields[3]
FieldType
IDRequired
choice
Output fields[3]
FieldType
Full URLurl
Resourceobject
Resource typetext
IDtext
Statustext
Subjectobject
Encounterobject
Authoreddate
Authorobject
Sourceobject
Itemarray
Get an AppointmentAction
Input fields[3]
FieldType
IDRequired
choice
Output fields[3]
FieldType
Resource typetext
IDtext
Metaobject
Last updatedtext
Identifierarray
Statustext
Service typearray
Appointment typeobject
Codingarray
Texttext
Descriptiontext
Startdate
Enddate
Commenttext
Patient instructiontext
Participantarray
Get an EncounterAction
Input fields[3]
FieldType
IDRequired
choice
Output fields[3]
FieldType
Resource typetext
IDtext
Metaobject
Last updatedtext
Identifierarray
Statustext
Classobject
Systemtext
Codetext
Displaytext
Typearray
Subjectobject
Referencetext
Participantarray
Periodobject
Starttext
Reason codearray
Hospitalizationobject
Discharge dispositionobject
Locationarray
List AppointmentsSearch
Input fields[3]
FieldType
Identifiertext
Actortext
Statuschoice
Datedate
Rev Includetext
Limitnumber
Output fields[3]
FieldType
Full URLurl
Resourceobject
Resource typetext
IDtext
Metaobject
Identifierarray
Statustext
Service typearray
Appointment typeobject
Descriptiontext
Startdate
Enddate
List Care PlansSearch
Input fields[3]
FieldType
Patienttext
Statuschoice
Datetext
Categorychoice
Revincludetext
Limitnumber
Output fields[3]
FieldType
Full URLurl
Resourceobject
Resource typetext
IDtext
Textobject
Statustext
Intenttext
Categoryarray
Subjectobject
Encounterobject
List Care TeamsSearch
Input fields[3]
FieldType
Patienttext
Statuschoice
_RevIncludechoice
Limitnumber
Output fields[3]
FieldType
Full URLurl
Resourceobject
Resource typetext
IDtext
Statustext
Subjectobject
Participantarray
List Diagnostic ReportsSearch
Input fields[3]
FieldType
Patienttext
Categorychoice
Codetext
Datetext
Statuschoice
_RevIncludechoice
Limitnumber
Output fields[3]
FieldType
Full URLurl
Resourceobject
Resource typetext
IDtext
Metaobject
Statustext
Categoryarray
Codeobject
Subjectobject
Encounterobject
Effective date timedate
Issueddate
List EncountersSearch
Input fields[3]
FieldType
Encounter Referencetext
Patient Referencetext
Statuschoice
Classchoice
Typetext
Datetext
RevIncludetext
Encounter Identifiertext
Limitnumber
Output fields[3]
FieldType
Full URLurl
Resourceobject
Resource typetext
IDtext
Metaobject
Identifierarray
Statustext
Classobject
Typearray
Subjectobject
Participantarray
Periodobject
List PatientsSearch
Input fields[3]
FieldType
Nametext
Birthdatetext
Genderchoice
Family Nametext
Given Nametext
Identifiertext
Patient Identifiertext
Revincludechoice
Limitnumber
Output fields[3]
FieldType
Full URLurl
Resourceobject
Resource typetext
IDtext
Metaobject
Extensionarray
Identifierarray
Activeboolean
Namearray
Telecomarray
Gendertext
Birth datedate
List PractitionersSearch
Input fields[3]
FieldType
Nametext
Identifiertext
Limitnumber
Output fields[3]
FieldType
Full URLurl
Resourceobject
Resource typetext
IDtext
Identifierarray
Activeboolean
Namearray
Telecomarray
Addressarray
Gendertext
List ProceduresSearch
Input fields[3]
FieldType
Statuschoice
Patienttext
Codetext
Datedate
RevIncludetext
Limitnumber
Output fields[3]
FieldType
Full URLurl
Resourceobject
Resource typetext
IDtext
Statustext
Codeobject
Subjectobject
Performed periodobject
Recorderobject
Reportarray
List Questionnaire ResponsesSearch
Input fields[3]
FieldType
Patienttext
Statuschoice
Datedate
_RevIncludechoice
Limitnumber
Output fields[3]
FieldType
Full URLurl
Resourceobject
Resource typetext
IDtext
Statustext
Subjectobject
Encounterobject
Authoreddate
Authorobject
Sourceobject
Itemarray
Make an API Calluniversal
Input fields[3]
FieldType
URLRequired
text
MethodRequired
choice
Headersarray
Headerobject
Query Stringarray
Parameterobject
Bodytext
Output fields[3]
FieldType
Bodytext
Headersobject
Status codenumber

Look for CharmHealth templates in the WEXTL template library.

Browse templates →
  1. WEXTL® CharmHealth Source Code connector implementation.
  2. Our users use cases and automations.
  3. Official API Documentation for CharmHealth.
  4. WEXTL® visual workflow builder data.

Last updated: Jul 23, 2026 22:39