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" : "extended-operations-client-consent-server",
"text" : {
"status" : "generated",
"div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p class=\"res-header-id\"><b>Generated Narrative: Requirements extended-operations-client-consent-server</b></p><a name=\"extended-operations-client-consent-server\"> </a><a name=\"hcextended-operations-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=\"463\"> </a></b>requirement-463</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>OperationDefinition FileConsent</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/OperationDefinition-file-consent.html#root\">https://build.fhir.org/ig/HL7/fhir-consent-management/en/OperationDefinition-file-consent.html</a>, <a href=\"https://build.fhir.org/ig/HL7/fhir-consent-management/en/OperationDefinition-file-consent.html#root\">https://build.fhir.org/ig/HL7/fhir-consent-management/en/OperationDefinition-file-consent.html</a></li></ul></td></tr><tr><td><b><a name=\"133\"> </a></b>requirement-133</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 is invoked as [base]/Consent/$fileConsent</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/OperationDefinition-file-consent.html#:~:text=URL%3A%20%5Bbase%5D/Consent/%24fileConsent\">https://build.fhir.org/ig/HL7/fhir-consent-management/en/OperationDefinition-file-consent.html</a></li></ul></td></tr><tr><td><b><a name=\"134\"> </a></b>requirement-134</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 input parameters SHALL conform to the FileConsentParameters profile<br/><br/>For the most part, I'm not going to trace to everything in StructDefs, because the FHIR validator will check these. We may revisit this decision.</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/OperationDefinition-file-consent.json.html#:~:text=%22inputProfile%22%20%3A%20%22http%3A//hl7.org/fhir/us/consent%2Dmanagement/StructureDefinition/fileConsentParameters%22\">https://build.fhir.org/ig/HL7/fhir-consent-management/en/OperationDefinition-file-consent.json.html</a></li></ul></td></tr><tr><td><b><a name=\"135\"> </a></b>requirement-135</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 a Consent resource</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/OperationDefinition-file-consent.json.html#:~:text=%22name%22%20%3A%20%22consent%22%2C%0A%20%20%20%20%20%20%22use%22%20%3A%20%22in%22%2C%0A%20%20%20%20%20%20%22min%22%20%3A%201%2C%0A%20%20%20%20%20%20%22max%22%20%3A%20%221%22%2C%0A%20%20%20%20%20%20%22documentation%22%20%3A%20%22The%20Consent%20instance%20to%20file%20%28see%20Input%20Parameters%20Profile%20for%20conformance%29%22%2C%0A%20%20%20%20%20%20%22type%22%20%3A%20%22Consent%22\">https://build.fhir.org/ig/HL7/fhir-consent-management/en/OperationDefinition-file-consent.json.html</a></li></ul></td></tr><tr><td><b><a name=\"166\"> </a></b>requirement-166</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 any resource</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/OperationDefinition-file-consent.json.html#:~:text=%22name%22%20%3A%20%22document%22%2C%0A%20%20%20%20%20%20%22use%22%20%3A%20%22in%22%2C%0A%20%20%20%20%20%20%22min%22%20%3A%201%2C%0A%20%20%20%20%20%20%22max%22%20%3A%20%221%22%2C%0A%20%20%20%20%20%20%22documentation%22%20%3A%20%22Accompanying%20documentation%20for%20the%20Consent%20in%20the%20form%20of%20a%20DocumentReference%20or%20QuestionnaireResponse%20%28see%20Input%20Parameters%20Profile%20for%20conformance%29%22%2C%0A%20%20%20%20%20%20%22type%22%20%3A%20%22Resource%22\">https://build.fhir.org/ig/HL7/fhir-consent-management/en/OperationDefinition-file-consent.json.html</a></li></ul></td></tr><tr><td><b><a name=\"168\"> </a></b>requirement-168</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 "return" output parameter SHALL be 0..1 and be an OperationOutcome<br/><br/>Note no defined way to return Consent ID</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/OperationDefinition-file-consent.json.html#:~:text=%22name%22%20%3A%20%22return%22%2C%0A%20%20%20%20%20%20%22use%22%20%3A%20%22out%22%2C%0A%20%20%20%20%20%20%22min%22%20%3A%200%2C%0A%20%20%20%20%20%20%22max%22%20%3A%20%221%22%2C%0A%20%20%20%20%20%20%22documentation%22%20%3A%20%22Optional%20outcome%20of%20the%20operation%20call%22%2C%0A%20%20%20%20%20%20%22type%22%20%3A%20%22OperationOutcome%22\">https://build.fhir.org/ig/HL7/fhir-consent-management/en/OperationDefinition-file-consent.json.html</a></li></ul></td></tr><tr><td><b><a name=\"466\"> </a></b>requirement-466</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>OperationDefinition RevokeConsent</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/OperationDefinition-revoke-consent.html#root\">https://build.fhir.org/ig/HL7/fhir-consent-management/en/OperationDefinition-revoke-consent.html</a>, <a href=\"https://build.fhir.org/ig/HL7/fhir-consent-management/en/OperationDefinition-revoke-consent.html#root\">https://build.fhir.org/ig/HL7/fhir-consent-management/en/OperationDefinition-revoke-consent.html</a></li></ul></td></tr><tr><td><b><a name=\"438\"> </a></b>requirement-438</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 RevokeConsent operation is invoked as [base]/Consent/$revokeConsent</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/OperationDefinition-revoke-consent.html#:~:text=URL%3A%20%5Bbase%5D/Consent/%24revokeConsent\">https://build.fhir.org/ig/HL7/fhir-consent-management/en/OperationDefinition-revoke-consent.html</a></li></ul></td></tr><tr><td><b><a name=\"439\"> </a></b>requirement-439</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 RevokeConsent operation input parameters SHALL conform to the RevokeConsentParameters 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/OperationDefinition-revoke-consent.json.html#:~:text=%22inputProfile%22%20%3A%20%22http%3A//hl7.org/fhir/us/consent%2Dmanagement/StructureDefinition/RevokeConsentParameters%22\">https://build.fhir.org/ig/HL7/fhir-consent-management/en/OperationDefinition-revoke-consent.json.html</a></li></ul></td></tr><tr><td><b><a name=\"444\"> </a></b>requirement-444</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 RevokeConsent operation "return" output parameter SHALL be 0..1 and be an OperationOutcome</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/OperationDefinition-revoke-consent.json.html#:~:text=%22name%22%20%3A%20%22return%22%2C%0A%20%20%20%20%20%20%22use%22%20%3A%20%22out%22%2C%0A%20%20%20%20%20%20%22min%22%20%3A%200%2C%0A%20%20%20%20%20%20%22max%22%20%3A%20%221%22%2C%0A%20%20%20%20%20%20%22documentation%22%20%3A%20%22Optional%20outcome%20of%20the%20operation%20call%22%2C%0A%20%20%20%20%20%20%22type%22%20%3A%20%22OperationOutcome%22\">https://build.fhir.org/ig/HL7/fhir-consent-management/en/OperationDefinition-revoke-consent.json.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/extended-operations-client-consent-server",
"version" : "1.0.0-preview",
"name" : "ExtendedOperationsClientConsentServer",
"title" : "Extended Operations 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" : "Extended Operations 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" : "463",
"label" : "requirement-463",
"conformance" : [
"SHALL"
],
"conditionality" : false,
"requirement" : "OperationDefinition FileConsent",
"derivedFrom" : "HL7 FAST Consent IG",
"reference" : [
"https://build.fhir.org/ig/HL7/fhir-consent-management/en/OperationDefinition-file-consent.html#root",
"https://build.fhir.org/ig/HL7/fhir-consent-management/en/OperationDefinition-file-consent.html#root"
]
},
{
"key" : "133",
"label" : "requirement-133",
"conformance" : [
"SHALL"
],
"conditionality" : false,
"requirement" : "The FileConsent operation is invoked as [base]/Consent/$fileConsent",
"derivedFrom" : "HL7 FAST Consent IG",
"parent" : "Requirements-extended-operations-client-consent-server.html#requirement-463",
"reference" : [
"https://build.fhir.org/ig/HL7/fhir-consent-management/en/OperationDefinition-file-consent.html#:~:text=URL%3A%20%5Bbase%5D/Consent/%24fileConsent"
]
},
{
"key" : "134",
"label" : "requirement-134",
"conformance" : [
"SHALL"
],
"conditionality" : false,
"requirement" : "The FileConsent operation input parameters SHALL conform to the FileConsentParameters profile<br/><br/>For the most part, I'm not going to trace to everything in StructDefs, because the FHIR validator will check these. We may revisit this decision.",
"derivedFrom" : "HL7 FAST Consent IG",
"parent" : "Requirements-extended-operations-client-consent-server.html#requirement-463",
"reference" : [
"https://build.fhir.org/ig/HL7/fhir-consent-management/en/OperationDefinition-file-consent.json.html#:~:text=%22inputProfile%22%20%3A%20%22http%3A//hl7.org/fhir/us/consent%2Dmanagement/StructureDefinition/fileConsentParameters%22"
]
},
{
"key" : "135",
"label" : "requirement-135",
"conformance" : [
"SHALL"
],
"conditionality" : false,
"requirement" : "The FileConsent operation \"consent\" input parameter SHALL be 1..1 and a Consent resource",
"derivedFrom" : "HL7 FAST Consent IG",
"parent" : "Requirements-extended-operations-client-consent-server.html#requirement-463",
"reference" : [
"https://build.fhir.org/ig/HL7/fhir-consent-management/en/OperationDefinition-file-consent.json.html#:~:text=%22name%22%20%3A%20%22consent%22%2C%0A%20%20%20%20%20%20%22use%22%20%3A%20%22in%22%2C%0A%20%20%20%20%20%20%22min%22%20%3A%201%2C%0A%20%20%20%20%20%20%22max%22%20%3A%20%221%22%2C%0A%20%20%20%20%20%20%22documentation%22%20%3A%20%22The%20Consent%20instance%20to%20file%20%28see%20Input%20Parameters%20Profile%20for%20conformance%29%22%2C%0A%20%20%20%20%20%20%22type%22%20%3A%20%22Consent%22"
]
},
{
"key" : "166",
"label" : "requirement-166",
"conformance" : [
"SHALL"
],
"conditionality" : false,
"requirement" : "The FileConsent operation \"document\" input parameter SHALL be 1..1 and any resource",
"derivedFrom" : "HL7 FAST Consent IG",
"parent" : "Requirements-extended-operations-client-consent-server.html#requirement-463",
"reference" : [
"https://build.fhir.org/ig/HL7/fhir-consent-management/en/OperationDefinition-file-consent.json.html#:~:text=%22name%22%20%3A%20%22document%22%2C%0A%20%20%20%20%20%20%22use%22%20%3A%20%22in%22%2C%0A%20%20%20%20%20%20%22min%22%20%3A%201%2C%0A%20%20%20%20%20%20%22max%22%20%3A%20%221%22%2C%0A%20%20%20%20%20%20%22documentation%22%20%3A%20%22Accompanying%20documentation%20for%20the%20Consent%20in%20the%20form%20of%20a%20DocumentReference%20or%20QuestionnaireResponse%20%28see%20Input%20Parameters%20Profile%20for%20conformance%29%22%2C%0A%20%20%20%20%20%20%22type%22%20%3A%20%22Resource%22"
]
},
{
"key" : "168",
"label" : "requirement-168",
"conformance" : [
"SHALL"
],
"conditionality" : false,
"requirement" : "The FileConsent operation \"return\" output parameter SHALL be 0..1 and be an OperationOutcome<br/><br/>Note no defined way to return Consent ID",
"derivedFrom" : "HL7 FAST Consent IG",
"parent" : "Requirements-extended-operations-client-consent-server.html#requirement-463",
"reference" : [
"https://build.fhir.org/ig/HL7/fhir-consent-management/en/OperationDefinition-file-consent.json.html#:~:text=%22name%22%20%3A%20%22return%22%2C%0A%20%20%20%20%20%20%22use%22%20%3A%20%22out%22%2C%0A%20%20%20%20%20%20%22min%22%20%3A%200%2C%0A%20%20%20%20%20%20%22max%22%20%3A%20%221%22%2C%0A%20%20%20%20%20%20%22documentation%22%20%3A%20%22Optional%20outcome%20of%20the%20operation%20call%22%2C%0A%20%20%20%20%20%20%22type%22%20%3A%20%22OperationOutcome%22"
]
},
{
"key" : "466",
"label" : "requirement-466",
"conformance" : [
"SHALL"
],
"conditionality" : false,
"requirement" : "OperationDefinition RevokeConsent",
"derivedFrom" : "HL7 FAST Consent IG",
"reference" : [
"https://build.fhir.org/ig/HL7/fhir-consent-management/en/OperationDefinition-revoke-consent.html#root",
"https://build.fhir.org/ig/HL7/fhir-consent-management/en/OperationDefinition-revoke-consent.html#root"
]
},
{
"key" : "438",
"label" : "requirement-438",
"conformance" : [
"SHALL"
],
"conditionality" : false,
"requirement" : "The RevokeConsent operation is invoked as [base]/Consent/$revokeConsent",
"derivedFrom" : "HL7 FAST Consent IG",
"parent" : "Requirements-extended-operations-client-consent-server.html#requirement-466",
"reference" : [
"https://build.fhir.org/ig/HL7/fhir-consent-management/en/OperationDefinition-revoke-consent.html#:~:text=URL%3A%20%5Bbase%5D/Consent/%24revokeConsent"
]
},
{
"key" : "439",
"label" : "requirement-439",
"conformance" : [
"SHALL"
],
"conditionality" : false,
"requirement" : "The RevokeConsent operation input parameters SHALL conform to the RevokeConsentParameters profile",
"derivedFrom" : "HL7 FAST Consent IG",
"parent" : "Requirements-extended-operations-client-consent-server.html#requirement-466",
"reference" : [
"https://build.fhir.org/ig/HL7/fhir-consent-management/en/OperationDefinition-revoke-consent.json.html#:~:text=%22inputProfile%22%20%3A%20%22http%3A//hl7.org/fhir/us/consent%2Dmanagement/StructureDefinition/RevokeConsentParameters%22"
]
},
{
"key" : "444",
"label" : "requirement-444",
"conformance" : [
"SHALL"
],
"conditionality" : false,
"requirement" : "The RevokeConsent operation \"return\" output parameter SHALL be 0..1 and be an OperationOutcome",
"derivedFrom" : "HL7 FAST Consent IG",
"parent" : "Requirements-extended-operations-client-consent-server.html#requirement-466",
"reference" : [
"https://build.fhir.org/ig/HL7/fhir-consent-management/en/OperationDefinition-revoke-consent.json.html#:~:text=%22name%22%20%3A%20%22return%22%2C%0A%20%20%20%20%20%20%22use%22%20%3A%20%22out%22%2C%0A%20%20%20%20%20%20%22min%22%20%3A%200%2C%0A%20%20%20%20%20%20%22max%22%20%3A%20%221%22%2C%0A%20%20%20%20%20%20%22documentation%22%20%3A%20%22Optional%20outcome%20of%20the%20operation%20call%22%2C%0A%20%20%20%20%20%20%22type%22%20%3A%20%22OperationOutcome%22"
]
}
]
}
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