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
Requirements Actor(s)
These requirements apply to the following actors:
Consent Server An application or product that implements the Consent Server.
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).
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).
"},"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/5.0/StructureDefinition/extension-Requirements.url","valueUri":"http://hl7.org/fhir/us/consent-management/Requirements/subscription-topics-consent-server"},{"url":"http://hl7.org/fhir/5.0/StructureDefinition/extension-Requirements.version","valueString":"1.0.0-preview"},{"url":"http://hl7.org/fhir/5.0/StructureDefinition/extension-Requirements.name","valueString":"SubscriptionTopicsConsentServer"},{"url":"http://hl7.org/fhir/5.0/StructureDefinition/extension-Requirements.title","valueString":"Subscription Topics Consent Server"},{"url":"http://hl7.org/fhir/5.0/StructureDefinition/extension-Requirements.status","valueCode":"active"},{"url":"http://hl7.org/fhir/5.0/StructureDefinition/extension-Requirements.experimental","valueBoolean":false},{"url":"http://hl7.org/fhir/5.0/StructureDefinition/extension-Requirements.date","valueDateTime":"2026-09-02T22:40:54-04:00"},{"url":"http://hl7.org/fhir/5.0/StructureDefinition/extension-Requirements.publisher","valueString":"HL7 International / Community Based Collaborative Care"},{"url":"http://hl7.org/fhir/5.0/StructureDefinition/extension-Requirements.contact","valueContactDetail":{"name":"HL7 International / Community Based Collaborative Care","telecom":[{"system":"url","value":"http://www.hl7.org/Special/committees/homehealth"}]}},{"url":"http://hl7.org/fhir/5.0/StructureDefinition/extension-Requirements.description","valueMarkdown":"Subscription Topics Requirements for Consent Server"},{"url":"http://hl7.org/fhir/5.0/StructureDefinition/extension-Requirements.jurisdiction","valueCodeableConcept":{"coding":[{"system":"urn:iso:std:iso:3166","code":"US","display":"United States of America"}]}},{"url":"http://hl7.org/fhir/5.0/StructureDefinition/extension-Requirements.actor","valueCanonical":"http://hl7.org/fhir/us/consent-management/ActorDefinition/consent-server"},{"extension":[{"url":"http://hl7.org/fhir/5.0/StructureDefinition/extension-Requirements.statement.key","valueId":"1174"},{"url":"http://hl7.org/fhir/5.0/StructureDefinition/extension-Requirements.statement.label","valueString":"requirement-1174"},{"url":"http://hl7.org/fhir/5.0/StructureDefinition/extension-Requirements.statement.conformance","valueCode":"SHALL"},{"url":"http://hl7.org/fhir/5.0/StructureDefinition/extension-Requirements.statement.requirement","valueMarkdown":"Consent Administration Service SHALL support Consent notification triggers based on create and update
build: replaced requirement 1090"},{"url":"http://hl7.org/fhir/5.0/StructureDefinition/extension-Requirements.statement.derivedFrom","valueString":"HL7 FAST Consent IG"},{"url":"http://hl7.org/fhir/5.0/StructureDefinition/extension-Requirements.statement.satisfiedBy","valueUrl":"https://build.fhir.org/ig/HL7/fhir-consent-management/en/SubscriptionTopic-FASTConsentSubscriptionTopic.json.html#:~:text=%22resourceTrigger%22%20%3A%20%5B%0A%20%20%20%20%7B%0A%20%20%20%20%20%20%22description%22%20%3A%20%22When%20a%20consent%20record%20has%20been%20%27touched%27%20and%20needs%20to%20be%20distributed%20amongst%20interested%20parties.%22%2C%0A%20%20%20%20%20%20%22resource%22%20%3A%20%22http%3A//hl7.org/fhir/StructureDefinition/Consent%22%2C%0A%20%20%20%20%20%20%22supportedInteraction%22%20%3A%20%5B%0A%20%20%20%20%20%20%20%20%22create%22%2C%0A%20%20%20%20%20%20%20%20%22update%22"}],"url":"http://hl7.org/fhir/5.0/StructureDefinition/extension-Requirements.statement"},{"extension":[{"url":"http://hl7.org/fhir/5.0/StructureDefinition/extension-Requirements.statement.key","valueId":"1175"},{"url":"http://hl7.org/fhir/5.0/StructureDefinition/extension-Requirements.statement.label","valueString":"requirement-1175"},{"url":"http://hl7.org/fhir/5.0/StructureDefinition/extension-Requirements.statement.conformance","valueCode":"SHALL"},{"url":"http://hl7.org/fhir/5.0/StructureDefinition/extension-Requirements.statement.requirement","valueMarkdown":"Consent Administration Service SHALL support Consent notification filter by patient identifier"},{"url":"http://hl7.org/fhir/5.0/StructureDefinition/extension-Requirements.statement.derivedFrom","valueString":"HL7 FAST Consent IG"},{"url":"http://hl7.org/fhir/5.0/StructureDefinition/extension-Requirements.statement.satisfiedBy","valueUrl":"https://build.fhir.org/ig/HL7/fhir-consent-management/en/SubscriptionTopic-FASTConsentSubscriptionTopic.json.html#:~:text=create%22%2C%0A%20%20%20%20%20%20%20%20%22update%22%0A%20%20%20%20%20%20%5D%0A%20%20%20%20%7D%0A%20%20%5D%2C%0A%20%20%22canFilterBy%22%20%3A%20%5B%0A%20%20%20%20%7B-,%22description%22%20%3A%20%22The%20patient%20whose,comparator%22%20%3A%20%5B%0A%20%20%20%20%20%20%20%20%22eq%22%0A%20%20%20%20%20%20%5D%2C%0A%20%20%20%20%20%20%22modifier%22%20%3A%20%5B%0A%20%20%20%20%20%20%20%20%22identifier%22%0A%20%20%20%20%20%20%5D"}],"url":"http://hl7.org/fhir/5.0/StructureDefinition/extension-Requirements.statement"},{"extension":[{"url":"http://hl7.org/fhir/5.0/StructureDefinition/extension-Requirements.statement.key","valueId":"1177"},{"url":"http://hl7.org/fhir/5.0/StructureDefinition/extension-Requirements.statement.label","valueString":"requirement-1177"},{"url":"http://hl7.org/fhir/5.0/StructureDefinition/extension-Requirements.statement.conformance","valueCode":"SHALL"},{"url":"http://hl7.org/fhir/5.0/StructureDefinition/extension-Requirements.statement.requirement","valueMarkdown":"Consent Administration Service SHALL support Consent notification filter by controller identifier"},{"url":"http://hl7.org/fhir/5.0/StructureDefinition/extension-Requirements.statement.derivedFrom","valueString":"HL7 FAST Consent IG"},{"url":"http://hl7.org/fhir/5.0/StructureDefinition/extension-Requirements.statement.satisfiedBy","valueUrl":"https://build.fhir.org/ig/HL7/fhir-consent-management/en/SubscriptionTopic-FASTConsentSubscriptionTopic.json.html#:~:text=eq%22%0A%20%20%20%20%20%20%5D%2C%0A%20%20%20%20%20%20%22modifier%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%0A%20%20%20%20%7B-,%22description%22%20%3A%20%22The%20controller%20of,comparator%22%20%3A%20%5B%0A%20%20%20%20%20%20%20%20%22eq%22%0A%20%20%20%20%20%20%5D%2C%0A%20%20%20%20%20%20%22modifier%22%20%3A%20%5B%0A%20%20%20%20%20%20%20%20%22identifier%22%0A%20%20%20%20%20%20%5D"}],"url":"http://hl7.org/fhir/5.0/StructureDefinition/extension-Requirements.statement"},{"extension":[{"url":"http://hl7.org/fhir/5.0/StructureDefinition/extension-Requirements.statement.key","valueId":"629"},{"url":"http://hl7.org/fhir/5.0/StructureDefinition/extension-Requirements.statement.label","valueString":"requirement-629"},{"url":"http://hl7.org/fhir/5.0/StructureDefinition/extension-Requirements.statement.conformance","valueCode":"SHALL"},{"url":"http://hl7.org/fhir/5.0/StructureDefinition/extension-Requirements.statement.requirement","valueMarkdown":"Consent Administration Service SHALL support Consent notification filter by actor identifier"},{"url":"http://hl7.org/fhir/5.0/StructureDefinition/extension-Requirements.statement.derivedFrom","valueString":"HL7 FAST Consent IG"},{"url":"http://hl7.org/fhir/5.0/StructureDefinition/extension-Requirements.statement.satisfiedBy","valueUrl":"https://build.fhir.org/ig/HL7/fhir-consent-management/en/SubscriptionTopic-FASTConsentSubscriptionTopic.json.html#:~:text=%22description%22%20%3A%20%22The%20identifier%20of%20one%20of%20the%20actors%20that%20is%20controlled%20by%20a%20consent.%22%2C%0A%20%20%20%20%20%20%22filterParameter%22%20%3A%20%22actor%22%2C%0A%20%20%20%20%20%20%22filterDefinition%22%20%3A%20%22http%3A//hl7.org/fhir/SearchParameter/Consent%2Dactor%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%2C%0A%20%20%20%20%20%20%22modifier%22%20%3A%20%5B%0A%20%20%20%20%20%20%20%20%22identifier%22"}],"url":"http://hl7.org/fhir/5.0/StructureDefinition/extension-Requirements.statement"},{"extension":[{"url":"http://hl7.org/fhir/5.0/StructureDefinition/extension-Requirements.statement.key","valueId":"630"},{"url":"http://hl7.org/fhir/5.0/StructureDefinition/extension-Requirements.statement.label","valueString":"requirement-630"},{"url":"http://hl7.org/fhir/5.0/StructureDefinition/extension-Requirements.statement.conformance","valueCode":"SHALL"},{"url":"http://hl7.org/fhir/5.0/StructureDefinition/extension-Requirements.statement.requirement","valueMarkdown":"Consent Administration Service SHALL support Consent notification filter by status"},{"url":"http://hl7.org/fhir/5.0/StructureDefinition/extension-Requirements.statement.derivedFrom","valueString":"HL7 FAST Consent IG"},{"url":"http://hl7.org/fhir/5.0/StructureDefinition/extension-Requirements.statement.satisfiedBy","valueUrl":"https://build.fhir.org/ig/HL7/fhir-consent-management/en/SubscriptionTopic-FASTConsentSubscriptionTopic.json.html#:~:text=%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"}],"url":"http://hl7.org/fhir/5.0/StructureDefinition/extension-Requirements.statement"},{"extension":[{"url":"http://hl7.org/fhir/5.0/StructureDefinition/extension-Requirements.statement.key","valueId":"1179"},{"url":"http://hl7.org/fhir/5.0/StructureDefinition/extension-Requirements.statement.label","valueString":"requirement-1179"},{"url":"http://hl7.org/fhir/5.0/StructureDefinition/extension-Requirements.statement.conformance","valueCode":"SHALL"},{"url":"http://hl7.org/fhir/5.0/StructureDefinition/extension-Requirements.statement.requirement","valueMarkdown":"Consent Administration Service SHALL support Consent notification filter by category"},{"url":"http://hl7.org/fhir/5.0/StructureDefinition/extension-Requirements.statement.derivedFrom","valueString":"HL7 FAST Consent IG"},{"url":"http://hl7.org/fhir/5.0/StructureDefinition/extension-Requirements.statement.satisfiedBy","valueUrl":"https://build.fhir.org/ig/HL7/fhir-consent-management/en/SubscriptionTopic-FASTConsentSubscriptionTopic.json.html#:~:text=%22description%22%20%3A%20%22the%20category%20of%20the%20consent.%22%2C%20%22filterparameter%22%20%3A%20%22category%22%2C%20%22filterdefinition%22%20%3A%20%22http%3A//hl7.org/fhir/searchparameter/consent%2Dcategory%22%2C%20%22comparator%22%20%3A%20%5B%20%22eq%22%20%5D"}],"url":"http://hl7.org/fhir/5.0/StructureDefinition/extension-Requirements.statement"},{"extension":[{"url":"http://hl7.org/fhir/5.0/StructureDefinition/extension-Requirements.statement.key","valueId":"600"},{"url":"http://hl7.org/fhir/5.0/StructureDefinition/extension-Requirements.statement.label","valueString":"requirement-600"},{"url":"http://hl7.org/fhir/5.0/StructureDefinition/extension-Requirements.statement.conformance","valueCode":"SHALL"},{"url":"http://hl7.org/fhir/5.0/StructureDefinition/extension-Requirements.statement.requirement","valueMarkdown":"Consent Administration Service SHALL trigger a notification for every Consent create, unless filtered out
This requirement is derived by the definition in the topic plus the actual behavior defined in R5 SubscriptionTopic (which is what's linked)."},{"url":"http://hl7.org/fhir/5.0/StructureDefinition/extension-Requirements.statement.derivedFrom","valueString":"HL7 FHIR R5"},{"url":"http://hl7.org/fhir/5.0/StructureDefinition/extension-Requirements.statement.satisfiedBy","valueUrl":"https://hl7.org/fhir/subscriptiontopic.html#:~:text=Subscription%20Topics%20that%20include%20create,interaction%20is%20confirmed%20to%20apply."}],"url":"http://hl7.org/fhir/5.0/StructureDefinition/extension-Requirements.statement"},{"extension":[{"url":"http://hl7.org/fhir/5.0/StructureDefinition/extension-Requirements.statement.key","valueId":"606"},{"url":"http://hl7.org/fhir/5.0/StructureDefinition/extension-Requirements.statement.label","valueString":"requirement-606"},{"url":"http://hl7.org/fhir/5.0/StructureDefinition/extension-Requirements.statement.conformance","valueCode":"SHALL"},{"url":"http://hl7.org/fhir/5.0/StructureDefinition/extension-Requirements.statement.requirement","valueMarkdown":"Consent Administration Service SHALL trigger a notification for every Consent update, unless filtered out
This requirement is derived by the definition in the topic plus the actual behavior defined in R5 SubscriptionTopic (which is what's linked)."},{"url":"http://hl7.org/fhir/5.0/StructureDefinition/extension-Requirements.statement.derivedFrom","valueString":"HL7 FHIR R5"},{"url":"http://hl7.org/fhir/5.0/StructureDefinition/extension-Requirements.statement.satisfiedBy","valueUrl":"https://hl7.org/fhir/subscriptiontopic.html#:~:text=Subscription%20Topics%20that%20include%20update,PUT%20with%20an%20identical%20resource%29."}],"url":"http://hl7.org/fhir/5.0/StructureDefinition/extension-Requirements.statement"}],"code":{"coding":[{"system":"http://hl7.org/fhir/fhir-types","code":"Requirements"}]}}
]]>
|
Propose a change