FHIR © HL7.org  |  Server Home  |  XIG Home  |  XIG Stats  |  Server Source  |  FHIR  

FHIR IG Statistics: OperationDefinition/update-consent

Packagehl7.fhir.us.consent-management
Resource TypeOperationDefinition
Idupdate-consent
FHIR VersionR4
Sourcehttp://hl7.org/fhir/us/consent-management/https://build.fhir.org/ig/HL7/fhir-consent-management/OperationDefinition-update-consent.html
URLhttp://hl7.org/fhir/us/consent-management/OperationDefinition/update-consent
Version0.1.0
Statusactive
Date2025-08-07T19:06:30+00:00
NameUpdateConsent
TitleUpdate a Consent
Realmus
Authorityhl7
DescriptionThis operation is used to update 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.
Typetrue
Kindoperation

Resources that use this resource

CapabilityStatement
ConsentAdministrativeServerCapabilitiesConsent Administrative Server Capabilities
ConsentClientCapabilitiesConsent Client Capabilities

Resources that this resource uses

No resources found


Narrative

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

Generated Narrative: OperationDefinition update-consent

URL: [base]/Consent/$updateConsent

Input parameters Profile:Update Consent Operation Parameters

Parameters

UseNameScopeCardinalityTypeBindingDocumentation
INconsent1..1Consent

The Consent instance to update (see Input Parameters Profile for conformance)

INdocument1..1Resource

Accompanying documentation for the Consent in the form of a DocumentReference or QuestionnaireResponse (see Input Parameters Profile for conformance)

OUTreturn0..1OperationOutcome

Optional outcome of the operation call


Source

{
  "resourceType": "OperationDefinition",
  "id": "update-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/update-consent",
  "version": "0.1.0",
  "name": "UpdateConsent",
  "title": "Update 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 update 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": "updateConsent",
  "resource": [
    "Consent"
  ],
  "system": false,
  "type": true,
  "instance": false,
  "inputProfile": "http://hl7.org/fhir/us/consent-management/StructureDefinition/UpdateConsentParameters",
  "parameter": [
    {
      "name": "consent",
      "use": "in",
      "min": 1,
      "max": "1",
      "documentation": "The Consent instance to update (see Input Parameters Profile for conformance)",
      "type": "Consent"
    },
    {
      "name": "document",
      "use": "in",
      "min": 1,
      "max": "1",
      "documentation": "Accompanying documentation for 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"
    }
  ]
}