| Package | hl7.fhir.us.consent-management |
| Resource Type | OperationDefinition |
| Id | revoke-consent |
| FHIR Version | R4 |
| Source | http://hl7.org/fhir/us/consent-management/https://build.fhir.org/ig/HL7/fhir-consent-management/OperationDefinition-revoke-consent.html |
| URL | http://hl7.org/fhir/us/consent-management/OperationDefinition/revoke-consent |
| Version | 0.1.0 |
| Status | active |
| Date | 2025-08-07T19:06:30+00:00 |
| Name | RevokeConsent |
| Title | Revoke a Consent |
| Realm | us |
| Authority | hl7 |
| Description | 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. |
| Type | true |
| Kind | operation |
| CapabilityStatement | |
| ConsentAdministrativeServerCapabilities | Consent Administrative Server Capabilities |
| ConsentClientCapabilities | Consent Client Capabilities |
No resources found
Note: links and images are rebased to the (stated) source
Generated Narrative: OperationDefinition revoke-consent
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 |
{
"resourceType": "OperationDefinition",
"id": "revoke-consent",
"text": {
"status": "generated",
"div": "<!-- snip (see above) -->"
},
"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/OperationDefinition/revoke-consent",
"version": "0.1.0",
"name": "RevokeConsent",
"title": "Revoke a Consent",
"status": "active",
"kind": "operation",
"date": "2025-08-07T19:06:30+00: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": "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": "urn:iso:std:iso:3166",
"code": "US",
"display": "United States of America"
}
]
}
],
"code": "revokeConsent",
"resource": [
"Consent"
],
"system": false,
"type": true,
"instance": false,
"inputProfile": "http://hl7.org/fhir/us/consent-management/StructureDefinition/RevokeConsentParameters",
"parameter": [
{
"name": "consent",
"use": "in",
"min": 1,
"max": "1",
"documentation": "A reference to the Consent instance to revoke (see Input Parameters Profile for conformance)",
"type": "Reference",
"targetProfile": [
"http://hl7.org/fhir/us/consent-management/StructureDefinition/FASTConsent"
]
},
{
"name": "patient",
"use": "in",
"min": 1,
"max": "1",
"documentation": "A reference to the Patient who the revoked Consent is about (see Input Parameters Profile for conformance)",
"type": "Reference",
"targetProfile": [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-patient"
]
},
{
"name": "document",
"use": "in",
"min": 0,
"max": "1",
"documentation": "Accompanying documentation for the revocation of the Consent in the form of a DocumentReference or QuestionnaireResponse (see Input Parameters Profile for conformance)",
"type": "Resource"
},
{
"name": "return",
"use": "out",
"min": 0,
"max": "1",
"documentation": "Optional outcome of the operation call",
"type": "OperationOutcome"
}
]
}