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 Data Reporting API Capability Statement

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

Describes the expected capabilities of systems implementing the ACCESS Data Reporting API for submitting clinical data for aligned patients.

Raw OpenAPI-Swagger Definition file | Download

Language: en

ACCESS Data Reporting 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

Track-Specific Data Requirements:

CKM (Cardio-Kidney-Metabolic) Track:

  • Blood Pressure (BP using LOINC 85354-9)
  • Lipid panel (LOINC 57698-3)
  • Body weight (LOINC 29463-7)
  • BMI (LOINC 39156-3)
  • Waist circumference (LOINC 8280-0)
  • HbA1c (LOINC 4548-4)
  • eGFR (LOINC 98979-8)
  • uACR (LOINC 14959-1)

eCKM (Early Cardio-Kidney-Metabolic) Track:

  • Blood Pressure (BP using LOINC 85354-9)
  • Lipid panel (LOINC 57698-3)
  • Body weight (LOINC 29463-7)
  • BMI (LOINC 39156-3)
  • Waist circumference (LOINC 8280-0)
  • HbA1c (LOINC 4548-4)

MSK (Musculoskeletal) Track:

  • PROMIS Physical Function Short Form 6b (LOINC 76804-4) or PROMIS Physical Function v2.0 Computer Adaptive Test (LOINC 91722-9)
  • PROMIS Pain Interference Short Form 6a (LOINC 90973-9) or PROMIS Pain Interference v1.1 Computer Adaptive Test (LOINC 89923-7)
  • Oswestry Disability Index (LOINC 97908-8)
  • Neck Disability Index (LOINC 82226-2)
  • Quick Disabilities of the Arm, Shoulder and Hand/QuickDASH (ACCESSReportDataCompositionSection QuickDASH)
  • Patient's Global Impression of Change (ACCESSReportDataCompositionSection PGIC)
  • Knee Injury and Osteoarthritis Outcome Score for Joint Replacement/KOOS JR (LOINC 82324-5)
  • Hip Dysfunction and Osteoarthritis Outcome Score for Joint Replacement/HOOS JR (LOINC 82316-1)
  • PROMIS Pain Intensity Numeric Rating Scale v1.0 (LOINC 72514-3)

BH (Behavioral Health) Track:

  • Depression screening/PHQ-9 (LOINC 44261-6)
  • Anxiety screening/GAD-7 (LOINC 69737-5)
  • Functioning and disability/WHODAS 2.0 (ACCESSReportDataCompositionSection WHODAS)
  • Patient's Global Impression of Change (ACCESSReportDataCompositionSection PGIC)
Security
Enable CORS: yes
Security services supported:

Implementations SHALL use TLS 1.3 and implement OAuth 2.0 Client Credentials flow for authentication. All clinical data and MBI 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 $report-data, $submission-status
Core FHIR Resource
Patient
Reference Policy
Interaction summary

    Documentation

    Patient resource for ACCESS data reporting operations

    Extended Operations
    ConformanceOperationDocumentation
    SHALL$report-data

    Report clinical data for an aligned patient. This operation requires the entityId query parameter (participant identifier) and a Parameters body including other required inputs. Requires document bundle conforming to ACCESSDataReportingBundle profile with Composition as first entry and all referenced resources included. Validates track-specific data requirements. Supports multiple submissions per reporting period. Returns submission status from ACCESSReportDataResultVS: success, validation-error, duplicate, patient-not-aligned, reporting-period-closed, incomplete-data, or incorrect-track. 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 data report. Returns HTTP 202 while processing or HTTP 200 with result when complete. May include OperationOutcome with validation errors if submission failed.