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 1.0.0-preview 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

• Content
• Detailed Descriptions
• Mappings
• Examples
• XML
• JSON
• TTL

Resource Profile: File Consent Operation Parameters

A profile that indicates the parameters for the File Consent operation.

Usages:

• Examples for this Profile: Parameters/FileConsentDocRefExample and Parameters/FileConsentQuestionnaireExample

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

Description Differentials, Snapshots, and other representations.

• Key Elements Table
• Differential Table
• Snapshot Table
• Statistics/References
• All

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Parameters		0..*	Parameters	Operation Request or Response
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
Slices for parameter	ΣC	2..*	BackboneElement	Operation Parameter Slice: Unordered, Open by value:name Constraints: inv-1
parameter:All Slices				Content/Rules for all slices
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
name	Σ	1..1	string	Name from the definition
resource	SΣC	1..1	Resource	If parameter is a whole resource
parameter:consent	SΣC	1..1	BackboneElement	Operation Parameter Constraints: inv-1
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
name	Σ	1..1	string	Name from the definition Required Pattern: consent
resource	S	1..1	FASTConsent	A healthcare consumer's choices to permit or deny recipients or roles to perform actions for specific purposes and periods of time
parameter:document	SΣC	1..1	BackboneElement	Operation Parameter Constraints: inv-1
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
name	Σ	1..1	string	Name from the definition Required Pattern: document
resource	S	1..1	FASTDocumentReference, USCoreQuestionnaireResponseProfile	A reference to a document
Documentation for this format

Constraints

Id	Grade	Path(s)	Description	Expression
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children	hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both	extension.exists() != value.exists()
inv-1	error	Parameters.parameter, Parameters.parameter:consent, Parameters.parameter:document	A parameter must have one and only one of (value, resource, part)	(part.exists() and value.empty() and resource.empty()) or (part.empty() and (value.exists() xor resource.exists()))

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Parameters		0..*	Parameters	Operation Request or Response
Slices for parameter		2..*	BackboneElement	Operation Parameter Slice: Unordered, Open by value:name
parameter:All Slices				Content/Rules for all slices
value[x]		0..0		If parameter is a data type
resource	S	1..1	Resource	If parameter is a whole resource
part		0..0		Named part of a multi-part parameter
parameter:consent	S	1..1	BackboneElement	Operation Parameter
name		1..1	string	Name from the definition Required Pattern: consent
resource		1..1	FASTConsent	A healthcare consumer's choices to permit or deny recipients or roles to perform actions for specific purposes and periods of time
parameter:document	S	1..1	BackboneElement	Operation Parameter
name		1..1	string	Name from the definition Required Pattern: document
resource		1..1	FASTDocumentReference, USCoreQuestionnaireResponseProfile	A reference to a document
Documentation for this format

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Parameters		0..*	Parameters	Operation Request or Response
id	Σ	0..1	id	Logical id of this artifact
meta	Σ	0..1	Meta	Metadata about the resource
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
language		0..1	code	Language of the resource content Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
Slices for parameter	ΣC	2..*	BackboneElement	Operation Parameter Slice: Unordered, Open by value:name Constraints: inv-1
parameter:All Slices				Content/Rules for all slices
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
name	Σ	1..1	string	Name from the definition
resource	SΣC	1..1	Resource	If parameter is a whole resource
parameter:consent	SΣC	1..1	BackboneElement	Operation Parameter Constraints: inv-1
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
name	Σ	1..1	string	Name from the definition Required Pattern: consent
resource	S	1..1	FASTConsent	A healthcare consumer's choices to permit or deny recipients or roles to perform actions for specific purposes and periods of time
parameter:document	SΣC	1..1	BackboneElement	Operation Parameter Constraints: inv-1
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
name	Σ	1..1	string	Name from the definition Required Pattern: document
resource	S	1..1	FASTDocumentReference, USCoreQuestionnaireResponseProfile	A reference to a document
Documentation for this format

Terminology Bindings

Path	Status	Usage	ValueSet	Version	Source
Parameters.language	Base	preferred	Common Languages	📍4.0.1	FHIR Std.

Constraints

Id	Grade	Path(s)	Description	Expression
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children	hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both	extension.exists() != value.exists()
inv-1	error	Parameters.parameter, Parameters.parameter:consent, Parameters.parameter:document	A parameter must have one and only one of (value, resource, part)	(part.exists() and value.empty() and resource.empty()) or (part.empty() and (value.exists() xor resource.exists()))

Summary

Mandatory: 3 elements
Must-Support: 3 elements
Prohibited: 2 elements

Structures

This structure refers to these other structures:

