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 |
<OperationDefinition xmlns="http://hl7.org/fhir">
<id value="revoke-consent"/>
<text>
<status value="generated"/>
<div xmlns="http://www.w3.org/1999/xhtml"><p class="res-header-id"><b>Generated Narrative: OperationDefinition revoke-consent</b></p><a name="revoke-consent"> </a><a name="hcrevoke-consent"> </a><p>URL: [base]/Consent/$revokeConsent</p><p>Input parameters Profile:<a href="StructureDefinition-RevokeConsentParameters.html">Revoke Consent Operation Parameters</a></p><h3>Parameters</h3><table class="grid"><tr><td><b>Use</b></td><td><b>Name</b></td><td><b>Scope</b></td><td><b>Cardinality</b></td><td><b>Type</b></td><td><b>Binding</b></td><td><b>Documentation</b></td></tr><tr><td>IN</td><td>consent</td><td/><td>1..1</td><td><a href="http://hl7.org/fhir/R4/references.html#Reference">Reference</a> (<a href="StructureDefinition-FASTConsent.html" title="http://hl7.org/fhir/us/consent-management/StructureDefinition/FASTConsent">FASTConsent</a>)</td><td/><td><div><p>A reference to the Consent instance to revoke (see Input Parameters Profile for conformance)</p>
</div></td></tr><tr><td>IN</td><td>patient</td><td/><td>1..1</td><td><a href="http://hl7.org/fhir/R4/references.html#Reference">Reference</a> (<a href="http://hl7.org/fhir/us/core/STU6.1/StructureDefinition-us-core-patient.html" title="http://hl7.org/fhir/us/core/StructureDefinition/us-core-patient">US Core Patient Profile</a>)</td><td/><td><div><p>A reference to the Patient who the revoked Consent is about (see Input Parameters Profile for conformance)</p>
</div></td></tr><tr><td>IN</td><td>document</td><td/><td>0..1</td><td><a href="http://hl7.org/fhir/R4/resource.html">Resource</a></td><td/><td><div><p>Accompanying documentation for the revocation of the Consent in the form of a DocumentReference or QuestionnaireResponse (see Input Parameters Profile for conformance)</p>
</div></td></tr><tr><td>OUT</td><td>return</td><td/><td>0..1</td><td><a href="http://hl7.org/fhir/R4/operationoutcome.html">OperationOutcome</a></td><td/><td><div><p>Optional outcome of the operation call</p>
</div></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/OperationDefinition/revoke-consent"/>
<version value="0.1.0"/>
<name value="RevokeConsent"/>
<title value="Revoke a Consent"/>
<status value="active"/>
<kind value="operation"/>
<date value="2025-08-07T19:06:30+00: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="This operation is used to revoke a consent with a consent administration service. The parameters are a reference to the Consent resource along with accompanying documentation in the form of a DocumentReference (for PDF or other forms) or QuestionnaireResponse."/>
<jurisdiction>
<coding>
<system value="urn:iso:std:iso:3166"/>
<code value="US"/>
<display value="United States of America"/>
</coding>
</jurisdiction>
<code value="revokeConsent"/>
<resource value="Consent"/>
<system value="false"/>
<type value="true"/>
<instance value="false"/>
<inputProfile
value="http://hl7.org/fhir/us/consent-management/StructureDefinition/RevokeConsentParameters"/>
<parameter>
<name value="consent"/>
<use value="in"/>
<min value="1"/>
<max value="1"/>
<documentation
value="A reference to the Consent instance to revoke (see Input Parameters Profile for conformance)"/>
<type value="Reference"/>
<targetProfile
value="http://hl7.org/fhir/us/consent-management/StructureDefinition/FASTConsent"/>
</parameter>
<parameter>
<name value="patient"/>
<use value="in"/>
<min value="1"/>
<max value="1"/>
<documentation
value="A reference to the Patient who the revoked Consent is about (see Input Parameters Profile for conformance)"/>
<type value="Reference"/>
<targetProfile
value="http://hl7.org/fhir/us/core/StructureDefinition/us-core-patient"/>
</parameter>
<parameter>
<name value="document"/>
<use value="in"/>
<min value="0"/>
<max value="1"/>
<documentation
value="Accompanying documentation for the revocation of the Consent in the form of a DocumentReference or QuestionnaireResponse (see Input Parameters Profile for conformance)"/>
<type value="Resource"/>
</parameter>
<parameter>
<name value="return"/>
<use value="out"/>
<min value="0"/>
<max value="1"/>
<documentation value="Optional outcome of the operation call"/>
<type value="OperationOutcome"/>
</parameter>
</OperationDefinition>