The eClinicalWorks connector lets your AI agent act in each user's eClinicalWorks account. Each user signs in to eClinicalWorks once, and Scalekit stores and refreshes their tokens, so your agent never handles credentials. It comes with 77 tools.
- Tools
- 77
- What they doRead · write · destructive
- 55 · 20 · 255 read20 write2 destructive
- Users sign in with
- SMART on FHIR
Setup
Install the SDK
Terminal window npm install @scalekit-sdk/node dotenvTerminal window pip install scalekit-sdk-python python-dotenvSet your credentials
Add your Scalekit credentials to your
.envfile. Find values in app.scalekit.com > Developers > API Credentials..env SCALEKIT_ENVIRONMENT_URL=<your-environment-url>SCALEKIT_CLIENT_ID=<your-client-id>SCALEKIT_CLIENT_SECRET=<your-client-secret>Create the eClinicalWorks connection
In AgentKit > Connections, create an eClinicalWorks connection. The name you give it is the
connection_nameyour code passes. See Configure connections.Console steps with screenshots
eClinicalWorks connections use SMART on FHIR and act as the signed-in clinician. Each eClinicalWorks practice has its own FHIR base URL, so each connection carries that practice’s authorization endpoint, token endpoint, audience (
aud) and FHIR server domain, plus the client ID and secret of your eClinicalWorks app.-
Create the connection and copy the redirect URI
In the Scalekit dashboard, go to AgentKit > Connections > Create Connection, find eClinicalWorks and click Create. Copy the Redirect URI.
-
Register a provider app with eClinicalWorks
Register a confidential provider app with eClinicalWorks, and note its client ID and client secret:
- Add the redirect URI exactly as you copied it, including any trailing slash. eClinicalWorks accepts only the exact registered URI.
- Request refresh tokens (
offline_access).
eClinicalWorks FHIR Support provides sandbox logins and a sandbox practice code. Tools that create, update or delete records need a signed write agreement with eClinicalWorks.
-
Find the practice’s endpoints
Each practice has its own FHIR base URL, which is also its issuer, such as
https://fhir4.eclinicalworks.com/fhir/r4/<practice-code>. Open<FHIR base>/metadata?_format=jsonand copy the authorization and token URLs it lists. -
Enter the values on the connection
Back on the eClinicalWorks connection, enter:
- Client ID and Client Secret: from your eClinicalWorks app.
- Authorization Endpoint and Token Endpoint: from the practice’s
/metadata. - Audience (aud): the practice’s full FHIR base URL.
- FHIR Server Domain: the FHIR base without
https://, including its path, such asfhir4.eclinicalworks.com/fhir/r4/<practice-code>.
Select
openid,fhirUserandoffline_access, plus the resource scopes your agent needs. Click Save.For the example practice in eClinicalWorks’ documentation, the values are below. Replace
JAFJCDwith your sandbox practice code, and read that practice’s/metadatato confirm the endpoints.Field Value Authorization Endpoint https://oauthserver.eclinicalworks.com/oauth/oauth2/authorizeToken Endpoint https://oauthserver.eclinicalworks.com/oauth/oauth2/tokenAudience (aud) https://fhir4.eclinicalworks.com/fhir/r4/JAFJCDFHIR Server Domain fhir4.eclinicalworks.com/fhir/r4/JAFJCD
-
Tools
Pass the exact name toexecute_tooleclinicalworks_allergy_intolerance_readGet one AllergyIntolerance resource from the practice's eClinicalWorks chart by its FHIR ID.Read-onlyGet Allergy Intolerance
Get one AllergyIntolerance resource from the practice's eClinicalWorks chart by its FHIR ID. Returns the AllergyIntolerance with substance code, clinical status, criticality, reactions and onset. Use eclinicalworks_allergy_intolerance_search to find allergy intolerance records when you do not have the ID.
Inputs
allergy_intolerance_idstringrequired- FHIR logical ID of the Allergy Intolerance (the `id` returned by eCW, an opaque string; not an MRN or account number). Example: 12345.
eclinicalworks_allergy_intolerance_searchSearch AllergyIntolerance resources in the practice's eClinicalWorks chart.Read-onlySearch Allergy Intolerances
Search AllergyIntolerance resources in the practice's eClinicalWorks chart. Returns a FHIR searchset Bundle of AllergyIntolerance resources with substance code, clinical status, criticality, reactions and onset. Use eclinicalworks_allergy_intolerance_read when you already have the ID. If the result has a `next` link, use `eclinicalworks_next_page` to get more.
Inputs
patientstringrequired- FHIR logical ID of the patient whose AllergyIntolerance records to return. eCW requires it on every AllergyIntolerance search. Example: 12345.
clinical_statusstring- Allergy clinical status. One of: active, inactive, resolved.one of
activeinactiveresolved encounterstring- Only return records linked to this encounter (FHIR ID of the Encounter). Example: 67890.
eclinicalworks_binary_readGet one Binary resource from the practice's eClinicalWorks chart by its FHIR ID.Read-onlyGet Binary
Get one Binary resource from the practice's eClinicalWorks chart by its FHIR ID. Returns the Binary with content type and base64 `data` of the document (C-CDA XML or a PDF report). Use it when another resource references this one by ID; eCW offers no search for this resource type. Use it to download the content that a DocumentReference or DiagnosticReport points to.
Inputs
binary_idstringrequired- FHIR logical ID of the Binary (the `id` returned by eCW, an opaque string; not an MRN or account number). Example: 12345.
eclinicalworks_care_plan_readGet one CarePlan resource from the practice's eClinicalWorks chart by its FHIR ID.Read-onlyGet Care Plan
Get one CarePlan resource from the practice's eClinicalWorks chart by its FHIR ID. Returns the CarePlan with category, status, intent, period and plan activities (upcoming appointments and pending orders). Use eclinicalworks_care_plan_search to find care plan records when you do not have the ID.
Inputs
care_plan_idstringrequired- FHIR logical ID of the Care Plan (the `id` returned by eCW, an opaque string; not an MRN or account number). Example: 12345.
eclinicalworks_care_plan_searchSearch CarePlan resources in the practice's eClinicalWorks chart.Read-onlySearch Care Plans
Search CarePlan resources in the practice's eClinicalWorks chart. Returns a FHIR searchset Bundle of CarePlan resources with category, status, intent, period and plan activities (upcoming appointments and pending orders). Use eclinicalworks_care_plan_read when you already have the ID. If the result has a `next` link, use `eclinicalworks_next_page` to get more.
Inputs
patientstringrequired- FHIR logical ID of the patient whose CarePlan records to return. eCW requires it on every CarePlan search. Example: 12345.
categorystring- Care plan category. eCW documents assess-plan.
encounterstring- Only return records linked to this encounter (FHIR ID of the Encounter). Example: 67890.
eclinicalworks_care_team_readGet one CareTeam resource from the practice's eClinicalWorks chart by its FHIR ID.Read-onlyGet Care Team
Get one CareTeam resource from the practice's eClinicalWorks chart by its FHIR ID. Returns the CareTeam with status and participants with their roles. Use eclinicalworks_care_team_search to find care team records when you do not have the ID.
Inputs
care_team_idstringrequired- FHIR logical ID of the Care Team (the `id` returned by eCW, an opaque string; not an MRN or account number). Example: 12345.
eclinicalworks_care_team_searchSearch CareTeam resources in the practice's eClinicalWorks chart.Read-onlySearch Care Teams
Search CareTeam resources in the practice's eClinicalWorks chart. Returns a FHIR searchset Bundle of CareTeam resources with status and participants with their roles. Use eclinicalworks_care_team_read when you already have the ID. If the result has a `next` link, use `eclinicalworks_next_page` to get more.
Inputs
patientstringrequired- FHIR logical ID of the patient whose CareTeam records to return. eCW requires it on every CareTeam search. Example: 12345.
statusstring- Only return records with this status. One of: active, proposed, suspended, inactive, entered-in-error.one of
activeproposedsuspendedinactiveentered-in-error
eclinicalworks_condition_readGet one Condition resource from the practice's eClinicalWorks chart by its FHIR ID.Read-onlyGet Condition
Get one Condition resource from the practice's eClinicalWorks chart by its FHIR ID. Returns the Condition with category (problem list, encounter diagnosis or health concern), ICD-10/SNOMED code, clinical and verification status and onset. Use eclinicalworks_condition_search to find condition records when you do not have the ID.
Inputs
condition_idstringrequired- FHIR logical ID of the Condition (the `id` returned by eCW, an opaque string; not an MRN or account number). Example: 12345.
eclinicalworks_condition_searchSearch Condition resources in the practice's eClinicalWorks chart.Read-onlySearch Conditions
Search Condition resources in the practice's eClinicalWorks chart. Returns a FHIR searchset Bundle of Condition resources with category (problem list, encounter diagnosis or health concern), ICD-10/SNOMED code, clinical and verification status and onset. Use eclinicalworks_condition_read when you already have the ID. If the result has a `next` link, use `eclinicalworks_next_page` to get more.
Inputs
patientstringrequired- FHIR logical ID of the patient whose Condition records to return. eCW requires it on every Condition search. Example: 12345.
categorystring- Condition category: problem-list-item (problem list), encounter-diagnosis (assessments) or health-concern.one of
problem-list-itemencounter-diagnosishealth-concern encounterstring- Only return records linked to this encounter (FHIR ID of the Encounter). Example: 67890.
onset_datestring- Filter on the condition onset date. A date (YYYY-MM-DD) or date-time, optionally prefixed with a comparison: ge, le, gt, lt or eq. Example: ge2024-01-01 for on or after 1 Jan 2024. Only one value is accepted.
eclinicalworks_coverage_readGet one Coverage resource from the practice's eClinicalWorks chart by its FHIR ID.Read-onlyGet Coverage
Get one Coverage resource from the practice's eClinicalWorks chart by its FHIR ID. Returns the Coverage with insurance status, type, subscriber, beneficiary, relationship, payor, period, class (group) and order. Use eclinicalworks_coverage_search to find coverage records when you do not have the ID.
Inputs
coverage_idstringrequired- FHIR logical ID of the Coverage (the `id` returned by eCW, an opaque string; not an MRN or account number). Example: 12345.
eclinicalworks_coverage_searchSearch Coverage resources in the practice's eClinicalWorks chart.Read-onlySearch Coverages
Search Coverage resources in the practice's eClinicalWorks chart. Returns a FHIR searchset Bundle of Coverage resources with insurance status, type, subscriber, beneficiary, relationship, payor, period, class (group) and order. Use eclinicalworks_coverage_read when you already have the ID. If the result has a `next` link, use `eclinicalworks_next_page` to get more.
Inputs
patientstringrequired- FHIR logical ID of the patient whose Coverage records to return. eCW requires it on every Coverage search. Example: 12345.
eclinicalworks_device_readGet one Device resource from the practice's eClinicalWorks chart by its FHIR ID.Read-onlyGet Device
Get one Device resource from the practice's eClinicalWorks chart by its FHIR ID. Returns the Device with implantable device type, UDI and status. Use eclinicalworks_device_search to find device records when you do not have the ID.
Inputs
device_idstringrequired- FHIR logical ID of the Device (the `id` returned by eCW, an opaque string; not an MRN or account number). Example: 12345.
eclinicalworks_device_searchSearch Device resources in the practice's eClinicalWorks chart.Read-onlySearch Devices
Search Device resources in the practice's eClinicalWorks chart. Returns a FHIR searchset Bundle of Device resources with implantable device type, UDI and status. Use eclinicalworks_device_read when you already have the ID. If the result has a `next` link, use `eclinicalworks_next_page` to get more.
Inputs
patientstringrequired- FHIR logical ID of the patient whose Device records to return. eCW requires it on every Device search. Example: 12345.
encounterstring- Only return records linked to this encounter (FHIR ID of the Encounter). Example: 67890.
typestring- SNOMED device type code. Example: 468063009.
eclinicalworks_diagnostic_report_readGet one DiagnosticReport resource from the practice's eClinicalWorks chart by its FHIR ID.Read-onlyGet Diagnostic Report
Get one DiagnosticReport resource from the practice's eClinicalWorks chart by its FHIR ID. Returns the DiagnosticReport with category, code, status, effective date, result references and presented form. Use eclinicalworks_diagnostic_report_search to find diagnostic report records when you do not have the ID.
Inputs
diagnostic_report_idstringrequired- FHIR logical ID of the Diagnostic Report (the `id` returned by eCW, an opaque string; not an MRN or account number). Example: 12345.
eclinicalworks_diagnostic_report_searchSearch DiagnosticReport resources in the practice's eClinicalWorks chart.Read-onlySearch Diagnostic Reports
Search DiagnosticReport resources in the practice's eClinicalWorks chart. Returns a FHIR searchset Bundle of DiagnosticReport resources with category, code, status, effective date, result references and presented form. Use eclinicalworks_diagnostic_report_read when you already have the ID. If the result has a `next` link, use `eclinicalworks_next_page` to get more.
Inputs
patientstringrequired- FHIR logical ID of the patient whose DiagnosticReport records to return. eCW requires it on every DiagnosticReport search. Example: 12345.
categorystring- Report category: LAB for laboratory results, or a LOINC category code such as LP29684-5 (radiology) for report and note exchange.
codestring- LOINC code(s) of the report, comma-separated. Example: 24323-8.
datestring- Filter on the report date. A date (YYYY-MM-DD) or date-time, optionally prefixed with a comparison: ge, le, gt, lt or eq. Example: ge2024-01-01 for on or after 1 Jan 2024. Only one value is accepted.
encounterstring- Only return records linked to this encounter (FHIR ID of the Encounter). Example: 67890.
statusstring- Report status, comma-separated, for example final or completed.
eclinicalworks_document_reference_readGet one DocumentReference resource from the practice's eClinicalWorks chart by its FHIR ID.Read-onlyGet Document Reference
Get one DocumentReference resource from the practice's eClinicalWorks chart by its FHIR ID. Returns the DocumentReference with type, category, date, author, encounter context and attachment (inline data or a Binary URL). Use eclinicalworks_document_reference_search to find document reference records when you do not have the ID.
Inputs
document_reference_idstringrequired- FHIR logical ID of the Document Reference (the `id` returned by eCW, an opaque string; not an MRN or account number). Example: 12345.
eclinicalworks_document_reference_searchSearch DocumentReference resources in the practice's eClinicalWorks chart.Read-onlySearch Document References
Search DocumentReference resources in the practice's eClinicalWorks chart. To get the file itself, read the Binary URL in the attachment with eclinicalworks_binary_read. Returns a FHIR searchset Bundle of DocumentReference resources with type, category, date, author, encounter context and attachment (inline data or a Binary URL). Use eclinicalworks_document_reference_read when you already have the ID. If the result has a `next` link, use `eclinicalworks_next_page` to get more.
Inputs
patientstringrequired- FHIR logical ID of the patient whose DocumentReference records to return. eCW requires it on every DocumentReference search. Example: 12345.
categorystring- Document category, for example clinical-note.
contenttypestring- Content type of the document, for example urn:ihe:iti:xds-sd:pdf:2008 for a progress note PDF (use with type 11506-3 and encounter).
datestring- Filter on the document date. A date (YYYY-MM-DD) or date-time, optionally prefixed with a comparison: ge, le, gt, lt or eq. Example: ge2024-01-01 for on or after 1 Jan 2024. Only one value is accepted.
encounterstring- Only return records linked to this encounter (FHIR ID of the Encounter). Example: 67890.
typestring- LOINC document type. Examples: 34133-9 (C-CDA summary), 11506-3 (progress note), 64290-0 / 53245-7 (insurance card / ID), 103140-0 (patient documents).
eclinicalworks_encounter_readGet one Encounter resource from the practice's eClinicalWorks chart by its FHIR ID.Read-onlyGet Encounter
Get one Encounter resource from the practice's eClinicalWorks chart by its FHIR ID. Returns the Encounter with visit status, class, type, period, participants, location and reason. Use eclinicalworks_encounter_search to find encounter records when you do not have the ID.
Inputs
encounter_idstringrequired- FHIR logical ID of the Encounter (the `id` returned by eCW, an opaque string; not an MRN or account number). Example: 12345.
eclinicalworks_encounter_searchSearch Encounter resources in the practice's eClinicalWorks chart.Read-onlySearch Encounters
Search Encounter resources in the practice's eClinicalWorks chart. Pass a patient (optionally with date), or a practitioner with date (optionally with location) to list a provider's schedule. Returns a FHIR searchset Bundle of Encounter resources with visit status, class, type, period, participants, location and reason. Use eclinicalworks_encounter_read when you already have the ID. If the result has a `next` link, use `eclinicalworks_next_page` to get more.
Inputs
datestring- Filter on the encounter date. A date (YYYY-MM-DD) or date-time, optionally prefixed with a comparison: ge, le, gt, lt or eq. Example: ge2024-01-01 for on or after 1 Jan 2024. Only one value is accepted.
locationstring- FHIR ID of the location (facility) of the encounter. Use with practitioner and date. Example: 13579.
patientstring- FHIR ID of the patient whose encounters to return. Example: 12345.
practitionerstring- FHIR ID of a practitioner taking part in the encounter. Use with date. Example: 24680.
eclinicalworks_family_member_history_readGet one FamilyMemberHistory resource from the practice's eClinicalWorks chart by its FHIR ID.Read-onlyGet Family Member History
Get one FamilyMemberHistory resource from the practice's eClinicalWorks chart by its FHIR ID. Returns the FamilyMemberHistory with relationship, status and conditions of the family member. Use eclinicalworks_family_member_history_search to find family member history records when you do not have the ID.
Inputs
family_member_history_idstringrequired- FHIR logical ID of the Family Member History (the `id` returned by eCW, an opaque string; not an MRN or account number). Example: 12345.
eclinicalworks_family_member_history_searchSearch FamilyMemberHistory resources in the practice's eClinicalWorks chart.Read-onlySearch Family Member Histories
Search FamilyMemberHistory resources in the practice's eClinicalWorks chart. Returns a FHIR searchset Bundle of FamilyMemberHistory resources with relationship, status and conditions of the family member. Use eclinicalworks_family_member_history_read when you already have the ID. If the result has a `next` link, use `eclinicalworks_next_page` to get more.
Inputs
patientstringrequired- FHIR logical ID of the patient whose FamilyMemberHistory records to return. eCW requires it on every FamilyMemberHistory search. Example: 12345.
eclinicalworks_goal_readGet one Goal resource from the practice's eClinicalWorks chart by its FHIR ID.Read-onlyGet Goal
Get one Goal resource from the practice's eClinicalWorks chart by its FHIR ID. Returns the Goal with lifecycle status, description, targets and start date. Use eclinicalworks_goal_search to find goal records when you do not have the ID.
Inputs
goal_idstringrequired- FHIR logical ID of the Goal (the `id` returned by eCW, an opaque string; not an MRN or account number). Example: 12345.
eclinicalworks_goal_searchSearch Goal resources in the practice's eClinicalWorks chart.Read-onlySearch Goals
Search Goal resources in the practice's eClinicalWorks chart. Returns a FHIR searchset Bundle of Goal resources with lifecycle status, description, targets and start date. Use eclinicalworks_goal_read when you already have the ID. If the result has a `next` link, use `eclinicalworks_next_page` to get more.
Inputs
patientstringrequired- FHIR logical ID of the patient whose Goal records to return. eCW requires it on every Goal search. Example: 12345.
encounterstring- Only return records linked to this encounter (FHIR ID of the Encounter). Example: 67890.
eclinicalworks_immunization_readGet one Immunization resource from the practice's eClinicalWorks chart by its FHIR ID.Read-onlyGet Immunization
Get one Immunization resource from the practice's eClinicalWorks chart by its FHIR ID. Returns the Immunization with CVX vaccine code, status, occurrence date, lot, site, route, dose and performer. Use eclinicalworks_immunization_search to find immunization records when you do not have the ID.
Inputs
immunization_idstringrequired- FHIR logical ID of the Immunization (the `id` returned by eCW, an opaque string; not an MRN or account number). Example: 12345.
eclinicalworks_immunization_searchSearch Immunization resources in the practice's eClinicalWorks chart.Read-onlySearch Immunizations
Search Immunization resources in the practice's eClinicalWorks chart. Returns a FHIR searchset Bundle of Immunization resources with CVX vaccine code, status, occurrence date, lot, site, route, dose and performer. Use eclinicalworks_immunization_read when you already have the ID. If the result has a `next` link, use `eclinicalworks_next_page` to get more.
Inputs
patientstringrequired- FHIR logical ID of the patient whose Immunization records to return. eCW requires it on every Immunization search. Example: 12345.
datestring- Filter on the vaccination date. A date (YYYY-MM-DD) or date-time, optionally prefixed with a comparison: ge, le, gt, lt or eq. Example: ge2024-01-01 for on or after 1 Jan 2024. Only one value is accepted.
encounterstring- Only return records linked to this encounter (FHIR ID of the Encounter). Example: 67890.
statusstring- Only return records with this status. One of: completed, entered-in-error, not-done.one of
completedentered-in-errornot-done
eclinicalworks_location_readGet one Location resource from the practice's eClinicalWorks chart by its FHIR ID.Read-onlyGet Location
Get one Location resource from the practice's eClinicalWorks chart by its FHIR ID. Returns the Location with facility name, address, telecom and managing organization. Use eclinicalworks_location_search to find location records when you do not have the ID.
Inputs
location_idstringrequired- FHIR logical ID of the Location (the `id` returned by eCW, an opaque string; not an MRN or account number). Example: 12345.
eclinicalworks_location_searchSearch Location resources in the practice's eClinicalWorks chart.Read-onlySearch Locations
Search Location resources in the practice's eClinicalWorks chart. Leave both inputs empty to list all facilities. Returns a FHIR searchset Bundle of Location resources with facility name, address, telecom and managing organization. Use eclinicalworks_location_read when you already have the ID. If the result has a `next` link, use `eclinicalworks_next_page` to get more.
Inputs
addressstring- Match facilities whose address contains this text. Example: Main Street.
namestring- Match facilities whose name contains this text. Example: Health.
eclinicalworks_medication_administration_readGet one MedicationAdministration resource from the practice's eClinicalWorks chart by its FHIR ID.Read-onlyGet Medication Administration
Get one MedicationAdministration resource from the practice's eClinicalWorks chart by its FHIR ID. Returns the MedicationAdministration with medication, status, effective time, dosage and encounter context. Use eclinicalworks_medication_administration_search to find medication administration records when you do not have the ID.
Inputs
medication_administration_idstringrequired- FHIR logical ID of the Medication Administration (the `id` returned by eCW, an opaque string; not an MRN or account number). Example: 12345.
eclinicalworks_medication_administration_searchSearch MedicationAdministration resources in the practice's eClinicalWorks chart.Read-onlySearch Medication Administrations
Search MedicationAdministration resources in the practice's eClinicalWorks chart. Returns a FHIR searchset Bundle of MedicationAdministration resources with medication, status, effective time, dosage and encounter context. Use eclinicalworks_medication_administration_read when you already have the ID. If the result has a `next` link, use `eclinicalworks_next_page` to get more.
Inputs
patientstringrequired- FHIR logical ID of the patient whose MedicationAdministration records to return. eCW requires it on every MedicationAdministration search. Example: 12345.
contextstring- FHIR ID of the encounter where the medication (for example a therapeutic injection) was given. Example: 67890.
statusstring- Administration status, for example completed.
eclinicalworks_medication_dispense_readGet one MedicationDispense resource from the practice's eClinicalWorks chart by its FHIR ID.Read-onlyGet Medication Dispense
Get one MedicationDispense resource from the practice's eClinicalWorks chart by its FHIR ID. Returns the MedicationDispense with medication, quantity, days supply, status and dispense dates. Use eclinicalworks_medication_dispense_search to find medication dispense records when you do not have the ID.
Inputs
medication_dispense_idstringrequired- FHIR logical ID of the Medication Dispense (the `id` returned by eCW, an opaque string; not an MRN or account number). Example: 12345.
eclinicalworks_medication_dispense_searchSearch MedicationDispense resources in the practice's eClinicalWorks chart.Read-onlySearch Medication Dispenses
Search MedicationDispense resources in the practice's eClinicalWorks chart. Returns a FHIR searchset Bundle of MedicationDispense resources with medication, quantity, days supply, status and dispense dates. Use eclinicalworks_medication_dispense_read when you already have the ID. If the result has a `next` link, use `eclinicalworks_next_page` to get more.
Inputs
patientstringrequired- FHIR logical ID of the patient whose MedicationDispense records to return. eCW requires it on every MedicationDispense search. Example: 12345.
include_medicationstring- Set to MedicationDispense:medication to also return the referenced Medication resources.one of
MedicationDispense:medication
eclinicalworks_medication_readGet one Medication resource from the practice's eClinicalWorks chart by its FHIR ID.Read-onlyGet Medication
Get one Medication resource from the practice's eClinicalWorks chart by its FHIR ID. Returns the Medication with medication code (RxNorm/NDC), name, form and ingredients. Use it when another resource references this one by ID; eCW offers no search for this resource type.
Inputs
medication_idstringrequired- FHIR logical ID of the Medication (the `id` returned by eCW, an opaque string; not an MRN or account number). Example: 12345.
eclinicalworks_medication_request_readGet one MedicationRequest resource from the practice's eClinicalWorks chart by its FHIR ID.Read-onlyGet Medication Request
Get one MedicationRequest resource from the practice's eClinicalWorks chart by its FHIR ID. Returns the MedicationRequest with medication, status, intent, dosage instructions, dispense request, requester and authored date. Use eclinicalworks_medication_request_search to find medication request records when you do not have the ID.
Inputs
medication_request_idstringrequired- FHIR logical ID of the Medication Request (the `id` returned by eCW, an opaque string; not an MRN or account number). Example: 12345.
eclinicalworks_medication_request_searchSearch MedicationRequest resources in the practice's eClinicalWorks chart.Read-onlySearch Medication Requests
Search MedicationRequest resources in the practice's eClinicalWorks chart. Returns a FHIR searchset Bundle of MedicationRequest resources with medication, status, intent, dosage instructions, dispense request, requester and authored date. Use eclinicalworks_medication_request_read when you already have the ID. If the result has a `next` link, use `eclinicalworks_next_page` to get more.
Inputs
patientstringrequired- FHIR logical ID of the patient whose MedicationRequest records to return. eCW requires it on every MedicationRequest search. Example: 12345.
authoredonstring- Filter on the date the prescription was written. A date (YYYY-MM-DD) or date-time, optionally prefixed with a comparison: ge, le, gt, lt or eq. Example: ge2024-01-01 for on or after 1 Jan 2024. Only one value is accepted.
encounterstring- Only return records linked to this encounter (FHIR ID of the Encounter). Example: 67890.
include_medicationstring- Set to MedicationRequest:medication to also return the referenced Medication resources in the same Bundle.one of
MedicationRequest:medication intended_dispenserstring- FHIR ID of the pharmacy (Organization) the prescription was sent to. Use with patient and encounter. Example: 11223.
intentstring- Request intent. eCW documents intent=order for the medication list; send order unless you need another intent.one of
orderplanproposal statusstring- Medication request status, comma-separated, for example active or active,completed.
eclinicalworks_next_pageFetch the next page of results from a previous eClinicalWorks search tool by following the Bundle's `next` link.Read-onlyGet Next Page of Search Results
Fetch the next page of results from a previous eClinicalWorks search tool by following the Bundle's `next` link. Returns the next searchset Bundle; when it has no `next` link, it is the last page.
Inputs
next_page_pathstringrequired- The part of the previous Bundle's `link` entry with relation `next` that comes after the practice's FHIR base address (https://<host>/fhir/r4/<practice code>/), starting with the resource type, with no leading slash. Pass it exactly as returned, query string included. Example: for the next link https://fhir4.eclinicalworks.com/fhir/r4/JAFJCD/Observation?patient=12345&category=vital-signs&page=2 pass Observation?patient=12345&category=vital-signs&page=2 (keep whatever page value eCW returned).
eclinicalworks_observation_readGet one Observation resource from the practice's eClinicalWorks chart by its FHIR ID.Read-onlyGet Observation
Get one Observation resource from the practice's eClinicalWorks chart by its FHIR ID. Returns the Observation with category, LOINC code, value or components, status, effective date and performer. Use eclinicalworks_observation_search to find observation records when you do not have the ID.
Inputs
observation_idstringrequired- FHIR logical ID of the Observation (the `id` returned by eCW, an opaque string; not an MRN or account number). Example: 12345.
eclinicalworks_observation_searchSearch Observation resources in the practice's eClinicalWorks chart.Read-onlySearch Observations
Search Observation resources in the practice's eClinicalWorks chart. Pass a category or a code with the patient; eCW does not return all observations for a patient at once. Returns a FHIR searchset Bundle of Observation resources with category, LOINC code, value or components, status, effective date and performer. Use eclinicalworks_observation_read when you already have the ID. If the result has a `next` link, use `eclinicalworks_next_page` to get more.
Inputs
patientstringrequired- FHIR logical ID of the patient whose Observation records to return. eCW requires it on every Observation search. Example: 12345.
categorystring- Observation category: vital-signs, laboratory, social-history (smoking, pregnancy, occupation, sexual orientation), survey (screening assessments), sdoh, exam, imaging or obstetrics-gynecology.one of
vital-signslaboratorysocial-historysurveysdohexamimagingobstetrics-gynecology codestring- LOINC code(s) of the observation, comma-separated, optionally as system|code. Example: 8867-4 (heart rate) or 2339-0,2514-8.
datestring- Filter on the observation date. A date (YYYY-MM-DD) or date-time, optionally prefixed with a comparison: ge, le, gt, lt or eq. Example: ge2024-01-01 for on or after 1 Jan 2024. Only one value is accepted.
encounterstring- Only return records linked to this encounter (FHIR ID of the Encounter). Example: 67890.
statusstring- Observation status, for example final or preliminary.
eclinicalworks_organization_readGet one Organization resource from the practice's eClinicalWorks chart by its FHIR ID.Read-onlyGet Organization
Get one Organization resource from the practice's eClinicalWorks chart by its FHIR ID. Returns the Organization with name, type, identifiers, address and telecom. Use eclinicalworks_organization_search to find organization records when you do not have the ID.
Inputs
organization_idstringrequired- FHIR logical ID of the Organization (the `id` returned by eCW, an opaque string; not an MRN or account number). Example: 12345.
eclinicalworks_organization_searchSearch Organization resources in the practice's eClinicalWorks chart.Read-onlySearch Organizations
Search Organization resources in the practice's eClinicalWorks chart. To list a patient's pharmacies, pass type=other, organization_extension_reference=Patient/<id> and organization_extension_url=http://eclinicalworks.com/supportingInfo/pharmacy. Returns a FHIR searchset Bundle of Organization resources with name, type, identifiers, address and telecom. Use eclinicalworks_organization_read when you already have the ID. If the result has a `next` link, use `eclinicalworks_next_page` to get more.
Inputs
addressstring- Match organizations whose address contains this text.
address_postalcodestring- Postal code of the organization. Example: 02139.
namestring- Match organizations whose name contains this text. Example: Pharmacy.
organization_extension_referencestring- Reference to a patient, as Patient/<FHIR ID>, to list that patient's pharmacies. Use with type=other and organization_extension_url. Example: Patient/12345.
organization_extension_urlstring- Extension URL that links organizations to a patient. For the patient's pharmacies use http://eclinicalworks.com/supportingInfo/pharmacy.
typestring- Organization type, for example pay (payors), other (pharmacies, labs, vaccine manufacturers) or prov.
eclinicalworks_patient_everythingRun the FHIR $everything operation on a patient in eClinicalWorks.Read-onlyGet Patient Everything
Run the FHIR $everything operation on a patient in eClinicalWorks. Returns a Bundle with the patient and the clinical resources linked to them. Use it for a whole-chart snapshot; use the per-resource search tools for filtered queries. If the result has a `next` link, use `eclinicalworks_next_page` to get more.
Inputs
patient_idstringrequired- FHIR logical ID of the Patient (the `id` returned by eCW, an opaque string; not an MRN or account number). Example: 12345.
eclinicalworks_patient_readGet one Patient resource from the practice's eClinicalWorks chart by its FHIR ID.Read-onlyGet Patient
Get one Patient resource from the practice's eClinicalWorks chart by its FHIR ID. Returns the Patient with demographics: name, identifiers (FHIR id as `usual`, eCW account number as `secondary`), gender, birth date, telecom, address, contacts, race/ethnicity and communication preferences. Use eclinicalworks_patient_search to find patient records when you do not have the ID.
Inputs
patient_idstringrequired- FHIR logical ID of the Patient (the `id` returned by eCW, an opaque string; not an MRN or account number). Example: 12345.
eclinicalworks_patient_searchSearch Patient resources in the practice's eClinicalWorks chart.Read-onlySearch Patients
Search Patient resources in the practice's eClinicalWorks chart. eCW supports these combinations: name; name with birthdate or gender; family with birthdate or gender; identifier; identifier with birthdate (account number); family, given and phone; family, given and birthdate (optionally gender); birthdate and phone. Returns a FHIR searchset Bundle of Patient resources with demographics: name, identifiers (FHIR id as `usual`, eCW account number as `secondary`), gender, birth date, telecom, address, contacts, race/ethnicity and communication preferences. Use eclinicalworks_patient_read when you already have the ID. If the result has a `next` link, use `eclinicalworks_next_page` to get more.
Inputs
birthdatestring- Patient's date of birth in YYYY-MM-DD format (the only format eCW accepts). Example: 1980-01-01.
familystring- Match patients whose last name starts with this text. Example: Smith.
genderstring- Administrative gender. One of: male, female, unknown.one of
malefemaleunknown givenstring- Match patients whose first name starts with this text. Example: Alex.
identifierstring- Patient identifier. On its own it matches the usual identifier (the patient's FHIR ID); combined with birthdate it matches the eCW account number (MRN). Example: 12345.
namestring- Match patients whose given or family name starts with this text. Example: Smith.
phonestring- Patient phone number, up to 10 digits; matches home, work and cell numbers. Example: 5555550100.
eclinicalworks_practitioner_readGet one Practitioner resource from the practice's eClinicalWorks chart by its FHIR ID.Read-onlyGet Practitioner
Get one Practitioner resource from the practice's eClinicalWorks chart by its FHIR ID. Returns the Practitioner with provider name, identifiers (such as NPI), telecom and address. Use eclinicalworks_practitioner_search to find practitioner records when you do not have the ID.
Inputs
practitioner_idstringrequired- FHIR logical ID of the Practitioner (the `id` returned by eCW, an opaque string; not an MRN or account number). Example: 12345.
eclinicalworks_practitioner_role_readGet one PractitionerRole resource from the practice's eClinicalWorks chart by its FHIR ID.Read-onlyGet Practitioner Role
Get one PractitionerRole resource from the practice's eClinicalWorks chart by its FHIR ID. Returns the PractitionerRole with practitioner, organization, role, specialty and locations. Use eclinicalworks_practitioner_role_search to find practitioner role records when you do not have the ID.
Inputs
practitioner_role_idstringrequired- FHIR logical ID of the Practitioner Role (the `id` returned by eCW, an opaque string; not an MRN or account number). Example: 12345.
eclinicalworks_practitioner_role_searchSearch PractitionerRole resources in the practice's eClinicalWorks chart.Read-onlySearch Practitioner Roles
Search PractitionerRole resources in the practice's eClinicalWorks chart. Returns a FHIR searchset Bundle of PractitionerRole resources with practitioner, organization, role, specialty and locations. Use eclinicalworks_practitioner_role_read when you already have the ID. If the result has a `next` link, use `eclinicalworks_next_page` to get more.
Inputs
locationstring- FHIR ID of a location where the practitioner works. Example: 13579.
namestring- Match roles whose practitioner name starts with this text.
practitionerstring- FHIR ID of the practitioner. Example: 24680.
rolestring- Role code of the practitioner. Example: 12434.
specialtystring- Specialty code (NUCC taxonomy). Example: 207Q00000X.
eclinicalworks_practitioner_searchSearch Practitioner resources in the practice's eClinicalWorks chart.Read-onlySearch Practitioners
Search Practitioner resources in the practice's eClinicalWorks chart. Returns a FHIR searchset Bundle of Practitioner resources with provider name, identifiers (such as NPI), telecom and address. Use eclinicalworks_practitioner_read when you already have the ID. If the result has a `next` link, use `eclinicalworks_next_page` to get more.
Inputs
identifierstring- Practitioner identifier, for example an NPI, optionally as system|value. Example: http://hl7.org/fhir/sid/us-npi|1234567890.
namestring- Match practitioners whose name starts with this text. Example: Smith.
eclinicalworks_procedure_readGet one Procedure resource from the practice's eClinicalWorks chart by its FHIR ID.Read-onlyGet Procedure
Get one Procedure resource from the practice's eClinicalWorks chart by its FHIR ID. Returns the Procedure with procedure code, status, performed date and encounter. Use eclinicalworks_procedure_search to find procedure records when you do not have the ID.
Inputs
procedure_idstringrequired- FHIR logical ID of the Procedure (the `id` returned by eCW, an opaque string; not an MRN or account number). Example: 12345.
eclinicalworks_procedure_searchSearch Procedure resources in the practice's eClinicalWorks chart.Read-onlySearch Procedures
Search Procedure resources in the practice's eClinicalWorks chart. Returns a FHIR searchset Bundle of Procedure resources with procedure code, status, performed date and encounter. Use eclinicalworks_procedure_read when you already have the ID. If the result has a `next` link, use `eclinicalworks_next_page` to get more.
Inputs
patientstringrequired- FHIR logical ID of the patient whose Procedure records to return. eCW requires it on every Procedure search. Example: 12345.
codestring- Procedure code(s) (CPT or SNOMED), comma-separated. Example: 99213.
datestring- Filter on the date the procedure was performed. A date (YYYY-MM-DD) or date-time, optionally prefixed with a comparison: ge, le, gt, lt or eq. Example: ge2024-01-01 for on or after 1 Jan 2024. Only one value is accepted.
encounterstring- Only return records linked to this encounter (FHIR ID of the Encounter). Example: 67890.
statusstring- Procedure status, comma-separated, for example completed.
eclinicalworks_questionnaire_readGet one Questionnaire resource from the practice's eClinicalWorks chart by its FHIR ID.Read-onlyGet Questionnaire
Get one Questionnaire resource from the practice's eClinicalWorks chart by its FHIR ID. Returns the Questionnaire with title, status and question items. Use it when another resource references this one by ID; eCW offers no search for this resource type.
Inputs
questionnaire_idstringrequired- FHIR logical ID of the Questionnaire (the `id` returned by eCW, an opaque string; not an MRN or account number). Example: 12345.
eclinicalworks_questionnaire_response_readGet one QuestionnaireResponse resource from the practice's eClinicalWorks chart by its FHIR ID.Read-onlyGet Questionnaire Response
Get one QuestionnaireResponse resource from the practice's eClinicalWorks chart by its FHIR ID. Returns the QuestionnaireResponse with questionnaire, status, authored date and answers. Use eclinicalworks_questionnaire_response_search to find questionnaire response records when you do not have the ID.
Inputs
questionnaire_response_idstringrequired- FHIR logical ID of the Questionnaire Response (the `id` returned by eCW, an opaque string; not an MRN or account number). Example: 12345.
eclinicalworks_questionnaire_response_searchSearch QuestionnaireResponse resources in the practice's eClinicalWorks chart.Read-onlySearch Questionnaire Responses
Search QuestionnaireResponse resources in the practice's eClinicalWorks chart. Returns a FHIR searchset Bundle of QuestionnaireResponse resources with questionnaire, status, authored date and answers. Use eclinicalworks_questionnaire_response_read when you already have the ID. If the result has a `next` link, use `eclinicalworks_next_page` to get more.
Inputs
patientstringrequired- FHIR logical ID of the patient whose QuestionnaireResponse records to return. eCW requires it on every QuestionnaireResponse search. Example: 12345.
authoredstring- Filter on the date the response was authored. A date (YYYY-MM-DD) or date-time, optionally prefixed with a comparison: ge, le, gt, lt or eq. Example: ge2024-01-01 for on or after 1 Jan 2024. Only one value is accepted.
statusstring- Response status, for example completed.
eclinicalworks_service_request_readGet one ServiceRequest resource from the practice's eClinicalWorks chart by its FHIR ID.Read-onlyGet Service Request
Get one ServiceRequest resource from the practice's eClinicalWorks chart by its FHIR ID. Returns the ServiceRequest with category, code, status, intent, authored date, occurrence, requester and notes. Use eclinicalworks_service_request_search to find service request records when you do not have the ID.
Inputs
service_request_idstringrequired- FHIR logical ID of the Service Request (the `id` returned by eCW, an opaque string; not an MRN or account number). Example: 12345.
eclinicalworks_service_request_searchSearch ServiceRequest resources in the practice's eClinicalWorks chart.Read-onlySearch Service Requests
Search ServiceRequest resources in the practice's eClinicalWorks chart. Returns a FHIR searchset Bundle of ServiceRequest resources with category, code, status, intent, authored date, occurrence, requester and notes. Use eclinicalworks_service_request_read when you already have the ID. If the result has a `next` link, use `eclinicalworks_next_page` to get more.
Inputs
patientstringrequired- FHIR logical ID of the patient whose ServiceRequest records to return. eCW requires it on every ServiceRequest search. Example: 12345.
authoredstring- Filter on the date the order was signed. A date (YYYY-MM-DD) or date-time, optionally prefixed with a comparison: ge, le, gt, lt or eq. Example: ge2024-01-01 for on or after 1 Jan 2024. Only one value is accepted.
categorystring- Order category code, for example 108252007 (lab), 363679005 (imaging), 387713003 (procedure), 3457005 (referral) or sdoh.
codestring- Order code(s) (LOINC or CPT), comma-separated, optionally as system|code.
occurrencestring- Filter on the date the service should occur. A date (YYYY-MM-DD) or date-time, optionally prefixed with a comparison: ge, le, gt, lt or eq. Example: ge2024-01-01 for on or after 1 Jan 2024. Only one value is accepted.
statusstring- Order status, for example active or completed.
eclinicalworks_specimen_readGet one Specimen resource from the practice's eClinicalWorks chart by its FHIR ID.Read-onlyGet Specimen
Get one Specimen resource from the practice's eClinicalWorks chart by its FHIR ID. Returns the Specimen with specimen type, collection details and subject. Use it when another resource references this one by ID; eCW offers no search for this resource type.
Inputs
specimen_idstringrequired- FHIR logical ID of the Specimen (the `id` returned by eCW, an opaque string; not an MRN or account number). Example: 12345.
eclinicalworks_allergy_intolerance_createRecord an allergy or adverse reaction for a patient in eClinicalWorks.WriteCreate Allergy Intolerance
Record an allergy or adverse reaction for a patient in eClinicalWorks. The entry lands in the chart's App Data tab, where a clinician reconciles it into the chart. Returns a transaction-response Bundle whose entry[0].response.location holds the new resource's FHIR ID (check entry[0].response.status for eCW error codes). Use eclinicalworks_allergy_intolerance_search to check existing allergies first. eCW requires a signed write contract for this scope.
Inputs
patient_idstringrequired- FHIR logical ID of the patient (the `id` returned by eCW, an opaque string; not an MRN or account number). Example: 12345.
substancestringrequired- Name of the allergen, shown as the allergy name in eCW. Example: Penicillin.
clinical_statusstring- Allergy status: active or inactive.one of
activeinactive codestring- Optional code of the allergen (for example a SNOMED or RxNorm code). Example: 764146007.
code_systemstring- Code system URI for code. Example: http://snomed.info/sct or http://www.nlm.nih.gov/research/umls/rxnorm.
criticalitystring- Criticality: high, low or unable-to-assess.one of
highlowunable-to-assess onset_date_timestring- Date the allergy was identified, as an ISO 8601 date-time with offset. Example: 2026-01-15T10:00:00-05:00.
reactionstring- Reaction text in eCW's '<reaction type> : <reaction>' format, where the type is Side Effects, Lack of Therapeutic Effect or Contraindication (eCW uses Allergy when no type is given). Example: Contraindication : hives.
eclinicalworks_communication_createAttach a free-text note to a patient's eClinicalWorks chart as a Checklist item on the App Data tab; it disappears once a user checks it off.WriteCreate Checklist Note
Attach a free-text note to a patient's eClinicalWorks chart as a Checklist item on the App Data tab; it disappears once a user checks it off. Returns a transaction-response Bundle whose entry[0].response.location holds the new resource's FHIR ID (check entry[0].response.status for eCW error codes). Use it for information no other create tool covers. eCW requires a signed write contract for this scope.
Inputs
messagestringrequired- Text of the note. Example: Patient reports improved sleep since last visit.
patient_idstringrequired- FHIR logical ID of the patient (the `id` returned by eCW, an opaque string; not an MRN or account number). Example: 12345.
eclinicalworks_condition_createAdd a diagnosis to a patient's Problem List or to the Assessments (encounter diagnosis) section in eClinicalWorks.WriteCreate Condition
Add a diagnosis to a patient's Problem List or to the Assessments (encounter diagnosis) section in eClinicalWorks. The entry lands in the chart's App Data tab, where a clinician reconciles it into the chart. Returns a transaction-response Bundle whose entry[0].response.location holds the new resource's FHIR ID (check entry[0].response.status for eCW error codes). Clinical status, verification status, abatement date and note apply to problem-list entries only. eCW requires a signed write contract for this scope.
Inputs
categorystringrequired- Where to add the diagnosis: problem-list-item (Problem List) or encounter-diagnosis (Assessments).one of
problem-list-itemencounter-diagnosis codestringrequired- Diagnosis code. eCW prefers ICD-10-CM, then SNOMED CT. Example: E11.9.
code_systemstringrequired- Code system of code: http://hl7.org/fhir/sid/icd-10-cm or http://snomed.info/sct.one of
http://hl7.org/fhir/sid/icd-10-cmhttp://snomed.info/sct patient_idstringrequired- FHIR logical ID of the patient (the `id` returned by eCW, an opaque string; not an MRN or account number). Example: 12345.
abatement_date_timestring- Date the problem resolved (required when clinical_status is resolved), as an ISO 8601 date-time with offset. Example: 2026-01-15T10:00:00-05:00.
clinical_statusstring- Problem status: active, resolved, inactive, recurrence or remission. When resolved, also send abatement_date_time.one of
activeresolvedinactiverecurrenceremission code_displaystring- Diagnosis name. Example: Type 2 diabetes mellitus without complications.
notestring- Note to attach to the diagnosis (problem list only). Example: Diet-controlled.
onset_date_timestring- Date the diagnosis was recorded, as an ISO 8601 date-time with offset. Example: 2026-01-15T10:00:00-05:00.
verification_statusstring- Verification status: confirmed, provisional, refuted, entered-in-error or differential.one of
confirmedprovisionalrefutedentered-in-errordifferential
eclinicalworks_coverage_createAdd an insurance policy to a patient's demographics in eClinicalWorks.WriteCreate Coverage
Add an insurance policy to a patient's demographics in eClinicalWorks. Returns a transaction-response Bundle whose entry[0].response.location holds the new resource's FHIR ID (check entry[0].response.status for eCW error codes). Find the payor Organization with eclinicalworks_organization_search (type=pay). Use eclinicalworks_coverage_update to change an existing policy. eCW requires a signed write contract for this scope.
Inputs
orderintegerrequired- Coverage order: 1 primary, 2 secondary, 3 tertiary.one of
123 patient_idstringrequired- FHIR logical ID of the patient (beneficiary) who holds the insurance (the `id` returned by eCW, an opaque string; not an MRN or account number). Example: 12345.
payor_idstringrequired- FHIR logical ID of the insurance company (payor Organization) (the `id` returned by eCW, an opaque string; not an MRN or account number). Example: 12345.
relationshipstringrequired- Beneficiary's relationship to the subscriber: self, spouse, child, injured (injured plaintiff), other, parent or common (life partner).one of
selfspousechildinjuredotherparentcommon subscriber_referencestringrequired- The insured person, as Patient/<FHIR ID> or RelatedPerson/<FHIR ID>. Example: Patient/12345.
assignment_of_benefitsstring- Assignment of benefits: Y (assigned to provider, eCW default), N (not assigned), O (pay other organization) or W (not applicable).one of
YNOW group_namestring- Group name. Example: Example Employer Plan.
group_numberstring- Group number on the card. Example: GRP001.
member_idstring- Subscriber (member) number on the insurance card. Example: ABC123456.
period_endstring- Coverage end date, as YYYY-MM-DD. Example: 2026-01-15.
period_startstring- Coverage start date, as YYYY-MM-DD. Example: 2026-01-15.
typestring- Insurance type (eCW source of payment): pay, PPO, POS, HIP, HMO, DENTAL, DENTPRG, AUTOPOL, DIS, GOVEMP, VET, WCBPOL.one of
payPPOPOSHIPHMODENTALDENTPRGAUTOPOLDISGOVEMPVETWCBPOL
eclinicalworks_coverage_updateUpdate an insurance policy on a patient's demographics in eClinicalWorks by its Coverage FHIR ID.WriteUpdate Coverage
Update an insurance policy on a patient's demographics in eClinicalWorks by its Coverage FHIR ID. Returns a transaction-response Bundle; check entry[0].response.status for eCW error codes. Use eclinicalworks_coverage_create to add a new policy. eCW requires a signed write contract for this scope.
Inputs
coverage_idstringrequired- FHIR logical ID of the Coverage (the `id` returned by eCW, an opaque string; not an MRN or account number). Example: 12345.
patient_idstringrequired- FHIR logical ID of the patient (beneficiary) who holds the insurance (the `id` returned by eCW, an opaque string; not an MRN or account number). Example: 12345.
payor_idstringrequired- FHIR logical ID of the insurance company (payor Organization) (the `id` returned by eCW, an opaque string; not an MRN or account number). Example: 12345.
assignment_of_benefitsstring- Assignment of benefits: Y (assigned to provider, eCW default), N (not assigned), O (pay other organization) or W (not applicable).one of
YNOW group_namestring- Group name. Example: Example Employer Plan.
group_numberstring- Group number on the card. Example: GRP001.
member_idstring- Subscriber (member) number on the insurance card. Example: ABC123456.
orderinteger- Coverage order: 1 primary, 2 secondary, 3 tertiary.one of
123 period_endstring- Coverage end date, as YYYY-MM-DD. Example: 2026-01-15.
period_startstring- Coverage start date, as YYYY-MM-DD. Example: 2026-01-15.
relationshipstring- Beneficiary's relationship to the subscriber: self, spouse, child, injured (injured plaintiff), other, parent or common (life partner).one of
selfspousechildinjuredotherparentcommon subscriber_referencestring- The insured person, as Patient/<FHIR ID> or RelatedPerson/<FHIR ID>. Example: Patient/12345.
typestring- Insurance type (eCW source of payment): pay, PPO, POS, HIP, HMO, DENTAL, DENTPRG, AUTOPOL, DIS, GOVEMP, VET, WCBPOL.one of
payPPOPOSHIPHMODENTALDENTPRGAUTOPOLDISGOVEMPVETWCBPOL
eclinicalworks_document_reference_clinical_note_createWrite a clinical (progress) note into an existing encounter in eClinicalWorks.WriteCreate Progress Note
Write a clinical (progress) note into an existing encounter in eClinicalWorks. The note content must be an HL7 v2 MDM (transcription) message, base64-encoded; eCW places its sections into the encounter's progress note. Returns a transaction-response Bundle whose entry[0].response.location holds the new resource's FHIR ID (check entry[0].response.status for eCW error codes). Get the encounter ID from eclinicalworks_encounter_search; eCW rejects the request without a valid encounter. eCW requires a signed write contract for this scope.
Inputs
encounter_idstringrequired- FHIR logical ID of the visit the note belongs to (the `id` returned by eCW, an opaque string; not an MRN or account number). Example: 12345.
hl7v2_message_base64stringrequired- Base64 of the HL7 v2 MDM/ORU message whose OBR/OBX segments carry the note sections (Chief Complaints, HPI, Assessment, Treatment and so on). Example: TVNIfF5+XCZ8 (truncated).
patient_idstringrequired- FHIR logical ID of the patient (the `id` returned by eCW, an opaque string; not an MRN or account number). Example: 12345.
practitioner_idstring- FHIR logical ID of the provider sending the note (the `id` returned by eCW, an opaque string; not an MRN or account number). Example: 12345.
eclinicalworks_document_reference_pdf_createUpload a PDF (base64) to a patient's documents in eClinicalWorks, either to the App Data tab for reconciliation or, when assigned to a reviewer, directly into Patient Documents (and into an encounter if one is given).WriteUpload PDF Document
Upload a PDF (base64) to a patient's documents in eClinicalWorks, either to the App Data tab for reconciliation or, when assigned to a reviewer, directly into Patient Documents (and into an encounter if one is given). Returns a transaction-response Bundle whose entry[0].response.location holds the new resource's FHIR ID (check entry[0].response.status for eCW error codes). Ask the practice for the folder name; unknown folders fall back to the practice's default folder (usually Misc). eCW requires a signed write contract for this scope.
Inputs
document_typestringrequired- LOINC document type: 34133-9 (Summary of episode note), 11488-4 (Consultation note), 34117-2 (H & P note), 28570-0 (Procedure note), 11506-3 (Progress note), 18842-5 (Discharge summary).one of
34133-911488-434117-228570-011506-318842-5 patient_idstringrequired- FHIR logical ID of the patient (the `id` returned by eCW, an opaque string; not an MRN or account number). Example: 12345.
pdf_base64stringrequired- Base64-encoded content of the PDF file. Example: JVBERi0xLjQK (truncated).
assign_to_idstring- FHIR logical ID of the provider or staff member who should review it; when set, the document goes straight into Patient Documents (the `id` returned by eCW, an opaque string; not an MRN or account number). Example: 12345.
author_idstring- FHIR logical ID of the provider sending the document (the `id` returned by eCW, an opaque string; not an MRN or account number). Example: 12345.
descriptionstring- Description of the document. Example: Consult letter from Dr. Example.
document_namestring- Name to show for the document. Example: Outside cardiology consult.
encounter_idstring- FHIR logical ID of the encounter to attach it to (used only with assign_to_id) (the `id` returned by eCW, an opaque string; not an MRN or account number). Example: 12345.
folder_namestring- eCW document folder to file it in, confirmed with the practice. Example: Consult Notes.
high_priorityboolean- Whether to flag the document as high priority.
reviewedboolean- Whether the document is already reviewed.
scanned_by_idstring- FHIR logical ID of the person who scanned the document (the `id` returned by eCW, an opaque string; not an MRN or account number). Example: 12345.
scanned_datestring- Date the document was scanned, as YYYY-MM-DD. Example: 2026-01-15.
eclinicalworks_encounter_telephone_createCreate a Telephone Encounter in a patient's eClinicalWorks chart, with reason, message, notes, action taken and the provider it is assigned to.WriteCreate Telephone Encounter
Create a Telephone Encounter in a patient's eClinicalWorks chart, with reason, message, notes, action taken and the provider it is assigned to. Returns a transaction-response Bundle whose entry[0].response.location holds the new resource's FHIR ID (check entry[0].response.status for eCW error codes). Use eclinicalworks_encounter_telephone_update to mark it addressed. eCW requires a signed write contract for this scope.
Inputs
patient_idstringrequired- FHIR logical ID of the patient (the `id` returned by eCW, an opaque string; not an MRN or account number). Example: 12345.
statusstringrequired- Telephone encounter status: planned or finished.one of
plannedfinished action_takenstring- Action taken. Example: Advised to continue current dose.
assigned_to_idstring- FHIR logical ID of the provider the telephone encounter is assigned to (the `id` returned by eCW, an opaque string; not an MRN or account number). Example: 12345.
class_codestring- Encounter class code (v3 ActCode). eCW's schema fixes AMB; its sample sends VR (virtual). Default AMB.one of
AMBVRdefaultAMB location_idstring- FHIR logical ID of the facility Location (the `id` returned by eCW, an opaque string; not an MRN or account number). Example: 12345.
messagestring- Message shown on the Telephone Encounter screen. Example: Patient asks about dosage.
notesstring- Notes on the telephone encounter. Example: Follow up in 2 weeks.
period_endstring- End date and time of the call, as an ISO 8601 date-time with offset. Example: 2026-01-15T10:15:00-05:00.
period_startstring- Start date and time of the call, as an ISO 8601 date-time with offset. Example: 2026-01-15T10:00:00-05:00.
pharmacy_idstring- FHIR logical ID of the pharmacy Organization (the `id` returned by eCW, an opaque string; not an MRN or account number). Example: 12345.
practitioner_idstring- FHIR logical ID of the provider on the encounter (the `id` returned by eCW, an opaque string; not an MRN or account number). Example: 12345.
reasonstring- Reason for the call. Example: Medication refill question.
eclinicalworks_encounter_telephone_updateMark an existing eClinicalWorks Telephone Encounter as addressed (status finished) by its FHIR ID.WriteMark Telephone Encounter Addressed
Mark an existing eClinicalWorks Telephone Encounter as addressed (status finished) by its FHIR ID. Returns a transaction-response Bundle; check entry[0].response.status for eCW error codes. Use eclinicalworks_encounter_telephone_create to open a new telephone encounter. eCW requires a signed write contract for this scope.
Inputs
encounter_idstringrequired- FHIR logical ID of the telephone encounter (the `id` returned by eCW, an opaque string; not an MRN or account number). Example: 12345.
patient_idstringrequired- FHIR logical ID of the patient (the `id` returned by eCW, an opaque string; not an MRN or account number). Example: 12345.
class_codestring- Encounter class code (v3 ActCode). eCW's schema fixes AMB; its sample sends VR (virtual). Default AMB.one of
AMBVRdefaultAMB
eclinicalworks_immunization_createRecord a historical immunization (given elsewhere or in the past) for a patient in eClinicalWorks.WriteCreate Immunization
Record a historical immunization (given elsewhere or in the past) for a patient in eClinicalWorks. The entry lands in the chart's App Data tab, where a clinician reconciles it into the chart. Returns a transaction-response Bundle whose entry[0].response.location holds the new resource's FHIR ID (check entry[0].response.status for eCW error codes). Use eclinicalworks_immunization_update to complete or correct an immunization already in the chart. eCW requires a signed write contract for this scope.
Inputs
cvx_codestringrequired- CVX vaccine code. Example: 52 (Hep A, adult).
occurrence_date_timestringrequired- Date the vaccine was given, as an ISO 8601 date-time with offset. Example: 2026-01-15T10:00:00-05:00.
patient_idstringrequired- FHIR logical ID of the patient (the `id` returned by eCW, an opaque string; not an MRN or account number). Example: 12345.
dose_numberinteger- Dose number in the series, 0 to 20. Example: 1.
dose_unitstring- UCUM unit of the dose: cL, cm3, g, ug, uL, {millicuries}, mg, mL, ng, {spray}, {units}.one of
cLcm3guguL{millicuries}mgmLng{spray}{units} dose_valuenumber- Dose amount. Example: 0.5.
location_idstring- FHIR logical ID of the facility where the immunization was documented (the `id` returned by eCW, an opaque string; not an MRN or account number). Example: 12345.
report_originstring- Source of the historical record: provider (other provider), record (written record), recall (parent's recall) or school (school record).one of
providerrecordrecallschool routestring- Route code: IDINJ (Intradermal), IM (Intramuscular), NASINHL (Nasal), IV (Intravenous), PO (Oral), SQINFUS (Subcutaneous), TRNSDERM (Transdermal).one of
IDINJIMNASINHLIVPOSQINFUSTRNSDERM sitestring- Body site code: LT (Left Thigh), LA (Left Arm), LD (Left Deltoid), LG (Left Gluteus Medius), LVL (Left Vastus Lateralis), LLFA (Left Lower Forearm), RT (Right Thigh), RA (Right Arm), RD (Right Deltoid), RG (Right Gluteus Medius), RVL (Right Vastus Lateralis), RLFA (Right Lower Forearm).one of
LTLALDLGLVLLLFARTRARDRGRVLRLFA vaccine_namestring- Vaccine name. Example: Hep A, Adult.
eclinicalworks_immunization_updateUpdate an existing (non-historical) immunization in eClinicalWorks by its FHIR ID, for example to mark it completed with lot, site, route and dose, or not-done with a reason.WriteUpdate Immunization
Update an existing (non-historical) immunization in eClinicalWorks by its FHIR ID, for example to mark it completed with lot, site, route and dose, or not-done with a reason. Returns a transaction-response Bundle; check entry[0].response.status for eCW error codes. When status is completed, eCW requires lot_number, expiration_date, site, route, dose, performer and dose_number; a new lot also needs manufacturer_id and funding_source. eCW requires a signed write contract for this scope.
Inputs
cvx_codestringrequired- CVX vaccine code. Example: 207.
encounter_idstringrequired- FHIR logical ID of the visit where the immunization is documented (the `id` returned by eCW, an opaque string; not an MRN or account number). Example: 12345.
immunization_idstringrequired- FHIR logical ID of the Immunization (the `id` returned by eCW, an opaque string; not an MRN or account number). Example: 12345.
occurrence_date_timestringrequired- Date and time the vaccine was given (ignored when status is not-done), as an ISO 8601 date-time with offset. Example: 2026-01-15T10:00:00-05:00.
patient_idstringrequired- FHIR logical ID of the patient (the `id` returned by eCW, an opaque string; not an MRN or account number). Example: 12345.
statusstringrequired- Immunization status: completed, entered-in-error or not-done.one of
completedentered-in-errornot-done dose_numberinteger- Dose number in the series, 0 to 20. Example: 1.
dose_unitstring- UCUM unit of the dose: cL, cm3, g, ug, uL, {millicuries}, mg, mL, ng, {spray}, {units}.one of
cLcm3guguL{millicuries}mgmLng{spray}{units} dose_valuenumber- Dose amount. Example: 0.5.
expiration_datestring- Lot expiration date, as YYYY-MM-DD. Example: 2026-01-15.
funding_sourcestring- Funding source (needed for a new lot): v (Govt (VFC)), y (Govt (Non VFC)), n (Purchased), u (Unknown), p (Patient Brought In), g (Public Vaccine Stock).one of
vynupg lot_numberstring- Lot number; eCW creates a new lot if none matches. Example: AB1234.
manufacturer_idstring- FHIR logical ID of the vaccine manufacturer Organization (needed for a new lot) (the `id` returned by eCW, an opaque string; not an MRN or account number). Example: 12345.
notestring- Comment to add to the immunization. Example: Patient tolerated well.
performer_idstring- FHIR logical ID of the practitioner who gave the vaccine (the `id` returned by eCW, an opaque string; not an MRN or account number). Example: 12345.
routestring- Route code: IDINJ (Intradermal), IM (Intramuscular), NASINHL (Nasal), IV (Intravenous), PO (Oral), SQINFUS (Subcutaneous), TRNSDERM (Transdermal).one of
IDINJIMNASINHLIVPOSQINFUSTRNSDERM sitestring- Body site code: LT (Left Thigh), LA (Left Arm), LD (Left Deltoid), LG (Left Gluteus Medius), LVL (Left Vastus Lateralis), LLFA (Left Lower Forearm), RT (Right Thigh), RA (Right Arm), RD (Right Deltoid), RG (Right Gluteus Medius), RVL (Right Vastus Lateralis), RLFA (Right Lower Forearm).one of
LTLALDLGLVLLLFARTRARDRGRVLRLFA status_reasonstring- Why it was not given (status not-done only): PATOBJ (patient decision), IMMUNE (evidence of immunity), MEDPREC (contraindication) or OSTOCK (vaccine unavailable).one of
PATOBJIMMUNEMEDPRECOSTOCK vaccine_namestring- Vaccine name. Example: COVID-19 (mRNA).
vis_presentation_datestring- Date printed on the Vaccine Information Statement, as YYYY-MM-DD. Example: 2026-01-15.
vis_publication_datestring- Date the Vaccine Information Statement was given, as YYYY-MM-DD. Example: 2026-01-15.
eclinicalworks_medication_request_createSend a medication order for a patient to eClinicalWorks.WriteCreate Medication Request
Send a medication order for a patient to eClinicalWorks. The entry lands in the chart's App Data tab, where a clinician reconciles it into the chart. Returns a transaction-response Bundle whose entry[0].response.location holds the new resource's FHIR ID (check entry[0].response.status for eCW error codes). Use eclinicalworks_medication_statement_create instead to add a medication the patient already takes to the medication list. eCW requires a signed write contract for this scope.
Inputs
authored_onstringrequired- Date and time the order was requested (required by the FHIR profile; eCW uses the current date as the start date), as an ISO 8601 date-time with offset. Example: 2026-01-15T10:00:00-05:00.
medication_codestringrequired- RxNorm or NDC code of the medication. Example: 859749.
medication_code_systemstringrequired- Code system of medication_code: rxnorm or ndc.one of
rxnormndc medication_namestringrequired- Medication name shown on the App Data tab (required by eCW). Example: Crestor 10 MG Tablet.
patient_idstringrequired- FHIR logical ID of the patient (the `id` returned by eCW, an opaque string; not an MRN or account number). Example: 12345.
practitioner_idstringrequired- FHIR logical ID of the provider placing the order (the `id` returned by eCW, an opaque string; not an MRN or account number). Example: 12345.
dispense_quantitynumber- Quantity to dispense, 1 to 999. Example: 30.
dosage_textstring- How to take the medication; fills the Take field. Example: Take 1 tablet by mouth twice a day for 10 days.
encounter_idstring- FHIR logical ID of the web encounter (refill request workflow only) (the `id` returned by eCW, an opaque string; not an MRN or account number). Example: 12345.
refillsinteger- Number of refills, 0 to 99. Example: 2.
supply_daysinteger- Duration of supply in days, greater than 0. Example: 30.
eclinicalworks_medication_statement_createAdd a medication the patient takes to their eClinicalWorks medication list (medication reconciliation).WriteAdd Medication to List
Add a medication the patient takes to their eClinicalWorks medication list (medication reconciliation). The entry lands in the chart's App Data tab, where a clinician reconciles it into the chart. Returns a transaction-response Bundle whose entry[0].response.location holds the new resource's FHIR ID (check entry[0].response.status for eCW error codes). Use eclinicalworks_medication_request_create to place a new prescription order. eCW requires a signed write contract for this scope.
Inputs
medication_codestringrequired- RxNorm or NDC code. Example: 318272.
medication_code_systemstringrequired- Code system of medication_code: rxnorm or ndc.one of
rxnormndc medication_namestringrequired- Medication name shown on the App Data tab (required by eCW). Example: Aspirin 81 MG Chewable Tablet.
patient_idstringrequired- FHIR logical ID of the patient (the `id` returned by eCW, an opaque string; not an MRN or account number). Example: 12345.
start_datestringrequired- Date the patient started the medication, as YYYY-MM-DD. Example: 2026-01-15.
as_neededboolean- If true, eCW prefixes the dose with 'As Needed'.
dose_unitstring- Unit for the dose. Example: tablet.
dose_valuenumber- Amount per dose (Take). Example: 1.
end_datestring- Date the patient stopped the medication, as YYYY-MM-DD. Example: 2026-01-15.
frequencystring- Frequency text. Example: once daily.
routestring- Route text. Example: Oral.
eclinicalworks_observation_vitals_createRecord one vital sign for a patient in eClinicalWorks, such as heart rate, temperature, weight, BMI, oxygen saturation or blood pressure.WriteCreate Vital Signs Observation
Record one vital sign for a patient in eClinicalWorks, such as heart rate, temperature, weight, BMI, oxygen saturation or blood pressure. The entry lands in the chart's App Data tab, where a clinician reconciles it into the chart. Returns a transaction-response Bundle whose entry[0].response.location holds the new resource's FHIR ID (check entry[0].response.status for eCW error codes). If effective_date_time matches an encounter's appointment time, eCW shows the value on that visit's Vitals screen; otherwise it goes to Vitals Notes.
Inputs
effective_date_timestringrequired- Date and time the vital was taken, as an ISO 8601 date-time with offset. Example: 2026-01-15T10:00:00-05:00.
loinc_codestringrequired- LOINC code of the vital sign: 9279-1 respiratory rate, 8867-4 heart rate, 8310-5 body temperature, 8302-2 body height, 9843-4 head circumference, 29463-7 body weight, 39156-5 BMI, 59576-9 BMI percentile, 8289-1 head circumference percentile, 77606-2 weight-for-length percentile, 85354-9 blood pressure panel, 2708-6 / 59408-5 oxygen saturation.one of
9279-18867-48310-58302-29843-429463-739156-559576-98289-177606-285354-92708-659408-5 patient_idstringrequired- FHIR logical ID of the patient (the `id` returned by eCW, an opaque string; not an MRN or account number). Example: 12345.
diastolicnumber- Diastolic pressure in mm[Hg] (blood pressure panel 85354-9 only). Example: 80.
displaystring- Name of the vital sign. Example: Heart rate.
inhaled_oxygen_concentrationnumber- Inhaled oxygen concentration in % (oxygen saturation codes only). Example: 21.
inhaled_oxygen_flow_ratenumber- Inhaled oxygen flow rate in L/min (oxygen saturation codes only). Example: 2.
practitioner_idstring- FHIR logical ID of the practitioner who took the vital (the `id` returned by eCW, an opaque string; not an MRN or account number). Example: 12345.
qualifierstring- Free-text qualifier shown with the vital, for example the blood pressure position. Example: Sitting.
systolicnumber- Systolic pressure in mm[Hg] (blood pressure panel 85354-9 only). Example: 120.
ucum_codestring- UCUM code of the unit, from the FHIR ucum-vitals-common value set. Example: /min, Cel, [degF], kg, [lb_av], cm, [in_i], %, kg/m2.
unitstring- Unit shown with the value. Example: /min, Cel, [lb_av], kg, cm, %, kg/m2.
valuenumber- Measured value. Required for every vital except the blood pressure panel (85354-9), which uses systolic and diastolic instead. Example: 72.
eclinicalworks_patient_createRegister a new patient in eClinicalWorks with name, birth date, gender, contact details and identifiers.WriteCreate Patient
Register a new patient in eClinicalWorks with name, birth date, gender, contact details and identifiers. Returns a transaction-response Bundle whose entry[0].response.location holds the new resource's FHIR ID (check entry[0].response.status for eCW error codes). eCW rejects the request if the account number already exists; use eclinicalworks_patient_search first to avoid duplicates. eCW requires a signed write contract for this scope.
Inputs
birth_datestringrequired- Date of birth, as YYYY-MM-DD. Example: 2026-01-15.
familystringrequired- Patient's last name. Example: Doe.
genderstringrequired- Administrative gender: male, female or unknown.one of
malefemaleunknown givenstringrequired- Patient's first name. Example: Alex.
identifier_systemstringrequired- Identifier system (OID) of the practice, as seen in identifier[].system on any Patient from this practice. Example: urn:oid:2.16.840.1.113883.4.391.12345.
usual_identifierstringrequired- Your system's identifier for the patient, sent as the `usual` identifier. eCW assigns the account number when none is sent. Example: EXT-12345.
account_numberstring- eCW account number to use (secondary identifier). Leave empty to let eCW assign one; creation fails if the account number already exists.
activeboolean- Whether the patient is active (eCW default true).
address_line1string- Street address line 1. Example: 1 Example Street.
address_line2string- Street address line 2. Example: Apt 2.
birth_sexstring- Birth sex: M, F or UNK.one of
MFUNK citystring- City. Example: Springfield.
emailstring- Email address. Example: patient@example.com.
general_practitioner_idstring- FHIR logical ID of the patient's primary care provider (the `id` returned by eCW, an opaque string; not an MRN or account number). Example: 12345.
languagestring- Preferred language as a BCP 47 code. Example: en or es.
marital_statusstring- Marital status: D (Divorced), M (Married), T (Domestic partner), S (Never Married), UNK (unknown), W (Widowed), L (Legally Separated).one of
DMTSUNKWL middlestring- Middle name. Example: J.
phone_homestring- Home phone. Example: 5555550100.
phone_mobilestring- Mobile phone. Example: 5555550101.
phone_workstring- Work phone. Example: 5555550102.
postal_codestring- ZIP code. Example: 01234.
prefixstring- Name prefix. Example: Mr.
statestring- Two-letter state code. Example: MA.
suffixstring- Name suffix. Example: Jr.
eclinicalworks_patient_updateUpdate an existing patient's demographics in eClinicalWorks.WriteUpdate Patient
Update an existing patient's demographics in eClinicalWorks. eCW finds the patient by account number and birth date (or by first name, last name and birth date) and overwrites the fields you send. Returns a transaction-response Bundle; check entry[0].response.status for eCW error codes. Get the account number and identifier system from eclinicalworks_patient_read. eCW requires a signed write contract for this scope.
Inputs
account_numberstringrequired- eCW account number of the patient (the `secondary` identifier on the Patient). eCW matches on account number plus birth date. Example: 12345.
birth_datestringrequired- Date of birth (used for matching; cannot be changed), as YYYY-MM-DD. Example: 2026-01-15.
familystringrequired- Patient's last name. Example: Doe.
genderstringrequired- Administrative gender: male, female or unknown.one of
malefemaleunknown givenstringrequired- Patient's first name. Example: Alex.
identifier_systemstringrequired- Identifier system (OID) of the practice, as seen in identifier[].system on any Patient from this practice. Example: urn:oid:2.16.840.1.113883.4.391.12345.
activeboolean- Whether the patient is active (eCW default true).
address_line1string- Street address line 1. Example: 1 Example Street.
address_line2string- Street address line 2. Example: Apt 2.
birth_sexstring- Birth sex: M, F or UNK.one of
MFUNK citystring- City. Example: Springfield.
emailstring- Email address. Example: patient@example.com.
general_practitioner_idstring- FHIR logical ID of the patient's primary care provider (the `id` returned by eCW, an opaque string; not an MRN or account number). Example: 12345.
languagestring- Preferred language as a BCP 47 code. Example: en or es.
marital_statusstring- Marital status: D (Divorced), M (Married), T (Domestic partner), S (Never Married), UNK (unknown), W (Widowed), L (Legally Separated).one of
DMTSUNKWL middlestring- Middle name. Example: J.
phone_homestring- Home phone. Example: 5555550100.
phone_mobilestring- Mobile phone. Example: 5555550101.
phone_workstring- Work phone. Example: 5555550102.
postal_codestring- ZIP code. Example: 01234.
prefixstring- Name prefix. Example: Mr.
statestring- Two-letter state code. Example: MA.
suffixstring- Name suffix. Example: Jr.
eclinicalworks_service_request_createPlace a lab, diagnostic imaging or procedure order for a patient in eClinicalWorks.WriteCreate Order
Place a lab, diagnostic imaging or procedure order for a patient in eClinicalWorks. Returns a transaction-response Bundle whose entry[0].response.location holds the new resource's FHIR ID (check entry[0].response.status for eCW error codes). Use eclinicalworks_service_request_referral_create for referrals and eclinicalworks_service_request_update to complete an order. eCW requires a signed write contract for this scope.
Inputs
codestringrequired- LOINC code for lab and imaging orders, or CPT code for procedure orders. Example: 2345-7.
order_typestringrequired- Kind of order: lab (LOINC code), imaging (LOINC code) or procedure (CPT code).one of
labimagingprocedure patient_idstringrequired- FHIR logical ID of the patient (the `id` returned by eCW, an opaque string; not an MRN or account number). Example: 12345.
code_displaystring- Order name. Example: Glucose [Mass/volume] in Serum or Plasma.
notestring- Note to add to the order. Example: Fasting sample.
eclinicalworks_service_request_referral_createCreate an incoming or outgoing referral for a patient in eClinicalWorks, with the referring and receiving providers, reason, dates and authorization.WriteCreate Referral
Create an incoming or outgoing referral for a patient in eClinicalWorks, with the referring and receiving providers, reason, dates and authorization. Returns a transaction-response Bundle whose entry[0].response.location holds the new resource's FHIR ID (check entry[0].response.status for eCW error codes). Use eclinicalworks_service_request_create for lab, imaging or procedure orders. eCW requires a signed write contract for this scope.
Inputs
appointment_datestringrequired- Appointment date on the referral, as an ISO 8601 date-time with offset. Example: 2026-01-15T10:00:00-05:00.
assigned_to_idstringrequired- FHIR logical ID of the staff member or provider the referral is assigned to (the `id` returned by eCW, an opaque string; not an MRN or account number). Example: 12345.
authored_onstringrequired- Date of the referral, as an ISO 8601 date-time with offset. Example: 2026-01-15T10:00:00-05:00.
directionstringrequired- Referral direction: outgoing (to another provider) or incoming.one of
outgoingincoming patient_idstringrequired- FHIR logical ID of the patient (the `id` returned by eCW, an opaque string; not an MRN or account number). Example: 12345.
reason_codestringrequired- ICD-10-CM code for the reason. Example: R50.9.
start_datestringrequired- Start of the referral validity period, as an ISO 8601 date-time with offset. Example: 2026-01-15T10:00:00-05:00.
statusstringrequired- Referral status: draft, active or completed.one of
draftactivecompleted auth_codestring- Authorization code on the referral screen. Example: 12345.
auth_typestring- Authorization type on the referral screen.
end_datestring- End of the referral validity period, as an ISO 8601 date-time with offset. Example: 2027-01-15T00:00:00-05:00.
from_practitioner_idstring- FHIR logical ID of the referring (From) provider (the `id` returned by eCW, an opaque string; not an MRN or account number). Example: 12345.
from_specialty_codestring- NUCC taxonomy code of the referring provider's specialty. Example: 207Q00000X.
from_specialty_displaystring- Specialty name. Example: Family Medicine.
location_idstring- FHIR logical ID of the facility for the referral (the `id` returned by eCW, an opaque string; not an MRN or account number). Example: 12345.
notestring- General notes on the referral. Example: Please evaluate.
prioritystring- Priority: routine, urgent or stat.one of
routineurgentstat reason_displaystring- Reason text. Example: Fever.
to_practitioner_idstring- FHIR logical ID of the receiving (To) provider (the `id` returned by eCW, an opaque string; not an MRN or account number). Example: 12345.
eclinicalworks_service_request_updateMark an existing eClinicalWorks lab, imaging or procedure order as completed by its FHIR ID and optionally add a note.WriteComplete Order
Mark an existing eClinicalWorks lab, imaging or procedure order as completed by its FHIR ID and optionally add a note. Returns a transaction-response Bundle; check entry[0].response.status for eCW error codes. Use eclinicalworks_service_request_create to place a new order. eCW requires a signed write contract for this scope.
Inputs
codestringrequired- LOINC (lab, imaging) or CPT (procedure) code of the order (required by the FHIR profile, not consumed by eCW). Example: 2345-7.
order_typestringrequired- Kind of order: lab (LOINC code), imaging (LOINC code) or procedure (CPT code).one of
labimagingprocedure patient_idstringrequired- FHIR logical ID of the patient (the `id` returned by eCW, an opaque string; not an MRN or account number). Example: 12345.
service_request_idstringrequired- FHIR logical ID of the order (the `id` returned by eCW, an opaque string; not an MRN or account number). Example: 12345.
code_displaystring- Order name.
notestring- Note to add to the order. Example: Results reviewed.
eclinicalworks_task_createCreate an Action (task) in eClinicalWorks, optionally about a patient and assigned to a provider, with priority, dates and a note.WriteCreate Action
Create an Action (task) in eClinicalWorks, optionally about a patient and assigned to a provider, with priority, dates and a note. Returns a transaction-response Bundle whose entry[0].response.location holds the new resource's FHIR ID (check entry[0].response.status for eCW error codes). Use eclinicalworks_communication_create for a simple checklist note on the chart. eCW requires a signed write contract for this scope.
Inputs
subjectstringrequired- Subject of the action. Example: Call patient with lab results.
endstring- End (due) of the action period, as an ISO 8601 date-time with offset. Example: 2026-01-16T17:00:00-05:00.
location_idstring- FHIR logical ID of the facility (the `id` returned by eCW, an opaque string; not an MRN or account number). Example: 12345.
notestring- Note on the action. Example: Results are in the chart.
owner_idstring- FHIR logical ID of the provider the action is assigned to (the `id` returned by eCW, an opaque string; not an MRN or account number). Example: 12345.
patient_idstring- FHIR logical ID of the patient the action is about (the `id` returned by eCW, an opaque string; not an MRN or account number). Example: 12345.
prioritystring- Priority: routine, urgent, asap or stat.one of
routineurgentasapstat requester_idstring- FHIR logical ID of the provider creating the action (the `id` returned by eCW, an opaque string; not an MRN or account number). Example: 12345.
startstring- Start of the action period, as an ISO 8601 date-time with offset. Example: 2026-01-15T10:00:00-05:00.
eclinicalworks_coverage_deleteRemove an insurance policy from a patient's demographics in eClinicalWorks by its Coverage FHIR ID.DestructiveDelete Coverage
Remove an insurance policy from a patient's demographics in eClinicalWorks by its Coverage FHIR ID. This cannot be undone. Returns a transaction-response Bundle; check entry[0].response.status for eCW error codes. eCW requires a signed write contract for this scope.
Inputs
coverage_idstringrequired- FHIR logical ID of the Coverage (the `id` returned by eCW, an opaque string; not an MRN or account number). Example: 12345.
patient_idstringrequired- FHIR logical ID of the patient (beneficiary) (the `id` returned by eCW, an opaque string; not an MRN or account number). Example: 12345.
payor_idstringrequired- FHIR logical ID of the policy's payor Organization (the `id` returned by eCW, an opaque string; not an MRN or account number). Example: 12345.
eclinicalworks_organization_patient_pharmacy_deleteRemove a pharmacy from a patient's pharmacy list in eClinicalWorks.DestructiveRemove Patient Pharmacy
Remove a pharmacy from a patient's pharmacy list in eClinicalWorks. This cannot be undone. Returns a transaction-response Bundle; check entry[0].response.status for eCW error codes. Find the patient's pharmacies with eclinicalworks_organization_search. eCW requires a signed write contract for this scope.
Inputs
patient_idstringrequired- FHIR logical ID of the patient (the `id` returned by eCW, an opaque string; not an MRN or account number). Example: 12345.
pharmacy_idstringrequired- FHIR logical ID of the pharmacy Organization to remove (the `id` returned by eCW, an opaque string; not an MRN or account number). Example: 12345.
No tools match.
