NHS North West Genomics
0.1.0 - ci-build United Kingdom flag

NHS North West Genomics, published by NHS North West Genomics. This guide is not an authorized publication; it is the continuous build for version 0.1.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/nw-gmsa/nw-gmsa.github.com/ and changes regularly. See the Directory of published versions

Resource Profile: AuditEvent

Official URL: https://fhir.nwgenomics.nhs.uk/StructureDefinition/AuditEvent Version: 0.1.0
Draft as of 2026-02-04 Computable Name: AuditEvent

Core model following IHE Basic Audit Log Patterns (BALP)

Summary

Element National Code Description
agent[oClient]   OAuth2 ClientID.
agent[client] ODS Code Client DNS or IP address
agent[server] ODS Code Server DNS or IP address
agent[user] GMC,GMP, HCPC, etc code  
entity[transaction]   (HL7 FHIR) RESTful HTTP Header: X-Request-ID
entity[message]   HTTP Header: X-Correlation-ID, HL7 v2 MSH.10 - Message Control ID and HL7 FHIR Message Bundle.identifier.value
entity[query]   also known as data in IHE BALP
entity[patient] NHS Number Patient reference plus NHS Number

Usages:

  • This Profile is not used by any profiles in this Implementation Guide

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. AuditEvent 0..* AuditEvent Event record kept for security purposes
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... type Σ 1..1 Coding Type/identifier of event
Binding: AuditEventID (extensible): Type of event.
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://terminology.hl7.org/CodeSystem/audit-event-type
.... version 0..1 string Version of the system - if relevant
.... code 1..1 code Symbol in syntax defined by the system
Fixed Value: rest
.... display 0..1 string Representation defined by the system
.... userSelected 0..1 boolean If this coding was chosen directly by the user
... action SΣ 1..1 code Type of action performed during the event
Binding: AuditEventAction (required): Indicator for type of action performed during the event that generated the event.
... recorded Σ 1..1 instant Time when the event was recorded
... Slices for agent S 2..* BackboneElement Actor involved in the event
Slice: Unordered, Open by value:type
.... agent:All Slices Content/Rules for all slices
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... requestor Σ 1..1 boolean Whether user is initiator
.... agent:oClient S 1..1 BackboneElement OAuth2 ClientID. Known as `oClient` in IHE BALP
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... type 1..1 CodeableConcept How agent participated
Binding: ParticipationRoleType (extensible): The Participation type of the agent to the event.
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://dicom.nema.org/resources/ontology/DCM
....... version 0..1 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 110150
....... 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
..... requestor Σ 1..1 boolean Whether user is initiator
.... agent:user 0..1 BackboneElement Actor involved in the event
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... type 1..1 CodeableConcept How agent participated
Binding: ParticipationRoleType (extensible): The Participation type of the agent to the event.
Required Pattern: At least the following
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ParticipationType
....... version 0..1 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: IRCP
....... display 0..1 string Representation defined by the system
....... userSelected 0..1 boolean If this coding was chosen directly by the user
...... text 0..1 string Plain text representation of the concept
..... who Σ 0..1 Reference(Practitioner) Identifier of who
...... identifier Σ 0..1 PractitionerIdentifier Logical reference, when literal reference is not known
..... requestor Σ 1..1 boolean Whether user is initiator
.... agent:server 1..1 BackboneElement Server DNS or IP address
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... type 1..1 CodeableConcept How agent participated
Binding: ParticipationRoleType (extensible): The Participation type of the agent to the event.
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://dicom.nema.org/resources/ontology/DCM
....... version 0..1 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 110152
....... 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
..... who Σ 0..1 Reference(Organization) Identifier of who
...... identifier Σ 0..1 OrganisationCode Logical reference, when literal reference is not known
..... requestor Σ 1..1 boolean Whether user is initiator
.... agent:client 0..1 BackboneElement Client DNS or IP address
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... type 1..1 CodeableConcept How agent participated
Binding: ParticipationRoleType (extensible): The Participation type of the agent to the event.
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://dicom.nema.org/resources/ontology/DCM
....... version 0..1 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 110153
....... 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
..... who Σ 0..1 Reference(Organization) Identifier of who
...... identifier Σ 0..1 OrganisationCode Logical reference, when literal reference is not known
..... requestor Σ 1..1 boolean Whether user is initiator
... source 1..1 BackboneElement Audit Event Reporter
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... observer Σ 1..1 Reference(PractitionerRole | Practitioner | Organization | Device | Patient | RelatedPerson) The identity of source detecting the event
... Slices for entity C 1..* BackboneElement Data or objects used
Slice: Unordered, Open by value:type
Constraints: sev-1
.... entity:All Slices Content/Rules for all slices
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... entity:transaction SC 1..1 BackboneElement (HL7 FHIR) RESTful HTTP Header: X-Request-ID
Constraints: sev-1
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... type 1..1 Coding Type of entity involved
Binding: AuditEventEntityType (extensible): Code for the entity type involved in the audit event.
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: https://profiles.ihe.net/ITI/BALP/CodeSystem/BasicAuditEntityType
...... version 0..1 string Version of the system - if relevant
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: XrequestId
...... display 0..1 string Representation defined by the system
...... userSelected 0..1 boolean If this coding was chosen directly by the user
.... entity:message SC 0..1 BackboneElement HTTP Header: X-Correlation-ID, HL7 v2 MSH.10 - Message Control ID and HL7 FHIR Message Bundle.identifier.value
Constraints: sev-1
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... type 1..1 Coding Type of entity involved
Binding: AuditEventEntityType (extensible): Code for the entity type involved in the audit event.
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: https://fhir.nwgenomics.nhs.uk/CodeSystem/BasicAuditEntityType
...... version 0..1 string Version of the system - if relevant
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: XcorrelationId
...... display 0..1 string Representation defined by the system
...... userSelected 0..1 boolean If this coding was chosen directly by the user
.... entity:query C 0..1 BackboneElement also known as `data` in IHE BALP
Constraints: sev-1
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... type 1..1 Coding Type of entity involved
Binding: AuditEventEntityType (extensible): Code for the entity type involved in the audit event.
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://terminology.hl7.org/CodeSystem/audit-entity-type
...... version 0..1 string Version of the system - if relevant
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 2
...... display 0..1 string Representation defined by the system
...... userSelected 0..1 boolean If this coding was chosen directly by the user
.... entity:patient C 0..1 BackboneElement Patient reference plus NHS Number
Constraints: sev-1
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... what Σ 0..1 Reference(Patient) Specific instance of resource
...... identifier Σ 0..1 NHSNumber Logical reference, when literal reference is not known
..... type 1..1 Coding Type of entity involved
Binding: AuditEventEntityType (extensible): Code for the entity type involved in the audit event.
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://terminology.hl7.org/CodeSystem/audit-entity-type
...... version 0..1 string Version of the system - if relevant
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 1
...... display 0..1 string Representation defined by the system
...... userSelected 0..1 boolean If this coding was chosen directly by the user

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
AuditEvent.type Base extensible Audit Event ID 📍4.0.1 FHIR Std.
AuditEvent.action Base required AuditEventAction 📍4.0.1 FHIR Std.
AuditEvent.agent:oClient.​type Base extensible ParticipationRoleType 📍4.0.1 FHIR Std.
AuditEvent.agent:user.​type Base extensible ParticipationRoleType 📍4.0.1 FHIR Std.
AuditEvent.agent:server.​type Base extensible ParticipationRoleType 📍4.0.1 FHIR Std.
AuditEvent.agent:client.​type Base extensible ParticipationRoleType 📍4.0.1 FHIR Std.
AuditEvent.entity:transaction.​type Base extensible Audit event entity type 📍4.0.1 FHIR Std.
AuditEvent.entity:message.​type Base extensible Audit event entity type 📍4.0.1 FHIR Std.
AuditEvent.entity:query.​type Base extensible Audit event entity type 📍4.0.1 FHIR Std.
AuditEvent.entity:patient.​type Base extensible Audit event entity type 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error AuditEvent If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error AuditEvent 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 AuditEvent 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 AuditEvent If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice AuditEvent A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
sev-1 error AuditEvent.entity, AuditEvent.entity:transaction, AuditEvent.entity:message, AuditEvent.entity:query, AuditEvent.entity:patient Either a name or a query (NOT both) name.empty() or query.empty()

