You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
DPC also offers a <a href="{{ '/api-documentation/postman-collection' | relative_url }}">Postman collection</a> with sample requests to public endpoints.
28
+
DPC also offers a <a href="{{ '/api-documentation/postman-collection.html' | relative_url }}">Postman collection</a> with sample requests to public endpoints.
29
29
</p>
30
30
</div>
31
31
</div>
32
32
<ol style="margin-top: 1rem;">
33
-
<li>Get an <a href="{{ '/api-documentation/get-access-token' | relative_url }}">access token</a>.</li>
Copy file name to clipboardExpand all lines: src/_pages/api-documentation/attribution.md
+4-4Lines changed: 4 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -12,12 +12,12 @@ Before accessing patient data, DPC must establish that you have a valid patient-
12
12
13
13
DPC provides you with a bundle of [sample practitioners](https://github.com/CMSgov/dpc-app/blob/main/dpc-web/public/practitioner_bundle.json){:target="_blank"} and [sample patients](https://github.com/CMSgov/dpc-app/blob/main/dpc-web/public/patient_bundle.json){:target="_blank"} to complete attribution in the DPC Sandbox.
14
14
15
-
1.[Upload practitioners]({{ "/api-documentation/attribution/upload-practitioners" | relative_url }}) in your organization.
16
-
2.[Upload patients]({{ "/api-documentation/attribution/upload-patients" | relative_url }}) in your care.
17
-
3. Attribute patients to their practitioners by [creating a group]({{ "/api-documentation/attribution/attestation#create-a-patient-group-resource" | relative_url }}) in the Attestation stage.
15
+
1.[Upload practitioners]({{ "/api-documentation/attribution/upload-practitioners.html" | relative_url }}) in your organization.
16
+
2.[Upload patients]({{ "/api-documentation/attribution/upload-patients.html" | relative_url }}) in your care.
17
+
3. Attribute patients to their practitioners by [creating a group]({{ "/api-documentation/attribution/attestation.html#create-a-patient-group-resource" | relative_url }}) in the Attestation stage.
18
18
19
19
## Attestation
20
20
21
-
You'll need to submit an [Attestation]({{ "/api-documentation/attribution/attestation" | relative_url }}) each time you attribute a patient to a provider group.
21
+
You'll need to submit an [Attestation]({{ "/api-documentation/attribution/attestation.html" | relative_url }}) each time you attribute a patient to a provider group.
22
22
23
23
{% include alert.html variant="warning" text="The DPC sandbox does not preload any test data." classNames="measure-6" %}
Copy file name to clipboardExpand all lines: src/_pages/api-documentation/attribution/attestation.md
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -74,7 +74,7 @@ Find your Practitioner ID by referencing the {id} variable in the resource objec
74
74
75
75
## Create a patient Group Resource
76
76
77
-
You'll need to create a Group Resource to link a list of registered [patients]({{ "/api-documentation/attribution/upload-patients" | relative_url }}) to a registered [practitioner]({{ "/api-documentation/attribution/upload-practitioners" | relative_url }}).
77
+
You'll need to create a Group Resource to link a list of registered [patients]({{ "/api-documentation/attribution/upload-patients.html" | relative_url }}) to a registered [practitioner]({{ "/api-documentation/attribution/upload-practitioners.html" | relative_url }}).
78
78
79
79
**Group Resource requirements**
80
80
@@ -404,7 +404,7 @@ You can only pull data for one practitioner’s patient group at a time. Do this
404
404
405
405
The response will return a [Bundle](https://www.hl7.org/fhir/STU3/bundle.html) Resource which contains attribution Groups for the given practitioner.
406
406
407
-
You can use the Group ID value of the returned resources to [initiate an export job]({{ "/api-documentation/export-data#initiate-an-export-job" | relative_url }}). Find your Group ID by referencing the `id` variable in your group’s resource object.
407
+
You can use the Group ID value of the returned resources to [initiate an export job]({{ "/api-documentation/export-data.html#initiate-an-export-job" | relative_url }}). Find your Group ID by referencing the `id` variable in your group’s resource object.
Copy file name to clipboardExpand all lines: src/_pages/api-documentation/export-data.md
+4-4Lines changed: 4 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -10,11 +10,11 @@ in-page-nav: true
10
10
11
11
## The `/Group/$export` operation
12
12
13
-
The FHIR `/Group/$export` operation is the primary interaction with the DPC Sandbox API. It lets you export [Patient, Coverage, and Explanation of Benefit data]({{ "/dpc-data" | relative_url }}) asynchronously and in bulk. Details on the FHIR bulk data operations can be found in the [FHIR Bulk Data Specification](https://build.fhir.org/ig/HL7/bulk-data/OperationDefinition-group-export.html).
13
+
The FHIR `/Group/$export` operation is the primary interaction with the DPC Sandbox API. It lets you export [Patient, Coverage, and Explanation of Benefit data]({{ "/dpc-data.html" | relative_url }}) asynchronously and in bulk. Details on the FHIR bulk data operations can be found in the [FHIR Bulk Data Specification](https://build.fhir.org/ig/HL7/bulk-data/OperationDefinition-group-export.html).
14
14
15
15
### Filtering data with `_type` and `_since`
16
16
17
-
Use `_type` and `_since` to [filter your results]({{ "/api-documentation/export-data/how-to-filter" | relative_url }}) by content, time, and range.
17
+
Use `_type` and `_since` to [filter your results]({{ "/api-documentation/export-data/how-to-filter.html" | relative_url }}) by content, time, and range.
18
18
19
19
#### Filter by FHIR Resource type with `_type`
20
20
Specify which of the FHIR resources to download using the `_type` query parameter (e.g., `?_type=Patient,Coverage`).
@@ -23,13 +23,13 @@ Specify which of the FHIR resources to download using the `_type` query paramete
23
23
Choose to download data obtained after a certain date by adding the `_since` parameter (e.g., only show Patient data from January 7, 2025 to the present).
24
24
25
25
#### Get all of a patient’s data
26
-
Use [`/Patient/{PATIENT_ID}/$everything`]({{ "/api-documentation/export-data/patient-everything" | relative_url }}) for 7 years’ historical data including Patient, Coverage, and ExplanationOfBenefit Resources.
26
+
Use [`/Patient/{PATIENT_ID}/$everything`]({{ "/api-documentation/export-data/patient-everything.html" | relative_url }}) for 7 years’ historical data including Patient, Coverage, and ExplanationOfBenefit Resources.
27
27
28
28
## Initiating an export job
29
29
30
30
### 1. Locate your Group ID
31
31
32
-
In order to start a patient data export job, locate your [Group ID]({{ "/api-documentation/attribution/attestation#create-a-patient-group-resource" | relative_url }}) by referencing the `id` variable in the resource object of your group.
32
+
In order to start a patient data export job, locate your [Group ID]({{ "/api-documentation/attribution/attestation.html#create-a-patient-group-resource" | relative_url }}) by referencing the `id` variable in the resource object of your group.
Copy file name to clipboardExpand all lines: src/_pages/api-documentation/export-data/how-to-filter.md
+4-4Lines changed: 4 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -12,7 +12,7 @@ DPC uses `_type` and `_since` parameters to filter your results by content, time
12
12
13
13
## Filter claims data by FHIR Resource with `_type`
14
14
15
-
The `_type` query parameter allows you to specify which FHIR Resources you wish to export. If you do not specify a `_type` parameter in your request, all three resources will be exported: [Explanation of Benefit, Patient, and Coverage]({{ "/dpc-data" | relative_url }}). You can specify these Resources individually or as a group using a comma delimited list and the syntax `?_type=ExplanationOfBenefit,Patient,Coverage`.
15
+
The `_type` query parameter allows you to specify which FHIR Resources you wish to export. If you do not specify a `_type` parameter in your request, all three resources will be exported: [Explanation of Benefit, Patient, and Coverage]({{ "/dpc-data.html" | relative_url }}). You can specify these Resources individually or as a group using a comma delimited list and the syntax `?_type=ExplanationOfBenefit,Patient,Coverage`.
16
16
17
17
The following request will export the Patient and Coverage Resources, but NOT the Explanation of Benefit Resource.
18
18
@@ -43,11 +43,11 @@ On subsequent calls you can begin retrieving incremental claims data for your be
43
43
Two ways to use `_since`:
44
44
45
45
1. Request the most recent data for all beneficiaries: [Use `_since` within the `/Group` endpoint](#request-data-using-_since-with-the-group-endpoint).
46
-
2. Request data synchronously for an individual patient: [Use `_since` within the `/Patient` endpoint]({{ "/api-documentation/export-data/patient-everything#requesting-data-using-_since-with-the-patient-endpoint" | relative_url }}).
46
+
2. Request data synchronously for an individual patient: [Use `_since` within the `/Patient` endpoint]({{ "/api-documentation/export-data/patient-everything.html#requesting-data-using-_since-with-the-patient-endpoint" | relative_url }}).
47
47
48
48
### Steps to request filtered data
49
49
50
-
1. Obtain an [access token]({{ "/api-documentation/get-access-token" | relative_url }}).
50
+
1. Obtain an [access token]({{ "/api-documentation/get-access-token.html" | relative_url }}).
51
51
2. Start a job to acquire data (you will input the `_since` parameter here. Omit `_since` to download all data).
52
52
3. Check the job status.
53
53
4. Download the data.
@@ -60,7 +60,7 @@ Datetimes submitted using `_since` must follow the [FHIR Instant format](https:/
60
60
61
61
#### The value of the `_since` parameter must be URL encoded
62
62
63
-
When using the [Postman Collection]({{ "/api-documentation/postman-collection" | relative_url }}), you'll need to manually encode the `_since` parameter when it contains a `+` since Postman does not automatically encode this character.
63
+
When using the [Postman Collection]({{ "/api-documentation/postman-collection.html" | relative_url }}), you'll need to manually encode the `_since` parameter when it contains a `+` since Postman does not automatically encode this character.
64
64
65
65
You can do this either by replacing the `+` with `%2B` (e.g., 2020-01-23T04:00:00.000%2B07:00 instead of 2020-01-23T04:00:00.000+07:00), or you can select the value and choose "EncodeURIComponent" from the context menu to have Postman encode the entire parameter automatically.
Copy file name to clipboardExpand all lines: src/_pages/api-documentation/export-data/patient-everything.md
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -17,11 +17,11 @@ The `/Patient/{PATIENT_ID}/$everything` endpoint lets you retrieve all resources
17
17
This is a synchronous download. `/Patient/{PATIENT_ID}/$everything` doesn't create a job that needs to be monitored or data files to download. The response body will contain the bundle. This is how it differs from a Group $export operation.
18
18
19
19
20
-
**Note:** A Patient record must already exist in the DPC database to complete your request. However, the patient does not need to belong to [a group]({{ "/api-documentation/attribution/attestation#create-a-patient-group-resource" | relative_url }}).
20
+
**Note:** A Patient record must already exist in the DPC database to complete your request. However, the patient does not need to belong to [a group]({{ "/api-documentation/attribution/attestation.html#create-a-patient-group-resource" | relative_url }}).
21
21
22
22
## Find a patient’s DPC ID
23
23
24
-
If you only have the patient’s Medicare Beneficiary Identifier (MBI) you can retrieve the DPC internal ID by first [making a GET request for that specific patient]({{ "/api-documentation/attribution/upload-patients/add-view-list-patients#list-a-specific-patient" | relative_url }}). The UUID is returned in that response.
24
+
If you only have the patient’s Medicare Beneficiary Identifier (MBI) you can retrieve the DPC internal ID by first [making a GET request for that specific patient]({{ "/api-documentation/attribution/upload-patients/add-view-list-patients.html#list-a-specific-patient" | relative_url }}). The UUID is returned in that response.
- A registered Client Token ([Generate a client token]({{ "/api-documentation/get-sandbox-credentials#2-generate-a-client-token-in-the-sandbox-site" | relative_url }}))
21
-
- Your Public Key ID ([Get a specific public key]({{ "/api-documentation/get-access-token/manage-credentials#get-a-specific-public-key" | relative_url }}))
- A registered Client Token ([Generate a client token]({{ "/api-documentation/get-sandbox-credentials.html#2-generate-a-client-token-in-the-sandbox-site" | relative_url }}))
21
+
- Your Public Key ID ([Get a specific public key]({{ "/api-documentation/get-access-token/manage-credentials.html#get-a-specific-public-key" | relative_url }}))
Copy file name to clipboardExpand all lines: src/_pages/api-documentation/get-access-token/create-jwt-manually.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -26,7 +26,7 @@ Review these steps if you’d prefer to create a JWT manually without using the
26
26
27
27
**Example decoded payload**
28
28
29
-
The `PUBLIC_KEY_ID` shown in the example is the one you generated while setting up DPC sandbox credentials. See [Create a public key]({{ "/api-documentation/get-sandbox-credentials#3-create-a-public-key" | relative_url }}).
29
+
The `PUBLIC_KEY_ID` shown in the example is the one you generated while setting up DPC sandbox credentials. See [Create a public key]({{ "/api-documentation/get-sandbox-credentials.html#3-create-a-public-key" | relative_url }}).
0 commit comments