Scalable Consent Management
1.0.0-preview - STU 1 PReview United States of America flag

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 1.0.0-preview 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

: Revoke a Consent

Page standards status: Trial-use Maturity Level: 1

Raw ttl | Download


@prefix fhir: <http://hl7.org/fhir/> .
@prefix owl: <http://www.w3.org/2002/07/owl#> .
@prefix rdfs: <http://www.w3.org/2000/01/rdf-schema#> .
@prefix xsd: <http://www.w3.org/2001/XMLSchema#> .

# - resource -------------------------------------------------------------------

<http://hl7.org/fhir/OperationDefinition/revoke-consent> a fhir:OperationDefinition ;
  fhir:nodeRole fhir:treeRoot ;
  fhir:Resource.id [ fhir:value "revoke-consent"] ;
  fhir:Resource.language [ fhir:value "en"] ;
  fhir:DomainResource.text [
     fhir:Narrative.status [ fhir:value "generated" ] ;
     fhir:Narrative.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>"
  ] ;
  fhir:DomainResource.extension [
     fhir:index -1 ;
     fhir:Extension.url [ fhir:value "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg" ] ;
     fhir:Extension.valueCode [ fhir:value "cbcc" ]
  ], [
     fhir:index -1 ;
     fhir:Extension.url [ fhir:value "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm" ] ;
     fhir:Extension.valueInteger [
       fhir:value "1"^^xsd:integer ;
       fhir:Element.extension [
         fhir:index -1 ;
         fhir:Extension.url [ fhir:value "http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom" ] ;
         fhir:Extension.valueCanonical [
           fhir:value "http://hl7.org/fhir/us/consent-management/ImplementationGuide/hl7.fhir.us.consent-management" ;
           fhir:link <http://hl7.org/fhir/us/consent-management/ImplementationGuide/hl7.fhir.us.consent-management>
         ]
       ]
     ]
  ], [
     fhir:index -1 ;
     fhir:Extension.url [ fhir:value "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status" ] ;
     fhir:Extension.valueCode [
       fhir:value "trial-use" ;
       fhir:Element.extension [
         fhir:index -1 ;
         fhir:Extension.url [ fhir:value "http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom" ] ;
         fhir:Extension.valueCanonical [
           fhir:value "http://hl7.org/fhir/us/consent-management/ImplementationGuide/hl7.fhir.us.consent-management" ;
           fhir:link <http://hl7.org/fhir/us/consent-management/ImplementationGuide/hl7.fhir.us.consent-management>
         ]
       ]
     ]
  ] ;
  fhir:OperationDefinition.url [ fhir:value "http://hl7.org/fhir/us/consent-management/OperationDefinition/revoke-consent"] ;
  fhir:OperationDefinition.version [ fhir:value "1.0.0-preview"] ;
  fhir:OperationDefinition.name [ fhir:value "RevokeConsent"] ;
  fhir:OperationDefinition.title [ fhir:value "Revoke a Consent"] ;
  fhir:OperationDefinition.status [ fhir:value "active"] ;
  fhir:OperationDefinition.kind [ fhir:value "operation"] ;
  fhir:OperationDefinition.date [ fhir:value "2026-09-11T19:37:25+00:00"^^xsd:dateTime] ;
  fhir:OperationDefinition.publisher [ fhir:value "HL7 International / Community Based Collaborative Care"] ;
  fhir:OperationDefinition.contact [
     fhir:index -1 ;
     fhir:ContactDetail.name [ fhir:value "HL7 International / Community Based Collaborative Care" ] ;
     fhir:ContactDetail.telecom [
       fhir:index -1 ;
       fhir:ContactPoint.system [ fhir:value "url" ] ;
       fhir:ContactPoint.value [ fhir:value "http://www.hl7.org/Special/committees/homehealth" ]
     ]
  ] ;
  fhir:OperationDefinition.description [ fhir: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."] ;
  fhir:OperationDefinition.jurisdiction [
     fhir:index -1 ;
     fhir:CodeableConcept.coding [
       fhir:index -1 ;
       fhir:Coding.system [ fhir:value "urn:iso:std:iso:3166" ] ;
       fhir:Coding.code [ fhir:value "US" ] ;
       fhir:Coding.display [ fhir:value "United States of America" ]
     ]
  ] ;
  fhir:OperationDefinition.code [ fhir:value "revokeConsent"] ;
  fhir:OperationDefinition.resource [
     fhir:value "Consent" ;
     fhir:index -1
  ] ;
  fhir:OperationDefinition.system [ fhir:value "false"^^xsd:boolean] ;
  fhir:OperationDefinition.type [ fhir:value "true"^^xsd:boolean] ;
  fhir:OperationDefinition.instance [ fhir:value "false"^^xsd:boolean] ;
  fhir:OperationDefinition.inputProfile [
     fhir:value "http://hl7.org/fhir/us/consent-management/StructureDefinition/RevokeConsentParameters" ;
     fhir:link <http://hl7.org/fhir/us/consent-management/StructureDefinition/RevokeConsentParameters>
  ] ;
  fhir:OperationDefinition.parameter [
     fhir:index -1 ;
     fhir:OperationDefinition.parameter.name [ fhir:value "consent" ] ;
     fhir:OperationDefinition.parameter.use [ fhir:value "in" ] ;
     fhir:OperationDefinition.parameter.min [ fhir:value "1"^^xsd:integer ] ;
     fhir:OperationDefinition.parameter.max [ fhir:value "1" ] ;
     fhir:OperationDefinition.parameter.documentation [ fhir:value "A reference to the Consent instance to revoke (see Input Parameters Profile for conformance)" ] ;
     fhir:OperationDefinition.parameter.type [ fhir:value "Reference" ] ;
     fhir:OperationDefinition.parameter.targetProfile [
       fhir:value "http://hl7.org/fhir/us/consent-management/StructureDefinition/FASTConsent" ;
       fhir:index -1 ;
       fhir:link <http://hl7.org/fhir/us/consent-management/StructureDefinition/FASTConsent>
     ]
  ], [
     fhir:index -1 ;
     fhir:OperationDefinition.parameter.name [ fhir:value "patient" ] ;
     fhir:OperationDefinition.parameter.use [ fhir:value "in" ] ;
     fhir:OperationDefinition.parameter.min [ fhir:value "1"^^xsd:integer ] ;
     fhir:OperationDefinition.parameter.max [ fhir:value "1" ] ;
     fhir:OperationDefinition.parameter.documentation [ fhir:value "A reference to the Patient who the revoked Consent is about (see Input Parameters Profile for conformance)" ] ;
     fhir:OperationDefinition.parameter.type [ fhir:value "Reference" ] ;
     fhir:OperationDefinition.parameter.targetProfile [
       fhir:value "http://hl7.org/fhir/us/core/StructureDefinition/us-core-patient" ;
       fhir:index -1 ;
       fhir:link <http://hl7.org/fhir/us/core/StructureDefinition/us-core-patient>
     ]
  ], [
     fhir:index -1 ;
     fhir:OperationDefinition.parameter.name [ fhir:value "document" ] ;
     fhir:OperationDefinition.parameter.use [ fhir:value "in" ] ;
     fhir:OperationDefinition.parameter.min [ fhir:value "0"^^xsd:integer ] ;
     fhir:OperationDefinition.parameter.max [ fhir:value "1" ] ;
     fhir:OperationDefinition.parameter.documentation [ fhir:value "Accompanying documentation for the revocation of the Consent in the form of a DocumentReference or QuestionnaireResponse (see Input Parameters Profile for conformance)" ] ;
     fhir:OperationDefinition.parameter.type [ fhir:value "Resource" ]
  ], [
     fhir:index -1 ;
     fhir:OperationDefinition.parameter.name [ fhir:value "return" ] ;
     fhir:OperationDefinition.parameter.use [ fhir:value "out" ] ;
     fhir:OperationDefinition.parameter.min [ fhir:value "0"^^xsd:integer ] ;
     fhir:OperationDefinition.parameter.max [ fhir:value "1" ] ;
     fhir:OperationDefinition.parameter.documentation [ fhir:value "Optional outcome of the operation call" ] ;
     fhir:OperationDefinition.parameter.type [ fhir:value "OperationOutcome" ]
  ] .

# - ontology header ------------------------------------------------------------

<http://hl7.org/fhir/OperationDefinition/revoke-consent.ttl> a owl:Ontology ;
  owl:imports fhir:fhir.ttl ;
  owl:versionIRI <http://build.fhir.org/OperationDefinition/revoke-consent.ttl> .