This structure is derived from AuditEvent

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. AuditEvent 0..* AuditEvent Event record kept for security purposes
... type 1..1 Coding Type/identifier of event
Required Pattern: At least the following
.... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/audit-event-type
.... code 1..1 code Symbol in syntax defined by the system
Fixed Value: rest
... action S 1..1 code Type of action performed during the event
... Slices for agent S 2..* BackboneElement Actor involved in the event
Slice: Unordered, Open by value:type
.... agent:oClient S 1..1 BackboneElement OAuth2 ClientID. Known as `oClient` in IHE BALP
..... type 1..1 CodeableConcept How agent participated
Required Pattern: At least the following
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://dicom.nema.org/resources/ontology/DCM
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 110150
.... agent:user 0..1 BackboneElement Actor involved in the event
..... type 1..1 CodeableConcept How agent participated
Required Pattern: At least the following
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ParticipationType
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: IRCP
..... who 0..1 Reference(Practitioner) Identifier of who
...... identifier 0..1 PractitionerIdentifier Logical reference, when literal reference is not known
.... agent:server 1..1 BackboneElement Server DNS or IP address
..... type 1..1 CodeableConcept How agent participated
Required Pattern: At least the following
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://dicom.nema.org/resources/ontology/DCM
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 110152
..... who 0..1 Reference(Organization) Identifier of who
...... identifier 0..1 OrganisationCode Logical reference, when literal reference is not known
.... agent:client 0..1 BackboneElement Client DNS or IP address
..... type 1..1 CodeableConcept How agent participated
Required Pattern: At least the following
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://dicom.nema.org/resources/ontology/DCM
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 110153
..... who 0..1 Reference(Organization) Identifier of who
...... identifier 0..1 OrganisationCode Logical reference, when literal reference is not known
... Slices for entity 1..* BackboneElement Data or objects used
Slice: Unordered, Open by value:type
.... entity:transaction S 1..1 BackboneElement (HL7 FHIR) RESTful HTTP Header: X-Request-ID
..... type 1..1 Coding Type of entity involved
Required Pattern: At least the following
...... system 1..1 uri Identity of the terminology system
Fixed Value: https://profiles.ihe.net/ITI/BALP/CodeSystem/BasicAuditEntityType
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: XrequestId
.... entity:message S 0..1 BackboneElement HTTP Header: X-Correlation-ID, HL7 v2 MSH.10 - Message Control ID and HL7 FHIR Message Bundle.identifier.value
..... type 1..1 Coding Type of entity involved
Required Pattern: At least the following
...... system 1..1 uri Identity of the terminology system
Fixed Value: https://fhir.nwgenomics.nhs.uk/CodeSystem/BasicAuditEntityType
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: XcorrelationId
.... entity:query 0..1 BackboneElement also known as `data` in IHE BALP
..... type 1..1 Coding Type of entity involved
Required Pattern: At least the following
...... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/audit-entity-type
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 2
.... entity:patient 0..1 BackboneElement Patient reference plus NHS Number
..... what 0..1 Reference(Patient) Specific instance of resource
...... identifier 0..1 NHSNumber Logical reference, when literal reference is not known
..... type 1..1 Coding Type of entity involved
Required Pattern: At least the following
...... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/audit-entity-type
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 1

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. AuditEvent 0..* AuditEvent Event record kept for security purposes
... 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.
Additional BindingsPurpose
AllLanguages Max Binding
... 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
... type Σ 1..1 Coding Type/identifier of event
Binding: AuditEventID (extensible): Type of event.
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://terminology.hl7.org/CodeSystem/audit-event-type
.... version 0..1 string Version of the system - if relevant
.... code 1..1 code Symbol in syntax defined by the system
Fixed Value: rest
.... display 0..1 string Representation defined by the system
.... userSelected 0..1 boolean If this coding was chosen directly by the user
... subtype Σ 0..* Coding More specific type/id for the event
Binding: AuditEventSub-Type (extensible): Sub-type of event.
... action SΣ 1..1 code Type of action performed during the event
Binding: AuditEventAction (required): Indicator for type of action performed during the event that generated the event.
... period 0..1 Period When the activity occurred
... recorded Σ 1..1 instant Time when the event was recorded
... outcome Σ 0..1 code Whether the event succeeded or failed
Binding: AuditEventOutcome (required): Indicates whether the event succeeded or failed.
... outcomeDesc Σ 0..1 string Description of the event outcome
... purposeOfEvent Σ 0..* CodeableConcept The purposeOfUse of the event
Binding: PurposeOfUse (extensible): The reason the activity took place.
... Slices for agent S 2..* BackboneElement Actor involved in the event
Slice: Unordered, Open by value:type
.... agent:All Slices Content/Rules for all slices
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... type 0..1 CodeableConcept How agent participated
Binding: ParticipationRoleType (extensible): The Participation type of the agent to the event.
..... role 0..* CodeableConcept Agent role in the event
Binding: SecurityRoleType (example): What security role enabled the agent to participate in the event.
..... who Σ 0..1 Reference(PractitionerRole | Practitioner | Organization | Device | Patient | RelatedPerson) Identifier of who
..... altId 0..1 string Alternative User identity
..... name 0..1 string Human friendly name for the agent
..... requestor Σ 1..1 boolean Whether user is initiator
..... location 0..1 Reference(Location) Where
..... policy 0..* uri Policy that authorized event
..... media 0..1 Coding Type of media
Binding: MediaTypeCode (extensible): Used when the event is about exporting/importing onto media.
..... network 0..1 BackboneElement Logical network location for application activity
...... 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
...... address 0..1 string Identifier for the network access point of the user device
...... type 0..1 code The type of network access point
Binding: AuditEventAgentNetworkType (required): The type of network access point of this agent in the audit event.
..... purposeOfUse 0..* CodeableConcept Reason given for this user
Binding: PurposeOfUse (extensible): The reason the activity took place.
.... agent:oClient S 1..1 BackboneElement OAuth2 ClientID. Known as `oClient` in IHE BALP
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... type 1..1 CodeableConcept How agent participated
Binding: ParticipationRoleType (extensible): The Participation type of the agent to the event.
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://dicom.nema.org/resources/ontology/DCM
....... version 0..1 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 110150
....... 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
..... role 0..* CodeableConcept Agent role in the event
Binding: SecurityRoleType (example): What security role enabled the agent to participate in the event.
..... who Σ 0..1 Reference(PractitionerRole | Practitioner | Organization | Device | Patient | RelatedPerson) Identifier of who
..... altId 0..1 string Alternative User identity
..... name 0..1 string Human friendly name for the agent
..... requestor Σ 1..1 boolean Whether user is initiator
..... location 0..1 Reference(Location) Where
..... policy 0..* uri Policy that authorized event
..... media 0..1 Coding Type of media
Binding: MediaTypeCode (extensible): Used when the event is about exporting/importing onto media.
..... network 0..1 BackboneElement Logical network location for application activity
...... 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
...... address 0..1 string Identifier for the network access point of the user device
...... type 0..1 code The type of network access point
Binding: AuditEventAgentNetworkType (required): The type of network access point of this agent in the audit event.
..... purposeOfUse 0..* CodeableConcept Reason given for this user
Binding: PurposeOfUse (extensible): The reason the activity took place.
.... agent:user 0..1 BackboneElement Actor involved in the event
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... type 1..1 CodeableConcept How agent participated
Binding: ParticipationRoleType (extensible): The Participation type of the agent to the event.
Required Pattern: At least the following
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ParticipationType
....... version 0..1 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: IRCP
....... display 0..1 string Representation defined by the system
....... userSelected 0..1 boolean If this coding was chosen directly by the user
...... text 0..1 string Plain text representation of the concept
..... role 0..* CodeableConcept Agent role in the event
Binding: SecurityRoleType (example): What security role enabled the agent to participate in the event.
..... who Σ 0..1 Reference(Practitioner) Identifier of who
...... 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 PractitionerIdentifier Logical reference, when literal reference is not known
...... display Σ 0..1 string Text alternative for the resource
..... altId 0..1 string Alternative User identity
..... name 0..1 string Human friendly name for the agent
..... requestor Σ 1..1 boolean Whether user is initiator
..... location 0..1 Reference(Location) Where
..... policy 0..* uri Policy that authorized event
..... media 0..1 Coding Type of media
Binding: MediaTypeCode (extensible): Used when the event is about exporting/importing onto media.
..... network 0..1 BackboneElement Logical network location for application activity
...... 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
...... address 0..1 string Identifier for the network access point of the user device
...... type 0..1 code The type of network access point
Binding: AuditEventAgentNetworkType (required): The type of network access point of this agent in the audit event.
..... purposeOfUse 0..* CodeableConcept Reason given for this user
Binding: PurposeOfUse (extensible): The reason the activity took place.
.... agent:server 1..1 BackboneElement Server DNS or IP address
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... type 1..1 CodeableConcept How agent participated
Binding: ParticipationRoleType (extensible): The Participation type of the agent to the event.
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://dicom.nema.org/resources/ontology/DCM
....... version 0..1 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 110152
....... 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
..... role 0..* CodeableConcept Agent role in the event
Binding: SecurityRoleType (example): What security role enabled the agent to participate in the event.
..... who Σ 0..1 Reference(Organization) Identifier of who
...... 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 OrganisationCode Logical reference, when literal reference is not known
...... display Σ 0..1 string Text alternative for the resource
..... altId 0..1 string Alternative User identity
..... name 0..1 string Human friendly name for the agent
..... requestor Σ 1..1 boolean Whether user is initiator
..... location 0..1 Reference(Location) Where
..... policy 0..* uri Policy that authorized event
..... media 0..1 Coding Type of media
Binding: MediaTypeCode (extensible): Used when the event is about exporting/importing onto media.
..... network 0..1 BackboneElement Logical network location for application activity
...... 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
...... address 0..1 string Identifier for the network access point of the user device
...... type 0..1 code The type of network access point
Binding: AuditEventAgentNetworkType (required): The type of network access point of this agent in the audit event.
..... purposeOfUse 0..* CodeableConcept Reason given for this user
Binding: PurposeOfUse (extensible): The reason the activity took place.
.... agent:client 0..1 BackboneElement Client DNS or IP address
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... type 1..1 CodeableConcept How agent participated
Binding: ParticipationRoleType (extensible): The Participation type of the agent to the event.
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://dicom.nema.org/resources/ontology/DCM
....... version 0..1 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 110153
....... 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
..... role 0..* CodeableConcept Agent role in the event
Binding: SecurityRoleType (example): What security role enabled the agent to participate in the event.
..... who Σ 0..1 Reference(Organization) Identifier of who
...... 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 OrganisationCode Logical reference, when literal reference is not known
...... display Σ 0..1 string Text alternative for the resource
..... altId 0..1 string Alternative User identity
..... name 0..1 string Human friendly name for the agent
..... requestor Σ 1..1 boolean Whether user is initiator
..... location 0..1 Reference(Location) Where
..... policy 0..* uri Policy that authorized event
..... media 0..1 Coding Type of media
Binding: MediaTypeCode (extensible): Used when the event is about exporting/importing onto media.
..... network 0..1 BackboneElement Logical network location for application activity
...... 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
...... address 0..1 string Identifier for the network access point of the user device
...... type 0..1 code The type of network access point
Binding: AuditEventAgentNetworkType (required): The type of network access point of this agent in the audit event.
..... purposeOfUse 0..* CodeableConcept Reason given for this user
Binding: PurposeOfUse (extensible): The reason the activity took place.
... source 1..1 BackboneElement Audit Event Reporter
.... 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
.... site 0..1 string Logical source location within the enterprise
.... observer Σ 1..1 Reference(PractitionerRole | Practitioner | Organization | Device | Patient | RelatedPerson) The identity of source detecting the event
.... type 0..* Coding The type of source where event originated
Binding: AuditEventSourceType (extensible): Code specifying the type of system that detected and recorded the event.
... Slices for entity C 1..* BackboneElement Data or objects used
Slice: Unordered, Open by value:type
Constraints: sev-1
.... entity:All Slices Content/Rules for all slices
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... what Σ 0..1 Reference(Resource) Specific instance of resource
..... type 0..1 Coding Type of entity involved
Binding: AuditEventEntityType (extensible): Code for the entity type involved in the audit event.
..... role 0..1 Coding What role the entity played
Binding: AuditEventEntityRole (extensible): Code representing the role the entity played in the audit event.
..... lifecycle 0..1 Coding Life-cycle stage for the entity
Binding: ObjectLifecycleEvents (extensible): Identifier for the data life-cycle stage for the entity.
..... securityLabel 0..* Coding Security labels on the entity
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
..... name ΣC 0..1 string Descriptor for entity
..... description 0..1 string Descriptive text
..... query ΣC 0..1 base64Binary Query parameters
..... detail 0..* BackboneElement Additional Information about the entity
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... type 1..1 string Name of the property
...... value[x] 1..1 Property value
....... valueString string
....... valueBase64Binary base64Binary
.... entity:transaction SC 1..1 BackboneElement (HL7 FHIR) RESTful HTTP Header: X-Request-ID
Constraints: sev-1
..... 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
..... what Σ 0..1 Reference(Resource) Specific instance of resource
..... type 1..1 Coding Type of entity involved
Binding: AuditEventEntityType (extensible): Code for the entity type involved in the audit event.
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: https://profiles.ihe.net/ITI/BALP/CodeSystem/BasicAuditEntityType
...... version 0..1 string Version of the system - if relevant
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: XrequestId
...... display 0..1 string Representation defined by the system
...... userSelected 0..1 boolean If this coding was chosen directly by the user
..... role 0..1 Coding What role the entity played
Binding: AuditEventEntityRole (extensible): Code representing the role the entity played in the audit event.
..... lifecycle 0..1 Coding Life-cycle stage for the entity
Binding: ObjectLifecycleEvents (extensible): Identifier for the data life-cycle stage for the entity.
..... securityLabel 0..* Coding Security labels on the entity
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
..... name ΣC 0..1 string Descriptor for entity
..... description 0..1 string Descriptive text
..... query ΣC 0..1 base64Binary Query parameters
..... detail 0..* BackboneElement Additional Information about the entity
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... type 1..1 string Name of the property
...... value[x] 1..1 Property value
....... valueString string
....... valueBase64Binary base64Binary
.... entity:message SC 0..1 BackboneElement HTTP Header: X-Correlation-ID, HL7 v2 MSH.10 - Message Control ID and HL7 FHIR Message Bundle.identifier.value
Constraints: sev-1
..... 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
..... what Σ 0..1 Reference(Resource) Specific instance of resource
..... type 1..1 Coding Type of entity involved
Binding: AuditEventEntityType (extensible): Code for the entity type involved in the audit event.
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: https://fhir.nwgenomics.nhs.uk/CodeSystem/BasicAuditEntityType
...... version 0..1 string Version of the system - if relevant
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: XcorrelationId
...... display 0..1 string Representation defined by the system
...... userSelected 0..1 boolean If this coding was chosen directly by the user
..... role 0..1 Coding What role the entity played
Binding: AuditEventEntityRole (extensible): Code representing the role the entity played in the audit event.
..... lifecycle 0..1 Coding Life-cycle stage for the entity
Binding: ObjectLifecycleEvents (extensible): Identifier for the data life-cycle stage for the entity.
..... securityLabel 0..* Coding Security labels on the entity
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
..... name ΣC 0..1 string Descriptor for entity
..... description 0..1 string Descriptive text
..... query ΣC 0..1 base64Binary Query parameters
..... detail 0..* BackboneElement Additional Information about the entity
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... type 1..1 string Name of the property
...... value[x] 1..1 Property value
....... valueString string
....... valueBase64Binary base64Binary
.... entity:query C 0..1 BackboneElement also known as `data` in IHE BALP
Constraints: sev-1
..... 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
..... what Σ 0..1 Reference(Resource) Specific instance of resource
..... type 1..1 Coding Type of entity involved
Binding: AuditEventEntityType (extensible): Code for the entity type involved in the audit event.
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://terminology.hl7.org/CodeSystem/audit-entity-type
...... version 0..1 string Version of the system - if relevant
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 2
...... display 0..1 string Representation defined by the system
...... userSelected 0..1 boolean If this coding was chosen directly by the user
..... role 0..1 Coding What role the entity played
Binding: AuditEventEntityRole (extensible): Code representing the role the entity played in the audit event.
..... lifecycle 0..1 Coding Life-cycle stage for the entity
Binding: ObjectLifecycleEvents (extensible): Identifier for the data life-cycle stage for the entity.
..... securityLabel 0..* Coding Security labels on the entity
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
..... name ΣC 0..1 string Descriptor for entity
..... description 0..1 string Descriptive text
..... query ΣC 0..1 base64Binary Query parameters
..... detail 0..* BackboneElement Additional Information about the entity
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... type 1..1 string Name of the property
...... value[x] 1..1 Property value
....... valueString string
....... valueBase64Binary base64Binary
.... entity:patient C 0..1 BackboneElement Patient reference plus NHS Number
Constraints: sev-1
..... 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
..... what Σ 0..1 Reference(Patient) Specific instance of resource
...... 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 NHSNumber Logical reference, when literal reference is not known
...... display Σ 0..1 string Text alternative for the resource
..... type 1..1 Coding Type of entity involved
Binding: AuditEventEntityType (extensible): Code for the entity type involved in the audit event.
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://terminology.hl7.org/CodeSystem/audit-entity-type
...... version 0..1 string Version of the system - if relevant
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 1
...... display 0..1 string Representation defined by the system
...... userSelected 0..1 boolean If this coding was chosen directly by the user
..... role 0..1 Coding What role the entity played
Binding: AuditEventEntityRole (extensible): Code representing the role the entity played in the audit event.
..... lifecycle 0..1 Coding Life-cycle stage for the entity
Binding: ObjectLifecycleEvents (extensible): Identifier for the data life-cycle stage for the entity.
..... securityLabel 0..* Coding Security labels on the entity
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
..... name ΣC 0..1 string Descriptor for entity
..... description 0..1 string Descriptive text
..... query ΣC 0..1 base64Binary Query parameters
..... detail 0..* BackboneElement Additional Information about the entity
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... type 1..1 string Name of the property
...... value[x] 1..1 Property value
....... valueString string
....... valueBase64Binary base64Binary

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
AuditEvent.language Base preferred Common Languages 📍4.0.1 FHIR Std.
AuditEvent.type Base extensible Audit Event ID 📍4.0.1 FHIR Std.
AuditEvent.subtype Base extensible Audit Event Sub-Type 📍4.0.1 FHIR Std.
AuditEvent.action Base required AuditEventAction 📍4.0.1 FHIR Std.
AuditEvent.outcome Base required AuditEventOutcome 📍4.0.1 FHIR Std.
AuditEvent.purposeOfEvent Base extensible PurposeOfUse 📦3.1.0 THO v7.0
AuditEvent.agent.type Base extensible ParticipationRoleType 📍4.0.1 FHIR Std.
AuditEvent.agent.role Base example SecurityRoleType 📍4.0.1 FHIR Std.
AuditEvent.agent.media Base extensible Media Type Code 📍4.0.1 FHIR Std.
AuditEvent.agent.network.​type Base required AuditEventAgentNetworkType 📍4.0.1 FHIR Std.
AuditEvent.agent.purposeOfUse Base extensible PurposeOfUse 📦3.1.0 THO v7.0
AuditEvent.agent:oClient.​type Base extensible ParticipationRoleType 📍4.0.1 FHIR Std.
AuditEvent.agent:oClient.​role Base example SecurityRoleType 📍4.0.1 FHIR Std.
AuditEvent.agent:oClient.​media Base extensible Media Type Code 📍4.0.1 FHIR Std.
AuditEvent.agent:oClient.​network.type Base required AuditEventAgentNetworkType 📍4.0.1 FHIR Std.
AuditEvent.agent:oClient.​purposeOfUse Base extensible PurposeOfUse 📦3.1.0 THO v7.0
AuditEvent.agent:user.​type Base extensible ParticipationRoleType 📍4.0.1 FHIR Std.
AuditEvent.agent:user.​role Base example SecurityRoleType 📍4.0.1 FHIR Std.
AuditEvent.agent:user.​who.type Base extensible ResourceType 📍4.0.1 FHIR Std.
AuditEvent.agent:user.​media Base extensible Media Type Code 📍4.0.1 FHIR Std.
AuditEvent.agent:user.​network.type Base required AuditEventAgentNetworkType 📍4.0.1 FHIR Std.
AuditEvent.agent:user.​purposeOfUse Base extensible PurposeOfUse 📦3.1.0 THO v7.0
AuditEvent.agent:server.​type Base extensible ParticipationRoleType 📍4.0.1 FHIR Std.
AuditEvent.agent:server.​role Base example SecurityRoleType 📍4.0.1 FHIR Std.
AuditEvent.agent:server.​who.type Base extensible ResourceType 📍4.0.1 FHIR Std.
AuditEvent.agent:server.​media Base extensible Media Type Code 📍4.0.1 FHIR Std.
AuditEvent.agent:server.​network.type Base required AuditEventAgentNetworkType 📍4.0.1 FHIR Std.
AuditEvent.agent:server.​purposeOfUse Base extensible PurposeOfUse 📦3.1.0 THO v7.0
AuditEvent.agent:client.​type Base extensible ParticipationRoleType 📍4.0.1 FHIR Std.
AuditEvent.agent:client.​role Base example SecurityRoleType 📍4.0.1 FHIR Std.
AuditEvent.agent:client.​who.type Base extensible ResourceType 📍4.0.1 FHIR Std.
AuditEvent.agent:client.​media Base extensible Media Type Code 📍4.0.1 FHIR Std.
AuditEvent.agent:client.​network.type Base required AuditEventAgentNetworkType 📍4.0.1 FHIR Std.
AuditEvent.agent:client.​purposeOfUse Base extensible PurposeOfUse 📦3.1.0 THO v7.0
AuditEvent.source.type Base extensible Audit Event Source Type 📍4.0.1 FHIR Std.
AuditEvent.entity.type Base extensible Audit event entity type 📍4.0.1 FHIR Std.
AuditEvent.entity.role Base extensible AuditEventEntityRole 📍4.0.1 FHIR Std.
AuditEvent.entity.lifecycle Base extensible ObjectLifecycleEvents 📍4.0.1 FHIR Std.
AuditEvent.entity.securityLabel Base extensible SecurityLabels 📍4.0.1 FHIR Std.
AuditEvent.entity:transaction.​type Base extensible Audit event entity type 📍4.0.1 FHIR Std.
AuditEvent.entity:transaction.​role Base extensible AuditEventEntityRole 📍4.0.1 FHIR Std.
AuditEvent.entity:transaction.​lifecycle Base extensible ObjectLifecycleEvents 📍4.0.1 FHIR Std.
AuditEvent.entity:transaction.​securityLabel Base extensible SecurityLabels 📍4.0.1 FHIR Std.
AuditEvent.entity:message.​type Base extensible Audit event entity type 📍4.0.1 FHIR Std.
AuditEvent.entity:message.​role Base extensible AuditEventEntityRole 📍4.0.1 FHIR Std.
AuditEvent.entity:message.​lifecycle Base extensible ObjectLifecycleEvents 📍4.0.1 FHIR Std.
AuditEvent.entity:message.​securityLabel Base extensible SecurityLabels 📍4.0.1 FHIR Std.
AuditEvent.entity:query.​type Base extensible Audit event entity type 📍4.0.1 FHIR Std.
AuditEvent.entity:query.​role Base extensible AuditEventEntityRole 📍4.0.1 FHIR Std.
AuditEvent.entity:query.​lifecycle Base extensible ObjectLifecycleEvents 📍4.0.1 FHIR Std.
AuditEvent.entity:query.​securityLabel Base extensible SecurityLabels 📍4.0.1 FHIR Std.
AuditEvent.entity:patient.​what.type Base extensible ResourceType 📍4.0.1 FHIR Std.
AuditEvent.entity:patient.​type Base extensible Audit event entity type 📍4.0.1 FHIR Std.
AuditEvent.entity:patient.​role Base extensible AuditEventEntityRole 📍4.0.1 FHIR Std.
AuditEvent.entity:patient.​lifecycle Base extensible ObjectLifecycleEvents 📍4.0.1 FHIR Std.
AuditEvent.entity:patient.​securityLabel Base extensible SecurityLabels 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error AuditEvent If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error AuditEvent 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 AuditEvent 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 AuditEvent If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice AuditEvent A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
sev-1 error AuditEvent.entity, AuditEvent.entity:transaction, AuditEvent.entity:message, AuditEvent.entity:query, AuditEvent.entity:patient Either a name or a query (NOT both) name.empty() or query.empty()

