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

• Narrative Content
• XML
• JSON
• TTL

: File a Consent - JSON Representation

Raw json | Download

{
  "resourceType" : "OperationDefinition",
  "id" : "file-consent",
  "text" : {
    "status" : "generated",
    "div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p class=\"res-header-id\"><b>Generated Narrative: OperationDefinition file-consent</b></p><a name=\"file-consent\"> </a><a name=\"hcfile-consent\"> </a><p>URL: [base]/Consent/$fileConsent</p><p>Input parameters Profile:<a href=\"StructureDefinition-FileConsentParameters.html\">File 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/consent.html\">Consent</a></td><td/><td><div><p>The Consent instance to file (see Input Parameters Profile for conformance)</p>\n</div></td></tr><tr><td>IN</td><td>document</td><td/><td>1..1</td><td><a href=\"http://hl7.org/fhir/R4/resource.html\">Resource</a></td><td/><td><div><p>Accompanying documentation for 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>"
  },
  "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/file-consent",
  "version" : "0.1.0",
  "name" : "FileConsent",
  "title" : "File a Consent",
  "status" : "active",
  "kind" : "operation",
  "date" : "2025-09-05T14:24:01+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 file a consent with a consent administration service.  The parameters are 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" : "fileConsent",
  "resource" : [
    "Consent"
  ],
  "system" : false,
  "type" : true,
  "instance" : false,
  "inputProfile" : "http://hl7.org/fhir/us/consent-management/StructureDefinition/FileConsentParameters",
  "parameter" : [
    {
      "name" : "consent",
      "use" : "in",
      "min" : 1,
      "max" : "1",
      "documentation" : "The Consent instance to file (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"
    }
  ]
}