CH EPR FHIR (R4)
4.0.1 - trial-use Switzerland flag

This page is part of the CH EPR FHIR (R4) (v4.0.1: DSTU 4) based on FHIR (HL7® FHIR® Standard) R4. This is the current published version in its permanent home (it will always be available at this URL). For a full list of available versions, see the Directory of published versions

Mobile Privacy Policy Feed [PPQ-3]

Scope

This transaction is used by the Policy Source to add, update, or delete single privacy policies. Correspondingly, the following HTTP methods SHALL be supported: POST, PUT, and DELETE.

HTTP Method POST

Interaction Diagram for [PPQ-3 POST]Policy SourcePolicy RepositoryHTTPPOST[baseUrl]/ConsentPayload: ConsentHTTP responsePayload: none / OperationOutcome / Consent
Figure 2: PPQ-3: HTTP Method POST

Trigger Event

The Policy Source uses HTTP method POST to submit a single new privacy policy to the Policy Repository.

Request Message

The request body SHALL represent a single Consent resource compliant to the PpqmConsent profile.

The request SHALL be sent to [baseUrl]/Consent.

Expected Actions

Upon receiving the HTTP POST request, the Policy Repository SHALL:

  • Validate the Consent resource contained in the request body.
  • Persist the policy set represented by this Consent.
  • Create a PPQ-3 response according to the transaction outcome.

Response Message

The PPQ-3 response SHALL be created according to the section 3.1.0.8 of the FHIR R4 specification.

HTTP Method PUT

Interaction Diagram for [PPQ-3 PUT]Policy SourcePolicy RepositoryHTTPPUT[baseUrl]/Consent?identifier=[uuid]Payload: ConsentHTTP responsePayload: none / OperationOutcome / Consent
Figure 3: PPQ-3: HTTP Method PUT

Trigger Event

The Policy Source uses HTTP method PUT to submit a new or update an existing single privacy policy.

Request Message

The request body SHALL represent a single Consent resource compliant to the PpqmConsent profile.

The request SHALL be sent to [baseUrl]/Consent?identifier=[uuid].

Expected Actions

The Policy Repository SHALL implement the Conditional Update pattern described in section 3.1.0.4.3 of the FHIR R4 specification.

Upon receiving the HTTP PUT request, the Policy Repository SHALL:

  • Validate the Consent resource contained in the request body. In particular, it SHALL be validated that the policy set ID is the same as in the HTTP URL.
  • Persist the policy set represented by this Consent.
  • Create a PPQ-3 response according to the transaction outcome.

Response Message

The PPQ-3 response SHALL be created according to the section 3.1.0.4 of the FHIR R4 specification.

HTTP Method DELETE

Interaction Diagram for [PPQ-3 DELETE]Policy SourcePolicy RepositoryHTTPDELETE[baseUrl]/Consent?identifier=[uuid]Payload: noneHTTP responsePayload: none / OperationOutcome
Figure 4: PPQ-3: HTTP Method DELETE

Trigger Event

The Policy Source uses HTTP method DELETE to delete a single existing privacy policy from the Policy Repository.

Request Message

The request body SHALL be empty.

The request SHALL be sent to [baseUrl]/Consent?identifier=[uuid].

Expected Actions

The Policy Repository SHALL implement the Conditional Delete pattern described in section 3.1.0.7.1 of the FHIR R4 specification.

Upon receiving the HTTP DELETE request, the Policy Repository SHALL:

  • Delete the policy set referenced in the request.
  • Create a PPQ-3 response according to the transaction outcome.

Response Message

The PPQ-3 response SHALL be created according to the section 3.1.0.7 of the FHIR R4 specification.

Security Considerations

TLS SHALL be used. For user authentication and authorization, the IUA profile with extended access token SHALL be used as described in the Amendment mHealth of Annex 5, Section 3.2. Consequently, the Mobile Privacy Policy Feed [PPQ-3] transaction SHALL be combined with the Incorporate Access Token [ITI-72] transaction of the IUA profile.

The actors SHALL support the traceparent header handling, as defined in Appendix: Trace Context.

The Policy Source and Policy Repository SHALL record the right audit event for the operations: