Scalable Consent Management
1.0.0-preview - STU 1 PReview United States of America flag

Scalable Consent Management, published by HL7 International / Community Based Collaborative Care. This guide is not an authorized publication; it is the continuous build for version 1.0.0-preview built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/fhir-consent-management/ and changes regularly. See the Directory of published versions

Requirements: Technical Specification Client

Official URL: http://hl7.org/fhir/us/consent-management/Requirements/technical-specification-client Version: 1.0.0-preview
Standards status: Trial-use Maturity Level: 1 Computable Name: TechnicalSpecificationClient

Technical Specification Requirements for Client

Requirements Actor(s)

These requirements apply to the following actors:

  • Client An application or product that implements the Client.

Requirements Statement List

Specification: HL7 FAST Consent IG

Link to Text: https://build.fhir.org/ig/HL7/fhir-consent-management/en/technical.html

Conformance: SHALL

Notes: Not testable yet - need lots more details about the lifecycle of relates resource instances. Query or match? Implies CAS is an MPI and similar for other resources? Doesn’t say what triggers these queries to occur, or what effect it has on workflows, or whether discovered identifiers are used in resources...

Specification: HL7 FAST Consent IG

Link to Text: https://build.fhir.org/ig/HL7/fhir-consent-management/en/technical.html

Conformance: SHOULD

Notes: Because it's a SHOULD, assumes other ways; for now this is the only way we'll test.

Specification: HL7 FAST Consent IG

Link to Text: https://build.fhir.org/ig/HL7/fhir-consent-management/en/technical.html

Conformance: SHOULD

Notes: Because it's a SHOULD, assumes other ways; for now this is the only way we'll test.

Specification: HL7 FAST Consent IG

Link to Text: https://build.fhir.org/ig/HL7/fhir-consent-management/en/technical.html

Conformance: SHALL

Notes: Need conformance words - who does this apply to? Assuming clients, but which ones? What triggering actions? Are clients required to support only, or that they positively subscribe to specific other systems? Suggest referencing section with normative workflows.

Specification: HL7 FAST Consent IG

Link to Text: https://build.fhir.org/ig/HL7/fhir-consent-management/en/technical.html

Conformance: MAY

Notes: - No conformance words "client will...", so not clear which actors SHALL or MAY support. For now, treating as MAY for both clients and servers - tests can be conditional. - Nature of topic is it allows combinations of criteria. I'll call out each criterion below for traceability. - TBD whether there need to be requirements for CAS to detect and fire Consent events or if implied by subs framework.

Specification: HL7 FAST Consent IG

Link to Text: https://build.fhir.org/ig/HL7/fhir-consent-management/en/technical.html

Conformance: SHOULD

Notes: Capturing because conformance verb, but can't test a negative.

Specification: HL7 FAST Consent IG

Link to Text: https://build.fhir.org/ig/HL7/fhir-consent-management/en/technical.html

Conformance: SHALL

Specification: HL7 FAST Consent IG

Link to Text: https://build.fhir.org/ig/HL7/fhir-consent-management/en/technical.html

Conformance: SHALL

Notes: Implied - need requirement

Specification: HL7 FAST Consent IG

Link to Text: https://build.fhir.org/ig/HL7/fhir-consent-management/en/technical.html

Conformance: SHOULD


Language: en

These requirements apply to the actor Client

requirement-67SHALL

Consent Client SHALL query the consent administration service for the identifiers of the involved patients, practitioners, organizations, and related persons<br/><br/>Not testable yet - need lots more details about the lifecycle of relates resource instances. Query or match? Implies CAS is an MPI and similar for other resources? Doesn’t say what triggers these queries to occur, or what effect it has on workflows, or whether discovered identifiers are used in resources...

Links:

requirement-1168SHOULD

To search for consents by organization identifier, implementers SHOULD use the controller:identifier chained search parameter (e.g., GET [base]/Consent?controller:identifier=|1234567890) rather than a custom organization ID search parameter<br/><br/>Because it's a SHOULD, assumes other ways; for now this is the only way we'll test.

Links:

requirement-1169SHOULD

To search for consents by patient identifier, implementers SHOULD use the patient:identifier chained search parameter (e.g., GET [base]/Consent?patient:identifier=http://example.org/mrn|M1230041)<br/><br/>Because it's a SHOULD, assumes other ways; for now this is the only way we'll test.

Links:

requirement-265SHALL

This guide mandates that Subscriptions be used<br/><br/>Need conformance words - who does this apply to? Assuming clients, but which ones? What triggering actions? Are clients required to support only, or that they positively subscribe to specific other systems? Suggest referencing section with normative workflows.

Links:

requirement-202MAY

Consent Client MAY subscribe to Consent topics as defined by the FAST Subscription Topic<br/><br/>- No conformance words "client will...", so not clear which actors SHALL or MAY support. For now, treating as MAY for both clients and servers - tests can be conditional.

  • Nature of topic is it allows combinations of criteria. I'll call out each criterion below for traceability.
  • TBD whether there need to be requirements for CAS to detect and fire Consent events or if implied by subs framework.

Links:

requirement-1170SHOULD

Systems conforming to this guide SHOULD NOT update an existing Consent resource in place using RESTful PUT or PATCH<br/><br/>Capturing because conformance verb, but can't test a negative.

Links:

requirement-1165SHALL

Consent Client SHALL support AuditEvent search by Consent (entity)

Links:

requirement-299SHALL

Consent Client SHALL support AuditEvent search by patient<br/><br/>Implied - need requirement

Links:

requirement-1167SHOULD

For disclosure events (cases where health information was actually shared following a permit decision), implementers SHOULD follow IHE-BALP patterns and the ITI-81 Retrieve ATNA Audit Event transaction for querying those events

Links: