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" : "subscriptiontopic-fastconsentsubscriptiontopic-admin-service",
"text" : {
"status" : "generated",
"div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p class=\"res-header-id\"><b>Generated Narrative: Requirements subscriptiontopic-fastconsentsubscriptiontopic-admin-service</b></p><a name=\"subscriptiontopic-fastconsentsubscriptiontopic-admin-service\"> </a><a name=\"hcsubscriptiontopic-fastconsentsubscriptiontopic-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=\"600\"> </a></b>requirement-600</td><td>SHALL</td><td><div><p>Consent Administration Service SHALL trigger a notification for every Consent create, unless filtered out<br/><br/>This requirement is derived by the definition in the topic plus the actual behavior defined in R5 SubscriptionTopic (which is what's linked).</p>\n</div><p>Links: </p><ul><li>Derived From: <code>HL7 FHIR R5</code></li><li>References: <a href=\"https://hl7.org/fhir/subscriptiontopic.html#:~:text=Subscription%20Topics%20that%20include%20create,interaction%20is%20confirmed%20to%20apply.\">https://hl7.org/fhir/subscriptiontopic.html</a></li></ul></td></tr><tr><td><b><a name=\"606\"> </a></b>requirement-606</td><td>SHALL</td><td><div><p>Consent Administration Service SHALL trigger a notification for every Consent update, unless filtered out<br/><br/>This requirement is derived by the definition in the topic plus the actual behavior defined in R5 SubscriptionTopic (which is what's linked).</p>\n</div><p>Links: </p><ul><li>Derived From: <code>HL7 FHIR R5</code></li><li>References: <a href=\"https://hl7.org/fhir/subscriptiontopic.html#:~:text=Subscription%20Topics%20that%20include%20update,PUT%20with%20an%20identical%20resource).\">https://hl7.org/fhir/subscriptiontopic.html</a></li></ul></td></tr><tr><td><b><a name=\"607\"> </a></b>requirement-607</td><td>SHALL</td><td><div><p>Consent Administration Service SHALL trigger a notification for every Consent delete, unless filtered out<br/><br/>This requirement is derived by the definition in the topic plus the actual behavior defined in R5 SubscriptionTopic (which is what's linked).</p>\n</div><p>Links: </p><ul><li>Derived From: <code>HL7 FHIR R5</code></li><li>References: <a href=\"https://hl7.org/fhir/subscriptiontopic.html#:~:text=Subscription%20Topics%20that%20include%20delete,interaction%20is%20confirmed%20to%20apply.\">https://hl7.org/fhir/subscriptiontopic.html</a></li></ul></td></tr><tr><td><b><a name=\"603\"> </a></b>requirement-603</td><td>SHALL</td><td><div><p>Consent Administration Service SHALL support Consent notification filter by SearchParameter FASTConsentPatientId</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/SubscriptionTopic-FASTConsentSubscriptionTopic.json.html#:~:text=%22canFilterBy%22%20%3A%20%5B%0A%20%20%20%20%7B%0A%20%20%20%20%20%20%22description%22%20%3A%20%22The%20identifier%20of%20the%20consent%20patient.%22%2C%0A%20%20%20%20%20%20%22filterParameter%22%20%3A%20%22patientId%22%2C%0A%20%20%20%20%20%20%22filterDefinition%22%20%3A%20%22http%3A//hl7.org/fhir/us/consent%2Dmanagement/SearchParameter/fast%2Dconsent%2DpatientId%22%2C%0A%20%20%20%20%20%20%22comparator%22%20%3A%20%5B%0A%20%20%20%20%20%20%20%20%22eq%22%0A%20%20%20%20%20%20%5D%0A%20%20%20%20%7D\">https://build.fhir.org/ig/HL7/fhir-consent-management/SubscriptionTopic-FASTConsentSubscriptionTopic.json.html</a></li></ul></td></tr><tr><td><b><a name=\"628\"> </a></b>requirement-628</td><td>SHALL</td><td><div><p>Consent Administration Service SHALL support Consent notification filter by SearchParameter FASTConsentOrganizationId</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/SubscriptionTopic-FASTConsentSubscriptionTopic.json.html#:~:text=%7B%0A%20%20%20%20%20%20%22description%22%20%3A%20%22The%20identifier%20of%20the%20organization%20actor%20that%20gained%20consent.%22%2C%0A%20%20%20%20%20%20%22filterParameter%22%20%3A%20%22organizationId%22%2C%0A%20%20%20%20%20%20%22filterDefinition%22%20%3A%20%22http%3A//hl7.org/fhir/us/consent%2Dmanagement/SearchParameter/fast%2Dconsent%2DorganizationId%22%2C%0A%20%20%20%20%20%20%22comparator%22%20%3A%20%5B%0A%20%20%20%20%20%20%20%20%22eq%22%0A%20%20%20%20%20%20%5D%0A%20%20%20%20%7D%2C\">https://build.fhir.org/ig/HL7/fhir-consent-management/SubscriptionTopic-FASTConsentSubscriptionTopic.json.html</a></li></ul></td></tr><tr><td><b><a name=\"629\"> </a></b>requirement-629</td><td>SHALL</td><td><div><p>Consent Administration Service SHALL support Consent notification filter by actor identifier</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/SubscriptionTopic-FASTConsentSubscriptionTopic.json.html#:~:text=%7B%0A%20%20%20%20%20%20%22description%22%20%3A%20%22The%20identifier%20of%20one,modifier%22%20%3A%20%5B%0A%20%20%20%20%20%20%20%20%22identifier%22%0A%20%20%20%20%20%20%5D%0A%20%20%20%20%7D%2C\">https://build.fhir.org/ig/HL7/fhir-consent-management/SubscriptionTopic-FASTConsentSubscriptionTopic.json.html</a></li></ul></td></tr><tr><td><b><a name=\"630\"> </a></b>requirement-630</td><td>SHALL</td><td><div><p>Consent Administration Service SHALL support Consent notification filter 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/SubscriptionTopic-FASTConsentSubscriptionTopic.json.html#:~:text=%7B%0A%20%20%20%20%20%20%22description%22%20%3A%20%22The%20status%20of%20a%20consent.%22%2C%0A%20%20%20%20%20%20%22filterParameter%22%20%3A%20%22status%22%2C%0A%20%20%20%20%20%20%22filterDefinition%22%20%3A%20%22http%3A//hl7.org/fhir/SearchParameter/Consent%2Dstatus%22%2C%0A%20%20%20%20%20%20%22comparator%22%20%3A%20%5B%0A%20%20%20%20%20%20%20%20%22eq%22%0A%20%20%20%20%20%20%5D%0A%20%20%20%20%7D%2C\">https://build.fhir.org/ig/HL7/fhir-consent-management/SubscriptionTopic-FASTConsentSubscriptionTopic.json.html</a></li></ul></td></tr><tr><td><b><a name=\"631\"> </a></b>requirement-631</td><td>SHALL</td><td><div><p>Consent Administration Service SHALL support Consent notification filter 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/SubscriptionTopic-FASTConsentSubscriptionTopic.json.html#:~:text=%7B%0A%20%20%20%20%20%20%22description%22%20%3A%20%22The%20scope%20of%20the%20consent.%22%2C%0A%20%20%20%20%20%20%22filterParameter%22%20%3A%20%22scope%22%2C%0A%20%20%20%20%20%20%22filterDefinition%22%20%3A%20%22http%3A//hl7.org/fhir/SearchParameter/Consent%2Dscope%22%2C%0A%20%20%20%20%20%20%22comparator%22%20%3A%20%5B%0A%20%20%20%20%20%20%20%20%22eq%22%0A%20%20%20%20%20%20%5D%0A%20%20%20%20%7D\">https://build.fhir.org/ig/HL7/fhir-consent-management/SubscriptionTopic-FASTConsentSubscriptionTopic.json.html</a></li></ul></td></tr><tr><td><b><a name=\"632\"> </a></b>requirement-632</td><td>SHALL</td><td><div><p>Consent Administration Service SHALL support Consent notification filter combinations</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/SubscriptionTopic-FASTConsentSubscriptionTopic.json.html#:~:text=%7B%0A%20%20%20%20%20%20%22description%22%20%3A%20%22The%20scope%20of%20the%20consent.%22%2C%0A%20%20%20%20%20%20%22filterParameter%22%20%3A%20%22scope%22%2C%0A%20%20%20%20%20%20%22filterDefinition%22%20%3A%20%22http%3A//hl7.org/fhir/SearchParameter/Consent%2Dscope%22%2C%0A%20%20%20%20%20%20%22comparator%22%20%3A%20%5B%0A%20%20%20%20%20%20%20%20%22eq%22%0A%20%20%20%20%20%20%5D%0A%20%20%20%20%7D\">https://build.fhir.org/ig/HL7/fhir-consent-management/SubscriptionTopic-FASTConsentSubscriptionTopic.json.html</a></li></ul></td></tr><tr><td><b><a name=\"633\"> </a></b>requirement-633</td><td>MAY</td><td><div><p>Consent Administration Service MAY support Consent notification filters by search parameters not listed by FASTConsentSubscriptionTopic<br/><br/>Not going to test just yet</p>\n</div><p>Links: </p><ul><li>Derived From: <code>Subscriptions R5 Backport</code></li><li>References: <a href=\"https://hl7.org/fhir/uv/subscriptions-backport/components.html#:~:text=A%20server%20MAY%20support,parameters%20for%20best%20interoperability.\">https://hl7.org/fhir/uv/subscriptions-backport/components.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/subscriptiontopic-fastconsentsubscriptiontopic-admin-service",
"version" : "0.1.0",
"name" : "SubscriptionTopicFASTConsentSubscriptionTopicAdminService",
"title" : "SubscriptionTopic FASTConsentSubscriptionTopic 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" : "SubscriptionTopic FASTConsentSubscriptionTopic 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" : "600",
"label" : "requirement-600",
"conformance" : [
"SHALL"
],
"conditionality" : false,
"requirement" : "Consent Administration Service SHALL trigger a notification for every Consent create, unless filtered out<br/><br/>This requirement is derived by the definition in the topic plus the actual behavior defined in R5 SubscriptionTopic (which is what's linked).",
"derivedFrom" : "HL7 FHIR R5",
"parent" : "Requirements-subscriptiontopic-fastconsentsubscriptiontopic-client-admin-ser.html#requirement-596",
"reference" : [
"https://hl7.org/fhir/subscriptiontopic.html#:~:text=Subscription%20Topics%20that%20include%20create,interaction%20is%20confirmed%20to%20apply."
]
},
{
"key" : "606",
"label" : "requirement-606",
"conformance" : [
"SHALL"
],
"conditionality" : false,
"requirement" : "Consent Administration Service SHALL trigger a notification for every Consent update, unless filtered out<br/><br/>This requirement is derived by the definition in the topic plus the actual behavior defined in R5 SubscriptionTopic (which is what's linked).",
"derivedFrom" : "HL7 FHIR R5",
"parent" : "Requirements-subscriptiontopic-fastconsentsubscriptiontopic-client-admin-ser.html#requirement-596",
"reference" : [
"https://hl7.org/fhir/subscriptiontopic.html#:~:text=Subscription%20Topics%20that%20include%20update,PUT%20with%20an%20identical%20resource)."
]
},
{
"key" : "607",
"label" : "requirement-607",
"conformance" : [
"SHALL"
],
"conditionality" : false,
"requirement" : "Consent Administration Service SHALL trigger a notification for every Consent delete, unless filtered out<br/><br/>This requirement is derived by the definition in the topic plus the actual behavior defined in R5 SubscriptionTopic (which is what's linked).",
"derivedFrom" : "HL7 FHIR R5",
"parent" : "Requirements-subscriptiontopic-fastconsentsubscriptiontopic-client-admin-ser.html#requirement-596",
"reference" : [
"https://hl7.org/fhir/subscriptiontopic.html#:~:text=Subscription%20Topics%20that%20include%20delete,interaction%20is%20confirmed%20to%20apply."
]
},
{
"key" : "603",
"label" : "requirement-603",
"conformance" : [
"SHALL"
],
"conditionality" : false,
"requirement" : "Consent Administration Service SHALL support Consent notification filter by SearchParameter FASTConsentPatientId",
"derivedFrom" : "HL7 FAST Consent IG",
"parent" : "Requirements-subscriptiontopic-fastconsentsubscriptiontopic-client-admin-ser.html#requirement-596",
"reference" : [
"https://build.fhir.org/ig/HL7/fhir-consent-management/SubscriptionTopic-FASTConsentSubscriptionTopic.json.html#:~:text=%22canFilterBy%22%20%3A%20%5B%0A%20%20%20%20%7B%0A%20%20%20%20%20%20%22description%22%20%3A%20%22The%20identifier%20of%20the%20consent%20patient.%22%2C%0A%20%20%20%20%20%20%22filterParameter%22%20%3A%20%22patientId%22%2C%0A%20%20%20%20%20%20%22filterDefinition%22%20%3A%20%22http%3A//hl7.org/fhir/us/consent%2Dmanagement/SearchParameter/fast%2Dconsent%2DpatientId%22%2C%0A%20%20%20%20%20%20%22comparator%22%20%3A%20%5B%0A%20%20%20%20%20%20%20%20%22eq%22%0A%20%20%20%20%20%20%5D%0A%20%20%20%20%7D"
]
},
{
"key" : "628",
"label" : "requirement-628",
"conformance" : [
"SHALL"
],
"conditionality" : false,
"requirement" : "Consent Administration Service SHALL support Consent notification filter by SearchParameter FASTConsentOrganizationId",
"derivedFrom" : "HL7 FAST Consent IG",
"parent" : "Requirements-subscriptiontopic-fastconsentsubscriptiontopic-client-admin-ser.html#requirement-596",
"reference" : [
"https://build.fhir.org/ig/HL7/fhir-consent-management/SubscriptionTopic-FASTConsentSubscriptionTopic.json.html#:~:text=%7B%0A%20%20%20%20%20%20%22description%22%20%3A%20%22The%20identifier%20of%20the%20organization%20actor%20that%20gained%20consent.%22%2C%0A%20%20%20%20%20%20%22filterParameter%22%20%3A%20%22organizationId%22%2C%0A%20%20%20%20%20%20%22filterDefinition%22%20%3A%20%22http%3A//hl7.org/fhir/us/consent%2Dmanagement/SearchParameter/fast%2Dconsent%2DorganizationId%22%2C%0A%20%20%20%20%20%20%22comparator%22%20%3A%20%5B%0A%20%20%20%20%20%20%20%20%22eq%22%0A%20%20%20%20%20%20%5D%0A%20%20%20%20%7D%2C"
]
},
{
"key" : "629",
"label" : "requirement-629",
"conformance" : [
"SHALL"
],
"conditionality" : false,
"requirement" : "Consent Administration Service SHALL support Consent notification filter by actor identifier",
"derivedFrom" : "HL7 FAST Consent IG",
"parent" : "Requirements-subscriptiontopic-fastconsentsubscriptiontopic-client-admin-ser.html#requirement-596",
"reference" : [
"https://build.fhir.org/ig/HL7/fhir-consent-management/SubscriptionTopic-FASTConsentSubscriptionTopic.json.html#:~:text=%7B%0A%20%20%20%20%20%20%22description%22%20%3A%20%22The%20identifier%20of%20one,modifier%22%20%3A%20%5B%0A%20%20%20%20%20%20%20%20%22identifier%22%0A%20%20%20%20%20%20%5D%0A%20%20%20%20%7D%2C"
]
},
{
"key" : "630",
"label" : "requirement-630",
"conformance" : [
"SHALL"
],
"conditionality" : false,
"requirement" : "Consent Administration Service SHALL support Consent notification filter by status",
"derivedFrom" : "HL7 FAST Consent IG",
"parent" : "Requirements-subscriptiontopic-fastconsentsubscriptiontopic-client-admin-ser.html#requirement-596",
"reference" : [
"https://build.fhir.org/ig/HL7/fhir-consent-management/SubscriptionTopic-FASTConsentSubscriptionTopic.json.html#:~:text=%7B%0A%20%20%20%20%20%20%22description%22%20%3A%20%22The%20status%20of%20a%20consent.%22%2C%0A%20%20%20%20%20%20%22filterParameter%22%20%3A%20%22status%22%2C%0A%20%20%20%20%20%20%22filterDefinition%22%20%3A%20%22http%3A//hl7.org/fhir/SearchParameter/Consent%2Dstatus%22%2C%0A%20%20%20%20%20%20%22comparator%22%20%3A%20%5B%0A%20%20%20%20%20%20%20%20%22eq%22%0A%20%20%20%20%20%20%5D%0A%20%20%20%20%7D%2C"
]
},
{
"key" : "631",
"label" : "requirement-631",
"conformance" : [
"SHALL"
],
"conditionality" : false,
"requirement" : "Consent Administration Service SHALL support Consent notification filter by scope",
"derivedFrom" : "HL7 FAST Consent IG",
"parent" : "Requirements-subscriptiontopic-fastconsentsubscriptiontopic-client-admin-ser.html#requirement-596",
"reference" : [
"https://build.fhir.org/ig/HL7/fhir-consent-management/SubscriptionTopic-FASTConsentSubscriptionTopic.json.html#:~:text=%7B%0A%20%20%20%20%20%20%22description%22%20%3A%20%22The%20scope%20of%20the%20consent.%22%2C%0A%20%20%20%20%20%20%22filterParameter%22%20%3A%20%22scope%22%2C%0A%20%20%20%20%20%20%22filterDefinition%22%20%3A%20%22http%3A//hl7.org/fhir/SearchParameter/Consent%2Dscope%22%2C%0A%20%20%20%20%20%20%22comparator%22%20%3A%20%5B%0A%20%20%20%20%20%20%20%20%22eq%22%0A%20%20%20%20%20%20%5D%0A%20%20%20%20%7D"
]
},
{
"key" : "632",
"label" : "requirement-632",
"conformance" : [
"SHALL"
],
"conditionality" : false,
"requirement" : "Consent Administration Service SHALL support Consent notification filter combinations",
"derivedFrom" : "HL7 FAST Consent IG",
"parent" : "Requirements-subscriptiontopic-fastconsentsubscriptiontopic-client-admin-ser.html#requirement-596",
"reference" : [
"https://build.fhir.org/ig/HL7/fhir-consent-management/SubscriptionTopic-FASTConsentSubscriptionTopic.json.html#:~:text=%7B%0A%20%20%20%20%20%20%22description%22%20%3A%20%22The%20scope%20of%20the%20consent.%22%2C%0A%20%20%20%20%20%20%22filterParameter%22%20%3A%20%22scope%22%2C%0A%20%20%20%20%20%20%22filterDefinition%22%20%3A%20%22http%3A//hl7.org/fhir/SearchParameter/Consent%2Dscope%22%2C%0A%20%20%20%20%20%20%22comparator%22%20%3A%20%5B%0A%20%20%20%20%20%20%20%20%22eq%22%0A%20%20%20%20%20%20%5D%0A%20%20%20%20%7D"
]
},
{
"key" : "633",
"label" : "requirement-633",
"conformance" : [
"MAY"
],
"conditionality" : false,
"requirement" : "Consent Administration Service MAY support Consent notification filters by search parameters not listed by FASTConsentSubscriptionTopic<br/><br/>Not going to test just yet",
"derivedFrom" : "Subscriptions R5 Backport",
"parent" : "Requirements-subscriptiontopic-fastconsentsubscriptiontopic-client-admin-ser.html#requirement-596",
"reference" : [
"https://hl7.org/fhir/uv/subscriptions-backport/components.html#:~:text=A%20server%20MAY%20support,parameters%20for%20best%20interoperability."
]
}
]
}
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