CH Core (R4)
7.0.0-ballot - ballot Switzerland flag

CH Core (R4), published by HL7 Switzerland. This guide is not an authorized publication; it is the continuous build for version 7.0.0-ballot built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/hl7ch/ch-core/ and changes regularly. See the Directory of published versions

Resource Profile: CH Core EPR-Consent

Official URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-core-epr-consent Version: 7.0.0-ballot
Active as of 2026-10-21 Computable Name: CHCoreEPRConsent

Copyright/Legal: CC0-1.0

Definition of the Consent resource to document in an external system (outside the EPR) that a patient has an electronic patient record (EPR) in Switzerland. This profile is used by healthcare organizations to track which patients have an EPR. Optionally, specific encounters can be excluded from EPR publication by referencing them in the provision element, documenting the patient's request that certain information should not be published to their EPR.

Note: This profile is NOT used to manage actual consent conditions within the EPR itself - those are managed through proper PPQ Consents (see CH EPR FHIR IG).

Usages:

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

Description Differentials, Snapshots, and other representations.

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Consent C 0..* Consent CH Core EPR-Consent
Constraints: ppc-1, ppc-2, ppc-3, ppc-4, ppc-5
Consent.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
Consent.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
Consent.status This element is a modifier element. This element is included in summaries. 1..1 code draft | proposed | active | rejected | inactive | entered-in-error
Binding: ConsentState (required): Indicates the state of the consent.
Consent.scope This element is a modifier element. This element is included in summaries. 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: 
{
  "coding" : [
    {
      "system" : "http://terminology.hl7.org/CodeSystem/consentscope",
      "code" : "patient-privacy"
    }
  ]
}
Consent.Slices for category This element is included in summaries. 1..* CodeableConcept Classification of the consent statement - for indexing/retrieval
Slice: Unordered, Open by value:coding.code, value:coding.system
Binding: ConsentCategoryCodes (extensible): A classification of the type of consents found in a consent statement.

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Consent.Slices for category.category:VSCat This element is included in summaries. 1..1 CodeableConcept Classification of the consent statement - for indexing/retrieval
Binding: ConsentCategoryCodes (extensible): A classification of the type of consents found in a consent statement.
Consent.Slices for category.category:VSCat.coding This element is included in summaries. 1..* Coding Code defined by a terminology system
Consent.Slices for category.category:VSCat.coding.system This element is included in summaries. 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ActCode (no extensions allowed)
Consent.Slices for category.category:VSCat.coding.code This element is included in summaries. 1..1 code information disclosure
Fixed Value: IDSCL (no extensions allowed)
Consent.patient This element is included in summaries. 1..1 Reference(CH Core Patient) The patient to whom this EPR consent applies
Consent.performer This element is included in summaries. 0..* Reference(CH Core Organization | CH Core Patient | CH Core Practitioner | CH Core RelatedPerson | CH Core PractitionerRole) Who is agreeing to the policy and rules
Consent.organization This element is included in summaries. 0..* Reference(CH Core Organization) Custodian of the consent
Consent.policyRule This element is included in summaries. C 0..1 CodeableConcept Regulation that this consents to
Binding: ConsentPolicyRuleCodes (extensible): Regulatory policy examples.
Required Pattern: 
{
  "coding" : [
    {
      "system" : "http://terminology.hl7.org/CodeSystem/consentpolicycodes",
      "version" : "3.0.1",
      "code" : "ch-epr"
    }
  ]
}
Consent.provision This element is included in summaries. 0..1 BackboneElement Exceptions to the EPR consent
Consent.provision.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Consent.provision.type This element is included in summaries. 1..1 code deny
Binding: ConsentProvisionType (required): How a rule statement is applied, such as adding additional consent or removing consent.
Fixed Value: deny (no extensions allowed)

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Consent.status Base required ConsentState 📍4.0.1 FHIR Std.
Consent.scope Base extensible Consent Scope Codes 📍4.0.1 FHIR Std.
Consent.category Base extensible Consent Category Codes 📍4.0.1 FHIR Std.
Consent.category:VSCat Base extensible Consent Category Codes 📍4.0.1 FHIR Std.
Consent.policyRule Base extensible Consent PolicyRule Codes 📍4.0.1 FHIR Std.
Consent.provision.type Base required ConsentProvisionType 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error Consent If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Consent If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error Consent If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error Consent If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Consent A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
ppc-1 error Consent Either a Policy or PolicyRule policy.exists() or policyRule.exists()
ppc-2 error Consent IF Scope=privacy, there must be a patient patient.exists() or scope.coding.where(system='something' and code='patient-privacy').exists().not()
ppc-3 error Consent IF Scope=research, there must be a patient patient.exists() or scope.coding.where(system='something' and code='research').exists().not()
ppc-4 error Consent IF Scope=adr, there must be a patient patient.exists() or scope.coding.where(system='something' and code='adr').exists().not()
ppc-5 error Consent IF Scope=treatment, there must be a patient patient.exists() or scope.coding.where(system='something' and code='treatment').exists().not()

