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 |
{
"resourceType" : "Requirements",
"id" : "technical-specification-admin-service",
"text" : {
"status" : "generated",
"div" : "<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>\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/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?\n•\tFor now, no, but consider iterating into this. Once everything traces, can consider refactoring traces.\n•\tAn argument for doing this: every time we add a new transaction, we need to add those traces.</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/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>\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/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>\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/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>\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/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>\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/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>\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/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>\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/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>\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/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>\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/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>\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/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>\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/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>\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/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>\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/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>\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/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>\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/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>"
},
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
"valueCode" : "cbcc"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
"valueInteger" : 1,
"_valueInteger" : {
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom",
"valueCanonical" : "http://hl7.org/fhir/us/consent-management/ImplementationGuide/hl7.fhir.us.consent-management"
}
]
}
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode" : "trial-use",
"_valueCode" : {
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom",
"valueCanonical" : "http://hl7.org/fhir/us/consent-management/ImplementationGuide/hl7.fhir.us.consent-management"
}
]
}
}
],
"url" : "http://hl7.org/fhir/us/consent-management/Requirements/technical-specification-admin-service",
"version" : "0.1.0",
"name" : "TechnicalSpecificationAdminService",
"title" : "Technical Specification Admin Service",
"status" : "active",
"experimental" : false,
"date" : "2025-09-03T19:43:24-04:00",
"publisher" : "HL7 International / Community Based Collaborative Care",
"contact" : [
{
"name" : "HL7 International / Community Based Collaborative Care",
"telecom" : [
{
"system" : "url",
"value" : "http://www.hl7.org/Special/committees/cbcc"
}
]
}
],
"description" : "Technical Specification Requirements for Admin Service",
"jurisdiction" : [
{
"coding" : [
{
"system" : "urn:iso:std:iso:3166",
"code" : "US",
"display" : "United States of America"
}
]
}
],
"actor" : [
🔗 "http://hl7.org/fhir/us/consent-management/ActorDefinition/admin-service"
],
"statement" : [
{
"key" : "68",
"label" : "requirement-68",
"conformance" : [
"SHOULD"
],
"conditionality" : false,
"requirement" : "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" : "HL7 FAST Consent IG",
"reference" : [
"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"
]
},
{
"key" : "69",
"label" : "requirement-69",
"conformance" : [
"MAY"
],
"conditionality" : false,
"requirement" : "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?\n•\tFor now, no, but consider iterating into this. Once everything traces, can consider refactoring traces.\n•\tAn argument for doing this: every time we add a new transaction, we need to add those traces.",
"derivedFrom" : "HL7 FAST Consent IG",
"reference" : [
"https://build.fhir.org/ig/HL7/fhir-consent-management/technical.html#:~:text=systems%20MAY%20return%20an%20OperationOutcome%20with%20a%20success%20to%20be%20consistent"
]
},
{
"key" : "63",
"label" : "requirement-63",
"conformance" : [
"SHALL"
],
"conditionality" : false,
"requirement" : "Consent Administration Service SHALL support Consent search",
"derivedFrom" : "HL7 FAST Consent IG",
"reference" : [
"https://build.fhir.org/ig/HL7/fhir-consent-management/technical.html#:~:text=consent%20administration%20service%20systems%20SHALL%20support%20searching%20for%20consents"
]
},
{
"key" : "364",
"label" : "requirement-364",
"conformance" : [
"SHALL"
],
"conditionality" : false,
"requirement" : "Consent Administration Service SHALL support Consent search by FASTConsentController",
"derivedFrom" : "HL7 FAST Consent IG",
"reference" : [
"https://build.fhir.org/ig/HL7/fhir-consent-management/technical.html#:~:text=To%20support%20searching,controller"
]
},
{
"key" : "365",
"label" : "requirement-365",
"conformance" : [
"SHALL"
],
"conditionality" : false,
"requirement" : "Consent Administration Service SHALL support Consent search by date",
"derivedFrom" : "HL7 FAST Consent IG",
"reference" : [
"https://build.fhir.org/ig/HL7/fhir-consent-management/technical.html#:~:text=To%20support%20searching,date"
]
},
{
"key" : "367",
"label" : "requirement-367",
"conformance" : [
"SHALL"
],
"conditionality" : false,
"requirement" : "Consent Administration Service SHALL support Consent search by FASTConsentManager",
"derivedFrom" : "HL7 FAST Consent IG",
"reference" : [
"https://build.fhir.org/ig/HL7/fhir-consent-management/technical.html#:~:text=To%20support%20searching,manager"
]
},
{
"key" : "71",
"label" : "requirement-71",
"conformance" : [
"SHALL"
],
"conditionality" : false,
"requirement" : "Consent Administration Service SHALL support Consent search by patient",
"derivedFrom" : "HL7 FAST Consent IG",
"reference" : [
"https://build.fhir.org/ig/HL7/fhir-consent-management/technical.html#:~:text=To%20support%20searching,patient"
]
},
{
"key" : "201",
"label" : "requirement-201",
"conformance" : [
"SHALL"
],
"conditionality" : false,
"requirement" : "Consent Administration Service SHALL support Consent search by scope",
"derivedFrom" : "HL7 FAST Consent IG",
"reference" : [
"https://build.fhir.org/ig/HL7/fhir-consent-management/technical.html#:~:text=To%20support%20searching,scope"
]
},
{
"key" : "73",
"label" : "requirement-73",
"conformance" : [
"SHALL"
],
"conditionality" : false,
"requirement" : "Consent Administration Service SHALL support Consent search by status",
"derivedFrom" : "HL7 FAST Consent IG",
"reference" : [
"https://build.fhir.org/ig/HL7/fhir-consent-management/technical.html#:~:text=To%20support%20searching,status"
]
},
{
"key" : "62",
"label" : "requirement-62",
"conformance" : [
"SHALL"
],
"conditionality" : false,
"requirement" : "Consent Administration Service SHALL support File Consent operation<br/><br/>Redundant with CapStmt",
"derivedFrom" : "HL7 FAST Consent IG",
"reference" : [
"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#consent-management"
]
},
{
"key" : "100",
"label" : "requirement-100",
"conformance" : [
"SHALL"
],
"conditionality" : false,
"requirement" : "Consent Administration Service SHALL support Update Consent operation<br/><br/>Redundant with CapStmt",
"derivedFrom" : "HL7 FAST Consent IG",
"reference" : [
"https://build.fhir.org/ig/HL7/fhir-consent-management/technical.html#:~:text=a%20consent%20administration%20service%20SHALL%20support%3A,Update%20Consent"
]
},
{
"key" : "101",
"label" : "requirement-101",
"conformance" : [
"SHALL"
],
"conditionality" : false,
"requirement" : "Consent Administration Service SHALL support Revoke Consent operation<br/><br/>Redundant with CapStmt",
"derivedFrom" : "HL7 FAST Consent IG",
"reference" : [
"https://build.fhir.org/ig/HL7/fhir-consent-management/technical.html#:~:text=a%20consent%20administration%20service%20SHALL%20support%3A,Revoke%20Consent"
]
},
{
"key" : "64",
"label" : "requirement-64",
"conformance" : [
"SHALL"
],
"conditionality" : false,
"requirement" : "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" : "HL7 FAST Consent IG",
"reference" : [
"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"
]
},
{
"key" : "407",
"label" : "requirement-407",
"conformance" : [
"SHALL"
],
"conditionality" : false,
"requirement" : "Consent Administration Service SHALL support AuditEvent search",
"derivedFrom" : "HL7 FAST Consent IG",
"reference" : [
"https://build.fhir.org/ig/HL7/fhir-consent-management/technical.html#:~:text=systems%20SHALL%20support%20the%20searching%20for%20FAST%20Audit%20Events"
]
},
{
"key" : "266",
"label" : "requirement-266",
"conformance" : [
"SHALL"
],
"conditionality" : false,
"requirement" : "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" : "HL7 FAST Consent IG",
"reference" : [
"https://build.fhir.org/ig/HL7/fhir-consent-management/technical.html#:~:text=systems%20SHALL%20support%20the,consent"
]
},
{
"key" : "298",
"label" : "requirement-298",
"conformance" : [
"SHALL"
],
"conditionality" : false,
"requirement" : "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" : "HL7 FAST Consent IG",
"reference" : [
"https://build.fhir.org/ig/HL7/fhir-consent-management/technical.html#:~:text=systems%20SHALL%20support%20the,patient"
]
}
]
}
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