HL7.FHIR.US.PACIO-ADI\ADI Participant Consent

PACIO Advance Directive Interoperability Implementation Guide
0.1.0 - STU 1 Ballot

This page is part of the PACIO Advance Directive Information Implementation Guide (v0.1.0: STU 1 Ballot 1) based on FHIR (HL7® FHIR® Standard) R4. The current version which supersedes this version is 1.0.0. For a full list of available versions, see the Directory of published versions

Resource Profile: ADI Participant Consent

Defining URL:

http://hl7.org/fhir/us/pacio-adi/StructureDefinition/PADI-ParticipantConsent

Version:

0.1.0

Name:

PADIParticipantConsent

Title:

ADI Participant Consent

Status:

Active as of 12/6/21 8:50 PM

Definition:

This profile is used to represent a consent for an advance directive participant such as a healthcare agent or advisor and power or limitation granted to such persons.

Publisher:

HL7 Patient Empowerment Working Group

Source Resource:

XML / JSON / Turtle

The official URL for this profile is:

http://hl7.org/fhir/us/pacio-adi/StructureDefinition/PADI-ParticipantConsent

Formal Views of Profile Content

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

Text Summary
Differential Table
Snapshot Table
Snapshot Table (Must Support)
All

This structure is derived from Consent

Summary

Mandatory: 5 elements
Must-Support: 12 elements

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

http://hl7.org/fhir/us/pacio-adi/StructureDefinition/padi-clause-extension

This structure is derived from Consent

Name	Flags	Card.	Type	Description & Constraints
Consent	I	0..*	Consent	A healthcare consumer's choices to permit or deny recipients or roles to perform actions for specific purposes and periods of time HCA-authority-scope-provisionType: Scope indicates powers granted and provision type is permit or scope indicates limitations placed and provision type is deny or scope indicates no powers/limitations and no provisions type and no action exist
text	S	1..1	Narrative	Text summary of the resource, for human interpretation
status	S	1..1	code	draft \| proposed \| active \| rejected \| inactive \| entered-in-error Required Pattern: active
scope		1..1	CodeableConcept	Which of the four areas this resource covers (extensible) Binding: Consent Type (required)
category		1..*	CodeableConcept	Classification of the consent statement - for indexing/retrieval Required Pattern: At least the following
coding		1..*	Coding	Code defined by a terminology system Fixed Value: (complex)
system		1..1	uri	Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/consentcategorycodes
code		1..1	code	Symbol in syntax defined by the system Fixed Value: acd
patient	S	1..1	Reference(US Core Patient Profile)	Who the consent applies to
dateTime	S	0..1	dateTime	When this Consent was created or indexed
policy	S	0..*	BackboneElement	Policies covered by this consent
provision	S	1..1	BackboneElement	Constraints to the base Consent.policyRule
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
padi-clause-extension	S	0..*	(Complex)	Clause URL: http://hl7.org/fhir/us/pacio-adi/StructureDefinition/padi-clause-extension
type	S	1..1	code	deny \| permit
period	S	0..1	Period	Timeframe for this rule
actor	S	1..*	BackboneElement	Who\|what controlled by this rule (or group, by role)
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
padi-clause-extension	S	0..*	(Complex)	Clause URL: http://hl7.org/fhir/us/pacio-adi/StructureDefinition/padi-clause-extension
role		1..1	CodeableConcept	How the actor is involved Binding: ADI Consent Actor Role (required)
reference		1..1	Reference(ADI Participant)	Resource for the actor (or group, by role)
action	S	0..*	CodeableConcept	Actions controlled by this rule Binding: Healthcare Agent Decisions (extensible)
purpose		0..*	Coding	Context of activities covered by this rule Required Pattern: At least the following
system		1..1	uri	Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ActReason
code		1..1	code	Symbol in syntax defined by the system Fixed Value: PWATRNY
Documentation for this format

