FHIR Release 3 (STU) CI-Build

This page is part of the FHIR Specification (v3.0.2: STU 3). The current version which supercedes this version is 5.0.0 . For a full list Continuous Integration Build of available versions, see FHIR (will be incorrect/inconsistent at times).
See the Directory of published versions icon . Page versions: R5 R4B R4 R3

Responsible Owner: Community Based Collaborative Care icon Work Group   Normative Maturity Level : 1   Trial Use Security Category : Patient Compartments : Group , Patient

Detailed Descriptions for the elements in the Consent resource.

Control Comments Comments Comments Comments Definition Control Meaning if Missing Comments Invariants Invariants Control All Security Labels Type Control Control Consent.except.period Control Control Comments Control
Definition Element Id Consent
Definition

A record of a healthcare consumer’s policy choices, choices or choices made on their behalf by a third party, which permits or denies identified recipient(s) or recipient role(s) to perform one or more actions within a given policy context, for specific purposes and periods of time.

Short Display A healthcare consumer's or third party's choices to permit or deny recipients or roles to perform actions for specific purposes and periods of time
Control Cardinality 0..*
1..1 Type DomainResource
Comments Summary false
Comments

Broadly, there are 3 key areas of consent for patients: Consent around sharing information (aka Privacy Consent Directive - Authorization to Collect, Use, or Disclose information), consent for specific treatment, or kinds of treatment, treatment and general advance care directives. consent for research participation and data sharing.

Invariants Constraints : policy.exists() or policyRule.exists(), xpath: exists(f:policy)
Defined on this element
ppc-1 : Rule Either a Policy Permission (.provisionReference) or PolicyRule ( expression a .provision tree may exist but not both provisionReference.exists() or exists(f:policyRule)) provision.exists()
Definition Element Id Consent.identifier
Definition

Unique identifier for this copy of the Consent Statement.

Note Short Display Identifier for this record (external references)
Note This is a business identifer, identifier, not a resource identifier (see discussion )
Control Cardinality 0..1 0..*
Type Identifier
Summary true
Comments

This identifier is identifies this copy of the consent. Where this identifier is also used elsewhere as the identifier for a consent record (e.g. a CDA consent document) then the consent details are expected to be the same.

Definition Element Id Consent.status
Definition

Indicates the current state of this consent. Consent resource.

Short Display draft | active | inactive | not-done | entered-in-error | unknown
Control Cardinality 1..1
Terminology Binding ConsentState Consent State ( Required )
Type code
Is Modifier true Requirements The Consent Directive that (Reason: This element is pointed to might be in various lifecycle states, e.g., labelled as a revoked Consent Directive. modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid)
Summary true
Comments

This element is labeled as a modifier because the status contains the codes rejected and entered-in-error that mark the Consent as not currently valid.

Definition Element Id Consent.category
Definition

A classification of the type of consents found in the statement. This element supports indexing and retrieval of consent statements.

Short Display Classification of the consent statement - for indexing/retrieval
Cardinality 0..*
Terminology Binding Consent Category Codes ( Example )
Type CodeableConcept
Summary true
Definition Element Id Consent.subject
Definition

The patient/healthcare consumer patient, healthcare practitioner, research subject, or a group of persons to whom this consent applies.

Short Display Who the consent applies to
Control Cardinality 1..1 0..1
Type Reference ( Patient | Practitioner | ResearchSubject | Group )
Summary true
Element Id Consent.date
Definition

Relevant time or time-period when this Consent is applicable. Date the consent instance was agreed to.

Control Short Display 0..1 Fully executed date of the consent
Type Cardinality Period 0..1
Meaning if Missing Type all date ranges included
Summary true
Element Id Consent.period
Definition

When Effective period for this Consent was issued / created / indexed. Resource and all provisions unless specified in that provision.

Short Display Effective period for this Consent
Control Cardinality 0..1
Type dateTime Period
Alternate Names period
Summary true
Element Id Consent.grantor
Definition

Either the Grantor, which is the The entity responsible for granting the rights listed in a Consent Directive or the Grantee, which Directive.

Short Display Who is granting rights according to the entity responsible for complying with the Consent Directive, including any obligations or limitations on authorizations policy and enforcement of prohibitions. rules
Control Cardinality 0..*
Type Reference ( CareTeam | Group | HealthcareService | Organization | Patient | Practitioner | RelatedPerson | PractitionerRole )
Alternate Names consentor grantor
Summary true
Definition Element Id Who or what is controlled by this consent. Use group to identify a set of actors by some property they share (e.g. 'admitting officers'). Consent.grantee
Control Definition 0..*

The entity responsible for complying with the Consent Directive, including any obligations or limitations on authorizations and enforcement of prohibitions.

