Da Vinci Health Record Exchange (HRex)
1.0.0 - STU R1 United States of America flag

Da Vinci Health Record Exchange (HRex), published by HL7 International - Clinical Interoperability Council. This is not an authorized publication; it is the continuous build for version 1.0.0). This version is based on the current content of https://github.com/HL7/davinci-ehrx/ and changes regularly. See the Directory of published versions

Resource Profile: HRex Consent Profile

Official URL: http://hl7.org/fhir/us/davinci-hrex/StructureDefinition/hrex-consent Version: 1.0.0
Standards status: Draft Maturity Level: 0 Computable Name: HRexConsent

The HRex Consent Profile defines the constraints for representing a member’s to the sharing of their healthcare information to other organizations.

Consent allows sharing the fact that a patient has authorized the sharing of data between two participants. Sharing the existence of consent is often a pre-requisite to being able to share information. This profile is leveraged by the $member-match operation, but can also be used by Da Vinci implementation guides in other ways.

Usage:

Formal Views of Profile Content

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

This structure is derived from Consent

NameFlagsCard.TypeDescription & Constraintsdoco
.. Consent 0..*ConsentA healthcare consumer's choices to permit or deny recipients or roles to perform actions for specific purposes and periods of time
... status S1..1codedraft | proposed | active | rejected | inactive | entered-in-error
Fixed Value: active
... scope S1..1CodeableConceptWhich of the four areas this resource covers (extensible)
Required Pattern: At least the following
.... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
..... system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/consentscope
..... code1..1codeSymbol in syntax defined by the system
Fixed Value: patient-privacy
... Slices for category 1..*CodeableConceptClassification of the consent statement - for indexing/retrieval
Slice: Unordered, Open by pattern:$this
.... category:disclosure S0..*CodeableConceptClassification of the consent statement - for indexing/retrieval

Required Pattern: At least the following
..... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
...... system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ActCode
...... code1..1codeSymbol in syntax defined by the system
Fixed Value: IDSCL
... performer S1..1Reference(US Core Patient Profile | RelatedPerson | US Core Practitioner Profile | US Core PractitionerRole Profile | US Core Organization Profile)Who is agreeing to the policy and rules
... source[x] S1..1Reference(DocumentReference)Source from which this consent is taken
... Slices for policy 1..*BackboneElementPolicies covered by this consent
Slice: Unordered, Open by value:uri
.... policy:hrex S1..*BackboneElementPolicies covered by this consent
..... uri S1..1uriSpecific policy covered by this consent
Binding: HRex Consent Policy ValueSet (required)
... provision S1..1BackboneElementConstraints to the base Consent.policyRule
.... type S1..1codedeny | permit
Fixed Value: permit
.... period S1..1PeriodTimeframe for this rule
..... start S1..1dateTimeStarting time with inclusive boundary
..... end S1..1dateTimeEnd time with inclusive boundary, if not ongoing
.... Slices for actor 2..*BackboneElementWho|what controlled by this rule (or group, by role)
Slice: Unordered, Open by pattern:role
..... actor:source S1..*BackboneElementAuthorized to disclose
...... role S1..1CodeableConceptHow the actor is involved
Required Pattern: At least the following
....... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
........ system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/provenance-participant-type
........ code1..1codeSymbol in syntax defined by the system
Fixed Value: performer
...... reference S1..1Reference(HRex Organization Profile)Resource for the actor (or group, by role)
..... actor:recipient S1..*BackboneElementAuthorized to receive information
...... role S1..1CodeableConceptHow the actor is involved
Required Pattern: At least the following
....... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
........ system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ParticipationType
........ code1..1codeSymbol in syntax defined by the system
Fixed Value: IRCP
...... reference S1..1Reference(HRex Organization Profile)Resource for the actor (or group, by role)
.... action 1..1CodeableConceptActions controlled by this rule
Required Pattern: At least the following
..... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
...... system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/consentaction
...... code1..1codeSymbol in syntax defined by the system
Fixed Value: disclose
.... securityLabel 0..0
.... purpose 0..0
.... class 0..0
.... code 0..0
.... dataPeriod 0..0
.... data 0..0
.... provision 0..0

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSet
Consent.policy:hrex.urirequiredHRexConsentPolicy
NameFlagsCard.TypeDescription & Constraintsdoco
.. Consent C0..*ConsentA healthcare consumer's choices to permit or deny recipients or roles to perform actions for specific purposes and periods of time
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... status ?!SΣ1..1codedraft | proposed | active | rejected | inactive | entered-in-error
Binding: ConsentState (required): Indicates the state of the consent.


