description: 'This profile defines the content of the document audit events which a community has to provide for a patients audit trail. '
package_name: ch.fhir.ig.ch-atc
derivation: constraint
name: DocumentAuditEvent
type: AuditEvent
elements:
  type:
    short: Type/identifier of event
    type: Coding
    binding: {strength: extensible, valueSet: 'http://hl7.org/fhir/ValueSet/audit-event-type'}
    index: 0
  subtype:
    type: Coding
    array: true
    min: 1
    index: 1
    slicing:
      rules: open
      discriminator:
      - {path: system, type: value}
      min: 1
      slices:
        DocumentAuditEventType:
          match: {system: 'urn:oid:2.16.756.5.30.1.127.3.10.7'}
          schema:
            short: DocumentAuditEventType
            binding: {strength: required, valueSet: 'http://fhir.ch/ig/ch-atc/ValueSet/DocumentAuditEventType'}
            _required: true
            index: 2
            elements:
              system:
                pattern: {type: Uri, value: 'urn:oid:2.16.756.5.30.1.127.3.10.7'}
                index: 3
            required: [system]
  recorded: {short: Time when the event was recorded, type: instant, index: 4}
  purposeOfEvent:
    short: The purposeOfUse of the event
    type: CodeableConcept
    binding: {strength: required, valueSet: 'http://fhir.ch/ig/ch-epr-term/ValueSet/EprPurposeOfUse'}
    index: 5
  agent:
    min: 1
    short: Participants
    type: BackboneElement
    array: true
    index: 6
    elements:
      role:
        short: Agent role in the event
        type: CodeableConcept
        binding: {strength: required, valueSet: 'http://fhir.ch/ig/ch-atc/ValueSet/EprParticipant'}
        index: 7
      who:
        short: Identifier of who
        refers: ['http://hl7.org/fhir/StructureDefinition/Device', 'http://hl7.org/fhir/StructureDefinition/Organization', 'http://hl7.org/fhir/StructureDefinition/Patient', 'http://hl7.org/fhir/StructureDefinition/Practitioner', 'http://hl7.org/fhir/StructureDefinition/PractitionerRole', 'http://hl7.org/fhir/StructureDefinition/RelatedPerson']
        type: Reference
        index: 8
      name: {short: Human-meaningful name for the agent, type: string, index: 9}
      requestor: {short: Whether user is initiator, type: boolean, index: 10}
    required: [role, requestor, name]
  entity:
    constraint:
      sev-1: {human: Either a name or a query (NOT both), severity: error, expression: name.empty() or query.empty()}
    short: Data or objects used
    type: BackboneElement
    array: true
    index: 11
    slicing:
      rules: open
      discriminator:
      - {path: type.code, type: value}
      - {path: role.code, type: value}
      min: 0
      slices:
        Patient:
          match:
            type: {code: '1'}
            role: {code: '1'}
          schema:
            short: Patient
            _required: true
            index: 12
            elements:
              what:
                elements:
                  identifier:
                    short: Patient Id (EPR-SPID)
                    type: Identifier
                    index: 13
                    elements:
                      system:
                        pattern: {type: Uri, value: 'urn:oid:2.16.756.5.30.1.127.3.10.3'}
                        index: 14
                    required: [system]
                required: [identifier]
              type:
                short: Type of entity involved
                type: Coding
                index: 15
                elements:
                  code:
                    pattern: {type: Code, value: '1'}
                    index: 16
                required: [code]
              role:
                type: Coding
                short: What role the entity played
                index: 17
                elements:
                  code:
                    pattern: {type: Code, value: '1'}
                    index: 18
                required: [code]
            required: [role, type]
        Document:
          match:
            type: {code: '2'}
            role: {code: '3'}
          schema:
            short: Document
            _required: true
            index: 19
            elements:
              what:
                elements:
                  identifier: {short: XDSDocumentEntry.uniqueId, type: Identifier, index: 20}
                required: [identifier]
              type:
                short: Type of entity involved
                type: Coding
                index: 21
                elements:
                  code:
                    pattern: {type: Code, value: '2'}
                    index: 22
                required: [code]
              role:
                type: Coding
                short: What role the entity played
                index: 23
                elements:
                  code:
                    pattern: {type: Code, value: '3'}
                    index: 24
                required: [code]
              detail:
                index: 25
                slicing:
                  rules: open
                  discriminator:
                  - {path: type, type: value}
                  min: null
                  slices:
                    repositoryUniqueId:
                      match: {type: Repository Unique Id}
                      schema:
                        short: repositoryUniqueId
                        _required: true
                        index: 26
                        elements:
                          type:
                            type: string
                            short: Name of the property
                            pattern: {type: String, value: Repository Unique Id}
                            index: 27
                          value: {short: Property value, type: base64Binary, index: 28}
                        required: [value, type]
                    homeCommunityID:
                      match: {type: homeCommunityID}
                      schema:
                        short: homeCommunityID
                        _required: true
                        index: 29
                        elements:
                          type:
                            type: string
                            short: Name of the property
                            pattern: {type: String, value: homeCommunityID}
                            index: 30
                          value: {short: Property value, type: base64Binary, index: 31}
                        required: [value, type]
                    EprDocumentTypeCode:
                      match: {type: EprDocumentTypeCode}
                      schema:
                        short: EprDocumentTypeCode
                        _required: true
                        index: 32
                        elements:
                          type:
                            type: string
                            short: Name of the property
                            pattern: {type: String, value: EprDocumentTypeCode}
                            index: 33
                          value: {short: Property value, type: base64Binary, index: 34}
                        required: [value, type]
            required: [role, type]
package_version: 3.1.0
class: profile
kind: resource
url: http://fhir.ch/ig/ch-atc/StructureDefinition/DocumentAuditEvent
base: http://hl7.org/fhir/StructureDefinition/AuditEvent
version: 3.1.0
required: [subtype, agent, recorded, purposeOfEvent, type]