This structure is derived from Consent

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Consent 0..* Consent CH Core EPR-Consent
Consent.scope 1..1 CodeableConcept Which of the four areas this resource covers (extensible)
Required Pattern: 
{
  "coding" : [
    {
      "system" : "http://terminology.hl7.org/CodeSystem/consentscope",
      "code" : "patient-privacy"
    }
  ]
}
Consent.Slices for category 1..* CodeableConcept Classification of the consent statement - for indexing/retrieval
Slice: Unordered, Open by value:coding.code, value:coding.system
Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Consent.Slices for category.category:VSCat 1..1 CodeableConcept Classification of the consent statement - for indexing/retrieval
Consent.Slices for category.category:VSCat.coding 1..* Coding Code defined by a terminology system
Consent.Slices for category.category:VSCat.coding.system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ActCode (no extensions allowed)
Consent.Slices for category.category:VSCat.coding.code 1..1 code information disclosure
Fixed Value: IDSCL (no extensions allowed)
Consent.patient 1..1 Reference(CH Core Patient) The patient to whom this EPR consent applies
Consent.organization 0..* Reference(CH Core Organization) Custodian of the consent
Consent.policyRule 0..1 CodeableConcept Regulation that this consents to
Required Pattern: 
{
  "coding" : [
    {
      "system" : "http://terminology.hl7.org/CodeSystem/consentpolicycodes",
      "version" : "3.0.1",
      "code" : "ch-epr"
    }
  ]
}
Consent.provision 0..1 BackboneElement Exceptions to the EPR consent
Consent.provision.type 1..1 code deny
Fixed Value: deny (no extensions allowed)
Consent.provision.data
Consent.provision.data.meaning 1..1 code instance | related | dependents | authoredby
Fixed Value: instance (no extensions allowed)
Consent.provision.data.reference 1..1 Reference(CH Core Encounter) Excluded encounter for EPR

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraints    Filter: doco
Consent C 0..* Consent CH Core EPR-Consent
Constraints: ppc-1, ppc-2, ppc-3, ppc-4, ppc-5
Consent.id This element is included in summaries. 0..1 id Logical id of this artifact
Consent.meta This element is included in summaries. 0..1 Meta Metadata about the resource
Consent.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
Consent.language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
Consent.text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
Consent.contained 0..* Resource Contained, inline Resources
Consent.extension 0..* Extension Additional content defined by implementations
Consent.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
Consent.identifier This element is included in summaries. 0..* Identifier Identifier for this record (external references)