Name	Flags	Card.	Type	Description & Constraints
Consent	I	0..*	Consent	A healthcare consumer's choices to permit or deny recipients or roles to perform actions for specific purposes and periods of time HCA-authority-scope-provisionType: Scope indicates powers granted and provision type is permit or scope indicates limitations placed and provision type is deny or scope indicates no powers/limitations and no provisions type and no action exist
id	Σ	0..1	string	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) Max Binding: AllLanguages: A human language.
text	S	1..1	Narrative	Text summary of the resource, for human interpretation
contained		0..*	Resource	Contained, inline Resources
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
identifier	Σ	0..*	Identifier	Identifier for this record (external references) Example General: {"system":"urn:ietf:rfc:3986","value":"Local eCMS identifier"}
status	?!SΣ	1..1	code	draft \| proposed \| active \| rejected \| inactive \| entered-in-error Binding: ConsentState (required): Indicates the state of the consent. Required Pattern: active
scope	?!Σ	1..1	CodeableConcept	Which of the four areas this resource covers (extensible) Binding: Consent Type (required)
category	Σ	1..*	CodeableConcept	Classification of the consent statement - for indexing/retrieval Binding: ConsentCategoryCodes (extensible): A classification of the type of consents found in a consent statement. Required Pattern: At least the following
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
coding		1..*	Coding	Code defined by a terminology system Fixed Value: (complex)
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
system		1..1	uri	Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/consentcategorycodes
version		0..1	string	Version of the system - if relevant
code		1..1	code	Symbol in syntax defined by the system Fixed Value: acd
display		0..1	string	Representation defined by the system
userSelected		0..1	boolean	If this coding was chosen directly by the user
text		0..1	string	Plain text representation of the concept
patient	SΣ	1..1	Reference(US Core Patient Profile)	Who the consent applies to
dateTime	SΣ	0..1	dateTime	When this Consent was created or indexed
performer	Σ	0..*	Reference(Organization \| Patient \| Practitioner \| RelatedPerson \| PractitionerRole)	Who is agreeing to the policy and rules
organization	Σ	0..*	Reference(Organization)	Custodian of the consent
source[x]	Σ	0..1		Source from which this consent is taken
sourceAttachment			Attachment
sourceReference			Reference(Consent \| DocumentReference \| Contract \| QuestionnaireResponse)
policy	S	0..*	BackboneElement	Policies covered by this consent
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
authority	I	0..1	uri	Enforcement source for policy
uri	I	0..1	uri	Specific policy covered by this consent
policyRule	ΣI	0..1	CodeableConcept	Regulation that this consents to Binding: ConsentPolicyRuleCodes (extensible): Regulatory policy examples.
verification	Σ	0..*	BackboneElement	Consent Verified by patient or family
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
verified	Σ	1..1	boolean	Has been verified
verifiedWith		0..1	Reference(Patient \| RelatedPerson)	Person who verified
verificationDate		0..1	dateTime	When consent verified
provision	SΣ	1..1	BackboneElement	Constraints to the base Consent.policyRule
id		0..1	string	Unique id for inter-element referencing
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
padi-clause-extension	S	0..*	(Complex)	Clause URL: http://hl7.org/fhir/us/pacio-adi/StructureDefinition/padi-clause-extension
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
type	SΣ	1..1	code	deny \| permit Binding: ConsentProvisionType (required): How a rule statement is applied, such as adding additional consent or removing consent.
period	SΣ	0..1	Period	Timeframe for this rule
actor	S	1..*	BackboneElement	Who\|what controlled by this rule (or group, by role)
id		0..1	string	Unique id for inter-element referencing
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
padi-clause-extension	S	0..*	(Complex)	Clause URL: http://hl7.org/fhir/us/pacio-adi/StructureDefinition/padi-clause-extension
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
role		1..1	CodeableConcept	How the actor is involved Binding: ADI Consent Actor Role (required)
reference		1..1	Reference(ADI Participant)	Resource for the actor (or group, by role)
action	SΣ	0..*	CodeableConcept	Actions controlled by this rule Binding: Healthcare Agent Decisions (extensible)
securityLabel	Σ	0..*	Coding	Security Labels that define affected resources Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
purpose	Σ	0..*	Coding	Context of activities covered by this rule Binding: PurposeOfUse (extensible): What purposes of use are controlled by this exception. If more than one label is specified, operations must have all the specified labels. Required Pattern: At least the following
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
system		1..1	uri	Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ActReason
version		0..1	string	Version of the system - if relevant
code		1..1	code	Symbol in syntax defined by the system Fixed Value: PWATRNY
display		0..1	string	Representation defined by the system
userSelected		0..1	boolean	If this coding was chosen directly by the user
class	Σ	0..*	Coding	e.g. Resource Type, Profile, CDA, etc. Binding: ConsentContentClass (extensible): The class (type) of information a consent rule covers.
code	Σ	0..*	CodeableConcept	e.g. LOINC or SNOMED CT code, etc. in the content Binding: ConsentContentCodes (example): If this code is found in an instance, then the exception applies.
dataPeriod	Σ	0..1	Period	Timeframe for data controlled by this rule
data	Σ	0..*	BackboneElement	Data controlled by this rule
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
meaning	Σ	1..1	code	instance \| related \| dependents \| authoredby Binding: ConsentDataMeaning (required): How a resource reference is interpreted when testing consent restrictions.
reference	Σ	1..1	Reference(Resource)	The actual data reference
provision		0..*	See provision (Consent)	Nested Exception Rules
Documentation for this format

