Scalable Consent Management
1.0.0-ballot - STU 1 Ballot
Scalable Consent Management
1.0.0-ballot - STU 1 Ballot
This page is part of the Scalable Consent Management (v1.0.0-ballot: STU 1 Ballot 1) based on FHIR (HL7® FHIR® Standard) R4. No current official version has been published yet. For a full list of available versions, see the Directory of published versions
| Official URL: http://hl7.org/fhir/us/consent-management/OperationDefinition/revoke-consent | Version: 1.0.0-ballot | |||
| Standards status: Trial-use | Maturity Level: 1 | Computable Name: RevokeConsent | ||
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.
URL: [base]/Consent/$revokeConsent
Input parameters Profile:Revoke Consent Operation Parameters
| Use | Name | Scope | Cardinality | Type | Binding | Documentation |
| IN | consent | 1..1 | Reference (FASTConsent) | A reference to the Consent instance to revoke (see Input Parameters Profile for conformance) | ||
| IN | patient | 1..1 | Reference (US Core Patient Profile) | A reference to the Patient who the revoked Consent is about (see Input Parameters Profile for conformance) | ||
| IN | document | 0..1 | Resource | Accompanying documentation for the revocation of the Consent in the form of a DocumentReference or QuestionnaireResponse (see Input Parameters Profile for conformance) | ||
| OUT | return | 0..1 | OperationOutcome | Optional outcome of the operation call |
IG © 2024+ HL7 International / Community Based Collaborative Care. Package hl7.fhir.us.consent-management#1.0.0-ballot based on FHIR 4.0.1. Generated 2025-12-15
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change