Scalable Consent Management
1.0.0-preview - STU 1 PReview
Scalable Consent Management
1.0.0-preview - STU 1 PReview
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
| Page standards status: Trial-use | Maturity Level: 1 |
@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/technical-specification-consent-server> a fhir:Requirements ; fhir:nodeRole fhir:treeRoot ; fhir:Resource.id [ fhir:value "technical-specification-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 technical-specification-consent-server</b></p><a name=\"technical-specification-consent-server\"> </a><a name=\"hctechnical-specification-consent-server\"> </a><p>These requirements apply to the actor <a href=\"ActorDefinition-consent-server.html\">Consent Server</a></p><table class=\"grid\"><tr><td><b><a name=\"69\"> </a></b>requirement-69</td><td><a href=\"http://hl7.org/fhir/uv/xver-r5.r4/0.1.0/CodeSystem-conformance-expectation.html#conformance-expectation-MAY\">MAY</a></td><td><div><p>Consent Administration Service MAY return OperationOutcome for a successful operation<br/><br/>I believe they are referring only to extended operations defined by the IG.</p>\n</div><p>Links: </p><ul><li>Derived From: <code>HL7 FAST Consent IG</code></li><li>Satisfied By: <a href=\"https://build.fhir.org/ig/HL7/fhir-consent-management/en/technical.html#:~:text=Consent%20Server%20systems%20MAY%20return%20an%20OperationOutcome%20with%20a%20success%20when%20they%20wish%20to%20provide%20additional%20structured%20information%20alongside%20a%20successful%20operation%20response\">https://build.fhir.org/ig/HL7/fhir-consent-management/en/technical.html</a></li></ul></td></tr><tr><td><b><a name=\"68\"> </a></b>requirement-68</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>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<br/><br/>I believe they are referring only to extended operations defined by the IG.</p>\n</div><p>Links: </p><ul><li>Derived From: <code>HL7 FAST Consent IG</code></li><li>Satisfied By: <a href=\"https://build.fhir.org/ig/HL7/fhir-consent-management/en/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/en/technical.html</a></li></ul></td></tr><tr><td><b><a name=\"62\"> </a></b>requirement-62</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>Consent Administration Service SHALL support File Consent operation<br/><br/>Redundant with CapStmt</p>\n</div><p>Links: </p><ul><li>Derived From: <code>HL7 FAST Consent IG</code></li><li>Satisfied By: <a href=\"https://build.fhir.org/ig/HL7/fhir-consent-management/en/technical.html#:~:text=are%20defined%20that-,a%20consent%20administration%20service%20SHALL%20support%3A,-File%20Consent&text=service%20SHALL%20support%3A-,File%20Consent,-and%20Revoke%20Consent\">https://build.fhir.org/ig/HL7/fhir-consent-management/en/technical.html</a></li></ul></td></tr><tr><td><b><a name=\"101\"> </a></b>requirement-101</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>Consent Administration Service SHALL support Revoke Consent operation<br/><br/>Redundant with CapStmt</p>\n</div><p>Links: </p><ul><li>Derived From: <code>HL7 FAST Consent IG</code></li><li>Satisfied By: <a href=\"https://build.fhir.org/ig/HL7/fhir-consent-management/en/technical.html#:~:text=are%20defined%20that-,a%20consent%20administration%20service%20SHALL%20support%3A,-File%20Consent&text=File%20Consent%20and-,Revoke%20Consent,-.%20%C2%A7OP1\">https://build.fhir.org/ig/HL7/fhir-consent-management/en/technical.html</a></li></ul></td></tr><tr><td><b><a name=\"63\"> </a></b>requirement-63</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>Consent Administration Service SHALL support Consent search</p>\n</div><p>Links: </p><ul><li>Derived From: <code>HL7 FAST Consent IG</code></li><li>Satisfied By: <a href=\"https://build.fhir.org/ig/HL7/fhir-consent-management/en/technical.html#:~:text=consent%20administration%20service%20systems%20SHALL%20support%20searching%20for%20consents\">https://build.fhir.org/ig/HL7/fhir-consent-management/en/technical.html</a></li></ul></td></tr><tr><td><b><a name=\"64\"> </a></b>requirement-64</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>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>\n</div><p>Links: </p><ul><li>Derived From: <code>HL7 FAST Consent IG</code></li><li>Satisfied By: <a href=\"https://build.fhir.org/ig/HL7/fhir-consent-management/en/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/en/technical.html</a></li></ul></td></tr><tr><td><b><a name=\"727\"> </a></b>requirement-727</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>Consent Administration Service SHALL set Consent status element to 'active' when a File Consent operation has succeeded.</p>\n</div><p>Links: </p><ul><li>Derived From: <code>HL7 FAST Consent IG</code></li><li>Satisfied By: <a href=\"https://build.fhir.org/ig/HL7/fhir-consent-management/en/technical.html#:~:text=When%20filing%20a%20consent%2C%20the%20Consent%20status%20element%20SHALL%20be%20set%20to%20%27active%27\">https://build.fhir.org/ig/HL7/fhir-consent-management/en/technical.html</a></li></ul></td></tr><tr><td><b><a name=\"634\"> </a></b>requirement-634</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>Consent Administration Service SHALL set Consent status element to 'inactive' when a Revoke Consent operation has succeeded.</p>\n</div><p>Links: </p><ul><li>Derived From: <code>HL7 FAST Consent IG</code></li><li>Satisfied By: <a href=\"https://build.fhir.org/ig/HL7/fhir-consent-management/en/technical.html#:~:text=After%20a%20consent%20has%20been%20revoked%2C%20the%20Consent%20status%20element%20for%20the%20revoked%20consent%20SHALL%20be%20set%20to%20%27inactive%27.\">https://build.fhir.org/ig/HL7/fhir-consent-management/en/technical.html</a></li></ul></td></tr><tr><td><b><a name=\"760\"> </a></b>requirement-760</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>Consent Administration Service SHALL NOT delete a Consent resource as a result of a Revoke Consent operation.</p>\n</div><p>Links: </p><ul><li>Derived From: <code>HL7 FAST Consent IG</code></li><li>Satisfied By: <a href=\"https://build.fhir.org/ig/HL7/fhir-consent-management/en/technical.html#:~:text=A%20revoked%20consent%20SHALL%20NOT%20be%20deleted%20from%20the%20consent%20management%20system\">https://build.fhir.org/ig/HL7/fhir-consent-management/en/technical.html</a></li></ul></td></tr><tr><td><b><a name=\"71\"> </a></b>requirement-71</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>Consent Administration Service SHALL support Consent search by patient</p>\n</div><p>Links: </p><ul><li>Derived From: <code>HL7 FAST Consent IG</code></li><li>Satisfied By: <a href=\"https://build.fhir.org/ig/HL7/fhir-consent-management/en/technical.html#:~:text=Searching%20for%20Consents-,To%20support%20searching%20for%20consents%2C%20the%20following%20search%20parameters%20SHALL%20be%20supported,-%2D%20patient%2C%20controller%2C%20manager&text=scope.%20%C2%A7OP7-,patient,-controller\">https://build.fhir.org/ig/HL7/fhir-consent-management/en/technical.html</a></li></ul></td></tr><tr><td><b><a name=\"364\"> </a></b>requirement-364</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>Consent Administration Service SHALL support Consent search by FASTConsentController</p>\n</div><p>Links: </p><ul><li>Derived From: <code>HL7 FAST Consent IG</code></li><li>Satisfied By: <a href=\"https://build.fhir.org/ig/HL7/fhir-consent-management/en/technical.html#:~:text=Searching%20for%20Consents-,To%20support%20searching%20for%20consents%2C%20the%20following%20search%20parameters%20SHALL%20be%20supported,-%2D%20patient%2C%20controller%2C%20manager&text=patient-,controller,-manager\">https://build.fhir.org/ig/HL7/fhir-consent-management/en/technical.html</a></li></ul></td></tr><tr><td><b><a name=\"367\"> </a></b>requirement-367</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>Consent Administration Service SHALL support Consent search by FASTConsentManager</p>\n</div><p>Links: </p><ul><li>Derived From: <code>HL7 FAST Consent IG</code></li><li>Satisfied By: <a href=\"https://build.fhir.org/ig/HL7/fhir-consent-management/en/technical.html#:~:text=Searching%20for%20Consents-,To%20support%20searching%20for%20consents%2C%20the%20following%20search%20parameters%20SHALL%20be%20supported,-%2D%20patient%2C%20controller%2C%20manager&text=controller-,manager,-date\">https://build.fhir.org/ig/HL7/fhir-consent-management/en/technical.html</a></li></ul></td></tr><tr><td><b><a name=\"365\"> </a></b>requirement-365</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>Consent Administration Service SHALL support Consent search by date</p>\n</div><p>Links: </p><ul><li>Derived From: <code>HL7 FAST Consent IG</code></li><li>Satisfied By: <a href=\"https://build.fhir.org/ig/HL7/fhir-consent-management/en/technical.html#:~:text=Searching%20for%20Consents-,To%20support%20searching%20for%20consents%2C%20the%20following%20search%20parameters%20SHALL%20be%20supported,-%2D%20patient%2C%20controller%2C%20manager&text=manager-,date,-status\">https://build.fhir.org/ig/HL7/fhir-consent-management/en/technical.html</a></li></ul></td></tr><tr><td><b><a name=\"73\"> </a></b>requirement-73</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>Consent Administration Service SHALL support Consent search by status</p>\n</div><p>Links: </p><ul><li>Derived From: <code>HL7 FAST Consent IG</code></li><li>Satisfied By: <a href=\"https://build.fhir.org/ig/HL7/fhir-consent-management/en/technical.html#:~:text=Searching%20for%20Consents-,To%20support%20searching%20for%20consents%2C%20the%20following%20search%20parameters%20SHALL%20be%20supported,-%2D%20patient%2C%20controller%2C%20manager&text=date-,status,-scope\">https://build.fhir.org/ig/HL7/fhir-consent-management/en/technical.html</a></li></ul></td></tr><tr><td><b><a name=\"201\"> </a></b>requirement-201</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>Consent Administration Service SHALL support Consent search by scope</p>\n</div><p>Links: </p><ul><li>Derived From: <code>HL7 FAST Consent IG</code></li><li>Satisfied By: <a href=\"https://build.fhir.org/ig/HL7/fhir-consent-management/en/technical.html#:~:text=Searching%20for%20Consents-,To%20support%20searching%20for%20consents%2C%20the%20following%20search%20parameters%20SHALL%20be%20supported,-%2D%20patient%2C%20controller%2C%20manager&text=status-,scope,-The%20controller%20and\">https://build.fhir.org/ig/HL7/fhir-consent-management/en/technical.html</a></li></ul></td></tr><tr><td><b><a name=\"827\"> </a></b>requirement-827</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>Consent Administration Service SHALL be able to record disclosures of when a consent was accessed to determine whether patient information could be accessed<br/><br/>- Need to clarify which system has the responsibility for calling this - assuming Consent Client, calling the CAS.</p>\n<ul>\n<li>For now, assuming client calls after accessing.</li>\n</ul>\n</div><p>Links: </p><ul><li>Derived From: <code>HL7 FAST Consent IG</code></li><li>Satisfied By: <a href=\"https://build.fhir.org/ig/HL7/fhir-consent-management/en/technical.html#:~:text=consent%20administration%20services%20SHALL%20be%20able%20to%20record%20and%20retrieve%20disclosures%20of%20when%20a%20consent%20was%20accessed%20to%20determine%20whether%20patient%20information%20could%20be%20accessed.\">https://build.fhir.org/ig/HL7/fhir-consent-management/en/technical.html</a></li></ul></td></tr><tr><td><b><a name=\"828\"> </a></b>requirement-828</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>Consent Administration Service SHALL be able to retrieve disclosures of when a consent was accessed to determine whether patient information could be accessed<br/><br/>- Need to clarify which system has the responsibility for calling this - assuming Consent Client, calling the CAS.</p>\n<ul>\n<li>For now, assuming client calls after accessing.</li>\n</ul>\n</div><p>Links: </p><ul><li>Derived From: <code>HL7 FAST Consent IG</code></li><li>Satisfied By: <a href=\"https://build.fhir.org/ig/HL7/fhir-consent-management/en/technical.html#:~:text=consent%20administration%20services%20SHALL%20be%20able%20to%20record%20and%20retrieve%20disclosures%20of%20when%20a%20consent%20was%20accessed%20to%20determine%20whether%20patient%20information%20could%20be%20accessed.\">https://build.fhir.org/ig/HL7/fhir-consent-management/en/technical.html</a></li></ul></td></tr><tr><td><b><a name=\"1166\"> </a></b>requirement-1166</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 SHALL create a FAST Consent Audit Event via a RESTful FHIR POST AuditEvent whenever a Consent instance is accessed to determine whether patient information can be accessed<br/><br/>See 7.2.6.1 - not always the Consent Admin Service, so if we test this in a workflow with a CAS, need to allow a different configurable actor to be the one that POSTs.</p>\n</div><p>Links: </p><ul><li>Derived From: <code>HL7 FAST Consent IG</code></li><li>Satisfied By: <a href=\"https://build.fhir.org/ig/HL7/fhir-consent-management/en/technical.html#:~:text=systems%20shall%20create%20a%20fast%20consent%20audit%20event%20via%20a%20restful%20fhir%20post%20auditevent%20whenever%20a%20consent%20instance%20is%20accessed%20to%20determine%20whether%20patient%20information%20can%20be%20accessed\">https://build.fhir.org/ig/HL7/fhir-consent-management/en/technical.html</a></li></ul></td></tr><tr><td><b><a name=\"1163\"> </a></b>requirement-1163</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>For disclosure events, implementers SHOULD follow the IHE Basic Audit Log Patterns (BALP) guide, specifically the patterns for data disclosure audit events. This guide does not define a custom profile for disclosure events; IHE-BALP patterns should be used directly.<br/><br/>Requires a separate analysis task</p>\n</div><p>Links: </p><ul><li>Derived From: <code>HL7 FAST Consent IG</code></li><li>Satisfied By: <a href=\"https://build.fhir.org/ig/HL7/fhir-consent-management/en/technical.html#:~:text=for%20disclosure%20events%2C%20implementers%20should%20follow%20the%20ihe%20basic%20audit%20log%20patterns%20%28balp%29%20guide%2C%20specifically%20the%20patterns%20for%20data%20disclosure%20audit%20events.%C2%A7op16%20this%20guide%20does%20not%20define%20a%20custom%20profile%20for%20disclosure%20events%3B%20ihe%2Dbalp%20patterns%20should%20be%20used%20directly.\">https://build.fhir.org/ig/HL7/fhir-consent-management/en/technical.html</a></li></ul></td></tr><tr><td><b><a name=\"1164\"> </a></b>requirement-1164</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>Consent Administration Service SHALL support AuditEvent search by Consent (entity)</p>\n</div><p>Links: </p><ul><li>Derived From: <code>HL7 FAST Consent IG</code></li><li>Satisfied By: <a href=\"https://build.fhir.org/ig/HL7/fhir-consent-management/en/technical.html#:~:text=systems%20shall%20support%20searching%20for%20fast%20consent%20audit%20events%C2%A7op9%20using%20the%20following%20search%20parameters&text=entity%20%E2%80%94%20use%20entity%3DConsent/%5Bid%5D%20to%20search%20for%20all%20authorization%20decisions%20made%20against%20a%20specific%20Consent%20instance\">https://build.fhir.org/ig/HL7/fhir-consent-management/en/technical.html</a></li></ul></td></tr><tr><td><b><a name=\"298\"> </a></b>requirement-298</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>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>\n</div><p>Links: </p><ul><li>Derived From: <code>HL7 FAST Consent IG</code></li><li>Satisfied By: <a href=\"https://build.fhir.org/ig/HL7/fhir-consent-management/en/technical.html#:~:text=systems%20shall%20support%20searching%20for%20fast%20consent%20audit%20events%C2%A7op9%20using%20the%20following%20search%20parameters&text=patient%20%E2%80%94%20use%20patient%3D%5Bref%5D%20to%20search%20for%20all%20authorization%20decisions%20involving%20any%20consent%20for%20a%20specific%20patient\">https://build.fhir.org/ig/HL7/fhir-consent-management/en/technical.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/technical-specification-consent-server"] ; fhir:Requirements.version [ fhir:value "1.0.0-preview"] ; fhir:Requirements.name [ fhir:value "TechnicalSpecificationConsentServer"] ; fhir:Requirements.title [ fhir:value "Technical Specification 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 "Technical Specification Requirements for 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/consent-server" ; fhir:index 0 ; fhir:link <http://hl7.org/fhir/us/consent-management/ActorDefinition/consent-server> ] ; fhir:Requirements.statement [ fhir:index 0 ; fhir:Requirements.statement.key [ fhir:value "69" ] ; fhir:Requirements.statement.label [ fhir:value "requirement-69" ] ; fhir:Requirements.statement.conformance [ fhir:value "MAY" ; fhir:index 0 ] ; fhir:Requirements.statement.conditionality [ fhir:value "false"^^xsd:boolean ] ; fhir:Requirements.statement.requirement [ fhir:value "Consent Administration Service MAY return OperationOutcome for a successful operation<br/><br/>I believe they are referring only to extended operations defined by the IG." ] ; fhir:Requirements.statement.derivedFrom [ fhir:value "HL7 FAST Consent IG" ] ; fhir:Requirements.statement.satisfiedBy [ fhir:value "https://build.fhir.org/ig/HL7/fhir-consent-management/en/technical.html#:~:text=Consent%20Server%20systems%20MAY%20return%20an%20OperationOutcome%20with%20a%20success%20when%20they%20wish%20to%20provide%20additional%20structured%20information%20alongside%20a%20successful%20operation%20response" ; fhir:index 0 ] ], [ fhir:index 1 ; fhir:Requirements.statement.key [ fhir:value "68" ] ; fhir:Requirements.statement.label [ fhir:value "requirement-68" ] ; 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 "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<br/><br/>I believe they are referring only to extended operations defined by the IG." ] ; fhir:Requirements.statement.derivedFrom [ fhir:value "HL7 FAST Consent IG" ] ; fhir:Requirements.statement.satisfiedBy [ fhir:value "https://build.fhir.org/ig/HL7/fhir-consent-management/en/technical.html#:~:text=Systems%20SHOULD%20return%20an%20OperationOutcome%20with%20the%20details%20if%20an%20HTTP%20status%20code%20of%204xx%20or%205xx%20is%20returned" ; fhir:index 0 ] ], [ fhir:index 2 ; fhir:Requirements.statement.key [ fhir:value "62" ] ; fhir:Requirements.statement.label [ fhir:value "requirement-62" ] ; 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 "Consent Administration Service SHALL support File Consent operation<br/><br/>Redundant with CapStmt" ] ; fhir:Requirements.statement.derivedFrom [ fhir:value "HL7 FAST Consent IG" ] ; fhir:Requirements.statement.satisfiedBy [ fhir:value "https://build.fhir.org/ig/HL7/fhir-consent-management/en/technical.html#:~:text=are%20defined%20that-,a%20consent%20administration%20service%20SHALL%20support%3A,-File%20Consent&text=service%20SHALL%20support%3A-,File%20Consent,-and%20Revoke%20Consent" ; fhir:index 0 ] ], [ fhir:index 3 ; fhir:Requirements.statement.key [ fhir:value "101" ] ; fhir:Requirements.statement.label [ fhir:value "requirement-101" ] ; 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 "Consent Administration Service SHALL support Revoke Consent operation<br/><br/>Redundant with CapStmt" ] ; fhir:Requirements.statement.derivedFrom [ fhir:value "HL7 FAST Consent IG" ] ; fhir:Requirements.statement.satisfiedBy [ fhir:value "https://build.fhir.org/ig/HL7/fhir-consent-management/en/technical.html#:~:text=are%20defined%20that-,a%20consent%20administration%20service%20SHALL%20support%3A,-File%20Consent&text=File%20Consent%20and-,Revoke%20Consent,-.%20%C2%A7OP1" ; fhir:index 0 ] ], [ fhir:index 4 ; fhir:Requirements.statement.key [ fhir:value "63" ] ; fhir:Requirements.statement.label [ fhir:value "requirement-63" ] ; 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 "Consent Administration Service SHALL support Consent search" ] ; fhir:Requirements.statement.derivedFrom [ fhir:value "HL7 FAST Consent IG" ] ; fhir:Requirements.statement.satisfiedBy [ fhir:value "https://build.fhir.org/ig/HL7/fhir-consent-management/en/technical.html#:~:text=consent%20administration%20service%20systems%20SHALL%20support%20searching%20for%20consents" ; fhir:index 0 ] ], [ fhir:index 5 ; fhir:Requirements.statement.key [ fhir:value "64" ] ; fhir:Requirements.statement.label [ fhir:value "requirement-64" ] ; 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 "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.\"" ] ; fhir:Requirements.statement.derivedFrom [ fhir:value "HL7 FAST Consent IG" ] ; fhir:Requirements.statement.satisfiedBy [ fhir:value "https://build.fhir.org/ig/HL7/fhir-consent-management/en/technical.html#:~:text=consent%20administration%20service%20SHALL%20support%20subscriptions%20to%20allow%20other%20systems%20to%20be%20informed%20when%20consents%20for%20a%20patient%20have%20changed" ; fhir:index 0 ] ], [ fhir:index 6 ; fhir:Requirements.statement.key [ fhir:value "727" ] ; fhir:Requirements.statement.label [ fhir:value "requirement-727" ] ; 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 "Consent Administration Service SHALL set Consent status element to 'active' when a File Consent operation has succeeded." ] ; fhir:Requirements.statement.derivedFrom [ fhir:value "HL7 FAST Consent IG" ] ; fhir:Requirements.statement.satisfiedBy [ fhir:value "https://build.fhir.org/ig/HL7/fhir-consent-management/en/technical.html#:~:text=When%20filing%20a%20consent%2C%20the%20Consent%20status%20element%20SHALL%20be%20set%20to%20%27active%27" ; fhir:index 0 ] ], [ fhir:index 7 ; fhir:Requirements.statement.key [ fhir:value "634" ] ; fhir:Requirements.statement.label [ fhir:value "requirement-634" ] ; 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 "Consent Administration Service SHALL set Consent status element to 'inactive' when a Revoke Consent operation has succeeded." ] ; fhir:Requirements.statement.derivedFrom [ fhir:value "HL7 FAST Consent IG" ] ; fhir:Requirements.statement.satisfiedBy [ fhir:value "https://build.fhir.org/ig/HL7/fhir-consent-management/en/technical.html#:~:text=After%20a%20consent%20has%20been%20revoked%2C%20the%20Consent%20status%20element%20for%20the%20revoked%20consent%20SHALL%20be%20set%20to%20%27inactive%27." ; fhir:index 0 ] ], [ fhir:index 8 ; fhir:Requirements.statement.key [ fhir:value "760" ] ; fhir:Requirements.statement.label [ fhir:value "requirement-760" ] ; 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 "Consent Administration Service SHALL NOT delete a Consent resource as a result of a Revoke Consent operation." ] ; fhir:Requirements.statement.derivedFrom [ fhir:value "HL7 FAST Consent IG" ] ; fhir:Requirements.statement.satisfiedBy [ fhir:value "https://build.fhir.org/ig/HL7/fhir-consent-management/en/technical.html#:~:text=A%20revoked%20consent%20SHALL%20NOT%20be%20deleted%20from%20the%20consent%20management%20system" ; fhir:index 0 ] ], [ fhir:index 9 ; fhir:Requirements.statement.key [ fhir:value "71" ] ; fhir:Requirements.statement.label [ fhir:value "requirement-71" ] ; 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 "Consent Administration Service SHALL support Consent search by patient" ] ; fhir:Requirements.statement.derivedFrom [ fhir:value "HL7 FAST Consent IG" ] ; fhir:Requirements.statement.satisfiedBy [ fhir:value "https://build.fhir.org/ig/HL7/fhir-consent-management/en/technical.html#:~:text=Searching%20for%20Consents-,To%20support%20searching%20for%20consents%2C%20the%20following%20search%20parameters%20SHALL%20be%20supported,-%2D%20patient%2C%20controller%2C%20manager&text=scope.%20%C2%A7OP7-,patient,-controller" ; fhir:index 0 ] ], [ fhir:index 10 ; fhir:Requirements.statement.key [ fhir:value "364" ] ; fhir:Requirements.statement.label [ fhir:value "requirement-364" ] ; 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 "Consent Administration Service SHALL support Consent search by FASTConsentController" ] ; fhir:Requirements.statement.derivedFrom [ fhir:value "HL7 FAST Consent IG" ] ; fhir:Requirements.statement.satisfiedBy [ fhir:value "https://build.fhir.org/ig/HL7/fhir-consent-management/en/technical.html#:~:text=Searching%20for%20Consents-,To%20support%20searching%20for%20consents%2C%20the%20following%20search%20parameters%20SHALL%20be%20supported,-%2D%20patient%2C%20controller%2C%20manager&text=patient-,controller,-manager" ; fhir:index 0 ] ], [ fhir:index 11 ; fhir:Requirements.statement.key [ fhir:value "367" ] ; fhir:Requirements.statement.label [ fhir:value "requirement-367" ] ; 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 "Consent Administration Service SHALL support Consent search by FASTConsentManager" ] ; fhir:Requirements.statement.derivedFrom [ fhir:value "HL7 FAST Consent IG" ] ; fhir:Requirements.statement.satisfiedBy [ fhir:value "https://build.fhir.org/ig/HL7/fhir-consent-management/en/technical.html#:~:text=Searching%20for%20Consents-,To%20support%20searching%20for%20consents%2C%20the%20following%20search%20parameters%20SHALL%20be%20supported,-%2D%20patient%2C%20controller%2C%20manager&text=controller-,manager,-date" ; fhir:index 0 ] ], [ fhir:index 12 ; fhir:Requirements.statement.key [ fhir:value "365" ] ; fhir:Requirements.statement.label [ fhir:value "requirement-365" ] ; 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 "Consent Administration Service SHALL support Consent search by date" ] ; fhir:Requirements.statement.derivedFrom [ fhir:value "HL7 FAST Consent IG" ] ; fhir:Requirements.statement.satisfiedBy [ fhir:value "https://build.fhir.org/ig/HL7/fhir-consent-management/en/technical.html#:~:text=Searching%20for%20Consents-,To%20support%20searching%20for%20consents%2C%20the%20following%20search%20parameters%20SHALL%20be%20supported,-%2D%20patient%2C%20controller%2C%20manager&text=manager-,date,-status" ; fhir:index 0 ] ], [ fhir:index 13 ; fhir:Requirements.statement.key [ fhir:value "73" ] ; fhir:Requirements.statement.label [ fhir:value "requirement-73" ] ; 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 "Consent Administration Service SHALL support Consent search by status" ] ; fhir:Requirements.statement.derivedFrom [ fhir:value "HL7 FAST Consent IG" ] ; fhir:Requirements.statement.satisfiedBy [ fhir:value "https://build.fhir.org/ig/HL7/fhir-consent-management/en/technical.html#:~:text=Searching%20for%20Consents-,To%20support%20searching%20for%20consents%2C%20the%20following%20search%20parameters%20SHALL%20be%20supported,-%2D%20patient%2C%20controller%2C%20manager&text=date-,status,-scope" ; fhir:index 0 ] ], [ fhir:index 14 ; fhir:Requirements.statement.key [ fhir:value "201" ] ; fhir:Requirements.statement.label [ fhir:value "requirement-201" ] ; 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 "Consent Administration Service SHALL support Consent search by scope" ] ; fhir:Requirements.statement.derivedFrom [ fhir:value "HL7 FAST Consent IG" ] ; fhir:Requirements.statement.satisfiedBy [ fhir:value "https://build.fhir.org/ig/HL7/fhir-consent-management/en/technical.html#:~:text=Searching%20for%20Consents-,To%20support%20searching%20for%20consents%2C%20the%20following%20search%20parameters%20SHALL%20be%20supported,-%2D%20patient%2C%20controller%2C%20manager&text=status-,scope,-The%20controller%20and" ; fhir:index 0 ] ], [ fhir:index 15 ; fhir:Requirements.statement.key [ fhir:value "827" ] ; fhir:Requirements.statement.label [ fhir:value "requirement-827" ] ; 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 "Consent Administration Service SHALL be able to record disclosures of when a consent was accessed to determine whether patient information could be accessed<br/><br/>- Need to clarify which system has the responsibility for calling this - assuming Consent Client, calling the CAS.\n- For now, assuming client calls after accessing." ] ; fhir:Requirements.statement.derivedFrom [ fhir:value "HL7 FAST Consent IG" ] ; fhir:Requirements.statement.satisfiedBy [ fhir:value "https://build.fhir.org/ig/HL7/fhir-consent-management/en/technical.html#:~:text=consent%20administration%20services%20SHALL%20be%20able%20to%20record%20and%20retrieve%20disclosures%20of%20when%20a%20consent%20was%20accessed%20to%20determine%20whether%20patient%20information%20could%20be%20accessed." ; fhir:index 0 ] ], [ fhir:index 16 ; fhir:Requirements.statement.key [ fhir:value "828" ] ; fhir:Requirements.statement.label [ fhir:value "requirement-828" ] ; 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 "Consent Administration Service SHALL be able to retrieve disclosures of when a consent was accessed to determine whether patient information could be accessed<br/><br/>- Need to clarify which system has the responsibility for calling this - assuming Consent Client, calling the CAS.\n- For now, assuming client calls after accessing." ] ; fhir:Requirements.statement.derivedFrom [ fhir:value "HL7 FAST Consent IG" ] ; fhir:Requirements.statement.satisfiedBy [ fhir:value "https://build.fhir.org/ig/HL7/fhir-consent-management/en/technical.html#:~:text=consent%20administration%20services%20SHALL%20be%20able%20to%20record%20and%20retrieve%20disclosures%20of%20when%20a%20consent%20was%20accessed%20to%20determine%20whether%20patient%20information%20could%20be%20accessed." ; fhir:index 0 ] ], [ fhir:index 17 ; fhir:Requirements.statement.key [ fhir:value "1166" ] ; fhir:Requirements.statement.label [ fhir:value "requirement-1166" ] ; 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 SHALL create a FAST Consent Audit Event via a RESTful FHIR POST AuditEvent whenever a Consent instance is accessed to determine whether patient information can be accessed<br/><br/>See 7.2.6.1 - not always the Consent Admin Service, so if we test this in a workflow with a CAS, need to allow a different configurable actor to be the one that POSTs." ] ; fhir:Requirements.statement.derivedFrom [ fhir:value "HL7 FAST Consent IG" ] ; fhir:Requirements.statement.satisfiedBy [ fhir:value "https://build.fhir.org/ig/HL7/fhir-consent-management/en/technical.html#:~:text=systems%20shall%20create%20a%20fast%20consent%20audit%20event%20via%20a%20restful%20fhir%20post%20auditevent%20whenever%20a%20consent%20instance%20is%20accessed%20to%20determine%20whether%20patient%20information%20can%20be%20accessed" ; fhir:index 0 ] ], [ fhir:index 18 ; fhir:Requirements.statement.key [ fhir:value "1163" ] ; fhir:Requirements.statement.label [ fhir:value "requirement-1163" ] ; 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 "For disclosure events, implementers SHOULD follow the IHE Basic Audit Log Patterns (BALP) guide, specifically the patterns for data disclosure audit events. This guide does not define a custom profile for disclosure events; IHE-BALP patterns should be used directly.<br/><br/>Requires a separate analysis task" ] ; fhir:Requirements.statement.derivedFrom [ fhir:value "HL7 FAST Consent IG" ] ; fhir:Requirements.statement.satisfiedBy [ fhir:value "https://build.fhir.org/ig/HL7/fhir-consent-management/en/technical.html#:~:text=for%20disclosure%20events%2C%20implementers%20should%20follow%20the%20ihe%20basic%20audit%20log%20patterns%20%28balp%29%20guide%2C%20specifically%20the%20patterns%20for%20data%20disclosure%20audit%20events.%C2%A7op16%20this%20guide%20does%20not%20define%20a%20custom%20profile%20for%20disclosure%20events%3B%20ihe%2Dbalp%20patterns%20should%20be%20used%20directly." ; fhir:index 0 ] ], [ fhir:index 19 ; fhir:Requirements.statement.key [ fhir:value "1164" ] ; fhir:Requirements.statement.label [ fhir:value "requirement-1164" ] ; 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 "Consent Administration Service SHALL support AuditEvent search by Consent (entity)" ] ; fhir:Requirements.statement.derivedFrom [ fhir:value "HL7 FAST Consent IG" ] ; fhir:Requirements.statement.satisfiedBy [ fhir:value "https://build.fhir.org/ig/HL7/fhir-consent-management/en/technical.html#:~:text=systems%20shall%20support%20searching%20for%20fast%20consent%20audit%20events%C2%A7op9%20using%20the%20following%20search%20parameters&text=entity%20%E2%80%94%20use%20entity%3DConsent/%5Bid%5D%20to%20search%20for%20all%20authorization%20decisions%20made%20against%20a%20specific%20Consent%20instance" ; fhir:index 0 ] ], [ fhir:index 20 ; fhir:Requirements.statement.key [ fhir:value "298" ] ; fhir:Requirements.statement.label [ fhir:value "requirement-298" ] ; 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 "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" ] ; fhir:Requirements.statement.derivedFrom [ fhir:value "HL7 FAST Consent IG" ] ; fhir:Requirements.statement.satisfiedBy [ fhir:value "https://build.fhir.org/ig/HL7/fhir-consent-management/en/technical.html#:~:text=systems%20shall%20support%20searching%20for%20fast%20consent%20audit%20events%C2%A7op9%20using%20the%20following%20search%20parameters&text=patient%20%E2%80%94%20use%20patient%3D%5Bref%5D%20to%20search%20for%20all%20authorization%20decisions%20involving%20any%20consent%20for%20a%20specific%20patient" ; fhir:index 0 ] ] . # - ontology header ------------------------------------------------------------ <http://hl7.org/fhir/Requirements/technical-specification-consent-server.ttl> a owl:Ontology ; owl:imports fhir:fhir.ttl ; owl:versionIRI <http://build.fhir.org/Requirements/technical-specification-consent-server.ttl> .
IG © 2024+ HL7 International / Community Based Collaborative Care.
Package hl7.fhir.us.consent-management#1.0.0-preview based on FHIR 4.0.1.
Generated
2026-09-11
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change