Name	Flags	Card.	Type	Description & Constraints
Consent	I	0..*	Consent	A healthcare consumer's choices to permit or deny recipients or roles to perform actions for specific purposes and periods of time HCA-authority-scope-provisionType: Scope indicates powers granted and provision type is permit or scope indicates limitations placed and provision type is deny or scope indicates no powers/limitations and no provisions type and no action exist
text		1..1	Narrative	Text summary of the resource, for human interpretation
status	?!Σ	1..1	code	draft \| proposed \| active \| rejected \| inactive \| entered-in-error Binding: ConsentState (required): Indicates the state of the consent. Required Pattern: active
patient	Σ	1..1	Reference(US Core Patient Profile)	Who the consent applies to
dateTime	Σ	0..1	dateTime	When this Consent was created or indexed
policy		0..*	BackboneElement	Policies covered by this consent
provision	Σ	1..1	BackboneElement	Constraints to the base Consent.policyRule
padi-clause-extension		0..*	(Complex)	Clause URL: http://hl7.org/fhir/us/pacio-adi/StructureDefinition/padi-clause-extension
type	Σ	1..1	code	deny \| permit Binding: ConsentProvisionType (required): How a rule statement is applied, such as adding additional consent or removing consent.
period	Σ	0..1	Period	Timeframe for this rule
actor		1..*	BackboneElement	Who\|what controlled by this rule (or group, by role)
padi-clause-extension		0..*	(Complex)	Clause URL: http://hl7.org/fhir/us/pacio-adi/StructureDefinition/padi-clause-extension
action	Σ	0..*	CodeableConcept	Actions controlled by this rule Binding: Healthcare Agent Decisions (extensible)
Documentation for this format

This structure is derived from Consent

Summary

Mandatory: 5 elements
Must-Support: 12 elements

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

http://hl7.org/fhir/us/pacio-adi/StructureDefinition/padi-clause-extension

Differential View

This structure is derived from Consent

