PACIO Advance Healthcare Directive Interoperability Implementation Guide
2.0.0 - STU 2 – Ballot United States of America flag

PACIO Advance Healthcare Directive Interoperability Implementation Guide, published by HL7 International / Patient Empowerment. This guide is not an authorized publication; it is the continuous build for version 2.0.0 built by the FHIR (HL7® FHIR® Standard) CI Build. 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 Healthcare Agent Consent ( Abstract )

Official URL: http://hl7.org/fhir/us/pacio-adi/StructureDefinition/ADI-HealthcareAgentConsent Version: 2.0.0
Standards status: Trial-use Computable Name: ADIHealthcareAgentConsent
Other Identifiers: OID:2.16.840.1.113883.4.642.40.68.42.9

This profile is used to represent a delegation of rights consent for healthcare related decision-making. The ADI Healthcare Agent Consent Permit profile enables the patient to delegate the typical powers of a durable medical power of attorney to one or more healthcare agents which may be in a prioritized order (primary, secondary, tertiary) or simply may be designated as healthcare agents to act as an authorized personal representative for the patient in circumstances where the patient is not able to communicate. The ADI Healthcare Agent Consent Deny Profile may be used in conjunction to constrain the powers granted through the permit. The authorized personal representative appointed as healthcare agents are referenced from the Consent Resource via the actor.reference where the actor.code indicates the healthcare agent role

Usages:

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

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

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Consent C 0..* Consent This is an abstract profile. Child profiles: ADIHealthcareAgentConsentPermit, ADIHealthcareAgentConsentDeny
A healthcare consumer's choices to permit or deny recipients or roles to perform actions for specific purposes and periods of time
Constraints: ppc-1, ppc-2, ppc-3, ppc-4, ppc-5, HCA-consent-category, HCA-provision-purpose
Consent.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
Consent.text This element must be supported. 1..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
Consent.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
Consent.status This element is a modifier element. This element must be supported. This element is included in summaries. 1..1 code draft | proposed | active | rejected | inactive | entered-in-error
Binding: ConsentState (required): Indicates the state of the consent.
Required Pattern: active (extensions allowed)
Consent.scope This element is a modifier element. This element is included in summaries. 1..1 CodeableConcept Which of the four areas this resource covers (extensible)
Binding: ConsentScopeCodes (extensible): The four anticipated uses for the Consent Resource.
Required Pattern:
{
  "coding" : [
    {
      "system" : "http://loinc.org",
      "code" : "81377-4",
      "display" : "Goals, preferences, and priorities regarding the appointment of healthcare agents Narrative - Reported"
    }
  ]
}
Consent.category This element must be supported. This element is included in summaries. 1..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:
{
  "coding" : [
    {
      "system" : "http://terminology.hl7.org/CodeSystem/consentcategorycodes",
      "version" : "1.0.1",
      "code" : "acd"
    }
  ]
}
Consent.patient This element must be supported. This element is included in summaries. 1..1 Reference(US Core Patient Profile) Who the consent applies to
Consent.dateTime This element must be supported. This element is included in summaries. 0..1 dateTime When this Consent was created or indexed
Consent.policy This element must be supported. 0..* BackboneElement Policies covered by this consent
Consent.policy.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Consent.provision This element must be supported. This element is included in summaries. 1..1 BackboneElement Constraints to the base Consent.policyRule
Consent.provision.Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Consent.provision.Slices for extension.extension:ClauseExtension 0..* (Complex) Clause
URL: http://hl7.org/fhir/us/pacio-adi/StructureDefinition/adi-clause-extension
Consent.provision.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Consent.provision.type This element must be supported. This element is included in summaries. 1..1 code deny | permit
Binding: ConsentProvisionType (required): How a rule statement is applied, such as adding additional consent or removing consent.
Consent.provision.actor This element must be supported. 1..* BackboneElement Who|what controlled by this rule (or group, by role)
Consent.provision.actor.Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Consent.provision.actor.Slices for extension.extension:ClauseExtension 0..* (Complex) Clause
URL: http://hl7.org/fhir/us/pacio-adi/StructureDefinition/adi-clause-extension
Consent.provision.actor.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Consent.provision.actor.role 1..1 CodeableConcept How the actor is involved
Binding: Healthcare Agent or Proxy Choices (required)
Consent.provision.actor.reference 1..1 Reference(ADI Healthcare Agent Participant) Resource for the actor (or group, by role)
Consent.provision.action This element is included in summaries. 0..* CodeableConcept Actions controlled by this rule
Binding: Healthcare Agent Decisions (extensible)
Consent.provision.purpose This element is included in summaries. 0..* Coding Context of activities covered by this rule
Binding: v3 Code System ActReason (required)

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Consent.status Base required ConsentState 📍4.0.1 FHIR Std.
Consent.scope Base extensible Consent Scope Codes 📍4.0.1 FHIR Std.
Consent.category Base extensible Consent Category Codes 📍4.0.1 FHIR Std.
Consent.provision.type Base required ConsentProvisionType 📍4.0.1 FHIR Std.
Consent.provision.actor.​role Base required Healthcare Agent or Proxy Choices ⏿20221029 tx.fhir.org
Consent.provision.action Base extensible Healthcare Agent Decisions 📦2.0.0 This IG
Consent.provision.purpose Base required v3 Code System ActReason 📦3.0.0 THO v7.4

