Scalable Consent Management
1.0.0-preview - STU 1 PReview 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 1.0.0-preview 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 Server Capabilities

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 rdfs: <http://www.w3.org/2000/01/rdf-schema#> .
@prefix xsd: <http://www.w3.org/2001/XMLSchema#> .

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

<http://hl7.org/fhir/CapabilityStatement/ConsentAdministrativeServerCapabilities> a fhir:CapabilityStatement ;
  fhir:nodeRole fhir:treeRoot ;
  fhir:Resource.id [ fhir:value "ConsentAdministrativeServerCapabilities"] ;
  fhir:Resource.language [ fhir:value "en"] ;
  fhir:DomainResource.text [
     fhir:Narrative.status [ fhir:value "extensions" ] ;
     fhir:Narrative.div "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p class=\"res-header-id\"><b>Generated Narrative: CapabilityStatement ConsentAdministrativeServerCapabilities</b></p><a name=\"ConsentAdministrativeServerCapabilities\"> </a><a name=\"hcConsentAdministrativeServerCapabilities\"> </a><h2 id=\"title\">Consent Server Capabilities</h2><ul><li>Implementation Guide Version: 1.0.0-preview </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>server</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\">y</td><td class=\"text-center\"/><td>patient</td><td/><td/><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, manager, patient, scope, status</td><td/><td/><td><code>$fileConsent</code>, <code>$revokeConsent</code></td></tr><tr><td><a href=\"#Subscription1-3\">Subscription</a></td><td>Supported Profiles<br/>  <a href=\"StructureDefinition-FASTSubscription.html\">FASTSubscription</a></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: unspecified </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>create</code>, <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></tbody></table></div><div class=\"col-lg-5\"> </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: unspecified </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-manager.html\">manager</a></td><td><code>reference</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>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-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: unspecified </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/><div class=\"row\"><div class=\"col-6\"><span class=\"lead\">Supported Profiles</span><p><a href=\"StructureDefinition-FASTSubscription.html\">FASTSubscription</a></p></div></div><p/></div></div></div></div>"
  ] ;
  fhir:DomainResource.extension [
     fhir:index -1 ;
     fhir:Extension.url [ fhir:value "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg" ] ;
     fhir:Extension.valueCode [ fhir:value "cbcc" ]
  ], [
     fhir:index -1 ;
     fhir:Extension.url [ fhir:value "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm" ] ;
     fhir:Extension.valueInteger [
       fhir:value "1"^^xsd:integer ;
       fhir:Element.extension [
         fhir:index -1 ;
         fhir:Extension.url [ fhir:value "http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom" ] ;
         fhir:Extension.valueCanonical [
           fhir:value "http://hl7.org/fhir/us/consent-management/ImplementationGuide/hl7.fhir.us.consent-management" ;
           fhir:link <http://hl7.org/fhir/us/consent-management/ImplementationGuide/hl7.fhir.us.consent-management>
         ]
       ]
     ]
  ], [
     fhir:index -1 ;
     fhir:Extension.url [ fhir:value "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status" ] ;
     fhir:Extension.valueCode [
       fhir:value "trial-use" ;
       fhir:Element.extension [
         fhir:index -1 ;
         fhir:Extension.url [ fhir:value "http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom" ] ;
         fhir:Extension.valueCanonical [
           fhir:value "http://hl7.org/fhir/us/consent-management/ImplementationGuide/hl7.fhir.us.consent-management" ;
           fhir:link <http://hl7.org/fhir/us/consent-management/ImplementationGuide/hl7.fhir.us.consent-management>
         ]
       ]
     ]
  ] ;
  fhir:CapabilityStatement.url [ fhir:value "http://hl7.org/fhir/us/consent-management/CapabilityStatement/ConsentAdministrativeServerCapabilities"] ;
  fhir:CapabilityStatement.version [ fhir:value "1.0.0-preview"] ;
  fhir:CapabilityStatement.name [ fhir:value "ConsentServer"] ;
  fhir:CapabilityStatement.title [ fhir:value "Consent Server Capabilities"] ;
  fhir:CapabilityStatement.status [ fhir:value "active"] ;
  fhir:CapabilityStatement.experimental [ fhir:value "false"^^xsd:boolean] ;
  fhir:CapabilityStatement.date [ fhir:value "2025-01-01"^^xsd:date] ;
  fhir:CapabilityStatement.publisher [ fhir:value "HL7 International / Community Based Collaborative Care"] ;
  fhir:CapabilityStatement.contact [
     fhir:index -1 ;
     fhir:ContactDetail.name [ fhir:value "HL7 International / Community Based Collaborative Care" ] ;
     fhir:ContactDetail.telecom [
       fhir:index -1 ;
       fhir:ContactPoint.system [ fhir:value "url" ] ;
       fhir:ContactPoint.value [ fhir:value "http://www.hl7.org/Special/committees/homehealth" ]
     ]
  ] ;
  fhir:CapabilityStatement.description [ fhir:value "Capabilities required for a server system receiving consents."] ;
  fhir:CapabilityStatement.jurisdiction [
     fhir:index -1 ;
     fhir:CodeableConcept.coding [
       fhir:index -1 ;
       fhir:Coding.system [ fhir:value "urn:iso:std:iso:3166" ] ;
       fhir:Coding.code [ fhir:value "US" ] ;
       fhir:Coding.display [ fhir:value "United States of America" ]
     ]
  ] ;
  fhir:CapabilityStatement.kind [ fhir:value "requirements"] ;
  fhir:CapabilityStatement.fhirVersion [ fhir:value "4.0.1"] ;
  fhir:CapabilityStatement.format [
     fhir:value "json" ;
     fhir:index -1
  ], [
     fhir:value "xml" ;
     fhir:index -1
  ] ;
  fhir:CapabilityStatement.rest [
     fhir:index -1 ;
     fhir:CapabilityStatement.rest.mode [ fhir:value "server" ] ;
     fhir:CapabilityStatement.rest.resource [
       fhir:index -1 ;
       fhir:CapabilityStatement.rest.resource.type [ fhir:value "AuditEvent" ] ;
       fhir:CapabilityStatement.rest.resource.supportedProfile [
         fhir:value "http://hl7.org/fhir/us/consent-management/StructureDefinition/FASTConsentAuditEvent" ;
         fhir:index -1 ;
         fhir:link <http://hl7.org/fhir/us/consent-management/StructureDefinition/FASTConsentAuditEvent>
       ] ;
       fhir:CapabilityStatement.rest.resource.interaction [
         fhir:index -1 ;
         fhir:CapabilityStatement.rest.resource.interaction.code [ fhir:value "create" ]
       ], [
         fhir:index -1 ;
         fhir:CapabilityStatement.rest.resource.interaction.code [ fhir:value "search-type" ]
       ], [
         fhir:index -1 ;
         fhir:CapabilityStatement.rest.resource.interaction.code [ fhir:value "read" ]
       ] ;
       fhir:CapabilityStatement.rest.resource.searchParam [
         fhir:index -1 ;
         fhir:CapabilityStatement.rest.resource.searchParam.name [ fhir:value "patient" ] ;
         fhir:CapabilityStatement.rest.resource.searchParam.type [ fhir:value "reference" ]
       ]
     ], [
       fhir:index -1 ;
       fhir:CapabilityStatement.rest.resource.type [ fhir:value "Consent" ] ;
       fhir:CapabilityStatement.rest.resource.supportedProfile [
         fhir:value "http://hl7.org/fhir/us/consent-management/StructureDefinition/FASTConsent" ;
         fhir:index -1 ;
         fhir:link <http://hl7.org/fhir/us/consent-management/StructureDefinition/FASTConsent>
       ] ;
       fhir:CapabilityStatement.rest.resource.interaction [
         fhir:index -1 ;
         fhir:CapabilityStatement.rest.resource.interaction.code [ fhir:value "search-type" ]
       ], [
         fhir:index -1 ;
         fhir:CapabilityStatement.rest.resource.interaction.code [ fhir:value "read" ]
       ] ;
       fhir:CapabilityStatement.rest.resource.searchParam [
         fhir:index -1 ;
         fhir:CapabilityStatement.rest.resource.searchParam.name [ fhir:value "controller" ] ;
         fhir:CapabilityStatement.rest.resource.searchParam.definition [
           fhir:value "http://hl7.org/fhir/us/consent-management/SearchParameter/fast-consent-controller" ;
           fhir:link <http://hl7.org/fhir/us/consent-management/SearchParameter/fast-consent-controller>
         ] ;
         fhir:CapabilityStatement.rest.resource.searchParam.type [ fhir:value "reference" ]
       ], [
         fhir:index -1 ;
         fhir:CapabilityStatement.rest.resource.searchParam.name [ fhir:value "date" ] ;
         fhir:CapabilityStatement.rest.resource.searchParam.type [ fhir:value "date" ]
       ], [
         fhir:index -1 ;
         fhir:CapabilityStatement.rest.resource.searchParam.name [ fhir:value "manager" ] ;
         fhir:CapabilityStatement.rest.resource.searchParam.definition [
           fhir:value "http://hl7.org/fhir/us/consent-management/SearchParameter/fast-consent-manager" ;
           fhir:link <http://hl7.org/fhir/us/consent-management/SearchParameter/fast-consent-manager>
         ] ;
         fhir:CapabilityStatement.rest.resource.searchParam.type [ fhir:value "reference" ]
       ], [
         fhir:index -1 ;
         fhir:CapabilityStatement.rest.resource.searchParam.name [ fhir:value "patient" ] ;
         fhir:CapabilityStatement.rest.resource.searchParam.type [ fhir:value "reference" ]
       ], [
         fhir:index -1 ;
         fhir:CapabilityStatement.rest.resource.searchParam.name [ fhir:value "scope" ] ;
         fhir:CapabilityStatement.rest.resource.searchParam.type [ fhir:value "token" ]
       ], [
         fhir:index -1 ;
         fhir:CapabilityStatement.rest.resource.searchParam.name [ fhir:value "status" ] ;
         fhir:CapabilityStatement.rest.resource.searchParam.type [ fhir:value "token" ]
       ] ;
       fhir:CapabilityStatement.rest.resource.operation [
         fhir:index -1 ;
         fhir:CapabilityStatement.rest.resource.operation.name [ fhir:value "fileConsent" ] ;
         fhir:CapabilityStatement.rest.resource.operation.definition [
           fhir:value "http://hl7.org/fhir/us/consent-management/OperationDefinition/file-consent" ;
           fhir:link <http://hl7.org/fhir/us/consent-management/OperationDefinition/file-consent>
         ]
       ], [
         fhir:index -1 ;
         fhir:CapabilityStatement.rest.resource.operation.name [ fhir:value "revokeConsent" ] ;
         fhir:CapabilityStatement.rest.resource.operation.definition [
           fhir:value "http://hl7.org/fhir/us/consent-management/OperationDefinition/revoke-consent" ;
           fhir:link <http://hl7.org/fhir/us/consent-management/OperationDefinition/revoke-consent>
         ]
       ]
     ], [
       fhir:index -1 ;
       fhir:Element.extension [
         fhir:index -1 ;
         fhir:Extension.url [ fhir:value "http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/capabilitystatement-subscriptiontopic-canonical" ] ;
         fhir:Extension.valueCanonical [
           fhir:value "http://hl7.org/fhir/us/consent-management/SubscriptionTopic/FASTConsentSubscriptionTopic" ;
           fhir:link <http://hl7.org/fhir/us/consent-management/SubscriptionTopic/FASTConsentSubscriptionTopic>
         ]
       ] ;
       fhir:CapabilityStatement.rest.resource.type [ fhir:value "Subscription" ] ;
       fhir:CapabilityStatement.rest.resource.supportedProfile [
         fhir:value "http://hl7.org/fhir/us/consent-management/StructureDefinition/FASTSubscription" ;
         fhir:index -1 ;
         fhir:link <http://hl7.org/fhir/us/consent-management/StructureDefinition/FASTSubscription>
       ] ;
       fhir:CapabilityStatement.rest.resource.interaction [
         fhir:index -1 ;
         fhir:CapabilityStatement.rest.resource.interaction.code [ fhir:value "create" ]
       ], [
         fhir:index -1 ;
         fhir:CapabilityStatement.rest.resource.interaction.code [ fhir:value "update" ]
       ], [
         fhir:index -1 ;
         fhir:CapabilityStatement.rest.resource.interaction.code [ fhir:value "delete" ]
       ]
     ]
  ] .

# - ontology header ------------------------------------------------------------

<http://hl7.org/fhir/CapabilityStatement/ConsentAdministrativeServerCapabilities.ttl> a owl:Ontology ;
  owl:imports fhir:fhir.ttl ;
  owl:versionIRI <http://build.fhir.org/CapabilityStatement/ConsentAdministrativeServerCapabilities.ttl> .