This page is part of the Privacy Consent on FHIR (PCF) (v1.1.0: Publication) based on FHIR (HL7® FHIR® Standard) R4. This is the current published version. For a full list of available versions, see the Directory of published versions

2:3.108 Access Consent [ITI-108]

This section corresponds to transaction [ITI-108] of the IHE Technical Framework. Transaction [ITI-108] is used by the Consent Recorder, Consent Authorization Server, and Consent Registry Actors.

2:3.108.1 Scope

The Access Consent transaction is used to find Consent Resources that satisfy a set of parameters, retrieve an instance of a Consent Resource, Create a new Consent Resource, or to Update an existing Consent Resource. This transaction is made up of discrete http RESTful interactions (aka messages): Create, Read, Update, Delete, and Search. The Consent resource is intended to be compliant with the PCF defined Actor Options and PCF defined Consent Resource constraints. The ITI-108 transaction does not require compliance to the to these profiles of the Consent Resource constraints, although the Consent Registry Actor could be configured to assure compliance.

The Access Consent transaction is focused on fundamental RESTful interactions. The Consent Recorder Actor has a more nuanced interaction between the patient and the organization, and possibly with others like a delegate of the patient with authorization to act on behalf of the patient. This nuanced interaction may also consider Privacy Preferences, current Consent rules, and organization rules. The PCF does not impose any specific behaviour at the Consent Recorder actor. There is an impact on the use of the Access Consent transaction when there is an existing Consent that is being changed. This change must follow some workflow imposed by the organization capturing the consent. This change will utalize the Access Consent transaction, specifically the Create, Update, and/or Delete interaction. There are a few patterns that the organization may chose to follow:

1. Revise the existing FHIR Consent instance. That is to use the Update interaction to change the Consent. In this environment one must be able to understand the previous Consent rules in order to understand previous enforcements and the AuditEvent logged. The Consent Registry may be using FHIR version support, thus all Updates create a history of the past.
2. Add a new FHIR Consent, and update the old FHIR Consent to indicate it is inactive. The history is clear, and this model does not require the Consent Registry to have implemented FHIR version support, although it is still useful.
3. Add a new FHIR Consent, and delete the old FHIR Consent. The implementation of FHIR delete is often implemented logically, thus the previous Consent Resource instance is available administratively. The use of delete should only be used with careful consideration of longterm lifecycle management and accountability.

2:3.108.2 Actors Roles

Table 2:3.108.2-1: Actor Roles

2:3.108.2.1 CapabilityStatement Resource

Server implementing this transaction shall provide a CapabilityStatement Resource as described in ITI TF-2x: Appendix Z.3 indicating the transaction has been implemented.

• Requirements CapabilityStatement for Consent Recorder
• Requirements CapabilityStatement for Consent Registry
• Requirements CapabilityStatement for Consent Authorization Server

2:3.108.3 Referenced Standards

FHIR-R4 HL7 FHIR Release 4.0

2:3.108.4 Messages / Interactions

2:3.108.4.1 Search Request

The Consent Recorder or Consent Authorization Server uses this request to find available Consent Resources given some search parameters.

2:3.108.4.1.1 Trigger Events

When the Consent Recorder or Consent Authorization Server needs to discover available Consent Resources given some search parameters.

2:3.108.4.1.2 Message Semantics

The Consent Recorder or Consent Authorization Server executes an HTTP search against the Consent Registry Consent URL. The search target follows the FHIR HTTP specification, addressing the Consent Resource http://hl7.org/fhir/R4/http.html:

[base]/Consent?<query>

This URL is configurable by the Consent Registry and is subject to the following constraints:

The <query> represents a series of encoded name-value pairs representing the filter for the query, as specified in Section Query Search Parameters, as well as control parameters to modify the behavior of the Consent Registry such as response format, or pagination.

The Consent Recorder or Consent Authorization Server Actor may use GET or POST based searches. The Consent Registry shall support both GET and POST based searches http://hl7.org/fhir/R4/http.html#search.

2:3.108.4.1.2.1 Query Search Parameters

The Consent Recorder or Consent Authorization Server may supply, and the Consent Registry shall be capable of processing, all query parameters listed below. All query parameter values shall be appropriately encoded per RFC3986 “percent” encoding rules. Note that percent encoding does restrict the character set to a subset of ASCII characters which is used for encoding all other characters used in the URL.

The Consent Recorder or Consent Authorization Server shall include search parameter patient or patient.identifier, and status. The Consent Registry must implement the parameters described below. The Consent Registry may choose to support additional query parameters beyond the subset listed below. Any additional query parameters supported shall be supported according to the core FHIR specification. Such additional parameters are considered out of scope for this transaction. Any additional parameters not supported should be ignored. See http://hl7.org/fhir/R4/search.html#errors.