Constraints

Id Grade Path(s) Description Expression
HCA-consent-category error Consent Category must have a ConsentCategory of 'acd' category.coding.where(code = 'acd').exists()
HCA-provision-purpose error Consent Provision purpose must have a purpose of 'PWATRNY' provision.purpose.exists().not() or provision.purpose.where(code = 'PWATRNY').exists()
dom-2 error Consent If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Consent If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error Consent If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error Consent If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Consent A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
ppc-1 error Consent Either a Policy or PolicyRule policy.exists() or policyRule.exists()
ppc-2 error Consent IF Scope=privacy, there must be a patient patient.exists() or scope.coding.where(system='something' and code='patient-privacy').exists().not()
ppc-3 error Consent IF Scope=research, there must be a patient patient.exists() or scope.coding.where(system='something' and code='research').exists().not()
ppc-4 error Consent IF Scope=adr, there must be a patient patient.exists() or scope.coding.where(system='something' and code='adr').exists().not()
ppc-5 error Consent IF Scope=treatment, there must be a patient patient.exists() or scope.coding.where(system='something' and code='treatment').exists().not()

This structure is derived from Consent

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Consent C 0..* Consent This is an abstract profile. Child profiles: ADIHealthcareAgentConsentPermit, ADIHealthcareAgentConsentDeny
A healthcare consumer's choices to permit or deny recipients or roles to perform actions for specific purposes and periods of time
Constraints: HCA-consent-category, HCA-provision-purpose
Consent.text This element must be supported. 1..1 Narrative Text summary of the resource, for human interpretation
Consent.status This element must be supported. 1..1 code draft | proposed | active | rejected | inactive | entered-in-error
Required Pattern: active (extensions allowed)
Consent.scope 1..1 CodeableConcept Which of the four areas this resource covers (extensible)
Required Pattern:
{
  "coding" : [
    {
      "system" : "http://loinc.org",
      "code" : "81377-4",
      "display" : "Goals, preferences, and priorities regarding the appointment of healthcare agents Narrative - Reported"
    }
  ]
}
Consent.patient This element must be supported. 1..1 Reference(US Core Patient Profile) Who the consent applies to
Consent.dateTime This element must be supported. 0..1 dateTime When this Consent was created or indexed
Consent.policy This element must be supported. 0..* BackboneElement Policies covered by this consent
Consent.provision This element must be supported. 1..1 BackboneElement Constraints to the base Consent.policyRule
Consent.provision.Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Consent.provision.Slices for extension.extension:ClauseExtension 0..* (Complex) Clause
URL: http://hl7.org/fhir/us/pacio-adi/StructureDefinition/adi-clause-extension
Consent.provision.type This element must be supported. 1..1 code deny | permit
Consent.provision.actor This element must be supported. 1..* BackboneElement Who|what controlled by this rule (or group, by role)
Consent.provision.actor.Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Consent.provision.actor.Slices for extension.extension:ClauseExtension 0..* (Complex) Clause
URL: http://hl7.org/fhir/us/pacio-adi/StructureDefinition/adi-clause-extension
Consent.provision.actor.role 1..1 CodeableConcept How the actor is involved
Binding: Healthcare Agent or Proxy Choices (required)
Consent.provision.actor.reference 1..1 Reference(ADI Healthcare Agent Participant) Resource for the actor (or group, by role)
Consent.provision.action 0..* CodeableConcept Actions controlled by this rule
Binding: Healthcare Agent Decisions (extensible)
Consent.provision.purpose 0..* Coding Context of activities covered by this rule
Binding: v3 Code System ActReason (required)

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
Consent.provision.actor.​role Base required Healthcare Agent or Proxy Choices ⏿20221029 tx.fhir.org
Consent.provision.action Base extensible Healthcare Agent Decisions 📦2.0.0 This IG
Consent.provision.purpose Base required v3 Code System ActReason 📦3.0.0 THO v7.4

