PACIO Advance Directive Interoperability Implementation Guide
0.1.0 - STU 1 Ballot

PACIO Advance Directive Interoperability Implementation Guide, published by HL7 Patient Empowerment Working Group. This is not an authorized publication; it is the continuous build for version 0.1.0). This version is based on the current content of https://github.com/HL7/fhir-pacio-adi/ and changes regularly. 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/3/21, 11:52 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.

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:

This structure is derived from Consent

NameFlagsCard.TypeDescription & Constraintsdoco
.. Consent I0..*ConsentA 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 S1..1NarrativeText summary of the resource, for human interpretation
... status S1..1codedraft | proposed | active | rejected | inactive | entered-in-error
Required Pattern: active
... scope 1..1CodeableConceptWhich of the four areas this resource covers (extensible)
Binding: Consent Type (required)
.... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
..... system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/consentcategorycodes
..... code1..1codeSymbol in syntax defined by the system
Fixed Value: acd
... patient S1..1Reference(US Core Patient Profile)Who the consent applies to
... dateTime S0..1dateTimeWhen this Consent was created or indexed
... policy S0..*BackboneElementPolicies covered by this consent
... provision S1..1BackboneElementConstraints to the base Consent.policyRule
.... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... padi-clause-extension S0..*(Complex)Clause
URL: http://hl7.org/fhir/us/pacio-adi/StructureDefinition/padi-clause-extension
.... type S1..1codedeny | permit
.... period S0..1PeriodTimeframe for this rule
.... actor S1..*BackboneElementWho|what controlled by this rule (or group, by role)
..... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
..... padi-clause-extension S0..*(Complex)Clause
URL: http://hl7.org/fhir/us/pacio-adi/StructureDefinition/padi-clause-extension
..... role 1..1CodeableConceptHow the actor is involved
Binding: ADI Consent Actor Role (required)
..... reference 1..1Reference(ADI Participant)Resource for the actor (or group, by role)
.... action S0..*CodeableConceptActions controlled by this rule
Binding: Healthcare Agent Decisions (extensible)
.... purpose 0..*CodingContext of activities covered by this rule
Required Pattern: At least the following
..... system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ActReason
..... code1..1codeSymbol in syntax defined by the system
Fixed Value: PWATRNY

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Consent I0..*ConsentA 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..1stringLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... text S1..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..*IdentifierIdentifier for this record (external references)

Example General: {"system":"urn:ietf:rfc:3986","value":"Local eCMS identifier"}
... status ?!SΣ1..1codedraft | proposed | active | rejected | inactive | entered-in-error
Binding: ConsentState (required): Indicates the state of the consent.


Required Pattern: active
... scope ?!Σ1..1CodeableConceptWhich of the four areas this resource covers (extensible)
Binding: Consent Type (required)
... category Σ1..*CodeableConceptClassification 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
.... id0..1stringUnique id for inter-element referencing
.... extension0..*ExtensionAdditional content defined by implementations
.... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
..... id0..1stringUnique id for inter-element referencing
..... extension0..*ExtensionAdditional content defined by implementations
..... system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/consentcategorycodes
..... version0..1stringVersion of the system - if relevant
..... code1..1codeSymbol in syntax defined by the system
Fixed Value: acd
..... display0..1stringRepresentation defined by the system
..... userSelected0..1booleanIf this coding was chosen directly by the user
.... text0..1stringPlain text representation of the concept
... patient SΣ1..1Reference(US Core Patient Profile)Who the consent applies to
... dateTime SΣ0..1dateTimeWhen 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..1Source from which this consent is taken
.... sourceAttachmentAttachment
.... sourceReferenceReference(Consent | DocumentReference | Contract | QuestionnaireResponse)
... policy S0..*BackboneElementPolicies covered by this consent
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... authority I0..1uriEnforcement source for policy
.... uri I0..1uriSpecific policy covered by this consent
... policyRule ΣI0..1CodeableConceptRegulation that this consents to
Binding: ConsentPolicyRuleCodes (extensible): Regulatory policy examples.

... verification Σ0..*BackboneElementConsent Verified by patient or family
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... verified Σ1..1booleanHas been verified
.... verifiedWith 0..1Reference(Patient | RelatedPerson)Person who verified
.... verificationDate 0..1dateTimeWhen consent verified
... provision SΣ1..1BackboneElementConstraints to the base Consent.policyRule
.... id 0..1stringUnique id for inter-element referencing
.... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... padi-clause-extension S0..*(Complex)Clause
URL: http://hl7.org/fhir/us/pacio-adi/StructureDefinition/padi-clause-extension
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... type SΣ1..1codedeny | permit
Binding: ConsentProvisionType (required): How a rule statement is applied, such as adding additional consent or removing consent.

