PDex Provider Access Consent Profile - Da Vinci Payer Data Exchange v2.2.1

Da Vinci Payer Data Exchange, published by HL7 International / Financial Management. This guide is not an authorized publication; it is the continuous build for version 2.2.1 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/davinci-epdx/ and changes regularly. See the Directory of published versions

Resource Profile: PDex Provider Access Consent Profile ( Experimental )

Official URL: http://hl7.org/fhir/us/davinci-pdex/StructureDefinition/pdex-provider-consent		Version: 2.2.1
Standards status: Draft	Maturity Level: 0	Computable Name: PDexProviderSharingConsent
Other Identifiers: OID:2.16.840.1.113883.4.642.40.8.42.45
Copyright/Legal: Used by permission of HL7 International, all rights reserved Creative Commons License

The PDex Provider Access Consent Profile enables a member to express their preference for the sharing of their healthcare information to providers through the Provider Access API. A member has to actively choose to opt-out of sharing their data. The opt-out may be exercised by the patient or by the patient's legally recognized personal representative (e.g., parent, guardian, or healthcare proxy), consistent with CMS-0057-F and HIPAA.

Provider Access Opt-out

The CMS Prior Authorization Rule (CMS-0057) requires that a health plan enables a member to choose to opt-out of sharing their data with providers via the Provider Access API. By default a member is opted-in to data sharing with Providers that have an existing, or impending treatment relationship. This implementation Guide provides a Consent profile that expresses a Member's decision to opt-out, i.e., Deny sharing of their data, A Member can also revoke that denial.

Usages:

CapabilityStatements using this Profile: PDex Server CapabilityStatement with US core 6.1 support and PDEX Server CapabilityStatement
This Profile is not used by any profiles in this Specification

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.

Key Elements Table
Differential Table
Snapshot Table
Statistics/References
All