Meaning if Missing Short Display There Who is no specific actor associated with agreeing to the consent policy and rules
Summary Cardinality true 0..*
Type Consent.actor.role Reference ( CareTeam | Group | HealthcareService | Organization | Patient | Practitioner | RelatedPerson | PractitionerRole )
Alternate Names How the individual is involved in the resources content that is described in the consent. grantee
Control Summary 1..1 true
Terminology Binding Comments SecurityRoleType ( Extensible )

In a fully computable consent, both grantee and grantor will be listed as actors within the consent. The Grantee and Grantor elements are for ease of search only.

Element Id Consent.manager
Definition

The resource actor that identifies manages the actor. To identify a actors by type, use group to identify a set of actors by some property they share (e.g. 'admitting officers'). consent through its lifecycle.

Short Display Consent workflow management
Cardinality 1..1 0..*
Type Reference ( Device | Group | CareTeam HealthcareService | Organization | Patient | Practitioner | RelatedPerson )
Alternate Names manager
Summary false
Definition Element Id Consent.controller
Definition

Actions controlled by this The actor that controls/enforces the access according to the consent.

Control Short Display 0..* Consent Enforcer
Terminology Binding Cardinality Consent Action Codes ( Example ) 0..*
Type CodeableConcept Reference ( HealthcareService | Organization | Patient | Practitioner )
Alternate Names all actions controller
Summary true false
Element Id Consent.sourceAttachment
Definition

The organization that manages the consent, and the framework within source on which it this consent statement is executed. based. The source might be a scanned original paper form.

Short Display Source from which this consent is taken
Control Cardinality 0..*
Type Reference ( Organization Attachment ) Alternate Names custodian
Summary false
true Comments

The source can be contained inline (Attachment), referenced directly (Consent), referenced in a consent repository (DocumentReference), or simply by an identifier (Identifier), e.g. a CDA document id.

Definition Element Id Consent.sourceReference
Definition

The source on which this consent statement is based. The source might be a scanned original paper form, or a A reference to a consent that links back to such a source, a reference to a document repository (e.g. XDS) that stores the original consent document.

Short Display Source from which this consent is taken
Control Cardinality 0..1 0..*
Type Attachment | Identifier | Reference ( Consent | DocumentReference | Contract | QuestionnaireResponse )
[x] Note See Choice of Data Types for further information about how to use [x] Summary true false
Comments

The source can be contained inline (Attachment), referenced directly (Consent), referenced in a consent repository (DocumentReference), or simply by an identifier (Identifier), e.g. a CDA document id.

Definition Element Id Consent.regulatoryBasis
Definition

The references to A set of codes that indicate the policies regulatory basis (if any) that are included in this consent scope. Policies may be organizational, but are often defined jurisdictionally, or in law. supports.

Short Display Regulations establishing base Consent
Control Cardinality 0..*
Terminology Binding Consent PolicyRule Codes ( Example )
Type CodeableConcept
Summary false
Definition Element Id Consent.policyBasis
Definition

Entity or Organization having regulatory jurisdiction A Reference or accountability URL used to uniquely identify the policy the organization will enforce for  enforcing policies pertaining this Consent. This Reference or URL should be specific to Consent Directives. the version of the policy and should be dereferencable to a computable policy of some form.

Control Short Display 0..1 Computable version of the backing policy
Type Cardinality 0..1
uri Summary false
Element Id Consent.policyBasis.reference
Definition

The references to the policies A Reference that are included in identifies the policy the organization will enforce for this consent scope. Policies may be organizational, but are often defined jurisdictionally, or in law. Consent.

Short Display Reference backing policy resource
Control Cardinality 0..1
Type Reference ( Any )
uri Summary false
Comments

This element is for discoverability / documentation, While any resource may be used, Consent, PlanDefinition and does not modify or qualify the policy rules. Contract would be most frequent

Element Id Consent.policyBasis.uri
Definition

A referece URI that links to the specific a computable policy. version of the policy the organization will enforce for this Consent.

Short Display URI to a computable backing policy
Cardinality 0..1
Type uri
Requirements Summary Might be a unique identifier of a policy set in XACML, or other rules engine. false
true Element Id Consent.policyText
Comments Definition

If A Reference to the human readable policy reference is not known, the resource cannot be processed. Where explaining the reference is absent, there is no particular policy other than what is expressed directly in basis for the consent resource. Consent.

Invariants Short Display Human Readable Policy
Affect this element Cardinality ppc-1 : Either a Policy or PolicyRule 0..*
Type Reference ( expression DocumentReference )
Summary : policy.exists() or policyRule.exists(), xpath: exists(f:policy) or exists(f:policyRule)) false
Definition Element Id Consent.verification
Definition