Constraints

Id Grade Path(s) Description Expression
HCA-consent-category error Consent Category must have a ConsentCategory of 'acd' category.coding.where(code = 'acd').exists()
HCA-provision-purpose error Consent Provision purpose must have a purpose of 'PWATRNY' provision.purpose.exists().not() or provision.purpose.where(code = 'PWATRNY').exists()
NameFlagsCard.TypeDescription & Constraints    Filter: doco
Consent C 0..* Consent This is an abstract profile. Child profiles: ADIHealthcareAgentConsentPermit, ADIHealthcareAgentConsentDeny
A healthcare consumer's choices to permit or deny recipients or roles to perform actions for specific purposes and periods of time
Constraints: ppc-1, ppc-2, ppc-3, ppc-4, ppc-5, HCA-consent-category, HCA-provision-purpose
Consent.id This element is included in summaries. 0..1 id Logical id of this artifact
Consent.meta This element is included in summaries. 0..1 Meta Metadata about the resource
Consent.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
Consent.language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
Consent.text This element must be supported. 1..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
Consent.contained 0..* Resource Contained, inline Resources
Consent.extension 0..* Extension Additional content defined by implementations
Consent.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
Consent.identifier This element is included in summaries. 0..* Identifier Identifier for this record (external references)

Example General: {"system":"http://acme.org/identifier/local/eCMS","value":"Local eCMS identifier"}
Consent.status This element is a modifier element. This element must be supported. This element is included in summaries. 1..1 code draft | proposed | active | rejected | inactive | entered-in-error
Binding: ConsentState (required): Indicates the state of the consent.
Required Pattern: active (extensions allowed)
Consent.scope This element is a modifier element. This element is included in summaries. 1..1 CodeableConcept Which of the four areas this resource covers (extensible)
Binding: ConsentScopeCodes (extensible): The four anticipated uses for the Consent Resource.
Required Pattern:
{
  "coding" : [
    {
      "system" : "http://loinc.org",
      "code" : "81377-4",
      "display" : "Goals, preferences, and priorities regarding the appointment of healthcare agents Narrative - Reported"
    }
  ]
}
Consent.category This element must be supported. This element is included in summaries. 1..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:
{
  "coding" : [
    {
      "system" : "http://terminology.hl7.org/CodeSystem/consentcategorycodes",
      "version" : "1.0.1",
      "code" : "acd"
    }
  ]
}
Consent.patient This element must be supported. This element is included in summaries. 1..1 Reference(US Core Patient Profile) Who the consent applies to
Consent.dateTime This element must be supported. This element is included in summaries. 0..1 dateTime When this Consent was created or indexed
Consent.performer This element is included in summaries. 0..* Reference(Organization | Patient | Practitioner | RelatedPerson | PractitionerRole) Who is agreeing to the policy and rules
Consent.organization This element is included in summaries. 0..* Reference(Organization) Custodian of the consent
Consent.source[x] This element is included in summaries. 0..1 Source from which this consent is taken
Consent.source[x].sourceAttachment Attachment
Consent.source[x].sourceReference Reference(Consent | DocumentReference | Contract | QuestionnaireResponse)
Consent.policy This element must be supported. 0..* BackboneElement Policies covered by this consent
Consent.policy.id 0..1 string Unique id for inter-element referencing
Consent.policy.extension 0..* Extension Additional content defined by implementations
Consent.policy.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Consent.policy.authority C 0..1 uri Enforcement source for policy
Consent.policy.uri C 0..1 uri Specific policy covered by this consent
Consent.policyRule This element is included in summaries. C 0..1 CodeableConcept Regulation that this consents to
Binding: ConsentPolicyRuleCodes (extensible): Regulatory policy examples.
Consent.verification This element is included in summaries. 0..* BackboneElement Consent Verified by patient or family
Consent.verification.id 0..1 string Unique id for inter-element referencing
Consent.verification.extension 0..* Extension Additional content defined by implementations
Consent.verification.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Consent.verification.verified This element is included in summaries. 1..1 boolean Has been verified
Consent.verification.verifiedWith 0..1 Reference(Patient | RelatedPerson) Person who verified
Consent.verification.verificationDate 0..1 dateTime When consent verified
Consent.provision This element must be supported. This element is included in summaries. 1..1 BackboneElement Constraints to the base Consent.policyRule
Consent.provision.id 0..1 string Unique id for inter-element referencing
Consent.provision.Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Consent.provision.Slices for extension.extension:ClauseExtension 0..* (Complex) Clause
URL: http://hl7.org/fhir/us/pacio-adi/StructureDefinition/adi-clause-extension
Consent.provision.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Consent.provision.type This element must be supported. This element is included in summaries. 1..1 code deny | permit
Binding: ConsentProvisionType (required): How a rule statement is applied, such as adding additional consent or removing consent.
Consent.provision.period This element is included in summaries. 0..1 Period Timeframe for this rule
Consent.provision.actor This element must be supported. 1..* BackboneElement Who|what controlled by this rule (or group, by role)
Consent.provision.actor.id 0..1 string Unique id for inter-element referencing
Consent.provision.actor.Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Consent.provision.actor.Slices for extension.extension:ClauseExtension 0..* (Complex) Clause
URL: http://hl7.org/fhir/us/pacio-adi/StructureDefinition/adi-clause-extension
Consent.provision.actor.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Consent.provision.actor.role 1..1 CodeableConcept How the actor is involved
Binding: Healthcare Agent or Proxy Choices (required)
Consent.provision.actor.reference 1..1 Reference(ADI Healthcare Agent Participant) Resource for the actor (or group, by role)
Consent.provision.action This element is included in summaries. 0..* CodeableConcept Actions controlled by this rule
Binding: Healthcare Agent Decisions (extensible)
Consent.provision.securityLabel This element is included in summaries. 0..* Coding Security Labels that define affected resources
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
Consent.provision.purpose This element is included in summaries. 0..* Coding Context of activities covered by this rule
Binding: v3 Code System ActReason (required)
Consent.provision.class This element is included in summaries. 0..* Coding e.g. Resource Type, Profile, CDA, etc.
Binding: ConsentContentClass (extensible): The class (type) of information a consent rule covers.
Consent.provision.code This element is included in summaries. 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.
Consent.provision.dataPeriod This element is included in summaries. 0..1 Period Timeframe for data controlled by this rule
Consent.provision.data This element is included in summaries. 0..* BackboneElement Data controlled by this rule
Consent.provision.data.id 0..1 string Unique id for inter-element referencing
Consent.provision.data.extension 0..* Extension Additional content defined by implementations
Consent.provision.data.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Consent.provision.data.meaning This element is included in summaries. 1..1 code instance | related | dependents | authoredby
Binding: ConsentDataMeaning (required): How a resource reference is interpreted when testing consent restrictions.
Consent.provision.data.reference This element is included in summaries. 1..1 Reference(Resource) The actual data reference
Consent.provision.provision 0..* See provision (Consent) Nested Exception Rules

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Consent.language Base preferred Common Languages 📍4.0.1 FHIR Std.
Consent.status Base required ConsentState 📍4.0.1 FHIR Std.
Consent.scope Base extensible Consent Scope Codes 📍4.0.1 FHIR Std.
Consent.category Base extensible Consent Category Codes 📍4.0.1 FHIR Std.
Consent.policyRule Base extensible Consent PolicyRule Codes 📍4.0.1 FHIR Std.
Consent.provision.type Base required ConsentProvisionType 📍4.0.1 FHIR Std.
Consent.provision.actor.​role Base required Healthcare Agent or Proxy Choices ⏿20221029 tx.fhir.org
Consent.provision.action Base extensible Healthcare Agent Decisions 📦2.0.0 This IG
Consent.provision.securityLabel Base extensible SecurityLabels 📍4.0.1 FHIR Std.
Consent.provision.purpose Base required v3 Code System ActReason 📦3.0.0 THO v7.4
Consent.provision.class Base extensible Consent Content Class 📍4.0.1 FHIR Std.
Consent.provision.code Base example Consent Content Codes 📍4.0.1 FHIR Std.
Consent.provision.data.​meaning Base required ConsentDataMeaning 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
HCA-consent-category error Consent Category must have a ConsentCategory of 'acd' category.coding.where(code = 'acd').exists()
HCA-provision-purpose error Consent Provision purpose must have a purpose of 'PWATRNY' provision.purpose.exists().not() or provision.purpose.where(code = 'PWATRNY').exists()
dom-2 error Consent If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Consent If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error Consent If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error Consent If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Consent A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
ppc-1 error Consent Either a Policy or PolicyRule policy.exists() or policyRule.exists()
ppc-2 error Consent IF Scope=privacy, there must be a patient patient.exists() or scope.coding.where(system='something' and code='patient-privacy').exists().not()
ppc-3 error Consent IF Scope=research, there must be a patient patient.exists() or scope.coding.where(system='something' and code='research').exists().not()
ppc-4 error Consent IF Scope=adr, there must be a patient patient.exists() or scope.coding.where(system='something' and code='adr').exists().not()
ppc-5 error Consent IF Scope=treatment, there must be a patient patient.exists() or scope.coding.where(system='something' and code='treatment').exists().not()