actor: This parameter is of type Reference. This parameter would be used to look for Consent Resources that explicitly identify an actor for which there is a provision. Note that the absence of an explicit actor does not mean an absence of applicability of Consent resources.

patient: This parameter is of type Reference(Patient). The Consent Recorder or Consent Authorization Server may get this reference using the PDQm or PIXm Profile. When the patient parameter is used, the Patient reference would need to be accessible to both the Consent Recorder or Consent Authorization Server and the Consent Registry.

patient.identifier: This parameter, of type token, specifies an identifier associated with the patient to which the Consent Resource is assigned. See ITI TF-2x: Appendix Z.2 for additional constraints on the use of the token search parameter type. This use of patient.identifier follows the FHIR Chaining Parameters search methodology.

status: This parameter, of type token, specifies the status of the Consent Resource. The use of this parameter can eliminate Consent resources that are in states that are not of interest, such as draft or inactive.

2:3.108.4.1.2.2 Populating Expected Response Format

The FHIR standard provides encodings for responses as either XML or JSON. The Consent Registry shall support both message encodings, whilst the Consent Recorder or Consent Authorization Server shall support one and may support both.

See ITI TF-2x: Appendix Z.6 for details.

2:3.108.4.1.3 Expected Actions

The Consent Registry shall process the query to discover the Consent entries that match the search parameters given.

2:3.108.4.2 Search Response

The Consent Registry returns a HTTP Status code appropriate to the processing as well as a Bundle of the matching Consent Resources.

2:3.108.4.2.1 Trigger Events

The Consent Registry has processed has processed the search interaction.

2:3.108.4.2.2 Message Semantics

Based on the query results, the Consent Registry will either return an error or success. Guidance on handling Access Denied related to use of 200, 403 and 404 can be found in ITI TF-2x: Appendix Z.7.

When the Consent Registry needs to report an error, it shall use HTTP error response codes and should include a FHIR OperationOutcome with more details on the failure. See FHIR http://hl7.org/fhir/R4/http.html and http://hl7.org/fhir/R4/operationoutcome.html.

If the search interaction is processed successfully, whether or not any Consent Resources are found, the HTTP status code shall be 200. The search response message shall be a Bundle Resource containing zero or more Consent Resources. If the Consent Registry is sending warnings, the Bundle Resource shall also contain an OperationOutcome Resource that contains those warnings.

The response shall adhere to the FHIR Bundle constraints specified in ITI TF-2x: Appendix Z.1.

2:3.108.4.2.2.1 Consent Resource Contents

The Consent Resources returned shall be compliant with the FHIR specification http://hl7.org/fhir/R4/consent.html.

The Consent Resources returned should be compliant with the IHE restrictions on the Consent Resource.

2:3.108.4.2.3 Expected Actions

The Consent Recorder or Consent Authorization Server shall process the results according to application-defined rules. The Consent Recorder or Consent Authorization Server should be robust as the response may contain Consent Resources that match the query parameters but are not compliant with the IHE Consent constraints defined here.

2:3.108.4.3 Create Request

The Consent Recorder has a need to create a new Consent Resource.

2:3.108.4.3.1 Trigger Events

A new Consent Resource needs to be recorded.

2:3.108.4.3.2 Message Semantics

The FHIR create interaction is used. See http://hl7.org/fhir/R4/http.html#create.

Update as Create is not required but may be supported by the actors beyond the scope of this transaction.

2:3.108.4.3.3 Expected Actions

The Consent Registry shall handle the create request according to policy. See the discussion in the FHIR create interaction.

2:3.108.4.4 Create Response

The Consent Recorder has received an Create Request and needs to return a response.

2:3.108.4.4.1 Trigger Events

The Consent Registry has processed the FHIR create interaction.

2:3.108.4.4.2 Message Semantics

See the FHIR create interaction. The success or failure of the create interaction is indicated by the http response code (e.g., 400, 200, etc.).

2:3.108.4.4.3 Expected Actions

There is no defined expected actions to be taken by the Consent Recorder, however user interface and workflow may be affected by the response code.

2:3.108.4.5 Read Request

The Consent Recorder or Consent Authorization Server have a Consent id and need to retrieve the current Consent resource instance. The id may have been discovered via some undefined method. For example an authorization token request may be referring to a Consent by id. Note that search can also be used given an id, but will result in a Bundle, whereas the Read Request returns only the Consent resource.

2:3.108.4.5.1 Trigger Events

A specific Consent is needed and the id is known.

2:3.108.4.5.2 Message Semantics

The FHIR read interaction or FHIR vread interaction are used. See http://hl7.org/fhir/R4/http.html#vread and http://hl7.org/fhir/R4/http.html#vread. The Consent Registry shall support both interactions.

2:3.108.4.5.3 Expected Actions

