API Reference
Base URL: https://cms-api.wasatch.org/fhir/r4
Discovery & Metadata
| Endpoint | Description | |
|---|---|---|
GET /fhir/r4/metadata |
FHIR R4 CapabilityStatement — declares all supported resources, profiles, and security requirements. | Open |
GET /fhir/r4/.well-known/smart-configuration |
SMART configuration document — OAuth 2.0 endpoints, supported scopes, and PKCE capabilities. | Open |
SMART Authorization
This API implements a SMART App Launch 2.0 proxy. Client apps send standard SMART scope strings to
/oauth2/authorize; the proxy translates them to Microsoft Entra ID format, handles the
authentication redirect, and returns a SMART-shaped token response. PKCE (S256) is
required for all clients.
| Endpoint | Description |
|---|---|
GET /oauth2/authorize |
Authorization endpoint for the SMART standalone launch flow. Accepts standard OAuth 2.0
parameters (response_type, client_id, redirect_uri,
scope, state, code_challenge,
code_challenge_method) and redirects to Entra ID for authentication.
Returns an authorization code to the client's redirect_uri.
|
POST /oauth2/token |
Token endpoint supporting authorization_code and refresh_token
grant types (application/x-www-form-urlencoded). Returns a SMART-shaped
response including access_token, token_type,
expires_in, scope, and — when the token contains a patient
identity — a patient context parameter with the FHIR Patient ID.
|
Clinical Resources
All endpoints follow the pattern GET https://cms-api.wasatch.org/fhir/r4/{Resource} and require a valid Bearer token
with the corresponding patient/{Resource}.rs scope.
Results are automatically filtered to the authenticated patient.
Supports _count and _offset for pagination.
| Resource | Returns | Profile |
|---|---|---|
GET /Patient |
Demographic and contact information for the authenticated patient. | US Core Patient 6.1.0 |
GET /Condition |
Active and historical diagnoses and health problems. | US Core Condition 6.1.0 |
GET /Observation |
Laboratory results, vital signs, smoking status, and social history observations. | US Core Observation 6.1.0 |
GET /DocumentReference |
Clinical notes and document attachments (CCD, discharge summaries, etc.). | US Core DocumentReference 6.1.0 |
GET /DiagnosticReport |
Laboratory and imaging diagnostic reports with result references. | US Core DiagnosticReport 6.1.0 |
GET /Medication |
Medication definitions referenced by MedicationRequest and MedicationDispense resources. | US Core Medication 6.1.0 |
GET /MedicationRequest |
Prescriptions and active medication orders. | US Core MedicationRequest 6.1.0 |
GET /MedicationDispense |
Pharmacy dispensing records for filled prescriptions. | US Core MedicationDispense 6.1.0 |
GET /AllergyIntolerance |
Documented allergies, intolerances, and adverse reactions. | US Core AllergyIntolerance 6.1.0 |
GET /Immunization |
Administered vaccine history and immunization records. | US Core Immunization 6.1.0 |
GET /Procedure |
Surgical procedures and clinical interventions. | US Core Procedure 6.1.0 |
GET /Encounter |
Office visits, inpatient stays, emergency visits, and other care events. | US Core Encounter 6.1.0 |
GET /CarePlan |
Active and completed care plans including goals and interventions. | US Core CarePlan 6.1.0 |
GET /CareTeam |
Members of the patient's care team and their roles. | US Core CareTeam 6.1.0 |
GET /Goal |
Patient care goals and achievement status. | US Core Goal 6.1.0 |
GET /Device |
Implanted and patient-used medical devices. | US Core ImplantableDevice 6.1.0 |
GET /Provenance |
Audit trail records capturing who created or modified clinical resources. | US Core Provenance 6.1.0 |
GET /RelatedPerson |
Family members, caregivers, and other people related to the patient. | US Core RelatedPerson 6.1.0 |
GET /ServiceRequest |
Lab, imaging, and referral orders and service requests. | US Core ServiceRequest 6.1.0 |
GET /Specimen |
Biological specimen collection and processing details. | US Core Specimen 6.1.0 |
GET /QuestionnaireResponse |
Patient-completed questionnaire and structured assessment responses. | SDC QuestionnaireResponse |
Claims & Benefits
| Resource | Returns | Profile |
|---|---|---|
GET /Coverage |
Health insurance coverage details and eligibility periods. | CARIN C4BB Coverage 2.1.0 |
GET /ExplanationOfBenefit |
Adjudicated claim records including services, costs, and payer determinations. | CARIN C4BB EOB 2.1.0 |
GET /Claim |
Prior authorization requests submitted to the payer. | Da Vinci PAS |
GET /ClaimResponse |
Prior authorization determinations and responses from the payer. | Da Vinci PAS |
Formulary & Reference
| Resource | Returns | Profile |
|---|---|---|
GET /InsurancePlan |
Formulary and drug plan information including tiers and cost sharing. | Da Vinci USDF 2.0.0 |
GET /MedicationKnowledge |
Formulary drug entries with tier, cost sharing, and coverage details. | Da Vinci USDF FormularyDrug 2.0.0 |
GET /Organization |
Payer and provider organization identities and contact information. | US Core Organization 6.1.0 |
GET /Practitioner |
Provider identity, NPI, and credential information. | US Core Practitioner 6.1.0 |
GET /PractitionerRole |
Provider roles, specialties, and practice location affiliations. | US Core PractitionerRole 6.1.0 |
GET /Location |
Practice and facility addresses and contact details. | US Core Location 6.1.0 |
Error responses are returned as FHIR
OperationOutcome resources
with HTTP status codes 400, 401, 403, or 404 as appropriate.
All successful responses use Content-Type: application/fhir+json.