Fixed Value: active
.... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
..... system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/consentscope
..... code1..1codeSymbol in syntax defined by the system
Fixed Value: patient-privacy
... Slices for category Σ1..*CodeableConceptClassification 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 SΣ0..*CodeableConceptClassification of the consent statement - for indexing/retrieval
Binding: ConsentCategoryCodes (extensible): A classification of the type of consents found in a consent statement.



Required Pattern: At least the following
..... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
...... system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ActCode
...... code1..1codeSymbol in syntax defined by the system
Fixed Value: IDSCL
... patient SΣ1..1Reference(US Core Patient Profile)Who the consent applies to
... performer SΣ1..1Reference(US Core Patient Profile | RelatedPerson | US Core Practitioner Profile | US Core PractitionerRole Profile | US Core Organization Profile)Who is agreeing to the policy and rules
... source[x] SΣ1..1Reference(DocumentReference)Source from which this consent is taken
... Slices for policy 1..*BackboneElementPolicies covered by this consent
Slice: Unordered, Open by value:uri
.... policy:All Slices Content/Rules for all slices
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... policy:hrex S1..*BackboneElementPolicies covered by this consent
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... uri SC1..1uriSpecific policy covered by this consent
Binding: HRex Consent Policy ValueSet (required)
... provision SΣ1..1BackboneElementConstraints to the base Consent.policyRule
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... type SΣ1..1codedeny | permit
Binding: ConsentProvisionType (required): How a rule statement is applied, such as adding additional consent or removing consent.


Fixed Value: permit
.... period SΣ1..1PeriodTimeframe for this rule
..... start SΣC1..1dateTimeStarting time with inclusive boundary
..... end SΣC1..1dateTimeEnd time with inclusive boundary, if not ongoing
.... Slices for actor 2..*BackboneElementWho|what controlled by this rule (or group, by role)
Slice: Unordered, Open by pattern:role
..... actor:All Slices Content/Rules for all slices
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... role 1..1CodeableConceptHow the actor is involved
Binding: SecurityRoleType (extensible): How an actor is involved in the consent considerations.

...... reference 1..1Reference(Device | Group | CareTeam | Organization | Patient | Practitioner | RelatedPerson | PractitionerRole)Resource for the actor (or group, by role)
..... actor:source S1..*BackboneElementAuthorized to disclose
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... role S1..1CodeableConceptHow the actor is involved
Binding: SecurityRoleType (extensible): How an actor is involved in the consent considerations.


Required Pattern: At least the following
....... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
........ system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/provenance-participant-type
........ code1..1codeSymbol in syntax defined by the system
Fixed Value: performer
...... reference S1..1Reference(HRex Organization Profile)Resource for the actor (or group, by role)
..... actor:recipient S1..*BackboneElementAuthorized to receive information
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... role S1..1CodeableConceptHow the actor is involved
Binding: SecurityRoleType (extensible): How an actor is involved in the consent considerations.


Required Pattern: At least the following
....... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
........ system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ParticipationType
........ code1..1codeSymbol in syntax defined by the system
Fixed Value: IRCP
...... reference S1..1Reference(HRex Organization Profile)Resource for the actor (or group, by role)
.... action Σ1..1CodeableConceptActions controlled by this rule
Binding: ConsentActionCodes (example): Detailed codes for the consent action.



