CH EPR FHIR (R4)
5.0.0-ci-build - ci-build
CH EPR FHIR (R4)
5.0.0-ci-build - ci-build
CH EPR FHIR (R4), published by eHealth Suisse. This guide is not an authorized publication; it is the continuous build for version 5.0.0-ci-build built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/ehealthsuisse/ch-epr-fhir/ and changes regularly. See the Directory of published versions
| Official URL: http://fhir.ch/ig/ch-epr-fhir/StructureDefinition/PpqmConsentTemplate201 | Version: 5.0.0-ci-build | |||
| Active as of 2025-10-20 | Computable Name: PpqmConsentTemplate201 | |||
Copyright/Legal: CC0-1.0 |
||||
EPR policy set based on template 201 – grants the patient the full access to the their EPR. This policy set shall be created during the patient's onboarding.
Usages:
You can also check for usages in the FHIR IG Statistics
Description of Profiles, Differentials, Snapshots and how the different presentations work.
| Name | Flags | Card. | Type | Description & Constraints Filter:   |
|---|---|---|---|---|
  Consent |
C | 0..* | PpqmConsent | A healthcare consumer's choices to permit or deny recipients or roles to perform actions for specific purposes and periods of time Constraints: ppc-1, ppc-2, ppc-3, ppc-4, ppc-5, ch-epr-ppqm-template-structure, ch-epr-ppqm-provision-actor-is-patient, ch-epr-ppqm-patient-references-equal |
  implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
 modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored |
  Slices for identifier |
Σ | 2..* | Identifier | Identifier for this record (external references) Slice: Unordered, Open by value:type.coding Example General: {"system":"http://acme.org/identifier/local/eCMS","value":"Local eCMS identifier"} |
   identifier:policySetId |
Σ | 1..1 | Identifier | UUID of the Policy Set Example General: {"system":"http://acme.org/identifier/local/eCMS","value":"Local eCMS identifier"} |
   type |
Σ | 1..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. |
  coding |
Σ | 1..1 | Coding | Code defined by a terminology system Required Pattern: At least the following |
 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://fhir.ch/ig/ch-epr-fhir/CodeSystem/PpqmConsentIdentifierType | |
| version |
0..1 | string | Version of the system - if relevant | |
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: policySetId | |
| display |
0..1 | string | Representation defined by the system | |
 userSelected |
0..1 | boolean | If this coding was chosen directly by the user | |
 value |
ΣC | 1..1 | string | UUID of the policy set in URN format Constraints: ch-epr-ppqm-uuid-format Example General: 123456 |
 identifier:templateId |
Σ | 1..1 | Identifier | Template ID of the policy set Example General: {"system":"http://acme.org/identifier/local/eCMS","value":"Local eCMS identifier"} |
| type |
Σ | 1..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. |
| coding |
Σ | 1..1 | Coding | Code defined by a terminology system Required Pattern: At least the following |
| 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://fhir.ch/ig/ch-epr-fhir/CodeSystem/PpqmConsentIdentifierType | |
| version |
0..1 | string | Version of the system - if relevant | |
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: templateId | |
| display |
0..1 | string | Representation defined by the system | |
| userSelected |
0..1 | boolean | If this coding was chosen directly by the user | |
| value |
Σ | 1..1 | string | Template ID of the policy set Binding: CH PPQm Policy Set Template ID (required) Required Pattern: 201 |
| status |
?!Σ | 1..1 | code | Fixed status value Binding: ConsentState (required): Indicates the state of the consent. Required Pattern: active |
| scope |
?!Σ | 1..1 | CodeableConcept | Fixed scope value 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 | |
| coding |
Σ | 1..1 | Coding | Code defined by a terminology system |
| category |
Σ | 1..1 | CodeableConcept | Fixed category value Binding: ConsentCategoryCodes (extensible): A classification of the type of consents found in a consent statement. 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-ActCode | |
| version |
0..1 | string | Version of the system - if relevant | |
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: INFA | |
| 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 | |
| coding |
Σ | 1..1 | Coding | Code defined by a terminology system |
 patient |
