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

FHIR IG Statistics: OperationDefinition/file-consent

Packagehl7.fhir.us.consent-management
TypeOperationDefinition
Idfile-consent
FHIR VersionR4
Sourcehttp://hl7.org/fhir/us/consent-management/https://build.fhir.org/ig/HL7/fhir-consent-management/OperationDefinition-file-consent.html
URLhttp://hl7.org/fhir/us/consent-management/OperationDefinition/file-consent
Version0.1.0
Statusactive
Date2025-07-09T21:09:16+00:00
NameFileConsent
TitleFile a Consent
Realmus
Authorityhl7
DescriptionThis 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 DocumentReferences (for PDF or other forms) or QuestionnaireResponses.
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 file-consent

URL: [base]/Consent/$fileConsent

Input parameters Profile:File Consent Operation Parameters

Parameters

UseNameScopeCardinalityTypeBindingDocumentation
INconsent1..1Consent (FASTConsent)

The Consent instance to file

INdocument1..1Resource (US Core QuestionnaireResponse Profile, FASTDocumentReference)

Accompanying documentation for the Consent

OUTreturn0..1OperationOutcome

Optional outcome of the operation call


Source

{
  "resourceType": "OperationDefinition",
  "id": "file-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/file-consent",
  "version": "0.1.0",
  "name": "FileConsent",
  "title": "File 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 file a consent with a consent administration service.  The parameters are 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": "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",
      "type": "Consent",
      "targetProfile": [
        "http://hl7.org/fhir/us/consent-management/StructureDefinition/FASTConsent"
      ]
    },
    {
      "name": "document",
      "use": "in",
      "min": 1,
      "max": "1",
      "documentation": "Accompanying documentation for 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"
    }
  ]
}