generated from DSACMS/tier2
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathCapabilityStatement-ACCESSEligibilityAPICapabilityStatement.html
More file actions
297 lines (198 loc) · 15.4 KB
/
CapabilityStatement-ACCESSEligibilityAPICapabilityStatement.html
File metadata and controls
297 lines (198 loc) · 15.4 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE HTML>
<html xml:lang="en" xmlns="http://www.w3.org/1999/xhtml" lang="en">
<head>
<meta content="text/html;charset=utf-8" http-equiv="Content-Type"/>
<title>ACCESS Eligibility API Capability Statement - CMS ACCESS Model API v0.9.0</title>
<meta name="viewport" content="width=device-width, initial-scale=1.0"/>
<meta name="author" content="http://hl7.org/fhir"/>
<link href="fhir.css" rel="stylesheet"/>
<!-- Bootstrap core CSS -->
<link href="assets/css/bootstrap-fhir.css" rel="stylesheet"/>
<!-- Project extras -->
<link href="assets/css/project.css" rel="stylesheet"/>
<link href="assets/css/pygments-manni.css" rel="stylesheet"/>
<link href="assets/css/jquery-ui.css" rel="stylesheet"/>
<link href="assets/css/prism.css" rel="stylesheet" />
<link href="assets/css/cqf.css" rel="stylesheet" />
<!-- Placeholder for child template CSS declarations -->
<script type="text/javascript" src="fhir-table-scripts.js"> </script>
<!-- HTML5 shim and Respond.js IE8 support of HTML5 elements and media queries -->
<!--[if lt IE 9]>
<script src="assets/js/html5shiv.js"></script>
<script src="assets/js/respond.min.js"></script>
<![endif]-->
<!-- Favicons -->
<link rel="apple-touch-icon-precomposed" sizes="144x144" href="assets/ico/icon-fhir-144.png"/>
<link rel="apple-touch-icon-precomposed" sizes="114x114" href="assets/ico/icon-fhir-114.png"/>
<link rel="apple-touch-icon-precomposed" sizes="72x72" href="assets/ico/icon-fhir-72.png"/>
<link rel="apple-touch-icon-precomposed" href="assets/ico/icon-fhir-57.png"/>
<link rel="shortcut icon" href="assets/ico/favicon.png"/>
</head>
<body onload="document.body.style.opacity='1'">
<script src="assets/js/prism.js"></script>
<script type="text/javascript" src="assets/js/mermaid.js"></script>
<script type="text/javascript" src="assets/js/mermaid-init.js"></script>
<style type="text/css">h2{--heading-prefix:"3.32"}
h3,h4,h5,h6{--heading-prefix:"3.32"}</style>
<div id="segment-header" class="segment"> <!-- segment-header -->
<div class="container"> <!-- container -->
<!-- Placeholder for child template header declarations -->
<div id="ig-status">
<p><span style="font-size:12pt;font-weight:bold">CMS ACCESS Model API</span>
<br/>
<span style="display:inline-block;">0.9.0 - ci-build
<img alt="United States of America flag" src="assets/images/usa.svg" height="16" title="United States of America"/>
</span>
</p>
</div>
</div> <!-- /container -->
</div> <!-- /segment-header -->
<div id="segment-navbar" class="segment"> <!-- segment-navbar -->
<div id="stripe"> </div>
<div class="container"> <!-- container -->
<!-- HEADER CONTENT -->
<nav class="navbar navbar-inverse">
<!--status-bar-->
<div class="container">
<button data-target=".navbar-inverse-collapse" class="navbar-toggle" data-toggle="collapse" type="button">
<span class="icon-bar"> </span>
<span class="icon-bar"> </span>
<span class="icon-bar"> </span>
</button>
<a class="navbar-brand hidden" href="http://hl7.org/fhir/R4/index.html">FHIR</a>
<div class="nav-collapse collapse navbar-inverse-collapse">
<!-- menu.xml -->
<ul xmlns="http://www.w3.org/1999/xhtml" class="nav navbar-nav">
<li>
<a href="index.html">Home</a>
</li>
<li>
<a href="toc.html">Table of Contents</a>
</li>
<li class="dropdown">
<a data-toggle="dropdown" href="#" class="dropdown-toggle">Specification
<b class="caret"></b>
</a>
<ul class="dropdown-menu">
<li>
<a href="conformance.html">Conformance Expectations</a>
</li>
</ul>
</li>
<li>
<a href="artifacts.html">Artifacts</a>
</li>
<li>
<a href="downloads.html">Downloads</a>
</li>
</ul>
</div> <!-- /.nav-collapse -->
</div> <!-- /.container -->
</nav> <!-- /.navbar -->
<!-- /HEADER CONTENT -->
</div> <!-- /container -->
</div> <!-- /segment-navbar -->
<!--status-bar-->
<div id="segment-breadcrumb" class="segment"> <!-- segment-breadcrumb -->
<div class="container"> <!-- container -->
<ul class="breadcrumb">
<li><a href='toc.html'><b>Table of Contents</b></a></li><li><a href='artifacts.html'><b>Artifacts</b></a></li><li><b>ACCESS Eligibility API Capability Statement</b></li>
</ul>
</div> <!-- /container -->
</div> <!-- /segment-breadcrumb -->
<a name="top"> </a>
<div id="segment-content" class="segment"> <!-- segment-content -->
<div class="container"> <!-- container -->
<div class="row">
<div class="inner-wrapper">
<div class="col-12">
<!--ReleaseHeader--><p id="publish-box">CMS ACCESS Model API - Local Development build (v0.9.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the <a href='https://globalalliantinc.com/access/history.html'>Directory of published versions</a></p><!--EndReleaseHeader-->
<ul class="nav nav-tabs">
<li class="active">
<a href="#">Narrative Content</a>
</li>
<li>
<a href="CapabilityStatement-ACCESSEligibilityAPICapabilityStatement.xml.html">XML</a>
</li>
<li>
<a href="CapabilityStatement-ACCESSEligibilityAPICapabilityStatement.json.html">JSON</a>
</li>
</ul>
<a name="root"> </a>
<h2 id="root">CapabilityStatement: ACCESS Eligibility API Capability Statement
</h2>
<table class="colsi">
<tr>
<td colspan="4"><i>Official URL</i>: <span class="copy-text">https://globalalliantinc.com/access/CapabilityStatement/ACCESSEligibilityAPICapabilityStatement<button title="Click to copy URL" class="btn-copy" data-clipboard-text="https://globalalliantinc.com/access/CapabilityStatement/ACCESSEligibilityAPICapabilityStatement"/></span>
</td>
<td><i>Version</i>:
<span class="copy-text">0.9.0<button title="Click to copy versioned URL" class="btn-copy" data-clipboard-text="https://globalalliantinc.com/access/CapabilityStatement/ACCESSEligibilityAPICapabilityStatement|0.9.0"/></span>
</td>
</tr>
<tr>
<td colspan="4">
Active
as of 2026-01-23
</td>
<td><i>Computable Name</i>: <span style="font-family: monospace;">ACCESSEligibilityAPICapabilityStatement</span></td>
</tr>
</table>
<p>
<p>Describes the expected capabilities of systems implementing the ACCESS Eligibility API for checking patient eligibility for the ACCESS Model.</p>
</p>
<!-- insert intro if present -->
<!-- <p>
Formats: <a href="CapabilityStatement-ACCESSEligibilityAPICapabilityStatement.xml.html">XML</a>, <a href="CapabilityStatement-ACCESSEligibilityAPICapabilityStatement.json.html">JSON</a>, <a href="CapabilityStatement-ACCESSEligibilityAPICapabilityStatement.ttl.html">Turtle</a>
</p>-->
<p>
<a href="ACCESSEligibilityAPICapabilityStatement.openapi.json" no-download="true">Raw OpenAPI-Swagger Definition file</a> | <a href="ACCESSEligibilityAPICapabilityStatement.openapi.json" download>Download</a>
</p>
<div data-fhir="generated"><p class="res-header-id"/><a name="ACCESSEligibilityAPICapabilityStatement"> </a><a name="hcACCESSEligibilityAPICapabilityStatement"> </a><h2 id="title">ACCESS Eligibility API Capability Statement</h2><ul><li>Implementation Guide Version: 0.9.0 </li><li>FHIR Version: 4.0.1 </li><li>Supported Formats: <code>json</code>, <code>xml</code></li><li>Published on: 2026-01-23 </li><li>Published by: Global Alliant, Inc. </li></ul><blockquote class="impl-note"><p><strong>Note to Implementers: FHIR Capabilities</strong></p><p>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.</p></blockquote><h3 id="shallIGs">SHALL Support the Following Implementation Guides</h3><ul><li><a href="index.html">https://dsacms.github.io/cmmi-access-model/</a></li></ul><h2 id="rest">FHIR RESTful Capabilities</h2><div class="panel panel-default"><div class="panel-heading"><h3 id="mode1" class="panel-title">Mode: <code>server</code></h3></div><div class="panel-body"><div><p>The ACCESS Eligibility API supports checking patient eligibility for the ACCESS Model.</p>
</div><div class="lead"><em>Security</em></div><div class="row"><div class="col-lg-6">Enable CORS: yes</div><div class="col-lg-6">Security services supported: </div></div><blockquote><div><p>Implementations SHALL use TLS 1.3 and implement OAuth 2.0 Client Credentials flow for authentication. All PHI including MBI must be protected according to HIPAA requirements.</p>
</div></blockquote></div></div><h3 id="resourcesCap1">Capabilities by Resource/Profile</h3><h4 id="resourcesSummary1">Summary</h4><p>The summary table lists the resources that are part of this configuration, and for each resource it lists:</p><ul><li>The relevant profiles (if any)</li><li>The interactions supported by each resource (<b><span class="bg-info">R</span></b>ead, <b><span class="bg-info">S</span></b>earch, <b><span class="bg-info">U</span></b>pdate, and <b><span class="bg-info">C</span></b>reate, are always shown, while <b><span class="bg-info">VR</span></b>ead, <b><span class="bg-info">P</span></b>atch, <b><span class="bg-info">D</span></b>elete, <b><span class="bg-info">H</span></b>istory on <b><span class="bg-info">I</span></b>nstance, or <b><span class="bg-info">H</span></b>istory on <b><span class="bg-info">T</span></b>ype are only present if at least one of the resources has support for them.</li><li><span>The required, recommended, and some optional search parameters (if any). </span></li><li>The linked resources enabled for <code>_include</code></li><li>The other resources enabled for <code>_revinclude</code></li><li>The operations on the resource (if any)</li></ul><div class="table-responsive"><table class="table table-condensed table-hover"><thead><tr><th><b>Resource Type</b></th><th><b>Profile</b></th><th class="text-center"><b title="GET a resource (read interaction)">R</b></th><th class="text-center"><b title="GET all set of resources of the type (search interaction)">S</b></th><th class="text-center"><b title="PUT a new resource version (update interaction)">U</b></th><th class="text-center"><b title="POST a new resource (create interaction)">C</b></th><th><b title="Required and recommended search parameters">Searches</b></th><th><code><b>_include</b></code></th><th><code><b>_revinclude</b></code></th><th><b>Operations</b></th></tr></thead><tbody><tr><td><a href="#Patient1-1">Patient</a></td><td> </td><td class="text-center"/><td class="text-center"/><td class="text-center"/><td class="text-center"/><td></td><td/><td/><td><code>$check-eligibility</code>, <code>$submission-status</code></td></tr></tbody></table></div><hr/><div class="panel panel-default"><div role="tab" id="heading1-1" class="panel-heading"><h4 id="Patient1-1" class="panel-title"><a data-toggle="collapse" role="button" aria-controls="collapse1-1" aria-expanded="true" href="#collapse1-1"><span style="float: right;">Resource Conformance: supported</span>Patient</a></h4></div><div role="tabpanel" aria-labelledby="heading1-1" id="collapse1-1" class="panel-collapse in"><div class="panel-body"><div class="container"><div class="row"><div class="col-lg-4"><span class="lead">Core FHIR Resource</span><br/><a href="http://hl7.org/fhir/R4/patient.html">Patient</a></div><div class="col-lg-4"><span class="lead">Reference Policy</span><br/></div><div class="col-lg-4"><span class="lead">Interaction summary</span><br/><ul/></div></div><p/><p/><div class="row"><div class="col-12"><span class="lead">Documentation</span><blockquote><div><p>Patient resource for ACCESS eligibility operations</p>
</div></blockquote></div></div><div class="row"><div class="col-12"><span class="lead">Extended Operations</span><table class="table table-condensed table-hover"><thead><tr><th>Conformance</th><th>Operation</th><th>Documentation</th></tr></thead><tbody><tr><td><b>SHALL</b></td><td><a href="OperationDefinition-CheckEligibility.html">$check-eligibility</a></td><td><div><p>Check if a patient is eligible for the ACCESS Model. Returns eligibility status from ACCESSEligibilityResultVS: eligible, not-eligible-not-medicare, not-eligible-services, not-eligible-diagnoses, not-eligible-control-group, or not-eligible-already-aligned. Implements asynchronous processing with HTTP 202 Accepted response containing Content-Location header for status polling.</p>
</div></td></tr><tr><td><b>SHALL</b></td><td><a href="OperationDefinition-SubmissionStatus.html">$submission-status</a></td><td><div><p>Poll the status of a previously submitted eligibility check request. Returns HTTP 202 while processing or HTTP 200 with result when complete.</p>
</div></td></tr></tbody></table></div></div></div></div></div></div></div>
<!-- insert notes if present -->
</div>
</div> <!-- /inner-wrapper -->
</div> <!-- /row -->
</div> <!-- /container -->
</div> <!-- /segment-content -->
<script type="text/javascript" src="assets/js/jquery.js"> </script> <!-- note keep space here, otherwise it will be transformed to empty tag -> fails -->
<script type="text/javascript" src="assets/js/jquery-ui.min.js"> </script>
<script type="text/javascript" src="assets/js/window-hash.js"> </script>
<a name="bottom"> </a>
<div id="segment-footer" igtool="footer" class="segment"> <!-- segment-footer -->
<div class="container"> <!-- container -->
<div class="inner-wrapper">
<p>
IG © 2025+ <a style="color:var(--footer-hyperlink-text-color)" href="https://globalalliantinc.com">Global Alliant, Inc.</a>. Package cms.fhir.us.access#0.9.0 based on <a style="color: var(--footer-hyperlink-text-color)" href="http://hl7.org/fhir/R4/">FHIR 4.0.1</a>. Generated <span title="Fri, Mar 6, 2026 16:03-0500">2026-03-06</span>
<br/>
<span style="color: var(--footer-highlight-text-color)">
Links: <a style="color: var(--footer-hyperlink-text-color)" href="toc.html">Table of Contents</a> |
<a style="color: var(--footer-hyperlink-text-color)" href="qa.html">QA Report</a>
</span>
</p>
</div> <!-- /inner-wrapper -->
</div> <!-- /container -->
</div> <!-- /segment-footer -->
<div id="segment-post-footer" class="segment hidden"> <!-- segment-post-footer -->
<div class="container"> <!-- container -->
</div> <!-- /container -->
</div> <!-- /segment-post-footer -->
<!-- JS and analytics only. -->
<!-- Bootstrap core JavaScript
================================================== -->
<!-- Placed at the end of the document so the pages load faster -->
<script type="text/javascript" src="assets/js/bootstrap.min.js"> </script>
<script type="text/javascript" src="assets/js/respond.min.js"> </script>
<script type="text/javascript" src="assets/js/anchor.min.js"> </script>
<script type="text/javascript" src="assets/js/clipboard.min.js"> </script>
<script type="text/javascript" src="assets/js/clipboard-btn.js"> </script>
<script type="text/javascript" src="assets/js/anchor-hover.js"> </script>
<!-- Analytics Below
================================================== -->
</body>
</html>