Required Pattern: At least the following
..... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
...... system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/consentaction
...... code1..1codeSymbol in syntax defined by the system
Fixed Value: disclose

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
Consent.statusrequiredFixed Value: active
Consent.scopeextensiblePattern: patient-privacy
Consent.categoryextensibleConsentCategoryCodes
Consent.category:disclosureextensiblePattern: IDSCL
Consent.policy:hrex.urirequiredHRexConsentPolicy
Consent.provision.typerequiredFixed Value: permit
Consent.provision.actor.roleextensibleSecurityRoleType
Consent.provision.actor:source.roleextensiblePattern: performer
Consent.provision.actor:recipient.roleextensiblePattern: IRCP
Consent.provision.actionexamplePattern: disclose
Consent.provision.data.meaningrequiredConsentDataMeaning
NameFlagsCard.TypeDescription & Constraintsdoco
.. Consent C0..*ConsentA healthcare consumer's choices to permit or deny recipients or roles to perform actions for specific purposes and periods of time
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..*IdentifierIdentifier for this record (external references)

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


Fixed Value: active
... scope ?!SΣ1..1CodeableConceptWhich of the four areas this resource covers (extensible)
Binding: ConsentScopeCodes (extensible): The four anticipated uses for the Consent Resource.


Required Pattern: At least the following
.... id0..1stringUnique id for inter-element referencing
.... extension0..*ExtensionAdditional content defined by implementations
.... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
..... id0..1stringUnique id for inter-element referencing
..... extension0..*ExtensionAdditional content defined by implementations
..... system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/consentscope
..... version0..1stringVersion of the system - if relevant
..... code1..1codeSymbol in syntax defined by the system
Fixed Value: patient-privacy
..... display0..1stringRepresentation defined by the system
..... userSelected0..1booleanIf this coding was chosen directly by the user
.... text0..1stringPlain text representation of the concept
... Slices for category Σ1..*CodeableConceptClassification 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 SΣ0..*CodeableConceptClassification of the consent statement - for indexing/retrieval
Binding: ConsentCategoryCodes (extensible): A classification of the type of consents found in a consent statement.



Required Pattern: At least the following
..... id0..1stringUnique id for inter-element referencing
..... extension0..*ExtensionAdditional content defined by implementations
..... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
...... id0..1stringUnique id for inter-element referencing
...... extension0..*ExtensionAdditional content defined by implementations
...... system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ActCode
...... version0..1stringVersion of the system - if relevant
...... code1..1codeSymbol in syntax defined by the system
Fixed Value: IDSCL
...... display0..1stringRepresentation defined by the system
...... userSelected0..1booleanIf this coding was chosen directly by the user
..... text0..1stringPlain text representation of the concept
... patient SΣ1..1Reference(US Core Patient Profile)Who the consent applies to
... dateTime Σ0..1dateTimeWhen this Consent was created or indexed
... performer SΣ1..1Reference(US Core Patient Profile | RelatedPerson | US Core Practitioner Profile | US Core PractitionerRole Profile | US Core Organization Profile)Who is agreeing to the policy and rules
... organization Σ0..*Reference(Organization)Custodian of the consent
... source[x] SΣ1..1Reference(DocumentReference)Source from which this consent is taken
... Slices for policy 1..*BackboneElementPolicies covered by this consent
Slice: Unordered, Open by value:uri
.... policy:All Slices Content/Rules for all slices
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... authority C0..1uriEnforcement source for policy
..... uri C0..1uriSpecific policy covered by this consent
.... policy:hrex S1..*BackboneElementPolicies covered by this consent
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... authority C0..1uriEnforcement source for policy
..... uri SC1..1uriSpecific policy covered by this consent
Binding: HRex Consent Policy ValueSet (required)
... policyRule ΣC0..1CodeableConceptRegulation that this consents to
Binding: ConsentPolicyRuleCodes (extensible): Regulatory policy examples.

... verification Σ0..*BackboneElementConsent Verified by patient or family
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... verified Σ1..1booleanHas been verified
.... verifiedWith 0..1Reference(Patient | RelatedPerson)Person who verified
.... verificationDate 0..1dateTimeWhen consent verified
... provision SΣ1..1BackboneElementConstraints to the base Consent.policyRule
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... type SΣ1..1codedeny | permit
Binding: ConsentProvisionType (required): How a rule statement is applied, such as adding additional consent or removing consent.


