Skip to content

Commit

Permalink
[DPC-4107] Update docsV1.md (#112)
Browse files Browse the repository at this point in the history
## 🎫 Ticket

https://jira.cms.gov/browse/DPC-4107

## 🛠 Changes

Updated instructions for uploading a public key, creating an
attestation, and deleting a group.

## ℹ️ Context for reviewers

(Background context, more in-depth details of the implementation, and
anything else you'd like to call out or ask reviewers.)

## ✅ Acceptance validation

Uploading a public key

![image](https://github.com/CMSgov/dpc-static-site/assets/134093673/d97e1177-2849-4ef4-bcce-5b6b92f6f4d4)

Creating an attestation

![image](https://github.com/CMSgov/dpc-static-site/assets/134093673/390e881e-a961-45bc-a1ab-f78bf1b6fafc)

Deleting a group

![image](https://github.com/CMSgov/dpc-static-site/assets/134093673/7c54acb8-2308-494d-b3aa-72e73edadfb6)

## 🔒 Security Implications

- [ ] Adds a new software dependency or dependencies
- [ ] Modifies or invalidates one or more of our security controls
- [ ] Stores or transmits data that was not stored or transmitted before
- [ ] Requires additional review of its security implications

If any security implications apply, add Jason Ashbaugh (GitHub username:
StewGoin) as a reviewer and do not merge this PR without his approval.
  • Loading branch information
ashley-weaver authored Jun 18, 2024
1 parent ce20c9b commit 53b5f48
Showing 1 changed file with 8 additions and 8 deletions.
16 changes: 8 additions & 8 deletions common/docsV1.md
Original file line number Diff line number Diff line change
Expand Up @@ -273,7 +273,7 @@ Public keys verify that client token requests are coming from an authorized appl
openssl base64 -in snippet.txt.sig -out signature.sig
~~~

**5. Paste the contents** of your verified public key signature (signature.txt file) into the ‘Public Key Signature’ field in your DPC Account.
**5. Paste the contents** of your verified public key signature (signature.sig file) into the ‘Public Key Signature’ field in your DPC Account.

**6. Click "Add Key"** to upload your public key.

Expand Down Expand Up @@ -1094,7 +1094,7 @@ Details on Provenance Resources are given in the <a href="https://www.hl7.org/fh
- **Timestamp:** Time when attestation was made.
- **Reason:** Reason for the attestation (currently only: http://hl7.org/fhir/v3/ActReason#TREAT is supported).
- **Organization ID:** The agent making the attestation referenced by their Organization Resource ID.
- _Your Organization ID can be found by referencing the {id} variable in the resource object of your practitioner._
- _Your Organization ID can be found in the DPC Portal by following <a href="#find-organization-id"> these instructions</a>._
- **Practitioner ID:** The practitioner attached to the attestation referenced by their Practitioner ID.
- _Your Practitioner ID can be found by referencing the {id} variable in the resource object of your practitioner._

Expand Down Expand Up @@ -1145,7 +1145,7 @@ The attestation is then included in the X-Provenance header as part of any opera
<a href="#create-a-group" class="ds-u-padding-left--3 guide_sub-link">Create a group</a><br />
<a href="#update-a-group" class="ds-u-padding-left--3 guide_sub-link">Update a group</a><br />
<a href="#add-patients-to-group" class="ds-u-padding-left--3 guide_sub-link">Add patients to group</a><br />
<a href="#delete-a-group" class="ds-u-padding-left--3 guide_sub-link">delete a group</a><br />
<a href="#delete-a-group" class="ds-u-padding-left--3 guide_sub-link">Delete a group</a><br />
<a href="#removing-patients-from-a-group" class="ds-u-padding-left--3 guide_sub-link">Removing patients from a group</a><br />
<a href="#overwrite-a-group-membership" class="ds-u-padding-left--3 guide_sub-link">Overwrite a group membership</a><br />
<a href="#locate-your-groupid" class="ds-u-padding-left--3 guide_sub-link">Locate your group.id</a>
Expand Down Expand Up @@ -1341,16 +1341,16 @@ You may want to delete a group if you no longer require data for the patients wi
Group IDs can be found either at creation or as the result of [locating your Group ID](#locate-your-groupid).

#### Request:
<pre class="highlight"><code>api/v1/Group?characteristic-value=attributed-to$<span style="color: #045E87;">{Group.id}</span></code></pre>
<pre class="highlight"><code>api/v1/Group/$<span style="color: #045E87;">{Group.id}</span></code></pre>

#### cURL command:
<pre class="highlight"><code>curl -v https://sandbox.dpc.cms.gov/api/v1/Group?characteristic-value=attributed-to${Group ID} \
<pre class="highlight"><code>curl -v https://sandbox.dpc.cms.gov/api/v1/Group/${Group.id} \
     -H 'Authorization: Bearer {access_token}' \
     -H 'Accept: application/json' \
     -H 'Content-Type: application/json' \
     -H 'Accept: application/fhir+json' \
     -H 'Content-Type: application/fhir+json' \
     -X DELETE</code></pre>

### Reponse:
### Response:
<pre class="highlight"><code>200 - Group was removed</code></pre>

### Removing patients from a group
Expand Down

0 comments on commit 53b5f48

Please sign in to comment.