This structure is derived from AuditEvent

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. AuditEvent 0..* AuditEvent Event record kept for security purposes
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... type Σ 1..1 Coding Type/identifier of event
Binding: AuditEventID (extensible): Type of event.
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://terminology.hl7.org/CodeSystem/audit-event-type
.... version 0..1 string Version of the system - if relevant
.... code 1..1 code Symbol in syntax defined by the system
Fixed Value: rest
.... display 0..1 string Representation defined by the system
.... userSelected 0..1 boolean If this coding was chosen directly by the user
... action SΣ 1..1 code Type of action performed during the event
Binding: AuditEventAction (required): Indicator for type of action performed during the event that generated the event.
... recorded Σ 1..1 instant Time when the event was recorded
... Slices for agent S 2..* BackboneElement Actor involved in the event
Slice: Unordered, Open by value:type
.... agent:All Slices Content/Rules for all slices
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... requestor Σ 1..1 boolean Whether user is initiator
.... agent:oClient S 1..1 BackboneElement OAuth2 ClientID. Known as `oClient` in IHE BALP
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... type 1..1 CodeableConcept How agent participated
Binding: ParticipationRoleType (extensible): The Participation type of the agent to the event.
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://dicom.nema.org/resources/ontology/DCM
....... version 0..1 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 110150
....... 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
..... requestor Σ 1..1 boolean Whether user is initiator
.... agent:user 0..1 BackboneElement Actor involved in the event
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... type 1..1 CodeableConcept How agent participated
Binding: ParticipationRoleType (extensible): The Participation type of the agent to the event.
Required Pattern: At least the following
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ParticipationType
....... version 0..1 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: IRCP
....... display 0..1 string Representation defined by the system
....... userSelected 0..1 boolean If this coding was chosen directly by the user
...... text 0..1 string Plain text representation of the concept
..... who Σ 0..1 Reference(Practitioner) Identifier of who
...... identifier Σ 0..1 PractitionerIdentifier Logical reference, when literal reference is not known
..... requestor Σ 1..1 boolean Whether user is initiator
.... agent:server 1..1 BackboneElement Server DNS or IP address
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... type 1..1 CodeableConcept How agent participated
Binding: ParticipationRoleType (extensible): The Participation type of the agent to the event.
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://dicom.nema.org/resources/ontology/DCM
....... version 0..1 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 110152
....... 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
..... who Σ 0..1 Reference(Organization) Identifier of who
...... identifier Σ 0..1 OrganisationCode Logical reference, when literal reference is not known
..... requestor Σ 1..1 boolean Whether user is initiator
.... agent:client 0..1 BackboneElement Client DNS or IP address
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... type 1..1 CodeableConcept How agent participated
Binding: ParticipationRoleType (extensible): The Participation type of the agent to the event.
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://dicom.nema.org/resources/ontology/DCM
....... version 0..1 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 110153
....... 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
..... who Σ 0..1 Reference(Organization) Identifier of who
...... identifier Σ 0..1 OrganisationCode Logical reference, when literal reference is not known
..... requestor Σ 1..1 boolean Whether user is initiator
... source 1..1 BackboneElement Audit Event Reporter
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... observer Σ 1..1 Reference(PractitionerRole | Practitioner | Organization | Device | Patient | RelatedPerson) The identity of source detecting the event
... Slices for entity C 1..* BackboneElement Data or objects used
Slice: Unordered, Open by value:type
Constraints: sev-1
.... entity:All Slices Content/Rules for all slices
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... entity:transaction SC 1..1 BackboneElement (HL7 FHIR) RESTful HTTP Header: X-Request-ID
Constraints: sev-1
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... type 1..1 Coding Type of entity involved
Binding: AuditEventEntityType (extensible): Code for the entity type involved in the audit event.
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: https://profiles.ihe.net/ITI/BALP/CodeSystem/BasicAuditEntityType
...... version 0..1 string Version of the system - if relevant
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: XrequestId
...... display 0..1 string Representation defined by the system
...... userSelected 0..1 boolean If this coding was chosen directly by the user
.... entity:message SC 0..1 BackboneElement HTTP Header: X-Correlation-ID, HL7 v2 MSH.10 - Message Control ID and HL7 FHIR Message Bundle.identifier.value
Constraints: sev-1
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... type 1..1 Coding Type of entity involved
Binding: AuditEventEntityType (extensible): Code for the entity type involved in the audit event.
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: https://fhir.nwgenomics.nhs.uk/CodeSystem/BasicAuditEntityType
...... version 0..1 string Version of the system - if relevant
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: XcorrelationId
...... display 0..1 string Representation defined by the system
...... userSelected 0..1 boolean If this coding was chosen directly by the user
.... entity:query C 0..1 BackboneElement also known as `data` in IHE BALP
Constraints: sev-1
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... type 1..1 Coding Type of entity involved
Binding: AuditEventEntityType (extensible): Code for the entity type involved in the audit event.
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://terminology.hl7.org/CodeSystem/audit-entity-type
...... version 0..1 string Version of the system - if relevant
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 2
...... display 0..1 string Representation defined by the system
...... userSelected 0..1 boolean If this coding was chosen directly by the user
.... entity:patient C 0..1 BackboneElement Patient reference plus NHS Number
Constraints: sev-1
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... what Σ 0..1 Reference(Patient) Specific instance of resource
...... identifier Σ 0..1 NHSNumber Logical reference, when literal reference is not known
..... type 1..1 Coding Type of entity involved
Binding: AuditEventEntityType (extensible): Code for the entity type involved in the audit event.
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://terminology.hl7.org/CodeSystem/audit-entity-type
...... version 0..1 string Version of the system - if relevant
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 1
...... display 0..1 string Representation defined by the system
...... userSelected 0..1 boolean If this coding was chosen directly by the user

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
AuditEvent.type Base extensible Audit Event ID 📍4.0.1 FHIR Std.
AuditEvent.action Base required AuditEventAction 📍4.0.1 FHIR Std.
AuditEvent.agent:oClient.​type Base extensible ParticipationRoleType 📍4.0.1 FHIR Std.
AuditEvent.agent:user.​type Base extensible ParticipationRoleType 📍4.0.1 FHIR Std.
AuditEvent.agent:server.​type Base extensible ParticipationRoleType 📍4.0.1 FHIR Std.
AuditEvent.agent:client.​type Base extensible ParticipationRoleType 📍4.0.1 FHIR Std.
AuditEvent.entity:transaction.​type Base extensible Audit event entity type 📍4.0.1 FHIR Std.
AuditEvent.entity:message.​type Base extensible Audit event entity type 📍4.0.1 FHIR Std.
AuditEvent.entity:query.​type Base extensible Audit event entity type 📍4.0.1 FHIR Std.
AuditEvent.entity:patient.​type Base extensible Audit event entity type 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error AuditEvent If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error AuditEvent 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 AuditEvent 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 AuditEvent If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice AuditEvent A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
sev-1 error AuditEvent.entity, AuditEvent.entity:transaction, AuditEvent.entity:message, AuditEvent.entity:query, AuditEvent.entity:patient Either a name or a query (NOT both) name.empty() or query.empty()

