Scalable Consent Management
0.1.0 - ci-build United States of America flag

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

Resource Profile: File Consent Operation Parameters

Official URL: http://hl7.org/fhir/us/consent-management/StructureDefinition/FileConsentParameters Version: 0.1.0
Standards status: Trial-use Maturity Level: 1 Computable Name: FileConsentParameters

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

Usages:

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. 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

doco Documentation for this format

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
inv-1errorParameters.parameter, Parameters.parameter:consent, Parameters.parameter:documentA 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()))

This structure is derived from Parameters

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. 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
..... resource S 1..1 Resource If parameter is a whole resource
..... part 0..0
.... 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

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. 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
... 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

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Parameters.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages
From the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
inv-1errorParameters.parameter, Parameters.parameter:consent, Parameters.parameter:documentA 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()))

This structure is derived from Parameters

Summary

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

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

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

Maturity: 1

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. 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

doco Documentation for this format

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
inv-1errorParameters.parameter, Parameters.parameter:consent, Parameters.parameter:documentA 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

This structure is derived from Parameters

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. 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
..... resource S 1..1 Resource If parameter is a whole resource
..... part 0..0
.... 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

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. 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
... 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

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Parameters.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages
From the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
inv-1errorParameters.parameter, Parameters.parameter:consent, Parameters.parameter:documentA 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()))

This structure is derived from Parameters

Summary

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

Structures

This structure refers to these other structures:

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