Name	Flags	Card.	Type	Description & Constraints
Consent	I	0..*	Consent	A healthcare consumer's choices to permit or deny recipients or roles to perform actions for specific purposes and periods of time HCA-authority-scope-provisionType: Scope indicates powers granted and provision type is permit or scope indicates limitations placed and provision type is deny or scope indicates no powers/limitations and no provisions type and no action exist
text	S	1..1	Narrative	Text summary of the resource, for human interpretation
status	S	1..1	code	draft \| proposed \| active \| rejected \| inactive \| entered-in-error Required Pattern: active
scope		1..1	CodeableConcept	Which of the four areas this resource covers (extensible) Binding: Consent Type (required)
category		1..*	CodeableConcept	Classification of the consent statement - for indexing/retrieval Required Pattern: At least the following
coding		1..*	Coding	Code defined by a terminology system Fixed Value: (complex)
system		1..1	uri	Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/consentcategorycodes
code		1..1	code	Symbol in syntax defined by the system Fixed Value: acd
patient	S	1..1	Reference(US Core Patient Profile)	Who the consent applies to
dateTime	S	0..1	dateTime	When this Consent was created or indexed
policy	S	0..*	BackboneElement	Policies covered by this consent
provision	S	1..1	BackboneElement	Constraints to the base Consent.policyRule
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
padi-clause-extension	S	0..*	(Complex)	Clause URL: http://hl7.org/fhir/us/pacio-adi/StructureDefinition/padi-clause-extension
type	S	1..1	code	deny \| permit
period	S	0..1	Period	Timeframe for this rule
actor	S	1..*	BackboneElement	Who\|what controlled by this rule (or group, by role)
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
padi-clause-extension	S	0..*	(Complex)	Clause URL: http://hl7.org/fhir/us/pacio-adi/StructureDefinition/padi-clause-extension
role		1..1	CodeableConcept	How the actor is involved Binding: ADI Consent Actor Role (required)
reference		1..1	Reference(ADI Participant)	Resource for the actor (or group, by role)
action	S	0..*	CodeableConcept	Actions controlled by this rule Binding: Healthcare Agent Decisions (extensible)
purpose		0..*	Coding	Context of activities covered by this rule Required Pattern: At least the following
system		1..1	uri	Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ActReason
code		1..1	code	Symbol in syntax defined by the system Fixed Value: PWATRNY
Documentation for this format

Snapshot View

Name	Flags	Card.	Type	Description & Constraints
Consent	I	0..*	Consent	A healthcare consumer's choices to permit or deny recipients or roles to perform actions for specific purposes and periods of time HCA-authority-scope-provisionType: Scope indicates powers granted and provision type is permit or scope indicates limitations placed and provision type is deny or scope indicates no powers/limitations and no provisions type and no action exist
id	Σ	0..1	string	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) Max Binding: AllLanguages: A human language.
text	S	1..1	Narrative	Text summary of the resource, for human interpretation
contained		0..*	Resource	Contained, inline Resources
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
identifier	Σ	0..*	Identifier	Identifier for this record (external references) Example General: {"system":"urn:ietf:rfc:3986","value":"Local eCMS identifier"}
status	?!SΣ	1..1	code	draft \| proposed \| active \| rejected \| inactive \| entered-in-error Binding: ConsentState (required): Indicates the state of the consent. Required Pattern: active
scope	?!Σ	1..1	CodeableConcept	Which of the four areas this resource covers (extensible) Binding: Consent Type (required)
category	Σ	1..*	CodeableConcept	Classification of the consent statement - for indexing/retrieval Binding: ConsentCategoryCodes (extensible): A classification of the type of consents found in a consent statement. Required Pattern: At least the following
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
coding		1..*	Coding	Code defined by a terminology system Fixed Value: (complex)
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
system		1..1	uri	Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/consentcategorycodes
version		0..1	string	Version of the system - if relevant
code		1..1	code	Symbol in syntax defined by the system Fixed Value: acd
display		0..1	string	Representation defined by the system
userSelected		0..1	boolean	If this coding was chosen directly by the user
text		0..1	string	Plain text representation of the concept
patient	SΣ	1..1	Reference(US Core Patient Profile)	Who the consent applies to
dateTime	SΣ	0..1	dateTime	When this Consent was created or indexed
performer	Σ	0..*	Reference(Organization \| Patient \| Practitioner \| RelatedPerson \| PractitionerRole)	Who is agreeing to the policy and rules
organization	Σ	0..*	Reference(Organization)	Custodian of the consent
source[x]	Σ	0..1		Source from which this consent is taken
sourceAttachment			Attachment
sourceReference			Reference(Consent \| DocumentReference \| Contract \| QuestionnaireResponse)
policy	S	0..*	BackboneElement	Policies covered by this consent
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
authority	I	0..1	uri	Enforcement source for policy
uri	I	0..1	uri	Specific policy covered by this consent
policyRule	ΣI	0..1	CodeableConcept	Regulation that this consents to Binding: ConsentPolicyRuleCodes (extensible): Regulatory policy examples.
verification	Σ	0..*	BackboneElement	Consent Verified by patient or family
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
verified	Σ	1..1	boolean	Has been verified
verifiedWith		0..1	Reference(Patient \| RelatedPerson)	Person who verified
verificationDate		0..1	dateTime	When consent verified
provision	SΣ	1..1	BackboneElement	Constraints to the base Consent.policyRule
id		0..1	string	Unique id for inter-element referencing
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
padi-clause-extension	S	0..*	(Complex)	Clause URL: http://hl7.org/fhir/us/pacio-adi/StructureDefinition/padi-clause-extension
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
type	SΣ	1..1	code	deny \| permit Binding: ConsentProvisionType (required): How a rule statement is applied, such as adding additional consent or removing consent.
period	SΣ	0..1	Period	Timeframe for this rule
actor	S	1..*	BackboneElement	Who\|what controlled by this rule (or group, by role)
id		0..1	string	Unique id for inter-element referencing
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
padi-clause-extension	S	0..*	(Complex)	Clause URL: http://hl7.org/fhir/us/pacio-adi/StructureDefinition/padi-clause-extension
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
role		1..1	CodeableConcept	How the actor is involved Binding: ADI Consent Actor Role (required)
reference		1..1	Reference(ADI Participant)	Resource for the actor (or group, by role)
action	SΣ	0..*	CodeableConcept	Actions controlled by this rule Binding: Healthcare Agent Decisions (extensible)
securityLabel	Σ	0..*	Coding	Security Labels that define affected resources Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
purpose	Σ	0..*	Coding	Context of activities covered by this rule Binding: PurposeOfUse (extensible): What purposes of use are controlled by this exception. If more than one label is specified, operations must have all the specified labels. Required Pattern: At least the following
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
system		1..1	uri	Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ActReason
version		0..1	string	Version of the system - if relevant
code		1..1	code	Symbol in syntax defined by the system Fixed Value: PWATRNY
display		0..1	string	Representation defined by the system
userSelected		0..1	boolean	If this coding was chosen directly by the user
class	Σ	0..*	Coding	e.g. Resource Type, Profile, CDA, etc. Binding: ConsentContentClass (extensible): The class (type) of information a consent rule covers.
code	Σ	0..*	CodeableConcept	e.g. LOINC or SNOMED CT code, etc. in the content Binding: ConsentContentCodes (example): If this code is found in an instance, then the exception applies.
dataPeriod	Σ	0..1	Period	Timeframe for data controlled by this rule
data	Σ	0..*	BackboneElement	Data controlled by this rule
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
meaning	Σ	1..1	code	instance \| related \| dependents \| authoredby Binding: ConsentDataMeaning (required): How a resource reference is interpreted when testing consent restrictions.
reference	Σ	1..1	Reference(Resource)	The actual data reference
provision		0..*	See provision (Consent)	Nested Exception Rules
Documentation for this format