This structure is derived from Consent

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Consent C 0..* Consent This is an abstract profile. Child profiles: ADIHealthcareAgentConsentPermit, ADIHealthcareAgentConsentDeny
A healthcare consumer's choices to permit or deny recipients or roles to perform actions for specific purposes and periods of time
Constraints: ppc-1, ppc-2, ppc-3, ppc-4, ppc-5, HCA-consent-category, HCA-provision-purpose
Consent.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
Consent.text This element must be supported. 1..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
Consent.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
Consent.status This element is a modifier element. This element must be supported. This element is included in summaries. 1..1 code draft | proposed | active | rejected | inactive | entered-in-error
Binding: ConsentState (required): Indicates the state of the consent.
Required Pattern: active (extensions allowed)
Consent.scope This element is a modifier element. This element is included in summaries. 1..1 CodeableConcept Which of the four areas this resource covers (extensible)
Binding: ConsentScopeCodes (extensible): The four anticipated uses for the Consent Resource.
Required Pattern:
{
  "coding" : [
    {
      "system" : "http://loinc.org",
      "code" : "81377-4",
      "display" : "Goals, preferences, and priorities regarding the appointment of healthcare agents Narrative - Reported"
    }
  ]
}
Consent.category This element must be supported. This element is included in summaries. 1..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:
{
  "coding" : [
    {
      "system" : "http://terminology.hl7.org/CodeSystem/consentcategorycodes",
      "version" : "1.0.1",
      "code" : "acd"
    }
  ]
}
Consent.patient This element must be supported. This element is included in summaries. 1..1 Reference(US Core Patient Profile) Who the consent applies to
Consent.dateTime This element must be supported. This element is included in summaries. 0..1 dateTime When this Consent was created or indexed
Consent.policy This element must be supported. 0..* BackboneElement Policies covered by this consent
Consent.policy.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Consent.provision This element must be supported. This element is included in summaries. 1..1 BackboneElement Constraints to the base Consent.policyRule
Consent.provision.Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Consent.provision.Slices for extension.extension:ClauseExtension 0..* (Complex) Clause
URL: http://hl7.org/fhir/us/pacio-adi/StructureDefinition/adi-clause-extension
Consent.provision.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Consent.provision.type This element must be supported. This element is included in summaries. 1..1 code deny | permit
Binding: ConsentProvisionType (required): How a rule statement is applied, such as adding additional consent or removing consent.
Consent.provision.actor This element must be supported. 1..* BackboneElement Who|what controlled by this rule (or group, by role)
Consent.provision.actor.Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Consent.provision.actor.Slices for extension.extension:ClauseExtension 0..* (Complex) Clause
URL: http://hl7.org/fhir/us/pacio-adi/StructureDefinition/adi-clause-extension
Consent.provision.actor.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Consent.provision.actor.role 1..1 CodeableConcept How the actor is involved
Binding: Healthcare Agent or Proxy Choices (required)
Consent.provision.actor.reference 1..1 Reference(ADI Healthcare Agent Participant) Resource for the actor (or group, by role)
Consent.provision.action This element is included in summaries. 0..* CodeableConcept Actions controlled by this rule
Binding: Healthcare Agent Decisions (extensible)
Consent.provision.purpose This element is included in summaries. 0..* Coding Context of activities covered by this rule
Binding: v3 Code System ActReason (required)

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Consent.status Base required ConsentState 📍4.0.1 FHIR Std.
Consent.scope Base extensible Consent Scope Codes 📍4.0.1 FHIR Std.
Consent.category Base extensible Consent Category Codes 📍4.0.1 FHIR Std.
Consent.provision.type Base required ConsentProvisionType 📍4.0.1 FHIR Std.
Consent.provision.actor.​role Base required Healthcare Agent or Proxy Choices ⏿20221029 tx.fhir.org
Consent.provision.action Base extensible Healthcare Agent Decisions 📦2.0.0 This IG
Consent.provision.purpose Base required v3 Code System ActReason 📦3.0.0 THO v7.4

