Release 4B R5 Final QA

This page is part of the FHIR Specification (v4.3.0: R4B (v5.0.0-draft-final: Final QA Preview for R5 - STU see ballot notes ). The current version which supercedes this version is 5.0.0 . For a full list of available versions, see the Directory of published versions . Page versions: R5 R4B R4 R3

Community Based Collaborative Care icon Work Group Maturity Level : 2   Trial Use Security Category : Patient Compartments : Patient

Detailed Descriptions for the elements in the Consent resource.

Summary Summary uri Summary policy.exists() or policyRule.exists() Either a Policy or PolicyRule Requirements Terminology Binding ConsentProvisionType ( Required ) Comments Typical use of this is a Document code with class = CDA.
Consent
Element Id Consent
Definition

A record of a healthcare consumer’s 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
Cardinality 0..*
Type DomainResource
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, and general advance care directives. Invariants Defined on this element ppc-1 Rule Either a Policy or PolicyRule policy.exists() or policyRule.exists() ppc-2 Rule IF Scope=privacy, there must be a patient patient.exists() or scope.coding.where(system='something' and code='patient-privacy').exists().not() ppc-3 Rule IF Scope=research, there must be a patient patient.exists() or scope.coding.where(system='something' and code='research').exists().not() ppc-4 Rule IF Scope=adr, there must be a patient patient.exists() or scope.coding.where(system='something' treatment and code='adr').exists().not() ppc-5 Rule IF Scope=treatment, there must be a patient patient.exists() or scope.coding.where(system='something' consent for research participation and code='treatment').exists().not() data sharing.

Consent.identifier
Element Id Consent.identifier
Definition

Unique identifier for this copy of the Consent Statement.

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

This identifier 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.

Consent.status
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
Cardinality 1..1
Terminology Binding ConsentState Consent State ( Required )
Type code
Is Modifier true (Reason: This element is labelled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid)
Requirements The Consent Directive that is pointed to might be in various lifecycle states, e.g., a revoked Consent Directive. 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.

Consent.scope Consent.category
Element Id Consent.scope Consent.category
Definition

A selector classification of the type of consent being presented: ADR, Privacy, Treatment, Research. consents found in the statement. This list is now extensible. element supports indexing and retrieval of consent statements.

Short Display Classification of the consent statement - for indexing/retrieval
Cardinality 1..1 0..*
Terminology Binding Consent Scope Category Codes ( Extensible Example )
Type CodeableConcept
Is Modifier Summary true (Reason: Allows changes
Consent.subject
Element Id Consent.subject
Definition

The patient/healthcare practitioner or group of persons to codes based on scope selection) whom this consent applies.

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

A classification of the type of consents found in Date the statement. This element supports indexing and retrieval of consent statements. instance was agreed to.

Cardinality Short Display 1..* Fully executed date of the consent
Terminology Binding Cardinality Consent Category Codes ( Extensible ) 0..1
Type CodeableConcept date
Summary true
Consent.patient Consent.period
Element Id Consent.patient Consent.period
Definition

The patient/healthcare consumer to whom Effective period for this consent applies. Consent Resource and all provisions unless specified in that provision.

Short Display Effective period for this Consent
Cardinality 0..1
Type Reference ( Patient Period )
Alternate Names true period
Comments Summary Commonly, the patient the consent pertains to is the author, but for young and old people, it may be some other person. true
Consent.dateTime Consent.grantor
Element Id Consent.dateTime Consent.grantor
Definition

When this The entity responsible for granting the rights listed in a Consent was issued / created / indexed. Directive.

Short Display Who is granting rights according to the policy and rules
Cardinality 0..1 0..*
Type dateTime Reference ( CareTeam | HealthcareService | Organization | Patient | Practitioner | RelatedPerson | PractitionerRole )
Alternate Names true grantor
Comments Summary This is not the time of the original consent, but the time that this statement was made or derived. true
Consent.performer Consent.grantee
Element Id Consent.performer Consent.grantee
Definition

Either the Grantor, which is the entity responsible for granting the rights listed in a Consent Directive or the Grantee, which is the The entity responsible for complying with the Consent Directive, including any obligations or limitations on authorizations and enforcement of prohibitions.

Short Display Who is agreeing to the policy and rules
Cardinality 0..*
Type Reference ( CareTeam | HealthcareService | Organization | Patient | Practitioner | RelatedPerson | PractitionerRole )
Alternate Names consentor grantee
Summary true
Comments

Commonly, the patient the consent pertains to is the consentor, but particularly for young In a fully computable consent, both grantee and old people, it may grantor will be some other person - e.g. a legal guardian. listed as actors within the consent. The Grantee and Grantor elements are for ease of search only.

Consent.organization Consent.manager
Element Id Consent.organization Consent.manager
Definition

The organization actor that manages the consent, and consent through its lifecycle.

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

The actor that controls/enforces the framework within which it is executed. access according to the consent.

Short Display Consent Enforcer
Cardinality 0..*
Type Reference ( HealthcareService | Organization | Patient | Practitioner )
Alternate Names custodian controller
Summary true false
Consent.source[x] Consent.sourceAttachment
Element Id Consent.source[x] Consent.sourceAttachment
Definition

The source on which this consent statement is based. The source might be a scanned original paper form, form.

Short Display Source from which this consent is taken
Cardinality 0..*
Type Attachment
Summary 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.

Consent.sourceReference
Element Id Consent.sourceReference
Definition

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
Cardinality 0..1 0..*
Type Attachment | 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.

Consent.policy Consent.regulatoryBasis
Element Id Consent.policy 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
Cardinality 0..*
Terminology Binding Consent PolicyRule Codes ( Example )
Type CodeableConcept
Summary false
Consent.policy.authority Consent.policyBasis
Element Id Consent.policy.authority 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.

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

A Reference that identifies the policy the organization will enforce for this Consent.

Invariants Short Display Reference backing policy resource
Affect this element Cardinality 0..1
ppc-1 Type Rule Reference ( Any )
Either a Policy or PolicyRule Summary false
Comments

While any resource may be used, Consent, PlanDefinition and Contract would be most frequent

Consent.policy.uri Consent.policyBasis.url
Element Id Consent.policy.uri Consent.policyBasis.url
Definition

The references A URL that links to a computable version of the policies that are included in policy the organization will enforce for this consent scope. Policies may be organizational, but are often defined jurisdictionally, or in law. Consent.

Short Display URL to a computable backing policy
Cardinality 0..1
Type uri url
Summary false
Consent.policyText
Comments Element Id Consent.policyText
Definition

This element is for discoverability / documentation and does not modify or qualify A Reference to the human readable policy rules. explaining the basis for the Consent.

Invariants Short Display Human Readable Policy
Affect this element Cardinality 0..*
ppc-1 Type Rule Reference ( DocumentReference )
policy.exists() or policyRule.exists() Summary false
Consent.policyRule Consent.verification
Element Id Consent.policyRule Consent.verification
Definition

A reference to Whether a treatment instruction (e.g. artificial respiration: yes or no) was verified with the specific base computable regulation patient, his/her family or policy. another authorized person.

Cardinality Short Display 0..1 Consent Verified by patient or family
Terminology Binding Cardinality Consent PolicyRule Codes ( Extensible ) 0..*
Type Summary CodeableConcept true
Consent.verification.verified Might be a unique identifier of a policy set in XACML, or other rules engine.
Summary Element Id true Consent.verification.verified
Comments Definition

If the policyRule is absent, computable consent would need to be constructed from the elements of Has the Consent resource. instruction been verified.

Invariants Short Display Has been verified
Affect this element Cardinality 1..1
ppc-1 Type Rule boolean Either a Policy or PolicyRule
policy.exists() or policyRule.exists() Summary true
Consent.verification Consent.verification.verificationType
Element Id Consent.verification Consent.verification.verificationType
Definition

Whether a treatment instruction (e.g. artificial respiration yes or no) was verified Extensible list of verification type starting with the patient, his/her family or another authorized person. verification and re-validation.

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

This allows the verification element to hold multiple use cases including RelatedPerson verification of the Grantee decision and periodic re-validation of the consent.

Consent.verification.verified Consent.verification.verifiedBy
Element Id Consent.verification.verified Consent.verification.verifiedBy
Definition

Has The person who conducted the instruction been verified. verification/validation of the Grantor decision.

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

Who verified the instruction (Patient, Relative or other Authorized Person).

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

Date Date(s) verification was collected.

Short Display When consent verified
Cardinality 0..1 0..*
Type dateTime
Summary false
Comments

Allows for history of verification/validation.

Consent.provision Consent.decision
Element Id Consent.provision Consent.decision
Definition

An exception Action to the base policy of this consent. An exception can be an addition take - permit or removal of access permissions. deny - as default.

Short Display deny | permit
Cardinality 0..1
Summary Terminology Binding true Consent Provision Type ( Required )
Type Consent.provision.type code
Element Id Is Modifier Consent.provision.type true (Reason: Sets context for the values in .provision)
Definition Summary Action to take - permit or deny - when the rule conditions are met. Not permitted in root rule, required in all nested rules. true
Cardinality Consent.provision
0..1 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
Type Cardinality code 0..*
Summary true
Consent.provision.period
Element Id Consent.provision.period
Definition

The timeframe in Timeframe for this rule is valid. provision.

Short Display Timeframe for this provision
Cardinality 0..1
Type Period
Summary true
Comments

This is the bound effective time of the consent and should be in the base provision in the Consent resource.

Consent.provision.actor
Element Id Consent.provision.actor
Definition

Who or what is controlled by this rule. 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 false
Consent.provision.actor.role
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
Cardinality 1..1 0..1
Terminology Binding SecurityRoleType Participation Role Type ( Extensible )
Type CodeableConcept
Summary false
Consent.provision.actor.reference
Element Id Consent.provision.actor.reference
Definition

The resource that identifies the actor. To identify 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)
Cardinality 1..1 0..1
Type Reference ( Device | Group | CareTeam | Organization | Patient | Practitioner | RelatedPerson | PractitionerRole )
Summary false
Consent.provision.action
Element Id Consent.provision.action
Definition