Name	Flags	Card.	Type	Description & Constraints Filter: Bindings Constraints Obligations
Consent	C	0..*	Consent	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
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.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. Fixed Value: active (no extensions allowed)
Consent.scope	This element is a modifier element. This element must be supported. This element is included in summaries.	1..1	CodeableConcept	Information-disclosure scope (fixed to patient-privacy) Binding: ConsentScopeCodes (extensible): The four anticipated uses for the Consent Resource. Required Pattern: `{ "coding" : [ { "system" : "http://terminology.hl7.org/CodeSystem/consentscope", "code" : "patient-privacy" } ] }`
Consent.Slices for category	This element is included in summaries.	2..*	CodeableConcept	Classification of the consent statement - for indexing/retrieval Slice: Unordered, Open by pattern:$this Binding: ConsentCategoryCodes (extensible): A classification of the type of consents found in a consent statement.
Consent.Slices for category.category:disclosure	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/v3-ActCode", "code" : "IDSCL" } ] }`
Consent.Slices for category.category:apiPurpose	This element must be supported. This element is included in summaries.	1..1	CodeableConcept	Identifies this Consent as applying to the Provider Access API Binding: ConsentCategoryCodes (extensible): A classification of the type of consents found in a consent statement. Required Pattern: `{ "coding" : [ { "system" : "http://hl7.org/fhir/us/davinci-pdex/CodeSystem/pdex-consent-api-purpose", "code" : "provider-access" } ] }`
Consent.patient	This element must be supported. This element is included in summaries.	1..1	Reference(US Core Patient Profile(7.0.0))	Who the consent applies to
Consent.performer	This element must be supported. This element is included in summaries.	1..1	Reference(US Core Patient Profile(7.0.0) \| US Core RelatedPerson Profile(7.0.0))	Who is agreeing to the policy and rules
Consent.organization	This element must be supported. This element is included in summaries.	1..1	Reference(HRex Organization Profile(1.2.0))	Custodian of the consent
Consent.policyRule	This element is included in summaries. C	0..1	CodeableConcept	Regulation that this consents to Binding: ConsentPolicyRuleCodes (extensible): Regulatory policy examples. Required Pattern: `{ "coding" : [ { "system" : "http://terminology.hl7.org/CodeSystem/consentpolicycodes", "code" : "cric", "display" : "Common Rule Informed Consent" } ] }`
Consent.provision	This element must be supported. This element is included in summaries.	1..1	BackboneElement	Constraints to the base Consent.policyRule
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 must be supported. This element is included in summaries.	1..1	Period	Timeframe for this rule
Consent.provision.period.start	This element must be supported. This element is included in summaries. C	1..1	dateTime	Starting time with inclusive boundary
Consent.provision.Slices for actor		1..*	BackboneElement	Who\|what controlled by this rule (or group, by role) Slice: Unordered, Open by pattern:role
Consent.provision.Slices for actor.actor:All Slices				Content/Rules for all slices
Consent.provision.Slices for actor.actor:All Slices.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.Slices for actor.actor:All Slices.role		1..1	CodeableConcept	How the actor is involved Binding: SecurityRoleType (extensible): How an actor is involved in the consent considerations.
Consent.provision.Slices for actor.actor:All Slices.reference		1..1	Reference(Device \| Group \| CareTeam \| Organization \| Patient \| Practitioner \| RelatedPerson \| PractitionerRole)	Resource for the actor (or group, by role)
Consent.provision.Slices for actor.actor:source	This element must be supported.	1..*	BackboneElement	Authorized or Not to disclose
Consent.provision.Slices for actor.actor:source.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.Slices for actor.actor:source.role	This element must be supported.	1..1	CodeableConcept	How the actor is involved Binding: SecurityRoleType (extensible): How an actor is involved in the consent considerations. Required Pattern: `{ "coding" : [ { "system" : "http://terminology.hl7.org/CodeSystem/provenance-participant-type", "code" : "performer" } ] }`
Consent.provision.Slices for actor.actor:source.reference	This element must be supported.	1..1	Reference(HRex Organization Profile(1.2.0))	Resource for the actor (or group, by role)
Consent.provision.action	This element must be supported. This element is included in summaries.	1..1	CodeableConcept	Action permitted or denied - use 'disclose' with provision.type='deny' for Provider Access opt-out Binding: ConsentActionCodes (required)
Consent.provision.action.Slices for extension				Content/Rules for all slices
Consent.provision.action.Slices for extension.extension:providerAccessUseCase	This element must be supported.	0..1	boolean	Indicates this action applies to Provider Access API URL: http://hl7.org/fhir/us/davinci-pdex/StructureDefinition/pdex-provider-access-use-case
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.category:disclosure	Base	extensible	Consent Category Codes	📍4.0.1	FHIR Std.
Consent.category:apiPurpose	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	extensible	SecurityRoleType	📍4.0.1	FHIR Std.
Consent.provision.actor:source.role	Base	extensible	SecurityRoleType	📍4.0.1	FHIR Std.
Consent.provision.action	Base	required	Consent Action Codes	📦4.0.1	FHIR Std.

Constraints

Grade

Path(s)

Description

Expression

This structure is derived from Consent