Constraints

Id Grade Path(s) Description Expression
HCA-consent-category error Consent Category must have a ConsentCategory of 'acd' category.coding.where(code = 'acd').exists()
HCA-provision-purpose error Consent Provision purpose must have a purpose of 'PWATRNY' provision.purpose.exists().not() or provision.purpose.where(code = 'PWATRNY').exists()
dom-2 error Consent If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Consent If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error Consent If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error Consent If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Consent A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
ppc-1 error Consent Either a Policy or PolicyRule policy.exists() or policyRule.exists()
ppc-2 error Consent IF Scope=privacy, there must be a patient patient.exists() or scope.coding.where(system='something' and code='patient-privacy').exists().not()
ppc-3 error Consent IF Scope=research, there must be a patient patient.exists() or scope.coding.where(system='something' and code='research').exists().not()
ppc-4 error Consent IF Scope=adr, there must be a patient patient.exists() or scope.coding.where(system='something' and code='adr').exists().not()
ppc-5 error Consent IF Scope=treatment, there must be a patient patient.exists() or scope.coding.where(system='something' and code='treatment').exists().not()

Differential View

This structure is derived from Consent

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Consent C 0..* Consent This is an abstract profile. Child profiles: ADIHealthcareAgentConsentPermit, ADIHealthcareAgentConsentDeny
A healthcare consumer's choices to permit or deny recipients or roles to perform actions for specific purposes and periods of time
Constraints: HCA-consent-category, HCA-provision-purpose
Consent.text This element must be supported. 1..1 Narrative Text summary of the resource, for human interpretation
Consent.status This element must be supported. 1..1 code draft | proposed | active | rejected | inactive | entered-in-error
Required Pattern: active (extensions allowed)
Consent.scope 1..1 CodeableConcept Which of the four areas this resource covers (extensible)
Required Pattern:
{
  "coding" : [
    {
      "system" : "http://loinc.org",
      "code" : "81377-4",
      "display" : "Goals, preferences, and priorities regarding the appointment of healthcare agents Narrative - Reported"
    }
  ]
}
Consent.category This element must be supported. 1..1 CodeableConcept Classification of the consent statement - for indexing/retrieval
Required Pattern:
{
  "coding" : [
    {
      "system" : "http://terminology.hl7.org/CodeSystem/consentcategorycodes",
      "version" : "1.0.1",
      "code" : "acd"
    }
  ]
}
Consent.patient This element must be supported. 1..1 Reference(US Core Patient Profile) Who the consent applies to
Consent.dateTime This element must be supported. 0..1 dateTime When this Consent was created or indexed
Consent.policy This element must be supported. 0..* BackboneElement Policies covered by this consent
Consent.provision This element must be supported. 1..1 BackboneElement Constraints to the base Consent.policyRule
Consent.provision.Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Consent.provision.Slices for extension.extension:ClauseExtension 0..* (Complex) Clause
URL: http://hl7.org/fhir/us/pacio-adi/StructureDefinition/adi-clause-extension
Consent.provision.type This element must be supported. 1..1 code deny | permit
Consent.provision.actor This element must be supported. 1..* BackboneElement Who|what controlled by this rule (or group, by role)
Consent.provision.actor.Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Consent.provision.actor.Slices for extension.extension:ClauseExtension 0..* (Complex) Clause
URL: http://hl7.org/fhir/us/pacio-adi/StructureDefinition/adi-clause-extension
Consent.provision.actor.role 1..1 CodeableConcept How the actor is involved
Binding: Healthcare Agent or Proxy Choices (required)
Consent.provision.actor.reference 1..1 Reference(ADI Healthcare Agent Participant) Resource for the actor (or group, by role)
Consent.provision.action 0..* CodeableConcept Actions controlled by this rule
Binding: Healthcare Agent Decisions (extensible)
Consent.provision.purpose 0..* Coding Context of activities covered by this rule
Binding: v3 Code System ActReason (required)

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
Consent.provision.actor.​role Base required Healthcare Agent or Proxy Choices ⏿20221029 tx.fhir.org
Consent.provision.action Base extensible Healthcare Agent Decisions 📦2.0.0 This IG
Consent.provision.purpose Base required v3 Code System ActReason 📦3.0.0 THO v7.4