Actions controlled by this Rule. 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'.

Consent.provision.securityLabel
Element Id Consent.provision.securityLabel
Definition

A security label, comprised of 0..* security label fields (Privacy tags), which define which resources are controlled by this exception.

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

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. When the purpose of use tag is on the data, access request purpose of use shall not conflict.

Consent.provision.purpose
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 rule. provision.

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

When the purpose of use tag is on the data, access request purpose of use shall not conflict.

Consent.provision.class Consent.provision.documentType
Element Id Consent.provision.class Consent.provision.documentType
Definition

The class of information documentType(s) covered by this rule. 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
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.

Consent.provision.resourceType
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.

Consent.provision.code
Element Id Consent.provision.code
Definition

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

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

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

Short Display Timeframe for data controlled by this provision
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.

Consent.provision.data
Element Id Consent.provision.data
Definition

The resources controlled by this rule provision if specific resources are referenced.

Short Display Data controlled by this provision
Cardinality 0..*
Meaning if Missing all data
Summary true
Consent.provision.data.meaning
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
Consent.provision.data.reference
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
Cardinality 1..1
Type Reference ( Any )
Summary true
Consent.provision.expression
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

Consent.provision.provision
Element Id Consent.provision.provision
Definition

Rules Provisions which provide exceptions to the base rule provision or subrules. subprovisions.

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