Scalable Consent Management
0.1.0 - ci-build 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 0.1.0 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 Admin Service

Official URL: http://hl7.org/fhir/us/consent-management/Requirements/technical-specification-admin-service Version: 0.1.0
Standards status: Trial-use Maturity Level: 1 Computable Name: TechnicalSpecificationAdminService

Technical Specification Requirements for Admin Service

Requirements Actor(s)

These requirements apply to the following actors:

  • Admin Service An application or product that implements the Admin Service.

Requirements Statement List

Specification: HL7 FAST Consent IG

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

Conformance: SHOULD

Specification: HL7 FAST Consent IG

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

Conformance: MAY

Notes: - Right now, linking to each transaction. But rather than link many generic requirements to every transaction, should I create generic tests that each transaction uses? • For now, no, but consider iterating into this. Once everything traces, can consider refactoring traces. • An argument for doing this: every time we add a new transaction, we need to add those traces.

Specification: HL7 FAST Consent IG

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

Conformance: SHALL

Specification: HL7 FAST Consent IG

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

Conformance: SHALL

Related Requirement: Requirements-search-parameters-client-admin-service.html#requirement-472

Specification: HL7 FAST Consent IG

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

Conformance: SHALL

Specification: HL7 FAST Consent IG

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

Conformance: SHALL

Related Requirement: Requirements-search-parameters-client-admin-service.html#requirement-474

Specification: HL7 FAST Consent IG

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

Conformance: SHALL

Specification: HL7 FAST Consent IG

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

Conformance: SHALL

Specification: HL7 FAST Consent IG

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

Conformance: SHALL

Specification: HL7 FAST Consent IG

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

Reference: https://build.fhir.org/ig/HL7/fhir-consent-management/technical.html

Conformance: SHALL

Related Requirement: Requirements-extended-operations-client-admin-service.html#requirement-463

Notes: Redundant with CapStmt

Specification: HL7 FAST Consent IG

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

Conformance: SHALL

Related Requirement: Requirements-extended-operations-client-admin-service.html#requirement-465

Notes: Redundant with CapStmt

Specification: HL7 FAST Consent IG

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

Conformance: SHALL

Related Requirement: Requirements-extended-operations-client-admin-service.html#requirement-466

Notes: Redundant with CapStmt

Specification: HL7 FAST Consent IG

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

Conformance: SHALL

Notes: Fix: "a consent administration service SHALL support subscriptions to allow other systems to be informed when consents for a patient have changed." - this should be more precise, like "a consent administration service SHALL support subscriptions as defined by the FAST Subscription Topic, e.g. to allow other systems to be informed when consents for a patient have changed."

Specification: HL7 FAST Consent IG

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

Conformance: SHALL

Specification: HL7 FAST Consent IG

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

Conformance: SHALL

Notes: Need to specify actor(s). For now, assuming CAS SHALL support and Consent Client MAY support

Specification: HL7 FAST Consent IG

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

Conformance: SHALL

Notes: Need to specify actor(s). For now, assuming CAS SHALL support and Consent Client MAY support


These requirements apply to the actor Admin Service

requirement-68SHOULD

Consent Administration Service SHOULD return OperationOutcome with details of which business rules did not allow an operation to be successful if an HTTP status code of 4xx or 5xx is returned

Links:

requirement-69MAY

Consent Administration Service MAY return OperationOutcome for a successful operation<br/><br/>- Right now, linking to each transaction. But rather than link many generic requirements to every transaction, should I create generic tests that each transaction uses? • For now, no, but consider iterating into this. Once everything traces, can consider refactoring traces. • An argument for doing this: every time we add a new transaction, we need to add those traces.

Links:

requirement-63SHALL

Consent Administration Service SHALL support Consent search

Links:

requirement-364SHALL

Consent Administration Service SHALL support Consent search by FASTConsentController

Links:

requirement-365SHALL

Consent Administration Service SHALL support Consent search by date

Links:

requirement-367SHALL

Consent Administration Service SHALL support Consent search by FASTConsentManager

Links:

requirement-71SHALL

Consent Administration Service SHALL support Consent search by patient

Links:

requirement-201SHALL

Consent Administration Service SHALL support Consent search by scope

Links:

requirement-73SHALL

Consent Administration Service SHALL support Consent search by status

Links:

requirement-62SHALL

Consent Administration Service SHALL support File Consent operation<br/><br/>Redundant with CapStmt

Links:

requirement-100SHALL

Consent Administration Service SHALL support Update Consent operation<br/><br/>Redundant with CapStmt

Links:

requirement-101SHALL

Consent Administration Service SHALL support Revoke Consent operation<br/><br/>Redundant with CapStmt

Links:

requirement-64SHALL

Consent Administration Service SHALL support Consent subscriptions (as defined by the FAST Subscription Topic for FHIR R4 with Subscriptions Backport)<br/><br/>Fix: "a consent administration service SHALL support subscriptions to allow other systems to be informed when consents for a patient have changed." - this should be more precise, like "a consent administration service SHALL support subscriptions as defined by the FAST Subscription Topic, e.g. to allow other systems to be informed when consents for a patient have changed."

Links:

requirement-407SHALL

Consent Administration Service SHALL support AuditEvent search

Links:

requirement-266SHALL

Consent Administration Service SHALL support AuditEvent search by FASTAuditEventConsent<br/><br/>Need to specify actor(s). For now, assuming CAS SHALL support and Consent Client MAY support

Links:

requirement-298SHALL

Consent Administration Service SHALL support AuditEvent search by patient<br/><br/>Need to specify actor(s). For now, assuming CAS SHALL support and Consent Client MAY support

Links: