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

CapabilityStatement: ACCESS Unalignment API Capability Statement

Official URL: https://dsacms.github.io/cmmi-access-model/CapabilityStatement/ACCESSUnalignmentAPICapabilityStatement Version: 0.9.8
Active as of 2026-01-23 Computable Name: ACCESSUnalignmentAPICapabilityStatement

Describes the expected capabilities of systems implementing the ACCESS Unalignment API for removing patient alignments from ACCESS participants.

Raw OpenAPI-Swagger Definition file | Download

Language: en

ACCESS Unalignment API Capability Statement

  • Implementation Guide Version: 0.9.8
  • FHIR Version: 4.0.1
  • Supported Formats: json, xml
  • Published on: 2026-01-23
  • Published by: Global Alliant, Inc.

Note to Implementers: FHIR Capabilities

Any FHIR capability may be 'allowed' by the system unless explicitly marked as 'SHALL NOT'. A few items are marked as MAY in the Implementation Guide to highlight their potential relevance to the use case.

SHALL Support the Following Implementation Guides

FHIR RESTful Capabilities

Mode: server

The ACCESS Unalignment API supports the voluntary removal of patient alignments from ACCESS participants and tracks.

Security
Enable CORS: yes
Security services supported:

Implementations SHALL use TLS 1.3 and implement OAuth 2.0 Client Credentials flow for authentication. MBI and other PHI must be protected according to HIPAA requirements.

Capabilities by Resource/Profile

Summary

The summary table lists the resources that are part of this configuration, and for each resource it lists:

  • The relevant profiles (if any)
  • The interactions supported by each resource (Read, Search, Update, and Create, are always shown, while VRead, Patch, Delete, History on Instance, or History on Type are only present if at least one of the resources has support for them.
  • The required, recommended, and some optional search parameters (if any).
  • The linked resources enabled for _include
  • The other resources enabled for _revinclude
  • The operations on the resource (if any)
Resource TypeProfileRSUCSearches_include_revincludeOperations
Patient $unalign, $submission-status
Core FHIR Resource
Patient
Reference Policy
Interaction summary

    Documentation

    Patient resource for ACCESS unalignment operations

    Extended Operations
    ConformanceOperationDocumentation
    SHALL$unalign

    Remove a patient's alignment from an ACCESS participant. This operation requires the entityId query parameter (participant identifier) and a Parameters body including other required inputs. Requires mandatory reason parameter from ACCESSUnalignmentReasonVS (geographic-relocated or loss-of-contact). Automatically cancels active subscriptions and sends unalignment notifications upon successful unalignment. Returns unalignment status from ACCESSUnalignmentResultVS: unaligned or unalignment-pending. Implements asynchronous processing with HTTP 202 Accepted response containing Content-Location header for status polling.

    SHALL$submission-status

    Poll the status of a previously submitted unalignment request. Returns HTTP 202 while processing or HTTP 200 with result when complete.