A set of security labels that define which resources are controlled by this consent. If more than one label is specified, all resources must have all Whether a treatment instruction (e.g. artificial respiration: yes or no) was verified with the specified labels. patient, his/her family or another authorized person.

Short Display Consent Verified by patient or family
Control Cardinality 0..*
Terminology Binding Summary true
Element Id Consent.verification.verified
Definition Coding

Has the instruction been verified.

Short Display Has been verified
Summary Cardinality true 1..1
Comments Type boolean
If the consent specifies a security label of "R" then it applies to all resources that are labeled "R" or lower. E.g. for Confidentiality, it's a high water mark. For other kinds of security labels, subsumption logic applies. Not all of the security labels make sense for use in this element (may define a narrower value set?). Summary true
Definition Element Id Consent.verification.type
Definition

The context Extensible list of the activities a user is taking - why the user is accessing the data - that are controlled by this consent. verification type starting with verification and re-validation.

Short Display Business case of verification
Control Cardinality 0..* 0..1
Terminology Binding PurposeOfUse Consent Vefication Codes ( Extensible Example )
Type Coding CodeableConcept
Summary true false
Comments

This element is for discoverability / documentation, and does not modify or qualify allows the policy (e.g. verification element to hold multiple use cases including RelatedPerson verification of the policy itself describes Grantee decision and periodic re-validation of the purposes for which it applies). consent.

Definition Element Id Consent.verification.verifiedBy
Definition

Clinical or Operational Relevant period The person who conducted the verification/validation of time that bounds the data controlled by this consent. Grantor decision.

Short Display Person conducting verification
Cardinality 0..1
Type Period Reference ( Organization | Practitioner | PractitionerRole )
Summary true false
Comments Element Id Consent.verification.verifiedWith
Definition

This has a different sense to the Consent.period - that is when the consent agreement holds. This is the time period of the data that is controlled by Who verified the agreement. instruction (Patient, Relative or other Authorized Person).

Short Display Person who verified
Cardinality 0..1
Type Reference ( Patient | RelatedPerson | Group )
Summary false
Definition Element Id Consent.verification.date
Definition

The resources controlled by this consent, if specific resources are referenced. Date(s) verification was collected.

Short Display When consent verified
Control Cardinality 0..*
Meaning if Missing Type all data dateTime
Summary false
true Comments

Allows for history of verification/validation.

Definition Element Id Consent.decision
Definition

How the resource reference is interpreted when testing consent restrictions. Action to take - permit or deny - as default.

Short Display deny | permit
Control Cardinality 1..1 0..1
Terminology Binding ConsentDataMeaning Consent Provision Type ( Required )
Type code
Is Modifier true (Reason: Sets context for the values in .provision)
Summary true
Definition Element Id Consent.provisionReference
Definition

A reference to Alternate for the provision structure using the Permission resource. Only one of Permission and .provision may be used in a specific resource that defines which resources are covered by this consent. resource.

Short Display Permission Resource for provisions
Cardinality 1..1 0..*
Type Reference ( Any Permission )
Summary true false
Definition Element Id Consent.provision
Definition

An exception to the base policy of this consent. An exception can be an addition or removal of access permissions.

Short Display Constraints to the base Consent.policyRule/Consent.policy
Control Cardinality 0..*
Summary true
Definition Element Id Consent.provision.period
Definition

Action to take - permit or deny - when the exception conditions are met. Timeframe for this provision.

Control Short Display 1..1 Timeframe for this provision
Terminology Binding Cardinality ConsentExceptType ( Required ) 0..1
Type code Period
Summary true
Definition Comments

The timeframe in this exception This is valid. the bound effective time of the consent and should be in the base provision in the Consent resource.

Summary Element Id true Consent.except.actor Consent.provision.actor
Definition

Who or what is controlled by this Exception. provision. Use group to identify a set of actors by some property they share (e.g. 'admitting officers').

Short Display Who|what controlled by this provision (or group, by role)
Cardinality 0..*
Meaning if Missing There is no specific actor associated with the exception
Summary true false
Definition Element Id Consent.provision.actor.role
Definition

How the individual is involved in the resources content that is described in the exception.

Short Display How the actor is involved
Control Cardinality 1..1 0..1
Terminology Binding SecurityRoleType Participation Role Type ( Extensible )
Type CodeableConcept
Summary false
Definition Element Id Consent.provision.actor.reference
Definition

The resource that identifies the actor. To identify a actors by type, use group to identify a set of actors by some property they share (e.g. 'admitting officers').

