FHIR IG Statistics: OperationDefinition/revoke-consent

Resources that use this resource

No resources found

Resources that this resource uses

No resources found

Narrative

Note: links and images are rebased to the (stated) source

Source

{
  "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-07-09T21:09:16+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 DocumentReferences (for PDF or other forms) or QuestionnaireResponses.",
  "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",
      "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",
      "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",
      "type": "Resource",
      "targetProfile": [
        "http://hl7.org/fhir/us/core/StructureDefinition/us-core-questionnaireresponse",
        "http://hl7.org/fhir/us/consent-management/StructureDefinition/FASTDocumentReference"
      ]
    },
    {
      "name": "return",
      "use": "out",
      "min": 0,
      "max": "1",
      "documentation": "Optional outcome of the operation call",
      "type": "OperationOutcome"
    }
  ]
}