Example General: {"system":"http://acme.org/identifier/local/eCMS","value":"Local eCMS identifier"}
Consent.status This element is a modifier element. This element is included in summaries. 1..1 code draft | proposed | active | rejected | inactive | entered-in-error
Binding: ConsentState (required): Indicates the state of the consent.
Consent.scope This element is a modifier element. This element is included in summaries. 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: 
{
  "coding" : [
    {
      "system" : "http://terminology.hl7.org/CodeSystem/consentscope",
      "code" : "patient-privacy"
    }
  ]
}
Consent.Slices for category This element is included in summaries. 1..* CodeableConcept Classification of the consent statement - for indexing/retrieval
Slice: Unordered, Open by value:coding.code, value:coding.system
Binding: ConsentCategoryCodes (extensible): A classification of the type of consents found in a consent statement.

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Consent.Slices for category.category:VSCat This element is included in summaries. 1..1 CodeableConcept Classification of the consent statement - for indexing/retrieval
Binding: ConsentCategoryCodes (extensible): A classification of the type of consents found in a consent statement.
Consent.Slices for category.category:VSCat.id 0..1 string Unique id for inter-element referencing
Consent.Slices for category.category:VSCat.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Consent.Slices for category.category:VSCat.coding This element is included in summaries. 1..* Coding Code defined by a terminology system
Consent.Slices for category.category:VSCat.coding.id 0..1 string Unique id for inter-element referencing
Consent.Slices for category.category:VSCat.coding.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Consent.Slices for category.category:VSCat.coding.system This element is included in summaries. 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ActCode (no extensions allowed)
Consent.Slices for category.category:VSCat.coding.version This element is included in summaries. 0..1 string Version of the system - if relevant
Consent.Slices for category.category:VSCat.coding.code This element is included in summaries. 1..1 code information disclosure
Fixed Value: IDSCL (no extensions allowed)
Consent.Slices for category.category:VSCat.coding.display This element is included in summaries. 0..1 string Representation defined by the system
Consent.Slices for category.category:VSCat.coding.userSelected This element is included in summaries. 0..1 boolean If this coding was chosen directly by the user
Consent.Slices for category.category:VSCat.text This element is included in summaries. 0..1 string Plain text representation of the concept
Consent.patient This element is included in summaries. 1..1 Reference(CH Core Patient) The patient to whom this EPR consent applies
Consent.dateTime This element is included in summaries. 0..1 dateTime When this Consent was created or indexed
Consent.performer This element is included in summaries. 0..* Reference(CH Core Organization | CH Core Patient | CH Core Practitioner | CH Core RelatedPerson | CH Core PractitionerRole) Who is agreeing to the policy and rules
Consent.organization This element is included in summaries. 0..* Reference(CH Core Organization) Custodian of the consent
Consent.source[x] This element is included in summaries. 0..1 Source from which this consent is taken
Consent.source[x].sourceAttachment Attachment
Consent.source[x].sourceReference Reference(Consent | DocumentReference | Contract | QuestionnaireResponse)
Consent.policy 0..* BackboneElement Policies covered by this consent
Consent.policy.id 0..1 string Unique id for inter-element referencing
Consent.policy.extension 0..* Extension Additional content defined by implementations
Consent.policy.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Consent.policy.authority C 0..1 uri Enforcement source for policy
Consent.policy.uri C 0..1 uri Specific policy covered by this consent
Consent.policyRule This element is included in summaries. C 0..1 CodeableConcept Regulation that this consents to
Binding: ConsentPolicyRuleCodes (extensible): Regulatory policy examples.
Required Pattern: 
{
  "coding" : [
    {
      "system" : "http://terminology.hl7.org/CodeSystem/consentpolicycodes",
      "version" : "3.0.1",
      "code" : "ch-epr"
    }
  ]
}
Consent.verification This element is included in summaries. 0..* BackboneElement Consent Verified by patient or family
Consent.verification.id 0..1 string Unique id for inter-element referencing
Consent.verification.extension 0..* Extension Additional content defined by implementations
Consent.verification.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Consent.verification.verified This element is included in summaries. 1..1 boolean Has been verified
Consent.verification.verifiedWith 0..1 Reference(Patient | RelatedPerson) Person who verified
Consent.verification.verificationDate 0..1 dateTime When consent verified
Consent.provision This element is included in summaries. 0..1 BackboneElement Exceptions to the EPR consent
Consent.provision.id 0..1 string Unique id for inter-element referencing
Consent.provision.extension 0..* Extension Additional content defined by implementations
Consent.provision.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Consent.provision.type This element is included in summaries. 1..1 code deny
Binding: ConsentProvisionType (required): How a rule statement is applied, such as adding additional consent or removing consent.
Fixed Value: deny (no extensions allowed)
Consent.provision.period This element is included in summaries. 0..1 Period Timeframe for this rule
Consent.provision.actor 0..* BackboneElement Who|what controlled by this rule (or group, by role)
Consent.provision.actor.id 0..1 string Unique id for inter-element referencing
Consent.provision.actor.extension 0..* Extension Additional content defined by implementations
Consent.provision.actor.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Consent.provision.actor.role 1..1 CodeableConcept How the actor is involved
Binding: SecurityRoleType (extensible): How an actor is involved in the consent considerations.
Consent.provision.actor.reference 1..1 Reference(Device | Group | CareTeam | Organization | Patient | Practitioner | RelatedPerson | PractitionerRole) Resource for the actor (or group, by role)
Consent.provision.action This element is included in summaries. 0..* CodeableConcept Actions controlled by this rule
Binding: ConsentActionCodes (example): Detailed codes for the consent action.
Consent.provision.securityLabel This element is included in summaries. 0..* Coding Security Labels that define affected resources
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
Consent.provision.purpose This element is included in summaries. 0..* Coding Context of activities covered by this rule
Binding: PurposeOfUse (extensible): What purposes of use are controlled by this exception. If more than one label is specified, operations must have all the specified labels.
Consent.provision.class This element is included in summaries. 0..* Coding e.g. Resource Type, Profile, CDA, etc.
Binding: ConsentContentClass (extensible): The class (type) of information a consent rule covers.
Consent.provision.code This element is included in summaries. 0..* CodeableConcept e.g. LOINC or SNOMED CT code, etc. in the content
Binding: ConsentContentCodes (example): If this code is found in an instance, then the exception applies.
Consent.provision.dataPeriod This element is included in summaries. 0..1 Period Timeframe for data controlled by this rule
Consent.provision.data This element is included in summaries. 0..* BackboneElement Data controlled by this rule
Consent.provision.data.id 0..1 string Unique id for inter-element referencing
Consent.provision.data.extension 0..* Extension Additional content defined by implementations
Consent.provision.data.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Consent.provision.data.meaning This element is included in summaries. 1..1 code instance | related | dependents | authoredby
Binding: ConsentDataMeaning (required): How a resource reference is interpreted when testing consent restrictions.
Fixed Value: instance (no extensions allowed)
Consent.provision.data.reference This element is included in summaries. 1..1 Reference(CH Core Encounter) Excluded encounter for EPR
Consent.provision.provision 0..* See provision (Consent) Nested Exception Rules

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Consent.language Base preferred Common Languages 📍4.0.1 FHIR Std.
Consent.status Base required ConsentState 📍4.0.1 FHIR Std.
Consent.scope Base extensible Consent Scope Codes 📍4.0.1 FHIR Std.
Consent.category Base extensible Consent Category Codes 📍4.0.1 FHIR Std.
Consent.category:VSCat Base extensible Consent Category Codes 📍4.0.1 FHIR Std.
Consent.policyRule Base extensible Consent PolicyRule Codes 📍4.0.1 FHIR Std.
Consent.provision.type Base required ConsentProvisionType 📍4.0.1 FHIR Std.
Consent.provision.actor.​role Base extensible SecurityRoleType 📍4.0.1 FHIR Std.
Consent.provision.action Base example Consent Action Codes 📍4.0.1 FHIR Std.
Consent.provision.securityLabel Base extensible SecurityLabels 📍4.0.1 FHIR Std.
Consent.provision.purpose Base extensible PurposeOfUse 📦3.1.0 THO v7.4
Consent.provision.class Base extensible Consent Content Class 📍4.0.1 FHIR Std.
Consent.provision.code Base example Consent Content Codes 📍4.0.1 FHIR Std.
Consent.provision.data.​meaning Base required ConsentDataMeaning 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error Consent If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Consent If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error Consent If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error Consent If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Consent A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
ppc-1 error Consent Either a Policy or PolicyRule policy.exists() or policyRule.exists()
ppc-2 error Consent IF Scope=privacy, there must be a patient patient.exists() or scope.coding.where(system='something' and code='patient-privacy').exists().not()
ppc-3 error Consent IF Scope=research, there must be a patient patient.exists() or scope.coding.where(system='something' and code='research').exists().not()
ppc-4 error Consent IF Scope=adr, there must be a patient patient.exists() or scope.coding.where(system='something' and code='adr').exists().not()
ppc-5 error Consent IF Scope=treatment, there must be a patient patient.exists() or scope.coding.where(system='something' and code='treatment').exists().not()

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Consent C 0..* Consent CH Core EPR-Consent
Constraints: ppc-1, ppc-2, ppc-3, ppc-4, ppc-5
Consent.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
Consent.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
Consent.status This element is a modifier element. This element is included in summaries. 1..1 code draft | proposed | active | rejected | inactive | entered-in-error
Binding: ConsentState (required): Indicates the state of the consent.
Consent.scope This element is a modifier element. This element is included in summaries. 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: 
{
  "coding" : [
    {
      "system" : "http://terminology.hl7.org/CodeSystem/consentscope",
      "code" : "patient-privacy"
    }
  ]
}
Consent.Slices for category This element is included in summaries. 1..* CodeableConcept Classification of the consent statement - for indexing/retrieval
Slice: Unordered, Open by value:coding.code, value:coding.system
Binding: ConsentCategoryCodes (extensible): A classification of the type of consents found in a consent statement.

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Consent.Slices for category.category:VSCat This element is included in summaries. 1..1 CodeableConcept Classification of the consent statement - for indexing/retrieval
Binding: ConsentCategoryCodes (extensible): A classification of the type of consents found in a consent statement.
Consent.Slices for category.category:VSCat.coding This element is included in summaries. 1..* Coding Code defined by a terminology system
Consent.Slices for category.category:VSCat.coding.system This element is included in summaries. 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ActCode (no extensions allowed)
Consent.Slices for category.category:VSCat.coding.code This element is included in summaries. 1..1 code information disclosure
Fixed Value: IDSCL (no extensions allowed)
Consent.patient This element is included in summaries. 1..1 Reference(CH Core Patient) The patient to whom this EPR consent applies
Consent.performer This element is included in summaries. 0..* Reference(CH Core Organization | CH Core Patient | CH Core Practitioner | CH Core RelatedPerson | CH Core PractitionerRole) Who is agreeing to the policy and rules
Consent.organization This element is included in summaries. 0..* Reference(CH Core Organization) Custodian of the consent
Consent.policyRule This element is included in summaries. C 0..1 CodeableConcept Regulation that this consents to
Binding: ConsentPolicyRuleCodes (extensible): Regulatory policy examples.
Required Pattern: 
{
  "coding" : [
    {
      "system" : "http://terminology.hl7.org/CodeSystem/consentpolicycodes",
      "version" : "3.0.1",
      "code" : "ch-epr"
    }
  ]
}
Consent.provision This element is included in summaries. 0..1 BackboneElement Exceptions to the EPR consent
Consent.provision.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Consent.provision.type This element is included in summaries. 1..1 code deny
Binding: ConsentProvisionType (required): How a rule statement is applied, such as adding additional consent or removing consent.
Fixed Value: deny (no extensions allowed)

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Consent.status Base required ConsentState 📍4.0.1 FHIR Std.
Consent.scope Base extensible Consent Scope Codes 📍4.0.1 FHIR Std.
Consent.category Base extensible Consent Category Codes 📍4.0.1 FHIR Std.
Consent.category:VSCat Base extensible Consent Category Codes 📍4.0.1 FHIR Std.
Consent.policyRule Base extensible Consent PolicyRule Codes 📍4.0.1 FHIR Std.
Consent.provision.type Base required ConsentProvisionType 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error Consent If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Consent If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error Consent If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error Consent If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Consent A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
ppc-1 error Consent Either a Policy or PolicyRule policy.exists() or policyRule.exists()
ppc-2 error Consent IF Scope=privacy, there must be a patient patient.exists() or scope.coding.where(system='something' and code='patient-privacy').exists().not()
ppc-3 error Consent IF Scope=research, there must be a patient patient.exists() or scope.coding.where(system='something' and code='research').exists().not()
ppc-4 error Consent IF Scope=adr, there must be a patient patient.exists() or scope.coding.where(system='something' and code='adr').exists().not()
ppc-5 error Consent IF Scope=treatment, there must be a patient patient.exists() or scope.coding.where(system='something' and code='treatment').exists().not()