Short Display Resource for the actor (or group, by role)
Control Cardinality 1..1 0..1
Type Reference ( Device | Group | CareTeam | Organization | Patient | Practitioner | RelatedPerson | PractitionerRole )
Summary false
Definition Element Id Consent.provision.action
Definition

Actions controlled by this Exception. provision.

Short Display Actions controlled by this provision
Cardinality 0..*
Terminology Binding Consent Action Codes ( Example )
Type CodeableConcept
Meaning if Missing all actions
Summary true
Comments

Note that this is the direct action (not the grounds for the action covered in the purpose element). At present, the only action in the understood and tested scope of this resource is 'read'.

Definition Element Id Consent.provision.securityLabel
Definition

A set security label, comprised of 0..* security labels that label fields (Privacy tags), which define which resources are controlled by this exception. If more than one label is specified, all resources must have all the specified labels.

Short Display Security Labels that define affected resources
Control Cardinality 0..*
Terminology Binding All Example set of Security Labels ( Extensible Example )
Type Coding
Summary true
Comments

If the consent specifies a security label of "R" "R" then it applies to all resources that are labeled "R" "R" or lower. E.g. for Confidentiality, it's a high water mark. For other kinds of security labels, subsumption logic applies. Not all When the purpose of use tag is on the security labels make sense for data, access request purpose of use in this element (may define a narrower value set?). shall not conflict.

Definition Element Id Consent.provision.purpose
Definition

The context of the activities a user is taking - why the user is accessing the data - that are controlled by this exception. provision.

Short Display Context of activities covered by this provision
Control Cardinality 0..*
Terminology Binding PurposeOfUse icon ( Extensible )
Type Coding
Summary true
Comments

E.g. if When the purpose of use tag is 'research', then the operational context must be research, in order for on the consent to apply. Not all data, access request purpose of the security labels make sense for use in this element (may define a narrower value set?). shall not conflict.

Definition Element Id Consent.provision.documentType
Definition

The class of information documentType(s) covered by this exception. provision. The type can be a FHIR resource type, a profile on a type, or a CDA document, or some other type that indicates what sort of information the consent relates to.

Short Display e.g. Resource Type, Profile, CDA, etc
Control Cardinality 0..*
Terminology Binding Consent Content Class ( Preferred )
Type Coding
Summary true
Comments

Multiple types are or'ed together. The intention of the documentType element is that the codes refer to document types defined in a standard somewhere.

Element Id Consent.provision.resourceType
Definition

The resourceType(s) covered by this provision. The type can be a FHIR resource type or a profile on a type that indicates what information the consent relates to.

Short Display e.g. Resource Type, Profile, etc
Cardinality 0..*
Terminology Binding Resource Types ( Extensible )
Type Coding
Summary true
Comments

Multiple types are or'ed together. The intention of the contentType resourceType element is that the codes refer to profiles or document types defined in a standard or an implementation guide somewhere.

Definition Element Id Consent.provision.code
Definition

If this code is found in an instance, then the exception provision applies.

Short Display e.g. LOINC or SNOMED CT code, etc. in the content
Control Cardinality 0..*
Terminology Binding Consent Content Codes ( Example )
Type Coding CodeableConcept
Summary true
Element Id Consent.provision.dataPeriod
Definition

Clinical or Operational Relevant period of time that bounds the data controlled by this exception. provision.

Short Display Timeframe for data controlled by this provision
Control Cardinality 0..1
Type Period
Summary true
Comments

This has a different sense to the Consent.period - that is when the consent agreement holds. This is the time period of the data that is controlled by the agreement.

Definition Element Id Consent.provision.data
Definition

The resources controlled by this exception, provision if specific resources are referenced.

Short Display Data controlled by this provision
Control Cardinality 0..*
Meaning if Missing all data
Summary true
Definition Element Id Consent.provision.data.meaning
Definition

How the resource reference is interpreted when testing consent restrictions.

Short Display instance | related | dependents | authoredby
Cardinality 1..1
Terminology Binding ConsentDataMeaning Consent Data Meaning ( Required )
Type code
Summary true
Definition Element Id Consent.provision.data.reference
Definition

A reference to a specific resource that defines which resources are covered by this consent.

Short Display The actual data reference
Control Cardinality 1..1
Type Reference ( Any )
Summary true
Element Id Consent.provision.expression
Definition

A computable (FHIRPath or other) definition of what is controlled by this consent.

Short Display A computable expression of the consent
Cardinality 0..1
Type Expression
Summary false
Comments

Constraining the expression type for a specific implementation via profile is recommended

Element Id Consent.provision.provision
Definition

Provisions which provide exceptions to the base provision or subprovisions.

Short Display Nested Exception Provisions
Cardinality 0..*
Type See Consent.provision
Summary false