Σ | 1..1 | Reference(Patient) | Who the consent applies to |
| identifier |
Σ | 1..1 | EPRSPIDIdentifier | Logical reference, when literal reference is not known |
| system |
Σ | 1..1 | uri | The namespace for the identifier value Fixed Value: urn:oid:2.16.756.5.30.1.127.3.10.3 |
| value |
ΣC | 1..1 | string | The value that is unique Constraints: epr-spid-length, epr-spid-startswith76133761, epr-spid-modulus-10 Example General: 123456 |
| policyRule |
ΣC | 1..1 | CodeableConcept | ID of the referenced basis policy set Binding: ConsentPolicyRuleCodes (extensible): Regulatory policy examples. |
| coding |
Σ | 1..1 | Coding | Code defined by a terminology system Binding: CH PPQm Referenced Policy Set for Patients (201) and Representative (303) templates (required) |
| system |
Σ | 1..1 | uri | Identity of the terminology system |
| code |
Σ | 1..1 | code | Symbol in syntax defined by the system |
| provision |
Σ | 1..1 | BackboneElement | Constraints to the base Consent.policyRule |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| actor |
1..1 | 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: EprRole (3.3.0-ci-build) (required) | |
| coding |
Σ | 0..* | Coding | Code defined by a terminology system Required Pattern: At least the following |
| 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: urn:oid:2.16.756.5.30.1.127.3.10.6 | |
| version |
0..1 | string | Version of the system - if relevant | |
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: PAT | |
| display |
0..1 | string | Representation defined by the system | |
| userSelected |
0..1 | boolean | If this coding was chosen directly by the user | |
| system |
Σ | 1..1 | uri | Identity of the terminology system Required Pattern: urn:oid:2.16.756.5.30.1.127.3.10.6 |
| code |
Σ | 1..1 | code | EPR actor role code |
| reference |
1..1 | Reference(Patient) | Resource for the actor (or group, by role) | |
| identifier |
Σ | 0..1 | EPRSPIDIdentifier | This element is present only in policy sets which reference a particular healthcare professional, group of healthcare professionals, patient, or representative |
| type |
Σ | 1..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. |
| coding |
Σ | 1..1 | Coding | Code defined by a terminology system Binding: CH PPQm Actor Identifier Type (required) Required Pattern: At least the following |
| 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: urn:ietf:rfc:3986 | |
| version |
0..1 | string | Version of the system - if relevant | |
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: urn:e-health-suisse:2015:epr-spid | |
| display |
0..1 | string | Representation defined by the system | |
| userSelected |
0..1 | boolean | If this coding was chosen directly by the user | |
| system |
Σ | 1..1 | uri | Identity of the terminology system |
| code |
Σ | 1..1 | code | Actor identifier type code (name qualifier) |
| value |
Σ | 1..1 | string | ID of an healthcare professional, group of healthcare professionals, patient, or representative Example General: 123456 |
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Consent.identifier:policySetId.type | Base | extensible | IdentifierType | 📍4.0.1 | FHIR Std. |
| Consent.identifier:templateId.type | Base | extensible | IdentifierType | 📍4.0.1 | FHIR Std. |
| Consent.identifier:templateId.value | Base | required | CH PPQm Policy Set Template ID | 📦5.0.0-ci-build | This IG |
| 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.policyRule | Base | extensible | Consent PolicyRule Codes | 📍4.0.1 | FHIR Std. |
| Consent.policyRule.coding | Base | required | CH PPQm Referenced Policy Set for Patients (201) and Representative (303) templates | 📦5.0.0-ci-build | This IG |
| Consent.provision.actor.role | Base | required | EprRole | 📍3.3.0-ci-build | CH Term v3.3 |
| Consent.provision.actor.reference.identifier.type | Base | extensible | IdentifierType | 📍4.0.1 | FHIR Std. |
| Consent.provision.actor.reference.identifier.type.coding | Base | required | CH PPQm Actor Identifier Type | 📦5.0.0-ci-build | This IG |
| Consent.provision.data.meaning | Base | required | ConsentDataMeaning | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| ch-epr-ppqm-date-format | error | Consent.provision.period.end | Timestamp must have precision of days, i.e. not contain the time part |
toString().matches('^[0-9]{4}-[0-9]{2}-[0-9]{2}$')
|
| ch-epr-ppqm-patient-references-equal | error | Consent | If literal references are provided for the patient in 201, they shall be equal |
provision[0].actor.reference.reference.empty() or patient.reference.empty() or provision[0].actor.reference.reference = patient.reference
|
| ch-epr-ppqm-provision-actor-is-patient | error | Consent | The provision.actor and patient SHALL be the same |
provision[0].actor.reference.identifier[0].value = patient.identifier.value
|
| ch-epr-ppqm-template-structure | error | Consent | The resource shall correspond to one of official policy set templates |
conformsTo('http://fhir.ch/ig/ch-epr-fhir/StructureDefinition/PpqmConsentTemplate201') or
conformsTo('http://fhir.ch/ig/ch-epr-fhir/StructureDefinition/PpqmConsentTemplate202') or
conformsTo('http://fhir.ch/ig/ch-epr-fhir/StructureDefinition/PpqmConsentTemplate203') or
conformsTo('http://fhir.ch/ig/ch-epr-fhir/StructureDefinition/PpqmConsentTemplate301') or
conformsTo('http://fhir.ch/ig/ch-epr-fhir/StructureDefinition/PpqmConsentTemplate302') or
conformsTo('http://fhir.ch/ig/ch-epr-fhir/StructureDefinition/PpqmConsentTemplate303') or
conformsTo('http://fhir.ch/ig/ch-epr-fhir/StructureDefinition/PpqmConsentTemplate304')
|
| ch-epr-ppqm-uuid-format | error | Consent.identifier:policySetId.value | The policy set ID must be a UUID in URN format |
lower().matches('^urn:uuid:[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$')
|
| 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())
|
| epr-spid-length | warning | Consent.patient.identifier.value | EPR-SPID must be exactly 18 characters long |
matches('^[0-9]{18}$')
|
| epr-spid-modulus-10 | warning | Consent.patient.identifier.value | EPR-SPID must pass the modulus 10 check - https://www.gs1.org/services/how-calculate-check-digit-manually |
(((10-((68+(substring(8,1).toInteger()*3)+(substring(9,1).toInteger()*1)+(substring(10,1).toInteger()*3)+(substring(11,1).toInteger()*1)+(substring(12,1).toInteger()*3)+(substring(13,1).toInteger()*1)+(substring(14,1).toInteger()*3)+(substring(15,1).toInteger()*1)+(substring(16,1).toInteger()*3))mod(10)))mod(10))=substring(17,1).toInteger())
|
| epr-spid-startswith76133761 | warning | Consent.patient.identifier.value | EPR-SPID must start with 76133761 |
startsWith('76133761')
|
| 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 PpqmConsent
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Consent |
C | 0..* | PpqmConsent | A healthcare consumer's choices to permit or deny recipients or roles to perform actions for specific purposes and periods of time Constraints: ch-epr-ppqm-provision-actor-is-patient, ch-epr-ppqm-patient-references-equal |
| Slices for identifier |
Content/Rules for all slices | |||
| identifier:templateId |
1..1 | Identifier | Template ID of the policy set | |
 value |
