Privacy Consent on FHIR (PCF)
1.1.1-current - ci-build
Privacy Consent on FHIR (PCF)
1.1.1-current - ci-build
Privacy Consent on FHIR (PCF), published by IHE IT Infrastructure Technical Committee. This guide is not an authorized publication; it is the continuous build for version 1.1.1-current built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/IHE/ITI.PCF/ and changes regularly. See the Directory of published versions
| Official URL: https://profiles.ihe.net/ITI/PCF/StructureDefinition/IHE.PCF.consentIntermediate | Version: 1.1.1-current | |||
| Active as of 2024-10-21 | Computable Name: IntermediateConsent | |||
Explicit Intermediate Consent
.provision apply to the whole Consent
.provision.provision are exceptions to the base consent.provision.provision.provisions are allowed.dataPeriod element.data element with .meaning of #instance.data element with .meaning of #related.data element with .meaning of #authoredby.purpose elementsecurityLabel is not allowed, see AdvancedUsage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from Consent
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  Consent |
0..* | Consent | A healthcare consumer's choices to permit or deny recipients or roles to perform actions for specific purposes and periods of time | |
  scope |
1..1 | CodeableConcept | Which of the four areas this resource covers (extensible) Required Pattern: At least the following | |
   coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
 system |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/consentscope | |
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: patient-privacy | |
| patient |
1..1 | Reference(Patient) | Who the consent applies to | |
| dateTime |
1..1 | dateTime | When this Consent was created or indexed | |
| performer |
1..* | Reference(Organization | Patient | Practitioner | RelatedPerson | PractitionerRole) | Who is agreeing to the policy and rules | |
| organization |
1..* | Reference(Organization) | Custodian of the consent | |
| source[x] |
1..1 | Attachment, Reference(Consent | DocumentReference | Contract | QuestionnaireResponse) | Source from which this consent is taken | |
| policy |
||||
| uri |
1..1 | uri | Specific policy covered by this consent | |
| verification |
0..0 | |||
| provision |
S | 1..1 | BackboneElement | Constraints to the base Consent.policyRule |
| type |
1..1 | code | deny | permit | |
| period |
S | 0..1 | Period | Timeframe for this rule |
| actor |
S | 0..* | BackboneElement | Who|what controlled by this rule (or group, by role) |
| role |
1..1 | CodeableConcept | How the actor is involved Required Pattern: At least the following | |
| coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ParticipationType | |
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: IRCP | |
| action |
0..0 | |||
| securityLabel |
0..0 | |||
| purpose |
S | 0..* | Coding | Context of activities covered by this rule |
| class |
0..0 | |||
| code |
0..0 | |||
| dataPeriod |
S | 0..1 | Period | Timeframe for data controlled by this rule |
 Slices for data |
S | 0..* | BackboneElement | Data controlled by this rule Slice: Unordered, Closed by value:meaning |
  data:iData |
0..* | BackboneElement | Data controlled by this rule | |
  meaning |
1..1 | code | instance | related | dependents | authoredby Required Pattern: instance | |
| data:rData |
0..* | BackboneElement | Data controlled by this rule | |
 meaning |
1..1 | code | instance | related | dependents | authoredby Required Pattern: related | |
 reference |
1..1 | Reference(Encounter | CarePlan | EpisodeOfCare) | The actual data reference | |
 data:aData |
0..* | BackboneElement | Data controlled by this rule | |
| meaning |
1..1 | code | instance | related | dependents | authoredby Required Pattern: authoredby | |
| reference |
1..1 | Reference(Practitioner | PractitionerRole | Organization | Device | Group | CareTeam | Patient | RelatedPerson) | The actual data reference | |
 provision |
S | 0..* | BackboneElement | Nested Exception Rules |
| purpose |
S | 0..* | Coding | Context of activities covered by this rule |
| dataPeriod |
S | 0..1 | Period | Timeframe for data controlled by this rule |
| Slices for data |
S | 0..* | BackboneElement | Data controlled by this rule Slice: Unordered, Closed by value:meaning |
| data:iDataP |
0..1 | BackboneElement | Data controlled by this rule | |
| meaning |
1..1 | code | instance | related | dependents | authoredby Required Pattern: instance | |
| data:rDataP |
0..1 | BackboneElement | Data controlled by this rule | |
| meaning |
1..1 | code | instance | related | dependents | authoredby Required Pattern: related | |
| reference |
1..1 | Reference(Encounter | CarePlan | EpisodeOfCare) | The actual data reference | |
| data:aDataP |
0..1 | BackboneElement | Data controlled by this rule | |
| meaning |
1..1 | code | instance | related | dependents | authoredby Required Pattern: authoredby | |
| reference |
1..1 | Reference(Practitioner | PractitionerRole | Organization | Device | Group | CareTeam | Patient | RelatedPerson) | The actual data reference | |
| provision |
0..0 | |||
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Consent |
C | 0..* | Consent | A healthcare consumer's choices to permit or deny recipients or roles to perform actions for specific purposes and periods of time 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 |
 implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
 modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored |
| status |
?!Σ | 1..1 | code | draft | proposed | active | rejected | inactive | entered-in-error Binding: ConsentState (required): Indicates the state of the consent. |
| scope |
?!Σ | 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 |
| coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/consentscope | |
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: patient-privacy | |
| category |
Σ | 1..* | CodeableConcept | Classification of the consent statement - for indexing/retrieval Binding: ConsentCategoryCodes (extensible): A classification of the type of consents found in a consent statement. |
| patient |
Σ | 1..1 | Reference(Patient) | Who the consent applies to |
| dateTime |
Σ | 1..1 | dateTime | When this Consent was created or indexed |
| performer |
Σ | 1..* | Reference(Organization | Patient | Practitioner | RelatedPerson | PractitionerRole) | Who is agreeing to the policy and rules |
| organization |
Σ | 1..* | Reference(Organization) | Custodian of the consent |
 source[x] |