Name	Flags	Card.	Type	Description & Constraints Filter: Bindings Constraints Obligations
Consent		0..*	Consent	A healthcare consumer's choices to permit or deny recipients or roles to perform actions for specific purposes and periods of time
Consent.status	This element must be supported.	1..1	code	draft \| proposed \| active \| rejected \| inactive \| entered-in-error Fixed Value: active (no extensions allowed)
Consent.scope	This element must be supported.	1..1	CodeableConcept	Information-disclosure scope (fixed to patient-privacy) Required Pattern: `{ "coding" : [ { "system" : "http://terminology.hl7.org/CodeSystem/consentscope", "code" : "patient-privacy" } ] }`
Consent.Slices for category		2..*	CodeableConcept	Classification of the consent statement - for indexing/retrieval Slice: Unordered, Open by pattern:$this
Consent.Slices for category.category:disclosure	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/v3-ActCode", "code" : "IDSCL" } ] }`
Consent.Slices for category.category:apiPurpose	This element must be supported.	1..1	CodeableConcept	Identifies this Consent as applying to the Provider Access API Required Pattern: `{ "coding" : [ { "system" : "http://hl7.org/fhir/us/davinci-pdex/CodeSystem/pdex-consent-api-purpose", "code" : "provider-access" } ] }`
Consent.patient	This element must be supported.	1..1	Reference(US Core Patient Profile(7.0.0))	Who the consent applies to
Consent.performer	This element must be supported.	1..1	Reference(US Core Patient Profile(7.0.0) \| US Core RelatedPerson Profile(7.0.0))	Who is agreeing to the policy and rules
Consent.organization	This element must be supported.	1..1	Reference(HRex Organization Profile(1.2.0))	Custodian of the consent
Consent.policyRule		0..1	CodeableConcept	Regulation that this consents to Required Pattern: `{ "coding" : [ { "system" : "http://terminology.hl7.org/CodeSystem/consentpolicycodes", "code" : "cric", "display" : "Common Rule Informed Consent" } ] }`
Consent.provision	This element must be supported.	1..1	BackboneElement	Constraints to the base Consent.policyRule
Consent.provision.type	This element must be supported.	1..1	code	deny \| permit
Consent.provision.period	This element must be supported.	1..1	Period	Timeframe for this rule
Consent.provision.period.start	This element must be supported.	1..1	dateTime	Starting time with inclusive boundary
Consent.provision.Slices for actor		1..*	BackboneElement	Who\|what controlled by this rule (or group, by role) Slice: Unordered, Open by pattern:role
Consent.provision.Slices for actor.actor:source	This element must be supported.	1..*	BackboneElement	Authorized or Not to disclose
Consent.provision.Slices for actor.actor:source.role	This element must be supported.	1..1	CodeableConcept	How the actor is involved Required Pattern: `{ "coding" : [ { "system" : "http://terminology.hl7.org/CodeSystem/provenance-participant-type", "code" : "performer" } ] }`
Consent.provision.Slices for actor.actor:source.reference	This element must be supported.	1..1	Reference(HRex Organization Profile(1.2.0))	Resource for the actor (or group, by role)
Consent.provision.action	This element must be supported.	1..1	CodeableConcept	Action permitted or denied - use 'disclose' with provision.type='deny' for Provider Access opt-out Binding: ConsentActionCodes (required)
Consent.provision.action.Slices for extension				Content/Rules for all slices
Consent.provision.action.Slices for extension.extension:providerAccessUseCase	This element must be supported.	0..1	boolean	Indicates this action applies to Provider Access API URL: http://hl7.org/fhir/us/davinci-pdex/StructureDefinition/pdex-provider-access-use-case
Documentation for this format

Terminology Bindings (Differential)

Path	Status	Usage	ValueSet	Version	Source
Consent.provision.action	Base	required	Consent Action Codes	📦4.0.1	FHIR Std.

Description & Constraints Filter:

Consent C 0..* Consent 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

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

language

0..1

code

Language of the resource content
Binding: CommonLanguages (preferred): A human language.

Additional Bindings

Purpose

AllLanguages

Max Binding

Consent.text 0..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.
Fixed Value: active (no extensions allowed)

scope

1..1

CodeableConcept

Information-disclosure scope (fixed to patient-privacy)
Binding: ConsentScopeCodes (extensible): The four anticipated uses for the Consent Resource.
Required Pattern:

{
  "coding" : [
    {
      "system" : "http://terminology.hl7.org/CodeSystem/consentscope",
      "code" : "patient-privacy"
    }
  ]
}

Consent.Slices for category This element is included in summaries. 2..* CodeableConcept Classification of the consent statement - for indexing/retrieval
Slice: Unordered, Open by pattern:$this
Binding: ConsentCategoryCodes (extensible): A classification of the type of consents found in a consent statement.

category:disclosure

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/v3-ActCode",
      "code" : "IDSCL"
    }
  ]
}

category:apiPurpose

1..1

CodeableConcept

Identifies this Consent as applying to the Provider Access API
Binding: ConsentCategoryCodes (extensible): A classification of the type of consents found in a consent statement.

Required Pattern:

{
  "coding" : [
    {
      "system" : "http://hl7.org/fhir/us/davinci-pdex/CodeSystem/pdex-consent-api-purpose",
      "code" : "provider-access"
    }
  ]
}

Consent.patient This element must be supported. This element is included in summaries. 1..1 Reference(US Core Patient Profile(7.0.0)) Who the consent applies to

Consent.dateTime This element is included in summaries. 0..1 dateTime When this Consent was created or indexed

Consent.performer This element must be supported. This element is included in summaries. 1..1 Reference(US Core Patient Profile(7.0.0) | US Core RelatedPerson Profile(7.0.0)) Who is agreeing to the policy and rules

Consent.organization This element must be supported. This element is included in summaries. 1..1 Reference(HRex Organization Profile(1.2.0)) 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 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

policyRule

0..1

CodeableConcept

Regulation that this consents to
Binding: ConsentPolicyRuleCodes (extensible): Regulatory policy examples.
Required Pattern:

{
  "coding" : [
    {
      "system" : "http://terminology.hl7.org/CodeSystem/consentpolicycodes",
      "code" : "cric",
      "display" : "Common Rule Informed Consent"
    }
  ]
}

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.extension 0..* Extension Additional content defined by implementations

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 must be supported. This element is included in summaries. 1..1 Period Timeframe for this rule

Consent.provision.period.id 0..1 string Unique id for inter-element referencing

Consent.provision.period.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url

Consent.provision.period.start This element must be supported. This element is included in summaries. C 1..1 dateTime Starting time with inclusive boundary

Consent.provision.period.end This element is included in summaries. C 0..1 dateTime End time with inclusive boundary, if not ongoing

Consent.provision.Slices for actor 1..* BackboneElement Who|what controlled by this rule (or group, by role)
Slice: Unordered, Open by pattern:role

Consent.provision.Slices for actor.actor:All Slices Content/Rules for all slices

Consent.provision.Slices for actor.actor:All Slices.id 0..1 string Unique id for inter-element referencing

Consent.provision.Slices for actor.actor:All Slices.extension 0..* Extension Additional content defined by implementations

Consent.provision.Slices for actor.actor:All Slices.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.Slices for actor.actor:All Slices.role 1..1 CodeableConcept How the actor is involved
Binding: SecurityRoleType (extensible): How an actor is involved in the consent considerations.

Consent.provision.Slices for actor.actor:source This element must be supported. 1..* BackboneElement Authorized or Not to disclose

Consent.provision.Slices for actor.actor:source.id 0..1 string Unique id for inter-element referencing

Consent.provision.Slices for actor.actor:source.extension 0..* Extension Additional content defined by implementations

Consent.provision.Slices for actor.actor:source.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized

role

1..1

CodeableConcept

How the actor is involved
Binding: SecurityRoleType (extensible): How an actor is involved in the consent considerations.
Required Pattern:

{
  "coding" : [
    {
      "system" : "http://terminology.hl7.org/CodeSystem/provenance-participant-type",
      "code" : "performer"
    }
  ]
}

Consent.provision.Slices for actor.actor:source.reference This element must be supported. 1..1 Reference(HRex Organization Profile(1.2.0)) Resource for the actor (or group, by role)

Consent.provision.action This element must be supported. This element is included in summaries. 1..1 CodeableConcept Action permitted or denied - use 'disclose' with provision.type='deny' for Provider Access opt-out
Binding: ConsentActionCodes (required)

Consent.provision.action.id 0..1 string Unique id for inter-element referencing

Consent.provision.action.Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url

Consent.provision.action.Slices for extension.extension:providerAccessUseCase This element must be supported. 0..1 boolean Indicates this action applies to Provider Access API
URL: http://hl7.org/fhir/us/davinci-pdex/StructureDefinition/pdex-provider-access-use-case

Consent.provision.action.coding This element is included in summaries. 0..* Coding Code defined by a terminology system