The Consent Registry shall handle the read or vread request according to policy. See the discussion in the FHIR read interaction and http://hl7.org/fhir/R4/http.html#vread.

2:3.108.4.6 Read Response

The Consent Recorder has received a read or vread request and needs to return a response.

2:3.108.4.6.1 Trigger Events

The Consent Recorder has processed the FHIR read interaction or FHIR vread interaction.

2:3.108.4.6.2 Message Semantics

See the FHIR read interaction and FHIR vread interaction. The success or failure of the read interaction is indicated by the http response code (e.g., 404, 200, etc.).

2:3.108.4.6.3 Expected Actions

There is no defined expected actions to be taken, however user interface and workflow may be affected by the response code.

2:3.108.4.7 Update Request

The Consent Recorder has a need to update an identified existing Consent Resource. This might be because the terms of a Consent has changed, or might be because a Consent.status needs to be updated, such as to mark a Consent as inactive.

2:3.108.4.7.1 Trigger Events

The Consent Recorder has a need to update an identified existing Consent Resource.

2:3.108.4.7.2 Message Semantics

The FHIR update interaction is used. See http://hl7.org/fhir/R4/http.html#update.

Update as Create, Conditional update, and Patch are not required but may be supported by the actors beyond the scope of this transaction.

2:3.108.4.7.3 Expected Actions

The Consent Registry shall handle the update request according to policy. See the discussion in the FHIR update interaction.

2:3.108.4.8 Update Response

The Consent Recorder has received an Update Request and needs to return a response.

2:3.108.4.8.1 Trigger Events

The Consent Recorder has processed the FHIR update interaction.

2:3.108.4.8.2 Message Semantics

See the FHIR update interaction. The success or failure of the update interaction is indicated by the http response code (e.g., 400, 200, etc.).

2:3.108.4.8.3 Expected Actions

There is no defined expected actions to be taken by the Consent Recorder, however user interface and workflow may be affected by the response code.

2:3.108.4.9 Delete Request

The Consent Recorder could use this interaction to delete a Consent Resource. Note that Delete may not be supported, and thus the use of Update to a Consent.status to inactive may be the more proper policy. Note that when a Consent Resource is created in error, the use of Update to a Consent.status of entered-in-error may be preferred.

2:3.108.4.9.1 Trigger Events

The Consent Recorder has a need to delete an identified existing Consent Resource.

2:3.108.4.9.2 Message Semantics

The FHIR delete interaction is used. See http://hl7.org/fhir/R4/http.html#delete.

Conditional Delete is not required but may be supported by the actors beyond the scope of this transaction.

2:3.108.4.9.2 Expected Actions

The Consent Registry shall handle the delete request according to policy. See the discussion in the FHIR delete interaction.

2:3.108.4.10 Delete Response

The Consent Recorder has received a Delete Request and needs to return a response.

2:3.108.4.10.1 Trigger Events

The Consent Recorder has processed the FHIR delete interaction.

2:3.108.4.10.2 Message Semantics

See the FHIR delete interaction. The success or failure of the delete interaction is indicated by the http response code (e.g., 405, 200, etc.).

2:3.108.4.10.3 Expected Actions

There is no defined expected actions to be taken by the Consent Recorder, however user interface and workflow may be affected by the response code.

2:3.108.5 Security Considerations

See PCF Security Considerations.

This transaction should not return information that the Consent Recorder or Consent Authorization Server is not authorized to access. Where authorization here is inclusive of system, app, and user according to local policy, patient consents, and security layering. However, the transaction may return Consent resources that have Reference elements that may not have access to. This is to say that the authorization need only be to the content returned in the Bundle. There may be references (URLs) for which the content is not authorized. This is considered proper as the client would need to retrieve the content pointed to by those references, and at that time the proper authorization decision would be made on that context and content. In this way it is possible for a client to get Consent resources that are pointing at data that the client is not authorized to retrieve. Thus, the URLs used must be carefully crafted so as to not expose sensitive data in the URL value.

2:3.108.5.1 Security Audit Considerations

Recording audit logs is important for Security, Privacy, and data integrity assurance.

2:3.108.5.1.1 Consent Recorder Audit

The Consent Recorder when grouped with ATNA Secure Node or Secure Application shall be able to record a Patient specific REST event AuditEvent as defined in IHE Basic Audit Log Patterns (BALP).

2:3.108.5.1.2 Consent Authorization Server Audit

The Consent Authorization Server when grouped with ATNA Secure Node or Secure Application shall be able to record a Patient specific REST event AuditEvent as defined in IHE Basic Audit Log Patterns (BALP).

2:3.108.5.1.2 Consent Registry Audit

The Consent Recorder when grouped with ATNA Secure Node or Secure Application shall be able to record a Patient specific REST event AuditEvent as defined in IHE Basic Audit Log Patterns (BALP).