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.1.0 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
Official URL: http://hl7.org/fhir/us/davinci-pdex/StructureDefinition/pdex-consent | Version: 2.1.0 | |||
Standards status: Trial-use | Maturity Level: 0 | Computable Name: PDexConsent |
The PDex Consent Profile defines the constraints for representing a member’s consent to the sharing of their healthcare information to other organizations.
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from Consent
Name | Flags | Card. | Type | Description & Constraints![]() |
---|---|---|---|---|
![]() ![]() |
0..* | Consent | A healthcare consumer's choices to permit or deny recipients or roles to perform actions for specific purposes and periods of time | |
![]() ![]() ![]() |
S | 1..1 | code | draft | proposed | active | rejected | inactive | entered-in-error Fixed Value: active |
![]() ![]() ![]() |
S | 1..1 | CodeableConcept | Which of the four areas this resource covers (extensible) Required Pattern: At least the following |
![]() ![]() ![]() ![]() |
1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/consentscope | |
![]() ![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system Fixed Value: patient-privacy | |
![]() ![]() ![]() |
1..* | CodeableConcept | Classification of the consent statement - for indexing/retrieval Slice: Unordered, Open by pattern:$this | |
![]() ![]() ![]() ![]() |
S | 0..* | CodeableConcept | Classification of the consent statement - for indexing/retrieval Required Pattern: At least the following |
![]() ![]() ![]() ![]() ![]() |
1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ActCode | |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system Fixed Value: IDSCL | |
![]() ![]() ![]() |
S | 1..1 | Reference(US Core Patient Profile(6.1.0)) | Who the consent applies to |
![]() ![]() ![]() |
S | 1..1 | Reference(US Core Patient Profile(6.1.0) | RelatedPerson | US Core Practitioner Profile(6.1.0) | US Core PractitionerRole Profile(6.1.0) | US Core Organization Profile(6.1.0)) | Who is agreeing to the policy and rules |
![]() ![]() ![]() |
S | 1..1 | Reference(DocumentReference) | Source from which this consent is taken |
![]() ![]() ![]() |
1..* | BackboneElement | Policies covered by this consent Slice: Unordered, Open by value:uri | |
![]() ![]() ![]() ![]() |
S | 1..* | BackboneElement | Policies covered by this consent |
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | uri | Specific policy covered by this consent Binding: HRex Consent Policy ValueSet (required) |
![]() ![]() ![]() |
S | 1..1 | BackboneElement | Constraints to the base Consent.policyRule |
![]() ![]() ![]() ![]() |
S | 1..1 | code | deny | permit Fixed Value: permit |
![]() ![]() ![]() ![]() |
S | 1..1 | Period | Timeframe for this rule |
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | dateTime | Starting time with inclusive boundary |
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | dateTime | End time with inclusive boundary, if not ongoing |
![]() ![]() ![]() ![]() |
2..* | BackboneElement | Who|what controlled by this rule (or group, by role) Slice: Unordered, Open by pattern:role | |
![]() ![]() ![]() ![]() ![]() |
S | 1..* | BackboneElement | Authorized to disclose |
![]() ![]() ![]() ![]() ![]() ![]() |
S | 1..1 | CodeableConcept | How the actor is involved Required Pattern: At least the following |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/provenance-participant-type | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system Fixed Value: performer | |
![]() ![]() ![]() ![]() ![]() ![]() |
S | 1..1 | Reference(HRex Organization Profile(1.1.0-preview)) | Resource for the actor (or group, by role) |
![]() ![]() ![]() ![]() ![]() |
S | 1..* | BackboneElement | Authorized to receive information |
![]() ![]() ![]() ![]() ![]() ![]() |
S | 1..1 | CodeableConcept | How the actor is involved Required Pattern: At least the following |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ParticipationType | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system Fixed Value: IRCP | |
![]() ![]() ![]() ![]() ![]() ![]() |
S | 1..1 | Reference(HRex Organization Profile(1.1.0-preview)) | Resource for the actor (or group, by role) |
![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | Actions controlled by this rule Required Pattern: At least the following | |
![]() ![]() ![]() ![]() ![]() |
1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/consentaction | |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system Fixed Value: disclose | |
![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() |
0..0 | |||
![]() |
Path | Conformance | ValueSet | URI |
Consent.policy:pdex.uri | required | HRexConsentPolicyhttp://hl7.org/fhir/us/davinci-hrex/ValueSet/hrex-consent-policy |
Name | Flags | Card. | Type | Description & Constraints![]() |
---|---|---|---|---|
![]() ![]() |
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 ppc-1: Either a Policy or PolicyRule ppc-2: IF Scope=privacy, there must be a patient ppc-3: IF Scope=research, there must be a patient ppc-4: IF Scope=adr, there must be a patient ppc-5: IF Scope=treatment, there must be a patient |
![]() ![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
![]() ![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored |
![]() ![]() ![]() |
?!SΣ | 1..1 | code | draft | proposed | active | rejected | inactive | entered-in-error Binding: ConsentState (required): Indicates the state of the consent. Fixed Value: active |
![]() ![]() ![]() |
?!SΣ | 1..1 | CodeableConcept | Which of the four areas this resource covers (extensible) Binding: ConsentScopeCodes (extensible): The four anticipated uses for the Consent Resource. Required Pattern: At least the following |
![]() ![]() ![]() ![]() |
1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/consentscope | |
![]() ![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system Fixed Value: patient-privacy | |
![]() ![]() ![]() |
Σ | 1..* | 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. |
![]() ![]() ![]() ![]() |
SΣ | 0..* | 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: At least the following |
![]() ![]() ![]() ![]() ![]() |
1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ActCode | |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system Fixed Value: IDSCL | |
![]() ![]() ![]() |
SΣ | 1..1 | Reference(US Core Patient Profile(6.1.0)) | Who the consent applies to |
![]() ![]() ![]() |
SΣ | 1..1 | Reference(US Core Patient Profile(6.1.0) | RelatedPerson | US Core Practitioner Profile(6.1.0) | US Core PractitionerRole Profile(6.1.0) | US Core Organization Profile(6.1.0)) | Who is agreeing to the policy and rules |
![]() ![]() ![]() |
SΣ | 1..1 | Reference(DocumentReference) | Source from which this consent is taken |
![]() ![]() ![]() |
1..* | BackboneElement | Policies covered by this consent Slice: Unordered, Open by value:uri | |
![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() |
S | 1..* | BackboneElement | Policies covered by this consent |
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() ![]() |
SC | 1..1 | uri | Specific policy covered by this consent Binding: HRex Consent Policy ValueSet (required) |
![]() ![]() ![]() |
SΣ | 1..1 | BackboneElement | Constraints to the base Consent.policyRule |
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() |
SΣ | 1..1 | code | deny | permit Binding: ConsentProvisionType (required): How a rule statement is applied, such as adding additional consent or removing consent. Fixed Value: permit |
![]() ![]() ![]() ![]() |
SΣ | 1..1 | Period | Timeframe for this rule |
![]() ![]() ![]() ![]() ![]() |
SΣC | 1..1 | dateTime | Starting time with inclusive boundary |
![]() ![]() ![]() ![]() ![]() |
SΣC | 1..1 | dateTime | End time with inclusive boundary, if not ongoing |
![]() ![]() ![]() ![]() |
2..* | BackboneElement | Who|what controlled by this rule (or group, by role) Slice: Unordered, Open by pattern:role | |
![]() ![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | How the actor is involved Binding: SecurityRoleType (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) | |
![]() ![]() ![]() ![]() ![]() |
S | 1..* | BackboneElement | Authorized to disclose |
![]() ![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() ![]() ![]() |
S | 1..1 | CodeableConcept | How the actor is involved Binding: SecurityRoleType (extensible): How an actor is involved in the consent considerations. Required Pattern: At least the following |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/provenance-participant-type | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system Fixed Value: performer | |
![]() ![]() ![]() ![]() ![]() ![]() |
S | 1..1 | Reference(HRex Organization Profile(1.1.0-preview)) | Resource for the actor (or group, by role) |
![]() ![]() ![]() ![]() ![]() |
S | 1..* | BackboneElement | Authorized to receive information |
![]() ![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() ![]() ![]() |
S | 1..1 | CodeableConcept | How the actor is involved Binding: SecurityRoleType (extensible): How an actor is involved in the consent considerations. Required Pattern: At least the following |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ParticipationType | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system Fixed Value: IRCP | |
![]() ![]() ![]() ![]() ![]() ![]() |
S | 1..1 | Reference(HRex Organization Profile(1.1.0-preview)) | Resource for the actor (or group, by role) |
![]() ![]() ![]() ![]() |
Σ | 1..1 | CodeableConcept | Actions controlled by this rule Binding: ConsentActionCodes (example): Detailed codes for the consent action. Required Pattern: At least the following |
![]() ![]() ![]() ![]() ![]() |
1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/consentaction | |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system Fixed Value: disclose | |
![]() |
Path | Conformance | ValueSet / Code | URI |
Consent.status | required | Fixed Value: activehttp://hl7.org/fhir/ValueSet/consent-state-codes|4.0.1 from the FHIR Standard | |
Consent.scope | extensible | Pattern: patient-privacyhttp://hl7.org/fhir/ValueSet/consent-scope from the FHIR Standard | |
Consent.category | extensible | ConsentCategoryCodeshttp://hl7.org/fhir/ValueSet/consent-category from the FHIR Standard | |
Consent.category:disclosure | extensible | Pattern: IDSCLhttp://hl7.org/fhir/ValueSet/consent-category from the FHIR Standard | |
Consent.policy:pdex.uri | required | HRexConsentPolicyhttp://hl7.org/fhir/us/davinci-hrex/ValueSet/hrex-consent-policy | |
Consent.provision.type | required | Fixed Value: permithttp://hl7.org/fhir/ValueSet/consent-provision-type|4.0.1 from the FHIR Standard | |
Consent.provision.actor.role | extensible | SecurityRoleTypehttp://hl7.org/fhir/ValueSet/security-role-type from the FHIR Standard | |
Consent.provision.actor:source.role | extensible | Pattern: performerhttp://hl7.org/fhir/ValueSet/security-role-type from the FHIR Standard | |
Consent.provision.actor:recipient.role | extensible | Pattern: IRCPhttp://hl7.org/fhir/ValueSet/security-role-type from the FHIR Standard | |
Consent.provision.action | example | Pattern: disclosehttp://hl7.org/fhir/ValueSet/consent-action from the FHIR Standard | |
Consent.provision.data.meaning | required | ConsentDataMeaninghttp://hl7.org/fhir/ValueSet/consent-data-meaning|4.0.1 from the FHIR Standard |
Name | Flags | Card. | Type | Description & Constraints![]() | ||||
---|---|---|---|---|---|---|---|---|
![]() ![]() |
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 ppc-1: Either a Policy or PolicyRule ppc-2: IF Scope=privacy, there must be a patient ppc-3: IF Scope=research, there must be a patient ppc-4: IF Scope=adr, there must be a patient ppc-5: IF Scope=treatment, there must be a patient | ||||
![]() ![]() ![]() |
Σ | 0..1 | id | Logical id of this artifact | ||||
![]() ![]() ![]() |
Σ | 0..1 | Meta | Metadata about the resource | ||||
![]() ![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]() ![]() |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
![]() ![]() ![]() |
0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
![]() ![]() ![]() |
0..* | Resource | Contained, inline Resources | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
?! | 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"} | ||||
![]() ![]() ![]() |
?!SΣ | 1..1 | code | draft | proposed | active | rejected | inactive | entered-in-error Binding: ConsentState (required): Indicates the state of the consent. Fixed Value: active | ||||
![]() ![]() ![]() |
?!SΣ | 1..1 | CodeableConcept | Which of the four areas this resource covers (extensible) Binding: ConsentScopeCodes (extensible): The four anticipated uses for the Consent Resource. Required Pattern: At least the following | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/consentscope | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Version of the system - if relevant | |||||
![]() ![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system Fixed Value: patient-privacy | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Representation defined by the system | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | boolean | If this coding was chosen directly by the user | |||||
![]() ![]() ![]() ![]() |
0..1 | string | Plain text representation of the concept | |||||
![]() ![]() ![]() |
Σ | 1..* | 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. | ||||
![]() ![]() ![]() ![]() |
SΣ | 0..* | 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: At least the following | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() |
1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ActCode | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Version of the system - if relevant | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system Fixed Value: IDSCL | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Representation defined by the system | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | boolean | If this coding was chosen directly by the user | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Plain text representation of the concept | |||||
![]() ![]() ![]() |
SΣ | 1..1 | Reference(US Core Patient Profile(6.1.0)) | Who the consent applies to | ||||
![]() ![]() ![]() |
Σ | 0..1 | dateTime | When this Consent was created or indexed | ||||
![]() ![]() ![]() |
SΣ | 1..1 | Reference(US Core Patient Profile(6.1.0) | RelatedPerson | US Core Practitioner Profile(6.1.0) | US Core PractitionerRole Profile(6.1.0) | US Core Organization Profile(6.1.0)) | Who is agreeing to the policy and rules | ||||
![]() ![]() ![]() |
Σ | 0..* | Reference(Organization) | Custodian of the consent | ||||
![]() ![]() ![]() |
SΣ | 1..1 | Reference(DocumentReference) | Source from which this consent is taken | ||||
![]() ![]() ![]() |
1..* | BackboneElement | Policies covered by this consent Slice: Unordered, Open by value:uri | |||||
![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() ![]() |
C | 0..1 | uri | Enforcement source for policy | ||||
![]() ![]() ![]() ![]() ![]() |
C | 0..1 | uri | Specific policy covered by this consent | ||||
![]() ![]() ![]() ![]() |
S | 1..* | BackboneElement | Policies covered by this consent | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() ![]() |
C | 0..1 | uri | Enforcement source for policy | ||||
![]() ![]() ![]() ![]() ![]() |
SC | 1..1 | uri | Specific policy covered by this consent Binding: HRex Consent Policy ValueSet (required) | ||||
![]() ![]() ![]() |
ΣC | 0..1 | CodeableConcept | Regulation that this consents to Binding: ConsentPolicyRuleCodes (extensible): Regulatory policy examples. | ||||
![]() ![]() ![]() |
Σ | 0..* | BackboneElement | Consent Verified by patient or family | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
Σ | 1..1 | boolean | Has been verified | ||||
![]() ![]() ![]() ![]() |
0..1 | Reference(Patient | RelatedPerson) | Person who verified | |||||
![]() ![]() ![]() ![]() |
0..1 | dateTime | When consent verified | |||||
![]() ![]() ![]() |
SΣ | 1..1 | BackboneElement | Constraints to the base Consent.policyRule | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | code | deny | permit Binding: ConsentProvisionType (required): How a rule statement is applied, such as adding additional consent or removing consent. Fixed Value: permit | ||||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | Period | Timeframe for this rule | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
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 | End time with inclusive boundary, if not ongoing | ||||
![]() ![]() ![]() ![]() |
2..* | BackboneElement | Who|what controlled by this rule (or group, by role) Slice: Unordered, Open by pattern:role | |||||
![]() ![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | How the actor is involved Binding: SecurityRoleType (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) | |||||
![]() ![]() ![]() ![]() ![]() |
S | 1..* | BackboneElement | Authorized to disclose | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
S | 1..1 | CodeableConcept | How the actor is involved Binding: SecurityRoleType (extensible): How an actor is involved in the consent considerations. Required Pattern: At least the following | ||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/provenance-participant-type | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Version of the system - if relevant | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system Fixed Value: performer | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Representation defined by the system | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | boolean | If this coding was chosen directly by the user | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Plain text representation of the concept | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
S | 1..1 | Reference(HRex Organization Profile(1.1.0-preview)) | Resource for the actor (or group, by role) | ||||
![]() ![]() ![]() ![]() ![]() |
S | 1..* | BackboneElement | Authorized to receive information | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
S | 1..1 | CodeableConcept | How the actor is involved Binding: SecurityRoleType (extensible): How an actor is involved in the consent considerations. Required Pattern: At least the following | ||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ParticipationType | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Version of the system - if relevant | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system Fixed Value: IRCP | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Representation defined by the system | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | boolean | If this coding was chosen directly by the user | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Plain text representation of the concept | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
S | 1..1 | Reference(HRex Organization Profile(1.1.0-preview)) | Resource for the actor (or group, by role) | ||||
![]() ![]() ![]() ![]() |
Σ | 1..1 | CodeableConcept | Actions controlled by this rule Binding: ConsentActionCodes (example): Detailed codes for the consent action. Required Pattern: At least the following | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() |
1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/consentaction | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Version of the system - if relevant | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system Fixed Value: disclose | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Representation defined by the system | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | boolean | If this coding was chosen directly by the user | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Plain text representation of the concept | |||||
![]() |
Path | Conformance | ValueSet / Code | URI | |||
Consent.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languages from the FHIR Standard | ||||
Consent.status | required | Fixed Value: activehttp://hl7.org/fhir/ValueSet/consent-state-codes|4.0.1 from the FHIR Standard | ||||
Consent.scope | extensible | Pattern: patient-privacyhttp://hl7.org/fhir/ValueSet/consent-scope from the FHIR Standard | ||||
Consent.category | extensible | ConsentCategoryCodeshttp://hl7.org/fhir/ValueSet/consent-category from the FHIR Standard | ||||
Consent.category:disclosure | extensible | Pattern: IDSCLhttp://hl7.org/fhir/ValueSet/consent-category from the FHIR Standard | ||||
Consent.policy:pdex.uri | required | HRexConsentPolicyhttp://hl7.org/fhir/us/davinci-hrex/ValueSet/hrex-consent-policy | ||||
Consent.policyRule | extensible | ConsentPolicyRuleCodeshttp://hl7.org/fhir/ValueSet/consent-policy from the FHIR Standard | ||||
Consent.provision.type | required | Fixed Value: permithttp://hl7.org/fhir/ValueSet/consent-provision-type|4.0.1 from the FHIR Standard | ||||
Consent.provision.actor.role | extensible | SecurityRoleTypehttp://hl7.org/fhir/ValueSet/security-role-type from the FHIR Standard | ||||
Consent.provision.actor:source.role | extensible | Pattern: performerhttp://hl7.org/fhir/ValueSet/security-role-type from the FHIR Standard | ||||
Consent.provision.actor:recipient.role | extensible | Pattern: IRCPhttp://hl7.org/fhir/ValueSet/security-role-type from the FHIR Standard | ||||
Consent.provision.action | example | Pattern: disclosehttp://hl7.org/fhir/ValueSet/consent-action from the FHIR Standard | ||||
Consent.provision.data.meaning | required | ConsentDataMeaninghttp://hl7.org/fhir/ValueSet/consent-data-meaning|4.0.1 from the FHIR Standard |
This structure is derived from Consent
Summary
Mandatory: 14 elements
Must-Support: 19 elements
Fixed: 2 elements
Prohibited: 7 elements
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
Maturity: 0
Differential View
This structure is derived from Consent
Name | Flags | Card. | Type | Description & Constraints![]() |
---|---|---|---|---|
![]() ![]() |
0..* | Consent | A healthcare consumer's choices to permit or deny recipients or roles to perform actions for specific purposes and periods of time | |
![]() ![]() ![]() |
S | 1..1 | code | draft | proposed | active | rejected | inactive | entered-in-error Fixed Value: active |
![]() ![]() ![]() |
S | 1..1 | CodeableConcept | Which of the four areas this resource covers (extensible) Required Pattern: At least the following |
![]() ![]() ![]() ![]() |
1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/consentscope | |
![]() ![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system Fixed Value: patient-privacy | |
![]() ![]() ![]() |
1..* | CodeableConcept | Classification of the consent statement - for indexing/retrieval Slice: Unordered, Open by pattern:$this | |
![]() ![]() ![]() ![]() |
S | 0..* | CodeableConcept | Classification of the consent statement - for indexing/retrieval Required Pattern: At least the following |
![]() ![]() ![]() ![]() ![]() |
1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ActCode | |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system Fixed Value: IDSCL | |
![]() ![]() ![]() |
S | 1..1 | Reference(US Core Patient Profile(6.1.0)) | Who the consent applies to |
![]() ![]() ![]() |
S | 1..1 | Reference(US Core Patient Profile(6.1.0) | RelatedPerson | US Core Practitioner Profile(6.1.0) | US Core PractitionerRole Profile(6.1.0) | US Core Organization Profile(6.1.0)) | Who is agreeing to the policy and rules |
![]() ![]() ![]() |
S | 1..1 | Reference(DocumentReference) | Source from which this consent is taken |
![]() ![]() ![]() |
1..* | BackboneElement | Policies covered by this consent Slice: Unordered, Open by value:uri | |
![]() ![]() ![]() ![]() |
S | 1..* | BackboneElement | Policies covered by this consent |
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | uri | Specific policy covered by this consent Binding: HRex Consent Policy ValueSet (required) |
![]() ![]() ![]() |
S | 1..1 | BackboneElement | Constraints to the base Consent.policyRule |
![]() ![]() ![]() ![]() |
S | 1..1 | code | deny | permit Fixed Value: permit |
![]() ![]() ![]() ![]() |
S | 1..1 | Period | Timeframe for this rule |
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | dateTime | Starting time with inclusive boundary |
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | dateTime | End time with inclusive boundary, if not ongoing |
![]() ![]() ![]() ![]() |
2..* | BackboneElement | Who|what controlled by this rule (or group, by role) Slice: Unordered, Open by pattern:role | |
![]() ![]() ![]() ![]() ![]() |
S | 1..* | BackboneElement | Authorized to disclose |
![]() ![]() ![]() ![]() ![]() ![]() |
S | 1..1 | CodeableConcept | How the actor is involved Required Pattern: At least the following |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/provenance-participant-type | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system Fixed Value: performer | |
![]() ![]() ![]() ![]() ![]() ![]() |
S | 1..1 | Reference(HRex Organization Profile(1.1.0-preview)) | Resource for the actor (or group, by role) |
![]() ![]() ![]() ![]() ![]() |
S | 1..* | BackboneElement | Authorized to receive information |
![]() ![]() ![]() ![]() ![]() ![]() |
S | 1..1 | CodeableConcept | How the actor is involved Required Pattern: At least the following |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ParticipationType | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system Fixed Value: IRCP | |
![]() ![]() ![]() ![]() ![]() ![]() |
S | 1..1 | Reference(HRex Organization Profile(1.1.0-preview)) | Resource for the actor (or group, by role) |
![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | Actions controlled by this rule Required Pattern: At least the following | |
![]() ![]() ![]() ![]() ![]() |
1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/consentaction | |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system Fixed Value: disclose | |
![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() |
0..0 | |||
![]() |
Path | Conformance | ValueSet | URI |
Consent.policy:pdex.uri | required | HRexConsentPolicyhttp://hl7.org/fhir/us/davinci-hrex/ValueSet/hrex-consent-policy |
Key Elements View
Name | Flags | Card. | Type | Description & Constraints![]() |
---|---|---|---|---|
![]() ![]() |
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 ppc-1: Either a Policy or PolicyRule ppc-2: IF Scope=privacy, there must be a patient ppc-3: IF Scope=research, there must be a patient ppc-4: IF Scope=adr, there must be a patient ppc-5: IF Scope=treatment, there must be a patient |
![]() ![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
![]() ![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored |
![]() ![]() ![]() |
?!SΣ | 1..1 | code | draft | proposed | active | rejected | inactive | entered-in-error Binding: ConsentState (required): Indicates the state of the consent. Fixed Value: active |
![]() ![]() ![]() |
?!SΣ | 1..1 | CodeableConcept | Which of the four areas this resource covers (extensible) Binding: ConsentScopeCodes (extensible): The four anticipated uses for the Consent Resource. Required Pattern: At least the following |
![]() ![]() ![]() ![]() |
1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/consentscope | |
![]() ![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system Fixed Value: patient-privacy | |
![]() ![]() ![]() |
Σ | 1..* | 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. |
![]() ![]() ![]() ![]() |
SΣ | 0..* | 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: At least the following |
![]() ![]() ![]() ![]() ![]() |
1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ActCode | |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system Fixed Value: IDSCL | |
![]() ![]() ![]() |
SΣ | 1..1 | Reference(US Core Patient Profile(6.1.0)) | Who the consent applies to |
![]() ![]() ![]() |
SΣ | 1..1 | Reference(US Core Patient Profile(6.1.0) | RelatedPerson | US Core Practitioner Profile(6.1.0) | US Core PractitionerRole Profile(6.1.0) | US Core Organization Profile(6.1.0)) | Who is agreeing to the policy and rules |
![]() ![]() ![]() |
SΣ | 1..1 | Reference(DocumentReference) | Source from which this consent is taken |
![]() ![]() ![]() |
1..* | BackboneElement | Policies covered by this consent Slice: Unordered, Open by value:uri | |
![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() |
S | 1..* | BackboneElement | Policies covered by this consent |
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() ![]() |
SC | 1..1 | uri | Specific policy covered by this consent Binding: HRex Consent Policy ValueSet (required) |
![]() ![]() ![]() |
SΣ | 1..1 | BackboneElement | Constraints to the base Consent.policyRule |
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() |
SΣ | 1..1 | code | deny | permit Binding: ConsentProvisionType (required): How a rule statement is applied, such as adding additional consent or removing consent. Fixed Value: permit |
![]() ![]() ![]() ![]() |
SΣ | 1..1 | Period | Timeframe for this rule |
![]() ![]() ![]() ![]() ![]() |
SΣC | 1..1 | dateTime | Starting time with inclusive boundary |
![]() ![]() ![]() ![]() ![]() |
SΣC | 1..1 | dateTime | End time with inclusive boundary, if not ongoing |
![]() ![]() ![]() ![]() |
2..* | BackboneElement | Who|what controlled by this rule (or group, by role) Slice: Unordered, Open by pattern:role | |
![]() ![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | How the actor is involved Binding: SecurityRoleType (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) | |
![]() ![]() ![]() ![]() ![]() |
S | 1..* | BackboneElement | Authorized to disclose |
![]() ![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() ![]() ![]() |
S | 1..1 | CodeableConcept | How the actor is involved Binding: SecurityRoleType (extensible): How an actor is involved in the consent considerations. Required Pattern: At least the following |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/provenance-participant-type | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system Fixed Value: performer | |
![]() ![]() ![]() ![]() ![]() ![]() |
S | 1..1 | Reference(HRex Organization Profile(1.1.0-preview)) | Resource for the actor (or group, by role) |
![]() ![]() ![]() ![]() ![]() |
S | 1..* | BackboneElement | Authorized to receive information |
![]() ![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() ![]() ![]() |
S | 1..1 | CodeableConcept | How the actor is involved Binding: SecurityRoleType (extensible): How an actor is involved in the consent considerations. Required Pattern: At least the following |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ParticipationType | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system Fixed Value: IRCP | |
![]() ![]() ![]() ![]() ![]() ![]() |
S | 1..1 | Reference(HRex Organization Profile(1.1.0-preview)) | Resource for the actor (or group, by role) |
![]() ![]() ![]() ![]() |
Σ | 1..1 | CodeableConcept | Actions controlled by this rule Binding: ConsentActionCodes (example): Detailed codes for the consent action. Required Pattern: At least the following |
![]() ![]() ![]() ![]() ![]() |
1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/consentaction | |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system Fixed Value: disclose | |
![]() |
Path | Conformance | ValueSet / Code | URI |
Consent.status | required | Fixed Value: activehttp://hl7.org/fhir/ValueSet/consent-state-codes|4.0.1 from the FHIR Standard | |
Consent.scope | extensible | Pattern: patient-privacyhttp://hl7.org/fhir/ValueSet/consent-scope from the FHIR Standard | |
Consent.category | extensible | ConsentCategoryCodeshttp://hl7.org/fhir/ValueSet/consent-category from the FHIR Standard | |
Consent.category:disclosure | extensible | Pattern: IDSCLhttp://hl7.org/fhir/ValueSet/consent-category from the FHIR Standard | |
Consent.policy:pdex.uri | required | HRexConsentPolicyhttp://hl7.org/fhir/us/davinci-hrex/ValueSet/hrex-consent-policy | |
Consent.provision.type | required | Fixed Value: permithttp://hl7.org/fhir/ValueSet/consent-provision-type|4.0.1 from the FHIR Standard | |
Consent.provision.actor.role | extensible | SecurityRoleTypehttp://hl7.org/fhir/ValueSet/security-role-type from the FHIR Standard | |
Consent.provision.actor:source.role | extensible | Pattern: performerhttp://hl7.org/fhir/ValueSet/security-role-type from the FHIR Standard | |
Consent.provision.actor:recipient.role | extensible | Pattern: IRCPhttp://hl7.org/fhir/ValueSet/security-role-type from the FHIR Standard | |
Consent.provision.action | example | Pattern: disclosehttp://hl7.org/fhir/ValueSet/consent-action from the FHIR Standard | |
Consent.provision.data.meaning | required | ConsentDataMeaninghttp://hl7.org/fhir/ValueSet/consent-data-meaning|4.0.1 from the FHIR Standard |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints![]() | ||||
---|---|---|---|---|---|---|---|---|
![]() ![]() |
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 ppc-1: Either a Policy or PolicyRule ppc-2: IF Scope=privacy, there must be a patient ppc-3: IF Scope=research, there must be a patient ppc-4: IF Scope=adr, there must be a patient ppc-5: IF Scope=treatment, there must be a patient | ||||
![]() ![]() ![]() |
Σ | 0..1 | id | Logical id of this artifact | ||||
![]() ![]() ![]() |
Σ | 0..1 | Meta | Metadata about the resource | ||||
![]() ![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]() ![]() |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
![]() ![]() ![]() |
0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
![]() ![]() ![]() |
0..* | Resource | Contained, inline Resources | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
?! | 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"} | ||||
![]() ![]() ![]() |
?!SΣ | 1..1 | code | draft | proposed | active | rejected | inactive | entered-in-error Binding: ConsentState (required): Indicates the state of the consent. Fixed Value: active | ||||
![]() ![]() ![]() |
?!SΣ | 1..1 | CodeableConcept | Which of the four areas this resource covers (extensible) Binding: ConsentScopeCodes (extensible): The four anticipated uses for the Consent Resource. Required Pattern: At least the following | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/consentscope | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Version of the system - if relevant | |||||
![]() ![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system Fixed Value: patient-privacy | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Representation defined by the system | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | boolean | If this coding was chosen directly by the user | |||||
![]() ![]() ![]() ![]() |
0..1 | string | Plain text representation of the concept | |||||
![]() ![]() ![]() |
Σ | 1..* | 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. | ||||
![]() ![]() ![]() ![]() |
SΣ | 0..* | 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: At least the following | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() |
1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ActCode | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Version of the system - if relevant | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system Fixed Value: IDSCL | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Representation defined by the system | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | boolean | If this coding was chosen directly by the user | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Plain text representation of the concept | |||||
![]() ![]() ![]() |
SΣ | 1..1 | Reference(US Core Patient Profile(6.1.0)) | Who the consent applies to | ||||
![]() ![]() ![]() |
Σ | 0..1 | dateTime | When this Consent was created or indexed | ||||
![]() ![]() ![]() |
SΣ | 1..1 | Reference(US Core Patient Profile(6.1.0) | RelatedPerson | US Core Practitioner Profile(6.1.0) | US Core PractitionerRole Profile(6.1.0) | US Core Organization Profile(6.1.0)) | Who is agreeing to the policy and rules | ||||
![]() ![]() ![]() |
Σ | 0..* | Reference(Organization) | Custodian of the consent | ||||
![]() ![]() ![]() |
SΣ | 1..1 | Reference(DocumentReference) | Source from which this consent is taken | ||||
![]() ![]() ![]() |
1..* | BackboneElement | Policies covered by this consent Slice: Unordered, Open by value:uri | |||||
![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() ![]() |
C | 0..1 | uri | Enforcement source for policy | ||||
![]() ![]() ![]() ![]() ![]() |
C | 0..1 | uri | Specific policy covered by this consent | ||||
![]() ![]() ![]() ![]() |
S | 1..* | BackboneElement | Policies covered by this consent | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() ![]() |
C | 0..1 | uri | Enforcement source for policy | ||||
![]() ![]() ![]() ![]() ![]() |
SC | 1..1 | uri | Specific policy covered by this consent Binding: HRex Consent Policy ValueSet (required) | ||||
![]() ![]() ![]() |
ΣC | 0..1 | CodeableConcept | Regulation that this consents to Binding: ConsentPolicyRuleCodes (extensible): Regulatory policy examples. | ||||
![]() ![]() ![]() |
Σ | 0..* | BackboneElement | Consent Verified by patient or family | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
Σ | 1..1 | boolean | Has been verified | ||||
![]() ![]() ![]() ![]() |
0..1 | Reference(Patient | RelatedPerson) | Person who verified | |||||
![]() ![]() ![]() ![]() |
0..1 | dateTime | When consent verified | |||||
![]() ![]() ![]() |
SΣ | 1..1 | BackboneElement | Constraints to the base Consent.policyRule | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | code | deny | permit Binding: ConsentProvisionType (required): How a rule statement is applied, such as adding additional consent or removing consent. Fixed Value: permit | ||||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | Period | Timeframe for this rule | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
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 | End time with inclusive boundary, if not ongoing | ||||
![]() ![]() ![]() ![]() |
2..* | BackboneElement | Who|what controlled by this rule (or group, by role) Slice: Unordered, Open by pattern:role | |||||
![]() ![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | How the actor is involved Binding: SecurityRoleType (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) | |||||
![]() ![]() ![]() ![]() ![]() |
S | 1..* | BackboneElement | Authorized to disclose | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
S | 1..1 | CodeableConcept | How the actor is involved Binding: SecurityRoleType (extensible): How an actor is involved in the consent considerations. Required Pattern: At least the following | ||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/provenance-participant-type | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Version of the system - if relevant | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system Fixed Value: performer | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Representation defined by the system | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | boolean | If this coding was chosen directly by the user | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Plain text representation of the concept | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
S | 1..1 | Reference(HRex Organization Profile(1.1.0-preview)) | Resource for the actor (or group, by role) | ||||
![]() ![]() ![]() ![]() ![]() |
S | 1..* | BackboneElement | Authorized to receive information | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
S | 1..1 | CodeableConcept | How the actor is involved Binding: SecurityRoleType (extensible): How an actor is involved in the consent considerations. Required Pattern: At least the following | ||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ParticipationType | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Version of the system - if relevant | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system Fixed Value: IRCP | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Representation defined by the system | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | boolean | If this coding was chosen directly by the user | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Plain text representation of the concept | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
S | 1..1 | Reference(HRex Organization Profile(1.1.0-preview)) | Resource for the actor (or group, by role) | ||||
![]() ![]() ![]() ![]() |
Σ | 1..1 | CodeableConcept | Actions controlled by this rule Binding: ConsentActionCodes (example): Detailed codes for the consent action. Required Pattern: At least the following | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() |
1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/consentaction | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Version of the system - if relevant | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system Fixed Value: disclose | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Representation defined by the system | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | boolean | If this coding was chosen directly by the user | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Plain text representation of the concept | |||||
![]() |
Path | Conformance | ValueSet / Code | URI | |||
Consent.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languages from the FHIR Standard | ||||
Consent.status | required | Fixed Value: activehttp://hl7.org/fhir/ValueSet/consent-state-codes|4.0.1 from the FHIR Standard | ||||
Consent.scope | extensible | Pattern: patient-privacyhttp://hl7.org/fhir/ValueSet/consent-scope from the FHIR Standard | ||||
Consent.category | extensible | ConsentCategoryCodeshttp://hl7.org/fhir/ValueSet/consent-category from the FHIR Standard | ||||
Consent.category:disclosure | extensible | Pattern: IDSCLhttp://hl7.org/fhir/ValueSet/consent-category from the FHIR Standard | ||||
Consent.policy:pdex.uri | required | HRexConsentPolicyhttp://hl7.org/fhir/us/davinci-hrex/ValueSet/hrex-consent-policy | ||||
Consent.policyRule | extensible | ConsentPolicyRuleCodeshttp://hl7.org/fhir/ValueSet/consent-policy from the FHIR Standard | ||||
Consent.provision.type | required | Fixed Value: permithttp://hl7.org/fhir/ValueSet/consent-provision-type|4.0.1 from the FHIR Standard | ||||
Consent.provision.actor.role | extensible | SecurityRoleTypehttp://hl7.org/fhir/ValueSet/security-role-type from the FHIR Standard | ||||
Consent.provision.actor:source.role | extensible | Pattern: performerhttp://hl7.org/fhir/ValueSet/security-role-type from the FHIR Standard | ||||
Consent.provision.actor:recipient.role | extensible | Pattern: IRCPhttp://hl7.org/fhir/ValueSet/security-role-type from the FHIR Standard | ||||
Consent.provision.action | example | Pattern: disclosehttp://hl7.org/fhir/ValueSet/consent-action from the FHIR Standard | ||||
Consent.provision.data.meaning | required | ConsentDataMeaninghttp://hl7.org/fhir/ValueSet/consent-data-meaning|4.0.1 from the FHIR Standard |
This structure is derived from Consent
Summary
Mandatory: 14 elements
Must-Support: 19 elements
Fixed: 2 elements
Prohibited: 7 elements
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
Maturity: 0
Other representations of profile: CSV, Excel, Schematron