Consent.provision.action.text This element is included in summaries. 0..1 string Plain text representation of the concept

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: PurposeOfUse (3.1.0) (extensible): What purposes of use are controlled by this exception. If more than one label is specified, operations must have all the specified labels.

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

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.category:disclosure	Base	extensible	Consent Category Codes	📍4.0.1	FHIR Std.
Consent.category:apiPurpose	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	extensible	SecurityRoleType	📍4.0.1	FHIR Std.
Consent.provision.actor:source.role	Base	extensible	SecurityRoleType	📍4.0.1	FHIR Std.
Consent.provision.action	Base	required	Consent Action Codes	📦4.0.1	FHIR Std.
Consent.provision.securityLabel	Base	extensible	SecurityLabels	📍4.0.1	FHIR Std.
Consent.provision.purpose	Base	extensible	PurposeOfUse	📍3.1.0	THO v7.2
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

Grade

Path(s)

Description

Expression

This structure is derived from Consent

Summary

Mandatory: 12 elements
Must-Support: 16 elements
Fixed: 1 element

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

http://hl7.org/fhir/us/davinci-pdex/StructureDefinition/pdex-provider-access-use-case

Slices

This structure defines the following Slices:

The element 1 is sliced based on the value of Consent.category
The element 1 is sliced based on the value of Consent.provision.actor

Maturity: 0

Key Elements View

Name	Flags	Card.	Type	Description & Constraints Filter: Bindings Constraints Obligations
Consent	C	0..*	Consent	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
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.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. Fixed Value: active (no extensions allowed)
Consent.scope	This element is a modifier element. This element must be supported. This element is included in summaries.	1..1	CodeableConcept	Information-disclosure scope (fixed to patient-privacy) Binding: ConsentScopeCodes (extensible): The four anticipated uses for the Consent Resource. Required Pattern: `{ "coding" : [ { "system" : "http://terminology.hl7.org/CodeSystem/consentscope", "code" : "patient-privacy" } ] }`
Consent.Slices for category	This element is included in summaries.	2..*	CodeableConcept	Classification of the consent statement - for indexing/retrieval Slice: Unordered, Open by pattern:$this Binding: ConsentCategoryCodes (extensible): A classification of the type of consents found in a consent statement.
Consent.Slices for category.category:disclosure	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/v3-ActCode", "code" : "IDSCL" } ] }`
Consent.Slices for category.category:apiPurpose	This element must be supported. This element is included in summaries.	1..1	CodeableConcept	Identifies this Consent as applying to the Provider Access API Binding: ConsentCategoryCodes (extensible): A classification of the type of consents found in a consent statement. Required Pattern: `{ "coding" : [ { "system" : "http://hl7.org/fhir/us/davinci-pdex/CodeSystem/pdex-consent-api-purpose", "code" : "provider-access" } ] }`
Consent.patient	This element must be supported. This element is included in summaries.	1..1	Reference(US Core Patient Profile(7.0.0))	Who the consent applies to
Consent.performer	This element must be supported. This element is included in summaries.	1..1	Reference(US Core Patient Profile(7.0.0) \| US Core RelatedPerson Profile(7.0.0))	Who is agreeing to the policy and rules
Consent.organization	This element must be supported. This element is included in summaries.	1..1	Reference(HRex Organization Profile(1.2.0))	Custodian of the consent
Consent.policyRule	This element is included in summaries. C	0..1	CodeableConcept	Regulation that this consents to Binding: ConsentPolicyRuleCodes (extensible): Regulatory policy examples. Required Pattern: `{ "coding" : [ { "system" : "http://terminology.hl7.org/CodeSystem/consentpolicycodes", "code" : "cric", "display" : "Common Rule Informed Consent" } ] }`
Consent.provision	This element must be supported. This element is included in summaries.	1..1	BackboneElement	Constraints to the base Consent.policyRule
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 must be supported. This element is included in summaries.	1..1	Period	Timeframe for this rule
Consent.provision.period.start	This element must be supported. This element is included in summaries. C	1..1	dateTime	Starting time with inclusive boundary
Consent.provision.Slices for actor		1..*	BackboneElement	Who\|what controlled by this rule (or group, by role) Slice: Unordered, Open by pattern:role
Consent.provision.Slices for actor.actor:All Slices				Content/Rules for all slices
Consent.provision.Slices for actor.actor:All Slices.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.Slices for actor.actor:All Slices.role		1..1	CodeableConcept	How the actor is involved Binding: SecurityRoleType (extensible): How an actor is involved in the consent considerations.
Consent.provision.Slices for actor.actor:All Slices.reference		1..1	Reference(Device \| Group \| CareTeam \| Organization \| Patient \| Practitioner \| RelatedPerson \| PractitionerRole)	Resource for the actor (or group, by role)
Consent.provision.Slices for actor.actor:source	This element must be supported.	1..*	BackboneElement	Authorized or Not to disclose
Consent.provision.Slices for actor.actor:source.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.Slices for actor.actor:source.role	This element must be supported.	1..1	CodeableConcept	How the actor is involved Binding: SecurityRoleType (extensible): How an actor is involved in the consent considerations. Required Pattern: `{ "coding" : [ { "system" : "http://terminology.hl7.org/CodeSystem/provenance-participant-type", "code" : "performer" } ] }`
Consent.provision.Slices for actor.actor:source.reference	This element must be supported.	1..1	Reference(HRex Organization Profile(1.2.0))	Resource for the actor (or group, by role)
Consent.provision.action	This element must be supported. This element is included in summaries.	1..1	CodeableConcept	Action permitted or denied - use 'disclose' with provision.type='deny' for Provider Access opt-out Binding: ConsentActionCodes (required)
Consent.provision.action.Slices for extension				Content/Rules for all slices
Consent.provision.action.Slices for extension.extension:providerAccessUseCase	This element must be supported.	0..1	boolean	Indicates this action applies to Provider Access API URL: http://hl7.org/fhir/us/davinci-pdex/StructureDefinition/pdex-provider-access-use-case
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.category:disclosure	Base	extensible	Consent Category Codes	📍4.0.1	FHIR Std.
Consent.category:apiPurpose	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	extensible	SecurityRoleType	📍4.0.1	FHIR Std.
Consent.provision.actor:source.role	Base	extensible	SecurityRoleType	📍4.0.1	FHIR Std.
Consent.provision.action	Base	required	Consent Action Codes	📦4.0.1	FHIR Std.

