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" : "extended-operations-client-admin-service",
"text" : {
"status" : "generated",
"div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p class=\"res-header-id\"><b>Generated Narrative: Requirements extended-operations-client-admin-service</b></p><a name=\"extended-operations-client-admin-service\"> </a><a name=\"hcextended-operations-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=\"463\"> </a></b>requirement-463</td><td>SHALL</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/OperationDefinition-file-consent.html\">https://build.fhir.org/ig/HL7/fhir-consent-management/OperationDefinition-file-consent.html</a></li></ul></td></tr><tr><td><b><a name=\"133\"> </a></b>requirement-133</td><td>SHALL</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/OperationDefinition-file-consent.html#:~:text=URL%3A%20%5Bbase%5D/Consent/%24fileConsent\">https://build.fhir.org/ig/HL7/fhir-consent-management/OperationDefinition-file-consent.html</a></li></ul></td></tr><tr><td><b><a name=\"134\"> </a></b>requirement-134</td><td>SHALL</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/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/OperationDefinition-file-consent.json.html</a></li></ul></td></tr><tr><td><b><a name=\"135\"> </a></b>requirement-135</td><td>SHALL</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/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(see%20Input%20Parameters%20Profile%20for%20conformance)%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/OperationDefinition-file-consent.json.html</a></li></ul></td></tr><tr><td><b><a name=\"166\"> </a></b>requirement-166</td><td>SHALL</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/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(see%20Input%20Parameters%20Profile%20for%20conformance)%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/OperationDefinition-file-consent.json.html</a></li></ul></td></tr><tr><td><b><a name=\"168\"> </a></b>requirement-168</td><td>SHALL</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/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/OperationDefinition-file-consent.json.html</a></li></ul></td></tr><tr><td><b><a name=\"465\"> </a></b>requirement-465</td><td>SHALL</td><td><div><p>OperationDefinition UpdateConsent</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/OperationDefinition-update-consent.html\">https://build.fhir.org/ig/HL7/fhir-consent-management/OperationDefinition-update-consent.html</a></li></ul></td></tr><tr><td><b><a name=\"431\"> </a></b>requirement-431</td><td>SHALL</td><td><div><p>The UpdateConsent operation is invoked as [base]/Consent/$updateConsent</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/OperationDefinition-update-consent.html#:~:text=URL%3A%20%5Bbase%5D/Consent/%24updateConsent\">https://build.fhir.org/ig/HL7/fhir-consent-management/OperationDefinition-update-consent.html</a></li></ul></td></tr><tr><td><b><a name=\"432\"> </a></b>requirement-432</td><td>SHALL</td><td><div><p>The UpdateConsent operation input parameters SHALL conform to the UpdateConsentParameters 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/OperationDefinition-update-consent.json.html#:~:text=%22inputProfile%22%20%3A%20%22http%3A//hl7.org/fhir/us/consent%2Dmanagement/StructureDefinition/UpdateConsentParameters%22\">https://build.fhir.org/ig/HL7/fhir-consent-management/OperationDefinition-update-consent.json.html</a></li></ul></td></tr><tr><td><b><a name=\"433\"> </a></b>requirement-433</td><td>SHALL</td><td><div><p>The UpdateConsent 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/OperationDefinition-update-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%20update%20(see%20Input%20Parameters%20Profile%20for%20conformance)%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/OperationDefinition-update-consent.json.html</a></li></ul></td></tr><tr><td><b><a name=\"435\"> </a></b>requirement-435</td><td>SHALL</td><td><div><p>The UpdateConsent 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/OperationDefinition-update-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(see%20Input%20Parameters%20Profile%20for%20conformance)%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/OperationDefinition-update-consent.json.html</a></li></ul></td></tr><tr><td><b><a name=\"437\"> </a></b>requirement-437</td><td>SHALL</td><td><div><p>The UpdateConsent 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/OperationDefinition-update-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/OperationDefinition-update-consent.json.html</a></li></ul></td></tr><tr><td><b><a name=\"466\"> </a></b>requirement-466</td><td>SHALL</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/OperationDefinition-revoke-consent.html\">https://build.fhir.org/ig/HL7/fhir-consent-management/OperationDefinition-revoke-consent.html</a></li></ul></td></tr><tr><td><b><a name=\"438\"> </a></b>requirement-438</td><td>SHALL</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/OperationDefinition-revoke-consent.html#:~:text=URL%3A%20%5Bbase%5D/Consent/%24revokeConsent\">https://build.fhir.org/ig/HL7/fhir-consent-management/OperationDefinition-revoke-consent.html</a></li></ul></td></tr><tr><td><b><a name=\"439\"> </a></b>requirement-439</td><td>SHALL</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/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/OperationDefinition-revoke-consent.json.html</a></li></ul></td></tr><tr><td><b><a name=\"440\"> </a></b>requirement-440</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/OperationDefinition-revoke-consent.json.html#:~:text=%22name%22%20%3A%20%22consent,us/consent%2Dmanagement/StructureDefinition/FASTConsent%22\">https://build.fhir.org/ig/HL7/fhir-consent-management/OperationDefinition-revoke-consent.json.html</a></li></ul></td></tr><tr><td><b><a name=\"447\"> </a></b>requirement-447</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<br/><br/>- See http://hl7.org/fhir/us/core/STU6.1/StructureDefinition-us-core-patient.html</p>\n<ul>\n<li>Consider tracking that</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/OperationDefinition-revoke-consent.json.html#:~:text=%22name%22%20%3A%20%22patient,core/StructureDefinition/us%2Dcore%2Dpatient%22\">https://build.fhir.org/ig/HL7/fhir-consent-management/OperationDefinition-revoke-consent.json.html</a></li></ul></td></tr><tr><td><b><a name=\"442\"> </a></b>requirement-442</td><td>SHALL</td><td><div><p>The RevokeConsent operation "document" input parameter SHALL be 0..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/OperationDefinition-revoke-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%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%22Accompanying%20documentation%20for%20the%20revocation%20of%20the%20Consent%20in%20the%20form%20of%20a%20DocumentReference%20or%20QuestionnaireResponse%20(see%20Input%20Parameters%20Profile%20for%20conformance)%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/OperationDefinition-revoke-consent.json.html</a></li></ul></td></tr><tr><td><b><a name=\"444\"> </a></b>requirement-444</td><td>SHALL</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/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/OperationDefinition-revoke-consent.json.html</a></li></ul></td></tr><tr><td><b><a name=\"467\"> </a></b>requirement-467</td><td>SHALL</td><td><div><p>OperationDefinition RecordDisclosure</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/OperationDefinition-record-disclosure.html\">https://build.fhir.org/ig/HL7/fhir-consent-management/OperationDefinition-record-disclosure.html</a></li></ul></td></tr><tr><td><b><a name=\"445\"> </a></b>requirement-445</td><td>SHALL</td><td><div><p>The RecordDisclosure operation is invoked as [base]/AuditEvent/$recordDisclosure</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/OperationDefinition-record-disclosure.html#:~:text=URL%3A%20%5Bbase%5D/AuditEvent/%24recordDisclosure\">https://build.fhir.org/ig/HL7/fhir-consent-management/OperationDefinition-record-disclosure.html</a></li></ul></td></tr><tr><td><b><a name=\"446\"> </a></b>requirement-446</td><td>SHALL</td><td><div><p>The RecordDisclosure operation input parameters SHALL conform to the RecordDisclosureParameters 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/OperationDefinition-record-disclosure.json.html#:~:text=%22inputProfile%22%20%3A%20%22http%3A//hl7.org/fhir/us/consent%2Dmanagement/StructureDefinition/RecordDisclosureParameters%22\">https://build.fhir.org/ig/HL7/fhir-consent-management/OperationDefinition-record-disclosure.json.html</a></li></ul></td></tr><tr><td><b><a name=\"451\"> </a></b>requirement-451</td><td>SHALL</td><td><div><p>The RecordDisclosure operation "disclosure" input parameter SHALL be 1..1 and an AuditEvent 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/OperationDefinition-record-disclosure.json.html#:~:text=%22name%22%20%3A%20%22disclosure%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%22An%20AuditEvent%20detailing%20the%20disclosure%20(see%20Input%20Parameters%20Profile%20for%20conformance)%22%2C%0A%20%20%20%20%20%20%22type%22%20%3A%20%22AuditEvent%22\">https://build.fhir.org/ig/HL7/fhir-consent-management/OperationDefinition-record-disclosure.json.html</a></li></ul></td></tr><tr><td><b><a name=\"449\"> </a></b>requirement-449</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/OperationDefinition-record-disclosure.json.html#:~:text=%22name%22%20%3A%20%22consent,us/consent%2Dmanagement/StructureDefinition/FASTConsent%22\">https://build.fhir.org/ig/HL7/fhir-consent-management/OperationDefinition-record-disclosure.json.html</a></li></ul></td></tr><tr><td><b><a name=\"453\"> </a></b>requirement-453</td><td>SHALL</td><td><div><p>The RecordDisclosure 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/OperationDefinition-record-disclosure.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/OperationDefinition-record-disclosure.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-admin-service",
"version" : "0.1.0",
"name" : "ExtendedOperationsClientAdminService",
"title" : "Extended Operations 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" : "Extended Operations 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" : "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/OperationDefinition-file-consent.html"
]
},
{
"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-admin-service.html#requirement-463",
"reference" : [
"https://build.fhir.org/ig/HL7/fhir-consent-management/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-admin-service.html#requirement-463",
"reference" : [
"https://build.fhir.org/ig/HL7/fhir-consent-management/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-admin-service.html#requirement-463",
"reference" : [
"https://build.fhir.org/ig/HL7/fhir-consent-management/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(see%20Input%20Parameters%20Profile%20for%20conformance)%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-admin-service.html#requirement-463",
"reference" : [
"https://build.fhir.org/ig/HL7/fhir-consent-management/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(see%20Input%20Parameters%20Profile%20for%20conformance)%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-admin-service.html#requirement-463",
"reference" : [
"https://build.fhir.org/ig/HL7/fhir-consent-management/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" : "465",
"label" : "requirement-465",
"conformance" : [
"SHALL"
],
"conditionality" : false,
"requirement" : "OperationDefinition UpdateConsent",
"derivedFrom" : "HL7 FAST Consent IG",
"reference" : [
"https://build.fhir.org/ig/HL7/fhir-consent-management/OperationDefinition-update-consent.html"
]
},
{
"key" : "431",
"label" : "requirement-431",
"conformance" : [
"SHALL"
],
"conditionality" : false,
"requirement" : "The UpdateConsent operation is invoked as [base]/Consent/$updateConsent",
"derivedFrom" : "HL7 FAST Consent IG",
"parent" : "Requirements-extended-operations-client-admin-service.html#requirement-465",
"reference" : [
"https://build.fhir.org/ig/HL7/fhir-consent-management/OperationDefinition-update-consent.html#:~:text=URL%3A%20%5Bbase%5D/Consent/%24updateConsent"
]
},
{
"key" : "432",
"label" : "requirement-432",
"conformance" : [
"SHALL"
],
"conditionality" : false,
"requirement" : "The UpdateConsent operation input parameters SHALL conform to the UpdateConsentParameters profile",
"derivedFrom" : "HL7 FAST Consent IG",
"parent" : "Requirements-extended-operations-client-admin-service.html#requirement-465",
"reference" : [
"https://build.fhir.org/ig/HL7/fhir-consent-management/OperationDefinition-update-consent.json.html#:~:text=%22inputProfile%22%20%3A%20%22http%3A//hl7.org/fhir/us/consent%2Dmanagement/StructureDefinition/UpdateConsentParameters%22"
]
},
{
"key" : "433",
"label" : "requirement-433",
"conformance" : [
"SHALL"
],
"conditionality" : false,
"requirement" : "The UpdateConsent operation \"consent\" input parameter SHALL be 1..1 and a Consent resource",
"derivedFrom" : "HL7 FAST Consent IG",
"parent" : "Requirements-extended-operations-client-admin-service.html#requirement-465",
"reference" : [
"https://build.fhir.org/ig/HL7/fhir-consent-management/OperationDefinition-update-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%20update%20(see%20Input%20Parameters%20Profile%20for%20conformance)%22%2C%0A%20%20%20%20%20%20%22type%22%20%3A%20%22Consent%22"
]
},
{
"key" : "435",
"label" : "requirement-435",
"conformance" : [
"SHALL"
],
"conditionality" : false,
"requirement" : "The UpdateConsent operation \"document\" input parameter SHALL be 1..1 and any resource",
"derivedFrom" : "HL7 FAST Consent IG",
"parent" : "Requirements-extended-operations-client-admin-service.html#requirement-465",
"reference" : [
"https://build.fhir.org/ig/HL7/fhir-consent-management/OperationDefinition-update-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(see%20Input%20Parameters%20Profile%20for%20conformance)%22%2C%0A%20%20%20%20%20%20%22type%22%20%3A%20%22Resource%22"
]
},
{
"key" : "437",
"label" : "requirement-437",
"conformance" : [
"SHALL"
],
"conditionality" : false,
"requirement" : "The UpdateConsent operation \"return\" output parameter SHALL be 0..1 and be an OperationOutcome",
"derivedFrom" : "HL7 FAST Consent IG",
"parent" : "Requirements-extended-operations-client-admin-service.html#requirement-465",
"reference" : [
"https://build.fhir.org/ig/HL7/fhir-consent-management/OperationDefinition-update-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/OperationDefinition-revoke-consent.html"
]
},
{
"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-admin-service.html#requirement-466",
"reference" : [
"https://build.fhir.org/ig/HL7/fhir-consent-management/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-admin-service.html#requirement-466",
"reference" : [
"https://build.fhir.org/ig/HL7/fhir-consent-management/OperationDefinition-revoke-consent.json.html#:~:text=%22inputProfile%22%20%3A%20%22http%3A//hl7.org/fhir/us/consent%2Dmanagement/StructureDefinition/RevokeConsentParameters%22"
]
},
{
"key" : "440",
"label" : "requirement-440",
"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-extended-operations-client-admin-service.html#requirement-466",
"reference" : [
"https://build.fhir.org/ig/HL7/fhir-consent-management/OperationDefinition-revoke-consent.json.html#:~:text=%22name%22%20%3A%20%22consent,us/consent%2Dmanagement/StructureDefinition/FASTConsent%22"
]
},
{
"key" : "447",
"label" : "requirement-447",
"conformance" : [
"SHALL"
],
"conditionality" : false,
"requirement" : "The RevokeConsent operation \"patient\" input parameter SHALL be 1..1 and conform to the us-core-patient profile<br/><br/>- See http://hl7.org/fhir/us/core/STU6.1/StructureDefinition-us-core-patient.html\n- Consider tracking that",
"derivedFrom" : "HL7 FAST Consent IG",
"parent" : "Requirements-extended-operations-client-admin-service.html#requirement-466",
"reference" : [
"https://build.fhir.org/ig/HL7/fhir-consent-management/OperationDefinition-revoke-consent.json.html#:~:text=%22name%22%20%3A%20%22patient,core/StructureDefinition/us%2Dcore%2Dpatient%22"
]
},
{
"key" : "442",
"label" : "requirement-442",
"conformance" : [
"SHALL"
],
"conditionality" : false,
"requirement" : "The RevokeConsent operation \"document\" input parameter SHALL be 0..1 and any resource",
"derivedFrom" : "HL7 FAST Consent IG",
"parent" : "Requirements-extended-operations-client-admin-service.html#requirement-466",
"reference" : [
"https://build.fhir.org/ig/HL7/fhir-consent-management/OperationDefinition-revoke-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%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%22Accompanying%20documentation%20for%20the%20revocation%20of%20the%20Consent%20in%20the%20form%20of%20a%20DocumentReference%20or%20QuestionnaireResponse%20(see%20Input%20Parameters%20Profile%20for%20conformance)%22%2C%0A%20%20%20%20%20%20%22type%22%20%3A%20%22Resource%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-admin-service.html#requirement-466",
"reference" : [
"https://build.fhir.org/ig/HL7/fhir-consent-management/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"
]
},
{
"key" : "467",
"label" : "requirement-467",
"conformance" : [
"SHALL"
],
"conditionality" : false,
"requirement" : "OperationDefinition RecordDisclosure",
"derivedFrom" : "HL7 FAST Consent IG",
"reference" : [
"https://build.fhir.org/ig/HL7/fhir-consent-management/OperationDefinition-record-disclosure.html"
]
},
{
"key" : "445",
"label" : "requirement-445",
"conformance" : [
"SHALL"
],
"conditionality" : false,
"requirement" : "The RecordDisclosure operation is invoked as [base]/AuditEvent/$recordDisclosure",
"derivedFrom" : "HL7 FAST Consent IG",
"parent" : "Requirements-extended-operations-client-admin-service.html#requirement-467",
"reference" : [
"https://build.fhir.org/ig/HL7/fhir-consent-management/OperationDefinition-record-disclosure.html#:~:text=URL%3A%20%5Bbase%5D/AuditEvent/%24recordDisclosure"
]
},
{
"key" : "446",
"label" : "requirement-446",
"conformance" : [
"SHALL"
],
"conditionality" : false,
"requirement" : "The RecordDisclosure operation input parameters SHALL conform to the RecordDisclosureParameters profile",
"derivedFrom" : "HL7 FAST Consent IG",
"parent" : "Requirements-extended-operations-client-admin-service.html#requirement-467",
"reference" : [
"https://build.fhir.org/ig/HL7/fhir-consent-management/OperationDefinition-record-disclosure.json.html#:~:text=%22inputProfile%22%20%3A%20%22http%3A//hl7.org/fhir/us/consent%2Dmanagement/StructureDefinition/RecordDisclosureParameters%22"
]
},
{
"key" : "451",
"label" : "requirement-451",
"conformance" : [
"SHALL"
],
"conditionality" : false,
"requirement" : "The RecordDisclosure operation \"disclosure\" input parameter SHALL be 1..1 and an AuditEvent resource",
"derivedFrom" : "HL7 FAST Consent IG",
"parent" : "Requirements-extended-operations-client-admin-service.html#requirement-467",
"reference" : [
"https://build.fhir.org/ig/HL7/fhir-consent-management/OperationDefinition-record-disclosure.json.html#:~:text=%22name%22%20%3A%20%22disclosure%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%22An%20AuditEvent%20detailing%20the%20disclosure%20(see%20Input%20Parameters%20Profile%20for%20conformance)%22%2C%0A%20%20%20%20%20%20%22type%22%20%3A%20%22AuditEvent%22"
]
},
{
"key" : "449",
"label" : "requirement-449",
"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-extended-operations-client-admin-service.html#requirement-467",
"reference" : [
"https://build.fhir.org/ig/HL7/fhir-consent-management/OperationDefinition-record-disclosure.json.html#:~:text=%22name%22%20%3A%20%22consent,us/consent%2Dmanagement/StructureDefinition/FASTConsent%22"
]
},
{
"key" : "453",
"label" : "requirement-453",
"conformance" : [
"SHALL"
],
"conditionality" : false,
"requirement" : "The RecordDisclosure operation \"return\" output parameter SHALL be 0..1 and be an OperationOutcome",
"derivedFrom" : "HL7 FAST Consent IG",
"reference" : [
"https://build.fhir.org/ig/HL7/fhir-consent-management/OperationDefinition-record-disclosure.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#0.1.0 based on FHIR 4.0.1. Generated 2025-09-05
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change