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

Artifacts Summary

Contents:

This page provides a list of the FHIR artifacts defined as part of this implementation guide.

Global profiles

There are no Global profiles defined

Behavior: Capability Statements

The following artifacts define the specific capabilities that different types of systems are expected to have in order to comply with this implementation guide. Systems conforming to this implementation guide are expected to declare conformance to one or more of the following capability statements.

Consent Administrative Server Capabilities

Capabilities required for a server system receiving consents.
Consent Client Capabilities

Capabilities required for a client system filing and review consents.

Behavior: Operation Definitions

These are custom operations that can be supported by and/or invoked by systems conforming to this implementation guide.

File a Consent

This operation is used to file a consent with a consent administration service. The parameters are the Consent resource along with accompanying documentation in the form of a DocumentReference (for PDF or other forms) or QuestionnaireResponse.
RecordDisclosure

This operation is used to record a disclosure based on a given consent for a given patient with a consent administration service. The parameters are a Consent AuditEvent and a reference to the corresponding Consent resource.
Revoke a Consent

This operation is used to revoke a consent with a consent administration service. The parameters are a reference to the Consent resource along with accompanying documentation in the form of a DocumentReference (for PDF or other forms) or QuestionnaireResponse.
Update a Consent

This operation is used to update a consent with a consent administration service. The parameters are a reference to the Consent resource along with accompanying documentation in the form of a DocumentReference (for PDF or other forms) or QuestionnaireResponse.

Behavior: Search Parameters

These define the properties by which a RESTful server can be searched. They can also be used for sorting and including related resources.

fast-auditevent-consent

The Record Disclosure AuditEvent consent reference which is defined by the AuditEvent entity.
fast-consent-controller

The Consent controller reference which is defined by the Consent extension controller.
fast-consent-grantee

The Consent grantee reference which is defined by the Consent extension grantee.
fast-consent-manager

The Consent manager reference which is defined by the Consent extension manager.
fast-consent-organizationId

The Consent organization identifier which is defined either within one or more of the extensions grantee, manager, controller or the provision.actor.role.reference.
fast-consent-patientId

The Consent patient identifier which is defined either within the patient.identifier element or in one or more patient.extension additionalIdentifier.

Structures: Resource Profiles

These define constraints on FHIR resources for systems conforming to this implementation guide.

FASTConsent

This profile captures the details of a Patient's Consent.
FASTConsentAuditEvent

This profile captures the event of disclosing information after consulting a filed Consent.
FASTDocumentReference

This profile records non-structured documentation that records a patient's consent.
FASTSubscription

A profile for FAST subscriptions.
File Consent Operation Parameters

A profile that indicates the parameters for the File Consent operation.
Record Disclosure Operation Parameters

A profile that indicates the parameters for the Record Disclosure operation.
Revoke Consent Operation Parameters

A profile that indicates the parameters for the Revoke Consent operation.
Update Consent Operation Parameters

A profile that indicates the parameters for the Update Consent operation.

Structures: Data Type Profiles

These define constraints on FHIR data types for systems conforming to this implementation guide.

FASTReference

A profile on the Reference datatype that requires the identifier and exposes a set of additional identifiers in an extension.

Terminology: Value Sets

These define sets of codes used by systems conforming to this implementation guide.

LOINC Consent Document Types

These codes are used to convey the type of consent document being referenced.

Example: Example Instances

These are example instances that show what data produced and consumed by systems conforming with this implementation guide might look like.

ConsentExample

An example of a consent.
DocumentReferenceExample

An example of a consent document.
FASTOrganizationSubscriptionExample

An example of a FAST Subscription for a specific organization.
FASTPatientSubscriptionExample

An example of a FAST Subscription for a specific patient.
FASTSubscriptionNotification

An example of a FAST Subscription Notification
FASTSubscriptionNotificationParameters

An example of the parameters going back for a FAST subscription notification
FileConsentDocRefExample

An example of a $fileConsent Parameters resource with an optional DocumentReference.
FileConsentQuestionnaireExample

An example of a $fileConsent Parameters resource with an optional QuestionnaireResponse.
QuestionnaireResponseExample

An example of a consent questionnaire response.

Other

These are resources that are used within this implementation guide that do not fit into one of the other categories.

FAST Consent Subscription Topic

This is the subscription topic used for ensuring Consent records are updated amongst a set of Consent Registries.