| Left: | PDex Provider Access Consent Profile (http://hl7.org/fhir/us/davinci-pdex/StructureDefinition/pdex-provider-consent) |
| Right: | PDex Provider Access Consent Profile (http://hl7.org/fhir/us/davinci-pdex/StructureDefinition/pdex-provider-consent) |
| Error | StructureDefinition.version | Values for version differ: '2.1.0' vs '2.2.0' |
| Information | StructureDefinition.date | Values for date differ: '2025-06-18T00:57:14+00:00' vs '2026-03-19T14:08:32+00:00' |
| Information | Consent.language | Example/preferred bindings differ at Consent.language using binding from PDexProviderSharingConsent |
| Information | Consent.category | Element minimum cardinalities differ: '1' vs '2' |
| Information | StructureDefinition.comment | Values for comment differ: 'Commonly, the patient the consent pertains to is the consentor, but particularly for young and old people, it may be some other person - e.g. a legal guardian.' vs 'The individual who performed the opt-out. This SHALL be either the patient themselves (US Core Patient Profile) or the patient's legally recognized personal representative acting on their behalf (US Core RelatedPerson Profile), such as a parent, guardian, or healthcare proxy, consistent with CMS-0057-F and HIPAA.' |
| Information | StructureDefinition.short | Values for short differ: 'Actions controlled by this rule' vs 'Action permitted or denied - use 'disclose' with provision.type='deny' for Provider Access opt-out' |
| Information | StructureDefinition.comment | Values for comment differ: 'Note that this is the direct action (not the grounds for the action covered in the purpose element). At present, the only action in the understood and tested scope of this resource is 'read'.' vs 'To opt-out of Provider Access data sharing, set provision.type to 'deny' and provision.action to 'disclose'. The ProviderAccessUseCase extension identifies this consent as specific to the Provider Access API.' |
| Warning | Consent.provision.action | Elements differ in definition for mustSupport: 'false' vs 'true' |
| Name | Value | Comments | |
|---|---|---|---|
abstract | false | ||
baseDefinition | http://hl7.org/fhir/StructureDefinition/Consent | ||
copyright | Used by permission of HL7 International, all rights reserved Creative Commons License | ||
date | 2025-06-18T00:57:14+00:00 | 2026-03-19T14:08:32+00:00 |
|
description | 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 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. |
|
experimental | true | ||
fhirVersion | 4.0.1 | ||
jurisdiction | |||
![]() jurisdiction[0] | urn:iso:std:iso:3166#US | ||
kind | resource | ||
name | PDexProviderSharingConsent | ||
publisher | HL7 International / Financial Management | ||
purpose | |||
status | draft | ||
title | PDex Provider Access Consent Profile | ||
type | Consent | ||
url | http://hl7.org/fhir/us/davinci-pdex/StructureDefinition/pdex-provider-consent | ||
version | 2.1.0 | 2.2.0 |
|
| Name | L Flags | L Card. | L Type | L Description & Constraints | R Flags | R Card. | R Type | R Description & Constraints | Comments![]() | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
![]() | 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 | 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 | |||||||||
![]() ![]() | Σ | 0..1 | id | Logical id of this artifact | Σ | 0..1 | id | Logical id of this artifact | |||||||||
![]() ![]() | Σ | 0..1 | Meta | Metadata about the resource | Σ | 0..1 | Meta | Metadata about the resource | |||||||||
![]() ![]() | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ?!Σ | 0..1 | uri | A set of rules under which this content was created | |||||||||
![]() ![]() | 0..1 | code | Language of the resource content Binding: ?? (preferred): A human language.
| 0..1 | code | Language of the resource content Binding: ?? (preferred): A human language.
|
| ||||||||||
![]() ![]() | 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 | 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 | |||||||||||
![]() ![]() | 0..* | Resource | Contained, inline Resources | 0..* | Resource | Contained, inline Resources | |||||||||||
![]() ![]() | 0..* | Extension | Additional content defined by implementations | 0..* | Extension | Additional content defined by implementations | |||||||||||
![]() ![]() | ?! | 0..* | Extension | Extensions that cannot be ignored | ?! | 0..* | Extension | Extensions that cannot be ignored | |||||||||
![]() ![]() | Σ | 0..* | Identifier | Identifier for this record (external references) Example General: {"system":"http://acme.org/identifier/local/eCMS","value":"Local eCMS identifier"} | Σ | 0..* | Identifier | Identifier for this record (external references) Example General: {"system":"http://acme.org/identifier/local/eCMS","value":"Local eCMS identifier"} | |||||||||
![]() ![]() | ?!SΣ | 1..1 | code | draft | proposed | active | rejected | inactive | entered-in-error Binding: ?? (required): Indicates the state of the consent. Fixed Value: active | ?!SΣ | 1..1 | code | draft | proposed | active | rejected | inactive | entered-in-error Binding: ?? (required): Indicates the state of the consent. Fixed Value: active | |||||||||
![]() ![]() | ?!SΣ | 1..1 | CodeableConcept | Which of the four areas this resource covers (extensible) Binding: ?? (extensible): The four anticipated uses for the Consent Resource. Required Pattern: {"coding":[{"system":"http://terminology.hl7.org/CodeSystem/consentscope","code":"patient-privacy"}]} | ?!SΣ | 1..1 | CodeableConcept | Which of the four areas this resource covers (extensible) Binding: ?? (extensible): The four anticipated uses for the Consent Resource. Required Pattern: {"coding":[{"system":"http://terminology.hl7.org/CodeSystem/consentscope","code":"patient-privacy"}]} | |||||||||
![]() ![]() | Σ | 1..* | CodeableConcept | Classification of the consent statement - for indexing/retrieval Slice: Unordered, Open by pattern:$this Binding: ?? (extensible): A classification of the type of consents found in a consent statement. | Σ | 2..* | CodeableConcept | Classification of the consent statement - for indexing/retrieval Slice: Unordered, Open by pattern:$this Binding: ?? (extensible): A classification of the type of consents found in a consent statement. |
| ||||||||
![]() ![]() | SΣ | 1..1 | Reference(US Core Patient Profile(7.0.0)) | Who the consent applies to | SΣ | 1..1 | Reference(US Core Patient Profile(7.0.0)) | Who the consent applies to | |||||||||
![]() ![]() | Σ | 0..1 | dateTime | When this Consent was created or indexed | Σ | 0..1 | dateTime | When this Consent was created or indexed | |||||||||
![]() ![]() | SΣ | 1..1 | Reference(US Core Patient Profile(7.0.0)) | Who is agreeing to the policy and rules | SΣ | 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 | |||||||||
![]() ![]() | SΣ | 1..1 | Reference(HRex Organization Profile(1.1.0)) | Custodian of the consent | SΣ | 1..1 | Reference(HRex Organization Profile(1.1.0)) | Custodian of the consent | |||||||||
![]() ![]() | Σ | 0..1 | Attachment, Reference(Consent | DocumentReference | Contract | QuestionnaireResponse) | Source from which this consent is taken | Σ | 0..1 | Attachment, Reference(Consent | DocumentReference | Contract | QuestionnaireResponse) | Source from which this consent is taken | |||||||||
![]() ![]() | 0..* | BackboneElement | Policies covered by this consent | 0..* | BackboneElement | Policies covered by this consent | |||||||||||
![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | 0..1 | string | Unique id for inter-element referencing | |||||||||||
![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations | 0..* | Extension | Additional content defined by implementations | |||||||||||
![]() ![]() ![]() | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||||||
![]() ![]() ![]() | C | 0..1 | uri | Enforcement source for policy | C | 0..1 | uri | Enforcement source for policy | |||||||||
![]() ![]() ![]() | C | 0..1 | uri | Specific policy covered by this consent | C | 0..1 | uri | Specific policy covered by this consent | |||||||||
![]() ![]() | ΣC | 0..1 | CodeableConcept | Regulation that this consents to Binding: ?? (extensible): Regulatory policy examples. Required Pattern: {"coding":[{"system":"http://terminology.hl7.org/CodeSystem/consentpolicycodes","code":"cric","display":"Common Rule Informed Consent"}]} | ΣC | 0..1 | CodeableConcept | Regulation that this consents to Binding: ?? (extensible): Regulatory policy examples. Required Pattern: {"coding":[{"system":"http://terminology.hl7.org/CodeSystem/consentpolicycodes","code":"cric","display":"Common Rule Informed Consent"}]} | |||||||||
![]() ![]() | Σ | 0..* | BackboneElement | Consent Verified by patient or family | Σ | 0..* | BackboneElement | Consent Verified by patient or family | |||||||||
![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | 0..1 | string | Unique id for inter-element referencing | |||||||||||
![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations | 0..* | Extension | Additional content defined by implementations | |||||||||||
![]() ![]() ![]() | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||||||
![]() ![]() ![]() | Σ | 1..1 | boolean | Has been verified | Σ | 1..1 | boolean | Has been verified | |||||||||
![]() ![]() ![]() | 0..1 | Reference(Patient | RelatedPerson) | Person who verified | 0..1 | Reference(Patient | RelatedPerson) | Person who verified | |||||||||||
![]() ![]() ![]() | 0..1 | dateTime | When consent verified | 0..1 | dateTime | When consent verified | |||||||||||
![]() ![]() | SΣ | 1..1 | BackboneElement | Constraints to the base Consent.policyRule | SΣ | 1..1 | BackboneElement | Constraints to the base Consent.policyRule | |||||||||
![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | 0..1 | string | Unique id for inter-element referencing | |||||||||||
![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations | 0..* | Extension | Additional content defined by implementations | |||||||||||
![]() ![]() ![]() | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||||||
![]() ![]() ![]() | SΣ | 1..1 | code | deny | permit Binding: ?? (required): How a rule statement is applied, such as adding additional consent or removing consent. | SΣ | 1..1 | code | deny | permit Binding: ?? (required): How a rule statement is applied, such as adding additional consent or removing consent. | |||||||||
![]() ![]() ![]() | SΣ | 1..1 | Period | Timeframe for this rule | SΣ | 1..1 | Period | Timeframe for this rule | |||||||||
![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | 0..1 | string | Unique id for inter-element referencing | |||||||||||
![]() ![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||||||
![]() ![]() ![]() ![]() | SΣC | 1..1 | dateTime | Starting time with inclusive boundary | SΣC | 1..1 | dateTime | Starting time with inclusive boundary | |||||||||
![]() ![]() ![]() ![]() | ΣC | 0..1 | dateTime | End time with inclusive boundary, if not ongoing | ΣC | 0..1 | dateTime | End time with inclusive boundary, if not ongoing | |||||||||
![]() ![]() ![]() | 1..* | BackboneElement | Who|what controlled by this rule (or group, by role) Slice: Unordered, Open by pattern:role | 1..* | BackboneElement | Who|what controlled by this rule (or group, by role) Slice: Unordered, Open by pattern:role | |||||||||||
![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | 0..1 | string | Unique id for inter-element referencing | |||||||||||
![]() ![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations | 0..* | Extension | Additional content defined by implementations | |||||||||||
![]() ![]() ![]() ![]() | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||||||
![]() ![]() ![]() ![]() | 1..1 | CodeableConcept | How the actor is involved Binding: ?? (extensible): How an actor is involved in the consent considerations. | 1..1 | CodeableConcept | How the actor is involved Binding: ?? (extensible): How an actor is involved in the consent considerations. | |||||||||||
![]() ![]() ![]() ![]() | 1..1 | Reference(Device | Group | CareTeam | Organization | Patient | Practitioner | RelatedPerson | PractitionerRole) | Resource for the actor (or group, by role) | 1..1 | Reference(Device | Group | CareTeam | Organization | Patient | Practitioner | RelatedPerson | PractitionerRole) | Resource for the actor (or group, by role) | |||||||||||
![]() ![]() ![]() | Σ | 1..1 | CodeableConcept | Actions controlled by this rule Binding: ?? (example): Detailed codes for the consent action. Required Pattern: {"coding":[{"system":"http://terminology.hl7.org/CodeSystem/consentaction","code":"disclose"}]} | SΣ | 1..1 | CodeableConcept | Action permitted or denied - use 'disclose' with provision.type='deny' for Provider Access opt-out Binding: ?? (required) |
| ||||||||
![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing |
| |||||||||||||
![]() ![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url |
| |||||||||||||
![]() ![]() ![]() ![]() | Σ | 0..* | Coding | Code defined by a terminology system |
| ||||||||||||
![]() ![]() ![]() ![]() | Σ | 0..1 | string | Plain text representation of the concept |
| ||||||||||||
![]() ![]() ![]() | Σ | 0..* | Coding | Security Labels that define affected resources Binding: ?? (extensible): Security Labels from the Healthcare Privacy and Security Classification System. | Σ | 0..* | Coding | Security Labels that define affected resources Binding: ?? (extensible): Security Labels from the Healthcare Privacy and Security Classification System. | |||||||||
![]() ![]() ![]() | Σ | 0..* | Coding | Context of activities covered by this rule Binding: ?? (extensible): What purposes of use are controlled by this exception. If more than one label is specified, operations must have all the specified labels. | Σ | 0..* | Coding | Context of activities covered by this rule Binding: ?? (extensible): What purposes of use are controlled by this exception. If more than one label is specified, operations must have all the specified labels. | |||||||||
![]() ![]() ![]() | Σ | 0..* | Coding | e.g. Resource Type, Profile, CDA, etc. Binding: ?? (extensible): The class (type) of information a consent rule covers. | Σ | 0..* | Coding | e.g. Resource Type, Profile, CDA, etc. Binding: ?? (extensible): The class (type) of information a consent rule covers. | |||||||||
![]() ![]() ![]() | Σ | 0..* | CodeableConcept | e.g. LOINC or SNOMED CT code, etc. in the content Binding: ?? (example): If this code is found in an instance, then the exception applies. | Σ | 0..* | CodeableConcept | e.g. LOINC or SNOMED CT code, etc. in the content Binding: ?? (example): If this code is found in an instance, then the exception applies. | |||||||||
![]() ![]() ![]() | Σ | 0..1 | Period | Timeframe for data controlled by this rule | Σ | 0..1 | Period | Timeframe for data controlled by this rule | |||||||||
![]() ![]() ![]() | Σ | 0..* | BackboneElement | Data controlled by this rule | Σ | 0..* | BackboneElement | Data controlled by this rule | |||||||||
![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | 0..1 | string | Unique id for inter-element referencing | |||||||||||
![]() ![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations | 0..* | Extension | Additional content defined by implementations | |||||||||||
![]() ![]() ![]() ![]() | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||||||
![]() ![]() ![]() ![]() | Σ | 1..1 | code | instance | related | dependents | authoredby Binding: ?? (required): How a resource reference is interpreted when testing consent restrictions. | Σ | 1..1 | code | instance | related | dependents | authoredby Binding: ?? (required): How a resource reference is interpreted when testing consent restrictions. | |||||||||
![]() ![]() ![]() ![]() | Σ | 1..1 | Reference(Resource) | The actual data reference | Σ | 1..1 | Reference(Resource) | The actual data reference | |||||||||
![]() ![]() ![]() | 0..* | See provision (Consent) | Nested Exception Rules | 0..* | See provision (Consent) | Nested Exception Rules | |||||||||||
Documentation for this format | |||||||||||||||||