Read APIs (FHIR R4)

Complete catalog of FHIR R4 Read and Search APIs supported by eClinicalWorks across USCDI v1 and v3.

Two Tiers of FHIR Read APIs

eClinicalWorks supports two tiers of FHIR Read APIs: USCDI v1 (US Core 3.1.1) and USCDI v3 (expanded with SDOH, pregnancy, screening, and more). The tier available depends on the eCW version deployed.

Need actual field structures?

Use the USCDI Structure Docs to drill into field names, relationships, representative JSON payloads, and standards links for the resources listed on this page.

API Coverage by USCDI Version

USCDI v1
US Core 3.1.1 conformance

34 Resources

All certified versions (11.52.305C, 12.0.1, 12.0.2, 12.0.3)

USCDI v3
US Core 6.1.0 + FHIR R4

55+ Resources

Requires eCW v12.0.2(04000407+) or v12.0.3(04009267+)

New in USCDI v3

BasicFamilyMemberHistoryGoal (SDOH)MediaMedicationDispenseMedicationRequest (expanded)Observation (OBGYN)Observation (Occupation)Observation (Pregnancy Intent)Observation (Pregnancy Status)Observation (Screening Assessment)Observation (SDOH)Observation (Sexual Orientation)Observation (Simple Observation)Observation (Smoking Status)DocumentReference (Health card and Govt IDs)Organization (Patient's Pharmacy)QuestionnaireQuestionnaireResponseServiceRequest (Lab/DI/Procedure Orders)ServiceRequest (Referrals)ServiceRequest (SDOH Interventions)Specimen

HTI-1 Compliance

To exchange all USCDI v3 data classes related to HTI-1, eCW customers must upgrade to the latest cumulative patch for version 12.0.2.04000407 or 12.0.3.04009267 (or higher). If the client has not upgraded, eCW will return a response indicating that the read/search operation for the selected scope is not supported.