Patient Access API
Developer Portal

Scopes Reference

All scopes follow the SMART App Launch v2 patient-context format. Include the scopes your application requires in the scope parameter of the authorization request.

Clinical Resources

Scope Resource Description
patient/Patient.rs Patient Demographic and contact information for the authenticated patient.
patient/Condition.rs Condition Active and historical diagnoses and health conditions.
patient/Observation.rs Observation Laboratory results, vital signs, and social history observations.
patient/DocumentReference.rs DocumentReference Clinical notes and document attachments.
patient/DiagnosticReport.rs DiagnosticReport Diagnostic reports including laboratory and imaging results.
patient/Medication.rs Medication Medication definitions referenced by orders and dispenses.
patient/MedicationRequest.rs MedicationRequest Prescriptions and medication orders.
patient/MedicationDispense.rs MedicationDispense Pharmacy dispensing records for filled prescriptions.
patient/AllergyIntolerance.rs AllergyIntolerance Recorded allergies and adverse reactions.
patient/Immunization.rs Immunization Administered vaccine history.
patient/Procedure.rs Procedure Surgical and clinical procedures.
patient/Encounter.rs Encounter Office visits, hospitalizations, and care events.
patient/CarePlan.rs CarePlan Active and completed care plans.
patient/CareTeam.rs CareTeam Care team members and their roles.
patient/Goal.rs Goal Patient care goals and their achievement status.
patient/Device.rs Device Implanted and patient-used medical devices.
patient/ServiceRequest.rs ServiceRequest Orders and referrals for procedures, diagnostics, and other services.
patient/Specimen.rs Specimen Biological specimens collected for laboratory testing.
patient/QuestionnaireResponse.rs QuestionnaireResponse Patient-reported outcomes and survey responses.
patient/RelatedPerson.rs RelatedPerson People with a relationship to the patient, such as family members or caregivers.
patient/Provenance.rs Provenance Audit trail records tracking the origin and history of clinical resources.

Claims & Benefits

Profiles: CARIN IG for Blue Button (C4BB) 2.1.0 and Da Vinci PAS.

Scope Resource Description
patient/Coverage.rs Coverage Health insurance coverage and eligibility information.
patient/ExplanationOfBenefit.rs ExplanationOfBenefit Claim details and adjudication records (CARIN C4BB).
patient/Claim.rs Claim Prior authorization requests (Da Vinci PAS).
patient/ClaimResponse.rs ClaimResponse Prior authorization responses and determinations (Da Vinci PAS).

Formulary & Reference

Profiles: Da Vinci USDF Drug Formulary.

Scope Resource Description
patient/InsurancePlan.rs InsurancePlan Formulary and drug plan information (USDF).
patient/MedicationKnowledge.rs MedicationKnowledge Formulary drug details including tier and cost sharing (USDF).
patient/Organization.rs Organization Payer and provider organization details.
patient/Practitioner.rs Practitioner Provider identity and credential information.
patient/PractitionerRole.rs PractitionerRole Provider roles, specialties, and practice affiliations.
patient/Location.rs Location Practice and facility location details.

Identity & Session

Scope Resource Description
openid — Required for OIDC. Returns an ID token alongside the access token.
profile — Includes basic profile claims such as name in the ID token.
fhirUser — Returns the fhirUser claim in the token, identifying the patient's FHIR resource reference (e.g. Patient/42).
launch/patient — Requests patient context during the standalone launch sequence.
offline_access — Requests a refresh token for long-lived access without re-prompting the user. Subject to patient consent.

Wildcard

Scope Resource Description
patient/*.rs All Grants read and search access to all supported patient-scoped resources. Equivalent to requesting every patient/{Resource}.rs scope listed above.