Constraints

Grade

Path(s)

Description

Expression

Differential View

This structure is derived from Consent

Name	Flags	Card.	Type	Description & Constraints Filter: Bindings Constraints Obligations
Consent		0..*	Consent	A healthcare consumer's choices to permit or deny recipients or roles to perform actions for specific purposes and periods of time
Consent.status	This element must be supported.	1..1	code	draft \| proposed \| active \| rejected \| inactive \| entered-in-error Fixed Value: active (no extensions allowed)
Consent.scope	This element must be supported.	1..1	CodeableConcept	Information-disclosure scope (fixed to patient-privacy) Required Pattern: `{ "coding" : [ { "system" : "http://terminology.hl7.org/CodeSystem/consentscope", "code" : "patient-privacy" } ] }`
Consent.Slices for category		2..*	CodeableConcept	Classification of the consent statement - for indexing/retrieval Slice: Unordered, Open by pattern:$this
Consent.Slices for category.category:disclosure	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/v3-ActCode", "code" : "IDSCL" } ] }`
Consent.Slices for category.category:apiPurpose	This element must be supported.	1..1	CodeableConcept	Identifies this Consent as applying to the Provider Access API Required Pattern: `{ "coding" : [ { "system" : "http://hl7.org/fhir/us/davinci-pdex/CodeSystem/pdex-consent-api-purpose", "code" : "provider-access" } ] }`
Consent.patient	This element must be supported.	1..1	Reference(US Core Patient Profile(7.0.0))	Who the consent applies to
Consent.performer	This element must be supported.	1..1	Reference(US Core Patient Profile(7.0.0) \| US Core RelatedPerson Profile(7.0.0))	Who is agreeing to the policy and rules
Consent.organization	This element must be supported.	1..1	Reference(HRex Organization Profile(1.2.0))	Custodian of the consent
Consent.policyRule		0..1	CodeableConcept	Regulation that this consents to Required Pattern: `{ "coding" : [ { "system" : "http://terminology.hl7.org/CodeSystem/consentpolicycodes", "code" : "cric", "display" : "Common Rule Informed Consent" } ] }`
Consent.provision	This element must be supported.	1..1	BackboneElement	Constraints to the base Consent.policyRule
Consent.provision.type	This element must be supported.	1..1	code	deny \| permit
Consent.provision.period	This element must be supported.	1..1	Period	Timeframe for this rule
Consent.provision.period.start	This element must be supported.	1..1	dateTime	Starting time with inclusive boundary
Consent.provision.Slices for actor		1..*	BackboneElement	Who\|what controlled by this rule (or group, by role) Slice: Unordered, Open by pattern:role
Consent.provision.Slices for actor.actor:source	This element must be supported.	1..*	BackboneElement	Authorized or Not to disclose
Consent.provision.Slices for actor.actor:source.role	This element must be supported.	1..1	CodeableConcept	How the actor is involved Required Pattern: `{ "coding" : [ { "system" : "http://terminology.hl7.org/CodeSystem/provenance-participant-type", "code" : "performer" } ] }`
Consent.provision.Slices for actor.actor:source.reference	This element must be supported.	1..1	Reference(HRex Organization Profile(1.2.0))	Resource for the actor (or group, by role)
Consent.provision.action	This element must be supported.	1..1	CodeableConcept	Action permitted or denied - use 'disclose' with provision.type='deny' for Provider Access opt-out Binding: ConsentActionCodes (required)
Consent.provision.action.Slices for extension				Content/Rules for all slices
Consent.provision.action.Slices for extension.extension:providerAccessUseCase	This element must be supported.	0..1	boolean	Indicates this action applies to Provider Access API URL: http://hl7.org/fhir/us/davinci-pdex/StructureDefinition/pdex-provider-access-use-case
Documentation for this format

