-
Notifications
You must be signed in to change notification settings - Fork 1
/
guide.html
341 lines (340 loc) · 11.6 KB
/
guide.html
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
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
---
id: guide
title: Getting Started
layout: default
---
<div class="ds-base ds-l-container">
<div role="region" aria-label="page-title" class="ds-l-row ds-u-fill--primary-darker">
<div class="ds-l-col--12 ds-u-text-align--right ds-u-font-size--display ds-u-color--white">
Getting Started
</div>
<div class="ds-l-col--12 ds-u-text-align--right ds-u-font-size--h1 ds-u-color--white">
Learn About BCDA in Sandbox
</div>
</div>
<div class="ds-l-row ds-u-padding-top--2">
<aside class="ds-u-margin-bottom--4 ds-u-md-margin-bottom--0 ds-l-md-col--4 ds-l-lg-col--3">
<ul class="ds-c-vertical-nav sidenav">
<li class="ds-c-vertical-nav__item">
<a class="ds-c-vertical-nav__label" href="#what-is-an-api">
What is an API?
</a>
</li>
<li class="ds-c-vertical-nav__item">
<a class="ds-c-vertical-nav__label" href="#what-is-fhir">
What is FHIR?
</a>
</li>
<li class="ds-c-vertical-nav__item">
<a class="ds-c-vertical-nav__label" href="#BCDA-environments">
BCDA's Environments
</a>
<ul class="ds-c-vertical-nav__subnav">
<li class="ds-c-vertical-nav__subnav">
<a class="ds-c-vertical-nav__label" href="#sandbox-environment">
Sandbox Environment BCDA
</a>
</li>
<li class="ds-c-vertical-nav__subnav">
<a class="ds-c-vertical-nav__label" href="#production-environment">
Production Environment
</a>
</li>
</ul>
</li>
<li class="ds-c-vertical-nav__item">
<a class="ds-c-vertical-nav__label" href="#fhir-types">
FHIR Resource Types
</a>
<ul class="ds-c-vertical-nav__subnav">
<li class="ds-c-vertical-nav__subnav">
<a class="ds-c-vertical-nav__label" href="#eob-resource">
Explanation of Benefit (EOB)
</a>
</li>
<li class="ds-c-vertical-nav__subnav">
<a class="ds-c-vertical-nav__label" href="#patient-resource">
Patient
</a>
</li>
<li class="ds-c-vertical-nav__subnav">
<a class="ds-c-vertical-nav__label" href="#coverage-resource">
Coverage
</a>
</li>
<li class="ds-c-vertical-nav__subnav">
<a class="ds-c-vertical-nav__label" href="#claim-resource">
Claim
</a>
</li>
<li class="ds-c-vertical-nav__subnav">
<a class="ds-c-vertical-nav__label" href="#claimresponse-resource">
ClaimResponse
</a>
</li>
</ul>
</li>
<li class="ds-c-vertical-nav__item">
<a class="ds-c-vertical-nav__label" href="#fhir-endpoints">
BCDA's Endpoints
</a>
<ul class="ds-c-vertical-nav__subnav">
<li class="ds-c-vertical-nav__subnav">
<a class="ds-c-vertical-nav__label" href="#metadata-endpoint">
/Metadata Endpoint
</a>
</li>
<li class="ds-c-vertical-nav__subnav">
<a class="ds-c-vertical-nav__label" href="#patient-endpoint">
/Patient Endpoint
</a>
</li>
<li class="ds-c-vertical-nav__subnav">
<a class="ds-c-vertical-nav__label" href="#group-endpoint">
/Group Endpoint
</a>
</li>
<li class="ds-c-vertical-nav__subnav">
<a class="ds-c-vertical-nav__label" href="#jobs-endpoint">
/Jobs Endpoint
</a>
</li>
<li class="ds-c-vertical-nav__subnav">
<a class="ds-c-vertical-nav__label" href="#attribution-status-endpoint">
/Attribution_Status Endpoint
</a>
</li>
</ul>
</li>
<li class="ds-c-vertical-nav__item">
<a class="ds-c-vertical-nav__label" href="#BCDA-parameters">
BCDA Parameters
</a>
<ul class="ds-c-vertical-nav__subnav">
<li class="ds-c-vertical-nav__subnav">
<a class="ds-c-vertical-nav__label" href="#type-parameter">
The _type parameter
</a>
</li>
<li class="ds-c-vertical-nav__subnav">
<a class="ds-c-vertical-nav__label" href="#since-parameter">
The _since parameter
</a>
</li>
</ul>
</li>
<li class="ds-c-vertical-nav__item">
<a class="ds-c-vertical-nav__label" href="#bcda-v2">
BCDA Version 2 (V2)
</a>
</li>
<li class="ds-c-vertical-nav__item">
<a class="ds-c-vertical-nav__label" href="#try-the-api">
Try the API
</a>
</li>
</ul>
</aside>
<main id="main" class="ds-l-md-col--8 ds-l-lg-col--9">
<div class="guide-content">
<div class="ds-c-alert ds-c-alert--hide-icon" id="version-2-header-alert">
<div class="ds-c-alert__body">
<p class="ds-c-alert__text">
Version 2 of the Beneficiary Claims Data API (BCDA V2) endpoints are available as of Summer 2021.
If you are interested in interacting with BCDA V2 endpoints,
please navigate to the <a href="/guide.html#bcda-v2" class="in-text__link"><em>BCDA Version 2 (V2)</em></a> section for more information.
</p>
</div>
</div>
<div id="what-is-an-api">
<h1>
What Is an API?
</h1>
<div class="ds-u-font-size--base">
{% include guide/what_is_an_api.html %}
</div>
</div>
<div id="what-is-fhir">
<h1>
What Is FHIR?
</h1>
<div class="ds-u-font-size--base">
{% include guide/what_is_fhir.html %}
</div>
</div>
<div id="BCDA-environments">
<h1>
BCDA's Environments
</h1>
<div>
{% include guide/bcda_environments.html %}
</div>
</div>
<div id="sandbox-environment">
<h2 class="ds-u-text-decoration--underline ds-u-font-weight--bold">
1. Sandbox Environment
</h2>
<div>
{% include guide/sandbox_environment.html %}
</div>
<div id="production-environment">
<h2 class="ds-u-text-decoration--underline ds-u-font-weight--bold">
2. Production Environment
</h2>
<div>
{% include guide/production_environment.html %}
</div>
</div>
</div>
<div id="fhir-types">
<h1>
BCDA's FHIR Resource Types
</h1>
<div>
{% include guide/bcda_resource_types.html %}
</div>
<div id="eob-resource">
<h2 class="ds-u-text-decoration--underline ds-u-font-weight--bold">
1. Explanation of Benefit (EOB)
</h2>
<div>
{% include guide/eob_resource.html %}
</div>
</div>
<div id="patient-resource">
<h2 class="ds-u-text-decoration--underline ds-u-font-weight--bold">
2. Patient
</h2>
<div>
{% include guide/patient_resource.html %}
</div>
</div>
<div id="coverage-resource">
<h2 class="ds-u-text-decoration--underline ds-u-font-weight--bold">
3. Coverage
</h2>
<div>
{% include guide/coverage_resource.html %}
</div>
</div>
<div id="claim-resource">
<h2 class="ds-u-text-decoration--underline ds-u-font-weight--bold">
4. Claim
</h2>
<div>
{% include guide/claim_resource.html %}
</div>
</div>
<div id="claimresponse-resource">
<h2 class="ds-u-text-decoration--underline ds-u-font-weight--bold">
5. ClaimResponse
</h2>
<div>
{% include guide/claimresponse_resource.html %}
</div>
</div>
</div>
<div id="fhir-endpoints">
<h1>
BCDA's Endpoints
</h1>
<div id="metadata-endpoint">
<h2 class="ds-u-text-decoration--underline ds-u-font-weight--bold">
1. /Metadata endpoint
</h2>
<div>
{% include guide/metadata_endpoint.html %}
</div>
</div>
<div id="patient-endpoint">
<h2 class="ds-u-text-decoration--underline ds-u-font-weight--bold">
2. /Patient endpoint
</h2>
<div>
{% include guide/patient_endpoint.html %}
</div>
</div>
<div id="group-endpoint">
<h2 class="ds-u-text-decoration--underline ds-u-font-weight--bold">
3. /Group endpoint
</h2>
<div>
{% include guide/group_endpoint.html %}
</div>
</div>
<div class="ds-c-alert ds-c-alert--hide-icon" id="endpoint-alert">
<div class="ds-c-alert__body">
<h2 class="ds-c-alert__heading">Differences between /Patient and /Group when using _since</h2>
<p class="ds-c-alert__text">
{% include guide/endpoint_alert.html %}
</p>
</div>
</div>
<div id="jobs-endpoint">
<h2 class="ds-u-text-decoration--underline ds-u-font-weight--bold">
4. /Jobs endpoint
</h2>
<div>
{% include guide/jobs_endpoint.html %}
</div>
</div>
<div id="attribution-status-endpoint">
<h2 class="ds-u-text-decoration--underline ds-u-font-weight--bold">
5. /Attribution_Status endpoint
</h2>
<div>
{% include guide/attribution_status_endpoint.html %}
</div>
</div>
</div>
<div id="BCDA-parameters">
<h1>
BCDA's Parameters
</h1>
<div>
{% include guide/bcda_parameters.html %}
</div>
<div id="type-parameter">
<h2 class="ds-u-font-weight--bold">
1. The type parameter
</h2>
<div>
{% include guide/type_parameter.html %}
</div>
</div>
<div id="since-parameter">
<h2 class="ds-u-font-weight--bold">
2. The since parameter
</h2>
<div>
{% include guide/since_parameter.html %}
</div>
</div>
</div>
<div id="bcda-v2">
<h1>
BCDA Version 2 (V2)
</h1>
<div class="ds-c-alert ds-c-alert--hide-icon" id="version-2-alert">
<div class="ds-c-alert__body">
<p class="ds-c-alert__text">
Version 2 of the Beneficiary Claims Data API (BCDA V2) is available as of Summer 2021.
</p>
</div>
</div>
<div>
{% include guide/bcda_v2.html %}
</div>
</div>
<div id="try-the-api">
<h1>
Try the API
</h1>
<div>
{% include guide/try_the_api.html %}
</div>
</div>
</div>
</main>
</div>
</div>