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 |
@prefix fhir: <http://hl7.org/fhir/> .
@prefix owl: <http://www.w3.org/2002/07/owl#> .
@prefix rdf: <http://www.w3.org/1999/02/22-rdf-syntax-ns#> .
@prefix rdfs: <http://www.w3.org/2000/01/rdf-schema#> .
@prefix xsd: <http://www.w3.org/2001/XMLSchema#> .
# - resource -------------------------------------------------------------------
a fhir:OperationDefinition ;
fhir:nodeRole fhir:treeRoot ;
fhir:id [ fhir:v "revoke-consent"] ; #
fhir:text [
fhir:status [ fhir:v "generated" ] ;
fhir:div "<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>\n</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>\n</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>\n</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>\n</div></td></tr></table></div>"^^rdf:XMLLiteral
] ; #
fhir:extension ( [
fhir:url [ fhir:v "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg"^^xsd:anyURI ] ;
fhir:value [
a fhir:code ;
fhir:v "cbcc" ]
] [
fhir:url [ fhir:v "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm"^^xsd:anyURI ] ;
fhir:value [
a fhir:integer ;
fhir:v 1 ;
( fhir:extension [
fhir:url [ fhir:v "http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom"^^xsd:anyURI ] ;
fhir:value [
a fhir:canonical ;
fhir:v "http://hl7.org/fhir/us/consent-management/ImplementationGuide/hl7.fhir.us.consent-management"^^xsd:anyURI ;
fhir:link <http://hl7.org/fhir/us/consent-management/ImplementationGuide/hl7.fhir.us.consent-management> ] ] ) ]
] [
fhir:url [ fhir:v "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status"^^xsd:anyURI ] ;
fhir:value [
a fhir:code ;
fhir:v "trial-use" ;
( fhir:extension [
fhir:url [ fhir:v "http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom"^^xsd:anyURI ] ;
fhir:value [
a fhir:canonical ;
fhir:v "http://hl7.org/fhir/us/consent-management/ImplementationGuide/hl7.fhir.us.consent-management"^^xsd:anyURI ;
fhir:link <http://hl7.org/fhir/us/consent-management/ImplementationGuide/hl7.fhir.us.consent-management> ] ] ) ]
] ) ; #
fhir:url [ fhir:v "http://hl7.org/fhir/us/consent-management/OperationDefinition/revoke-consent"^^xsd:anyURI] ; #
fhir:version [ fhir:v "0.1.0"] ; #
fhir:name [ fhir:v "RevokeConsent"] ; #
fhir:title [ fhir:v "Revoke a Consent"] ; #
fhir:status [ fhir:v "active"] ; #
fhir:kind [ fhir:v "operation"] ; #
fhir:date [ fhir:v "2025-08-07T19:06:30+00:00"^^xsd:dateTime] ; #
fhir:publisher [ fhir:v "HL7 International / Community Based Collaborative Care"] ; #
fhir:contact ( [
fhir:name [ fhir:v "HL7 International / Community Based Collaborative Care" ] ;
( fhir:telecom [
fhir:system [ fhir:v "url" ] ;
fhir:value [ fhir:v "http://www.hl7.org/Special/committees/cbcc" ] ] )
] ) ; #
fhir:description [ fhir:v "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."] ; #
fhir:jurisdiction ( [
( fhir:coding [
fhir:system [ fhir:v "urn:iso:std:iso:3166"^^xsd:anyURI ] ;
fhir:code [ fhir:v "US" ] ;
fhir:display [ fhir:v "United States of America" ] ] )
] ) ; #
fhir:code [ fhir:v "revokeConsent"] ; #
fhir:resource ( [ fhir:v "Consent"] ) ; #
fhir:system [ fhir:v false] ; #
fhir:type [ fhir:v true] ; #
fhir:instance [ fhir:v false] ; #
fhir:inputProfile [
fhir:v "http://hl7.org/fhir/us/consent-management/StructureDefinition/RevokeConsentParameters"^^xsd:anyURI ;
fhir:link <http://hl7.org/fhir/us/consent-management/StructureDefinition/RevokeConsentParameters>
] ; #
fhir:parameter ( [
fhir:name [ fhir:v "consent" ] ;
fhir:use [ fhir:v "in" ] ;
fhir:min [ fhir:v 1 ] ;
fhir:max [ fhir:v "1" ] ;
fhir:documentation [ fhir:v "A reference to the Consent instance to revoke (see Input Parameters Profile for conformance)" ] ;
fhir:type [ fhir:v "Reference" ] ;
( fhir:targetProfile [
fhir:v "http://hl7.org/fhir/us/consent-management/StructureDefinition/FASTConsent"^^xsd:anyURI ;
fhir:link <http://hl7.org/fhir/us/consent-management/StructureDefinition/FASTConsent> ] )
] [
fhir:name [ fhir:v "patient" ] ;
fhir:use [ fhir:v "in" ] ;
fhir:min [ fhir:v 1 ] ;
fhir:max [ fhir:v "1" ] ;
fhir:documentation [ fhir:v "A reference to the Patient who the revoked Consent is about (see Input Parameters Profile for conformance)" ] ;
fhir:type [ fhir:v "Reference" ] ;
( fhir:targetProfile [
fhir:v "http://hl7.org/fhir/us/core/StructureDefinition/us-core-patient"^^xsd:anyURI ;
fhir:link <http://hl7.org/fhir/us/core/StructureDefinition/us-core-patient> ] )
] [
fhir:name [ fhir:v "document" ] ;
fhir:use [ fhir:v "in" ] ;
fhir:min [ fhir:v 0 ] ;
fhir:max [ fhir:v "1" ] ;
fhir:documentation [ fhir:v "Accompanying documentation for the revocation of the Consent in the form of a DocumentReference or QuestionnaireResponse (see Input Parameters Profile for conformance)" ] ;
fhir:type [ fhir:v "Resource" ]
] [
fhir:name [ fhir:v "return" ] ;
fhir:use [ fhir:v "out" ] ;
fhir:min [ fhir:v 0 ] ;
fhir:max [ fhir:v "1" ] ;
fhir:documentation [ fhir:v "Optional outcome of the operation call" ] ;
fhir:type [ fhir:v "OperationOutcome" ]
] ) . #
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-08-07
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change