Terminology Bindings (Differential)

Path	Status	Usage	ValueSet	Version	Source
Consent.provision.action	Base	required	Consent Action Codes	📦4.0.1	FHIR Std.

Snapshot View

Description & Constraints Filter:

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

language

0..1

code

Language of the resource content
Binding: CommonLanguages (preferred): A human language.

Additional Bindings

Purpose

AllLanguages

Max Binding

Consent.text 0..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

scope

1..1

CodeableConcept

Information-disclosure scope (fixed to patient-privacy)
Binding: ConsentScopeCodes (extensible): The four anticipated uses for the Consent Resource.
Required Pattern:

{
  "coding" : [
    {
      "system" : "http://terminology.hl7.org/CodeSystem/consentscope",
      "code" : "patient-privacy"
    }
  ]
}

category:disclosure

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/v3-ActCode",
      "code" : "IDSCL"
    }
  ]
}

category:apiPurpose

1..1

CodeableConcept

Identifies this Consent as applying to the Provider Access API
Binding: ConsentCategoryCodes (extensible): A classification of the type of consents found in a consent statement.

Required Pattern:

{
  "coding" : [
    {
      "system" : "http://hl7.org/fhir/us/davinci-pdex/CodeSystem/pdex-consent-api-purpose",
      "code" : "provider-access"
    }
  ]
}

Consent.patient This element must be supported. This element is included in summaries. 1..1 Reference(US Core Patient Profile(7.0.0)) Who the consent applies to

Consent.dateTime This element is included in summaries. 0..1 dateTime When this Consent was created or indexed

Consent.organization This element must be supported. This element is included in summaries. 1..1 Reference(HRex Organization Profile(1.2.0)) 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 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

policyRule

0..1

CodeableConcept

Regulation that this consents to
Binding: ConsentPolicyRuleCodes (extensible): Regulatory policy examples.
Required Pattern:

{
  "coding" : [
    {
      "system" : "http://terminology.hl7.org/CodeSystem/consentpolicycodes",
      "code" : "cric",
      "display" : "Common Rule Informed Consent"
    }
  ]
}