Fixed Value: permit
.... period SΣ1..1PeriodTimeframe for this rule
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... start SΣC1..1dateTimeStarting time with inclusive boundary
..... end SΣC1..1dateTimeEnd time with inclusive boundary, if not ongoing
.... Slices for actor 2..*BackboneElementWho|what controlled by this rule (or group, by role)
Slice: Unordered, Open by pattern:role
..... actor:All Slices Content/Rules for all slices
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... role 1..1CodeableConceptHow the actor is involved
Binding: SecurityRoleType (extensible): How an actor is involved in the consent considerations.

...... reference 1..1Reference(Device | Group | CareTeam | Organization | Patient | Practitioner | RelatedPerson | PractitionerRole)Resource for the actor (or group, by role)
..... actor:source S1..*BackboneElementAuthorized to disclose
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... role S1..1CodeableConceptHow the actor is involved
Binding: SecurityRoleType (extensible): How an actor is involved in the consent considerations.


Required Pattern: At least the following
....... id0..1stringUnique id for inter-element referencing
....... extension0..*ExtensionAdditional content defined by implementations
....... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
........ id0..1stringUnique id for inter-element referencing
........ extension0..*ExtensionAdditional content defined by implementations
........ system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/provenance-participant-type
........ version0..1stringVersion of the system - if relevant
........ code1..1codeSymbol in syntax defined by the system
Fixed Value: performer
........ display0..1stringRepresentation defined by the system
........ userSelected0..1booleanIf this coding was chosen directly by the user
....... text0..1stringPlain text representation of the concept
...... reference S1..1Reference(HRex Organization Profile)Resource for the actor (or group, by role)
..... actor:recipient S1..*BackboneElementAuthorized to receive information
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... role S1..1CodeableConceptHow the actor is involved
Binding: SecurityRoleType (extensible): How an actor is involved in the consent considerations.


Required Pattern: At least the following
....... id0..1stringUnique id for inter-element referencing
....... extension0..*ExtensionAdditional content defined by implementations
....... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
........ id0..1stringUnique id for inter-element referencing
........ extension0..*ExtensionAdditional content defined by implementations
........ system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ParticipationType
........ version0..1stringVersion of the system - if relevant
........ code1..1codeSymbol in syntax defined by the system
Fixed Value: IRCP
........ display0..1stringRepresentation defined by the system
........ userSelected0..1booleanIf this coding was chosen directly by the user
....... text0..1stringPlain text representation of the concept
...... reference S1..1Reference(HRex Organization Profile)Resource for the actor (or group, by role)
.... action Σ1..1CodeableConceptActions controlled by this rule
Binding: ConsentActionCodes (example): Detailed codes for the consent action.



Required Pattern: At least the following
..... id0..1stringUnique id for inter-element referencing
..... extension0..*ExtensionAdditional content defined by implementations
..... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
...... id0..1stringUnique id for inter-element referencing
...... extension0..*ExtensionAdditional content defined by implementations
...... system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/consentaction
...... version0..1stringVersion of the system - if relevant
...... code1..1codeSymbol in syntax defined by the system
Fixed Value: disclose
...... display0..1stringRepresentation defined by the system
...... userSelected0..1booleanIf this coding was chosen directly by the user
..... text0..1stringPlain text representation of the concept

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
Consent.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
Consent.statusrequiredFixed Value: active
Consent.scopeextensiblePattern: patient-privacy
Consent.categoryextensibleConsentCategoryCodes
Consent.category:disclosureextensiblePattern: IDSCL
Consent.policy:hrex.urirequiredHRexConsentPolicy
Consent.policyRuleextensibleConsentPolicyRuleCodes
Consent.provision.typerequiredFixed Value: permit
Consent.provision.actor.roleextensibleSecurityRoleType
Consent.provision.actor:source.roleextensiblePattern: performer
Consent.provision.actor:recipient.roleextensiblePattern: IRCP
Consent.provision.actionexamplePattern: disclose
Consent.provision.data.meaningrequiredConsentDataMeaning

This structure is derived from Consent

Summary

Mandatory: 14 elements
Must-Support: 19 elements
Fixed Value: 2 elements
Prohibited: 7 elements

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

  • The element Consent.category is sliced based on the value of pattern:$this
  • The element Consent.policy is sliced based on the value of value:uri
  • The element Consent.provision.actor is sliced based on the value of pattern:role

Maturity: 0