.... period SΣ0..1PeriodTimeframe for this rule
.... actor S1..*BackboneElementWho|what controlled by this rule (or group, by role)
..... id 0..1stringUnique id for inter-element referencing
..... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
..... padi-clause-extension S0..*(Complex)Clause
URL: http://hl7.org/fhir/us/pacio-adi/StructureDefinition/padi-clause-extension
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... role 1..1CodeableConceptHow the actor is involved
Binding: ADI Consent Actor Role (required)
..... reference 1..1Reference(ADI Participant)Resource for the actor (or group, by role)
.... action SΣ0..*CodeableConceptActions controlled by this rule
Binding: Healthcare Agent Decisions (extensible)
.... securityLabel Σ0..*CodingSecurity Labels that define affected resources
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.


.... purpose Σ0..*CodingContext 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
..... id0..1stringUnique id for inter-element referencing
..... extension0..*ExtensionAdditional content defined by implementations
..... system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ActReason
..... version0..1stringVersion of the system - if relevant
..... code1..1codeSymbol in syntax defined by the system
Fixed Value: PWATRNY
..... display0..1stringRepresentation defined by the system
..... userSelected0..1booleanIf this coding was chosen directly by the user
.... class Σ0..*Codinge.g. Resource Type, Profile, CDA, etc.
Binding: ConsentContentClass (extensible): The class (type) of information a consent rule covers.


.... code Σ0..*CodeableConcepte.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..1PeriodTimeframe for data controlled by this rule
.... data Σ0..*BackboneElementData controlled by this rule
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... meaning Σ1..1codeinstance | related | dependents | authoredby
Binding: ConsentDataMeaning (required): How a resource reference is interpreted when testing consent restrictions.

..... reference Σ1..1Reference(Resource)The actual data reference
.... provision 0..*See provision (Consent)Nested Exception Rules

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Consent I0..*ConsentA 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..1NarrativeText summary of the resource, for human interpretation
... status ?!Σ1..1codedraft | proposed | active | rejected | inactive | entered-in-error
Binding: ConsentState (required): Indicates the state of the consent.


Required Pattern: active
... patient Σ1..1Reference(US Core Patient Profile)Who the consent applies to
... policy 0..*BackboneElementPolicies covered by this consent
... provision Σ1..1BackboneElementConstraints 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..1codedeny | permit
Binding: ConsentProvisionType (required): How a rule statement is applied, such as adding additional consent or removing consent.

.... period Σ0..1PeriodTimeframe for this rule
.... actor 1..*BackboneElementWho|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..*CodeableConceptActions controlled by this rule
Binding: Healthcare Agent Decisions (extensible)

doco 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:

Differential View

This structure is derived from Consent

NameFlagsCard.TypeDescription & Constraintsdoco
.. Consent I0..*ConsentA 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 S1..1NarrativeText summary of the resource, for human interpretation
... status S1..1codedraft | proposed | active | rejected | inactive | entered-in-error
Required Pattern: active
... scope 1..1CodeableConceptWhich of the four areas this resource covers (extensible)
Binding: Consent Type (required)
.... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
..... system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/consentcategorycodes
..... code1..1codeSymbol in syntax defined by the system
Fixed Value: acd
... patient S1..1Reference(US Core Patient Profile)Who the consent applies to
... dateTime S0..1dateTimeWhen this Consent was created or indexed
... policy S0..*BackboneElementPolicies covered by this consent
... provision S1..1BackboneElementConstraints to the base Consent.policyRule
.... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... padi-clause-extension S0..*(Complex)Clause
URL: http://hl7.org/fhir/us/pacio-adi/StructureDefinition/padi-clause-extension
.... type S1..1codedeny | permit
.... period S0..1PeriodTimeframe for this rule
.... actor S1..*BackboneElementWho|what controlled by this rule (or group, by role)
..... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
..... padi-clause-extension S0..*(Complex)Clause
URL: http://hl7.org/fhir/us/pacio-adi/StructureDefinition/padi-clause-extension
..... role 1..1CodeableConceptHow the actor is involved
Binding: ADI Consent Actor Role (required)
..... reference 1..1Reference(ADI Participant)Resource for the actor (or group, by role)
.... action S0..*CodeableConceptActions controlled by this rule
Binding: Healthcare Agent Decisions (extensible)
.... purpose 0..*CodingContext of activities covered by this rule
Required Pattern: At least the following
..... system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ActReason
..... code1..1codeSymbol in syntax defined by the system
Fixed Value: PWATRNY

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Consent I0..*ConsentA 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..1stringLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... text S1..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..*IdentifierIdentifier for this record (external references)

Example General: {"system":"urn:ietf:rfc:3986","value":"Local eCMS identifier"}
... status ?!SΣ1..1codedraft | proposed | active | rejected | inactive | entered-in-error
Binding: ConsentState (required): Indicates the state of the consent.


