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/ReportData | Version: 0.9.8 | ||||
| Active as of 2026-05-20 | Computable Name: ReportData | ||||
The $report-data operation allows a participant to submit data reporting information for the ACCESS model.
These define constraints on FHIR resources for systems conforming to the ACCESS Data Reporting API.
| ACCESS Data Reporting Bundle | Contains the resources need to report patient data to the ACCESS Model |
| ACCESS Data Reporting Composition | Defines constraints that represent common clinical concepts for ACCESS Model Data Reporting submissions. Includes optional additional-information section for supplementary resources |
| ACCESS Report Data Request Parameters | Input parameters for the $report-data operation |
| ACCESS Report Data Response Parameters | Output parameters for the $report-data operation |
These define sets of codes used by systems conforming to the ACCESS Data Reporting API.
| ACCESS Report Type Value Set | Value set including all report type codes (e.g., baseline, end-of-quarter) |
| ACCESS Report Data Result Value Set | Value set including all data reporting submission result codes |
These define new code systems used by systems conforming to the ACCESS Data Reporting API.
| ACCESS Report Type Code System | Codes indicating the type of report (e.g., baseline, end-of-quarter) |
| ACCESS Report Data Result Code System | Codes indicating the result of a data reporting submission |
| ACCESS Report Data Composition Section Code System | Additional codes for composition sections used in ACCESS Model data reporting when LOINC codes are not available |
These are example instances demonstrating the use of the Data Reporting API.
| Report Data Request Example | Example request for submitting data report including participant ID, track, and complete data bundle |
| Report Data Response - Success | Example successful response indicating data submission was processed and recorded |
| Report Data Response - Duplicate | Example response indicating data submission is a duplicate |
| Report Data Response - Patient Not Aligned | Example response indicating patient is not currently aligned |
| Report Data Response - Reporting Period Closed | Example response indicating the reporting period has closed |
| Report Data Response - Incomplete Data | Example response indicating data submission is missing required elements |
| Report Data Response - Incorrect Track | Example response indicating data doesn't match patient's aligned track |
| Submission Status OperationOutcome Example | Example OperationOutcome showing detailed information about an incomplete data submission with severity, code, details text, and FHIRPath expressions |
| eCKM Report Data Request Example | Example request Parameters for submitting a eCKM track data report |
| eCKM Report Data Bundle Example | Example document bundle containing composition, patient, and clinical observations for the eCKM track |
| eCKM Report Data Composition Example | Example composition organizing clinical data for the eCKM track reporting |
| CKM Report Data Request Example | Example request Parameters for submitting a CKM track data report |
| CKM Report Data Bundle Example | Example document bundle containing composition, patient, and clinical observations for the CKM track |
| CKM Report Data Composition Example | Example composition organizing clinical data for the CKM track reporting |
| Blood Pressure Example | Example blood pressure observation with systolic and diastolic components for the CKM/eCKM track |
| Blood Pressure Example 2 | Example blood pressure observation with systolic and diastolic components for the CKM/eCKM track |
| Blood Pressure Example 3 | Example blood pressure observation with systolic and diastolic components for the CKM/eCKM track |
| Body Weight Example | Example body weight vital sign observation for the CKM/eCKM track |
| BMI Example | Example body mass index vital sign observation for the CKM/eCKM track |
| Waist Circumference Example | Example waist circumference vital sign observation for the CKM/eCKM track |
| HbA1c Example | Example hemoglobin A1c laboratory observation for the CKM/eCKM track |
| eGFR Example | Example estimated glomerular filtration rate laboratory observation for the CKM track |
| uACR Example | Example urine albumin-creatinine ratio laboratory observation for the CKM track |
| LDL-C Cholesterol Example | Example LDL-C observation for the CKM/eCKM track |
| HDL Cholesterol Example | Example HDL observation for the CKM/eCKM track |
| Total Cholesterol Example | Example total cholesterol observation for the CKM/eCKM track |
| Triglycerides Example | Example triglycerides observation for the CKM/eCKM track |
| Lipid Panel DiagnosticReport Example | Example lipid panel diagnostic report including total cholesterol, LDL, HDL, and triglycerides for the CKM/eCKM track |
| MSK Report Data Request Example | Example request Parameters for submitting a MSK track data report |
| MSK Report Data Bundle Example | Example document bundle containing composition, patient, and patient-reported outcomes for the MSK track |
| MSK Report Data Composition Example | Example composition organizing clinical data for the MSK track reporting |
| PROMIS Physical Function Short Form 6b Example | Example PROMIS Physical Function (PF) Short Form 6b QuestionnaireResponse for the MSK track |
| PROMIS Physical Function CAT Example | Example PROMIS Physical Function CAT QuestionnaireResponse for the MSK track |
| PROMIS Pain Interference Short Form 6a Example | Example PROMIS Pain Interference (PI) Short Form 6a QuestionnaireResponse for the MSK track |
| PROMIS Pain Interference CAT Example | Example PROMIS Pain Interference CAT QuestionnaireResponse for the MSK track |
| Oswestry Disability Index Example | Example Oswestry Disability Index (ODI) QuestionnaireResponse for the MSK track |
| Neck Disability Index Example | Example Neck Disability Index (NDI) QuestionnaireResponse for the MSK track |
| QuickDASH Example | Example Quick Disabilities of the Arm, Shoulder and Hand (QuickDASH) QuestionnaireResponse for the MSK track |
| Musculoskeletal PGIC Example | Example Patient Global Impression of Change QuestionnaireResponse for the MSK track |
| KOOS JR Example | Example KOOS JR QuestionnaireResponse for the MSK track |
| HOOS JR Example | Example HOOS JR QuestionnaireResponse for the MSK track |
| PROMIS Pain Intensity NRS Example | Example PROMIS Pain Intensity NRS QuestionnaireResponse for the MSK track |
| BH Report Data Request Example | Example request Parameters for submitting a BH track data report |
| BH Report Data Bundle Example | Example document bundle containing composition, patient, and behavioral health assessments for BH track |
| BH Report Data Composition Example | Example composition organizing clinical data for BH track reporting |
| Depression PHQ-9 Example | Example PHQ-9 QuestionnaireResponse for the BH track |
| Anxiety GAD-7 Example | Example GAD-7 QuestionnaireResponse for the BH track |
| WHODAS 2.0 Example | Example WHODAS 2.0 QuestionnaireResponse for the BH track |
| Behavioral Health PGIC Example | Example Behavioral Health PGIC QuestionnaireResponse for the BH track |
These questionnaire examples provide additional information to implementers and a better understanding of how the QuestionnaireResponse profiles interact with their associated questionnaires, particularly linkIds between the questionnaire items and the corresponding individual responses.
The Data Reporting API leverages USCoreQuestionnaireResponse profile, which requires a canonical URL for the underlying questionnaire associated with the questionnaire response. If the FHIR questionnaire is publicly available, it can be referenced through its canonical URL from the questionnaire response.
Otherwise, the questionnaire should be included in the ACCESS Data Reporting Bundle and referenced from the matching questionnaire response.
| PROMIS Physical Function Short Form 6b Questionnaire Example | Example PROMIS Physical Function (PF) Short Form 6b Questionnaire |
| PROMIS Physical Function CAT Questionnaire Example | Example PROMIS Physical Function CAT Questionnaire |
| PROMIS Pain Interference Short Form 6a Questionnaire Example | Example PROMIS Pain Interference (PI) Short Form 6a Questionnaire |
| PROMIS Pain Interference CAT Questionnaire Example | Example PROMIS Pain Interference CAT Questionnaire |
| Oswestry Disability Index Questionnaire Example | Example Oswestry Disability Index (ODI) Questionnaire |
| Neck Disability Index Questionnaire Example | Example Neck Disability Index (NDI) Questionnaire |
| QuickDASH Questionnaire Example | Example Quick Disabilities of the Arm, Shoulder and Hand (QuickDASH) Questionnaire |
| MSK PGIC Questionnaire Example | Example Patient Global Impression of Change Questionnaire |
| KOOS JR Questionnaire Example | Example KOOS JR Questionnaire |
| HOOS JR Questionnaire Example | Example HOOS JR Questionnaire |
| PROMIS Pain Intensity NRS Questionnaire Example | Example PROMIS Pain Intensity NRS Questionnaire |
| PHQ-9 Questionnaire Example | Example PHQ-9 Questionnaire |
| GAD-7 Questionnaire Example | Example GAD-7 Questionnaire |
| WHODAS 2.0 Questionnaire Example | Example WHODAS 2.0 Questionnaire |
| BH PGIC Questionnaire Example | Example Behavioral Health PGIC Questionnaire |
Language: en
URL: [base]/Patient/$report-data
Input parameters Profile:ACCESS Report Data 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 | track | 1..1 | CodeableConcept | ACCESS Model Tracks Value Set (Required) | ACCESS track for the data submission. | |
| IN | reportType | 1..1 | CodeableConcept | ACCESS Report Type Value Set (Required) | Type of data report. | |
| IN | dataBundle | 1..* | Bundle | Data bundle to report. |