Differential View

This structure is derived from Consent

NameFlagsCard.TypeDescription & Constraintsdoco
.. Consent 0..*ConsentA healthcare consumer's choices to permit or deny recipients or roles to perform actions for specific purposes and periods of time
... status S1..1codedraft | proposed | active | rejected | inactive | entered-in-error
Fixed Value: active
... scope S1..1CodeableConceptWhich of the four areas this resource covers (extensible)
Required Pattern: At least the following
.... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
..... system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/consentscope
..... code1..1codeSymbol in syntax defined by the system
Fixed Value: patient-privacy
... Slices for category 1..*CodeableConceptClassification of the consent statement - for indexing/retrieval
Slice: Unordered, Open by pattern:$this
.... category:disclosure S0..*CodeableConceptClassification of the consent statement - for indexing/retrieval

Required Pattern: At least the following
..... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
...... system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ActCode
...... code1..1codeSymbol in syntax defined by the system
Fixed Value: IDSCL
... performer S1..1Reference(US Core Patient Profile | RelatedPerson | US Core Practitioner Profile | US Core PractitionerRole Profile | US Core Organization Profile)Who is agreeing to the policy and rules
... source[x] S1..1Reference(DocumentReference)Source from which this consent is taken
... Slices for policy 1..*BackboneElementPolicies covered by this consent
Slice: Unordered, Open by value:uri
.... policy:hrex S1..*BackboneElementPolicies covered by this consent
..... uri S1..1uriSpecific policy covered by this consent
Binding: HRex Consent Policy ValueSet (required)
... provision S1..1BackboneElementConstraints to the base Consent.policyRule
.... type S1..1codedeny | permit
Fixed Value: permit
.... period S1..1PeriodTimeframe for this rule
..... start S1..1dateTimeStarting time with inclusive boundary
..... end S1..1dateTimeEnd time with inclusive boundary, if not ongoing
.... Slices for actor 2..*BackboneElementWho|what controlled by this rule (or group, by role)
Slice: Unordered, Open by pattern:role
..... actor:source S1..*BackboneElementAuthorized to disclose
...... role S1..1CodeableConceptHow the actor is involved
Required Pattern: At least the following
....... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
........ system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/provenance-participant-type
........ code1..1codeSymbol in syntax defined by the system
Fixed Value: performer
...... reference S1..1Reference(HRex Organization Profile)Resource for the actor (or group, by role)
..... actor:recipient S1..*BackboneElementAuthorized to receive information
...... role S1..1CodeableConceptHow the actor is involved
Required Pattern: At least the following
....... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
........ system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ParticipationType
........ code1..1codeSymbol in syntax defined by the system
Fixed Value: IRCP
...... reference S1..1Reference(HRex Organization Profile)Resource for the actor (or group, by role)
.... action 1..1CodeableConceptActions controlled by this rule
Required Pattern: At least the following
..... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
...... system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/consentaction
...... code1..1codeSymbol in syntax defined by the system
Fixed Value: disclose
.... securityLabel 0..0
.... purpose 0..0
.... class 0..0
.... code 0..0
.... dataPeriod 0..0
.... data 0..0
.... provision 0..0

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSet
Consent.policy:hrex.urirequiredHRexConsentPolicy

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Consent C0..*ConsentA healthcare consumer's choices to permit or deny recipients or roles to perform actions for specific purposes and periods of time
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... status ?!SΣ1..1codedraft | proposed | active | rejected | inactive | entered-in-error
Binding: ConsentState (required): Indicates the state of the consent.


Fixed Value: active
.... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
..... system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/consentscope
..... code1..1codeSymbol in syntax defined by the system
Fixed Value: patient-privacy
... Slices for category Σ1..*CodeableConceptClassification 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 SΣ0..*CodeableConceptClassification of the consent statement - for indexing/retrieval
Binding: ConsentCategoryCodes (extensible): A classification of the type of consents found in a consent statement.



