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 |
<Requirements xmlns="http://hl7.org/fhir">
<id value="technical-specification-admin-service"/>
<text>
<status value="generated"/>
<div xmlns="http://www.w3.org/1999/xhtml"><p class="res-header-id"><b>Generated Narrative: Requirements technical-specification-admin-service</b></p><a name="technical-specification-admin-service"> </a><a name="hctechnical-specification-admin-service"> </a><p>These requirements apply to the actor <a href="ActorDefinition-admin-service.html">Admin Service</a></p><table class="grid"><tr><td><b><a name="68"> </a></b>requirement-68</td><td>SHOULD</td><td><div><p>Consent Administration Service SHOULD return OperationOutcome with details of which business rules did not allow an operation to be successful if an HTTP status code of 4xx or 5xx is returned</p>
</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/technical.html#:~:text=Systems%20SHOULD%20return%20an%20OperationOutcome%20with%20the%20details%20if%20an%20HTTP%20status%20code%20of%204xx%20or%205xx%20is%20returned">https://build.fhir.org/ig/HL7/fhir-consent-management/technical.html</a></li></ul></td></tr><tr><td><b><a name="69"> </a></b>requirement-69</td><td>MAY</td><td><div><p>Consent Administration Service MAY return OperationOutcome for a successful operation<br/><br/>- Right now, linking to each transaction. But rather than link many generic requirements to every transaction, should I create generic tests that each transaction uses?
• For now, no, but consider iterating into this. Once everything traces, can consider refactoring traces.
• An argument for doing this: every time we add a new transaction, we need to add those traces.</p>
</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/technical.html#:~:text=systems%20MAY%20return%20an%20OperationOutcome%20with%20a%20success%20to%20be%20consistent">https://build.fhir.org/ig/HL7/fhir-consent-management/technical.html</a></li></ul></td></tr><tr><td><b><a name="63"> </a></b>requirement-63</td><td>SHALL</td><td><div><p>Consent Administration Service SHALL support Consent search</p>
</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/technical.html#:~:text=consent%20administration%20service%20systems%20SHALL%20support%20searching%20for%20consents">https://build.fhir.org/ig/HL7/fhir-consent-management/technical.html</a></li></ul></td></tr><tr><td><b><a name="364"> </a></b>requirement-364</td><td>SHALL</td><td><div><p>Consent Administration Service SHALL support Consent search by FASTConsentController</p>
</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/technical.html#:~:text=To%20support%20searching,controller">https://build.fhir.org/ig/HL7/fhir-consent-management/technical.html</a></li></ul></td></tr><tr><td><b><a name="365"> </a></b>requirement-365</td><td>SHALL</td><td><div><p>Consent Administration Service SHALL support Consent search by date</p>
</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/technical.html#:~:text=To%20support%20searching,date">https://build.fhir.org/ig/HL7/fhir-consent-management/technical.html</a></li></ul></td></tr><tr><td><b><a name="367"> </a></b>requirement-367</td><td>SHALL</td><td><div><p>Consent Administration Service SHALL support Consent search by FASTConsentManager</p>
</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/technical.html#:~:text=To%20support%20searching,manager">https://build.fhir.org/ig/HL7/fhir-consent-management/technical.html</a></li></ul></td></tr><tr><td><b><a name="71"> </a></b>requirement-71</td><td>SHALL</td><td><div><p>Consent Administration Service SHALL support Consent search by patient</p>
</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/technical.html#:~:text=To%20support%20searching,patient">https://build.fhir.org/ig/HL7/fhir-consent-management/technical.html</a></li></ul></td></tr><tr><td><b><a name="201"> </a></b>requirement-201</td><td>SHALL</td><td><div><p>Consent Administration Service SHALL support Consent search by scope</p>
</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/technical.html#:~:text=To%20support%20searching,scope">https://build.fhir.org/ig/HL7/fhir-consent-management/technical.html</a></li></ul></td></tr><tr><td><b><a name="73"> </a></b>requirement-73</td><td>SHALL</td><td><div><p>Consent Administration Service SHALL support Consent search by status</p>
</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/technical.html#:~:text=To%20support%20searching,status">https://build.fhir.org/ig/HL7/fhir-consent-management/technical.html</a></li></ul></td></tr><tr><td><b><a name="62"> </a></b>requirement-62</td><td>SHALL</td><td><div><p>Consent Administration Service SHALL support File Consent operation<br/><br/>Redundant with CapStmt</p>
</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/technical.html#:~:text=a%20consent%20administration%20service%20SHALL%20support%3A,File%20Consent">https://build.fhir.org/ig/HL7/fhir-consent-management/technical.html</a>, <a href="https://build.fhir.org/ig/HL7/fhir-consent-management/technical.html#consent-management">https://build.fhir.org/ig/HL7/fhir-consent-management/technical.html</a></li></ul></td></tr><tr><td><b><a name="100"> </a></b>requirement-100</td><td>SHALL</td><td><div><p>Consent Administration Service SHALL support Update Consent operation<br/><br/>Redundant with CapStmt</p>
</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/technical.html#:~:text=a%20consent%20administration%20service%20SHALL%20support%3A,Update%20Consent">https://build.fhir.org/ig/HL7/fhir-consent-management/technical.html</a></li></ul></td></tr><tr><td><b><a name="101"> </a></b>requirement-101</td><td>SHALL</td><td><div><p>Consent Administration Service SHALL support Revoke Consent operation<br/><br/>Redundant with CapStmt</p>
</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/technical.html#:~:text=a%20consent%20administration%20service%20SHALL%20support%3A,Revoke%20Consent">https://build.fhir.org/ig/HL7/fhir-consent-management/technical.html</a></li></ul></td></tr><tr><td><b><a name="64"> </a></b>requirement-64</td><td>SHALL</td><td><div><p>Consent Administration Service SHALL support Consent subscriptions (as defined by the FAST Subscription Topic for FHIR R4 with Subscriptions Backport)<br/><br/>Fix: "a consent administration service SHALL support subscriptions to allow other systems to be informed when consents for a patient have changed." - this should be more precise, like "a consent administration service SHALL support subscriptions as defined by the FAST Subscription Topic, e.g. to allow other systems to be informed when consents for a patient have changed."</p>
</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/technical.html#:~:text=consent%20administration%20service%20SHALL%20support%20subscriptions%20to%20allow%20other%20systems%20to%20be%20informed%20when%20consents%20for%20a%20patient%20have%20changed">https://build.fhir.org/ig/HL7/fhir-consent-management/technical.html</a></li></ul></td></tr><tr><td><b><a name="407"> </a></b>requirement-407</td><td>SHALL</td><td><div><p>Consent Administration Service SHALL support AuditEvent search</p>
</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/technical.html#:~:text=systems%20SHALL%20support%20the%20searching%20for%20FAST%20Audit%20Events">https://build.fhir.org/ig/HL7/fhir-consent-management/technical.html</a></li></ul></td></tr><tr><td><b><a name="266"> </a></b>requirement-266</td><td>SHALL</td><td><div><p>Consent Administration Service SHALL support AuditEvent search by FASTAuditEventConsent<br/><br/>Need to specify actor(s). For now, assuming CAS SHALL support and Consent Client MAY support</p>
</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/technical.html#:~:text=systems%20SHALL%20support%20the,consent">https://build.fhir.org/ig/HL7/fhir-consent-management/technical.html</a></li></ul></td></tr><tr><td><b><a name="298"> </a></b>requirement-298</td><td>SHALL</td><td><div><p>Consent Administration Service SHALL support AuditEvent search by patient<br/><br/>Need to specify actor(s). For now, assuming CAS SHALL support and Consent Client MAY support</p>
</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/technical.html#:~:text=systems%20SHALL%20support%20the,patient">https://build.fhir.org/ig/HL7/fhir-consent-management/technical.html</a></li></ul></td></tr></table></div>
</text>
<extension
url="http://hl7.org/fhir/StructureDefinition/structuredefinition-wg">
<valueCode value="cbcc"/>
</extension>
<extension
url="http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm">
<valueInteger value="1">
<extension
url="http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom">
<valueCanonical
value="http://hl7.org/fhir/us/consent-management/ImplementationGuide/hl7.fhir.us.consent-management"/>
</extension>
</valueInteger>
</extension>
<extension
url="http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status">
<valueCode value="trial-use">
<extension
url="http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom">
<valueCanonical
value="http://hl7.org/fhir/us/consent-management/ImplementationGuide/hl7.fhir.us.consent-management"/>
</extension>
</valueCode>
</extension>
<url
value="http://hl7.org/fhir/us/consent-management/Requirements/technical-specification-admin-service"/>
<version value="0.1.0"/>
<name value="TechnicalSpecificationAdminService"/>
<title value="Technical Specification Admin Service"/>
<status value="active"/>
<experimental value="false"/>
<date value="2025-09-03T19:43:24-04:00"/>
<publisher value="HL7 International / Community Based Collaborative Care"/>
<contact>
<name value="HL7 International / Community Based Collaborative Care"/>
<telecom>
<system value="url"/>
<value value="http://www.hl7.org/Special/committees/cbcc"/>
</telecom>
</contact>
<description
value="Technical Specification Requirements for Admin Service"/>
<jurisdiction>
<coding>
<system value="urn:iso:std:iso:3166"/>
<code value="US"/>
<display value="United States of America"/>
</coding>
</jurisdiction>
<actor
value="http://hl7.org/fhir/us/consent-management/ActorDefinition/admin-service"/>
<statement>
<key value="68"/>
<label value="requirement-68"/>
<conformance value="SHOULD"/>
<conditionality value="false"/>
<requirement
value="Consent Administration Service SHOULD return OperationOutcome with details of which business rules did not allow an operation to be successful if an HTTP status code of 4xx or 5xx is returned"/>
<derivedFrom value="HL7 FAST Consent IG"/>
<reference
value="https://build.fhir.org/ig/HL7/fhir-consent-management/technical.html#:~:text=Systems%20SHOULD%20return%20an%20OperationOutcome%20with%20the%20details%20if%20an%20HTTP%20status%20code%20of%204xx%20or%205xx%20is%20returned"/>
</statement>
<statement>
<key value="69"/>
<label value="requirement-69"/>
<conformance value="MAY"/>
<conditionality value="false"/>
<requirement
value="Consent Administration Service MAY return OperationOutcome for a successful operation<br/><br/>- Right now, linking to each transaction. But rather than link many generic requirements to every transaction, should I create generic tests that each transaction uses?
• For now, no, but consider iterating into this. Once everything traces, can consider refactoring traces.
• An argument for doing this: every time we add a new transaction, we need to add those traces."/>
<derivedFrom value="HL7 FAST Consent IG"/>
<reference
value="https://build.fhir.org/ig/HL7/fhir-consent-management/technical.html#:~:text=systems%20MAY%20return%20an%20OperationOutcome%20with%20a%20success%20to%20be%20consistent"/>
</statement>
<statement>
<key value="63"/>
<label value="requirement-63"/>
<conformance value="SHALL"/>
<conditionality value="false"/>
<requirement
value="Consent Administration Service SHALL support Consent search"/>
<derivedFrom value="HL7 FAST Consent IG"/>
<reference
value="https://build.fhir.org/ig/HL7/fhir-consent-management/technical.html#:~:text=consent%20administration%20service%20systems%20SHALL%20support%20searching%20for%20consents"/>
</statement>
<statement>
<key value="364"/>
<label value="requirement-364"/>
<conformance value="SHALL"/>
<conditionality value="false"/>
<requirement
value="Consent Administration Service SHALL support Consent search by FASTConsentController"/>
<derivedFrom value="HL7 FAST Consent IG"/>
<reference
value="https://build.fhir.org/ig/HL7/fhir-consent-management/technical.html#:~:text=To%20support%20searching,controller"/>
</statement>
<statement>
<key value="365"/>
<label value="requirement-365"/>
<conformance value="SHALL"/>
<conditionality value="false"/>
<requirement
value="Consent Administration Service SHALL support Consent search by date"/>
<derivedFrom value="HL7 FAST Consent IG"/>
<reference
value="https://build.fhir.org/ig/HL7/fhir-consent-management/technical.html#:~:text=To%20support%20searching,date"/>
</statement>
<statement>
<key value="367"/>
<label value="requirement-367"/>
<conformance value="SHALL"/>
<conditionality value="false"/>
<requirement
value="Consent Administration Service SHALL support Consent search by FASTConsentManager"/>
<derivedFrom value="HL7 FAST Consent IG"/>
<reference
value="https://build.fhir.org/ig/HL7/fhir-consent-management/technical.html#:~:text=To%20support%20searching,manager"/>
</statement>
<statement>
<key value="71"/>
<label value="requirement-71"/>
<conformance value="SHALL"/>
<conditionality value="false"/>
<requirement
value="Consent Administration Service SHALL support Consent search by patient"/>
<derivedFrom value="HL7 FAST Consent IG"/>
<reference
value="https://build.fhir.org/ig/HL7/fhir-consent-management/technical.html#:~:text=To%20support%20searching,patient"/>
</statement>
<statement>
<key value="201"/>
<label value="requirement-201"/>
<conformance value="SHALL"/>
<conditionality value="false"/>
<requirement
value="Consent Administration Service SHALL support Consent search by scope"/>
<derivedFrom value="HL7 FAST Consent IG"/>
<reference
value="https://build.fhir.org/ig/HL7/fhir-consent-management/technical.html#:~:text=To%20support%20searching,scope"/>
</statement>
<statement>
<key value="73"/>
<label value="requirement-73"/>
<conformance value="SHALL"/>
<conditionality value="false"/>
<requirement
value="Consent Administration Service SHALL support Consent search by status"/>
<derivedFrom value="HL7 FAST Consent IG"/>
<reference
value="https://build.fhir.org/ig/HL7/fhir-consent-management/technical.html#:~:text=To%20support%20searching,status"/>
</statement>
<statement>
<key value="62"/>
<label value="requirement-62"/>
<conformance value="SHALL"/>
<conditionality value="false"/>
<requirement
value="Consent Administration Service SHALL support File Consent operation<br/><br/>Redundant with CapStmt"/>
<derivedFrom value="HL7 FAST Consent IG"/>
<reference
value="https://build.fhir.org/ig/HL7/fhir-consent-management/technical.html#:~:text=a%20consent%20administration%20service%20SHALL%20support%3A,File%20Consent"/>
<reference
value="https://build.fhir.org/ig/HL7/fhir-consent-management/technical.html#consent-management"/>
</statement>
<statement>
<key value="100"/>
<label value="requirement-100"/>
<conformance value="SHALL"/>
<conditionality value="false"/>
<requirement
value="Consent Administration Service SHALL support Update Consent operation<br/><br/>Redundant with CapStmt"/>
<derivedFrom value="HL7 FAST Consent IG"/>
<reference
value="https://build.fhir.org/ig/HL7/fhir-consent-management/technical.html#:~:text=a%20consent%20administration%20service%20SHALL%20support%3A,Update%20Consent"/>
</statement>
<statement>
<key value="101"/>
<label value="requirement-101"/>
<conformance value="SHALL"/>
<conditionality value="false"/>
<requirement
value="Consent Administration Service SHALL support Revoke Consent operation<br/><br/>Redundant with CapStmt"/>
<derivedFrom value="HL7 FAST Consent IG"/>
<reference
value="https://build.fhir.org/ig/HL7/fhir-consent-management/technical.html#:~:text=a%20consent%20administration%20service%20SHALL%20support%3A,Revoke%20Consent"/>
</statement>
<statement>
<key value="64"/>
<label value="requirement-64"/>
<conformance value="SHALL"/>
<conditionality value="false"/>
<requirement
value="Consent Administration Service SHALL support Consent subscriptions (as defined by the FAST Subscription Topic for FHIR R4 with Subscriptions Backport)<br/><br/>Fix: "a consent administration service SHALL support subscriptions to allow other systems to be informed when consents for a patient have changed." - this should be more precise, like "a consent administration service SHALL support subscriptions as defined by the FAST Subscription Topic, e.g. to allow other systems to be informed when consents for a patient have changed.""/>
<derivedFrom value="HL7 FAST Consent IG"/>
<reference
value="https://build.fhir.org/ig/HL7/fhir-consent-management/technical.html#:~:text=consent%20administration%20service%20SHALL%20support%20subscriptions%20to%20allow%20other%20systems%20to%20be%20informed%20when%20consents%20for%20a%20patient%20have%20changed"/>
</statement>
<statement>
<key value="407"/>
<label value="requirement-407"/>
<conformance value="SHALL"/>
<conditionality value="false"/>
<requirement
value="Consent Administration Service SHALL support AuditEvent search"/>
<derivedFrom value="HL7 FAST Consent IG"/>
<reference
value="https://build.fhir.org/ig/HL7/fhir-consent-management/technical.html#:~:text=systems%20SHALL%20support%20the%20searching%20for%20FAST%20Audit%20Events"/>
</statement>
<statement>
<key value="266"/>
<label value="requirement-266"/>
<conformance value="SHALL"/>
<conditionality value="false"/>
<requirement
value="Consent Administration Service SHALL support AuditEvent search by FASTAuditEventConsent<br/><br/>Need to specify actor(s). For now, assuming CAS SHALL support and Consent Client MAY support"/>
<derivedFrom value="HL7 FAST Consent IG"/>
<reference
value="https://build.fhir.org/ig/HL7/fhir-consent-management/technical.html#:~:text=systems%20SHALL%20support%20the,consent"/>
</statement>
<statement>
<key value="298"/>
<label value="requirement-298"/>
<conformance value="SHALL"/>
<conditionality value="false"/>
<requirement
value="Consent Administration Service SHALL support AuditEvent search by patient<br/><br/>Need to specify actor(s). For now, assuming CAS SHALL support and Consent Client MAY support"/>
<derivedFrom value="HL7 FAST Consent IG"/>
<reference
value="https://build.fhir.org/ig/HL7/fhir-consent-management/technical.html#:~:text=systems%20SHALL%20support%20the,patient"/>
</statement>
</Requirements>
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