Page Status: updated 2023-01-26
Consent - Close
Page index
Introduction
Sv. Avregistrera dospatient, Uppdatera åtkomstsamtycke
This page describes how to end a consent for a patient by an example.
Updating a consent is done by the following operation.
PUT [base]/Consent
A set of HTTP headers must be provided in order to update a consent and the consent itself is provided as a Consent in the HTTP body.
- HTTP headers: see HTTP Header and Authorization for more information about the various headers used by the National Medication List.
- HTTP body: see Consent for more information about the Consent resource.
A PUT will update the resource in its entirety, it is therefore important to get the latest version of the resource before performing a change. The resource is identified by the logical id (the id element). A PUT on a non existing logical id will fail.
Before a consent is updated, the user needs access to other information in the National Medication List. For more information on different scenarios and what information is required for each scenario, see Handbok för vård- och apotekstjänster: Verksamhetsområden.
Examples
HTTP Headers
See HTTP Header and Authorization for generic information about all HTTP headers used by the National Medication List including information about authorization, purpose and access type. The authorization token is translated to an authority role. The authority role together with the purpose and type of access is used by the National Medication List to determine what actions a user may perform and what information the user may access.
| Header | Comment |
|---|---|
| authorization | The users's security token |
| prefer | Type of returned content |
| x-access | The cause for the call |
| x-context-id | An ID to group a sequence of requests |
| x-org-info | Information about the users's organisation |
| x-patientref | The logical ID of the patient |
| x-provenance | A provenance resource with information about the user interacting with NLL |
| x-purpose | The purpose of the call |
| x-request-id | A random and unique ID |
| x-user-agent | Information about the calling system |
Example 1 - Inactivate a multi dose dispensing consent
This example shows how to end the multi dose dispensing consent created in Create a multi dose dispensing consent.
HTTP headers
| Header | Value | Comment |
|---|---|---|
| authorization | {...,"FORSKRIVARKOD":"9000027","VARDGIVARE":"0123456789","YRKESKOD":["LK"],"loa":3} |
Selected information from the OAuth2-ticket in decoded form |
| prefer | ||
| x-access | ||
| x-org-info | {"orgenhetsOrt":"Sala"} |
Decoded value |
| x-patientref | ||
| x-provenance | Provenance for a healthcare user | Decoded value |
| x-purpose | ||
| x-request-id | bdf0c50a-65d1-4509-9ef7-47d4f425e930 |
|
| x-user-agent | {"name":"Test application","version":"0.01010101010.1 beta"} |
Decoded value |
HTTP body: Close NLLMultiDoseDispConsent
Example 2 - Inactivate an access consent
This example shows how to end the proposed access consent created in Create an access consent.
HTTP headers
| Header | Value | Comment |
|---|---|---|
| authorization | {...,"FORSKRIVARKOD":"9000027","VARDGIVARE":"0123456789","YRKESKOD":["LK"],"loa":3} |
Selected information from the OAuth2-ticket in decoded form |
| prefer | ||
| x-access | ||
| x-org-info | {"orgenhetsOrt":"Sala"} |
Decoded value |
| x-patientref | ||
| x-provenance | Provenance for a healthcare user | Decoded value |
| x-purpose | ||
| x-request-id | b6739c1f-5902-418d-968f-c0091bbfab4e |
|
| x-user-agent | {"name":"Test application","version":"0.01010101010.1 beta"} |
Decoded value |
HTTP body: Close NLLAccessConsent