Required Pattern: At least the following
..... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
...... system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ActCode
...... code1..1codeSymbol in syntax defined by the system
Fixed Value: IDSCL
... patient SΣ1..1Reference(US Core Patient Profile)Who the consent applies to
... performer SΣ1..1Reference(US Core Patient Profile | RelatedPerson | US Core Practitioner Profile | US Core PractitionerRole Profile | US Core Organization Profile)Who is agreeing to the policy and rules
... source[x] SΣ1..1Reference(DocumentReference)Source from which this consent is taken
... Slices for policy 1..*BackboneElementPolicies covered by this consent
Slice: Unordered, Open by value:uri
.... policy:All Slices Content/Rules for all slices
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... policy:hrex S1..*BackboneElementPolicies covered by this consent
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... uri SC1..1uriSpecific policy covered by this consent
Binding: HRex Consent Policy ValueSet (required)
... provision SΣ1..1BackboneElementConstraints to the base Consent.policyRule
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... type SΣ1..1codedeny | permit
Binding: ConsentProvisionType (required): How a rule statement is applied, such as adding additional consent or removing consent.


Fixed Value: permit
.... period SΣ1..1PeriodTimeframe for this rule
..... start SΣC1..1dateTimeStarting time with inclusive boundary
..... end SΣC1..1dateTimeEnd time with inclusive boundary, if not ongoing
.... Slices for actor 2..*BackboneElementWho|what controlled by this rule (or group, by role)
Slice: Unordered, Open by pattern:role
..... actor:All Slices Content/Rules for all slices
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... role 1..1CodeableConceptHow the actor is involved
Binding: SecurityRoleType (extensible): How an actor is involved in the consent considerations.

...... reference 1..1Reference(Device | Group | CareTeam | Organization | Patient | Practitioner | RelatedPerson | PractitionerRole)Resource for the actor (or group, by role)
..... actor:source S1..*BackboneElementAuthorized to disclose
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... role S1..1CodeableConceptHow the actor is involved
Binding: SecurityRoleType (extensible): How an actor is involved in the consent considerations.


Required Pattern: At least the following
....... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
........ system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/provenance-participant-type
........ code1..1codeSymbol in syntax defined by the system
Fixed Value: performer
...... reference S1..1Reference(HRex Organization Profile)Resource for the actor (or group, by role)
..... actor:recipient S1..*BackboneElementAuthorized to receive information
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... role S1..1CodeableConceptHow the actor is involved
Binding: SecurityRoleType (extensible): How an actor is involved in the consent considerations.


Required Pattern: At least the following
....... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
........ system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ParticipationType
........ code1..1codeSymbol in syntax defined by the system
Fixed Value: IRCP
...... reference S1..1Reference(HRex Organization Profile)Resource for the actor (or group, by role)
.... action Σ1..1CodeableConceptActions controlled by this rule
Binding: ConsentActionCodes (example): Detailed codes for the consent action.



Required Pattern: At least the following
..... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
...... system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/consentaction
...... code1..1codeSymbol in syntax defined by the system
Fixed Value: disclose

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
Consent.statusrequiredFixed Value: active
Consent.scopeextensiblePattern: patient-privacy
Consent.categoryextensibleConsentCategoryCodes
Consent.category:disclosureextensiblePattern: IDSCL
Consent.policy:hrex.urirequiredHRexConsentPolicy
Consent.provision.typerequiredFixed Value: permit
Consent.provision.actor.roleextensibleSecurityRoleType
Consent.provision.actor:source.roleextensiblePattern: performer
Consent.provision.actor:recipient.roleextensiblePattern: IRCP
Consent.provision.actionexamplePattern: disclose
Consent.provision.data.meaningrequiredConsentDataMeaning

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Consent C0..*ConsentA healthcare consumer's choices to permit or deny recipients or roles to perform actions for specific purposes and periods of time
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..*IdentifierIdentifier for this record (external references)

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


Fixed Value: active
... scope ?!SΣ1..1CodeableConceptWhich of the four areas this resource covers (extensible)
Binding: ConsentScopeCodes (extensible): The four anticipated uses for the Consent Resource.