Differential View

This structure is derived from AuditEvent

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. AuditEvent 0..* AuditEvent Event record kept for security purposes
... type 1..1 Coding Type/identifier of event
Required Pattern: At least the following
.... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/audit-event-type
.... code 1..1 code Symbol in syntax defined by the system
Fixed Value: rest
... action S 1..1 code Type of action performed during the event
... Slices for agent S 2..* BackboneElement Actor involved in the event
Slice: Unordered, Open by value:type
.... agent:oClient S 1..1 BackboneElement OAuth2 ClientID. Known as `oClient` in IHE BALP
..... type 1..1 CodeableConcept How agent participated
Required Pattern: At least the following
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://dicom.nema.org/resources/ontology/DCM
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 110150
.... agent:user 0..1 BackboneElement Actor involved in the event
..... type 1..1 CodeableConcept How agent participated
Required Pattern: At least the following
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ParticipationType
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: IRCP
..... who 0..1 Reference(Practitioner) Identifier of who
...... identifier 0..1 PractitionerIdentifier Logical reference, when literal reference is not known
.... agent:server 1..1 BackboneElement Server DNS or IP address
..... type 1..1 CodeableConcept How agent participated
Required Pattern: At least the following
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://dicom.nema.org/resources/ontology/DCM
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 110152
..... who 0..1 Reference(Organization) Identifier of who
...... identifier 0..1 OrganisationCode Logical reference, when literal reference is not known
.... agent:client 0..1 BackboneElement Client DNS or IP address
..... type 1..1 CodeableConcept How agent participated
Required Pattern: At least the following
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://dicom.nema.org/resources/ontology/DCM
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 110153
..... who 0..1 Reference(Organization) Identifier of who
...... identifier 0..1 OrganisationCode Logical reference, when literal reference is not known
... Slices for entity 1..* BackboneElement Data or objects used
Slice: Unordered, Open by value:type
.... entity:transaction S 1..1 BackboneElement (HL7 FHIR) RESTful HTTP Header: X-Request-ID
..... type 1..1 Coding Type of entity involved
Required Pattern: At least the following
...... system 1..1 uri Identity of the terminology system
Fixed Value: https://profiles.ihe.net/ITI/BALP/CodeSystem/BasicAuditEntityType
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: XrequestId
.... entity:message S 0..1 BackboneElement HTTP Header: X-Correlation-ID, HL7 v2 MSH.10 - Message Control ID and HL7 FHIR Message Bundle.identifier.value
..... type 1..1 Coding Type of entity involved
Required Pattern: At least the following
...... system 1..1 uri Identity of the terminology system
Fixed Value: https://fhir.nwgenomics.nhs.uk/CodeSystem/BasicAuditEntityType
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: XcorrelationId
.... entity:query 0..1 BackboneElement also known as `data` in IHE BALP
..... type 1..1 Coding Type of entity involved
Required Pattern: At least the following
...... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/audit-entity-type
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 2
.... entity:patient 0..1 BackboneElement Patient reference plus NHS Number
..... what 0..1 Reference(Patient) Specific instance of resource
...... identifier 0..1 NHSNumber Logical reference, when literal reference is not known
..... type 1..1 Coding Type of entity involved
Required Pattern: At least the following
...... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/audit-entity-type
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 1

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. AuditEvent 0..* AuditEvent Event record kept for security purposes
... 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.
Additional BindingsPurpose
AllLanguages Max Binding
... 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
... type Σ 1..1 Coding Type/identifier of event
Binding: AuditEventID (extensible): Type of event.
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://terminology.hl7.org/CodeSystem/audit-event-type
.... version 0..1 string Version of the system - if relevant
.... code 1..1 code Symbol in syntax defined by the system
Fixed Value: rest
.... display 0..1 string Representation defined by the system
.... userSelected 0..1 boolean If this coding was chosen directly by the user
... subtype Σ 0..* Coding More specific type/id for the event
Binding: AuditEventSub-Type (extensible): Sub-type of event.
... action SΣ 1..1 code Type of action performed during the event
Binding: AuditEventAction (required): Indicator for type of action performed during the event that generated the event.
... period 0..1 Period When the activity occurred
... recorded Σ 1..1 instant Time when the event was recorded
... outcome Σ 0..1 code Whether the event succeeded or failed
Binding: AuditEventOutcome (required): Indicates whether the event succeeded or failed.
... outcomeDesc Σ 0..1 string Description of the event outcome
... purposeOfEvent Σ 0..* CodeableConcept The purposeOfUse of the event
Binding: PurposeOfUse (extensible): The reason the activity took place.
... Slices for agent S 2..* BackboneElement Actor involved in the event
Slice: Unordered, Open by value:type
.... agent:All Slices Content/Rules for all slices
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... type 0..1 CodeableConcept How agent participated
Binding: ParticipationRoleType (extensible): The Participation type of the agent to the event.
..... role 0..* CodeableConcept Agent role in the event
Binding: SecurityRoleType (example): What security role enabled the agent to participate in the event.
..... who Σ 0..1 Reference(PractitionerRole | Practitioner | Organization | Device | Patient | RelatedPerson) Identifier of who
..... altId 0..1 string Alternative User identity
..... name 0..1 string Human friendly name for the agent
..... requestor Σ 1..1 boolean Whether user is initiator
..... location 0..1 Reference(Location) Where
..... policy 0..* uri Policy that authorized event
..... media 0..1 Coding Type of media
Binding: MediaTypeCode (extensible): Used when the event is about exporting/importing onto media.
..... network 0..1 BackboneElement Logical network location for application activity
...... 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
...... address 0..1 string Identifier for the network access point of the user device
...... type 0..1 code The type of network access point
Binding: AuditEventAgentNetworkType (required): The type of network access point of this agent in the audit event.
..... purposeOfUse 0..* CodeableConcept Reason given for this user
Binding: PurposeOfUse (extensible): The reason the activity took place.
.... agent:oClient S 1..1 BackboneElement OAuth2 ClientID. Known as `oClient` in IHE BALP
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... type 1..1 CodeableConcept How agent participated
Binding: ParticipationRoleType (extensible): The Participation type of the agent to the event.
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://dicom.nema.org/resources/ontology/DCM
....... version 0..1 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 110150
....... 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
..... role 0..* CodeableConcept Agent role in the event
Binding: SecurityRoleType (example): What security role enabled the agent to participate in the event.
..... who Σ 0..1 Reference(PractitionerRole | Practitioner | Organization | Device | Patient | RelatedPerson) Identifier of who
..... altId 0..1 string Alternative User identity
..... name 0..1 string Human friendly name for the agent
..... requestor Σ 1..1 boolean Whether user is initiator
..... location 0..1 Reference(Location) Where
..... policy 0..* uri Policy that authorized event
..... media 0..1 Coding Type of media
Binding: MediaTypeCode (extensible): Used when the event is about exporting/importing onto media.
..... network 0..1 BackboneElement Logical network location for application activity
...... 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
...... address 0..1 string Identifier for the network access point of the user device
...... type 0..1 code The type of network access point
Binding: AuditEventAgentNetworkType (required): The type of network access point of this agent in the audit event.
..... purposeOfUse 0..* CodeableConcept Reason given for this user
Binding: PurposeOfUse (extensible): The reason the activity took place.
.... agent:user 0..1 BackboneElement Actor involved in the event
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... type 1..1 CodeableConcept How agent participated
Binding: ParticipationRoleType (extensible): The Participation type of the agent to the event.
Required Pattern: At least the following
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ParticipationType
....... version 0..1 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: IRCP
....... display 0..1 string Representation defined by the system
....... userSelected 0..1 boolean If this coding was chosen directly by the user
...... text 0..1 string Plain text representation of the concept
..... role 0..* CodeableConcept Agent role in the event
Binding: SecurityRoleType (example): What security role enabled the agent to participate in the event.
..... who Σ 0..1 Reference(Practitioner) Identifier of who
...... 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 PractitionerIdentifier Logical reference, when literal reference is not known
...... display Σ 0..1 string Text alternative for the resource
..... altId 0..1 string Alternative User identity
..... name 0..1 string Human friendly name for the agent
..... requestor Σ 1..1 boolean Whether user is initiator
..... location 0..1 Reference(Location) Where
..... policy 0..* uri Policy that authorized event
..... media 0..1 Coding Type of media
Binding: MediaTypeCode (extensible): Used when the event is about exporting/importing onto media.
..... network 0..1 BackboneElement Logical network location for application activity
...... 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
...... address 0..1 string Identifier for the network access point of the user device
...... type 0..1 code The type of network access point
Binding: AuditEventAgentNetworkType (required): The type of network access point of this agent in the audit event.
..... purposeOfUse 0..* CodeableConcept Reason given for this user
Binding: PurposeOfUse (extensible): The reason the activity took place.
.... agent:server 1..1 BackboneElement Server DNS or IP address
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... type 1..1 CodeableConcept How agent participated
Binding: ParticipationRoleType (extensible): The Participation type of the agent to the event.
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://dicom.nema.org/resources/ontology/DCM
....... version 0..1 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 110152
....... 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
..... role 0..* CodeableConcept Agent role in the event
Binding: SecurityRoleType (example): What security role enabled the agent to participate in the event.
..... who Σ 0..1 Reference(Organization) Identifier of who
...... 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 OrganisationCode Logical reference, when literal reference is not known
...... display Σ 0..1 string Text alternative for the resource
..... altId 0..1 string Alternative User identity
..... name 0..1 string Human friendly name for the agent
..... requestor Σ 1..1 boolean Whether user is initiator
..... location 0..1 Reference(Location) Where
..... policy 0..* uri Policy that authorized event
..... media 0..1 Coding Type of media
Binding: MediaTypeCode (extensible): Used when the event is about exporting/importing onto media.
..... network 0..1 BackboneElement Logical network location for application activity
...... 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
...... address 0..1 string Identifier for the network access point of the user device
...... type 0..1 code The type of network access point
Binding: AuditEventAgentNetworkType (required): The type of network access point of this agent in the audit event.
..... purposeOfUse 0..* CodeableConcept Reason given for this user
Binding: PurposeOfUse (extensible): The reason the activity took place.
.... agent:client 0..1 BackboneElement Client DNS or IP address
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... type 1..1 CodeableConcept How agent participated
Binding: ParticipationRoleType (extensible): The Participation type of the agent to the event.
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://dicom.nema.org/resources/ontology/DCM
....... version 0..1 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 110153
....... 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
..... role 0..* CodeableConcept Agent role in the event
Binding: SecurityRoleType (example): What security role enabled the agent to participate in the event.
..... who Σ 0..1 Reference(Organization) Identifier of who
...... 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 OrganisationCode Logical reference, when literal reference is not known
...... display Σ 0..1 string Text alternative for the resource
..... altId 0..1 string Alternative User identity
..... name 0..1 string Human friendly name for the agent
..... requestor Σ 1..1 boolean Whether user is initiator
..... location 0..1 Reference(Location) Where
..... policy 0..* uri Policy that authorized event
..... media 0..1 Coding Type of media
Binding: MediaTypeCode (extensible): Used when the event is about exporting/importing onto media.
..... network 0..1 BackboneElement Logical network location for application activity
...... 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
...... address 0..1 string Identifier for the network access point of the user device
...... type 0..1 code The type of network access point
Binding: AuditEventAgentNetworkType (required): The type of network access point of this agent in the audit event.
..... purposeOfUse 0..* CodeableConcept Reason given for this user
Binding: PurposeOfUse (extensible): The reason the activity took place.
... source 1..1 BackboneElement Audit Event Reporter
.... 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
.... site 0..1 string Logical source location within the enterprise
.... observer Σ 1..1 Reference(PractitionerRole | Practitioner | Organization | Device | Patient | RelatedPerson) The identity of source detecting the event
.... type 0..* Coding The type of source where event originated
Binding: AuditEventSourceType (extensible): Code specifying the type of system that detected and recorded the event.
... Slices for entity C 1..* BackboneElement Data or objects used
Slice: Unordered, Open by value:type
Constraints: sev-1
.... entity:All Slices Content/Rules for all slices
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... what Σ 0..1 Reference(Resource) Specific instance of resource
..... type 0..1 Coding Type of entity involved
Binding: AuditEventEntityType (extensible): Code for the entity type involved in the audit event.
..... role 0..1 Coding What role the entity played
Binding: AuditEventEntityRole (extensible): Code representing the role the entity played in the audit event.
..... lifecycle 0..1 Coding Life-cycle stage for the entity
Binding: ObjectLifecycleEvents (extensible): Identifier for the data life-cycle stage for the entity.
..... securityLabel 0..* Coding Security labels on the entity
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
..... name ΣC 0..1 string Descriptor for entity
..... description 0..1 string Descriptive text
..... query ΣC 0..1 base64Binary Query parameters
..... detail 0..* BackboneElement Additional Information about the entity
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... type 1..1 string Name of the property
...... value[x] 1..1 Property value
....... valueString string
....... valueBase64Binary base64Binary
.... entity:transaction SC 1..1 BackboneElement (HL7 FHIR) RESTful HTTP Header: X-Request-ID
Constraints: sev-1
..... 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
..... what Σ 0..1 Reference(Resource) Specific instance of resource
..... type 1..1 Coding Type of entity involved
Binding: AuditEventEntityType (extensible): Code for the entity type involved in the audit event.
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: https://profiles.ihe.net/ITI/BALP/CodeSystem/BasicAuditEntityType
...... version 0..1 string Version of the system - if relevant
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: XrequestId
...... display 0..1 string Representation defined by the system
...... userSelected 0..1 boolean If this coding was chosen directly by the user
..... role 0..1 Coding What role the entity played
Binding: AuditEventEntityRole (extensible): Code representing the role the entity played in the audit event.
..... lifecycle 0..1 Coding Life-cycle stage for the entity
Binding: ObjectLifecycleEvents (extensible): Identifier for the data life-cycle stage for the entity.
..... securityLabel 0..* Coding Security labels on the entity
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
..... name ΣC 0..1 string Descriptor for entity
..... description 0..1 string Descriptive text
..... query ΣC 0..1 base64Binary Query parameters
..... detail 0..* BackboneElement Additional Information about the entity
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... type 1..1 string Name of the property
...... value[x] 1..1 Property value
....... valueString string
....... valueBase64Binary base64Binary
.... entity:message SC 0..1 BackboneElement HTTP Header: X-Correlation-ID, HL7 v2 MSH.10 - Message Control ID and HL7 FHIR Message Bundle.identifier.value
Constraints: sev-1
..... 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
..... what Σ 0..1 Reference(Resource) Specific instance of resource
..... type 1..1 Coding Type of entity involved
Binding: AuditEventEntityType (extensible): Code for the entity type involved in the audit event.
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: https://fhir.nwgenomics.nhs.uk/CodeSystem/BasicAuditEntityType
...... version 0..1 string Version of the system - if relevant
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: XcorrelationId
...... display 0..1 string Representation defined by the system
...... userSelected 0..1 boolean If this coding was chosen directly by the user
..... role 0..1 Coding What role the entity played
Binding: AuditEventEntityRole (extensible): Code representing the role the entity played in the audit event.
..... lifecycle 0..1 Coding Life-cycle stage for the entity
Binding: ObjectLifecycleEvents (extensible): Identifier for the data life-cycle stage for the entity.
..... securityLabel 0..* Coding Security labels on the entity
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
..... name ΣC 0..1 string Descriptor for entity
..... description 0..1 string Descriptive text
..... query ΣC 0..1 base64Binary Query parameters
..... detail 0..* BackboneElement Additional Information about the entity
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... type 1..1 string Name of the property
...... value[x] 1..1 Property value
....... valueString string
....... valueBase64Binary base64Binary
.... entity:query C 0..1 BackboneElement also known as `data` in IHE BALP
Constraints: sev-1
..... 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
..... what Σ 0..1 Reference(Resource) Specific instance of resource
..... type 1..1 Coding Type of entity involved
Binding: AuditEventEntityType (extensible): Code for the entity type involved in the audit event.
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://terminology.hl7.org/CodeSystem/audit-entity-type
...... version 0..1 string Version of the system - if relevant
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 2
...... display 0..1 string Representation defined by the system
...... userSelected 0..1 boolean If this coding was chosen directly by the user
..... role 0..1 Coding What role the entity played
Binding: AuditEventEntityRole (extensible): Code representing the role the entity played in the audit event.
..... lifecycle 0..1 Coding Life-cycle stage for the entity
Binding: ObjectLifecycleEvents (extensible): Identifier for the data life-cycle stage for the entity.
..... securityLabel 0..* Coding Security labels on the entity
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
..... name ΣC 0..1 string Descriptor for entity
..... description 0..1 string Descriptive text
..... query ΣC 0..1 base64Binary Query parameters
..... detail 0..* BackboneElement Additional Information about the entity
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... type 1..1 string Name of the property
...... value[x] 1..1 Property value
....... valueString string
....... valueBase64Binary base64Binary
.... entity:patient C 0..1 BackboneElement Patient reference plus NHS Number
Constraints: sev-1
..... 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
..... what Σ 0..1 Reference(Patient) Specific instance of resource
...... 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 NHSNumber Logical reference, when literal reference is not known
...... display Σ 0..1 string Text alternative for the resource
..... type 1..1 Coding Type of entity involved
Binding: AuditEventEntityType (extensible): Code for the entity type involved in the audit event.
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://terminology.hl7.org/CodeSystem/audit-entity-type
...... version 0..1 string Version of the system - if relevant
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 1
...... display 0..1 string Representation defined by the system
...... userSelected 0..1 boolean If this coding was chosen directly by the user
..... role 0..1 Coding What role the entity played
Binding: AuditEventEntityRole (extensible): Code representing the role the entity played in the audit event.
..... lifecycle 0..1 Coding Life-cycle stage for the entity
Binding: ObjectLifecycleEvents (extensible): Identifier for the data life-cycle stage for the entity.
..... securityLabel 0..* Coding Security labels on the entity
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
..... name ΣC 0..1 string Descriptor for entity
..... description 0..1 string Descriptive text
..... query ΣC 0..1 base64Binary Query parameters
..... detail 0..* BackboneElement Additional Information about the entity
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... type 1..1 string Name of the property
...... value[x] 1..1 Property value
....... valueString string
....... valueBase64Binary base64Binary

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
AuditEvent.language Base preferred Common Languages 📍4.0.1 FHIR Std.
AuditEvent.type Base extensible Audit Event ID 📍4.0.1 FHIR Std.
AuditEvent.subtype Base extensible Audit Event Sub-Type 📍4.0.1 FHIR Std.
AuditEvent.action Base required AuditEventAction 📍4.0.1 FHIR Std.
AuditEvent.outcome Base required AuditEventOutcome 📍4.0.1 FHIR Std.
AuditEvent.purposeOfEvent Base extensible PurposeOfUse 📦3.1.0 THO v7.0
AuditEvent.agent.type Base extensible ParticipationRoleType 📍4.0.1 FHIR Std.
AuditEvent.agent.role Base example SecurityRoleType 📍4.0.1 FHIR Std.
AuditEvent.agent.media Base extensible Media Type Code 📍4.0.1 FHIR Std.
AuditEvent.agent.network.​type Base required AuditEventAgentNetworkType 📍4.0.1 FHIR Std.
AuditEvent.agent.purposeOfUse Base extensible PurposeOfUse 📦3.1.0 THO v7.0
AuditEvent.agent:oClient.​type Base extensible ParticipationRoleType 📍4.0.1 FHIR Std.
AuditEvent.agent:oClient.​role Base example SecurityRoleType 📍4.0.1 FHIR Std.
AuditEvent.agent:oClient.​media Base extensible Media Type Code 📍4.0.1 FHIR Std.
AuditEvent.agent:oClient.​network.type Base required AuditEventAgentNetworkType 📍4.0.1 FHIR Std.
AuditEvent.agent:oClient.​purposeOfUse Base extensible PurposeOfUse 📦3.1.0 THO v7.0
AuditEvent.agent:user.​type Base extensible ParticipationRoleType 📍4.0.1 FHIR Std.
AuditEvent.agent:user.​role Base example SecurityRoleType 📍4.0.1 FHIR Std.
AuditEvent.agent:user.​who.type Base extensible ResourceType 📍4.0.1 FHIR Std.
AuditEvent.agent:user.​media Base extensible Media Type Code 📍4.0.1 FHIR Std.
AuditEvent.agent:user.​network.type Base required AuditEventAgentNetworkType 📍4.0.1 FHIR Std.
AuditEvent.agent:user.​purposeOfUse Base extensible PurposeOfUse 📦3.1.0 THO v7.0
AuditEvent.agent:server.​type Base extensible ParticipationRoleType 📍4.0.1 FHIR Std.
AuditEvent.agent:server.​role Base example SecurityRoleType 📍4.0.1 FHIR Std.
AuditEvent.agent:server.​who.type Base extensible ResourceType 📍4.0.1 FHIR Std.
AuditEvent.agent:server.​media Base extensible Media Type Code 📍4.0.1 FHIR Std.
AuditEvent.agent:server.​network.type Base required AuditEventAgentNetworkType 📍4.0.1 FHIR Std.
AuditEvent.agent:server.​purposeOfUse Base extensible PurposeOfUse 📦3.1.0 THO v7.0
AuditEvent.agent:client.​type Base extensible ParticipationRoleType 📍4.0.1 FHIR Std.
AuditEvent.agent:client.​role Base example SecurityRoleType 📍4.0.1 FHIR Std.
AuditEvent.agent:client.​who.type Base extensible ResourceType 📍4.0.1 FHIR Std.
AuditEvent.agent:client.​media Base extensible Media Type Code 📍4.0.1 FHIR Std.
AuditEvent.agent:client.​network.type Base required AuditEventAgentNetworkType 📍4.0.1 FHIR Std.
AuditEvent.agent:client.​purposeOfUse Base extensible PurposeOfUse 📦3.1.0 THO v7.0
AuditEvent.source.type Base extensible Audit Event Source Type 📍4.0.1 FHIR Std.
AuditEvent.entity.type Base extensible Audit event entity type 📍4.0.1 FHIR Std.
AuditEvent.entity.role Base extensible AuditEventEntityRole 📍4.0.1 FHIR Std.
AuditEvent.entity.lifecycle Base extensible ObjectLifecycleEvents 📍4.0.1 FHIR Std.
AuditEvent.entity.securityLabel Base extensible SecurityLabels 📍4.0.1 FHIR Std.
AuditEvent.entity:transaction.​type Base extensible Audit event entity type 📍4.0.1 FHIR Std.
AuditEvent.entity:transaction.​role Base extensible AuditEventEntityRole 📍4.0.1 FHIR Std.
AuditEvent.entity:transaction.​lifecycle Base extensible ObjectLifecycleEvents 📍4.0.1 FHIR Std.
AuditEvent.entity:transaction.​securityLabel Base extensible SecurityLabels 📍4.0.1 FHIR Std.
AuditEvent.entity:message.​type Base extensible Audit event entity type 📍4.0.1 FHIR Std.
AuditEvent.entity:message.​role Base extensible AuditEventEntityRole 📍4.0.1 FHIR Std.
AuditEvent.entity:message.​lifecycle Base extensible ObjectLifecycleEvents 📍4.0.1 FHIR Std.
AuditEvent.entity:message.​securityLabel Base extensible SecurityLabels 📍4.0.1 FHIR Std.
AuditEvent.entity:query.​type Base extensible Audit event entity type 📍4.0.1 FHIR Std.
AuditEvent.entity:query.​role Base extensible AuditEventEntityRole 📍4.0.1 FHIR Std.
AuditEvent.entity:query.​lifecycle Base extensible ObjectLifecycleEvents 📍4.0.1 FHIR Std.
AuditEvent.entity:query.​securityLabel Base extensible SecurityLabels 📍4.0.1 FHIR Std.
AuditEvent.entity:patient.​what.type Base extensible ResourceType 📍4.0.1 FHIR Std.
AuditEvent.entity:patient.​type Base extensible Audit event entity type 📍4.0.1 FHIR Std.
AuditEvent.entity:patient.​role Base extensible AuditEventEntityRole 📍4.0.1 FHIR Std.
AuditEvent.entity:patient.​lifecycle Base extensible ObjectLifecycleEvents 📍4.0.1 FHIR Std.
AuditEvent.entity:patient.​securityLabel Base extensible SecurityLabels 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error AuditEvent If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error AuditEvent 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 AuditEvent 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 AuditEvent If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice AuditEvent A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
sev-1 error AuditEvent.entity, AuditEvent.entity:transaction, AuditEvent.entity:message, AuditEvent.entity:query, AuditEvent.entity:patient Either a name or a query (NOT both) name.empty() or query.empty()

This structure is derived from AuditEvent

 

Other representations of profile: CSV, Excel, Schematron