• FASTConsent (http://hl7.org/fhir/us/consent-management/StructureDefinition/FASTConsent)
• FASTDocumentReference (http://hl7.org/fhir/us/consent-management/StructureDefinition/FASTDocumentReference)
• US Core QuestionnaireResponse Profile (http://hl7.org/fhir/us/core/StructureDefinition/us-core-questionnaireresponse)

Slices

This structure defines the following Slices:

• The element 1 is sliced based on the value of Parameters.parameter

Maturity: 1

Key Elements View

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Parameters		0..*	Parameters	Operation Request or Response
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
Slices for parameter	ΣC	2..*	BackboneElement	Operation Parameter Slice: Unordered, Open by value:name Constraints: inv-1
parameter:All Slices				Content/Rules for all slices
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
name	Σ	1..1	string	Name from the definition
resource	SΣC	1..1	Resource	If parameter is a whole resource
parameter:consent	SΣC	1..1	BackboneElement	Operation Parameter Constraints: inv-1
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
name	Σ	1..1	string	Name from the definition Required Pattern: consent
resource	S	1..1	FASTConsent	A healthcare consumer's choices to permit or deny recipients or roles to perform actions for specific purposes and periods of time
parameter:document	SΣC	1..1	BackboneElement	Operation Parameter Constraints: inv-1
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
name	Σ	1..1	string	Name from the definition Required Pattern: document
resource	S	1..1	FASTDocumentReference, USCoreQuestionnaireResponseProfile	A reference to a document
Documentation for this format

Constraints

Id	Grade	Path(s)	Description	Expression
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children	hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both	extension.exists() != value.exists()
inv-1	error	Parameters.parameter, Parameters.parameter:consent, Parameters.parameter:document	A parameter must have one and only one of (value, resource, part)	(part.exists() and value.empty() and resource.empty()) or (part.empty() and (value.exists() xor resource.exists()))

Differential View

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Parameters		0..*	Parameters	Operation Request or Response
Slices for parameter		2..*	BackboneElement	Operation Parameter Slice: Unordered, Open by value:name
parameter:All Slices				Content/Rules for all slices
value[x]		0..0		If parameter is a data type
resource	S	1..1	Resource	If parameter is a whole resource
part		0..0		Named part of a multi-part parameter
parameter:consent	S	1..1	BackboneElement	Operation Parameter
name		1..1	string	Name from the definition Required Pattern: consent
resource		1..1	FASTConsent	A healthcare consumer's choices to permit or deny recipients or roles to perform actions for specific purposes and periods of time
parameter:document	S	1..1	BackboneElement	Operation Parameter
name		1..1	string	Name from the definition Required Pattern: document
resource		1..1	FASTDocumentReference, USCoreQuestionnaireResponseProfile	A reference to a document
Documentation for this format

Snapshot ViewView

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Parameters		0..*	Parameters	Operation Request or Response
id	Σ	0..1	id	Logical id of this artifact
meta	Σ	0..1	Meta	Metadata about the resource
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
language		0..1	code	Language of the resource content Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
Slices for parameter	ΣC	2..*	BackboneElement	Operation Parameter Slice: Unordered, Open by value:name Constraints: inv-1
parameter:All Slices				Content/Rules for all slices
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
name	Σ	1..1	string	Name from the definition
resource	SΣC	1..1	Resource	If parameter is a whole resource
parameter:consent	SΣC	1..1	BackboneElement	Operation Parameter Constraints: inv-1
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
name	Σ	1..1	string	Name from the definition Required Pattern: consent
resource	S	1..1	FASTConsent	A healthcare consumer's choices to permit or deny recipients or roles to perform actions for specific purposes and periods of time
parameter:document	SΣC	1..1	BackboneElement	Operation Parameter Constraints: inv-1
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
name	Σ	1..1	string	Name from the definition Required Pattern: document
resource	S	1..1	FASTDocumentReference, USCoreQuestionnaireResponseProfile	A reference to a document
Documentation for this format

Terminology Bindings

Path	Status	Usage	ValueSet	Version	Source
Parameters.language	Base	preferred	Common Languages	📍4.0.1	FHIR Std.

Constraints

Id	Grade	Path(s)	Description	Expression
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children	hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both	extension.exists() != value.exists()
inv-1	error	Parameters.parameter, Parameters.parameter:consent, Parameters.parameter:document	A parameter must have one and only one of (value, resource, part)	(part.exists() and value.empty() and resource.empty()) or (part.empty() and (value.exists() xor resource.exists()))

Summary

Mandatory: 3 elements
Must-Support: 3 elements
Prohibited: 2 elements

Structures

This structure refers to these other structures:

• FASTConsent (http://hl7.org/fhir/us/consent-management/StructureDefinition/FASTConsent)
• FASTDocumentReference (http://hl7.org/fhir/us/consent-management/StructureDefinition/FASTDocumentReference)
• US Core QuestionnaireResponse Profile (http://hl7.org/fhir/us/core/StructureDefinition/us-core-questionnaireresponse)

Slices

This structure defines the following Slices:

• The element 1 is sliced based on the value of Parameters.parameter

Maturity: 1

Other representations of profile: CSV, Excel, Schematron