Required Pattern: At least the following
.... id0..1stringUnique id for inter-element referencing
.... extension0..*ExtensionAdditional content defined by implementations
.... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
..... id0..1stringUnique id for inter-element referencing
..... extension0..*ExtensionAdditional content defined by implementations
..... system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/consentscope
..... version0..1stringVersion of the system - if relevant
..... code1..1codeSymbol in syntax defined by the system
Fixed Value: patient-privacy
..... display0..1stringRepresentation defined by the system
..... userSelected0..1booleanIf this coding was chosen directly by the user
.... text0..1stringPlain text representation of the concept
... Slices for category Σ1..*CodeableConceptClassification 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 SΣ0..*CodeableConceptClassification of the consent statement - for indexing/retrieval
Binding: ConsentCategoryCodes (extensible): A classification of the type of consents found in a consent statement.



Required Pattern: At least the following
..... id0..1stringUnique id for inter-element referencing
..... extension0..*ExtensionAdditional content defined by implementations
..... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
...... id0..1stringUnique id for inter-element referencing
...... extension0..*ExtensionAdditional content defined by implementations
...... system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ActCode
...... version0..1stringVersion of the system - if relevant
...... code1..1codeSymbol in syntax defined by the system
Fixed Value: IDSCL
...... display0..1stringRepresentation defined by the system
...... userSelected0..1booleanIf this coding was chosen directly by the user
..... text0..1stringPlain text representation of the concept
... patient SΣ1..1Reference(US Core Patient Profile)Who the consent applies to
... dateTime Σ0..1dateTimeWhen this Consent was created or indexed
... performer SΣ1..1Reference(US Core Patient Profile | RelatedPerson | US Core Practitioner Profile | US Core PractitionerRole Profile | US Core Organization Profile)Who is agreeing to the policy and rules
... organization Σ0..*Reference(Organization)Custodian of the consent
... source[x] SΣ1..1Reference(DocumentReference)Source from which this consent is taken
... Slices for policy 1..*BackboneElementPolicies covered by this consent
Slice: Unordered, Open by value:uri
.... policy:All Slices Content/Rules for all slices
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... authority C0..1uriEnforcement source for policy
..... uri C0..1uriSpecific policy covered by this consent
.... policy:hrex S1..*BackboneElementPolicies covered by this consent
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... authority C0..1uriEnforcement source for policy
..... uri SC1..1uriSpecific policy covered by this consent
Binding: HRex Consent Policy ValueSet (required)
... policyRule ΣC0..1CodeableConceptRegulation that this consents to
Binding: ConsentPolicyRuleCodes (extensible): Regulatory policy examples.

... verification Σ0..*BackboneElementConsent Verified by patient or family
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... verified Σ1..1booleanHas been verified
.... verifiedWith 0..1Reference(Patient | RelatedPerson)Person who verified
.... verificationDate 0..1dateTimeWhen consent verified
... provision SΣ1..1BackboneElementConstraints to the base Consent.policyRule
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... type SΣ1..1codedeny | permit
Binding: ConsentProvisionType (required): How a rule statement is applied, such as adding additional consent or removing consent.


Fixed Value: permit
.... period SΣ1..1PeriodTimeframe for this rule
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... start SΣC1..1dateTimeStarting time with inclusive boundary
..... end SΣC1..1dateTimeEnd time with inclusive boundary, if not ongoing
.... Slices for actor 2..*BackboneElementWho|what controlled by this rule (or group, by role)
Slice: Unordered, Open by pattern:role
..... actor:All Slices Content/Rules for all slices
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... role 1..1CodeableConceptHow the actor is involved
Binding: SecurityRoleType (extensible): How an actor is involved in the consent considerations.

...... reference 1..1Reference(Device | Group | CareTeam | Organization | Patient | Practitioner | RelatedPerson | PractitionerRole)Resource for the actor (or group, by role)
..... actor:source S1..*BackboneElementAuthorized to disclose
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... role S1..1CodeableConceptHow the actor is involved
Binding: SecurityRoleType (extensible): How an actor is involved in the consent considerations.


