CMS ACCESS Model API
0.9.8 - draft
US
This page is part of the ACCESS Model IG v0.9.8 DRAFT (v0.9.8: Releases Draft) based on FHIR (HL7® FHIR® Standard) R4. No current official version has been published yet. For a full list of available versions, see the Directory of published versions
| Official URL: https://dsacms.github.io/cmmi-access-model/OperationDefinition/Align | Version: 0.9.8 | ||||
| Active as of 2026-05-20 | Computable Name: Align | ||||
The $align operation determines if the patient can be aligned to a participant so that the participant can start providing care to the patient under the ACCESS Model. If the patient can be aligned, the patient will be aligned with the participant for a specific ACCESS track.
These define constraints on FHIR resources for systems conforming to the ACCESS Alignment API.
| ACCESS Alignment Request Parameters | Input parameters for the $align operation |
| ACCESS Alignment Response Parameters | Output parameters for the $align operation |
These define sets of codes used by systems conforming to the ACCESS Alignment API.
| ACCESS Alignment Result Value Set | Value set including all alignment result codes |
| ACCESS Event Type Value Set | Value set including all event notification type codes |
These define new code systems used by systems conforming to the ACCESS Alignment API.
| ACCESS Alignment Result Code System | Codes indicating the result of an alignment request |
| ACCESS Event Type Code System | Codes for types of notification events that trigger subscription notifications |
These are example instances demonstrating the use of the Alignment API.
| Alignment Request Example | Example request for aligning a patient including participant ID, payer ID, patient details, track, conditions, and notification endpoint |
| Alignment Request with Switch Consent Example | Example request for aligning a patient with provider switch consent attestation after 90-day lock-in period |
| Alignment Response - Aligned | Example successful response indicating patient has been aligned to the ACCESS participant |
| Alignment Response - Switch Approved | Example successful response indicating patient provider switch has been approved and patient is re-aligned |
Language: en
URL: [base]/Patient/$align
Input parameters Profile:ACCESS Alignment Request Parameters
| Use | Name | Scope | Cardinality | Type | Binding | Documentation |
| IN | participantID | 1..1 | Identifier | ACCESS participant identifier. Must follow the pattern ACCES##### where ##### represents exactly 5 digits (e.g., ACCES00001, ACCES12345). | ||
| IN | payerID | 1..1 | Identifier | Payer ID for the patient. | ||
| IN | patient | 1..1 | Patient | Patient information. If the payer is Medicare, it SHALL contain the Medicare Beneficiary Identifier (MBI). | ||
| IN | track | 1..1 | CodeableConcept | ACCESS Model Tracks Value Set (Required) | ACCESS Track to align the patient to. | |
| IN | condition | 1..* | Condition | Patient's conditions. | ||
| IN | isProviderReferral | 1..1 | boolean | Was the patient referred to the ACCESS Model by a provider? | ||
| IN | switchConsentAttestation | 0..1 | boolean | Switch consent attestation, if applicable. |