Other representations of profile: CSV, Excel, Schematron

Terminology Bindings

Path	Conformance	ValueSet / Code
Consent.language	preferred	CommonLanguages Max Binding: AllLanguages
Consent.status	required	Pattern: active
Consent.scope	required	PADIConsentTypeVS
Consent.category	extensible	Pattern: acd
Consent.policyRule	extensible	ConsentPolicyRuleCodes
Consent.provision.type	required	ConsentProvisionType
Consent.provision.actor.role	required	PADIConsentActorRoleVS
Consent.provision.action	extensible	PADIHCADecisionsVS
Consent.provision.securityLabel	extensible	All Security Labels
Consent.provision.purpose	extensible	Pattern: PWATRNY
Consent.provision.class	extensible	ConsentContentClass
Consent.provision.code	example	ConsentContentCodes
Consent.provision.data.meaning	required	ConsentDataMeaning

Constraints

Id	Path	Details	Requirements
HCA-authority-scope-provisionType	Consent	Scope indicates powers granted and provision type is permit or scope indicates limitations placed and provision type is deny or scope indicates no powers/limitations and no provisions type and no action exist : (scope.coding.code = '75786-4' and provision.type = 'permit') or (scope.coding.code = '81346-9' and provision.type = 'deny') or (scope.coding.code = '81335-2' and provision.type.exists().not() and provision.action.exists().not() and provision.provision.exists().not())