Σ | 1..1 | Source from which this consent is taken | |
| sourceAttachment |
Attachment | |||
| sourceReference |
Reference(Consent | DocumentReference | Contract | QuestionnaireResponse) | |||
| provision |
SΣ | 1..1 | BackboneElement | Constraints to the base Consent.policyRule |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| type |
Σ | 1..1 | code | deny | permit Binding: ConsentProvisionType (required): How a rule statement is applied, such as adding additional consent or removing consent. |
| period |
SΣ | 0..1 | Period | Timeframe for this rule |
| actor |
S | 0..* | BackboneElement | Who|what controlled by this rule (or group, by role) |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| role |
1..1 | CodeableConcept | How the actor is involved Binding: SecurityRoleType (extensible): How an actor is involved in the consent considerations. Required Pattern: At least the following | |
| coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ParticipationType | |
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: IRCP | |
| reference |
1..1 | Reference(Device | Group | CareTeam | Organization | Patient | Practitioner | RelatedPerson | PractitionerRole) | Resource for the actor (or group, by role) | |
| purpose |
SΣ | 0..* | Coding | Context of activities covered by this rule Binding: PurposeOfUse (extensible): What purposes of use are controlled by this exception. If more than one label is specified, operations must have all the specified labels. |
| dataPeriod |
SΣ | 0..1 | Period | Timeframe for data controlled by this rule |
| Slices for data |
SΣ | 0..* | BackboneElement | Data controlled by this rule Slice: Unordered, Closed by value:meaning |
| data:All Slices |
Content/Rules for all slices | |||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| meaning |
Σ | 1..1 | code | instance | related | dependents | authoredby Binding: ConsentDataMeaning (required): How a resource reference is interpreted when testing consent restrictions. |
| reference |
Σ | 1..1 | Reference(Resource) | The actual data reference |
| data:iData |
Σ | 0..* | BackboneElement | Data controlled by this rule |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| meaning |
Σ | 1..1 | code | instance | related | dependents | authoredby Binding: ConsentDataMeaning (required): How a resource reference is interpreted when testing consent restrictions. Required Pattern: instance |
| reference |
Σ | 1..1 | Reference(Resource) | The actual data reference |
| data:rData |
Σ | 0..* | BackboneElement | Data controlled by this rule |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| meaning |
Σ | 1..1 | code | instance | related | dependents | authoredby Binding: ConsentDataMeaning (required): How a resource reference is interpreted when testing consent restrictions. Required Pattern: related |
| reference |
Σ | 1..1 | Reference(Encounter | CarePlan | EpisodeOfCare) | The actual data reference |
| data:aData |
Σ | 0..* | BackboneElement | Data controlled by this rule |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| meaning |
Σ | 1..1 | code | instance | related | dependents | authoredby Binding: ConsentDataMeaning (required): How a resource reference is interpreted when testing consent restrictions. Required Pattern: authoredby |
| reference |
Σ | 1..1 | Reference(Practitioner | PractitionerRole | Organization | Device | Group | CareTeam | Patient | RelatedPerson) | The actual data reference |
| provision |
S | 0..* | BackboneElement | Nested Exception Rules |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| purpose |
SΣ | 0..* | Coding | Context of activities covered by this rule Binding: PurposeOfUse (extensible): What purposes of use are controlled by this exception. If more than one label is specified, operations must have all the specified labels. |
| dataPeriod |
SΣ | 0..1 | Period | Timeframe for data controlled by this rule |
| Slices for data |
SΣ | 0..* | BackboneElement | Data controlled by this rule Slice: Unordered, Closed by value:meaning |
| data:All Slices |
Content/Rules for all slices | |||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| meaning |
Σ | 1..1 | code | instance | related | dependents | authoredby Binding: ConsentDataMeaning (required): How a resource reference is interpreted when testing consent restrictions. |
| reference |
Σ | 1..1 | Reference(Resource) | The actual data reference |
| data:iDataP |
Σ | 0..1 | BackboneElement | Data controlled by this rule |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| meaning |
Σ | 1..1 | code | instance | related | dependents | authoredby Binding: ConsentDataMeaning (required): How a resource reference is interpreted when testing consent restrictions. Required Pattern: instance |
| reference |
Σ | 1..1 | Reference(Resource) | The actual data reference |
| data:rDataP |
Σ | 0..1 | BackboneElement | Data controlled by this rule |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| meaning |
Σ | 1..1 | code | instance | related | dependents | authoredby Binding: ConsentDataMeaning (required): How a resource reference is interpreted when testing consent restrictions. Required Pattern: related |
| reference |
Σ | 1..1 | Reference(Encounter | CarePlan | EpisodeOfCare) | The actual data reference |
| data:aDataP |
Σ | 0..1 | BackboneElement | Data controlled by this rule |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| meaning |
Σ | 1..1 | code | instance | related | dependents | authoredby Binding: ConsentDataMeaning (required): How a resource reference is interpreted when testing consent restrictions. Required Pattern: authoredby |
| reference |
Σ | 1..1 | Reference(Practitioner | PractitionerRole | Organization | Device | Group | CareTeam | Patient | RelatedPerson) | The actual data reference |
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code | URI |
| Consent.status | required | ConsentStatehttp://hl7.org/fhir/ValueSet/consent-state-codes|4.0.1from the FHIR Standard | |
| Consent.scope | extensible | Pattern: patient-privacyhttp://hl7.org/fhir/ValueSet/consent-scopefrom the FHIR Standard | |
| Consent.category | extensible | ConsentCategoryCodeshttp://hl7.org/fhir/ValueSet/consent-categoryfrom the FHIR Standard | |
| Consent.provision.type | required | ConsentProvisionTypehttp://hl7.org/fhir/ValueSet/consent-provision-type|4.0.1from the FHIR Standard | |
| Consent.provision.actor.role | extensible | Pattern: IRCPhttp://hl7.org/fhir/ValueSet/security-role-typefrom the FHIR Standard | |
| Consent.provision.purpose | extensible | PurposeOfUsehttp://terminology.hl7.org/ValueSet/v3-PurposeOfUse | |
| Consent.provision.data.meaning | required | ConsentDataMeaninghttp://hl7.org/fhir/ValueSet/consent-data-meaning|4.0.1from the FHIR Standard | |
| Consent.provision.data:iData.meaning | required | Pattern: instancehttp://hl7.org/fhir/ValueSet/consent-data-meaning|4.0.1from the FHIR Standard | |
| Consent.provision.data:rData.meaning | required | Pattern: relatedhttp://hl7.org/fhir/ValueSet/consent-data-meaning|4.0.1from the FHIR Standard | |
| Consent.provision.data:aData.meaning | required | Pattern: authoredbyhttp://hl7.org/fhir/ValueSet/consent-data-meaning|4.0.1from the FHIR Standard | |
| Consent.provision.provision.purpose | extensible | PurposeOfUsehttp://terminology.hl7.org/ValueSet/v3-PurposeOfUse | |
| Consent.provision.provision.data.meaning | required | ConsentDataMeaninghttp://hl7.org/fhir/ValueSet/consent-data-meaning|4.0.1from the FHIR Standard | |
| Consent.provision.provision.data:iDataP.meaning | required | Pattern: instancehttp://hl7.org/fhir/ValueSet/consent-data-meaning|4.0.1from the FHIR Standard | |
| Consent.provision.provision.data:rDataP.meaning | required | Pattern: relatedhttp://hl7.org/fhir/ValueSet/consent-data-meaning|4.0.1from the FHIR Standard | |
| Consent.provision.provision.data:aDataP.meaning | required | Pattern: authoredbyhttp://hl7.org/fhir/ValueSet/consent-data-meaning|4.0.1from the FHIR Standard |
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| Consent |
C | 0..* | Consent | A healthcare consumer's choices to permit or deny recipients or roles to perform actions for specific purposes and periods of time 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 | ||||
| id |
Σ | 0..1 | id | Logical id of this artifact | ||||
| meta |
Σ | 0..1 | Meta | Metadata about the resource | ||||
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
| language |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
| text |
0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
| contained |
0..* | Resource | Contained, inline Resources | |||||
 extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| identifier |
