CH EPR FHIR (R4)
4.0.0-ballot - ballot Switzerland flag

This page is part of the CH EPR FHIR (R4) (v4.0.0-ballot: DSTU 4 Ballot 1) based on FHIR (HL7® FHIR® Standard) R4. This is the current published version in its permanent home (it will always be available at this URL). For a full list of available versions, see the Directory of published versions

Resource Profile: PpqmConsent - Detailed Descriptions

Active as of 2024-05-16

Definitions for the PpqmConsent resource profile.

Guidance on how to interpret the contents of this table can be found here

0. Consent
Invariantsch-epr-ppqm-template-structure: 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'))
2. Consent.identifier
NoteThis is a business identifier, not a resource identifier (see discussion)
Control2..?
SlicingThis element introduces a set of slices on Consent.identifier. The slices areUnordered and Open, and can be differentiated using the following discriminators:
  • pattern @ type.coding
  • 4. Consent.identifier.value
    6. Consent.identifier:policySetId
    Slice NamepolicySetId
    ShortUUID of the Policy Set
    NoteThis is a business identifier, not a resource identifier (see discussion)
    Control1..1
    8. Consent.identifier:policySetId.use
    Control0..0
    10. Consent.identifier:policySetId.type
    Control1..?
    12. Consent.identifier:policySetId.type.coding
    Control1..1
    Pattern Value{
      "system" : "http://fhir.ch/ig/ch-epr-fhir/CodeSystem/PpqmConsentIdentifierType",
      "code" : "policySetId"
    }
    14. Consent.identifier:policySetId.system
    Control0..0
    16. Consent.identifier:policySetId.value
    ShortUUID of the policy set in URN format
    Control1..?
    Invariantsch-epr-ppqm-uuid-format: 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}$'))
    18. Consent.identifier:policySetId.period
    Control0..0
    20. Consent.identifier:policySetId.assigner
    Control0..0
    22. Consent.identifier:templateId
    Slice NametemplateId
    ShortTemplate ID of the policy set
    NoteThis is a business identifier, not a resource identifier (see discussion)
    Control1..1
    24. Consent.identifier:templateId.use
    Control0..0
    26. Consent.identifier:templateId.type
    Control1..?
    28. Consent.identifier:templateId.type.coding
    Control1..1
    Pattern Value{
      "system" : "http://fhir.ch/ig/ch-epr-fhir/CodeSystem/PpqmConsentIdentifierType",
      "code" : "templateId"
    }
    30. Consent.identifier:templateId.system
    Control0..0
    32. Consent.identifier:templateId.value
    ShortTemplate ID of the policy set
    Control1..?
    BindingThe codes SHALL be taken from CH PPQm Policy Set Template ID
    (required to http://fhir.ch/ig/ch-epr-fhir/ValueSet/PpqmPolicySetTemplateId)
    34. Consent.identifier:templateId.period
    Control0..0
    36. Consent.identifier:templateId.assigner
    Control0..0
    38. Consent.status
    ShortFixed status value
    Pattern Valueactive
    40. Consent.scope
    ShortFixed scope value
    Pattern Value{
      "coding" : [{
        "system" : "http://terminology.hl7.org/CodeSystem/consentscope",
        "code" : "patient-privacy"
      }]
    }
    42. Consent.scope.coding
    Control1..1
    44. Consent.category
    ShortFixed category value
    Control0..1
    Pattern Value{
      "coding" : [{
        "system" : "http://terminology.hl7.org/CodeSystem/v3-ActCode",
        "code" : "INFA"
      }]
    }
    46. Consent.category.coding
    Control1..1
    48. Consent.patient
    Control1..?
    50. Consent.patient.reference
    Control0..0
    52. Consent.patient.type
    Control0..0
    54. Consent.patient.identifier
    NoteThis is a business identifier, not a resource identifier (see discussion)
    Control1..?
    TypeIdentifier(EPR-SPID Identifier)
    56. Consent.patient.identifier.use
    Control0..0
    58. Consent.patient.identifier.type
    Control0..0
    60. Consent.patient.identifier.system
    62. Consent.patient.identifier.value
    64. Consent.patient.identifier.period
    Control0..0
    66. Consent.patient.identifier.assigner
    Control0..0
    68. Consent.patient.display
    Control0..0
    70. Consent.dateTime
    Control0..0
    72. Consent.performer
    Control0..0
    74. Consent.organization
    Control0..0
    76. Consent.source[x]
    Control0..0
    78. Consent.policy
    Control0..0
    80. Consent.policyRule
    ShortID of the referenced basis policy set
    Control1..?
    82. Consent.policyRule.coding
    Control1..1
    84. Consent.policyRule.coding.system
    Control1..?
    86. Consent.policyRule.coding.version
    NoteThis is a business version Id, not a resource version Id (see discussion)
    Control0..0
    88. Consent.policyRule.coding.code
    Control1..?
    90. Consent.policyRule.coding.userSelected
    Control0..0
    92. Consent.verification
    Control0..0
    94. Consent.provision
    Control1..?
    96. Consent.provision.type
    Control0..0
    98. Consent.provision.period
    100. Consent.provision.period.start
    ShortStart date of the policy set validity, yyyy-mm-dd
    Invariantsch-epr-ppqm-date-format: Timestamp must have precision of days, i.e. not contain the time part (toString().matches('^[0-9]{4}-[0-9]{2}-[0-9]{2}$'))
    102. Consent.provision.period.end
    ShortEnd date of the policy set validity, yyyy-mm-dd
    Control1..?
    Invariantsch-epr-ppqm-date-format: Timestamp must have precision of days, i.e. not contain the time part (toString().matches('^[0-9]{4}-[0-9]{2}-[0-9]{2}$'))
    104. Consent.provision.actor
    Control1..1
    106. Consent.provision.actor.role
    BindingThe codes SHALL be taken from EprRole
    (required to http://fhir.ch/ig/ch-term/ValueSet/EprRole)
    108. Consent.provision.actor.role.coding
    110. Consent.provision.actor.role.coding.system
    Control1..?
    Pattern Valueurn:oid:2.16.756.5.30.1.127.3.10.6
    112. Consent.provision.actor.role.coding.code
    ShortEPR actor role code
    Control1..?
    114. Consent.provision.actor.reference
    116. Consent.provision.actor.reference.reference
    Control0..0
    118. Consent.provision.actor.reference.type
    Control0..0
    120. Consent.provision.actor.reference.identifier
    ShortThis element is present only in policy sets which reference a particular healthcare professional, group of healthcare professionals, patient, or representative
    NoteThis is a business identifier, not a resource identifier (see discussion)
    122. Consent.provision.actor.reference.identifier.use
    Control0..0
    124. Consent.provision.actor.reference.identifier.type
    Control1..?
    126. Consent.provision.actor.reference.identifier.type.coding
    Control1..1
    BindingThe codes SHALL be taken from CH PPQm Actor Identifier Type
    (required to http://fhir.ch/ig/ch-epr-fhir/ValueSet/PpqmActorIdentifierType)
    128. Consent.provision.actor.reference.identifier.type.coding.system
    Control1..?
    130. Consent.provision.actor.reference.identifier.type.coding.version
    NoteThis is a business version Id, not a resource version Id (see discussion)
    Control0..0
    132. Consent.provision.actor.reference.identifier.type.coding.code
    ShortActor identifier type code (name qualifier)
    Control1..?
    134. Consent.provision.actor.reference.identifier.type.coding.userSelected
    Control0..0
    136. Consent.provision.actor.reference.identifier.type.text
    Control0..0
    138. Consent.provision.actor.reference.identifier.value
    ShortID of an healthcare professional, group of healthcare professionals, patient, or representative
    Control1..?
    140. Consent.provision.actor.reference.identifier.period
    Control0..0
    142. Consent.provision.actor.reference.identifier.assigner
    Control0..0
    144. Consent.provision.actor.reference.display
    ShortThis element is present only in policy sets which reference indefinite sets of actors
    146. Consent.provision.action
    Control0..0
    148. Consent.provision.securityLabel
    Control0..0
    150. Consent.provision.purpose
    BindingThe codes SHALL be taken from EprPurposeOfUse
    (required to http://fhir.ch/ig/ch-term/ValueSet/EprPurposeOfUse)
    152. Consent.provision.purpose.system
    Control1..?
    Pattern Valueurn:oid:2.16.756.5.30.1.127.3.10.5
    154. Consent.provision.purpose.code
    Control1..?
    156. Consent.provision.class
    Control0..0
    158. Consent.provision.code
    Control0..0
    160. Consent.provision.dataPeriod
    Control0..0
    162. Consent.provision.data
    Control0..0
    164. Consent.provision.provision
    Control0..0