Differential View

This structure is derived from Consent

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Consent 0..* Consent CH Core EPR-Consent
Consent.scope 1..1 CodeableConcept Which of the four areas this resource covers (extensible)
Required Pattern: 
{
  "coding" : [
    {
      "system" : "http://terminology.hl7.org/CodeSystem/consentscope",
      "code" : "patient-privacy"
    }
  ]
}
Consent.Slices for category 1..* CodeableConcept Classification of the consent statement - for indexing/retrieval
Slice: Unordered, Open by value:coding.code, value:coding.system
Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Consent.Slices for category.category:VSCat 1..1 CodeableConcept Classification of the consent statement - for indexing/retrieval
Consent.Slices for category.category:VSCat.coding 1..* Coding Code defined by a terminology system
Consent.Slices for category.category:VSCat.coding.system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ActCode (no extensions allowed)
Consent.Slices for category.category:VSCat.coding.code 1..1 code information disclosure
Fixed Value: IDSCL (no extensions allowed)
Consent.patient 1..1 Reference(CH Core Patient) The patient to whom this EPR consent applies
Consent.performer 0..* Reference(CH Core Organization | CH Core Patient | CH Core Practitioner | CH Core RelatedPerson | CH Core PractitionerRole) Who is agreeing to the policy and rules
Consent.organization 0..* Reference(CH Core Organization) Custodian of the consent
Consent.policyRule 0..1 CodeableConcept Regulation that this consents to
Required Pattern: 
{
  "coding" : [
    {
      "system" : "http://terminology.hl7.org/CodeSystem/consentpolicycodes",
      "version" : "3.0.1",
      "code" : "ch-epr"
    }
  ]
}
Consent.provision 0..1 BackboneElement Exceptions to the EPR consent
Consent.provision.type 1..1 code deny
Fixed Value: deny (no extensions allowed)
Consent.provision.data
Consent.provision.data.meaning 1..1 code instance | related | dependents | authoredby
Fixed Value: instance (no extensions allowed)
Consent.provision.data.reference 1..1 Reference(CH Core Encounter) Excluded encounter for EPR