Required Pattern: active
... scope ?!Σ1..1CodeableConceptWhich of the four areas this resource covers (extensible)
Binding: Consent Type (required)
... category Σ1..*CodeableConceptClassification 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
.... id0..1stringUnique id for inter-element referencing
.... extension0..*ExtensionAdditional content defined by implementations
.... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
..... id0..1stringUnique id for inter-element referencing
..... extension0..*ExtensionAdditional content defined by implementations
..... system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/consentcategorycodes
..... version0..1stringVersion of the system - if relevant
..... code1..1codeSymbol in syntax defined by the system
Fixed Value: acd
..... display0..1stringRepresentation defined by the system
..... userSelected0..1booleanIf this coding was chosen directly by the user
.... text0..1stringPlain text representation of the concept
... patient SΣ1..1Reference(US Core Patient Profile)Who the consent applies to
... dateTime SΣ0..1dateTimeWhen 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..1Source from which this consent is taken
.... sourceAttachmentAttachment
.... sourceReferenceReference(Consent | DocumentReference | Contract | QuestionnaireResponse)
... policy S0..*BackboneElementPolicies covered by this consent
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... authority I0..1uriEnforcement source for policy
.... uri I0..1uriSpecific policy covered by this consent
... policyRule ΣI0..1CodeableConceptRegulation that this consents to
Binding: ConsentPolicyRuleCodes (extensible): Regulatory policy examples.

... verification Σ0..*BackboneElementConsent Verified by patient or family
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... verified Σ1..1booleanHas been verified
.... verifiedWith 0..1Reference(Patient | RelatedPerson)Person who verified
.... verificationDate 0..1dateTimeWhen consent verified
... provision SΣ1..1BackboneElementConstraints to the base Consent.policyRule
.... id 0..1stringUnique id for inter-element referencing
.... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... padi-clause-extension S0..*(Complex)Clause
URL: http://hl7.org/fhir/us/pacio-adi/StructureDefinition/padi-clause-extension
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... type SΣ1..1codedeny | permit
Binding: ConsentProvisionType (required): How a rule statement is applied, such as adding additional consent or removing consent.

.... period SΣ0..1PeriodTimeframe for this rule
.... actor S1..*BackboneElementWho|what controlled by this rule (or group, by role)
..... id 0..1stringUnique id for inter-element referencing
..... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
..... padi-clause-extension S0..*(Complex)Clause
URL: http://hl7.org/fhir/us/pacio-adi/StructureDefinition/padi-clause-extension
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... role 1..1CodeableConceptHow the actor is involved
Binding: ADI Consent Actor Role (required)
..... reference 1..1Reference(ADI Participant)Resource for the actor (or group, by role)
.... action SΣ0..*CodeableConceptActions controlled by this rule
Binding: Healthcare Agent Decisions (extensible)
.... securityLabel Σ0..*CodingSecurity Labels that define affected resources
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.


.... purpose Σ0..*CodingContext 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
..... id0..1stringUnique id for inter-element referencing
..... extension0..*ExtensionAdditional content defined by implementations
..... system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ActReason
..... version0..1stringVersion of the system - if relevant
..... code1..1codeSymbol in syntax defined by the system
Fixed Value: PWATRNY
..... display0..1stringRepresentation defined by the system
..... userSelected0..1booleanIf this coding was chosen directly by the user
.... class Σ0..*Codinge.g. Resource Type, Profile, CDA, etc.
Binding: ConsentContentClass (extensible): The class (type) of information a consent rule covers.


.... code Σ0..*CodeableConcepte.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..1PeriodTimeframe for data controlled by this rule
.... data Σ0..*BackboneElementData controlled by this rule
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... meaning Σ1..1codeinstance | related | dependents | authoredby
Binding: ConsentDataMeaning (required): How a resource reference is interpreted when testing consent restrictions.

..... reference Σ1..1Reference(Resource)The actual data reference
.... provision 0..*See provision (Consent)Nested Exception Rules

doco Documentation for this format

 

Other representations of profile: CSV, Excel, Schematron

Terminology Bindings

PathConformanceValueSet / Code
Consent.languagepreferredCommonLanguages
Max Binding: AllLanguages
Consent.statusrequiredPattern: active
Consent.scoperequiredPADIConsentTypeVS
Consent.categoryextensiblePattern: acd
Consent.policyRuleextensibleConsentPolicyRuleCodes
Consent.provision.typerequiredConsentProvisionType
Consent.provision.actor.rolerequiredPADIConsentActorRoleVS
Consent.provision.actionextensiblePADIHCADecisionsVS
Consent.provision.securityLabelextensibleAll Security Labels
Consent.provision.purposeextensiblePattern: PWATRNY
Consent.provision.classextensibleConsentContentClass
Consent.provision.codeexampleConsentContentCodes
Consent.provision.data.meaningrequiredConsentDataMeaning

Constraints

IdPathDetailsRequirements
HCA-authority-scope-provisionTypeConsentScope 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())