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 |
<Requirements xmlns="http://hl7.org/fhir">
<id value="extended-operations-client-admin-service"/>
<text>
<status value="generated"/>
<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>
</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>
</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>
</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>
</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>
</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>
</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>
</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>
</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>
</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>
</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>
</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>
</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>
</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>
</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>
</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>
</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>
<ul>
<li>Consider tracking that</li>
</ul>
</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>
</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>
</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>
</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>
</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>
</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>
</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>
</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>
</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>
</text>
<extension
url="http://hl7.org/fhir/StructureDefinition/structuredefinition-wg">
<valueCode value="cbcc"/>
</extension>
<extension
url="http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm">
<valueInteger value="1">
<extension
url="http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom">
<valueCanonical
value="http://hl7.org/fhir/us/consent-management/ImplementationGuide/hl7.fhir.us.consent-management"/>
</extension>
</valueInteger>
</extension>
<extension
url="http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status">
<valueCode value="trial-use">
<extension
url="http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom">
<valueCanonical
value="http://hl7.org/fhir/us/consent-management/ImplementationGuide/hl7.fhir.us.consent-management"/>
</extension>
</valueCode>
</extension>
<url
value="http://hl7.org/fhir/us/consent-management/Requirements/extended-operations-client-admin-service"/>
<version value="0.1.0"/>
<name value="ExtendedOperationsClientAdminService"/>
<title value="Extended Operations Client Admin Service"/>
<status value="active"/>
<experimental value="false"/>
<date value="2025-09-03T19:43:24-04:00"/>
<publisher value="HL7 International / Community Based Collaborative Care"/>
<contact>
<name value="HL7 International / Community Based Collaborative Care"/>
<telecom>
<system value="url"/>
<value value="http://www.hl7.org/Special/committees/cbcc"/>
</telecom>
</contact>
<description
value="Extended Operations Requirements for Client Admin Service"/>
<jurisdiction>
<coding>
<system value="urn:iso:std:iso:3166"/>
<code value="US"/>
<display value="United States of America"/>
</coding>
</jurisdiction>
<actor
value="http://hl7.org/fhir/us/consent-management/ActorDefinition/admin-service"/>
<actor
value="http://hl7.org/fhir/us/consent-management/ActorDefinition/client"/>
<statement>
<key value="463"/>
<label value="requirement-463"/>
<conformance value="SHALL"/>
<conditionality value="false"/>
<requirement value="OperationDefinition FileConsent"/>
<derivedFrom value="HL7 FAST Consent IG"/>
<reference
value="https://build.fhir.org/ig/HL7/fhir-consent-management/OperationDefinition-file-consent.html"/>
</statement>
<statement>
<key value="133"/>
<label value="requirement-133"/>
<conformance value="SHALL"/>
<conditionality value="false"/>
<requirement
value="The FileConsent operation is invoked as [base]/Consent/$fileConsent"/>
<derivedFrom value="HL7 FAST Consent IG"/>
<parent
value="Requirements-extended-operations-client-admin-service.html#requirement-463"/>
<reference
value="https://build.fhir.org/ig/HL7/fhir-consent-management/OperationDefinition-file-consent.html#:~:text=URL%3A%20%5Bbase%5D/Consent/%24fileConsent"/>
</statement>
<statement>
<key value="134"/>
<label value="requirement-134"/>
<conformance value="SHALL"/>
<conditionality value="false"/>
<requirement
value="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 value="HL7 FAST Consent IG"/>
<parent
value="Requirements-extended-operations-client-admin-service.html#requirement-463"/>
<reference
value="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"/>
</statement>
<statement>
<key value="135"/>
<label value="requirement-135"/>
<conformance value="SHALL"/>
<conditionality value="false"/>
<requirement
value="The FileConsent operation "consent" input parameter SHALL be 1..1 and a Consent resource"/>
<derivedFrom value="HL7 FAST Consent IG"/>
<parent
value="Requirements-extended-operations-client-admin-service.html#requirement-463"/>
<reference
value="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"/>
</statement>
<statement>
<key value="166"/>
<label value="requirement-166"/>
<conformance value="SHALL"/>
<conditionality value="false"/>
<requirement
value="The FileConsent operation "document" input parameter SHALL be 1..1 and any resource"/>
<derivedFrom value="HL7 FAST Consent IG"/>
<parent
value="Requirements-extended-operations-client-admin-service.html#requirement-463"/>
<reference
value="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"/>
</statement>
<statement>
<key value="168"/>
<label value="requirement-168"/>
<conformance value="SHALL"/>
<conditionality value="false"/>
<requirement
value="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 value="HL7 FAST Consent IG"/>
<parent
value="Requirements-extended-operations-client-admin-service.html#requirement-463"/>
<reference
value="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"/>
</statement>
<statement>
<key value="465"/>
<label value="requirement-465"/>
<conformance value="SHALL"/>
<conditionality value="false"/>
<requirement value="OperationDefinition UpdateConsent"/>
<derivedFrom value="HL7 FAST Consent IG"/>
<reference
value="https://build.fhir.org/ig/HL7/fhir-consent-management/OperationDefinition-update-consent.html"/>
</statement>
<statement>
<key value="431"/>
<label value="requirement-431"/>
<conformance value="SHALL"/>
<conditionality value="false"/>
<requirement
value="The UpdateConsent operation is invoked as [base]/Consent/$updateConsent"/>
<derivedFrom value="HL7 FAST Consent IG"/>
<parent
value="Requirements-extended-operations-client-admin-service.html#requirement-465"/>
<reference
value="https://build.fhir.org/ig/HL7/fhir-consent-management/OperationDefinition-update-consent.html#:~:text=URL%3A%20%5Bbase%5D/Consent/%24updateConsent"/>
</statement>
<statement>
<key value="432"/>
<label value="requirement-432"/>
<conformance value="SHALL"/>
<conditionality value="false"/>
<requirement
value="The UpdateConsent operation input parameters SHALL conform to the UpdateConsentParameters profile"/>
<derivedFrom value="HL7 FAST Consent IG"/>
<parent
value="Requirements-extended-operations-client-admin-service.html#requirement-465"/>
<reference
value="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"/>
</statement>
<statement>
<key value="433"/>
<label value="requirement-433"/>
<conformance value="SHALL"/>
<conditionality value="false"/>
<requirement
value="The UpdateConsent operation "consent" input parameter SHALL be 1..1 and a Consent resource"/>
<derivedFrom value="HL7 FAST Consent IG"/>
<parent
value="Requirements-extended-operations-client-admin-service.html#requirement-465"/>
<reference
value="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"/>
</statement>
<statement>
<key value="435"/>
<label value="requirement-435"/>
<conformance value="SHALL"/>
<conditionality value="false"/>
<requirement
value="The UpdateConsent operation "document" input parameter SHALL be 1..1 and any resource"/>
<derivedFrom value="HL7 FAST Consent IG"/>
<parent
value="Requirements-extended-operations-client-admin-service.html#requirement-465"/>
<reference
value="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"/>
</statement>
<statement>
<key value="437"/>
<label value="requirement-437"/>
<conformance value="SHALL"/>
<conditionality value="false"/>
<requirement
value="The UpdateConsent operation "return" output parameter SHALL be 0..1 and be an OperationOutcome"/>
<derivedFrom value="HL7 FAST Consent IG"/>
<parent
value="Requirements-extended-operations-client-admin-service.html#requirement-465"/>
<reference
value="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"/>
</statement>
<statement>
<key value="466"/>
<label value="requirement-466"/>
<conformance value="SHALL"/>
<conditionality value="false"/>
<requirement value="OperationDefinition RevokeConsent"/>
<derivedFrom value="HL7 FAST Consent IG"/>
<reference
value="https://build.fhir.org/ig/HL7/fhir-consent-management/OperationDefinition-revoke-consent.html"/>
</statement>
<statement>
<key value="438"/>
<label value="requirement-438"/>
<conformance value="SHALL"/>
<conditionality value="false"/>
<requirement
value="The RevokeConsent operation is invoked as [base]/Consent/$revokeConsent"/>
<derivedFrom value="HL7 FAST Consent IG"/>
<parent
value="Requirements-extended-operations-client-admin-service.html#requirement-466"/>
<reference
value="https://build.fhir.org/ig/HL7/fhir-consent-management/OperationDefinition-revoke-consent.html#:~:text=URL%3A%20%5Bbase%5D/Consent/%24revokeConsent"/>
</statement>
<statement>
<key value="439"/>
<label value="requirement-439"/>
<conformance value="SHALL"/>
<conditionality value="false"/>
<requirement
value="The RevokeConsent operation input parameters SHALL conform to the RevokeConsentParameters profile"/>
<derivedFrom value="HL7 FAST Consent IG"/>
<parent
value="Requirements-extended-operations-client-admin-service.html#requirement-466"/>
<reference
value="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"/>
</statement>
<statement>
<key value="440"/>
<label value="requirement-440"/>
<conformance value="SHALL"/>
<conditionality value="false"/>
<requirement
value="The RevokeConsent operation "consent" input parameter SHALL be 1..1 and conform to the FASTConsent profile"/>
<derivedFrom value="HL7 FAST Consent IG"/>
<parent
value="Requirements-extended-operations-client-admin-service.html#requirement-466"/>
<reference
value="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"/>
</statement>
<statement>
<key value="447"/>
<label value="requirement-447"/>
<conformance value="SHALL"/>
<conditionality value="false"/>
<requirement
value="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
- Consider tracking that"/>
<derivedFrom value="HL7 FAST Consent IG"/>
<parent
value="Requirements-extended-operations-client-admin-service.html#requirement-466"/>
<reference
value="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"/>
</statement>
<statement>
<key value="442"/>
<label value="requirement-442"/>
<conformance value="SHALL"/>
<conditionality value="false"/>
<requirement
value="The RevokeConsent operation "document" input parameter SHALL be 0..1 and any resource"/>
<derivedFrom value="HL7 FAST Consent IG"/>
<parent
value="Requirements-extended-operations-client-admin-service.html#requirement-466"/>
<reference
value="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"/>
</statement>
<statement>
<key value="444"/>
<label value="requirement-444"/>
<conformance value="SHALL"/>
<conditionality value="false"/>
<requirement
value="The RevokeConsent operation "return" output parameter SHALL be 0..1 and be an OperationOutcome"/>
<derivedFrom value="HL7 FAST Consent IG"/>
<parent
value="Requirements-extended-operations-client-admin-service.html#requirement-466"/>
<reference
value="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"/>
</statement>
<statement>
<key value="467"/>
<label value="requirement-467"/>
<conformance value="SHALL"/>
<conditionality value="false"/>
<requirement value="OperationDefinition RecordDisclosure"/>
<derivedFrom value="HL7 FAST Consent IG"/>
<reference
value="https://build.fhir.org/ig/HL7/fhir-consent-management/OperationDefinition-record-disclosure.html"/>
</statement>
<statement>
<key value="445"/>
<label value="requirement-445"/>
<conformance value="SHALL"/>
<conditionality value="false"/>
<requirement
value="The RecordDisclosure operation is invoked as [base]/AuditEvent/$recordDisclosure"/>
<derivedFrom value="HL7 FAST Consent IG"/>
<parent
value="Requirements-extended-operations-client-admin-service.html#requirement-467"/>
<reference
value="https://build.fhir.org/ig/HL7/fhir-consent-management/OperationDefinition-record-disclosure.html#:~:text=URL%3A%20%5Bbase%5D/AuditEvent/%24recordDisclosure"/>
</statement>
<statement>
<key value="446"/>
<label value="requirement-446"/>
<conformance value="SHALL"/>
<conditionality value="false"/>
<requirement
value="The RecordDisclosure operation input parameters SHALL conform to the RecordDisclosureParameters profile"/>
<derivedFrom value="HL7 FAST Consent IG"/>
<parent
value="Requirements-extended-operations-client-admin-service.html#requirement-467"/>
<reference
value="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"/>
</statement>
<statement>
<key value="451"/>
<label value="requirement-451"/>
<conformance value="SHALL"/>
<conditionality value="false"/>
<requirement
value="The RecordDisclosure operation "disclosure" input parameter SHALL be 1..1 and an AuditEvent resource"/>
<derivedFrom value="HL7 FAST Consent IG"/>
<parent
value="Requirements-extended-operations-client-admin-service.html#requirement-467"/>
<reference
value="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"/>
</statement>
<statement>
<key value="449"/>
<label value="requirement-449"/>
<conformance value="SHALL"/>
<conditionality value="false"/>
<requirement
value="The RecordDisclosure operation "consent" input parameter SHALL be 1..1 and conform to the FASTConsent profile"/>
<derivedFrom value="HL7 FAST Consent IG"/>
<parent
value="Requirements-extended-operations-client-admin-service.html#requirement-467"/>
<reference
value="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"/>
</statement>
<statement>
<key value="453"/>
<label value="requirement-453"/>
<conformance value="SHALL"/>
<conditionality value="false"/>
<requirement
value="The RecordDisclosure operation "return" output parameter SHALL be 0..1 and be an OperationOutcome"/>
<derivedFrom value="HL7 FAST Consent IG"/>
<reference
value="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"/>
</statement>
</Requirements>
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