Constraints

Id Grade Path(s) Description Expression
HCA-consent-category error Consent Category must have a ConsentCategory of 'acd' category.coding.where(code = 'acd').exists()
HCA-provision-purpose error Consent Provision purpose must have a purpose of 'PWATRNY' provision.purpose.exists().not() or provision.purpose.where(code = 'PWATRNY').exists()

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Consent C 0..* Consent This is an abstract profile. Child profiles: ADIHealthcareAgentConsentPermit, ADIHealthcareAgentConsentDeny
A healthcare consumer's choices to permit or deny recipients or roles to perform actions for specific purposes and periods of time
Constraints: ppc-1, ppc-2, ppc-3, ppc-4, ppc-5, HCA-consent-category, HCA-provision-purpose
Consent.id This element is included in summaries. 0..1 id Logical id of this artifact
Consent.meta This element is included in summaries. 0..1 Meta Metadata about the resource
Consent.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
Consent.language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
Consent.text This element must be supported. 1..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
Consent.contained 0..* Resource Contained, inline Resources
Consent.extension 0..* Extension Additional content defined by implementations
Consent.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
Consent.identifier This element is included in summaries. 0..* Identifier Identifier for this record (external references)

Example General: {"system":"http://acme.org/identifier/local/eCMS","value":"Local eCMS identifier"}
Consent.status This element is a modifier element. This element must be supported. This element is included in summaries. 1..1 code draft | proposed | active | rejected | inactive | entered-in-error
Binding: ConsentState (required): Indicates the state of the consent.
Required Pattern: active (extensions allowed)
Consent.scope This element is a modifier element. This element is included in summaries. 1..1 CodeableConcept Which of the four areas this resource covers (extensible)
Binding: ConsentScopeCodes (extensible): The four anticipated uses for the Consent Resource.
Required Pattern:
{
  "coding" : [
    {
      "system" : "http://loinc.org",
      "code" : "81377-4",
      "display" : "Goals, preferences, and priorities regarding the appointment of healthcare agents Narrative - Reported"
    }
  ]
}
Consent.category This element must be supported. This element is included in summaries. 1..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:
{
  "coding" : [
    {
      "system" : "http://terminology.hl7.org/CodeSystem/consentcategorycodes",
      "version" : "1.0.1",
      "code" : "acd"
    }
  ]
}
Consent.patient This element must be supported. This element is included in summaries. 1..1 Reference(US Core Patient Profile) Who the consent applies to
Consent.dateTime This element must be supported. This element is included in summaries. 0..1 dateTime When this Consent was created or indexed
Consent.performer This element is included in summaries. 0..* Reference(Organization | Patient | Practitioner | RelatedPerson | PractitionerRole) Who is agreeing to the policy and rules
Consent.organization This element is included in summaries. 0..* Reference(Organization) Custodian of the consent
Consent.source[x] This element is included in summaries. 0..1 Source from which this consent is taken
Consent.source[x].sourceAttachment Attachment
Consent.source[x].sourceReference Reference(Consent | DocumentReference | Contract | QuestionnaireResponse)
Consent.policy This element must be supported. 0..* BackboneElement Policies covered by this consent
Consent.policy.id 0..1 string Unique id for inter-element referencing
Consent.policy.extension 0..* Extension Additional content defined by implementations
Consent.policy.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Consent.policy.authority C 0..1 uri Enforcement source for policy
Consent.policy.uri C 0..1 uri Specific policy covered by this consent
Consent.policyRule This element is included in summaries. C 0..1 CodeableConcept Regulation that this consents to
Binding: ConsentPolicyRuleCodes (extensible): Regulatory policy examples.
Consent.verification This element is included in summaries. 0..* BackboneElement Consent Verified by patient or family
Consent.verification.id 0..1 string Unique id for inter-element referencing
Consent.verification.extension 0..* Extension Additional content defined by implementations
Consent.verification.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Consent.verification.verified This element is included in summaries. 1..1 boolean Has been verified
Consent.verification.verifiedWith 0..1 Reference(Patient | RelatedPerson) Person who verified
Consent.verification.verificationDate 0..1 dateTime When consent verified
Consent.provision This element must be supported. This element is included in summaries. 1..1 BackboneElement Constraints to the base Consent.policyRule
Consent.provision.id 0..1 string Unique id for inter-element referencing
Consent.provision.Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Consent.provision.Slices for extension.extension:ClauseExtension 0..* (Complex) Clause
URL: http://hl7.org/fhir/us/pacio-adi/StructureDefinition/adi-clause-extension
Consent.provision.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Consent.provision.type This element must be supported. This element is included in summaries. 1..1 code deny | permit
Binding: ConsentProvisionType (required): How a rule statement is applied, such as adding additional consent or removing consent.
Consent.provision.period This element is included in summaries. 0..1 Period Timeframe for this rule
Consent.provision.actor This element must be supported. 1..* BackboneElement Who|what controlled by this rule (or group, by role)
Consent.provision.actor.id 0..1 string Unique id for inter-element referencing
Consent.provision.actor.Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Consent.provision.actor.Slices for extension.extension:ClauseExtension 0..* (Complex) Clause
URL: http://hl7.org/fhir/us/pacio-adi/StructureDefinition/adi-clause-extension
Consent.provision.actor.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Consent.provision.actor.role 1..1 CodeableConcept How the actor is involved
Binding: Healthcare Agent or Proxy Choices (required)
Consent.provision.actor.reference 1..1 Reference(ADI Healthcare Agent Participant) Resource for the actor (or group, by role)
Consent.provision.action This element is included in summaries. 0..* CodeableConcept Actions controlled by this rule
Binding: Healthcare Agent Decisions (extensible)
Consent.provision.securityLabel This element is included in summaries. 0..* Coding Security Labels that define affected resources
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
Consent.provision.purpose This element is included in summaries. 0..* Coding Context of activities covered by this rule
Binding: v3 Code System ActReason (required)
Consent.provision.class This element is included in summaries. 0..* Coding e.g. Resource Type, Profile, CDA, etc.
Binding: ConsentContentClass (extensible): The class (type) of information a consent rule covers.
Consent.provision.code This element is included in summaries. 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.
Consent.provision.dataPeriod This element is included in summaries. 0..1 Period Timeframe for data controlled by this rule
Consent.provision.data This element is included in summaries. 0..* BackboneElement Data controlled by this rule
Consent.provision.data.id 0..1 string Unique id for inter-element referencing
Consent.provision.data.extension 0..* Extension Additional content defined by implementations
Consent.provision.data.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Consent.provision.data.meaning This element is included in summaries. 1..1 code instance | related | dependents | authoredby
Binding: ConsentDataMeaning (required): How a resource reference is interpreted when testing consent restrictions.
Consent.provision.data.reference This element is included in summaries. 1..1 Reference(Resource) The actual data reference
Consent.provision.provision 0..* See provision (Consent) Nested Exception Rules

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Consent.language Base preferred Common Languages 📍4.0.1 FHIR Std.
Consent.status Base required ConsentState 📍4.0.1 FHIR Std.
Consent.scope Base extensible Consent Scope Codes 📍4.0.1 FHIR Std.
Consent.category Base extensible Consent Category Codes 📍4.0.1 FHIR Std.
Consent.policyRule Base extensible Consent PolicyRule Codes 📍4.0.1 FHIR Std.
Consent.provision.type Base required ConsentProvisionType 📍4.0.1 FHIR Std.
Consent.provision.actor.​role Base required Healthcare Agent or Proxy Choices ⏿20221029 tx.fhir.org
Consent.provision.action Base extensible Healthcare Agent Decisions 📦2.0.0 This IG
Consent.provision.securityLabel Base extensible SecurityLabels 📍4.0.1 FHIR Std.
Consent.provision.purpose Base required v3 Code System ActReason 📦3.0.0 THO v7.4
Consent.provision.class Base extensible Consent Content Class 📍4.0.1 FHIR Std.
Consent.provision.code Base example Consent Content Codes 📍4.0.1 FHIR Std.
Consent.provision.data.​meaning Base required ConsentDataMeaning 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
HCA-consent-category error Consent Category must have a ConsentCategory of 'acd' category.coding.where(code = 'acd').exists()
HCA-provision-purpose error Consent Provision purpose must have a purpose of 'PWATRNY' provision.purpose.exists().not() or provision.purpose.where(code = 'PWATRNY').exists()
dom-2 error Consent If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Consent If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error Consent If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error Consent If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Consent A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
ppc-1 error Consent Either a Policy or PolicyRule policy.exists() or policyRule.exists()
ppc-2 error Consent IF Scope=privacy, there must be a patient patient.exists() or scope.coding.where(system='something' and code='patient-privacy').exists().not()
ppc-3 error Consent IF Scope=research, there must be a patient patient.exists() or scope.coding.where(system='something' and code='research').exists().not()
ppc-4 error Consent IF Scope=adr, there must be a patient patient.exists() or scope.coding.where(system='something' and code='adr').exists().not()
ppc-5 error Consent IF Scope=treatment, there must be a patient patient.exists() or scope.coding.where(system='something' and code='treatment').exists().not()

This structure is derived from Consent

 

Other representations of profile: CSV, Excel, Schematron