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/SubmissionStatus | Version: 0.9.8 | ||||
| Active as of 2026-05-20 | Computable Name: SubmissionStatus | ||||
The $submission-status operation allows the client to check the status of any asynchronous ACCESS operation submission. This is a shared operation used by all ACCESS APIs. The specific result codes returned depend on which operation created the submission: ACCESSEligibilityResultVS for $check-eligibility, ACCESSAlignmentResultVS for $align, ACCESSUnalignmentResultVS for $unalign, and ACCESSReportDataResultVS for $report-data.
Language: en
| Use | Name | Scope | Cardinality | Type | Binding | Documentation |
| OUT | result | 1..1 | CodeableConcept | The result of the asynchronous operation. The specific codes returned depend on the original operation type: ACCESSEligibilityResultVS for $check-eligibility submissions, ACCESSAlignmentResultVS for $align submissions, ACCESSUnalignmentResultVS for $unalign submissions, and ACCESSReportDataResultVS for $report-data submissions. When processing is complete (HTTP 200), this parameter contains the result code and descriptive text. When still processing (HTTP 202), no body is returned. | ||
| OUT | issues | 0..1 | OperationOutcome | This parameter MAY be included to provide more detail about the context of the result code. |
The submissionID of the original request is provided in the $submission-status URL: GET https://[base]/access/Patient/$submission-status/sub-12345