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" : "structure-definitions-client-admin-service",
"text" : {
"status" : "generated",
"div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p class=\"res-header-id\"><b>Generated Narrative: Requirements structure-definitions-client-admin-service</b></p><a name=\"structure-definitions-client-admin-service\"> </a><a name=\"hcstructure-definitions-client-admin-service\"> </a><p>These requirements apply to the following actors: </p><ul><li><a href=\"ActorDefinition-admin-service.html\">Admin Service</a></li><li><a href=\"ActorDefinition-client.html\">Client</a></li></ul><table class=\"grid\"><tr><td><b><a name=\"464\"> </a></b>requirement-464</td><td>SHALL</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/StructureDefinition-FileConsentParameters.html\">https://build.fhir.org/ig/HL7/fhir-consent-management/StructureDefinition-FileConsentParameters.html</a></li></ul></td></tr><tr><td><b><a name=\"70\"> </a></b>requirement-70</td><td>SHALL</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/StructureDefinition-FileConsentParameters-definitions.html#Parameters.parameter:consent\">https://build.fhir.org/ig/HL7/fhir-consent-management/StructureDefinition-FileConsentParameters-definitions.html</a></li></ul></td></tr><tr><td><b><a name=\"430\"> </a></b>requirement-430</td><td>SHALL</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/StructureDefinition-FileConsentParameters-definitions.html#Parameters.parameter:document\">https://build.fhir.org/ig/HL7/fhir-consent-management/StructureDefinition-FileConsentParameters-definitions.html</a></li></ul></td></tr><tr><td><b><a name=\"468\"> </a></b>requirement-468</td><td>SHALL</td><td><div><p>StructureDefinition UpdateConsentParameters</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/StructureDefinition-UpdateConsentParameters.html\">https://build.fhir.org/ig/HL7/fhir-consent-management/StructureDefinition-UpdateConsentParameters.html</a></li></ul></td></tr><tr><td><b><a name=\"434\"> </a></b>requirement-434</td><td>SHALL</td><td><div><p>The UpdateConsent 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/StructureDefinition-UpdateConsentParameters-definitions.html#Parameters.parameter:consent\">https://build.fhir.org/ig/HL7/fhir-consent-management/StructureDefinition-UpdateConsentParameters-definitions.html</a></li></ul></td></tr><tr><td><b><a name=\"436\"> </a></b>requirement-436</td><td>SHALL</td><td><div><p>The UpdateConsent 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/StructureDefinition-UpdateConsentParameters-definitions.html#Parameters.parameter:document\">https://build.fhir.org/ig/HL7/fhir-consent-management/StructureDefinition-UpdateConsentParameters-definitions.html</a></li></ul></td></tr><tr><td><b><a name=\"469\"> </a></b>requirement-469</td><td>SHALL</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/StructureDefinition-RevokeConsentParameters.html\">https://build.fhir.org/ig/HL7/fhir-consent-management/StructureDefinition-RevokeConsentParameters.html</a></li></ul></td></tr><tr><td><b><a name=\"441\"> </a></b>requirement-441</td><td>SHALL</td><td><div><p>The RevokeConsent 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/StructureDefinition-RevokeConsentParameters-definitions.html#Parameters.parameter:consent\">https://build.fhir.org/ig/HL7/fhir-consent-management/StructureDefinition-RevokeConsentParameters-definitions.html</a></li></ul></td></tr><tr><td><b><a name=\"448\"> </a></b>requirement-448</td><td>SHALL</td><td><div><p>The RevokeConsent operation "patient" input parameter SHALL be 1..1 and conform to the us-core-patient 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/StructureDefinition-RevokeConsentParameters-definitions.html#Parameters.parameter:patient\">https://build.fhir.org/ig/HL7/fhir-consent-management/StructureDefinition-RevokeConsentParameters-definitions.html</a></li></ul></td></tr><tr><td><b><a name=\"443\"> </a></b>requirement-443</td><td>SHALL</td><td><div><p>The RevokeConsent operation "document" input parameter SHALL be 0..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/StructureDefinition-RevokeConsentParameters-definitions.html#Parameters.parameter:document\">https://build.fhir.org/ig/HL7/fhir-consent-management/StructureDefinition-RevokeConsentParameters-definitions.html</a></li></ul></td></tr><tr><td><b><a name=\"470\"> </a></b>requirement-470</td><td>SHALL</td><td><div><p>StructureDefinition RecordDisclosureParameters</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/StructureDefinition-RecordDisclosureParameters.html\">https://build.fhir.org/ig/HL7/fhir-consent-management/StructureDefinition-RecordDisclosureParameters.html</a></li></ul></td></tr><tr><td><b><a name=\"452\"> </a></b>requirement-452</td><td>SHALL</td><td><div><p>The RecordDisclosure operation "disclosure" input parameter SHALL be 1..1 and conform to the \tFASTConsentAuditEvent 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/StructureDefinition-RecordDisclosureParameters-definitions.html#key_Parameters.parameter:disclosure\">https://build.fhir.org/ig/HL7/fhir-consent-management/StructureDefinition-RecordDisclosureParameters-definitions.html</a></li></ul></td></tr><tr><td><b><a name=\"450\"> </a></b>requirement-450</td><td>SHALL</td><td><div><p>The RecordDisclosure 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/StructureDefinition-RecordDisclosureParameters-definitions.html#Parameters.parameter:consent\">https://build.fhir.org/ig/HL7/fhir-consent-management/StructureDefinition-RecordDisclosureParameters-definitions.html</a></li></ul></td></tr><tr><td><b><a name=\"477\"> </a></b>requirement-477</td><td>SHALL</td><td><div><p>StructureDefinition FASTSubscription<br/><br/>- No requirements to use this yet</p>\n<ul>\n<li>The constraint that status is always "active" might not make sense. I think the client is supposed to POST it as "requested".</li>\n</ul>\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/StructureDefinition-FASTSubscription.html\">https://build.fhir.org/ig/HL7/fhir-consent-management/StructureDefinition-FASTSubscription.html</a></li></ul></td></tr><tr><td><b><a name=\"595\"> </a></b>requirement-595</td><td>SHALL</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/StructureDefinition-backport-subscription.html\">https://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition-backport-subscription.html</a></li></ul></td></tr><tr><td><b><a name=\"597\"> </a></b>requirement-597</td><td>SHALL</td><td><div><p>StructureDefinition FASTConsent<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/StructureDefinition-FASTConsent.html\">https://build.fhir.org/ig/HL7/fhir-consent-management/StructureDefinition-FASTConsent.html</a></li></ul></td></tr><tr><td><b><a name=\"599\"> </a></b>requirement-599</td><td>SHALL</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/StructureDefinition-FASTDocumentReference.html\">https://build.fhir.org/ig/HL7/fhir-consent-management/StructureDefinition-FASTDocumentReference.html</a></li></ul></td></tr><tr><td><b><a name=\"601\"> </a></b>requirement-601</td><td>SHALL</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/StructureDefinition-FASTReference.html\">https://build.fhir.org/ig/HL7/fhir-consent-management/StructureDefinition-FASTReference.html</a></li></ul></td></tr><tr><td><b><a name=\"598\"> </a></b>requirement-598</td><td>SHALL</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/StructureDefinition-FASTConsentAuditEvent.html\">https://build.fhir.org/ig/HL7/fhir-consent-management/StructureDefinition-FASTConsentAuditEvent.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-admin-service",
"version" : "0.1.0",
"name" : "StructureDefinitionsClientAdminService",
"title" : "Structure Definitions Client 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" : "Structure Definitions Requirements for Client 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"🔗 ,
"http://hl7.org/fhir/us/consent-management/ActorDefinition/client"
],
"statement" : [
{
"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/StructureDefinition-FileConsentParameters.html"
]
},
{
"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-admin-service.html#requirement-464",
"reference" : [
"https://build.fhir.org/ig/HL7/fhir-consent-management/StructureDefinition-FileConsentParameters-definitions.html#Parameters.parameter:consent"
]
},
{
"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-admin-service.html#requirement-464",
"reference" : [
"https://build.fhir.org/ig/HL7/fhir-consent-management/StructureDefinition-FileConsentParameters-definitions.html#Parameters.parameter:document"
]
},
{
"key" : "468",
"label" : "requirement-468",
"conformance" : [
"SHALL"
],
"conditionality" : false,
"requirement" : "StructureDefinition UpdateConsentParameters",
"derivedFrom" : "HL7 FAST Consent IG",
"reference" : [
"https://build.fhir.org/ig/HL7/fhir-consent-management/StructureDefinition-UpdateConsentParameters.html"
]
},
{
"key" : "434",
"label" : "requirement-434",
"conformance" : [
"SHALL"
],
"conditionality" : false,
"requirement" : "The UpdateConsent operation \"consent\" input parameter SHALL be 1..1 and conform to the FASTConsent profile",
"derivedFrom" : "HL7 FAST Consent IG",
"parent" : "Requirements-structure-definitions-client-admin-service.html#requirement-468",
"reference" : [
"https://build.fhir.org/ig/HL7/fhir-consent-management/StructureDefinition-UpdateConsentParameters-definitions.html#Parameters.parameter:consent"
]
},
{
"key" : "436",
"label" : "requirement-436",
"conformance" : [
"SHALL"
],
"conditionality" : false,
"requirement" : "The UpdateConsent 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-admin-service.html#requirement-468",
"reference" : [
"https://build.fhir.org/ig/HL7/fhir-consent-management/StructureDefinition-UpdateConsentParameters-definitions.html#Parameters.parameter:document"
]
},
{
"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/StructureDefinition-RevokeConsentParameters.html"
]
},
{
"key" : "441",
"label" : "requirement-441",
"conformance" : [
"SHALL"
],
"conditionality" : false,
"requirement" : "The RevokeConsent operation \"consent\" input parameter SHALL be 1..1 and conform to the FASTConsent profile",
"derivedFrom" : "HL7 FAST Consent IG",
"parent" : "Requirements-structure-definitions-client-admin-service.html#requirement-469",
"reference" : [
"https://build.fhir.org/ig/HL7/fhir-consent-management/StructureDefinition-RevokeConsentParameters-definitions.html#Parameters.parameter:consent"
]
},
{
"key" : "448",
"label" : "requirement-448",
"conformance" : [
"SHALL"
],
"conditionality" : false,
"requirement" : "The RevokeConsent operation \"patient\" input parameter SHALL be 1..1 and conform to the us-core-patient profile",
"derivedFrom" : "HL7 FAST Consent IG",
"parent" : "Requirements-structure-definitions-client-admin-service.html#requirement-469",
"reference" : [
"https://build.fhir.org/ig/HL7/fhir-consent-management/StructureDefinition-RevokeConsentParameters-definitions.html#Parameters.parameter:patient"
]
},
{
"key" : "443",
"label" : "requirement-443",
"conformance" : [
"SHALL"
],
"conditionality" : false,
"requirement" : "The RevokeConsent operation \"document\" input parameter SHALL be 0..1 and conform to either the us-core-questionnaireresponse or FASTDocumentReference profile",
"derivedFrom" : "HL7 FAST Consent IG",
"parent" : "Requirements-structure-definitions-client-admin-service.html#requirement-469",
"reference" : [
"https://build.fhir.org/ig/HL7/fhir-consent-management/StructureDefinition-RevokeConsentParameters-definitions.html#Parameters.parameter:document"
]
},
{
"key" : "470",
"label" : "requirement-470",
"conformance" : [
"SHALL"
],
"conditionality" : false,
"requirement" : "StructureDefinition RecordDisclosureParameters",
"derivedFrom" : "HL7 FAST Consent IG",
"reference" : [
"https://build.fhir.org/ig/HL7/fhir-consent-management/StructureDefinition-RecordDisclosureParameters.html"
]
},
{
"key" : "452",
"label" : "requirement-452",
"conformance" : [
"SHALL"
],
"conditionality" : false,
"requirement" : "The RecordDisclosure operation \"disclosure\" input parameter SHALL be 1..1 and conform to the \tFASTConsentAuditEvent profile",
"derivedFrom" : "HL7 FAST Consent IG",
"parent" : "Requirements-structure-definitions-client-admin-service.html#requirement-470",
"reference" : [
"https://build.fhir.org/ig/HL7/fhir-consent-management/StructureDefinition-RecordDisclosureParameters-definitions.html#key_Parameters.parameter:disclosure"
]
},
{
"key" : "450",
"label" : "requirement-450",
"conformance" : [
"SHALL"
],
"conditionality" : false,
"requirement" : "The RecordDisclosure operation \"consent\" input parameter SHALL be 1..1 and conform to the FASTConsent profile",
"derivedFrom" : "HL7 FAST Consent IG",
"parent" : "Requirements-structure-definitions-client-admin-service.html#requirement-470",
"reference" : [
"https://build.fhir.org/ig/HL7/fhir-consent-management/StructureDefinition-RecordDisclosureParameters-definitions.html#Parameters.parameter:consent"
]
},
{
"key" : "477",
"label" : "requirement-477",
"conformance" : [
"SHALL"
],
"conditionality" : false,
"requirement" : "StructureDefinition FASTSubscription<br/><br/>- No requirements to use this yet\n- 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/StructureDefinition-FASTSubscription.html"
]
},
{
"key" : "595",
"label" : "requirement-595",
"conformance" : [
"SHALL"
],
"conditionality" : false,
"requirement" : "StructureDefinition BackportSubscription",
"derivedFrom" : "Subscriptions R5 Backport",
"reference" : [
"https://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition-backport-subscription.html"
]
},
{
"key" : "597",
"label" : "requirement-597",
"conformance" : [
"SHALL"
],
"conditionality" : false,
"requirement" : "StructureDefinition FASTConsent<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/StructureDefinition-FASTConsent.html"
]
},
{
"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/StructureDefinition-FASTDocumentReference.html"
]
},
{
"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/StructureDefinition-FASTReference.html"
]
},
{
"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/StructureDefinition-FASTConsentAuditEvent.html"
]
}
]
}
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