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-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-consent-server</b></p><a name=\"structure-definitions-consent-server\"> </a><a name=\"hcstructure-definitions-consent-server\"> </a><p>These requirements apply to the actor <a href=\"ActorDefinition-consent-server.html\">Consent Server</a></p><table class=\"grid\"><tr><td><b><a name=\"1030\"> </a></b>requirement-1030</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>Consent Administration Service SHALL support Consent read</p>\n</div><p>Links: </p><ul><li>Derived From: <code>HL7 FAST Consent IG</code></li><li>Satisfied By: <a href=\"https://build.fhir.org/ig/HL7/fhir-consent-management/en/StructureDefinition-FASTConsent.html#:~:text=SHALL%20support%20both%C2%A0read%20Consent%20by%20id\">https://build.fhir.org/ig/HL7/fhir-consent-management/en/StructureDefinition-FASTConsent.html</a></li></ul></td></tr><tr><td><b><a name=\"1024\"> </a></b>requirement-1024</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>Consent Administration Service SHALL support FASTConsent search by _id</p>\n</div><p>Links: </p><ul><li>Derived From: <code>HL7 FAST Consent IG</code></li><li>Satisfied By: <a href=\"https://build.fhir.org/ig/HL7/fhir-consent-management/en/StructureDefinition-FASTConsent.html#:~:text=Consent%20search%20using%20the%20_id%20search%20parameter\">https://build.fhir.org/ig/HL7/fhir-consent-management/en/StructureDefinition-FASTConsent.html</a></li></ul></td></tr><tr><td><b><a name=\"1026\"> </a></b>requirement-1026</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>Consent Administration Service SHALL support Consent search by identifier</p>\n</div><p>Links: </p><ul><li>Derived From: <code>HL7 FAST Consent IG</code></li><li>Satisfied By: <a href=\"https://build.fhir.org/ig/HL7/fhir-consent-management/en/StructureDefinition-FASTConsent.html#:~:text=SHALL%20support%20searching%20a%20consent%20by%20an%20identifier%20such%20as%20a%20CDA%20consent%20document%20using%20the%20identifier%20search%20parameter\">https://build.fhir.org/ig/HL7/fhir-consent-management/en/StructureDefinition-FASTConsent.html</a></li></ul></td></tr><tr><td><b><a name=\"1028\"> </a></b>requirement-1028</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>Consent Administration Service SHALL support FASTConsent search by patient</p>\n</div><p>Links: </p><ul><li>Derived From: <code>HL7 FAST Consent IG</code></li><li>Satisfied By: <a href=\"https://build.fhir.org/ig/HL7/fhir-consent-management/en/StructureDefinition-FASTConsent.html#:~:text=SHALL%20support%20searching%20a%20consent%20by%20a%20patient%20using%20the%20patient%20search%20parameter\">https://build.fhir.org/ig/HL7/fhir-consent-management/en/StructureDefinition-FASTConsent.html</a></li></ul></td></tr><tr><td><b><a name=\"1032\"> </a></b>requirement-1032</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>Consent Administration Service SHALL support Consent search by the combination of the patient and status search parameters</p>\n</div><p>Links: </p><ul><li>Derived From: <code>HL7 FAST Consent IG</code></li><li>Satisfied By: <a href=\"https://build.fhir.org/ig/HL7/fhir-consent-management/en/StructureDefinition-FASTConsent.html#:~:text=SHALL%20support%20searching%20using%20the%20combination%20of%20the%20patient%20and%20status%20search%20parameters\">https://build.fhir.org/ig/HL7/fhir-consent-management/en/StructureDefinition-FASTConsent.html</a></li></ul></td></tr><tr><td><b><a name=\"1034\"> </a></b>requirement-1034</td><td><a href=\"http://hl7.org/fhir/uv/xver-r5.r4/0.1.0/CodeSystem-conformance-expectation.html#conformance-expectation-SHOULD\">SHOULD</a></td><td><div><p>Consent Administration Service SHOULD support Consent search by the combination of the patient and date search parameters</p>\n</div><p>Links: </p><ul><li>Derived From: <code>HL7 FAST Consent IG</code></li><li>Satisfied By: <a href=\"https://build.fhir.org/ig/HL7/fhir-consent-management/en/StructureDefinition-FASTConsent.html#:~:text=SHOULD%20support%20searching%20using%20the%20combination%20of%20the%20patient%20and%20date%20search%20parameters\">https://build.fhir.org/ig/HL7/fhir-consent-management/en/StructureDefinition-FASTConsent.html</a></li></ul></td></tr><tr><td><b><a name=\"632\"> </a></b>requirement-632</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>Consent Administration Service SHALL support Consent notification filter combinations, and they combine as AND<br/><br/>Not sure if there is a more direct requirement somewhere that says this.</p>\n</div><p>Links: </p><ul><li>Derived From: <code>Subscriptions R5 Backport</code></li><li>Satisfied By: <a href=\"https://hl7.org/fhir/uv/subscriptions-backport/STU1.1/StructureDefinition-backport-subscription-definitions.html#:~:text=When%20multiple%20filters%20are%20applied%2C%20evaluates%20to%20true%20if%20all%20the%20conditions%20are%20met%3B%20otherwise%20it%20returns%20false.%20%28i.e.%2C%20logical%20AND%29.\">https://hl7.org/fhir/uv/subscriptions-backport/STU1.1/StructureDefinition-backport-subscription-definitions.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-consent-server",
"version" : "1.0.0-preview",
"name" : "StructureDefinitionsConsentServer",
"title" : "Structure Definitions 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 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/consent-server"
],
"statement" : [
{
"key" : "1030",
"label" : "requirement-1030",
"conformance" : [
"SHALL"
],
"conditionality" : false,
"requirement" : "Consent Administration Service SHALL support Consent read",
"derivedFrom" : "HL7 FAST Consent IG",
"parent" : "Requirements-structure-definitions-client-consent-server.html#requirement-597",
"satisfiedBy" : [
"https://build.fhir.org/ig/HL7/fhir-consent-management/en/StructureDefinition-FASTConsent.html#:~:text=SHALL%20support%20both%C2%A0read%20Consent%20by%20id"
]
},
{
"key" : "1024",
"label" : "requirement-1024",
"conformance" : [
"SHALL"
],
"conditionality" : false,
"requirement" : "Consent Administration Service SHALL support FASTConsent search by _id",
"derivedFrom" : "HL7 FAST Consent IG",
"parent" : "Requirements-structure-definitions-client-consent-server.html#requirement-597",
"satisfiedBy" : [
"https://build.fhir.org/ig/HL7/fhir-consent-management/en/StructureDefinition-FASTConsent.html#:~:text=Consent%20search%20using%20the%20_id%20search%20parameter"
]
},
{
"key" : "1026",
"label" : "requirement-1026",
"conformance" : [
"SHALL"
],
"conditionality" : false,
"requirement" : "Consent Administration Service SHALL support Consent search by identifier",
"derivedFrom" : "HL7 FAST Consent IG",
"parent" : "Requirements-structure-definitions-client-consent-server.html#requirement-597",
"satisfiedBy" : [
"https://build.fhir.org/ig/HL7/fhir-consent-management/en/StructureDefinition-FASTConsent.html#:~:text=SHALL%20support%20searching%20a%20consent%20by%20an%20identifier%20such%20as%20a%20CDA%20consent%20document%20using%20the%20identifier%20search%20parameter"
]
},
{
"key" : "1028",
"label" : "requirement-1028",
"conformance" : [
"SHALL"
],
"conditionality" : false,
"requirement" : "Consent Administration Service SHALL support FASTConsent search by patient",
"derivedFrom" : "HL7 FAST Consent IG",
"parent" : "Requirements-structure-definitions-client-consent-server.html#requirement-597",
"satisfiedBy" : [
"https://build.fhir.org/ig/HL7/fhir-consent-management/en/StructureDefinition-FASTConsent.html#:~:text=SHALL%20support%20searching%20a%20consent%20by%20a%20patient%20using%20the%20patient%20search%20parameter"
]
},
{
"key" : "1032",
"label" : "requirement-1032",
"conformance" : [
"SHALL"
],
"conditionality" : false,
"requirement" : "Consent Administration Service SHALL support Consent search by the combination of the patient and status search parameters",
"derivedFrom" : "HL7 FAST Consent IG",
"parent" : "Requirements-structure-definitions-client-consent-server.html#requirement-597",
"satisfiedBy" : [
"https://build.fhir.org/ig/HL7/fhir-consent-management/en/StructureDefinition-FASTConsent.html#:~:text=SHALL%20support%20searching%20using%20the%20combination%20of%20the%20patient%20and%20status%20search%20parameters"
]
},
{
"key" : "1034",
"label" : "requirement-1034",
"conformance" : [
"SHOULD"
],
"conditionality" : false,
"requirement" : "Consent Administration Service SHOULD support Consent search by the combination of the patient and date search parameters",
"derivedFrom" : "HL7 FAST Consent IG",
"parent" : "Requirements-structure-definitions-client-consent-server.html#requirement-597",
"satisfiedBy" : [
"https://build.fhir.org/ig/HL7/fhir-consent-management/en/StructureDefinition-FASTConsent.html#:~:text=SHOULD%20support%20searching%20using%20the%20combination%20of%20the%20patient%20and%20date%20search%20parameters"
]
},
{
"key" : "632",
"label" : "requirement-632",
"conformance" : [
"SHALL"
],
"conditionality" : false,
"requirement" : "Consent Administration Service SHALL support Consent notification filter combinations, and they combine as AND<br/><br/>Not sure if there is a more direct requirement somewhere that says this.",
"derivedFrom" : "Subscriptions R5 Backport",
"parent" : "Requirements-subscription-topics-client-consent-server.html#requirement-596",
"satisfiedBy" : [
"https://hl7.org/fhir/uv/subscriptions-backport/STU1.1/StructureDefinition-backport-subscription-definitions.html#:~:text=When%20multiple%20filters%20are%20applied%2C%20evaluates%20to%20true%20if%20all%20the%20conditions%20are%20met%3B%20otherwise%20it%20returns%20false.%20%28i.e.%2C%20logical%20AND%29."
]
}
]
}
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