Package | hl7.fhir.us.consent-management |
Type | OperationDefinition |
Id | file-consent |
FHIR Version | R4 |
Source | http://hl7.org/fhir/us/consent-management/https://build.fhir.org/ig/HL7/fhir-consent-management/OperationDefinition-file-consent.html |
URL | http://hl7.org/fhir/us/consent-management/OperationDefinition/file-consent |
Version | 0.1.0 |
Status | active |
Date | 2025-07-09T21:09:16+00:00 |
Name | FileConsent |
Title | File a Consent |
Realm | us |
Authority | hl7 |
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. |
Type | true |
Kind | operation |
CapabilityStatement | |
ConsentAdministrativeServerCapabilities | Consent Administrative Server Capabilities |
ConsentClientCapabilities | Consent Client Capabilities |
No resources found
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
Use | Name | Scope | Cardinality | Type | Binding | Documentation |
IN | consent | 1..1 | Consent (FASTConsent) | The Consent instance to file | ||
IN | document | 1..1 | Resource (US Core QuestionnaireResponse Profile, FASTDocumentReference) | Accompanying documentation for the Consent | ||
OUT | return | 0..1 | OperationOutcome | Optional outcome of the operation call |
{ "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" } ] }