Required Pattern: At least the following
....... id0..1stringUnique id for inter-element referencing
....... extension0..*ExtensionAdditional content defined by implementations
....... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
........ id0..1stringUnique id for inter-element referencing
........ extension0..*ExtensionAdditional content defined by implementations
........ system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/provenance-participant-type
........ version0..1stringVersion of the system - if relevant
........ code1..1codeSymbol in syntax defined by the system
Fixed Value: performer
........ display0..1stringRepresentation defined by the system
........ userSelected0..1booleanIf this coding was chosen directly by the user
....... text0..1stringPlain text representation of the concept
...... reference S1..1Reference(HRex Organization Profile)Resource for the actor (or group, by role)
..... actor:recipient S1..*BackboneElementAuthorized to receive information
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... role S1..1CodeableConceptHow the actor is involved
Binding: SecurityRoleType (extensible): How an actor is involved in the consent considerations.


Required Pattern: At least the following
....... id0..1stringUnique id for inter-element referencing
....... extension0..*ExtensionAdditional content defined by implementations
....... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
........ id0..1stringUnique id for inter-element referencing
........ extension0..*ExtensionAdditional content defined by implementations
........ system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ParticipationType
........ version0..1stringVersion of the system - if relevant
........ code1..1codeSymbol in syntax defined by the system
Fixed Value: IRCP
........ display0..1stringRepresentation defined by the system
........ userSelected0..1booleanIf this coding was chosen directly by the user
....... text0..1stringPlain text representation of the concept
...... reference S1..1Reference(HRex Organization Profile)Resource for the actor (or group, by role)
.... action Σ1..1CodeableConceptActions controlled by this rule
Binding: ConsentActionCodes (example): Detailed codes for the consent action.



Required Pattern: At least the following
..... id0..1stringUnique id for inter-element referencing
..... extension0..*ExtensionAdditional content defined by implementations
..... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
...... id0..1stringUnique id for inter-element referencing
...... extension0..*ExtensionAdditional content defined by implementations
...... system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/consentaction
...... version0..1stringVersion of the system - if relevant
...... code1..1codeSymbol in syntax defined by the system
Fixed Value: disclose
...... display0..1stringRepresentation defined by the system
...... userSelected0..1booleanIf this coding was chosen directly by the user
..... text0..1stringPlain text representation of the concept

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
Consent.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
Consent.statusrequiredFixed Value: active
Consent.scopeextensiblePattern: patient-privacy
Consent.categoryextensibleConsentCategoryCodes
Consent.category:disclosureextensiblePattern: IDSCL
Consent.policy:hrex.urirequiredHRexConsentPolicy
Consent.policyRuleextensibleConsentPolicyRuleCodes
Consent.provision.typerequiredFixed Value: permit
Consent.provision.actor.roleextensibleSecurityRoleType
Consent.provision.actor:source.roleextensiblePattern: performer
Consent.provision.actor:recipient.roleextensiblePattern: IRCP
Consent.provision.actionexamplePattern: disclose
Consent.provision.data.meaningrequiredConsentDataMeaning

This structure is derived from Consent

Summary

Mandatory: 14 elements
Must-Support: 19 elements
Fixed Value: 2 elements
Prohibited: 7 elements

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

  • The element Consent.category is sliced based on the value of pattern:$this
  • The element Consent.policy is sliced based on the value of value:uri
  • The element Consent.provision.actor is sliced based on the value of pattern:role

Maturity: 0

 

Other representations of profile: CSV, Excel, Schematron

Notes:

HRex recognizes two consent policies:

  • http://hl7.org/fhir/us/davinci-hrex/StructureDefinition-hrex-consent.html#regular - Access is granted to all patient information that is not considered to be ‘sensitive’ according to U.S. state or federal regulation.
  • http://hl7.org/fhir/us/davinci-hrex/StructureDefinition-hrex-consent.html#sensitive - Access is granted to all patient information, including that considered to be ‘sensitive’ according to U.S. state or federal regulation.

Systems are not required to support both types of consent, but if using consent, are expected to recognize and use at least one of the two.

Consent.patient and Consent.performer are captured separately to track who actually provides the consent. Typically both will be the same, but in some cases, consent might be issued by a relative, an institution or even a provider.

Both the ‘performer’ and ‘recipient’ actors for disclosure repeat. The performer SHALL include the target payer for the $member-match and the recipient SHALL include the initiator of the $member-match. However, additional performers and recipients might be listed, including a ‘mutual’ consent where initiator and target payer are both listed as performers and recipients, thus authorizing each to share information with the other.