Scalable Consent Management
0.1.0 - ci-build
Scalable Consent Management
0.1.0 - ci-build
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
| Page standards status: Trial-use | Maturity Level: 1 |
{
"resourceType" : "CapabilityStatement",
"id" : "ConsentClientCapabilities",
"text" : {
"status" : "extensions",
"div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p class=\"res-header-id\"><b>Generated Narrative: CapabilityStatement ConsentClientCapabilities</b></p><a name=\"ConsentClientCapabilities\"> </a><a name=\"hcConsentClientCapabilities\"> </a><h2 id=\"title\">Consent Client Capabilities</h2><ul><li>Implementation Guide Version: 0.1.0 </li><li>FHIR Version: 4.0.1 </li><li>Supported Formats: <code>json</code>, <code>xml</code></li><li>Published on: 2025-01-01 </li><li>Published by: HL7 International / Community Based Collaborative Care </li></ul><blockquote class=\"impl-note\"><p><strong>Note to Implementers: FHIR Capabilities</strong></p><p>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.</p></blockquote><h2 id=\"rest\">FHIR RESTful Capabilities</h2><div class=\"panel panel-default\"><div class=\"panel-heading\"><h3 id=\"mode1\" class=\"panel-title\">Mode: <code>client</code></h3></div><div class=\"panel-body\"/></div><h3 id=\"resourcesCap1\">Capabilities by Resource/Profile</h3><h4 id=\"resourcesSummary1\">Summary</h4><p>The summary table lists the resources that are part of this configuration, and for each resource it lists:</p><ul><li>The relevant profiles (if any)</li><li>The interactions supported by each resource (<b><span class=\"bg-info\">R</span></b>ead, <b><span class=\"bg-info\">S</span></b>earch, <b><span class=\"bg-info\">U</span></b>pdate, and <b><span class=\"bg-info\">C</span></b>reate, are always shown, while <b><span class=\"bg-info\">VR</span></b>ead, <b><span class=\"bg-info\">P</span></b>atch, <b><span class=\"bg-info\">D</span></b>elete, <b><span class=\"bg-info\">H</span></b>istory on <b><span class=\"bg-info\">I</span></b>nstance, or <b><span class=\"bg-info\">H</span></b>istory on <b><span class=\"bg-info\">T</span></b>ype are only present if at least one of the resources has support for them.</li><li><span>The required, recommended, and some optional search parameters (if any). </span></li><li>The linked resources enabled for <code>_include</code></li><li>The other resources enabled for <code>_revinclude</code></li><li>The operations on the resource (if any)</li></ul><div class=\"table-responsive\"><table class=\"table table-condensed table-hover\"><thead><tr><th><b>Resource Type</b></th><th><b>Profile</b></th><th class=\"text-center\"><b title=\"GET a resource (read interaction)\">R</b></th><th class=\"text-center\"><b title=\"GET all set of resources of the type (search interaction)\">S</b></th><th class=\"text-center\"><b title=\"PUT a new resource version (update interaction)\">U</b></th><th class=\"text-center\"><b title=\"POST a new resource (create interaction)\">C</b></th><th class=\"text-center\"><b title=\"DELETE a resource (delete interaction)\">D</b></th><th><b title=\"Required and recommended search parameters\">Searches</b></th><th><code><b>_include</b></code></th><th><code><b>_revinclude</b></code></th><th><b>Operations</b></th></tr></thead><tbody><tr><td><a href=\"#AuditEvent1-1\">AuditEvent</a></td><td>Supported Profiles<br/>\u00a0\u00a0<a href=\"StructureDefinition-FASTConsentAuditEvent.html\">FASTConsentAuditEvent</a></td><td class=\"text-center\">y</td><td class=\"text-center\">y</td><td class=\"text-center\"/><td class=\"text-center\"/><td class=\"text-center\"/><td>patient, consent</td><td/><td/><td><code>$recordDisclosure</code></td></tr><tr><td><a href=\"#Consent1-2\">Consent</a></td><td>Supported Profiles<br/>\u00a0\u00a0<a href=\"StructureDefinition-FASTConsent.html\">FASTConsent</a></td><td class=\"text-center\">y</td><td class=\"text-center\">y</td><td class=\"text-center\"/><td class=\"text-center\"/><td class=\"text-center\"/><td>controller, date, grantee, manager, organizationId, patient, patientId, scope, status</td><td/><td/><td><code>$fileConsent</code>, <code>$updateConsent</code>, <code>$revokeConsent</code></td></tr><tr><td><a href=\"#Subscription1-3\">Subscription</a></td><td>\u00a0</td><td class=\"text-center\"/><td class=\"text-center\"/><td class=\"text-center\">y</td><td class=\"text-center\">y</td><td class=\"text-center\">y</td><td/><td/><td/><td/></tr></tbody></table></div><hr/><div class=\"panel panel-default\"><div class=\"panel-heading\"><h4 id=\"AuditEvent1-1\" class=\"panel-title\"><span style=\"float: right;\">Resource Conformance: supported </span>AuditEvent</h4></div><div class=\"panel-body\"><div class=\"container\"><div class=\"row\"><div class=\"col-lg-4\"><span class=\"lead\">Core FHIR Resource</span><br/><a href=\"http://hl7.org/fhir/R4/auditevent.html\">AuditEvent</a></div><div class=\"col-lg-4\"><span class=\"lead\">Reference Policy</span><br/></div><div class=\"col-lg-4\"><span class=\"lead\">Interaction summary</span><br/><ul><li>Supports <code>search-type</code>, <code>read</code>.</li></ul></div></div><p/><div class=\"row\"><div class=\"col-6\"><span class=\"lead\">Supported Profiles</span><p><a href=\"StructureDefinition-FASTConsentAuditEvent.html\">FASTConsentAuditEvent</a></p></div></div><p/><div class=\"row\"><div class=\"col-lg-7\"><span class=\"lead\">Search Parameters</span><table class=\"table table-condensed table-hover\"><thead><tr><th>Conformance</th><th>Parameter</th><th>Type</th><th>Documentation</th></tr></thead><tbody><tr><td><b>SHALL</b></td><td>patient</td><td><code>reference</code></td><td><div/></td></tr><tr><td><b>SHALL</b></td><td><a href=\"SearchParameter-fast-auditevent-consent.html\">consent</a></td><td><code>reference</code></td><td><div/></td></tr></tbody></table></div><div class=\"col-lg-5\">\u00a0</div></div><div class=\"row\"><div class=\"col-12\"><span class=\"lead\">Extended Operations</span><table class=\"table table-condensed table-hover\"><thead><tr><th>Conformance</th><th>Operation</th><th>Documentation</th></tr></thead><tbody><tr><td><b>SHALL</b></td><td><a href=\"OperationDefinition-record-disclosure.html\">$recordDisclosure</a></td><td><div/></td></tr></tbody></table></div></div></div></div></div><div class=\"panel panel-default\"><div class=\"panel-heading\"><h4 id=\"Consent1-2\" class=\"panel-title\"><span style=\"float: right;\">Resource Conformance: supported </span>Consent</h4></div><div class=\"panel-body\"><div class=\"container\"><div class=\"row\"><div class=\"col-lg-4\"><span class=\"lead\">Core FHIR Resource</span><br/><a href=\"http://hl7.org/fhir/R4/consent.html\">Consent</a></div><div class=\"col-lg-4\"><span class=\"lead\">Reference Policy</span><br/></div><div class=\"col-lg-4\"><span class=\"lead\">Interaction summary</span><br/><ul><li>Supports <code>search-type</code>, <code>read</code>.</li></ul></div></div><p/><div class=\"row\"><div class=\"col-6\"><span class=\"lead\">Supported Profiles</span><p><a href=\"StructureDefinition-FASTConsent.html\">FASTConsent</a></p></div></div><p/><div class=\"row\"><div class=\"col-lg-7\"><span class=\"lead\">Search Parameters</span><table class=\"table table-condensed table-hover\"><thead><tr><th>Conformance</th><th>Parameter</th><th>Type</th><th>Documentation</th></tr></thead><tbody><tr><td><b>SHALL</b></td><td><a href=\"SearchParameter-fast-consent-controller.html\">controller</a></td><td><code>reference</code></td><td><div/></td></tr><tr><td><b>SHALL</b></td><td>date</td><td><code>date</code></td><td><div/></td></tr><tr><td><b>SHALL</b></td><td><a href=\"SearchParameter-fast-consent-grantee.html\">grantee</a></td><td><code>reference</code></td><td><div/></td></tr><tr><td><b>SHALL</b></td><td><a href=\"SearchParameter-fast-consent-manager.html\">manager</a></td><td><code>reference</code></td><td><div/></td></tr><tr><td><b>SHALL</b></td><td><a href=\"SearchParameter-fast-consent-organizationId.html\">organizationId</a></td><td><code>token</code></td><td><div/></td></tr><tr><td><b>SHALL</b></td><td>patient</td><td><code>reference</code></td><td><div/></td></tr><tr><td><b>SHALL</b></td><td><a href=\"SearchParameter-fast-consent-patientId.html\">patientId</a></td><td><code>token</code></td><td><div/></td></tr><tr><td><b>SHALL</b></td><td>scope</td><td><code>token</code></td><td><div/></td></tr><tr><td><b>SHALL</b></td><td>status</td><td><code>token</code></td><td><div/></td></tr></tbody></table></div><div class=\"col-lg-5\">\u00a0</div></div><div class=\"row\"><div class=\"col-12\"><span class=\"lead\">Extended Operations</span><table class=\"table table-condensed table-hover\"><thead><tr><th>Conformance</th><th>Operation</th><th>Documentation</th></tr></thead><tbody><tr><td><b>SHALL</b></td><td><a href=\"OperationDefinition-file-consent.html\">$fileConsent</a></td><td><div/></td></tr><tr><td><b>SHALL</b></td><td><a href=\"OperationDefinition-update-consent.html\">$updateConsent</a></td><td><div/></td></tr><tr><td><b>SHALL</b></td><td><a href=\"OperationDefinition-revoke-consent.html\">$revokeConsent</a></td><td><div/></td></tr></tbody></table></div></div></div></div></div><div class=\"panel panel-default\"><div class=\"panel-heading\"><h4 id=\"Subscription1-3\" class=\"panel-title\"><span style=\"float: right;\">Resource Conformance: supported </span>Subscription</h4></div><div class=\"panel-body\"><div class=\"container\"><div class=\"row\"><div class=\"col-lg-4\"><span class=\"lead\">Core FHIR Resource</span><br/><a href=\"http://hl7.org/fhir/R4/subscription.html\">Subscription</a></div><div class=\"col-lg-4\"><span class=\"lead\">Reference Policy</span><br/></div><div class=\"col-lg-4\"><span class=\"lead\">Interaction summary</span><br/><ul><li>Supports <code>create</code>, <code>update</code>, <code>delete</code>.</li></ul></div></div><p/><p/></div></div></div></div>"
},
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
"valueCode" : "cbcc"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
"valueInteger" : 1,
"_valueInteger" : {
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom",
"valueCanonical" : "http://hl7.org/fhir/us/consent-management/ImplementationGuide/hl7.fhir.us.consent-management"
}
]
}
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode" : "trial-use",
"_valueCode" : {
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom",
"valueCanonical" : "http://hl7.org/fhir/us/consent-management/ImplementationGuide/hl7.fhir.us.consent-management"
}
]
}
}
],
"url" : "http://hl7.org/fhir/us/consent-management/CapabilityStatement/ConsentClientCapabilities",
"version" : "0.1.0",
"name" : "ConsentClient",
"title" : "Consent Client Capabilities",
"status" : "active",
"experimental" : false,
"date" : "2025-01-01",
"publisher" : "HL7 International / Community Based Collaborative Care",
"contact" : [
{
"name" : "HL7 International / Community Based Collaborative Care",
"telecom" : [
{
"system" : "url",
"value" : "http://www.hl7.org/Special/committees/cbcc"
}
]
}
],
"description" : "Capabilities required for a client system filing and review consents.",
"jurisdiction" : [
{
"coding" : [
{
"system" : "urn:iso:std:iso:3166",
"code" : "US",
"display" : "United States of America"
}
]
}
],
"kind" : "requirements",
"fhirVersion" : "4.0.1",
"format" : [
"json",
"xml"
],
"rest" : [
{
"mode" : "client",
"resource" : [
{
"type" : "AuditEvent",
"supportedProfile" : [
🔗 "http://hl7.org/fhir/us/consent-management/StructureDefinition/FASTConsentAuditEvent"
],
"interaction" : [
{
"code" : "search-type"
},
{
"code" : "read"
}
],
"searchParam" : [
{
"name" : "patient",
"type" : "reference"
},
{
"name" : "consent",
"definition" : "http://hl7.org/fhir/us/consent-management/SearchParameter/fast-auditevent-consent",
"type" : "reference"
}
],
"operation" : [
{
"name" : "recordDisclosure",
"definition" : "http://hl7.org/fhir/us/consent-management/OperationDefinition/record-disclosure"
}
]
},
{
"type" : "Consent",
"supportedProfile" : [
🔗 "http://hl7.org/fhir/us/consent-management/StructureDefinition/FASTConsent"
],
"interaction" : [
{
"code" : "search-type"
},
{
"code" : "read"
}
],
"searchParam" : [
{
"name" : "controller",
"definition" : "http://hl7.org/fhir/us/consent-management/SearchParameter/fast-consent-controller",
"type" : "reference"
},
{
"name" : "date",
"type" : "date"
},
{
"name" : "grantee",
"definition" : "http://hl7.org/fhir/us/consent-management/SearchParameter/fast-consent-grantee",
"type" : "reference"
},
{
"name" : "manager",
"definition" : "http://hl7.org/fhir/us/consent-management/SearchParameter/fast-consent-manager",
"type" : "reference"
},
{
"name" : "organizationId",
"definition" : "http://hl7.org/fhir/us/consent-management/SearchParameter/fast-consent-organizationId",
"type" : "token"
},
{
"name" : "patient",
"type" : "reference"
},
{
"name" : "patientId",
"definition" : "http://hl7.org/fhir/us/consent-management/SearchParameter/fast-consent-patientId",
"type" : "token"
},
{
"name" : "scope",
"type" : "token"
},
{
"name" : "status",
"type" : "token"
}
],
"operation" : [
{
"name" : "fileConsent",
"definition" : "http://hl7.org/fhir/us/consent-management/OperationDefinition/file-consent"
},
{
"name" : "updateConsent",
"definition" : "http://hl7.org/fhir/us/consent-management/OperationDefinition/update-consent"
},
{
"name" : "revokeConsent",
"definition" : "http://hl7.org/fhir/us/consent-management/OperationDefinition/revoke-consent"
}
]
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/capabilitystatement-subscriptiontopic-canonical",
"valueCanonical" : "http://hl7.org/fhir/us/consent-management/SubscriptionTopic/FASTConsentSubscriptionTopic"
}
],
"type" : "Subscription",
"interaction" : [
{
"code" : "create"
},
{
"code" : "update"
},
{
"code" : "delete"
}
]
}
]
}
]
}
IG © 2024+ HL7 International / Community Based Collaborative Care. Package hl7.fhir.us.consent-management#0.1.0 based on FHIR 4.0.1. Generated 2025-09-05
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change