Σ | 0..* | Identifier | Identifier for this record (external references) Example General: {"system":"http://acme.org/identifier/local/eCMS","value":"Local eCMS identifier"} | ||||
| status |
?!Σ | 1..1 | code | draft | proposed | active | rejected | inactive | entered-in-error Binding: ConsentState (required): Indicates the state of the consent. | ||||
| scope |
?!Σ | 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 | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/consentscope | |||||
| version |
0..1 | string | Version of the system - if relevant | |||||
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: patient-privacy | |||||
| display |
0..1 | string | Representation defined by the system | |||||
| userSelected |
0..1 | boolean | If this coding was chosen directly by the user | |||||
| text |
0..1 | string | Plain text representation of the concept | |||||
| category |
Σ | 1..* | CodeableConcept | Classification of the consent statement - for indexing/retrieval Binding: ConsentCategoryCodes (extensible): A classification of the type of consents found in a consent statement. | ||||
| patient |
Σ | 1..1 | Reference(Patient) | Who the consent applies to | ||||
| dateTime |
Σ | 1..1 | dateTime | When this Consent was created or indexed | ||||
| performer |
Σ | 1..* | Reference(Organization | Patient | Practitioner | RelatedPerson | PractitionerRole) | Who is agreeing to the policy and rules | ||||
| organization |
Σ | 1..* | Reference(Organization) | Custodian of the consent | ||||
| source[x] |
Σ | 1..1 | Source from which this consent is taken | |||||
| sourceAttachment |
Attachment | |||||||
| sourceReference |
Reference(Consent | DocumentReference | Contract | QuestionnaireResponse) | |||||||
| policy |
0..* | BackboneElement | Policies covered by this consent | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| authority |
C | 0..1 | uri | Enforcement source for policy | ||||
| uri |
C | 1..1 | uri | Specific policy covered by this consent | ||||
| policyRule |
ΣC | 0..1 | CodeableConcept | Regulation that this consents to Binding: ConsentPolicyRuleCodes (extensible): Regulatory policy examples. | ||||
| provision |
SΣ | 1..1 | BackboneElement | Constraints to the base Consent.policyRule | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| type |
Σ | 1..1 | code | deny | permit Binding: ConsentProvisionType (required): How a rule statement is applied, such as adding additional consent or removing consent. | ||||
| period |
SΣ | 0..1 | Period | Timeframe for this rule | ||||
| actor |
S | 0..* | BackboneElement | Who|what controlled by this rule (or group, by role) | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| role |
1..1 | CodeableConcept | How the actor is involved Binding: SecurityRoleType (extensible): How an actor is involved in the consent considerations. Required Pattern: At least the following | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ParticipationType | |||||
| version |
0..1 | string | Version of the system - if relevant | |||||
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: IRCP | |||||
| display |
0..1 | string | Representation defined by the system | |||||
| userSelected |
0..1 | boolean | If this coding was chosen directly by the user | |||||
| text |
0..1 | string | Plain text representation of the concept | |||||
| reference |
1..1 | Reference(Device | Group | CareTeam | Organization | Patient | Practitioner | RelatedPerson | PractitionerRole) | Resource for the actor (or group, by role) | |||||
| purpose |
SΣ | 0..* | Coding | Context of activities covered by this rule Binding: PurposeOfUse (extensible): What purposes of use are controlled by this exception. If more than one label is specified, operations must have all the specified labels. | ||||
| dataPeriod |
SΣ | 0..1 | Period | Timeframe for data controlled by this rule | ||||
| Slices for data |
SΣ | 0..* | BackboneElement | Data controlled by this rule Slice: Unordered, Closed by value:meaning | ||||
| data:All Slices |
Content/Rules for all slices | |||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| meaning |
Σ | 1..1 | code | instance | related | dependents | authoredby Binding: ConsentDataMeaning (required): How a resource reference is interpreted when testing consent restrictions. | ||||
| reference |
Σ | 1..1 | Reference(Resource) | The actual data reference | ||||
| data:iData |
Σ | 0..* | BackboneElement | Data controlled by this rule | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| meaning |
Σ | 1..1 | code | instance | related | dependents | authoredby Binding: ConsentDataMeaning (required): How a resource reference is interpreted when testing consent restrictions. Required Pattern: instance | ||||
| reference |
Σ | 1..1 | Reference(Resource) | The actual data reference | ||||
| data:rData |
Σ | 0..* | BackboneElement | Data controlled by this rule | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| meaning |
Σ | 1..1 | code | instance | related | dependents | authoredby Binding: ConsentDataMeaning (required): How a resource reference is interpreted when testing consent restrictions. Required Pattern: related | ||||
| reference |
Σ | 1..1 | Reference(Encounter | CarePlan | EpisodeOfCare) | The actual data reference | ||||
| data:aData |
Σ | 0..* | BackboneElement | Data controlled by this rule | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| meaning |
Σ | 1..1 | code | instance | related | dependents | authoredby Binding: ConsentDataMeaning (required): How a resource reference is interpreted when testing consent restrictions. Required Pattern: authoredby | ||||
| reference |
Σ | 1..1 | Reference(Practitioner | PractitionerRole | Organization | Device | Group | CareTeam | Patient | RelatedPerson) | The actual data reference | ||||
| provision |
S | 0..* | BackboneElement | Nested Exception Rules | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| type |
Σ | 0..1 | code | deny | permit Binding: ConsentProvisionType (required): How a rule statement is applied, such as adding additional consent or removing consent. | ||||
| period |
Σ | 0..1 | Period | Timeframe for this rule | ||||
| actor |
0..* | BackboneElement | Who|what controlled by this rule (or group, by role) | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| role |
1..1 | CodeableConcept | How the actor is involved Binding: SecurityRoleType (extensible): How an actor is involved in the consent considerations. | |||||
| reference |
1..1 | Reference(Device | Group | CareTeam | Organization | Patient | Practitioner | RelatedPerson | PractitionerRole) | Resource for the actor (or group, by role) | |||||
| action |
Σ | 0..* | CodeableConcept | Actions controlled by this rule Binding: ConsentActionCodes (example): Detailed codes for the consent action. | ||||
| securityLabel |
Σ | 0..* | Coding | Security Labels that define affected resources Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. | ||||
| purpose |
SΣ | 0..* | Coding | Context of activities covered by this rule Binding: PurposeOfUse (extensible): What purposes of use are controlled by this exception. If more than one label is specified, operations must have all the specified labels. | ||||
| class |
Σ | 0..* | Coding | e.g. Resource Type, Profile, CDA, etc. Binding: ConsentContentClass (extensible): The class (type) of information a consent rule covers. | ||||
| code |
Σ | 0..* | CodeableConcept | e.g. LOINC or SNOMED CT code, etc. in the content Binding: ConsentContentCodes (example): If this code is found in an instance, then the exception applies. | ||||
| dataPeriod |
SΣ | 0..1 | Period | Timeframe for data controlled by this rule | ||||
| Slices for data |
SΣ | 0..* | BackboneElement | Data controlled by this rule Slice: Unordered, Closed by value:meaning | ||||
| data:All Slices |
Content/Rules for all slices | |||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| meaning |
Σ | 1..1 | code | instance | related | dependents | authoredby Binding: ConsentDataMeaning (required): How a resource reference is interpreted when testing consent restrictions. | ||||
| reference |
Σ | 1..1 | Reference(Resource) | The actual data reference | ||||
| data:iDataP |
Σ | 0..1 | BackboneElement | Data controlled by this rule | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| meaning |
Σ | 1..1 | code | instance | related | dependents | authoredby Binding: ConsentDataMeaning (required): How a resource reference is interpreted when testing consent restrictions. Required Pattern: instance | ||||
| reference |
Σ | 1..1 | Reference(Resource) | The actual data reference | ||||
| data:rDataP |
Σ | 0..1 | BackboneElement | Data controlled by this rule | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| meaning |
Σ | 1..1 | code | instance | related | dependents | authoredby Binding: ConsentDataMeaning (required): How a resource reference is interpreted when testing consent restrictions. Required Pattern: related | ||||
| reference |
Σ | 1..1 | Reference(Encounter | CarePlan | EpisodeOfCare) | The actual data reference | ||||
| data:aDataP |
Σ | 0..1 | BackboneElement | Data controlled by this rule | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| meaning |
Σ | 1..1 | code | instance | related | dependents | authoredby Binding: ConsentDataMeaning (required): How a resource reference is interpreted when testing consent restrictions. Required Pattern: authoredby | ||||
| reference |
Σ | 1..1 | Reference(Practitioner | PractitionerRole | Organization | Device | Group | CareTeam | Patient | RelatedPerson) | The actual data reference | ||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet / Code | URI | |||
| Consent.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard | ||||
| Consent.status | required | ConsentStatehttp://hl7.org/fhir/ValueSet/consent-state-codes|4.0.1from the FHIR Standard | ||||
| Consent.scope | extensible | Pattern: patient-privacyhttp://hl7.org/fhir/ValueSet/consent-scopefrom the FHIR Standard | ||||
| Consent.category | extensible | ConsentCategoryCodeshttp://hl7.org/fhir/ValueSet/consent-categoryfrom the FHIR Standard | ||||
| Consent.policyRule | extensible | ConsentPolicyRuleCodeshttp://hl7.org/fhir/ValueSet/consent-policyfrom the FHIR Standard | ||||
| Consent.provision.type | required | ConsentProvisionTypehttp://hl7.org/fhir/ValueSet/consent-provision-type|4.0.1from the FHIR Standard | ||||
| Consent.provision.actor.role | extensible | Pattern: IRCPhttp://hl7.org/fhir/ValueSet/security-role-typefrom the FHIR Standard | ||||
| Consent.provision.purpose | extensible | PurposeOfUsehttp://terminology.hl7.org/ValueSet/v3-PurposeOfUse | ||||
| Consent.provision.data.meaning | required | ConsentDataMeaninghttp://hl7.org/fhir/ValueSet/consent-data-meaning|4.0.1from the FHIR Standard | ||||
| Consent.provision.data:iData.meaning | required | Pattern: instancehttp://hl7.org/fhir/ValueSet/consent-data-meaning|4.0.1from the FHIR Standard | ||||
| Consent.provision.data:rData.meaning | required | Pattern: relatedhttp://hl7.org/fhir/ValueSet/consent-data-meaning|4.0.1from the FHIR Standard | ||||
| Consent.provision.data:aData.meaning | required | Pattern: authoredbyhttp://hl7.org/fhir/ValueSet/consent-data-meaning|4.0.1from the FHIR Standard | ||||
| Consent.provision.provision.type | required | ConsentProvisionTypehttp://hl7.org/fhir/ValueSet/consent-provision-type|4.0.1from the FHIR Standard | ||||
| Consent.provision.provision.actor.role | extensible | SecurityRoleTypehttp://hl7.org/fhir/ValueSet/security-role-typefrom the FHIR Standard | ||||
| Consent.provision.provision.action | example | ConsentActionCodeshttp://hl7.org/fhir/ValueSet/consent-actionfrom the FHIR Standard | ||||
| Consent.provision.provision.securityLabel | extensible | All Security Labelshttp://hl7.org/fhir/ValueSet/security-labelsfrom the FHIR Standard | ||||
| Consent.provision.provision.purpose | extensible | PurposeOfUsehttp://terminology.hl7.org/ValueSet/v3-PurposeOfUse | ||||
| Consent.provision.provision.class | extensible | ConsentContentClasshttp://hl7.org/fhir/ValueSet/consent-content-classfrom the FHIR Standard | ||||
| Consent.provision.provision.code | example | ConsentContentCodes (a valid code from LOINC)http://hl7.org/fhir/ValueSet/consent-content-codefrom the FHIR Standard | ||||
| Consent.provision.provision.data.meaning | required | ConsentDataMeaninghttp://hl7.org/fhir/ValueSet/consent-data-meaning|4.0.1from the FHIR Standard | ||||
| Consent.provision.provision.data:iDataP.meaning | required | Pattern: instancehttp://hl7.org/fhir/ValueSet/consent-data-meaning|4.0.1from the FHIR Standard | ||||
| Consent.provision.provision.data:rDataP.meaning | required | Pattern: relatedhttp://hl7.org/fhir/ValueSet/consent-data-meaning|4.0.1from the FHIR Standard | ||||
| Consent.provision.provision.data:aDataP.meaning | required | Pattern: authoredbyhttp://hl7.org/fhir/ValueSet/consent-data-meaning|4.0.1from the FHIR Standard |
This structure is derived from Consent
Summary
Mandatory: 7 elements(1 nested mandatory element)
Must-Support: 10 elements
Prohibited: 6 elements
Slices
This structure defines the following Slices:
Differential View
This structure is derived from Consent
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Consent |
0..* | Consent | A healthcare consumer's choices to permit or deny recipients or roles to perform actions for specific purposes and periods of time | |
| scope |
1..1 | CodeableConcept | Which of the four areas this resource covers (extensible) Required Pattern: At least the following | |
| coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/consentscope | |
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: patient-privacy | |
| patient |
1..1 | Reference(Patient) | Who the consent applies to | |
| dateTime |
1..1 | dateTime | When this Consent was created or indexed | |
| performer |
1..* | Reference(Organization | Patient | Practitioner | RelatedPerson | PractitionerRole) | Who is agreeing to the policy and rules | |
| organization |
1..* | Reference(Organization) | Custodian of the consent | |
| source[x] |
1..1 | Attachment, Reference(Consent | DocumentReference | Contract | QuestionnaireResponse) | Source from which this consent is taken | |
| policy |
||||
| uri |
1..1 | uri | Specific policy covered by this consent | |
| verification |
0..0 | |||
| provision |
S | 1..1 | BackboneElement | Constraints to the base Consent.policyRule |
| type |
1..1 | code | deny | permit | |
| period |
S | 0..1 | Period | Timeframe for this rule |
| actor |
S | 0..* | BackboneElement | Who|what controlled by this rule (or group, by role) |
| role |
1..1 | CodeableConcept | How the actor is involved Required Pattern: At least the following | |
| coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ParticipationType | |
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: IRCP | |
| action |
0..0 | |||
| securityLabel |
0..0 | |||
| purpose |
S | 0..* | Coding | Context of activities covered by this rule |
| class |
0..0 | |||
| code |
0..0 | |||
| dataPeriod |
S | 0..1 | Period | Timeframe for data controlled by this rule |
| Slices for data |
S | 0..* | BackboneElement | Data controlled by this rule Slice: Unordered, Closed by value:meaning |
| data:iData |
0..* | BackboneElement | Data controlled by this rule | |
| meaning |
1..1 | code | instance | related | dependents | authoredby Required Pattern: instance | |
| data:rData |
0..* | BackboneElement | Data controlled by this rule | |
| meaning |
1..1 | code | instance | related | dependents | authoredby Required Pattern: related | |
| reference |
1..1 | Reference(Encounter | CarePlan | EpisodeOfCare) | The actual data reference | |
| data:aData |
0..* | BackboneElement | Data controlled by this rule | |
| meaning |
1..1 | code | instance | related | dependents | authoredby Required Pattern: authoredby | |
| reference |
1..1 | Reference(Practitioner | PractitionerRole | Organization | Device | Group | CareTeam | Patient | RelatedPerson) | The actual data reference | |
| provision |
S | 0..* | BackboneElement | Nested Exception Rules |
| purpose |
S | 0..* | Coding | Context of activities covered by this rule |
| dataPeriod |
S | 0..1 | Period | Timeframe for data controlled by this rule |
| Slices for data |
S | 0..* | BackboneElement | Data controlled by this rule Slice: Unordered, Closed by value:meaning |
| data:iDataP |
0..1 | BackboneElement | Data controlled by this rule | |
| meaning |
1..1 | code | instance | related | dependents | authoredby Required Pattern: instance | |
| data:rDataP |
0..1 | BackboneElement | Data controlled by this rule | |
| meaning |
1..1 | code | instance | related | dependents | authoredby Required Pattern: related | |
| reference |
1..1 | Reference(Encounter | CarePlan | EpisodeOfCare) | The actual data reference | |
| data:aDataP |
0..1 | BackboneElement | Data controlled by this rule | |
| meaning |
1..1 | code | instance | related | dependents | authoredby Required Pattern: authoredby | |
| reference |
1..1 | Reference(Practitioner | PractitionerRole | Organization | Device | Group | CareTeam | Patient | RelatedPerson) | The actual data reference | |
| provision |
0..0 | |||
| Documentation for this format | ||||
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Consent |
C | 0..* | Consent | A healthcare consumer's choices to permit or deny recipients or roles to perform actions for specific purposes and periods of time 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 |
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored |
| status |
?!Σ | 1..1 | code | draft | proposed | active | rejected | inactive | entered-in-error Binding: ConsentState (required): Indicates the state of the consent. |
| scope |
?!Σ | 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 |
| coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/consentscope | |
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: patient-privacy | |
| category |
Σ | 1..* | CodeableConcept | Classification of the consent statement - for indexing/retrieval Binding: ConsentCategoryCodes (extensible): A classification of the type of consents found in a consent statement. |
| patient |
Σ | 1..1 | Reference(Patient) | Who the consent applies to |
| dateTime |
Σ | 1..1 | dateTime | When this Consent was created or indexed |
| performer |
Σ | 1..* | Reference(Organization | Patient | Practitioner | RelatedPerson | PractitionerRole) | Who is agreeing to the policy and rules |
| organization |
Σ | 1..* | Reference(Organization) | Custodian of the consent |
| source[x] |
Σ | 1..1 | Source from which this consent is taken | |
| sourceAttachment |
Attachment | |||
| sourceReference |
Reference(Consent | DocumentReference | Contract | QuestionnaireResponse) | |||
| provision |
SΣ | 1..1 | BackboneElement | Constraints to the base Consent.policyRule |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| type |
Σ | 1..1 | code | deny | permit Binding: ConsentProvisionType (required): How a rule statement is applied, such as adding additional consent or removing consent. |
| period |
SΣ | 0..1 | Period | Timeframe for this rule |
| actor |
S | 0..* | BackboneElement | Who|what controlled by this rule (or group, by role) |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| role |
1..1 | CodeableConcept | How the actor is involved Binding: SecurityRoleType (extensible): How an actor is involved in the consent considerations. Required Pattern: At least the following | |
| coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ParticipationType | |
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: IRCP | |
| reference |
1..1 | Reference(Device | Group | CareTeam | Organization | Patient | Practitioner | RelatedPerson | PractitionerRole) | Resource for the actor (or group, by role) | |
| purpose |
SΣ | 0..* | Coding | Context of activities covered by this rule Binding: PurposeOfUse (extensible): What purposes of use are controlled by this exception. If more than one label is specified, operations must have all the specified labels. |
| dataPeriod |
SΣ | 0..1 | Period | Timeframe for data controlled by this rule |
| Slices for data |
SΣ | 0..* | BackboneElement | Data controlled by this rule Slice: Unordered, Closed by value:meaning |
| data:All Slices |
Content/Rules for all slices | |||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| meaning |
Σ | 1..1 | code | instance | related | dependents | authoredby Binding: ConsentDataMeaning (required): How a resource reference is interpreted when testing consent restrictions. |
| reference |
Σ | 1..1 | Reference(Resource) | The actual data reference |
| data:iData |
Σ | 0..* | BackboneElement | Data controlled by this rule |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| meaning |
Σ | 1..1 | code | instance | related | dependents | authoredby Binding: ConsentDataMeaning (required): How a resource reference is interpreted when testing consent restrictions. Required Pattern: instance |
| reference |
Σ | 1..1 | Reference(Resource) | The actual data reference |
| data:rData |
Σ | 0..* | BackboneElement | Data controlled by this rule |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| meaning |
Σ | 1..1 | code | instance | related | dependents | authoredby Binding: ConsentDataMeaning (required): How a resource reference is interpreted when testing consent restrictions. Required Pattern: related |
| reference |
Σ | 1..1 | Reference(Encounter | CarePlan | EpisodeOfCare) | The actual data reference |
| data:aData |
Σ | 0..* | BackboneElement | Data controlled by this rule |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| meaning |
Σ | 1..1 | code | instance | related | dependents | authoredby Binding: ConsentDataMeaning (required): How a resource reference is interpreted when testing consent restrictions. Required Pattern: authoredby |
| reference |
Σ | 1..1 | Reference(Practitioner | PractitionerRole | Organization | Device | Group | CareTeam | Patient | RelatedPerson) | The actual data reference |
| provision |
S | 0..* | BackboneElement | Nested Exception Rules |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| purpose |
SΣ | 0..* | Coding | Context of activities covered by this rule Binding: PurposeOfUse (extensible): What purposes of use are controlled by this exception. If more than one label is specified, operations must have all the specified labels. |
| dataPeriod |
SΣ | 0..1 | Period | Timeframe for data controlled by this rule |
| Slices for data |
SΣ | 0..* | BackboneElement | Data controlled by this rule Slice: Unordered, Closed by value:meaning |
| data:All Slices |
Content/Rules for all slices | |||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| meaning |
Σ | 1..1 | code | instance | related | dependents | authoredby Binding: ConsentDataMeaning (required): How a resource reference is interpreted when testing consent restrictions. |
| reference |
Σ | 1..1 | Reference(Resource) | The actual data reference |
| data:iDataP |
Σ | 0..1 | BackboneElement | Data controlled by this rule |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| meaning |
Σ | 1..1 | code | instance | related | dependents | authoredby Binding: ConsentDataMeaning (required): How a resource reference is interpreted when testing consent restrictions. Required Pattern: instance |
| reference |
Σ | 1..1 | Reference(Resource) | The actual data reference |
| data:rDataP |
Σ | 0..1 | BackboneElement | Data controlled by this rule |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| meaning |
Σ | 1..1 | code | instance | related | dependents | authoredby Binding: ConsentDataMeaning (required): How a resource reference is interpreted when testing consent restrictions. Required Pattern: related |
| reference |
Σ | 1..1 | Reference(Encounter | CarePlan | EpisodeOfCare) | The actual data reference |
| data:aDataP |
Σ | 0..1 | BackboneElement | Data controlled by this rule |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| meaning |
Σ | 1..1 | code | instance | related | dependents | authoredby Binding: ConsentDataMeaning (required): How a resource reference is interpreted when testing consent restrictions. Required Pattern: authoredby |
| reference |
Σ | 1..1 | Reference(Practitioner | PractitionerRole | Organization | Device | Group | CareTeam | Patient | RelatedPerson) | The actual data reference |
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code | URI |
| Consent.status | required | ConsentStatehttp://hl7.org/fhir/ValueSet/consent-state-codes|4.0.1from the FHIR Standard | |
| Consent.scope | extensible | Pattern: patient-privacyhttp://hl7.org/fhir/ValueSet/consent-scopefrom the FHIR Standard | |
| Consent.category | extensible | ConsentCategoryCodeshttp://hl7.org/fhir/ValueSet/consent-categoryfrom the FHIR Standard | |
| Consent.provision.type | required | ConsentProvisionTypehttp://hl7.org/fhir/ValueSet/consent-provision-type|4.0.1from the FHIR Standard | |
| Consent.provision.actor.role | extensible | Pattern: IRCPhttp://hl7.org/fhir/ValueSet/security-role-typefrom the FHIR Standard | |
| Consent.provision.purpose | extensible | PurposeOfUsehttp://terminology.hl7.org/ValueSet/v3-PurposeOfUse | |
| Consent.provision.data.meaning | required | ConsentDataMeaninghttp://hl7.org/fhir/ValueSet/consent-data-meaning|4.0.1from the FHIR Standard | |
| Consent.provision.data:iData.meaning | required | Pattern: instancehttp://hl7.org/fhir/ValueSet/consent-data-meaning|4.0.1from the FHIR Standard | |
| Consent.provision.data:rData.meaning | required | Pattern: relatedhttp://hl7.org/fhir/ValueSet/consent-data-meaning|4.0.1from the FHIR Standard | |
| Consent.provision.data:aData.meaning | required | Pattern: authoredbyhttp://hl7.org/fhir/ValueSet/consent-data-meaning|4.0.1from the FHIR Standard | |
| Consent.provision.provision.purpose | extensible | PurposeOfUsehttp://terminology.hl7.org/ValueSet/v3-PurposeOfUse | |
| Consent.provision.provision.data.meaning | required | ConsentDataMeaninghttp://hl7.org/fhir/ValueSet/consent-data-meaning|4.0.1from the FHIR Standard | |
| Consent.provision.provision.data:iDataP.meaning | required | Pattern: instancehttp://hl7.org/fhir/ValueSet/consent-data-meaning|4.0.1from the FHIR Standard | |
| Consent.provision.provision.data:rDataP.meaning | required | Pattern: relatedhttp://hl7.org/fhir/ValueSet/consent-data-meaning|4.0.1from the FHIR Standard | |
| Consent.provision.provision.data:aDataP.meaning | required | Pattern: authoredbyhttp://hl7.org/fhir/ValueSet/consent-data-meaning|4.0.1from the FHIR Standard |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| Consent |
C | 0..* | Consent | A healthcare consumer's choices to permit or deny recipients or roles to perform actions for specific purposes and periods of time 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 | ||||
| id |
Σ | 0..1 | id | Logical id of this artifact | ||||
| meta |
Σ | 0..1 | Meta | Metadata about the resource | ||||
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
| language |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
| text |
0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
| contained |
0..* | Resource | Contained, inline Resources | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| identifier |
Σ | 0..* | Identifier | Identifier for this record (external references) Example General: {"system":"http://acme.org/identifier/local/eCMS","value":"Local eCMS identifier"} | ||||
| status |
?!Σ | 1..1 | code | draft | proposed | active | rejected | inactive | entered-in-error Binding: ConsentState (required): Indicates the state of the consent. | ||||
| scope |
?!Σ | 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 | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/consentscope | |||||
| version |
0..1 | string | Version of the system - if relevant | |||||
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: patient-privacy | |||||
| display |
0..1 | string | Representation defined by the system | |||||
| userSelected |
0..1 | boolean | If this coding was chosen directly by the user | |||||
| text |
0..1 | string | Plain text representation of the concept | |||||
| category |
Σ | 1..* | CodeableConcept | Classification of the consent statement - for indexing/retrieval Binding: ConsentCategoryCodes (extensible): A classification of the type of consents found in a consent statement. | ||||
| patient |
Σ | 1..1 | Reference(Patient) | Who the consent applies to | ||||
| dateTime |
Σ | 1..1 | dateTime | When this Consent was created or indexed | ||||
| performer |
Σ | 1..* | Reference(Organization | Patient | Practitioner | RelatedPerson | PractitionerRole) | Who is agreeing to the policy and rules | ||||
| organization |
Σ | 1..* | Reference(Organization) | Custodian of the consent | ||||
| source[x] |
Σ | 1..1 | Source from which this consent is taken | |||||
| sourceAttachment |
Attachment | |||||||
| sourceReference |
Reference(Consent | DocumentReference | Contract | QuestionnaireResponse) | |||||||
| policy |
0..* | BackboneElement | Policies covered by this consent | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| authority |
C | 0..1 | uri | Enforcement source for policy | ||||
| uri |
C | 1..1 | uri | Specific policy covered by this consent | ||||
| policyRule |
ΣC | 0..1 | CodeableConcept | Regulation that this consents to Binding: ConsentPolicyRuleCodes (extensible): Regulatory policy examples. | ||||
| provision |
SΣ | 1..1 | BackboneElement | Constraints to the base Consent.policyRule | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| type |
Σ | 1..1 | code | deny | permit Binding: ConsentProvisionType (required): How a rule statement is applied, such as adding additional consent or removing consent. | ||||
| period |
SΣ | 0..1 | Period | Timeframe for this rule | ||||
| actor |
S | 0..* | BackboneElement | Who|what controlled by this rule (or group, by role) | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| role |
1..1 | CodeableConcept | How the actor is involved Binding: SecurityRoleType (extensible): How an actor is involved in the consent considerations. Required Pattern: At least the following | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ParticipationType | |||||
| version |
0..1 | string | Version of the system - if relevant | |||||
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: IRCP | |||||
| display |
0..1 | string | Representation defined by the system | |||||
| userSelected |
0..1 | boolean | If this coding was chosen directly by the user | |||||
| text |
0..1 | string | Plain text representation of the concept | |||||
| reference |
1..1 | Reference(Device | Group | CareTeam | Organization | Patient | Practitioner | RelatedPerson | PractitionerRole) | Resource for the actor (or group, by role) | |||||
| purpose |
SΣ | 0..* | Coding | Context of activities covered by this rule Binding: PurposeOfUse (extensible): What purposes of use are controlled by this exception. If more than one label is specified, operations must have all the specified labels. | ||||
| dataPeriod |
SΣ | 0..1 | Period | Timeframe for data controlled by this rule | ||||
| Slices for data |
SΣ | 0..* | BackboneElement | Data controlled by this rule Slice: Unordered, Closed by value:meaning | ||||
| data:All Slices |
Content/Rules for all slices | |||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| meaning |
Σ | 1..1 | code | instance | related | dependents | authoredby Binding: ConsentDataMeaning (required): How a resource reference is interpreted when testing consent restrictions. | ||||
| reference |
Σ | 1..1 | Reference(Resource) | The actual data reference | ||||
| data:iData |
Σ | 0..* | BackboneElement | Data controlled by this rule | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| meaning |
Σ | 1..1 | code | instance | related | dependents | authoredby Binding: ConsentDataMeaning (required): How a resource reference is interpreted when testing consent restrictions. Required Pattern: instance | ||||
| reference |
Σ | 1..1 | Reference(Resource) | The actual data reference | ||||
| data:rData |
Σ | 0..* | BackboneElement | Data controlled by this rule | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| meaning |
Σ | 1..1 | code | instance | related | dependents | authoredby Binding: ConsentDataMeaning (required): How a resource reference is interpreted when testing consent restrictions. Required Pattern: related | ||||
| reference |
Σ | 1..1 | Reference(Encounter | CarePlan | EpisodeOfCare) | The actual data reference | ||||
| data:aData |
Σ | 0..* | BackboneElement | Data controlled by this rule | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| meaning |
Σ | 1..1 | code | instance | related | dependents | authoredby Binding: ConsentDataMeaning (required): How a resource reference is interpreted when testing consent restrictions. Required Pattern: authoredby | ||||
| reference |
Σ | 1..1 | Reference(Practitioner | PractitionerRole | Organization | Device | Group | CareTeam | Patient | RelatedPerson) | The actual data reference | ||||
| provision |
S | 0..* | BackboneElement | Nested Exception Rules | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| type |
Σ | 0..1 | code | deny | permit Binding: ConsentProvisionType (required): How a rule statement is applied, such as adding additional consent or removing consent. | ||||
| period |
Σ | 0..1 | Period | Timeframe for this rule | ||||
| actor |
0..* | BackboneElement | Who|what controlled by this rule (or group, by role) | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| role |
1..1 | CodeableConcept | How the actor is involved Binding: SecurityRoleType (extensible): How an actor is involved in the consent considerations. | |||||
| reference |
1..1 | Reference(Device | Group | CareTeam | Organization | Patient | Practitioner | RelatedPerson | PractitionerRole) | Resource for the actor (or group, by role) | |||||
| action |
Σ | 0..* | CodeableConcept | Actions controlled by this rule Binding: ConsentActionCodes (example): Detailed codes for the consent action. | ||||
| securityLabel |
Σ | 0..* | Coding | Security Labels that define affected resources Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. | ||||
| purpose |
SΣ | 0..* | Coding | Context of activities covered by this rule Binding: PurposeOfUse (extensible): What purposes of use are controlled by this exception. If more than one label is specified, operations must have all the specified labels. | ||||
| class |
Σ | 0..* | Coding | e.g. Resource Type, Profile, CDA, etc. Binding: ConsentContentClass (extensible): The class (type) of information a consent rule covers. | ||||
| code |
Σ | 0..* | CodeableConcept | e.g. LOINC or SNOMED CT code, etc. in the content Binding: ConsentContentCodes (example): If this code is found in an instance, then the exception applies. | ||||
| dataPeriod |
SΣ | 0..1 | Period | Timeframe for data controlled by this rule | ||||
| Slices for data |
SΣ | 0..* | BackboneElement | Data controlled by this rule Slice: Unordered, Closed by value:meaning | ||||
| data:All Slices |
Content/Rules for all slices | |||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| meaning |
Σ | 1..1 | code | instance | related | dependents | authoredby Binding: ConsentDataMeaning (required): How a resource reference is interpreted when testing consent restrictions. | ||||
| reference |
Σ | 1..1 | Reference(Resource) | The actual data reference | ||||
| data:iDataP |
Σ | 0..1 | BackboneElement | Data controlled by this rule | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| meaning |
Σ | 1..1 | code | instance | related | dependents | authoredby Binding: ConsentDataMeaning (required): How a resource reference is interpreted when testing consent restrictions. Required Pattern: instance | ||||
| reference |
Σ | 1..1 | Reference(Resource) | The actual data reference | ||||
| data:rDataP |
Σ | 0..1 | BackboneElement | Data controlled by this rule | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| meaning |
Σ | 1..1 | code | instance | related | dependents | authoredby Binding: ConsentDataMeaning (required): How a resource reference is interpreted when testing consent restrictions. Required Pattern: related | ||||
| reference |
Σ | 1..1 | Reference(Encounter | CarePlan | EpisodeOfCare) | The actual data reference | ||||
| data:aDataP |
Σ | 0..1 | BackboneElement | Data controlled by this rule | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| meaning |
Σ | 1..1 | code | instance | related | dependents | authoredby Binding: ConsentDataMeaning (required): How a resource reference is interpreted when testing consent restrictions. Required Pattern: authoredby | ||||
| reference |
Σ | 1..1 | Reference(Practitioner | PractitionerRole | Organization | Device | Group | CareTeam | Patient | RelatedPerson) | The actual data reference | ||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet / Code | URI | |||
| Consent.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard | ||||
| Consent.status | required | ConsentStatehttp://hl7.org/fhir/ValueSet/consent-state-codes|4.0.1from the FHIR Standard | ||||
| Consent.scope | extensible | Pattern: patient-privacyhttp://hl7.org/fhir/ValueSet/consent-scopefrom the FHIR Standard | ||||
| Consent.category | extensible | ConsentCategoryCodeshttp://hl7.org/fhir/ValueSet/consent-categoryfrom the FHIR Standard | ||||
| Consent.policyRule | extensible | ConsentPolicyRuleCodeshttp://hl7.org/fhir/ValueSet/consent-policyfrom the FHIR Standard | ||||
| Consent.provision.type | required | ConsentProvisionTypehttp://hl7.org/fhir/ValueSet/consent-provision-type|4.0.1from the FHIR Standard | ||||
| Consent.provision.actor.role | extensible | Pattern: IRCPhttp://hl7.org/fhir/ValueSet/security-role-typefrom the FHIR Standard | ||||
| Consent.provision.purpose | extensible | PurposeOfUsehttp://terminology.hl7.org/ValueSet/v3-PurposeOfUse | ||||
| Consent.provision.data.meaning | required | ConsentDataMeaninghttp://hl7.org/fhir/ValueSet/consent-data-meaning|4.0.1from the FHIR Standard | ||||
| Consent.provision.data:iData.meaning | required | Pattern: instancehttp://hl7.org/fhir/ValueSet/consent-data-meaning|4.0.1from the FHIR Standard | ||||
| Consent.provision.data:rData.meaning | required | Pattern: relatedhttp://hl7.org/fhir/ValueSet/consent-data-meaning|4.0.1from the FHIR Standard | ||||
| Consent.provision.data:aData.meaning | required | Pattern: authoredbyhttp://hl7.org/fhir/ValueSet/consent-data-meaning|4.0.1from the FHIR Standard | ||||
| Consent.provision.provision.type | required | ConsentProvisionTypehttp://hl7.org/fhir/ValueSet/consent-provision-type|4.0.1from the FHIR Standard | ||||
| Consent.provision.provision.actor.role | extensible | SecurityRoleTypehttp://hl7.org/fhir/ValueSet/security-role-typefrom the FHIR Standard | ||||
| Consent.provision.provision.action | example | ConsentActionCodeshttp://hl7.org/fhir/ValueSet/consent-actionfrom the FHIR Standard | ||||
| Consent.provision.provision.securityLabel | extensible | All Security Labelshttp://hl7.org/fhir/ValueSet/security-labelsfrom the FHIR Standard | ||||
| Consent.provision.provision.purpose | extensible | PurposeOfUsehttp://terminology.hl7.org/ValueSet/v3-PurposeOfUse | ||||
| Consent.provision.provision.class | extensible | ConsentContentClasshttp://hl7.org/fhir/ValueSet/consent-content-classfrom the FHIR Standard | ||||
| Consent.provision.provision.code | example | ConsentContentCodes (a valid code from LOINC)http://hl7.org/fhir/ValueSet/consent-content-codefrom the FHIR Standard | ||||
| Consent.provision.provision.data.meaning | required | ConsentDataMeaninghttp://hl7.org/fhir/ValueSet/consent-data-meaning|4.0.1from the FHIR Standard | ||||
| Consent.provision.provision.data:iDataP.meaning | required | Pattern: instancehttp://hl7.org/fhir/ValueSet/consent-data-meaning|4.0.1from the FHIR Standard | ||||
| Consent.provision.provision.data:rDataP.meaning | required | Pattern: relatedhttp://hl7.org/fhir/ValueSet/consent-data-meaning|4.0.1from the FHIR Standard | ||||
| Consent.provision.provision.data:aDataP.meaning | required | Pattern: authoredbyhttp://hl7.org/fhir/ValueSet/consent-data-meaning|4.0.1from the FHIR Standard |
This structure is derived from Consent
Summary
Mandatory: 7 elements(1 nested mandatory element)
Must-Support: 10 elements
Prohibited: 6 elements
Slices
This structure defines the following Slices:
Other representations of profile: CSV, Excel, Schematron
IG © 2023+ IHE IT Infrastructure Technical Committee. Package ihe.iti.pcf#1.1.1-current based on FHIR 4.0.1. Generated 2024-10-21
Links: Table of Contents |
QA Report
| New Issue | Issues
Version History |
|
Propose a change