doco Documentation for this format

Snapshot ViewView

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Consent C 0..* Consent CH Core EPR-Consent
Constraints: ppc-1, ppc-2, ppc-3, ppc-4, ppc-5
Consent.id This element is included in summaries. 0..1 id Logical id of this artifact
Consent.meta This element is included in summaries. 0..1 Meta Metadata about the resource
Consent.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
Consent.language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
Consent.text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
Consent.contained 0..* Resource Contained, inline Resources
Consent.extension 0..* Extension Additional content defined by implementations
Consent.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
Consent.identifier This element is included in summaries. 0..* Identifier Identifier for this record (external references)

Example General: {"system":"http://acme.org/identifier/local/eCMS","value":"Local eCMS identifier"}
Consent.status This element is a modifier element. This element is included in summaries. 1..1 code draft | proposed | active | rejected | inactive | entered-in-error
Binding: ConsentState (required): Indicates the state of the consent.
Consent.scope This element is a modifier element. This element is included in summaries. 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: 
{
  "coding" : [
    {
      "system" : "http://terminology.hl7.org/CodeSystem/consentscope",
      "code" : "patient-privacy"
    }
  ]
}
Consent.Slices for category This element is included in summaries. 1..* CodeableConcept Classification of the consent statement - for indexing/retrieval
Slice: Unordered, Open by value:coding.code, value:coding.system
Binding: ConsentCategoryCodes (extensible): A classification of the type of consents found in a consent statement.

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Consent.Slices for category.category:VSCat This element is included in summaries. 1..1 CodeableConcept Classification of the consent statement - for indexing/retrieval
Binding: ConsentCategoryCodes (extensible): A classification of the type of consents found in a consent statement.
Consent.Slices for category.category:VSCat.id 0..1 string Unique id for inter-element referencing
Consent.Slices for category.category:VSCat.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Consent.Slices for category.category:VSCat.coding This element is included in summaries. 1..* Coding Code defined by a terminology system
Consent.Slices for category.category:VSCat.coding.id 0..1 string Unique id for inter-element referencing
Consent.Slices for category.category:VSCat.coding.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Consent.Slices for category.category:VSCat.coding.system This element is included in summaries. 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ActCode (no extensions allowed)
Consent.Slices for category.category:VSCat.coding.version This element is included in summaries. 0..1 string Version of the system - if relevant
Consent.Slices for category.category:VSCat.coding.code This element is included in summaries. 1..1 code information disclosure
Fixed Value: IDSCL (no extensions allowed)
Consent.Slices for category.category:VSCat.coding.display This element is included in summaries. 0..1 string Representation defined by the system
Consent.Slices for category.category:VSCat.coding.userSelected This element is included in summaries. 0..1 boolean If this coding was chosen directly by the user
Consent.Slices for category.category:VSCat.text This element is included in summaries. 0..1 string Plain text representation of the concept
Consent.patient This element is included in summaries. 1..1 Reference(CH Core Patient) The patient to whom this EPR consent applies
Consent.dateTime This element is included in summaries. 0..1 dateTime When this Consent was created or indexed
Consent.performer This element is included in summaries. 0..* Reference(CH Core Organization | CH Core Patient | CH Core Practitioner | CH Core RelatedPerson | CH Core PractitionerRole) Who is agreeing to the policy and rules
Consent.organization This element is included in summaries. 0..* Reference(CH Core Organization) Custodian of the consent
Consent.source[x] This element is included in summaries. 0..1 Source from which this consent is taken
Consent.source[x].sourceAttachment Attachment
Consent.source[x].sourceReference Reference(Consent | DocumentReference | Contract | QuestionnaireResponse)
Consent.policy 0..* BackboneElement Policies covered by this consent
Consent.policy.id 0..1 string Unique id for inter-element referencing
Consent.policy.extension 0..* Extension Additional content defined by implementations
Consent.policy.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Consent.policy.authority C 0..1 uri Enforcement source for policy
Consent.policy.uri C 0..1 uri Specific policy covered by this consent
Consent.policyRule This element is included in summaries. C 0..1 CodeableConcept Regulation that this consents to
Binding: ConsentPolicyRuleCodes (extensible): Regulatory policy examples.
Required Pattern: 
{
  "coding" : [
    {
      "system" : "http://terminology.hl7.org/CodeSystem/consentpolicycodes",
      "version" : "3.0.1",
      "code" : "ch-epr"
    }
  ]
}
Consent.verification This element is included in summaries. 0..* BackboneElement Consent Verified by patient or family
Consent.verification.id 0..1 string Unique id for inter-element referencing
Consent.verification.extension 0..* Extension Additional content defined by implementations
Consent.verification.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Consent.verification.verified This element is included in summaries. 1..1 boolean Has been verified
Consent.verification.verifiedWith 0..1 Reference(Patient | RelatedPerson) Person who verified
Consent.verification.verificationDate 0..1 dateTime When consent verified
Consent.provision This element is included in summaries. 0..1 BackboneElement Exceptions to the EPR consent
Consent.provision.id 0..1 string Unique id for inter-element referencing
Consent.provision.extension 0..* Extension Additional content defined by implementations
Consent.provision.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Consent.provision.type This element is included in summaries. 1..1 code deny
Binding: ConsentProvisionType (required): How a rule statement is applied, such as adding additional consent or removing consent.
Fixed Value: deny (no extensions allowed)
Consent.provision.period This element is included in summaries. 0..1 Period Timeframe for this rule
Consent.provision.actor 0..* BackboneElement Who|what controlled by this rule (or group, by role)
Consent.provision.actor.id 0..1 string Unique id for inter-element referencing
Consent.provision.actor.extension 0..* Extension Additional content defined by implementations
Consent.provision.actor.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Consent.provision.actor.role 1..1 CodeableConcept How the actor is involved
Binding: SecurityRoleType (extensible): How an actor is involved in the consent considerations.
Consent.provision.actor.reference 1..1 Reference(Device | Group | CareTeam | Organization | Patient | Practitioner | RelatedPerson | PractitionerRole) Resource for the actor (or group, by role)
Consent.provision.action This element is included in summaries. 0..* CodeableConcept Actions controlled by this rule
Binding: ConsentActionCodes (example): Detailed codes for the consent action.
Consent.provision.securityLabel This element is included in summaries. 0..* Coding Security Labels that define affected resources
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
Consent.provision.purpose This element is included in summaries. 0..* Coding Context of activities covered by this rule
Binding: PurposeOfUse (extensible): What purposes of use are controlled by this exception. If more than one label is specified, operations must have all the specified labels.
Consent.provision.class This element is included in summaries. 0..* Coding e.g. Resource Type, Profile, CDA, etc.
Binding: ConsentContentClass (extensible): The class (type) of information a consent rule covers.
Consent.provision.code This element is included in summaries. 0..* CodeableConcept e.g. LOINC or SNOMED CT code, etc. in the content
Binding: ConsentContentCodes (example): If this code is found in an instance, then the exception applies.
Consent.provision.dataPeriod This element is included in summaries. 0..1 Period Timeframe for data controlled by this rule
Consent.provision.data This element is included in summaries. 0..* BackboneElement Data controlled by this rule
Consent.provision.data.id 0..1 string Unique id for inter-element referencing
Consent.provision.data.extension 0..* Extension Additional content defined by implementations
Consent.provision.data.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Consent.provision.data.meaning This element is included in summaries. 1..1 code instance | related | dependents | authoredby
Binding: ConsentDataMeaning (required): How a resource reference is interpreted when testing consent restrictions.
Fixed Value: instance (no extensions allowed)
Consent.provision.data.reference This element is included in summaries. 1..1 Reference(CH Core Encounter) Excluded encounter for EPR
Consent.provision.provision 0..* See provision (Consent) Nested Exception Rules

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Consent.language Base preferred Common Languages 📍4.0.1 FHIR Std.
Consent.status Base required ConsentState 📍4.0.1 FHIR Std.
Consent.scope Base extensible Consent Scope Codes 📍4.0.1 FHIR Std.
Consent.category Base extensible Consent Category Codes 📍4.0.1 FHIR Std.
Consent.category:VSCat Base extensible Consent Category Codes 📍4.0.1 FHIR Std.
Consent.policyRule Base extensible Consent PolicyRule Codes 📍4.0.1 FHIR Std.
Consent.provision.type Base required ConsentProvisionType 📍4.0.1 FHIR Std.
Consent.provision.actor.​role Base extensible SecurityRoleType 📍4.0.1 FHIR Std.
Consent.provision.action Base example Consent Action Codes 📍4.0.1 FHIR Std.
Consent.provision.securityLabel Base extensible SecurityLabels 📍4.0.1 FHIR Std.
Consent.provision.purpose Base extensible PurposeOfUse 📦3.1.0 THO v7.4
Consent.provision.class Base extensible Consent Content Class 📍4.0.1 FHIR Std.
Consent.provision.code Base example Consent Content Codes 📍4.0.1 FHIR Std.
Consent.provision.data.​meaning Base required ConsentDataMeaning 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error Consent If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Consent If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error Consent If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error Consent If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Consent A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
ppc-1 error Consent Either a Policy or PolicyRule policy.exists() or policyRule.exists()
ppc-2 error Consent IF Scope=privacy, there must be a patient patient.exists() or scope.coding.where(system='something' and code='patient-privacy').exists().not()
ppc-3 error Consent IF Scope=research, there must be a patient patient.exists() or scope.coding.where(system='something' and code='research').exists().not()
ppc-4 error Consent IF Scope=adr, there must be a patient patient.exists() or scope.coding.where(system='something' and code='adr').exists().not()
ppc-5 error Consent IF Scope=treatment, there must be a patient patient.exists() or scope.coding.where(system='something' and code='treatment').exists().not()

 

Other representations of profile: CSV, Excel, Schematron