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

: Implementation Notes Client Consent Server

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/Requirements/implementation-notes-client-consent-server> a fhir:Requirements ;
  fhir:nodeRole fhir:treeRoot ;
  fhir:Resource.id [ fhir:value "implementation-notes-client-consent-server"] ;
  fhir:DomainResource.text [
     fhir:Narrative.status [ fhir:value "generated" ] ;
     fhir:Narrative.div "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p class=\"res-header-id\"><b>Generated Narrative: Requirements implementation-notes-client-consent-server</b></p><a name=\"implementation-notes-client-consent-server\"> </a><a name=\"hcimplementation-notes-client-consent-server\"> </a><p>These requirements apply to the following actors: </p><ul><li><a href=\"ActorDefinition-client.html\">Client</a></li><li><a href=\"ActorDefinition-consent-server.html\">Consent Server</a></li></ul><table class=\"grid\"><tr><td><b><a name=\"1185\"> </a></b>requirement-1185</td><td><a href=\"http://hl7.org/fhir/uv/xver-r5.r4/0.1.0/CodeSystem-conformance-expectation.html#conformance-expectation-SHOULD\">SHOULD</a></td><td><div><p>A consent administration service receiving a POST Subscription request SHOULD verify that the subscribing system is authorized to access the consents it is requesting to be notified about&lt;br/&gt;&lt;br/&gt;Can test by combining Consent and Security tests.</p>\n</div><p>Links: </p><ul><li>Derived From: <code>HL7 FAST Consent IG</code></li><li>References: <a href=\"https://build.fhir.org/ig/HL7/fhir-consent-management/en/implementation_notes.html#:~:text=a%20consent%20administration%20service%20receiving%20a%20post%20subscription%20request%20should%20verify%20that%20the%20subscribing%20system%20is%20authorized%20to%20access%20the%20consents%20it%20is%20requesting%20to%20be%20notified%20about\">https://build.fhir.org/ig/HL7/fhir-consent-management/en/implementation_notes.html</a></li></ul></td></tr><tr><td><b><a name=\"1186\"> </a></b>requirement-1186</td><td><a href=\"http://hl7.org/fhir/uv/xver-r5.r4/0.1.0/CodeSystem-conformance-expectation.html#conformance-expectation-SHALL\">SHALL</a></td><td><div><p>Access should be limited to consents where the requesting system is a named participant: for example, consents where the system's organization is identified as a controller, manager, or actor within a consent's provision</p>\n</div><p>Links: </p><ul><li>Derived From: <code>HL7 FAST Consent IG</code></li><li>References: <a href=\"https://build.fhir.org/ig/HL7/fhir-consent-management/en/implementation_notes.html#:~:text=access%20should%20be%20limited%20to%20consents%20where%20the%20requesting%20system%20is%20a%20named%20participant%3A%20for%20example%2C%20consents%20where%20the%20system%27s%20organization%20is%20identified%20as%20a%20controller%2C%20manager%2C%20or%20actor%20within%20a%20consent%27s%20provision\">https://build.fhir.org/ig/HL7/fhir-consent-management/en/implementation_notes.html</a></li></ul></td></tr><tr><td><b><a name=\"1187\"> </a></b>requirement-1187</td><td><a href=\"http://hl7.org/fhir/uv/xver-r5.r4/0.1.0/CodeSystem-conformance-expectation.html#conformance-expectation-SHALL\">SHALL</a></td><td><div><p>Implementers of consent administration services should apply appropriate access control filters when processing search queries</p>\n</div><p>Links: </p><ul><li>Derived From: <code>HL7 FAST Consent IG</code></li><li>References: <a href=\"https://build.fhir.org/ig/HL7/fhir-consent-management/en/implementation_notes.html#:~:text=implementers%20of%20consent%20administration%20services%20should%20apply%20appropriate%20access%20control%20filters%20when%20processing%20search%20queries\">https://build.fhir.org/ig/HL7/fhir-consent-management/en/implementation_notes.html</a></li></ul></td></tr><tr><td><b><a name=\"1184\"> </a></b>requirement-1184</td><td><a href=\"http://hl7.org/fhir/uv/xver-r5.r4/0.1.0/CodeSystem-conformance-expectation.html#conformance-expectation-SHOULD\">SHOULD</a></td><td><div><p>A system that cannot maintain a subscription to the consent management source SHOULD fetch a fresh copy of the consent at the time of each authorization decision rather than rely on a cached copy</p>\n</div><p>Links: </p><ul><li>Derived From: <code>HL7 FAST Consent IG</code></li><li>References: <a href=\"https://build.fhir.org/ig/HL7/fhir-consent-management/en/implementation_notes.html#:~:text=a%20system%20that%20cannot%20maintain%20a%20subscription%20to%20the%20consent%20management%20source%20should%20fetch%20a%20fresh%20copy%20of%20the%20consent%20at%20the%20time%20of%20each%20authorization%20decision%20rather%20than%20rely%20on%20a%20cached%20copy\">https://build.fhir.org/ig/HL7/fhir-consent-management/en/implementation_notes.html</a></li></ul></td></tr><tr><td><b><a name=\"1183\"> </a></b>requirement-1183</td><td><a href=\"http://hl7.org/fhir/uv/xver-r5.r4/0.1.0/CodeSystem-conformance-expectation.html#conformance-expectation-SHALL\">SHALL</a></td><td><div><p>When a copy of consent travels to a different system, before making decisions based on the consent, the enforcing system needs to ensure it is up to date&lt;br/&gt;&lt;br/&gt;No conformance verb, but this is the key guidance that can drive both black box tests (e.g. A shares with B, B uses access, A revokes, B rejected) as well as tests for specific mechanisms and fallbacks, conditional on systems' support for each technique.</p>\n</div><p>Links: </p><ul><li>Derived From: <code>HL7 FAST Consent IG</code></li><li>References: <a href=\"https://build.fhir.org/ig/HL7/fhir-consent-management/en/implementation_notes.html#:~:text=when%20a%20copy%20of%20consent%20travels%20to%20a%20different%20system%2C%20before%20making%20decisions%20based%20on%20the%20consent%2C%20the%20enforcing%20system%20needs%20to%20ensure%20it%20is%20up%20to%20date\">https://build.fhir.org/ig/HL7/fhir-consent-management/en/implementation_notes.html</a></li></ul></td></tr><tr><td><b><a name=\"1181\"> </a></b>requirement-1181</td><td><a href=\"http://hl7.org/fhir/uv/xver-r5.r4/0.1.0/CodeSystem-conformance-expectation.html#conformance-expectation-SHALL\">SHALL</a></td><td><div><p>When the Consent record is created on System A, System A's system identifier SHALL be recorded in the manager extension of the Consent instance</p>\n</div><p>Links: </p><ul><li>Derived From: <code>HL7 FAST Consent IG</code></li><li>References: <a href=\"https://build.fhir.org/ig/HL7/fhir-consent-management/en/implementation_notes.html#:~:text=when%20the%20consent%20record%20is%20created%20on%20system%20a%2C%20system%20a%27s%20system%20identifier%20shall%20be%20recorded%20in%20the%20manager%20extension%20of%20the%20consent%20instance\">https://build.fhir.org/ig/HL7/fhir-consent-management/en/implementation_notes.html</a></li></ul></td></tr><tr><td><b><a name=\"1182\"> </a></b>requirement-1182</td><td><a href=\"http://hl7.org/fhir/uv/xver-r5.r4/0.1.0/CodeSystem-conformance-expectation.html#conformance-expectation-SHALL\">SHALL</a></td><td><div><p>Systems that ingest a Consent from another system SHALL preserve the manager extension value unchanged</p>\n</div><p>Links: </p><ul><li>Derived From: <code>HL7 FAST Consent IG</code></li><li>References: <a href=\"https://build.fhir.org/ig/HL7/fhir-consent-management/en/implementation_notes.html#:~:text=systems%20that%20ingest%20a%20consent%20from%20another%20system%20shall%20preserve%20the%20manager%20extension%20value%20unchanged\">https://build.fhir.org/ig/HL7/fhir-consent-management/en/implementation_notes.html</a></li></ul></td></tr></table></div>"
  ] ;
  fhir:DomainResource.extension [
     fhir:index 0 ;
     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 0 ;
         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 2 ;
     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 0 ;
         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:Requirements.url [ fhir:value "http://hl7.org/fhir/us/consent-management/Requirements/implementation-notes-client-consent-server"] ;
  fhir:Requirements.version [ fhir:value "1.0.0-preview"] ;
  fhir:Requirements.name [ fhir:value "ImplementationNotesClientConsentServer"] ;
  fhir:Requirements.title [ fhir:value "Implementation Notes Client Consent Server"] ;
  fhir:Requirements.status [ fhir:value "active"] ;
  fhir:Requirements.experimental [ fhir:value "false"^^xsd:boolean] ;
  fhir:Requirements.date [ fhir:value "2026-09-02T22:40:54-04:00"^^xsd:dateTime] ;
  fhir:Requirements.publisher [ fhir:value "HL7 International / Community Based Collaborative Care"] ;
  fhir:Requirements.contact [
     fhir:index 0 ;
     fhir:ContactDetail.name [ fhir:value "HL7 International / Community Based Collaborative Care" ] ;
     fhir:ContactDetail.telecom [
       fhir:index 0 ;
       fhir:ContactPoint.system [ fhir:value "url" ] ;
       fhir:ContactPoint.value [ fhir:value "http://www.hl7.org/Special/committees/homehealth" ]
     ]
  ] ;
  fhir:Requirements.description [ fhir:value "Implementation Notes Requirements for Client Consent Server"] ;
  fhir:Requirements.jurisdiction [
     fhir:index 0 ;
     fhir:CodeableConcept.coding [
       fhir:index 0 ;
       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:Requirements.actor [
     fhir:value "http://hl7.org/fhir/us/consent-management/ActorDefinition/client" ;
     fhir:index 0 ;
     fhir:link <http://hl7.org/fhir/us/consent-management/ActorDefinition/client>
  ], [
     fhir:value "http://hl7.org/fhir/us/consent-management/ActorDefinition/consent-server" ;
     fhir:index 1 ;
     fhir:link <http://hl7.org/fhir/us/consent-management/ActorDefinition/consent-server>
  ] ;
  fhir:Requirements.statement [
     fhir:index 0 ;
     fhir:Requirements.statement.key [ fhir:value "1185" ] ;
     fhir:Requirements.statement.label [ fhir:value "requirement-1185" ] ;
     fhir:Requirements.statement.conformance [
       fhir:value "SHOULD" ;
       fhir:index 0
     ] ;
     fhir:Requirements.statement.conditionality [ fhir:value "false"^^xsd:boolean ] ;
     fhir:Requirements.statement.requirement [ fhir:value "A consent administration service receiving a POST Subscription request SHOULD verify that the subscribing system is authorized to access the consents it is requesting to be notified about<br/><br/>Can test by combining Consent and Security tests." ] ;
     fhir:Requirements.statement.derivedFrom [ fhir:value "HL7 FAST Consent IG" ] ;
     fhir:Requirements.statement.reference [
       fhir:value "https://build.fhir.org/ig/HL7/fhir-consent-management/en/implementation_notes.html#:~:text=a%20consent%20administration%20service%20receiving%20a%20post%20subscription%20request%20should%20verify%20that%20the%20subscribing%20system%20is%20authorized%20to%20access%20the%20consents%20it%20is%20requesting%20to%20be%20notified%20about" ;
       fhir:index 0
     ]
  ], [
     fhir:index 1 ;
     fhir:Requirements.statement.key [ fhir:value "1186" ] ;
     fhir:Requirements.statement.label [ fhir:value "requirement-1186" ] ;
     fhir:Requirements.statement.conformance [
       fhir:value "SHALL" ;
       fhir:index 0
     ] ;
     fhir:Requirements.statement.conditionality [ fhir:value "false"^^xsd:boolean ] ;
     fhir:Requirements.statement.requirement [ fhir:value "Access should be limited to consents where the requesting system is a named participant: for example, consents where the system's organization is identified as a controller, manager, or actor within a consent's provision" ] ;
     fhir:Requirements.statement.derivedFrom [ fhir:value "HL7 FAST Consent IG" ] ;
     fhir:Requirements.statement.reference [
       fhir:value "https://build.fhir.org/ig/HL7/fhir-consent-management/en/implementation_notes.html#:~:text=access%20should%20be%20limited%20to%20consents%20where%20the%20requesting%20system%20is%20a%20named%20participant%3A%20for%20example%2C%20consents%20where%20the%20system%27s%20organization%20is%20identified%20as%20a%20controller%2C%20manager%2C%20or%20actor%20within%20a%20consent%27s%20provision" ;
       fhir:index 0
     ]
  ], [
     fhir:index 2 ;
     fhir:Requirements.statement.key [ fhir:value "1187" ] ;
     fhir:Requirements.statement.label [ fhir:value "requirement-1187" ] ;
     fhir:Requirements.statement.conformance [
       fhir:value "SHALL" ;
       fhir:index 0
     ] ;
     fhir:Requirements.statement.conditionality [ fhir:value "false"^^xsd:boolean ] ;
     fhir:Requirements.statement.requirement [ fhir:value "Implementers of consent administration services should apply appropriate access control filters when processing search queries" ] ;
     fhir:Requirements.statement.derivedFrom [ fhir:value "HL7 FAST Consent IG" ] ;
     fhir:Requirements.statement.reference [
       fhir:value "https://build.fhir.org/ig/HL7/fhir-consent-management/en/implementation_notes.html#:~:text=implementers%20of%20consent%20administration%20services%20should%20apply%20appropriate%20access%20control%20filters%20when%20processing%20search%20queries" ;
       fhir:index 0
     ]
  ], [
     fhir:index 3 ;
     fhir:Requirements.statement.key [ fhir:value "1184" ] ;
     fhir:Requirements.statement.label [ fhir:value "requirement-1184" ] ;
     fhir:Requirements.statement.conformance [
       fhir:value "SHOULD" ;
       fhir:index 0
     ] ;
     fhir:Requirements.statement.conditionality [ fhir:value "false"^^xsd:boolean ] ;
     fhir:Requirements.statement.requirement [ fhir:value "A system that cannot maintain a subscription to the consent management source SHOULD fetch a fresh copy of the consent at the time of each authorization decision rather than rely on a cached copy" ] ;
     fhir:Requirements.statement.derivedFrom [ fhir:value "HL7 FAST Consent IG" ] ;
     fhir:Requirements.statement.reference [
       fhir:value "https://build.fhir.org/ig/HL7/fhir-consent-management/en/implementation_notes.html#:~:text=a%20system%20that%20cannot%20maintain%20a%20subscription%20to%20the%20consent%20management%20source%20should%20fetch%20a%20fresh%20copy%20of%20the%20consent%20at%20the%20time%20of%20each%20authorization%20decision%20rather%20than%20rely%20on%20a%20cached%20copy" ;
       fhir:index 0
     ]
  ], [
     fhir:index 4 ;
     fhir:Requirements.statement.key [ fhir:value "1183" ] ;
     fhir:Requirements.statement.label [ fhir:value "requirement-1183" ] ;
     fhir:Requirements.statement.conformance [
       fhir:value "SHALL" ;
       fhir:index 0
     ] ;
     fhir:Requirements.statement.conditionality [ fhir:value "false"^^xsd:boolean ] ;
     fhir:Requirements.statement.requirement [ fhir:value "When a copy of consent travels to a different system, before making decisions based on the consent, the enforcing system needs to ensure it is up to date<br/><br/>No conformance verb, but this is the key guidance that can drive both black box tests (e.g. A shares with B, B uses access, A revokes, B rejected) as well as tests for specific mechanisms and fallbacks, conditional on systems' support for each technique." ] ;
     fhir:Requirements.statement.derivedFrom [ fhir:value "HL7 FAST Consent IG" ] ;
     fhir:Requirements.statement.reference [
       fhir:value "https://build.fhir.org/ig/HL7/fhir-consent-management/en/implementation_notes.html#:~:text=when%20a%20copy%20of%20consent%20travels%20to%20a%20different%20system%2C%20before%20making%20decisions%20based%20on%20the%20consent%2C%20the%20enforcing%20system%20needs%20to%20ensure%20it%20is%20up%20to%20date" ;
       fhir:index 0
     ]
  ], [
     fhir:index 5 ;
     fhir:Requirements.statement.key [ fhir:value "1181" ] ;
     fhir:Requirements.statement.label [ fhir:value "requirement-1181" ] ;
     fhir:Requirements.statement.conformance [
       fhir:value "SHALL" ;
       fhir:index 0
     ] ;
     fhir:Requirements.statement.conditionality [ fhir:value "false"^^xsd:boolean ] ;
     fhir:Requirements.statement.requirement [ fhir:value "When the Consent record is created on System A, System A's system identifier SHALL be recorded in the manager extension of the Consent instance" ] ;
     fhir:Requirements.statement.derivedFrom [ fhir:value "HL7 FAST Consent IG" ] ;
     fhir:Requirements.statement.reference [
       fhir:value "https://build.fhir.org/ig/HL7/fhir-consent-management/en/implementation_notes.html#:~:text=when%20the%20consent%20record%20is%20created%20on%20system%20a%2C%20system%20a%27s%20system%20identifier%20shall%20be%20recorded%20in%20the%20manager%20extension%20of%20the%20consent%20instance" ;
       fhir:index 0
     ]
  ], [
     fhir:index 6 ;
     fhir:Requirements.statement.key [ fhir:value "1182" ] ;
     fhir:Requirements.statement.label [ fhir:value "requirement-1182" ] ;
     fhir:Requirements.statement.conformance [
       fhir:value "SHALL" ;
       fhir:index 0
     ] ;
     fhir:Requirements.statement.conditionality [ fhir:value "false"^^xsd:boolean ] ;
     fhir:Requirements.statement.requirement [ fhir:value "Systems that ingest a Consent from another system SHALL preserve the manager extension value unchanged" ] ;
     fhir:Requirements.statement.derivedFrom [ fhir:value "HL7 FAST Consent IG" ] ;
     fhir:Requirements.statement.reference [
       fhir:value "https://build.fhir.org/ig/HL7/fhir-consent-management/en/implementation_notes.html#:~:text=systems%20that%20ingest%20a%20consent%20from%20another%20system%20shall%20preserve%20the%20manager%20extension%20value%20unchanged" ;
       fhir:index 0
     ]
  ] .

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

<http://hl7.org/fhir/Requirements/implementation-notes-client-consent-server.ttl> a owl:Ontology ;
  owl:imports fhir:fhir.ttl ;
  owl:versionIRI <http://build.fhir.org/Requirements/implementation-notes-client-consent-server.ttl> .