1..1 | string | Template ID of the policy set Required Pattern: 201 | |
| policyRule |
||||
| coding |
1..1 | Coding | Code defined by a terminology system Binding: CH PPQm Referenced Policy Set for Patients (201) and Representative (303) templates (required) | |
| provision |
||||
| period |
0..0 | |||
| actor |
||||
| role |
||||
| coding |
0..* | Coding | Code defined by a terminology system Required Pattern: At least the following | |
| system |
1..1 | uri | Identity of the terminology system Fixed Value: urn:oid:2.16.756.5.30.1.127.3.10.6 | |
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: PAT | |
| reference |
1..1 | Reference(Patient) | Resource for the actor (or group, by role) | |
| identifier |
0..1 | EPRSPIDIdentifier | This element is present only in policy sets which reference a particular healthcare professional, group of healthcare professionals, patient, or representative | |
| type |
||||
| coding |
1..1 | Coding | Code defined by a terminology system Required Pattern: At least the following | |
| system |
1..1 | uri | Identity of the terminology system Fixed Value: urn:ietf:rfc:3986 | |
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: urn:e-health-suisse:2015:epr-spid | |
| display |
0..0 | |||
| purpose |
0..0 | |||
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Consent.policyRule.coding | Base | required | CH PPQm Referenced Policy Set for Patients (201) and Representative (303) templates | 📦5.0.0-ci-build | This IG |
| Id | Grade | Path(s) | Description | Expression |
| ch-epr-ppqm-patient-references-equal | error | Consent | If literal references are provided for the patient in 201, they shall be equal |
provision[0].actor.reference.reference.empty() or patient.reference.empty() or provision[0].actor.reference.reference = patient.reference
|
| ch-epr-ppqm-provision-actor-is-patient | error | Consent | The provision.actor and patient SHALL be the same |
provision[0].actor.reference.identifier[0].value = patient.identifier.value
|
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| Consent |
C | 0..* | PpqmConsent | A healthcare consumer's choices to permit or deny recipients or roles to perform actions for specific purposes and periods of time Constraints: ppc-1, ppc-2, ppc-3, ppc-4, ppc-5, ch-epr-ppqm-template-structure, ch-epr-ppqm-provision-actor-is-patient, ch-epr-ppqm-patient-references-equal | ||||
| 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 This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||
| contained |
0..* | Resource | Contained, inline Resources | |||||
 extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| Slices for identifier |
Σ | 2..* | Identifier | Identifier for this record (external references) Slice: Unordered, Open by value:type.coding Example General: {"system":"http://acme.org/identifier/local/eCMS","value":"Local eCMS identifier"} | ||||
| identifier:policySetId |
Σ | 1..1 | Identifier | UUID of the Policy Set Example General: {"system":"http://acme.org/identifier/local/eCMS","value":"Local eCMS identifier"} | ||||
 id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| type |
