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 |
{
"resourceType" : "Requirements",
"id" : "structure-definitions-client-consent-server",
"text" : {
"status" : "generated",
"div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p class=\"res-header-id\"><b>Generated Narrative: Requirements structure-definitions-client-consent-server</b></p><a name=\"structure-definitions-client-consent-server\"> </a><a name=\"hcstructure-definitions-client-consent-server\"> </a><p>These requirements apply to the following actors: </p><ul><li><a href=\"ActorDefinition-client.html\">Client</a></li><li><a href=\"ActorDefinition-consent-server.html\">Consent Server</a></li></ul><table class=\"grid\"><tr><td><b><a name=\"597\"> </a></b>requirement-597</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>StructureDefinition FASTConsent<br/><br/>Many nested profiles/requirements, including from US Core. Most will be checked by validator, so no need to capture. But I will capture Must Support requirements.</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/en/StructureDefinition-FASTConsent.html#root\">https://build.fhir.org/ig/HL7/fhir-consent-management/en/StructureDefinition-FASTConsent.html</a>, <a href=\"https://build.fhir.org/ig/HL7/fhir-consent-management/en/StructureDefinition-FASTConsent.html#root\">https://build.fhir.org/ig/HL7/fhir-consent-management/en/StructureDefinition-FASTConsent.html</a></li></ul></td></tr><tr><td><b><a name=\"598\"> </a></b>requirement-598</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>StructureDefinition FASTConsentAuditEvent<br/><br/>Many nested profiles, including from US Core. Will be checked by validator.</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/en/StructureDefinition-FASTConsentAuditEvent.html#root\">https://build.fhir.org/ig/HL7/fhir-consent-management/en/StructureDefinition-FASTConsentAuditEvent.html</a>, <a href=\"https://build.fhir.org/ig/HL7/fhir-consent-management/en/StructureDefinition-FASTConsentAuditEvent.html#root\">https://build.fhir.org/ig/HL7/fhir-consent-management/en/StructureDefinition-FASTConsentAuditEvent.html</a></li></ul></td></tr><tr><td><b><a name=\"599\"> </a></b>requirement-599</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>StructureDefinition FASTDocumentReference<br/><br/>Many nested profiles, including from US Core. Will be checked by validator.</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/en/StructureDefinition-FASTDocumentReference.html#root\">https://build.fhir.org/ig/HL7/fhir-consent-management/en/StructureDefinition-FASTDocumentReference.html</a>, <a href=\"https://build.fhir.org/ig/HL7/fhir-consent-management/en/StructureDefinition-FASTDocumentReference.html#root\">https://build.fhir.org/ig/HL7/fhir-consent-management/en/StructureDefinition-FASTDocumentReference.html</a></li></ul></td></tr><tr><td><b><a name=\"477\"> </a></b>requirement-477</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>StructureDefinition FASTSubscription<br/><br/>The constraint that status is always "active" might not make sense. I think the client is supposed to POST it as "requested".</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/en/StructureDefinition-FASTSubscription.html#root\">https://build.fhir.org/ig/HL7/fhir-consent-management/en/StructureDefinition-FASTSubscription.html</a>, <a href=\"https://build.fhir.org/ig/HL7/fhir-consent-management/en/StructureDefinition-FASTSubscription.html#root\">https://build.fhir.org/ig/HL7/fhir-consent-management/en/StructureDefinition-FASTSubscription.html</a></li></ul></td></tr><tr><td><b><a name=\"601\"> </a></b>requirement-601</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>StructureDefinition FASTReference<br/><br/>Many nested profiles, including from US Core. Will be checked by validator.</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/en/StructureDefinition-FASTReference.html#root\">https://build.fhir.org/ig/HL7/fhir-consent-management/en/StructureDefinition-FASTReference.html</a>, <a href=\"https://build.fhir.org/ig/HL7/fhir-consent-management/en/StructureDefinition-FASTReference.html#root\">https://build.fhir.org/ig/HL7/fhir-consent-management/en/StructureDefinition-FASTReference.html</a></li></ul></td></tr><tr><td><b><a name=\"464\"> </a></b>requirement-464</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>StructureDefinition FileConsentParameters</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/en/StructureDefinition-FileConsentParameters.html#root\">https://build.fhir.org/ig/HL7/fhir-consent-management/en/StructureDefinition-FileConsentParameters.html</a>, <a href=\"https://build.fhir.org/ig/HL7/fhir-consent-management/en/StructureDefinition-FileConsentParameters.html#root\">https://build.fhir.org/ig/HL7/fhir-consent-management/en/StructureDefinition-FileConsentParameters.html</a></li></ul></td></tr><tr><td><b><a name=\"70\"> </a></b>requirement-70</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>The FileConsent operation "consent" input parameter SHALL be 1..1 and conform to the FASTConsent profile</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/en/StructureDefinition-FileConsentParameters.html#:~:text=parameter%3Aconsent,1..1&text=Required%20Pattern%3A%20consent-,resource,FASTConsent,-A%20healthcare%20consumer%27s\">https://build.fhir.org/ig/HL7/fhir-consent-management/en/StructureDefinition-FileConsentParameters.html</a></li></ul></td></tr><tr><td><b><a name=\"430\"> </a></b>requirement-430</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>The FileConsent operation "document" input parameter SHALL be 1..1 and conform to either the us-core-questionnaireresponse or FASTDocumentReference profile</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/en/StructureDefinition-FileConsentParameters.html#:~:text=parameter%3Adocument,1..1&text=Required%20Pattern%3A%20document-,resource,FASTDocumentReference%2C%20USCoreQuestionnaireResponseProfile,-A%20reference%20to\">https://build.fhir.org/ig/HL7/fhir-consent-management/en/StructureDefinition-FileConsentParameters.html</a></li></ul></td></tr><tr><td><b><a name=\"469\"> </a></b>requirement-469</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>StructureDefinition RevokeConsentParameters</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/en/StructureDefinition-RevokeConsentParameters.html#root\">https://build.fhir.org/ig/HL7/fhir-consent-management/en/StructureDefinition-RevokeConsentParameters.html</a>, <a href=\"https://build.fhir.org/ig/HL7/fhir-consent-management/en/StructureDefinition-RevokeConsentParameters.html#root\">https://build.fhir.org/ig/HL7/fhir-consent-management/en/StructureDefinition-RevokeConsentParameters.html</a></li></ul></td></tr><tr><td><b><a name=\"595\"> </a></b>requirement-595</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>StructureDefinition BackportSubscription</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/STU1.1/StructureDefinition-backport-subscription.html#root\">https://hl7.org/fhir/uv/subscriptions-backport/STU1.1/StructureDefinition-backport-subscription.html</a>, <a href=\"https://hl7.org/fhir/uv/subscriptions-backport/STU1.1/StructureDefinition-backport-subscription.html#root\">https://hl7.org/fhir/uv/subscriptions-backport/STU1.1/StructureDefinition-backport-subscription.html</a></li></ul></td></tr><tr><td><b><a name=\"892\"> </a></b>requirement-892</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>StructureDefinition R4 Topic-Based Subscription Notification Bundle</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/STU1.1/StructureDefinition-backport-subscription-notification-r4.html#root\">https://hl7.org/fhir/uv/subscriptions-backport/STU1.1/StructureDefinition-backport-subscription-notification-r4.html</a>, <a href=\"https://hl7.org/fhir/uv/subscriptions-backport/STU1.1/StructureDefinition-backport-subscription-notification-r4.html#root\">https://hl7.org/fhir/uv/subscriptions-backport/STU1.1/StructureDefinition-backport-subscription-notification-r4.html</a></li></ul></td></tr><tr><td><b><a name=\"893\"> </a></b>requirement-893</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>StructureDefinition R4 Backported R5 SubscriptionStatus</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/STU1.1/StructureDefinition-backport-subscription-status-r4.html#root\">https://hl7.org/fhir/uv/subscriptions-backport/STU1.1/StructureDefinition-backport-subscription-status-r4.html</a>, <a href=\"https://hl7.org/fhir/uv/subscriptions-backport/STU1.1/StructureDefinition-backport-subscription-status-r4.html#root\">https://hl7.org/fhir/uv/subscriptions-backport/STU1.1/StructureDefinition-backport-subscription-status-r4.html</a></li></ul></td></tr><tr><td><b><a name=\"535\"> </a></b>requirement-535</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>ValueSet BackportContentValueSet<br/><br/>This cannot be fully tested for a given system unless we know its specific requirements, but we can hit it with each content level as an exploratory test.</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/STU1.1/ValueSet-backport-content-value-set.html#root\">https://hl7.org/fhir/uv/subscriptions-backport/STU1.1/ValueSet-backport-content-value-set.html</a>, <a href=\"https://hl7.org/fhir/uv/subscriptions-backport/STU1.1/ValueSet-backport-content-value-set.html#root\">https://hl7.org/fhir/uv/subscriptions-backport/STU1.1/ValueSet-backport-content-value-set.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/structure-definitions-client-consent-server",
"version" : "1.0.0-preview",
"name" : "StructureDefinitionsClientConsentServer",
"title" : "Structure Definitions Client Consent Server",
"status" : "active",
"experimental" : false,
"date" : "2026-09-02T22:40:54-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/homehealth"
}
]
}
],
"description" : "Structure Definitions Requirements for Client Consent Server",
"jurisdiction" : [
{
"coding" : [
{
"system" : "urn:iso:std:iso:3166",
"code" : "US",
"display" : "United States of America"
}
]
}
],
"actor" : [
🔗 "http://hl7.org/fhir/us/consent-management/ActorDefinition/client"🔗 ,
"http://hl7.org/fhir/us/consent-management/ActorDefinition/consent-server"
],
"statement" : [
{
"key" : "597",
"label" : "requirement-597",
"conformance" : [
"SHALL"
],
"conditionality" : false,
"requirement" : "StructureDefinition FASTConsent<br/><br/>Many nested profiles/requirements, including from US Core. Most will be checked by validator, so no need to capture. But I will capture Must Support requirements.",
"derivedFrom" : "HL7 FAST Consent IG",
"reference" : [
"https://build.fhir.org/ig/HL7/fhir-consent-management/en/StructureDefinition-FASTConsent.html#root",
"https://build.fhir.org/ig/HL7/fhir-consent-management/en/StructureDefinition-FASTConsent.html#root"
]
},
{
"key" : "598",
"label" : "requirement-598",
"conformance" : [
"SHALL"
],
"conditionality" : false,
"requirement" : "StructureDefinition FASTConsentAuditEvent<br/><br/>Many nested profiles, including from US Core. Will be checked by validator.",
"derivedFrom" : "HL7 FAST Consent IG",
"reference" : [
"https://build.fhir.org/ig/HL7/fhir-consent-management/en/StructureDefinition-FASTConsentAuditEvent.html#root",
"https://build.fhir.org/ig/HL7/fhir-consent-management/en/StructureDefinition-FASTConsentAuditEvent.html#root"
]
},
{
"key" : "599",
"label" : "requirement-599",
"conformance" : [
"SHALL"
],
"conditionality" : false,
"requirement" : "StructureDefinition FASTDocumentReference<br/><br/>Many nested profiles, including from US Core. Will be checked by validator.",
"derivedFrom" : "HL7 FAST Consent IG",
"reference" : [
"https://build.fhir.org/ig/HL7/fhir-consent-management/en/StructureDefinition-FASTDocumentReference.html#root",
"https://build.fhir.org/ig/HL7/fhir-consent-management/en/StructureDefinition-FASTDocumentReference.html#root"
]
},
{
"key" : "477",
"label" : "requirement-477",
"conformance" : [
"SHALL"
],
"conditionality" : false,
"requirement" : "StructureDefinition FASTSubscription<br/><br/>The constraint that status is always \"active\" might not make sense. I think the client is supposed to POST it as \"requested\".",
"derivedFrom" : "HL7 FAST Consent IG",
"reference" : [
"https://build.fhir.org/ig/HL7/fhir-consent-management/en/StructureDefinition-FASTSubscription.html#root",
"https://build.fhir.org/ig/HL7/fhir-consent-management/en/StructureDefinition-FASTSubscription.html#root"
]
},
{
"key" : "601",
"label" : "requirement-601",
"conformance" : [
"SHALL"
],
"conditionality" : false,
"requirement" : "StructureDefinition FASTReference<br/><br/>Many nested profiles, including from US Core. Will be checked by validator.",
"derivedFrom" : "HL7 FAST Consent IG",
"reference" : [
"https://build.fhir.org/ig/HL7/fhir-consent-management/en/StructureDefinition-FASTReference.html#root",
"https://build.fhir.org/ig/HL7/fhir-consent-management/en/StructureDefinition-FASTReference.html#root"
]
},
{
"key" : "464",
"label" : "requirement-464",
"conformance" : [
"SHALL"
],
"conditionality" : false,
"requirement" : "StructureDefinition FileConsentParameters",
"derivedFrom" : "HL7 FAST Consent IG",
"reference" : [
"https://build.fhir.org/ig/HL7/fhir-consent-management/en/StructureDefinition-FileConsentParameters.html#root",
"https://build.fhir.org/ig/HL7/fhir-consent-management/en/StructureDefinition-FileConsentParameters.html#root"
]
},
{
"key" : "70",
"label" : "requirement-70",
"conformance" : [
"SHALL"
],
"conditionality" : false,
"requirement" : "The FileConsent operation \"consent\" input parameter SHALL be 1..1 and conform to the FASTConsent profile",
"derivedFrom" : "HL7 FAST Consent IG",
"parent" : "Requirements-structure-definitions-client-consent-server.html#requirement-464",
"reference" : [
"https://build.fhir.org/ig/HL7/fhir-consent-management/en/StructureDefinition-FileConsentParameters.html#:~:text=parameter%3Aconsent,1..1&text=Required%20Pattern%3A%20consent-,resource,FASTConsent,-A%20healthcare%20consumer%27s"
]
},
{
"key" : "430",
"label" : "requirement-430",
"conformance" : [
"SHALL"
],
"conditionality" : false,
"requirement" : "The FileConsent operation \"document\" input parameter SHALL be 1..1 and conform to either the us-core-questionnaireresponse or FASTDocumentReference profile",
"derivedFrom" : "HL7 FAST Consent IG",
"parent" : "Requirements-structure-definitions-client-consent-server.html#requirement-464",
"reference" : [
"https://build.fhir.org/ig/HL7/fhir-consent-management/en/StructureDefinition-FileConsentParameters.html#:~:text=parameter%3Adocument,1..1&text=Required%20Pattern%3A%20document-,resource,FASTDocumentReference%2C%20USCoreQuestionnaireResponseProfile,-A%20reference%20to"
]
},
{
"key" : "469",
"label" : "requirement-469",
"conformance" : [
"SHALL"
],
"conditionality" : false,
"requirement" : "StructureDefinition RevokeConsentParameters",
"derivedFrom" : "HL7 FAST Consent IG",
"reference" : [
"https://build.fhir.org/ig/HL7/fhir-consent-management/en/StructureDefinition-RevokeConsentParameters.html#root",
"https://build.fhir.org/ig/HL7/fhir-consent-management/en/StructureDefinition-RevokeConsentParameters.html#root"
]
},
{
"key" : "595",
"label" : "requirement-595",
"conformance" : [
"SHALL"
],
"conditionality" : false,
"requirement" : "StructureDefinition BackportSubscription",
"derivedFrom" : "Subscriptions R5 Backport",
"reference" : [
"https://hl7.org/fhir/uv/subscriptions-backport/STU1.1/StructureDefinition-backport-subscription.html#root",
"https://hl7.org/fhir/uv/subscriptions-backport/STU1.1/StructureDefinition-backport-subscription.html#root"
]
},
{
"key" : "892",
"label" : "requirement-892",
"conformance" : [
"SHALL"
],
"conditionality" : false,
"requirement" : "StructureDefinition R4 Topic-Based Subscription Notification Bundle",
"derivedFrom" : "Subscriptions R5 Backport",
"reference" : [
"https://hl7.org/fhir/uv/subscriptions-backport/STU1.1/StructureDefinition-backport-subscription-notification-r4.html#root",
"https://hl7.org/fhir/uv/subscriptions-backport/STU1.1/StructureDefinition-backport-subscription-notification-r4.html#root"
]
},
{
"key" : "893",
"label" : "requirement-893",
"conformance" : [
"SHALL"
],
"conditionality" : false,
"requirement" : "StructureDefinition R4 Backported R5 SubscriptionStatus",
"derivedFrom" : "Subscriptions R5 Backport",
"reference" : [
"https://hl7.org/fhir/uv/subscriptions-backport/STU1.1/StructureDefinition-backport-subscription-status-r4.html#root",
"https://hl7.org/fhir/uv/subscriptions-backport/STU1.1/StructureDefinition-backport-subscription-status-r4.html#root"
]
},
{
"key" : "535",
"label" : "requirement-535",
"conformance" : [
"SHALL"
],
"conditionality" : false,
"requirement" : "ValueSet BackportContentValueSet<br/><br/>This cannot be fully tested for a given system unless we know its specific requirements, but we can hit it with each content level as an exploratory test.",
"derivedFrom" : "Subscriptions R5 Backport",
"reference" : [
"https://hl7.org/fhir/uv/subscriptions-backport/STU1.1/ValueSet-backport-content-value-set.html#root",
"https://hl7.org/fhir/uv/subscriptions-backport/STU1.1/ValueSet-backport-content-value-set.html#root"
]
}
]
}
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