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

: Consent Client Capabilities - TTL Representation

Page standards status: Trial-use Maturity Level: 1

Raw ttl | Download


@prefix fhir: <http://hl7.org/fhir/> .
@prefix owl: <http://www.w3.org/2002/07/owl#> .
@prefix rdf: <http://www.w3.org/1999/02/22-rdf-syntax-ns#> .
@prefix rdfs: <http://www.w3.org/2000/01/rdf-schema#> .
@prefix xsd: <http://www.w3.org/2001/XMLSchema#> .

# - resource -------------------------------------------------------------------

 a fhir:CapabilityStatement ;
  fhir:nodeRole fhir:treeRoot ;
  fhir:id [ fhir:v "ConsentClientCapabilities"] ; # 
  fhir:text [
fhir:status [ fhir:v "extensions" ] ;
fhir: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/>  <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/>  <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> </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\"> </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\"> </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>"^^rdf:XMLLiteral
  ] ; # 
  fhir:extension ( [
fhir:url [ fhir:v "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg"^^xsd:anyURI ] ;
fhir:value [
a fhir:code ;
fhir:v "cbcc"     ]
  ] [
fhir:url [ fhir:v "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm"^^xsd:anyURI ] ;
fhir:value [
a fhir:integer ;
fhir:v 1 ;
      ( fhir:extension [
fhir:url [ fhir:v "http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom"^^xsd:anyURI ] ;
fhir:value [
a fhir:canonical ;
fhir:v "http://hl7.org/fhir/us/consent-management/ImplementationGuide/hl7.fhir.us.consent-management"^^xsd:anyURI ;
fhir:link <http://hl7.org/fhir/us/consent-management/ImplementationGuide/hl7.fhir.us.consent-management>         ]       ] )     ]
  ] [
fhir:url [ fhir:v "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status"^^xsd:anyURI ] ;
fhir:value [
a fhir:code ;
fhir:v "trial-use" ;
      ( fhir:extension [
fhir:url [ fhir:v "http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom"^^xsd:anyURI ] ;
fhir:value [
a fhir:canonical ;
fhir:v "http://hl7.org/fhir/us/consent-management/ImplementationGuide/hl7.fhir.us.consent-management"^^xsd:anyURI ;
fhir:link <http://hl7.org/fhir/us/consent-management/ImplementationGuide/hl7.fhir.us.consent-management>         ]       ] )     ]
  ] ) ; # 
  fhir:url [ fhir:v "http://hl7.org/fhir/us/consent-management/CapabilityStatement/ConsentClientCapabilities"^^xsd:anyURI] ; # 
  fhir:version [ fhir:v "0.1.0"] ; # 
  fhir:name [ fhir:v "ConsentClient"] ; # 
  fhir:title [ fhir:v "Consent Client Capabilities"] ; # 
  fhir:status [ fhir:v "active"] ; # 
  fhir:experimental [ fhir:v false] ; # 
  fhir:date [ fhir:v "2025-01-01"^^xsd:date] ; # 
  fhir:publisher [ fhir:v "HL7 International / Community Based Collaborative Care"] ; # 
  fhir:contact ( [
fhir:name [ fhir:v "HL7 International / Community Based Collaborative Care" ] ;
    ( fhir:telecom [
fhir:system [ fhir:v "url" ] ;
fhir:value [ fhir:v "http://www.hl7.org/Special/committees/cbcc" ]     ] )
  ] ) ; # 
  fhir:description [ fhir:v "Capabilities required for a client system filing and review consents."] ; # 
  fhir:jurisdiction ( [
    ( fhir:coding [
fhir:system [ fhir:v "urn:iso:std:iso:3166"^^xsd:anyURI ] ;
fhir:code [ fhir:v "US" ] ;
fhir:display [ fhir:v "United States of America" ]     ] )
  ] ) ; # 
  fhir:kind [ fhir:v "requirements"] ; # 
  fhir:fhirVersion [ fhir:v "4.0.1"] ; # 
  fhir:format ( [ fhir:v "json"] [ fhir:v "xml"] ) ; # 
  fhir:rest ( [
fhir:mode [ fhir:v "client" ] ;
    ( fhir:resource [
fhir:type [ fhir:v "AuditEvent" ] ;
      ( fhir:supportedProfile [
fhir:v "http://hl7.org/fhir/us/consent-management/StructureDefinition/FASTConsentAuditEvent"^^xsd:anyURI ;
fhir:link <http://hl7.org/fhir/us/consent-management/StructureDefinition/FASTConsentAuditEvent>       ] ) ;
      ( fhir:interaction [
fhir:code [ fhir:v "search-type" ]       ] [
fhir:code [ fhir:v "read" ]       ] ) ;
      ( fhir:searchParam [
fhir:name [ fhir:v "patient" ] ;
fhir:type [ fhir:v "reference" ]       ] [
fhir:name [ fhir:v "consent" ] ;
fhir:definition [
fhir:v "http://hl7.org/fhir/us/consent-management/SearchParameter/fast-auditevent-consent"^^xsd:anyURI ;
fhir:link <http://hl7.org/fhir/us/consent-management/SearchParameter/fast-auditevent-consent>         ] ;
fhir:type [ fhir:v "reference" ]       ] ) ;
      ( fhir:operation [
fhir:name [ fhir:v "recordDisclosure" ] ;
fhir:definition [
fhir:v "http://hl7.org/fhir/us/consent-management/OperationDefinition/record-disclosure"^^xsd:anyURI ;
fhir:link <http://hl7.org/fhir/us/consent-management/OperationDefinition/record-disclosure>         ]       ] )     ] [
fhir:type [ fhir:v "Consent" ] ;
      ( fhir:supportedProfile [
fhir:v "http://hl7.org/fhir/us/consent-management/StructureDefinition/FASTConsent"^^xsd:anyURI ;
fhir:link <http://hl7.org/fhir/us/consent-management/StructureDefinition/FASTConsent>       ] ) ;
      ( fhir:interaction [
fhir:code [ fhir:v "search-type" ]       ] [
fhir:code [ fhir:v "read" ]       ] ) ;
      ( fhir:searchParam [
fhir:name [ fhir:v "controller" ] ;
fhir:definition [
fhir:v "http://hl7.org/fhir/us/consent-management/SearchParameter/fast-consent-controller"^^xsd:anyURI ;
fhir:link <http://hl7.org/fhir/us/consent-management/SearchParameter/fast-consent-controller>         ] ;
fhir:type [ fhir:v "reference" ]       ] [
fhir:name [ fhir:v "date" ] ;
fhir:type [ fhir:v "date" ]       ] [
fhir:name [ fhir:v "grantee" ] ;
fhir:definition [
fhir:v "http://hl7.org/fhir/us/consent-management/SearchParameter/fast-consent-grantee"^^xsd:anyURI ;
fhir:link <http://hl7.org/fhir/us/consent-management/SearchParameter/fast-consent-grantee>         ] ;
fhir:type [ fhir:v "reference" ]       ] [
fhir:name [ fhir:v "manager" ] ;
fhir:definition [
fhir:v "http://hl7.org/fhir/us/consent-management/SearchParameter/fast-consent-manager"^^xsd:anyURI ;
fhir:link <http://hl7.org/fhir/us/consent-management/SearchParameter/fast-consent-manager>         ] ;
fhir:type [ fhir:v "reference" ]       ] [
fhir:name [ fhir:v "organizationId" ] ;
fhir:definition [
fhir:v "http://hl7.org/fhir/us/consent-management/SearchParameter/fast-consent-organizationId"^^xsd:anyURI ;
fhir:link <http://hl7.org/fhir/us/consent-management/SearchParameter/fast-consent-organizationId>         ] ;
fhir:type [ fhir:v "token" ]       ] [
fhir:name [ fhir:v "patient" ] ;
fhir:type [ fhir:v "reference" ]       ] [
fhir:name [ fhir:v "patientId" ] ;
fhir:definition [
fhir:v "http://hl7.org/fhir/us/consent-management/SearchParameter/fast-consent-patientId"^^xsd:anyURI ;
fhir:link <http://hl7.org/fhir/us/consent-management/SearchParameter/fast-consent-patientId>         ] ;
fhir:type [ fhir:v "token" ]       ] [
fhir:name [ fhir:v "scope" ] ;
fhir:type [ fhir:v "token" ]       ] [
fhir:name [ fhir:v "status" ] ;
fhir:type [ fhir:v "token" ]       ] ) ;
      ( fhir:operation [
fhir:name [ fhir:v "fileConsent" ] ;
fhir:definition [
fhir:v "http://hl7.org/fhir/us/consent-management/OperationDefinition/file-consent"^^xsd:anyURI ;
fhir:link <http://hl7.org/fhir/us/consent-management/OperationDefinition/file-consent>         ]       ] [
fhir:name [ fhir:v "updateConsent" ] ;
fhir:definition [
fhir:v "http://hl7.org/fhir/us/consent-management/OperationDefinition/update-consent"^^xsd:anyURI ;
fhir:link <http://hl7.org/fhir/us/consent-management/OperationDefinition/update-consent>         ]       ] [
fhir:name [ fhir:v "revokeConsent" ] ;
fhir:definition [
fhir:v "http://hl7.org/fhir/us/consent-management/OperationDefinition/revoke-consent"^^xsd:anyURI ;
fhir:link <http://hl7.org/fhir/us/consent-management/OperationDefinition/revoke-consent>         ]       ] )     ] [
      ( fhir:extension [
fhir:url [ fhir:v "http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/capabilitystatement-subscriptiontopic-canonical"^^xsd:anyURI ] ;
fhir:value [
a fhir:canonical ;
fhir:v "http://hl7.org/fhir/us/consent-management/SubscriptionTopic/FASTConsentSubscriptionTopic"^^xsd:anyURI ;
fhir:link <http://hl7.org/fhir/us/consent-management/SubscriptionTopic/FASTConsentSubscriptionTopic>         ]       ] ) ;
fhir:type [ fhir:v "Subscription" ] ;
      ( fhir:interaction [
fhir:code [ fhir:v "create" ]       ] [
fhir:code [ fhir:v "update" ]       ] [
fhir:code [ fhir:v "delete" ]       ] )     ] )
  ] ) . #