Σ | 1..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| coding |
Σ | 1..1 | Coding | Code defined by a terminology system Required Pattern: At least the following | ||||
| 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://fhir.ch/ig/ch-epr-fhir/CodeSystem/PpqmConsentIdentifierType | |||||
| version |
0..1 | string | Version of the system - if relevant | |||||
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: policySetId | |||||
| 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 | ||||
| value |
ΣC | 1..1 | string | UUID of the policy set in URN format Constraints: ch-epr-ppqm-uuid-format Example General: 123456 | ||||
| identifier:templateId |
Σ | 1..1 | Identifier | Template ID of the policy set Example General: {"system":"http://acme.org/identifier/local/eCMS","value":"Local eCMS identifier"} | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| type |
Σ | 1..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| coding |
Σ | 1..1 | Coding | Code defined by a terminology system Required Pattern: At least the following | ||||
| 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://fhir.ch/ig/ch-epr-fhir/CodeSystem/PpqmConsentIdentifierType | |||||
| version |
0..1 | string | Version of the system - if relevant | |||||
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: templateId | |||||
| 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 | ||||
| value |
Σ | 1..1 | string | Template ID of the policy set Binding: CH PPQm Policy Set Template ID (required) Required Pattern: 201 | ||||
| status |
?!Σ | 1..1 | code | Fixed status value Binding: ConsentState (required): Indicates the state of the consent. Required Pattern: active | ||||
| scope |
?!Σ | 1..1 | CodeableConcept | Fixed scope value 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 | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| coding |
Σ | 1..1 | Coding | Code defined by a terminology system | ||||
| text |
Σ | 0..1 | string | Plain text representation of the concept | ||||
| category |
Σ | 1..1 | CodeableConcept | Fixed category value Binding: ConsentCategoryCodes (extensible): A classification of the type of consents found in a consent statement. 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-ActCode | |||||
| version |
0..1 | string | Version of the system - if relevant | |||||
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: INFA | |||||
| 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 | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| coding |
Σ | 1..1 | Coding | Code defined by a terminology system | ||||
| text |
Σ | 0..1 | string | Plain text representation of the concept | ||||
| patient |
Σ | 1..1 | Reference(Patient) | Who the consent applies to | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| reference |
ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
| type |
Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | ||||
| identifier |
Σ | 1..1 | EPRSPIDIdentifier | Logical reference, when literal reference is not known | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| system |
Σ | 1..1 | uri | The namespace for the identifier value Fixed Value: urn:oid:2.16.756.5.30.1.127.3.10.3 | ||||
| value |
ΣC | 1..1 | string | The value that is unique Constraints: epr-spid-length, epr-spid-startswith76133761, epr-spid-modulus-10 Example General: 123456 | ||||
| policyRule |
ΣC | 1..1 | CodeableConcept | ID of the referenced basis policy set Binding: ConsentPolicyRuleCodes (extensible): Regulatory policy examples. | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| coding |
Σ | 1..1 | Coding | Code defined by a terminology system Binding: CH PPQm Referenced Policy Set for Patients (201) and Representative (303) templates (required) | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| system |
Σ | 1..1 | uri | Identity of the terminology system | ||||
| code |
Σ | 1..1 | code | Symbol in syntax defined by the system | ||||
| display |
Σ | 0..1 | string | Representation defined by the system | ||||
| text |
Σ | 0..1 | string | Plain text representation of the concept | ||||
| provision |
Σ | 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 | ||||
| actor |
1..1 | 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: EprRole (3.3.0-ci-build) (required) | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| coding |
Σ | 0..* | Coding | Code defined by a terminology system Required Pattern: At least the following | ||||
| 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: urn:oid:2.16.756.5.30.1.127.3.10.6 | |||||
| version |
0..1 | string | Version of the system - if relevant | |||||
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: PAT | |||||
| display |
0..1 | string | Representation defined by the system | |||||
| userSelected |
0..1 | boolean | If this coding was chosen directly by the user | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| system |
Σ | 1..1 | uri | Identity of the terminology system Required Pattern: urn:oid:2.16.756.5.30.1.127.3.10.6 | ||||
| version |
Σ | 0..1 | string | Version of the system - if relevant | ||||
| code |
Σ | 1..1 | code | EPR actor role code | ||||
| 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(Patient) | Resource for the actor (or group, by role) | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| reference |
ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
| type |
Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | ||||
| identifier |
Σ | 0..1 | EPRSPIDIdentifier | This element is present only in policy sets which reference a particular healthcare professional, group of healthcare professionals, patient, or representative | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| type |
Σ | 1..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| coding |
Σ | 1..1 | Coding | Code defined by a terminology system Binding: CH PPQm Actor Identifier Type (required) Required Pattern: At least the following | ||||
| 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: urn:ietf:rfc:3986 | |||||
| version |
0..1 | string | Version of the system - if relevant | |||||
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: urn:e-health-suisse:2015:epr-spid | |||||
| display |
0..1 | string | Representation defined by the system | |||||
| userSelected |
0..1 | boolean | If this coding was chosen directly by the user | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| system |
Σ | 1..1 | uri | Identity of the terminology system | ||||
| code |
Σ | 1..1 | code | Actor identifier type code (name qualifier) | ||||
| display |
Σ | 0..1 | string | Representation defined by the system | ||||
| system |
Σ | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
| value |
Σ | 1..1 | string | ID of an healthcare professional, group of healthcare professionals, patient, or representative Example General: 123456 | ||||
| Documentation for this format | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| Consent.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std. |
| Consent.identifier:policySetId.type | Base | extensible | IdentifierType | 📍4.0.1 | FHIR Std. |
| Consent.identifier:templateId.type | Base | extensible | IdentifierType | 📍4.0.1 | FHIR Std. |
| Consent.identifier:templateId.value | Base | required | CH PPQm Policy Set Template ID | 📦5.0.0-ci-build | This IG |
| 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.patient.type | Base | extensible | ResourceType | 📍4.0.1 | FHIR Std. |
| Consent.policyRule | Base | extensible | Consent PolicyRule Codes | 📍4.0.1 | FHIR Std. |
| Consent.policyRule.coding | Base | required | CH PPQm Referenced Policy Set for Patients (201) and Representative (303) templates | 📦5.0.0-ci-build | This IG |
| Consent.provision.actor.role | Base | required | EprRole | 📍3.3.0-ci-build | CH Term v3.3 |
| Consent.provision.actor.reference.type | Base | extensible | ResourceType | 📍4.0.1 | FHIR Std. |
| Consent.provision.actor.reference.identifier.type | Base | extensible | IdentifierType | 📍4.0.1 | FHIR Std. |
| Consent.provision.actor.reference.identifier.type.coding | Base | required | CH PPQm Actor Identifier Type | 📦5.0.0-ci-build | This IG |
| Consent.provision.data.meaning | Base | required | ConsentDataMeaning | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| ch-epr-ppqm-date-format | error | Consent.provision.period.start, Consent.provision.period.end | Timestamp must have precision of days, i.e. not contain the time part |
toString().matches('^[0-9]{4}-[0-9]{2}-[0-9]{2}$')
|
| ch-epr-ppqm-patient-references-equal | error | Consent | If literal references are provided for the patient in 201, they shall be equal |
provision[0].actor.reference.reference.empty() or patient.reference.empty() or provision[0].actor.reference.reference = patient.reference
|
| ch-epr-ppqm-provision-actor-is-patient | error | Consent | The provision.actor and patient SHALL be the same |
provision[0].actor.reference.identifier[0].value = patient.identifier.value
|
| ch-epr-ppqm-template-structure | error | Consent | The resource shall correspond to one of official policy set templates |
conformsTo('http://fhir.ch/ig/ch-epr-fhir/StructureDefinition/PpqmConsentTemplate201') or
conformsTo('http://fhir.ch/ig/ch-epr-fhir/StructureDefinition/PpqmConsentTemplate202') or
conformsTo('http://fhir.ch/ig/ch-epr-fhir/StructureDefinition/PpqmConsentTemplate203') or
conformsTo('http://fhir.ch/ig/ch-epr-fhir/StructureDefinition/PpqmConsentTemplate301') or
conformsTo('http://fhir.ch/ig/ch-epr-fhir/StructureDefinition/PpqmConsentTemplate302') or
conformsTo('http://fhir.ch/ig/ch-epr-fhir/StructureDefinition/PpqmConsentTemplate303') or
conformsTo('http://fhir.ch/ig/ch-epr-fhir/StructureDefinition/PpqmConsentTemplate304')
|
| ch-epr-ppqm-uuid-format | error | Consent.identifier:policySetId.value | The policy set ID must be a UUID in URN format |
lower().matches('^urn:uuid:[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$')
|
| 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())
|
| epr-spid-length | warning | Consent.patient.identifier.value | EPR-SPID must be exactly 18 characters long |
matches('^[0-9]{18}$')
|
| epr-spid-modulus-10 | warning | Consent.patient.identifier.value | EPR-SPID must pass the modulus 10 check - https://www.gs1.org/services/how-calculate-check-digit-manually |
(((10-((68+(substring(8,1).toInteger()*3)+(substring(9,1).toInteger()*1)+(substring(10,1).toInteger()*3)+(substring(11,1).toInteger()*1)+(substring(12,1).toInteger()*3)+(substring(13,1).toInteger()*1)+(substring(14,1).toInteger()*3)+(substring(15,1).toInteger()*1)+(substring(16,1).toInteger()*3))mod(10)))mod(10))=substring(17,1).toInteger())
|
| epr-spid-startswith76133761 | warning | Consent.patient.identifier.value | EPR-SPID must start with 76133761 |
startsWith('76133761')
|
| 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 PpqmConsent
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Consent |
C | 0..* | PpqmConsent | A healthcare consumer's choices to permit or deny recipients or roles to perform actions for specific purposes and periods of time Constraints: ppc-1, ppc-2, ppc-3, ppc-4, ppc-5, ch-epr-ppqm-template-structure, ch-epr-ppqm-provision-actor-is-patient, ch-epr-ppqm-patient-references-equal |
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored |
| Slices for identifier |
Σ | 2..* | Identifier | Identifier for this record (external references) Slice: Unordered, Open by value:type.coding Example General: {"system":"http://acme.org/identifier/local/eCMS","value":"Local eCMS identifier"} |
| identifier:policySetId |
Σ | 1..1 | Identifier | UUID of the Policy Set Example General: {"system":"http://acme.org/identifier/local/eCMS","value":"Local eCMS identifier"} |
| type |
Σ | 1..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. |
| coding |
Σ | 1..1 | Coding | Code defined by a terminology system Required Pattern: At least the following |
| 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://fhir.ch/ig/ch-epr-fhir/CodeSystem/PpqmConsentIdentifierType | |
| version |
0..1 | string | Version of the system - if relevant | |
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: policySetId | |
| display |
0..1 | string | Representation defined by the system | |
| userSelected |
0..1 | boolean | If this coding was chosen directly by the user | |
| value |
ΣC | 1..1 | string | UUID of the policy set in URN format Constraints: ch-epr-ppqm-uuid-format Example General: 123456 |
| identifier:templateId |
Σ | 1..1 | Identifier | Template ID of the policy set Example General: {"system":"http://acme.org/identifier/local/eCMS","value":"Local eCMS identifier"} |
| type |
Σ | 1..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. |
| coding |
Σ | 1..1 | Coding | Code defined by a terminology system Required Pattern: At least the following |
| 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://fhir.ch/ig/ch-epr-fhir/CodeSystem/PpqmConsentIdentifierType | |
| version |
0..1 | string | Version of the system - if relevant | |
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: templateId | |
| display |
0..1 | string | Representation defined by the system | |
| userSelected |
0..1 | boolean | If this coding was chosen directly by the user | |
| value |
Σ | 1..1 | string | Template ID of the policy set Binding: CH PPQm Policy Set Template ID (required) Required Pattern: 201 |
| status |
?!Σ | 1..1 | code | Fixed status value Binding: ConsentState (required): Indicates the state of the consent. Required Pattern: active |
| scope |
?!Σ | 1..1 | CodeableConcept | Fixed scope value 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 | |
| coding |
Σ | 1..1 | Coding | Code defined by a terminology system |
| category |
Σ | 1..1 | CodeableConcept | Fixed category value Binding: ConsentCategoryCodes (extensible): A classification of the type of consents found in a consent statement. 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-ActCode | |
| version |
0..1 | string | Version of the system - if relevant | |
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: INFA | |
| 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 | |
| coding |
Σ | 1..1 | Coding | Code defined by a terminology system |
| patient |
Σ | 1..1 | Reference(Patient) | Who the consent applies to |
| identifier |
Σ | 1..1 | EPRSPIDIdentifier | Logical reference, when literal reference is not known |
| system |
Σ | 1..1 | uri | The namespace for the identifier value Fixed Value: urn:oid:2.16.756.5.30.1.127.3.10.3 |
| value |
ΣC | 1..1 | string | The value that is unique Constraints: epr-spid-length, epr-spid-startswith76133761, epr-spid-modulus-10 Example General: 123456 |
| policyRule |
ΣC | 1..1 | CodeableConcept | ID of the referenced basis policy set Binding: ConsentPolicyRuleCodes (extensible): Regulatory policy examples. |
| coding |
Σ | 1..1 | Coding | Code defined by a terminology system Binding: CH PPQm Referenced Policy Set for Patients (201) and Representative (303) templates (required) |
| system |
Σ | 1..1 | uri | Identity of the terminology system |
| code |
Σ | 1..1 | code | Symbol in syntax defined by the system |
| provision |
Σ | 1..1 | BackboneElement | Constraints to the base Consent.policyRule |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| actor |
1..1 | 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: EprRole (3.3.0-ci-build) (required) | |
| coding |
Σ | 0..* | Coding | Code defined by a terminology system Required Pattern: At least the following |
| 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: urn:oid:2.16.756.5.30.1.127.3.10.6 | |
| version |
0..1 | string | Version of the system - if relevant | |
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: PAT | |
| display |
0..1 | string | Representation defined by the system | |
| userSelected |
0..1 | boolean | If this coding was chosen directly by the user | |
| system |
Σ | 1..1 | uri | Identity of the terminology system Required Pattern: urn:oid:2.16.756.5.30.1.127.3.10.6 |
| code |
Σ | 1..1 | code | EPR actor role code |
| reference |
1..1 | Reference(Patient) | Resource for the actor (or group, by role) | |
| identifier |
Σ | 0..1 | EPRSPIDIdentifier | This element is present only in policy sets which reference a particular healthcare professional, group of healthcare professionals, patient, or representative |
| type |
Σ | 1..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. |
| coding |
Σ | 1..1 | Coding | Code defined by a terminology system Binding: CH PPQm Actor Identifier Type (required) Required Pattern: At least the following |
| 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: urn:ietf:rfc:3986 | |
| version |
0..1 | string | Version of the system - if relevant | |
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: urn:e-health-suisse:2015:epr-spid | |
| display |
0..1 | string | Representation defined by the system | |
| userSelected |
0..1 | boolean | If this coding was chosen directly by the user | |
| system |
Σ | 1..1 | uri | Identity of the terminology system |
| code |
Σ | 1..1 | code | Actor identifier type code (name qualifier) |
| value |
Σ | 1..1 | string | ID of an healthcare professional, group of healthcare professionals, patient, or representative Example General: 123456 |
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Consent.identifier:policySetId.type | Base | extensible | IdentifierType | 📍4.0.1 | FHIR Std. |
| Consent.identifier:templateId.type | Base | extensible | IdentifierType | 📍4.0.1 | FHIR Std. |
| Consent.identifier:templateId.value | Base | required | CH PPQm Policy Set Template ID | 📦5.0.0-ci-build | This IG |
| 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.policyRule | Base | extensible | Consent PolicyRule Codes | 📍4.0.1 | FHIR Std. |
| Consent.policyRule.coding | Base | required | CH PPQm Referenced Policy Set for Patients (201) and Representative (303) templates | 📦5.0.0-ci-build | This IG |
| Consent.provision.actor.role | Base | required | EprRole | 📍3.3.0-ci-build | CH Term v3.3 |
| Consent.provision.actor.reference.identifier.type | Base | extensible | IdentifierType | 📍4.0.1 | FHIR Std. |
| Consent.provision.actor.reference.identifier.type.coding | Base | required | CH PPQm Actor Identifier Type | 📦5.0.0-ci-build | This IG |
| Consent.provision.data.meaning | Base | required | ConsentDataMeaning | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| ch-epr-ppqm-date-format | error | Consent.provision.period.end | Timestamp must have precision of days, i.e. not contain the time part |
toString().matches('^[0-9]{4}-[0-9]{2}-[0-9]{2}$')
|
| ch-epr-ppqm-patient-references-equal | error | Consent | If literal references are provided for the patient in 201, they shall be equal |
provision[0].actor.reference.reference.empty() or patient.reference.empty() or provision[0].actor.reference.reference = patient.reference
|
| ch-epr-ppqm-provision-actor-is-patient | error | Consent | The provision.actor and patient SHALL be the same |
provision[0].actor.reference.identifier[0].value = patient.identifier.value
|
| ch-epr-ppqm-template-structure | error | Consent | The resource shall correspond to one of official policy set templates |
conformsTo('http://fhir.ch/ig/ch-epr-fhir/StructureDefinition/PpqmConsentTemplate201') or
conformsTo('http://fhir.ch/ig/ch-epr-fhir/StructureDefinition/PpqmConsentTemplate202') or
conformsTo('http://fhir.ch/ig/ch-epr-fhir/StructureDefinition/PpqmConsentTemplate203') or
conformsTo('http://fhir.ch/ig/ch-epr-fhir/StructureDefinition/PpqmConsentTemplate301') or
conformsTo('http://fhir.ch/ig/ch-epr-fhir/StructureDefinition/PpqmConsentTemplate302') or
conformsTo('http://fhir.ch/ig/ch-epr-fhir/StructureDefinition/PpqmConsentTemplate303') or
conformsTo('http://fhir.ch/ig/ch-epr-fhir/StructureDefinition/PpqmConsentTemplate304')
|
| ch-epr-ppqm-uuid-format | error | Consent.identifier:policySetId.value | The policy set ID must be a UUID in URN format |
lower().matches('^urn:uuid:[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$')
|
| 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())
|
| epr-spid-length | warning | Consent.patient.identifier.value | EPR-SPID must be exactly 18 characters long |
matches('^[0-9]{18}$')
|
| epr-spid-modulus-10 | warning | Consent.patient.identifier.value | EPR-SPID must pass the modulus 10 check - https://www.gs1.org/services/how-calculate-check-digit-manually |
(((10-((68+(substring(8,1).toInteger()*3)+(substring(9,1).toInteger()*1)+(substring(10,1).toInteger()*3)+(substring(11,1).toInteger()*1)+(substring(12,1).toInteger()*3)+(substring(13,1).toInteger()*1)+(substring(14,1).toInteger()*3)+(substring(15,1).toInteger()*1)+(substring(16,1).toInteger()*3))mod(10)))mod(10))=substring(17,1).toInteger())
|
| epr-spid-startswith76133761 | warning | Consent.patient.identifier.value | EPR-SPID must start with 76133761 |
startsWith('76133761')
|
| 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 PpqmConsent
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Consent |
C | 0..* | PpqmConsent | A healthcare consumer's choices to permit or deny recipients or roles to perform actions for specific purposes and periods of time Constraints: ch-epr-ppqm-provision-actor-is-patient, ch-epr-ppqm-patient-references-equal |
| Slices for identifier |
Content/Rules for all slices | |||
| identifier:templateId |
1..1 | Identifier | Template ID of the policy set | |
| value |
1..1 | string | Template ID of the policy set Required Pattern: 201 | |
| policyRule |
||||
| coding |
1..1 | Coding | Code defined by a terminology system Binding: CH PPQm Referenced Policy Set for Patients (201) and Representative (303) templates (required) | |
| provision |
||||
| period |
0..0 | |||
| actor |
||||
| role |
||||
| coding |
0..* | Coding | Code defined by a terminology system Required Pattern: At least the following | |
| system |
1..1 | uri | Identity of the terminology system Fixed Value: urn:oid:2.16.756.5.30.1.127.3.10.6 | |
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: PAT | |
| reference |
1..1 | Reference(Patient) | Resource for the actor (or group, by role) | |
| identifier |
0..1 | EPRSPIDIdentifier | This element is present only in policy sets which reference a particular healthcare professional, group of healthcare professionals, patient, or representative | |
| type |
||||
| coding |
1..1 | Coding | Code defined by a terminology system Required Pattern: At least the following | |
| system |
1..1 | uri | Identity of the terminology system Fixed Value: urn:ietf:rfc:3986 | |
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: urn:e-health-suisse:2015:epr-spid | |
| display |
0..0 | |||
| purpose |
0..0 | |||
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Consent.policyRule.coding | Base | required | CH PPQm Referenced Policy Set for Patients (201) and Representative (303) templates | 📦5.0.0-ci-build | This IG |
| Id | Grade | Path(s) | Description | Expression |
| ch-epr-ppqm-patient-references-equal | error | Consent | If literal references are provided for the patient in 201, they shall be equal |
provision[0].actor.reference.reference.empty() or patient.reference.empty() or provision[0].actor.reference.reference = patient.reference
|
| ch-epr-ppqm-provision-actor-is-patient | error | Consent | The provision.actor and patient SHALL be the same |
provision[0].actor.reference.identifier[0].value = patient.identifier.value
|
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| Consent |
C | 0..* | PpqmConsent | A healthcare consumer's choices to permit or deny recipients or roles to perform actions for specific purposes and periods of time Constraints: ppc-1, ppc-2, ppc-3, ppc-4, ppc-5, ch-epr-ppqm-template-structure, ch-epr-ppqm-provision-actor-is-patient, ch-epr-ppqm-patient-references-equal | ||||
| 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 This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||
| contained |
0..* | Resource | Contained, inline Resources | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| Slices for identifier |
Σ | 2..* | Identifier | Identifier for this record (external references) Slice: Unordered, Open by value:type.coding Example General: {"system":"http://acme.org/identifier/local/eCMS","value":"Local eCMS identifier"} | ||||
| identifier:policySetId |
Σ | 1..1 | Identifier | UUID of the Policy Set Example General: {"system":"http://acme.org/identifier/local/eCMS","value":"Local eCMS identifier"} | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| type |
Σ | 1..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| coding |
Σ | 1..1 | Coding | Code defined by a terminology system Required Pattern: At least the following | ||||
| 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://fhir.ch/ig/ch-epr-fhir/CodeSystem/PpqmConsentIdentifierType | |||||
| version |
0..1 | string | Version of the system - if relevant | |||||
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: policySetId | |||||
| 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 | ||||
| value |
ΣC | 1..1 | string | UUID of the policy set in URN format Constraints: ch-epr-ppqm-uuid-format Example General: 123456 | ||||
| identifier:templateId |
Σ | 1..1 | Identifier | Template ID of the policy set Example General: {"system":"http://acme.org/identifier/local/eCMS","value":"Local eCMS identifier"} | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| type |
Σ | 1..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| coding |
Σ | 1..1 | Coding | Code defined by a terminology system Required Pattern: At least the following | ||||
| 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://fhir.ch/ig/ch-epr-fhir/CodeSystem/PpqmConsentIdentifierType | |||||
| version |
0..1 | string | Version of the system - if relevant | |||||
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: templateId | |||||
| 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 | ||||
| value |
Σ | 1..1 | string | Template ID of the policy set Binding: CH PPQm Policy Set Template ID (required) Required Pattern: 201 | ||||
| status |
?!Σ | 1..1 | code | Fixed status value Binding: ConsentState (required): Indicates the state of the consent. Required Pattern: active | ||||
| scope |
?!Σ | 1..1 | CodeableConcept | Fixed scope value 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 | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| coding |
Σ | 1..1 | Coding | Code defined by a terminology system | ||||
| text |
Σ | 0..1 | string | Plain text representation of the concept | ||||
| category |
Σ | 1..1 | CodeableConcept | Fixed category value Binding: ConsentCategoryCodes (extensible): A classification of the type of consents found in a consent statement. 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-ActCode | |||||
| version |
0..1 | string | Version of the system - if relevant | |||||
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: INFA | |||||
| 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 | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| coding |
Σ | 1..1 | Coding | Code defined by a terminology system | ||||
| text |
Σ | 0..1 | string | Plain text representation of the concept | ||||
| patient |
Σ | 1..1 | Reference(Patient) | Who the consent applies to | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| reference |
ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
| type |
Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | ||||
| identifier |
Σ | 1..1 | EPRSPIDIdentifier | Logical reference, when literal reference is not known | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| system |
Σ | 1..1 | uri | The namespace for the identifier value Fixed Value: urn:oid:2.16.756.5.30.1.127.3.10.3 | ||||
| value |
ΣC | 1..1 | string | The value that is unique Constraints: epr-spid-length, epr-spid-startswith76133761, epr-spid-modulus-10 Example General: 123456 | ||||
| policyRule |
ΣC | 1..1 | CodeableConcept | ID of the referenced basis policy set Binding: ConsentPolicyRuleCodes (extensible): Regulatory policy examples. | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| coding |
Σ | 1..1 | Coding | Code defined by a terminology system Binding: CH PPQm Referenced Policy Set for Patients (201) and Representative (303) templates (required) | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| system |
Σ | 1..1 | uri | Identity of the terminology system | ||||
| code |
Σ | 1..1 | code | Symbol in syntax defined by the system | ||||
| display |
Σ | 0..1 | string | Representation defined by the system | ||||
| text |
Σ | 0..1 | string | Plain text representation of the concept | ||||
| provision |
Σ | 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 | ||||
| actor |
1..1 | 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: EprRole (3.3.0-ci-build) (required) | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| coding |
Σ | 0..* | Coding | Code defined by a terminology system Required Pattern: At least the following | ||||
| 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: urn:oid:2.16.756.5.30.1.127.3.10.6 | |||||
| version |
0..1 | string | Version of the system - if relevant | |||||
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: PAT | |||||
| display |
0..1 | string | Representation defined by the system | |||||
| userSelected |
0..1 | boolean | If this coding was chosen directly by the user | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| system |
Σ | 1..1 | uri | Identity of the terminology system Required Pattern: urn:oid:2.16.756.5.30.1.127.3.10.6 | ||||
| version |
Σ | 0..1 | string | Version of the system - if relevant | ||||
| code |
Σ | 1..1 | code | EPR actor role code | ||||
| 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(Patient) | Resource for the actor (or group, by role) | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| reference |
ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
| type |
Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | ||||
| identifier |
Σ | 0..1 | EPRSPIDIdentifier | This element is present only in policy sets which reference a particular healthcare professional, group of healthcare professionals, patient, or representative | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| type |
Σ | 1..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| coding |
Σ | 1..1 | Coding | Code defined by a terminology system Binding: CH PPQm Actor Identifier Type (required) Required Pattern: At least the following | ||||
| 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: urn:ietf:rfc:3986 | |||||
| version |
0..1 | string | Version of the system - if relevant | |||||
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: urn:e-health-suisse:2015:epr-spid | |||||
| display |
0..1 | string | Representation defined by the system | |||||
| userSelected |
0..1 | boolean | If this coding was chosen directly by the user | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| system |
Σ | 1..1 | uri | Identity of the terminology system | ||||
| code |
Σ | 1..1 | code | Actor identifier type code (name qualifier) | ||||
| display |
Σ | 0..1 | string | Representation defined by the system | ||||
| system |
Σ | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
| value |
Σ | 1..1 | string | ID of an healthcare professional, group of healthcare professionals, patient, or representative Example General: 123456 | ||||
| Documentation for this format | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| Consent.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std. |
| Consent.identifier:policySetId.type | Base | extensible | IdentifierType | 📍4.0.1 | FHIR Std. |
| Consent.identifier:templateId.type | Base | extensible | IdentifierType | 📍4.0.1 | FHIR Std. |
| Consent.identifier:templateId.value | Base | required | CH PPQm Policy Set Template ID | 📦5.0.0-ci-build | This IG |
| 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.patient.type | Base | extensible | ResourceType | 📍4.0.1 | FHIR Std. |
| Consent.policyRule | Base | extensible | Consent PolicyRule Codes | 📍4.0.1 | FHIR Std. |
| Consent.policyRule.coding | Base | required | CH PPQm Referenced Policy Set for Patients (201) and Representative (303) templates | 📦5.0.0-ci-build | This IG |
| Consent.provision.actor.role | Base | required | EprRole | 📍3.3.0-ci-build | CH Term v3.3 |
| Consent.provision.actor.reference.type | Base | extensible | ResourceType | 📍4.0.1 | FHIR Std. |
| Consent.provision.actor.reference.identifier.type | Base | extensible | IdentifierType | 📍4.0.1 | FHIR Std. |
| Consent.provision.actor.reference.identifier.type.coding | Base | required | CH PPQm Actor Identifier Type | 📦5.0.0-ci-build | This IG |
| Consent.provision.data.meaning | Base | required | ConsentDataMeaning | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| ch-epr-ppqm-date-format | error | Consent.provision.period.start, Consent.provision.period.end | Timestamp must have precision of days, i.e. not contain the time part |
toString().matches('^[0-9]{4}-[0-9]{2}-[0-9]{2}$')
|
| ch-epr-ppqm-patient-references-equal | error | Consent | If literal references are provided for the patient in 201, they shall be equal |
provision[0].actor.reference.reference.empty() or patient.reference.empty() or provision[0].actor.reference.reference = patient.reference
|
| ch-epr-ppqm-provision-actor-is-patient | error | Consent | The provision.actor and patient SHALL be the same |
provision[0].actor.reference.identifier[0].value = patient.identifier.value
|
| ch-epr-ppqm-template-structure | error | Consent | The resource shall correspond to one of official policy set templates |
conformsTo('http://fhir.ch/ig/ch-epr-fhir/StructureDefinition/PpqmConsentTemplate201') or
conformsTo('http://fhir.ch/ig/ch-epr-fhir/StructureDefinition/PpqmConsentTemplate202') or
conformsTo('http://fhir.ch/ig/ch-epr-fhir/StructureDefinition/PpqmConsentTemplate203') or
conformsTo('http://fhir.ch/ig/ch-epr-fhir/StructureDefinition/PpqmConsentTemplate301') or
conformsTo('http://fhir.ch/ig/ch-epr-fhir/StructureDefinition/PpqmConsentTemplate302') or
conformsTo('http://fhir.ch/ig/ch-epr-fhir/StructureDefinition/PpqmConsentTemplate303') or
conformsTo('http://fhir.ch/ig/ch-epr-fhir/StructureDefinition/PpqmConsentTemplate304')
|
| ch-epr-ppqm-uuid-format | error | Consent.identifier:policySetId.value | The policy set ID must be a UUID in URN format |
lower().matches('^urn:uuid:[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$')
|
| 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())
|
| epr-spid-length | warning | Consent.patient.identifier.value | EPR-SPID must be exactly 18 characters long |
matches('^[0-9]{18}$')
|
| epr-spid-modulus-10 | warning | Consent.patient.identifier.value | EPR-SPID must pass the modulus 10 check - https://www.gs1.org/services/how-calculate-check-digit-manually |
(((10-((68+(substring(8,1).toInteger()*3)+(substring(9,1).toInteger()*1)+(substring(10,1).toInteger()*3)+(substring(11,1).toInteger()*1)+(substring(12,1).toInteger()*3)+(substring(13,1).toInteger()*1)+(substring(14,1).toInteger()*3)+(substring(15,1).toInteger()*1)+(substring(16,1).toInteger()*3))mod(10)))mod(10))=substring(17,1).toInteger())
|
| epr-spid-startswith76133761 | warning | Consent.patient.identifier.value | EPR-SPID must start with 76133761 |
startsWith('76133761')
|
| 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 PpqmConsent
Other representations of profile: CSV, Excel, Schematron