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

CapabilityStatement: Consent Client Capabilities

Official URL: http://hl7.org/fhir/us/consent-management/CapabilityStatement/ConsentClientCapabilities Version: 0.1.0
Standards status: Trial-use Maturity Level: 1 Computable Name: ConsentClient

Capabilities required for a client system filing and review consents.

Raw OpenAPI-Swagger Definition file | Download

Consent Client Capabilities

  • Implementation Guide Version: 0.1.0
  • FHIR Version: 4.0.1
  • Supported Formats: json, xml
  • Supported Patch Formats:
  • Published on: 2025-01-01
  • Published by: HL7 International / Community Based Collaborative Care

Note to Implementers: FHIR Capabilities

Any FHIR capability may be 'allowed' by the system unless explicitly marked as 'SHALL NOT'. A few items are marked as MAY in the Implementation Guide to highlight their potential relevance to the use case.

FHIR RESTful Capabilities

Mode: client

Summary of System-wide Interactions

Capabilities by Resource/Profile

Summary

The summary table lists the resources that are part of this configuration, and for each resource it lists:

  • The relevant profiles (if any)
  • The interactions supported by each resource (Read, Search, Update, and Create, are always shown, while VRead, Patch, Delete, History on Instance, or History on Type are only present if at least one of the resources has support for them.
  • The required, recommended, and some optional search parameters (if any).
  • The linked resources enabled for _include
  • The other resources enabled for _revinclude
  • The operations on the resource (if any)
Resource TypeProfileRSUCDSearches_include_revincludeOperations
AuditEventSupported Profiles
  FASTConsentAuditEvent		yypatient, consent$recordDisclosure
ConsentSupported Profiles
  FASTConsent		yycontroller, date, grantee, manager, organizationId, patient, patientId, scope, status$fileConsent, $updateConsent, $revokeConsent
Subscription yyy

Resource Conformance: supported AuditEvent

Core FHIR Resource
AuditEvent
Reference Policy
Interaction summary
  • Supports search-type, read.

Supported Profiles

FASTConsentAuditEvent

Search Parameters
ConformanceParameterTypeDocumentation
SHALLpatientreference
SHALLconsentreference
 
Extended Operations
ConformanceOperationDocumentation
SHALL$recordDisclosure

Resource Conformance: supported Consent

Core FHIR Resource
Consent
Reference Policy
Interaction summary
  • Supports search-type, read.

Supported Profiles

FASTConsent

Search Parameters
ConformanceParameterTypeDocumentation
SHALLcontrollerreference
SHALLdatedate
SHALLgranteereference
SHALLmanagerreference
SHALLorganizationIdtoken
SHALLpatientreference
SHALLpatientIdtoken
SHALLscopetoken
SHALLstatustoken
 
Extended Operations
ConformanceOperationDocumentation
SHALL$fileConsent
SHALL$updateConsent
SHALL$revokeConsent

Resource Conformance: supported Subscription

Core FHIR Resource
Subscription
Reference Policy
Interaction summary
  • Supports create, update, delete.