Basic Audit Log Patterns (BALP)
1.1.4-current - ci-build
Basic Audit Log Patterns (BALP)
1.1.4-current - ci-build
Basic Audit Log Patterns (BALP), published by IHE IT Infrastructure Technical Committee. This guide is not an authorized publication; it is the continuous build for version 1.1.4-current built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/IHE/ITI.BasicAudit/ and changes regularly. See the Directory of published versions
| Official URL: https://profiles.ihe.net/ITI/BALP/StructureDefinition/IHE.BasicAudit.PatientRead | Version: 1.1.4-current | |||
| Active as of 2024-11-14 | Computable Name: PatientRead | |||
A basic AuditEvent profile for when a RESTful Read action happens successfully, and where there is an identifiable Patient subject associated with the read Resource.
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from Read
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  AuditEvent |
0..* | Read | Event record kept for security purposes | |
  entity |
2..* | BackboneElement | Data or objects used | |
  Slices for entity |
Content/Rules for all slices | |||
   entity:patient |
1..1 | BackboneElement | Data or objects used | |
  what |
1..1 | Reference(Patient) | Specific instance of resource | |
| 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 | |
 role |
1..1 | Coding | What role the entity played Required Pattern: At least the following | |
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/object-role | |
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: 1 | |
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| AuditEvent |
0..* | Read | 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 |
 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 | |
| Slices for subtype |
Σ | 1..* | Coding | More specific type/id for the event Slice: Unordered, Open by value:$this Binding: AuditEventSub-Type (extensible): Sub-type of event. |
| subtype:anyRead |
Σ | 1..1 | Coding | More specific type/id for the event Binding: all Reads (required) |
| recorded |
Σ | 1..1 | instant | Time when the event was recorded |
| outcome |
Σ | 1..1 | code | Whether the event succeeded or failed Binding: AuditEventOutcome (required): Indicates whether the event succeeded or failed. Required Pattern: 0 |
| Slices for agent |
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:client |
1..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 | |
| 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 |
Σ | 1..1 | Reference(PractitionerRole | Practitioner | Organization | Device | Patient | RelatedPerson) | Identifier of who |
| requestor |
Σ | 1..1 | boolean | Whether user is initiator |
| network |
1..1 | BackboneElement | Logical network location for application activity | |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| agent:server |
1..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 | |
| 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 |
Σ | 1..1 | Reference(PractitionerRole | Practitioner | Organization | Device | Patient | RelatedPerson) | Identifier of who |
| requestor |
Σ | 1..1 | boolean | Whether user is initiator |
| network |
1..1 | BackboneElement | Logical network location for application activity | |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| 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 | |
| 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 | |
| role |
S | 0..* | CodeableConcept | Agent role in the event Binding: SecurityRoleType (example): What security role enabled the agent to participate in the event. |
| who |
Σ | 1..1 | Reference(PractitionerRole | Practitioner | Organization | Device | Patient | RelatedPerson) | Identifier of who |
| name |
S | 0..1 | string | Human friendly name for the agent |
| requestor |
Σ | 1..1 | boolean | Whether user is initiator Required Pattern: true |
| purposeOfUse |
S | 0..* | CodeableConcept | Reason given for this user Binding: PurposeOfUse (extensible): The reason the activity took place. |
| source |
S | 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 | 2..* | BackboneElement | Data or objects used Slice: Unordered, Open by value:type sev-1: Either a name or a query (NOT both) |
| entity:All Slices |
Content/Rules for all slices | |||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| entity:transaction |
C | 0..1 | BackboneElement | Data or objects used sev-1: Either a name or a query (NOT both) |
| 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 | |
| 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:data |
C | 1..1 | BackboneElement | Data or objects used sev-1: Either a name or a query (NOT both) |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| what |
Σ | 1..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 | |
| 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 |
C | 1..1 | BackboneElement | Data or objects used sev-1: Either a name or a query (NOT both) |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| what |
Σ | 1..1 | Reference(Patient) | 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 | |
| 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 | |
| role |
1..1 | Coding | What role the entity played Binding: AuditEventEntityRole (extensible): Code representing the role the entity played in the audit event. Required Pattern: At least the following | |
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/object-role | |
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: 1 | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code | URI |
| AuditEvent.type | extensible | Pattern: resthttp://hl7.org/fhir/ValueSet/audit-event-typefrom the FHIR Standard | |
| AuditEvent.subtype | extensible | AuditEventSub-Typehttp://hl7.org/fhir/ValueSet/audit-event-sub-typefrom the FHIR Standard | |
| AuditEvent.subtype:anyRead | required | AllReadVShttps://profiles.ihe.net/ITI/BALP/ValueSet/AllReadVSfrom this IG | |
| AuditEvent.outcome | required | Pattern: 0http://hl7.org/fhir/ValueSet/audit-event-outcome|4.0.1from the FHIR Standard | |
| AuditEvent.agent:client.type | extensible | Pattern: 110152http://hl7.org/fhir/ValueSet/participation-role-typefrom the FHIR Standard | |
| AuditEvent.agent:server.type | extensible | Pattern: 110153http://hl7.org/fhir/ValueSet/participation-role-typefrom the FHIR Standard | |
| AuditEvent.agent:user.type | extensible | Pattern: IRCPhttp://hl7.org/fhir/ValueSet/participation-role-typefrom the FHIR Standard | |
| AuditEvent.agent:user.role | example | SecurityRoleTypehttp://hl7.org/fhir/ValueSet/security-role-typefrom the FHIR Standard | |
| AuditEvent.agent:user.purposeOfUse | extensible | PurposeOfUsehttp://terminology.hl7.org/ValueSet/v3-PurposeOfUse | |
| AuditEvent.entity:transaction.type | extensible | Pattern: XrequestIdhttp://hl7.org/fhir/ValueSet/audit-entity-typefrom the FHIR Standard | |
| AuditEvent.entity:data.type | extensible | Pattern: 2http://hl7.org/fhir/ValueSet/audit-entity-typefrom the FHIR Standard | |
| AuditEvent.entity:patient.type | extensible | Pattern: 1http://hl7.org/fhir/ValueSet/audit-entity-typefrom the FHIR Standard | |
| AuditEvent.entity:patient.role | extensible | Pattern: 1http://hl7.org/fhir/ValueSet/object-rolefrom the FHIR Standard |
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| AuditEvent |
0..* | Read | 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.
| |||||
| text |
0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
| 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 | |||||
| Slices for subtype |
Σ | 1..* | Coding | More specific type/id for the event Slice: Unordered, Open by value:$this Binding: AuditEventSub-Type (extensible): Sub-type of event. | ||||
| subtype:anyRead |
Σ | 1..1 | Coding | More specific type/id for the event Binding: all Reads (required) | ||||
| action |
Σ | 0..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. Required Pattern: R | ||||
| period |
0..1 | Period | When the activity occurred | |||||
| recorded |
Σ | 1..1 | instant | Time when the event was recorded | ||||
| outcome |
Σ | 1..1 | code | Whether the event succeeded or failed Binding: AuditEventOutcome (required): Indicates whether the event succeeded or failed. Required Pattern: 0 | ||||
| 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 |
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:client |
1..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://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 |
Σ | 1..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 | |||||
| network |
1..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 | 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://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 |
Σ | 1..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 | |||||
| network |
1..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 |
S | 0..* | CodeableConcept | Agent role in the event Binding: SecurityRoleType (example): What security role enabled the agent to participate in the event. | ||||
| who |
Σ | 1..1 | Reference(PractitionerRole | Practitioner | Organization | Device | Patient | RelatedPerson) | Identifier of who | ||||
| altId |
0..1 | string | Alternative User identity | |||||
| name |
S | 0..1 | string | Human friendly name for the agent | ||||
| requestor |
Σ | 1..1 | boolean | Whether user is initiator Required Pattern: true | ||||
| location |
0..1 | Reference(Location) | Where | |||||
| policy |
0..* | uri | Policy that authorized event | |||||
| purposeOfUse |
S | 0..* | CodeableConcept | Reason given for this user Binding: PurposeOfUse (extensible): The reason the activity took place. | ||||
| source |
S | 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 | 2..* | BackboneElement | Data or objects used Slice: Unordered, Open by value:type sev-1: Either a name or a query (NOT both) | ||||
| 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 |
C | 0..1 | BackboneElement | Data or objects used sev-1: Either a name or a query (NOT both) | ||||
| 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 | ||||
| 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 | Identifier | Logical reference, when literal reference is not known | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| use |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
| type |
Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
| system |
Σ | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
| value |
Σ | 1..1 | string | the value of X-Request-Id Example General: 123456 | ||||
| period |
Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
| assigner |
Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
| 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: 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:data |
C | 1..1 | BackboneElement | Data or objects used sev-1: Either a name or a query (NOT both) | ||||
| 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 |
Σ | 1..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: RESTful objects role in the event (required) | |||||
| 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 | may contain the security labels on the resource returned 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 | 1..1 | BackboneElement | Data or objects used sev-1: Either a name or a query (NOT both) | ||||
| 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 |
Σ | 1..1 | Reference(Patient) | 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: 1 | |||||
| display |
0..1 | string | Representation defined by the system | |||||
| userSelected |
0..1 | boolean | If this coding was chosen directly by the user | |||||
| role |
1..1 | Coding | What role the entity played Binding: AuditEventEntityRole (extensible): Code representing the role the entity played 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/object-role | |||||
| 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 | |||||
| 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 | |||||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet / Code | URI | |||
| AuditEvent.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard | ||||
| AuditEvent.type | extensible | Pattern: resthttp://hl7.org/fhir/ValueSet/audit-event-typefrom the FHIR Standard | ||||
| AuditEvent.subtype | extensible | AuditEventSub-Typehttp://hl7.org/fhir/ValueSet/audit-event-sub-typefrom the FHIR Standard | ||||
| AuditEvent.subtype:anyRead | required | AllReadVShttps://profiles.ihe.net/ITI/BALP/ValueSet/AllReadVSfrom this IG | ||||
| AuditEvent.action | required | Pattern: Rhttp://hl7.org/fhir/ValueSet/audit-event-action|4.0.1from the FHIR Standard | ||||
| AuditEvent.outcome | required | Pattern: 0http://hl7.org/fhir/ValueSet/audit-event-outcome|4.0.1from the FHIR Standard | ||||
| AuditEvent.purposeOfEvent | extensible | PurposeOfUsehttp://terminology.hl7.org/ValueSet/v3-PurposeOfUse | ||||
| AuditEvent.agent.type | extensible | ParticipationRoleTypehttp://hl7.org/fhir/ValueSet/participation-role-typefrom the FHIR Standard | ||||
| AuditEvent.agent.role | example | SecurityRoleTypehttp://hl7.org/fhir/ValueSet/security-role-typefrom the FHIR Standard | ||||
| AuditEvent.agent.media | extensible | MediaTypeCodehttp://hl7.org/fhir/ValueSet/dicm-405-mediatypefrom the FHIR Standard | ||||
| AuditEvent.agent.network.type | required | AuditEventAgentNetworkTypehttp://hl7.org/fhir/ValueSet/network-type|4.0.1from the FHIR Standard | ||||
| AuditEvent.agent.purposeOfUse | extensible | PurposeOfUsehttp://terminology.hl7.org/ValueSet/v3-PurposeOfUse | ||||
| AuditEvent.agent:client.type | extensible | Pattern: 110152http://hl7.org/fhir/ValueSet/participation-role-typefrom the FHIR Standard | ||||
| AuditEvent.agent:client.role | example | SecurityRoleTypehttp://hl7.org/fhir/ValueSet/security-role-typefrom the FHIR Standard | ||||
| AuditEvent.agent:client.network.type | required | AuditEventAgentNetworkTypehttp://hl7.org/fhir/ValueSet/network-type|4.0.1from the FHIR Standard | ||||
| AuditEvent.agent:client.purposeOfUse | extensible | PurposeOfUsehttp://terminology.hl7.org/ValueSet/v3-PurposeOfUse | ||||
| AuditEvent.agent:server.type | extensible | Pattern: 110153http://hl7.org/fhir/ValueSet/participation-role-typefrom the FHIR Standard | ||||
| AuditEvent.agent:server.role | example | SecurityRoleTypehttp://hl7.org/fhir/ValueSet/security-role-typefrom the FHIR Standard | ||||
| AuditEvent.agent:server.network.type | required | AuditEventAgentNetworkTypehttp://hl7.org/fhir/ValueSet/network-type|4.0.1from the FHIR Standard | ||||
| AuditEvent.agent:server.purposeOfUse | extensible | PurposeOfUsehttp://terminology.hl7.org/ValueSet/v3-PurposeOfUse | ||||
| AuditEvent.agent:user.type | extensible | Pattern: IRCPhttp://hl7.org/fhir/ValueSet/participation-role-typefrom the FHIR Standard | ||||
| AuditEvent.agent:user.role | example | SecurityRoleTypehttp://hl7.org/fhir/ValueSet/security-role-typefrom the FHIR Standard | ||||
| AuditEvent.agent:user.network.type | required | AuditEventAgentNetworkTypehttp://hl7.org/fhir/ValueSet/network-type|4.0.1from the FHIR Standard | ||||
| AuditEvent.agent:user.purposeOfUse | extensible | PurposeOfUsehttp://terminology.hl7.org/ValueSet/v3-PurposeOfUse | ||||
| AuditEvent.source.type | extensible | AuditEventSourceTypehttp://hl7.org/fhir/ValueSet/audit-source-typefrom the FHIR Standard | ||||
| AuditEvent.entity.type | extensible | AuditEventEntityTypehttp://hl7.org/fhir/ValueSet/audit-entity-typefrom the FHIR Standard | ||||
| AuditEvent.entity.role | extensible | AuditEventEntityRolehttp://hl7.org/fhir/ValueSet/object-rolefrom the FHIR Standard | ||||
| AuditEvent.entity.lifecycle | extensible | ObjectLifecycleEventshttp://hl7.org/fhir/ValueSet/object-lifecycle-events | ||||
| AuditEvent.entity.securityLabel | extensible | All Security Labelshttp://hl7.org/fhir/ValueSet/security-labelsfrom the FHIR Standard | ||||
| AuditEvent.entity:transaction.what.type | extensible | ResourceTypehttp://hl7.org/fhir/ValueSet/resource-typesfrom the FHIR Standard | ||||
| AuditEvent.entity:transaction.what.identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1from the FHIR Standard | ||||
| AuditEvent.entity:transaction.what.identifier.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-typefrom the FHIR Standard | ||||
| AuditEvent.entity:transaction.type | extensible | Pattern: XrequestIdhttp://hl7.org/fhir/ValueSet/audit-entity-typefrom the FHIR Standard | ||||
| AuditEvent.entity:transaction.role | extensible | AuditEventEntityRolehttp://hl7.org/fhir/ValueSet/object-rolefrom the FHIR Standard | ||||
| AuditEvent.entity:transaction.lifecycle | extensible | ObjectLifecycleEventshttp://hl7.org/fhir/ValueSet/object-lifecycle-events | ||||
| AuditEvent.entity:transaction.securityLabel | extensible | All Security Labelshttp://hl7.org/fhir/ValueSet/security-labelsfrom the FHIR Standard | ||||
| AuditEvent.entity:data.type | extensible | Pattern: 2http://hl7.org/fhir/ValueSet/audit-entity-typefrom the FHIR Standard | ||||
| AuditEvent.entity:data.role | required | RestObjectRoleshttps://profiles.ihe.net/ITI/BALP/ValueSet/RestObjectRolesfrom this IG | ||||
| AuditEvent.entity:data.lifecycle | extensible | ObjectLifecycleEventshttp://hl7.org/fhir/ValueSet/object-lifecycle-events | ||||
| AuditEvent.entity:data.securityLabel | extensible | All Security Labelshttp://hl7.org/fhir/ValueSet/security-labelsfrom the FHIR Standard | ||||
| AuditEvent.entity:patient.type | extensible | Pattern: 1http://hl7.org/fhir/ValueSet/audit-entity-typefrom the FHIR Standard | ||||
| AuditEvent.entity:patient.role | extensible | Pattern: 1http://hl7.org/fhir/ValueSet/object-rolefrom the FHIR Standard | ||||
| AuditEvent.entity:patient.lifecycle | extensible | ObjectLifecycleEventshttp://hl7.org/fhir/ValueSet/object-lifecycle-events | ||||
| AuditEvent.entity:patient.securityLabel | extensible | All Security Labelshttp://hl7.org/fhir/ValueSet/security-labelsfrom the FHIR Standard |
This structure is derived from Read
Differential View
This structure is derived from Read
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| AuditEvent |
0..* | Read | Event record kept for security purposes | |
| entity |
2..* | BackboneElement | Data or objects used | |
| Slices for entity |
Content/Rules for all slices | |||
| entity:patient |
1..1 | BackboneElement | Data or objects used | |
| what |
1..1 | Reference(Patient) | Specific instance of resource | |
| 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 | |
| role |
1..1 | Coding | What role the entity played Required Pattern: At least the following | |
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/object-role | |
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: 1 | |
| Documentation for this format | ||||
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| AuditEvent |
0..* | Read | 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 |
| 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 | |
| Slices for subtype |
Σ | 1..* | Coding | More specific type/id for the event Slice: Unordered, Open by value:$this Binding: AuditEventSub-Type (extensible): Sub-type of event. |
| subtype:anyRead |
Σ | 1..1 | Coding | More specific type/id for the event Binding: all Reads (required) |
| recorded |
Σ | 1..1 | instant | Time when the event was recorded |
| outcome |
Σ | 1..1 | code | Whether the event succeeded or failed Binding: AuditEventOutcome (required): Indicates whether the event succeeded or failed. Required Pattern: 0 |
| Slices for agent |
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:client |
1..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 | |
| 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 |
Σ | 1..1 | Reference(PractitionerRole | Practitioner | Organization | Device | Patient | RelatedPerson) | Identifier of who |
| requestor |
Σ | 1..1 | boolean | Whether user is initiator |
| network |
1..1 | BackboneElement | Logical network location for application activity | |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| agent:server |
1..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 | |
| 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 |
Σ | 1..1 | Reference(PractitionerRole | Practitioner | Organization | Device | Patient | RelatedPerson) | Identifier of who |
| requestor |
Σ | 1..1 | boolean | Whether user is initiator |
| network |
1..1 | BackboneElement | Logical network location for application activity | |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| 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 | |
| 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 | |
| role |
S | 0..* | CodeableConcept | Agent role in the event Binding: SecurityRoleType (example): What security role enabled the agent to participate in the event. |
| who |
Σ | 1..1 | Reference(PractitionerRole | Practitioner | Organization | Device | Patient | RelatedPerson) | Identifier of who |
| name |
S | 0..1 | string | Human friendly name for the agent |
| requestor |
Σ | 1..1 | boolean | Whether user is initiator Required Pattern: true |
| purposeOfUse |
S | 0..* | CodeableConcept | Reason given for this user Binding: PurposeOfUse (extensible): The reason the activity took place. |
| source |
S | 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 | 2..* | BackboneElement | Data or objects used Slice: Unordered, Open by value:type sev-1: Either a name or a query (NOT both) |
| entity:All Slices |
Content/Rules for all slices | |||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| entity:transaction |
C | 0..1 | BackboneElement | Data or objects used sev-1: Either a name or a query (NOT both) |
| 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 | |
| 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:data |
C | 1..1 | BackboneElement | Data or objects used sev-1: Either a name or a query (NOT both) |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| what |
Σ | 1..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 | |
| 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 |
C | 1..1 | BackboneElement | Data or objects used sev-1: Either a name or a query (NOT both) |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| what |
Σ | 1..1 | Reference(Patient) | 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 | |
| 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 | |
| role |
1..1 | Coding | What role the entity played Binding: AuditEventEntityRole (extensible): Code representing the role the entity played in the audit event. Required Pattern: At least the following | |
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/object-role | |
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: 1 | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code | URI |
| AuditEvent.type | extensible | Pattern: resthttp://hl7.org/fhir/ValueSet/audit-event-typefrom the FHIR Standard | |
| AuditEvent.subtype | extensible | AuditEventSub-Typehttp://hl7.org/fhir/ValueSet/audit-event-sub-typefrom the FHIR Standard | |
| AuditEvent.subtype:anyRead | required | AllReadVShttps://profiles.ihe.net/ITI/BALP/ValueSet/AllReadVSfrom this IG | |
| AuditEvent.outcome | required | Pattern: 0http://hl7.org/fhir/ValueSet/audit-event-outcome|4.0.1from the FHIR Standard | |
| AuditEvent.agent:client.type | extensible | Pattern: 110152http://hl7.org/fhir/ValueSet/participation-role-typefrom the FHIR Standard | |
| AuditEvent.agent:server.type | extensible | Pattern: 110153http://hl7.org/fhir/ValueSet/participation-role-typefrom the FHIR Standard | |
| AuditEvent.agent:user.type | extensible | Pattern: IRCPhttp://hl7.org/fhir/ValueSet/participation-role-typefrom the FHIR Standard | |
| AuditEvent.agent:user.role | example | SecurityRoleTypehttp://hl7.org/fhir/ValueSet/security-role-typefrom the FHIR Standard | |
| AuditEvent.agent:user.purposeOfUse | extensible | PurposeOfUsehttp://terminology.hl7.org/ValueSet/v3-PurposeOfUse | |
| AuditEvent.entity:transaction.type | extensible | Pattern: XrequestIdhttp://hl7.org/fhir/ValueSet/audit-entity-typefrom the FHIR Standard | |
| AuditEvent.entity:data.type | extensible | Pattern: 2http://hl7.org/fhir/ValueSet/audit-entity-typefrom the FHIR Standard | |
| AuditEvent.entity:patient.type | extensible | Pattern: 1http://hl7.org/fhir/ValueSet/audit-entity-typefrom the FHIR Standard | |
| AuditEvent.entity:patient.role | extensible | Pattern: 1http://hl7.org/fhir/ValueSet/object-rolefrom the FHIR Standard |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| AuditEvent |
0..* | Read | 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.
| |||||
| text |
0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
| 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 | |||||
| Slices for subtype |
Σ | 1..* | Coding | More specific type/id for the event Slice: Unordered, Open by value:$this Binding: AuditEventSub-Type (extensible): Sub-type of event. | ||||
| subtype:anyRead |
Σ | 1..1 | Coding | More specific type/id for the event Binding: all Reads (required) | ||||
| action |
Σ | 0..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. Required Pattern: R | ||||
| period |
0..1 | Period | When the activity occurred | |||||
| recorded |
Σ | 1..1 | instant | Time when the event was recorded | ||||
| outcome |
Σ | 1..1 | code | Whether the event succeeded or failed Binding: AuditEventOutcome (required): Indicates whether the event succeeded or failed. Required Pattern: 0 | ||||
| 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 |
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:client |
1..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://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 |
Σ | 1..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 | |||||
| network |
1..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 | 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://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 |
Σ | 1..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 | |||||
| network |
1..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 |
S | 0..* | CodeableConcept | Agent role in the event Binding: SecurityRoleType (example): What security role enabled the agent to participate in the event. | ||||
| who |
Σ | 1..1 | Reference(PractitionerRole | Practitioner | Organization | Device | Patient | RelatedPerson) | Identifier of who | ||||
| altId |
0..1 | string | Alternative User identity | |||||
| name |
S | 0..1 | string | Human friendly name for the agent | ||||
| requestor |
Σ | 1..1 | boolean | Whether user is initiator Required Pattern: true | ||||
| location |
0..1 | Reference(Location) | Where | |||||
| policy |
0..* | uri | Policy that authorized event | |||||
| purposeOfUse |
S | 0..* | CodeableConcept | Reason given for this user Binding: PurposeOfUse (extensible): The reason the activity took place. | ||||
| source |
S | 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 | 2..* | BackboneElement | Data or objects used Slice: Unordered, Open by value:type sev-1: Either a name or a query (NOT both) | ||||
| 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 |
C | 0..1 | BackboneElement | Data or objects used sev-1: Either a name or a query (NOT both) | ||||
| 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 | ||||
| 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 | Identifier | Logical reference, when literal reference is not known | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| use |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
| type |
Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
| system |
Σ | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
| value |
Σ | 1..1 | string | the value of X-Request-Id Example General: 123456 | ||||
| period |
Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
| assigner |
Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
| 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: 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:data |
C | 1..1 | BackboneElement | Data or objects used sev-1: Either a name or a query (NOT both) | ||||
| 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 |
Σ | 1..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: RESTful objects role in the event (required) | |||||
| 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 | may contain the security labels on the resource returned 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 | 1..1 | BackboneElement | Data or objects used sev-1: Either a name or a query (NOT both) | ||||
| 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 |
Σ | 1..1 | Reference(Patient) | 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: 1 | |||||
| display |
0..1 | string | Representation defined by the system | |||||
| userSelected |
0..1 | boolean | If this coding was chosen directly by the user | |||||
| role |
1..1 | Coding | What role the entity played Binding: AuditEventEntityRole (extensible): Code representing the role the entity played 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/object-role | |||||
| 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 | |||||
| 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 | |||||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet / Code | URI | |||
| AuditEvent.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard | ||||
| AuditEvent.type | extensible | Pattern: resthttp://hl7.org/fhir/ValueSet/audit-event-typefrom the FHIR Standard | ||||
| AuditEvent.subtype | extensible | AuditEventSub-Typehttp://hl7.org/fhir/ValueSet/audit-event-sub-typefrom the FHIR Standard | ||||
| AuditEvent.subtype:anyRead | required | AllReadVShttps://profiles.ihe.net/ITI/BALP/ValueSet/AllReadVSfrom this IG | ||||
| AuditEvent.action | required | Pattern: Rhttp://hl7.org/fhir/ValueSet/audit-event-action|4.0.1from the FHIR Standard | ||||
| AuditEvent.outcome | required | Pattern: 0http://hl7.org/fhir/ValueSet/audit-event-outcome|4.0.1from the FHIR Standard | ||||
| AuditEvent.purposeOfEvent | extensible | PurposeOfUsehttp://terminology.hl7.org/ValueSet/v3-PurposeOfUse | ||||
| AuditEvent.agent.type | extensible | ParticipationRoleTypehttp://hl7.org/fhir/ValueSet/participation-role-typefrom the FHIR Standard | ||||
| AuditEvent.agent.role | example | SecurityRoleTypehttp://hl7.org/fhir/ValueSet/security-role-typefrom the FHIR Standard | ||||
| AuditEvent.agent.media | extensible | MediaTypeCodehttp://hl7.org/fhir/ValueSet/dicm-405-mediatypefrom the FHIR Standard | ||||
| AuditEvent.agent.network.type | required | AuditEventAgentNetworkTypehttp://hl7.org/fhir/ValueSet/network-type|4.0.1from the FHIR Standard | ||||
| AuditEvent.agent.purposeOfUse | extensible | PurposeOfUsehttp://terminology.hl7.org/ValueSet/v3-PurposeOfUse | ||||
| AuditEvent.agent:client.type | extensible | Pattern: 110152http://hl7.org/fhir/ValueSet/participation-role-typefrom the FHIR Standard | ||||
| AuditEvent.agent:client.role | example | SecurityRoleTypehttp://hl7.org/fhir/ValueSet/security-role-typefrom the FHIR Standard | ||||
| AuditEvent.agent:client.network.type | required | AuditEventAgentNetworkTypehttp://hl7.org/fhir/ValueSet/network-type|4.0.1from the FHIR Standard | ||||
| AuditEvent.agent:client.purposeOfUse | extensible | PurposeOfUsehttp://terminology.hl7.org/ValueSet/v3-PurposeOfUse | ||||
| AuditEvent.agent:server.type | extensible | Pattern: 110153http://hl7.org/fhir/ValueSet/participation-role-typefrom the FHIR Standard | ||||
| AuditEvent.agent:server.role | example | SecurityRoleTypehttp://hl7.org/fhir/ValueSet/security-role-typefrom the FHIR Standard | ||||
| AuditEvent.agent:server.network.type | required | AuditEventAgentNetworkTypehttp://hl7.org/fhir/ValueSet/network-type|4.0.1from the FHIR Standard | ||||
| AuditEvent.agent:server.purposeOfUse | extensible | PurposeOfUsehttp://terminology.hl7.org/ValueSet/v3-PurposeOfUse | ||||
| AuditEvent.agent:user.type | extensible | Pattern: IRCPhttp://hl7.org/fhir/ValueSet/participation-role-typefrom the FHIR Standard | ||||
| AuditEvent.agent:user.role | example | SecurityRoleTypehttp://hl7.org/fhir/ValueSet/security-role-typefrom the FHIR Standard | ||||
| AuditEvent.agent:user.network.type | required | AuditEventAgentNetworkTypehttp://hl7.org/fhir/ValueSet/network-type|4.0.1from the FHIR Standard | ||||
| AuditEvent.agent:user.purposeOfUse | extensible | PurposeOfUsehttp://terminology.hl7.org/ValueSet/v3-PurposeOfUse | ||||
| AuditEvent.source.type | extensible | AuditEventSourceTypehttp://hl7.org/fhir/ValueSet/audit-source-typefrom the FHIR Standard | ||||
| AuditEvent.entity.type | extensible | AuditEventEntityTypehttp://hl7.org/fhir/ValueSet/audit-entity-typefrom the FHIR Standard | ||||
| AuditEvent.entity.role | extensible | AuditEventEntityRolehttp://hl7.org/fhir/ValueSet/object-rolefrom the FHIR Standard | ||||
| AuditEvent.entity.lifecycle | extensible | ObjectLifecycleEventshttp://hl7.org/fhir/ValueSet/object-lifecycle-events | ||||
| AuditEvent.entity.securityLabel | extensible | All Security Labelshttp://hl7.org/fhir/ValueSet/security-labelsfrom the FHIR Standard | ||||
| AuditEvent.entity:transaction.what.type | extensible | ResourceTypehttp://hl7.org/fhir/ValueSet/resource-typesfrom the FHIR Standard | ||||
| AuditEvent.entity:transaction.what.identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1from the FHIR Standard | ||||
| AuditEvent.entity:transaction.what.identifier.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-typefrom the FHIR Standard | ||||
| AuditEvent.entity:transaction.type | extensible | Pattern: XrequestIdhttp://hl7.org/fhir/ValueSet/audit-entity-typefrom the FHIR Standard | ||||
| AuditEvent.entity:transaction.role | extensible | AuditEventEntityRolehttp://hl7.org/fhir/ValueSet/object-rolefrom the FHIR Standard | ||||
| AuditEvent.entity:transaction.lifecycle | extensible | ObjectLifecycleEventshttp://hl7.org/fhir/ValueSet/object-lifecycle-events | ||||
| AuditEvent.entity:transaction.securityLabel | extensible | All Security Labelshttp://hl7.org/fhir/ValueSet/security-labelsfrom the FHIR Standard | ||||
| AuditEvent.entity:data.type | extensible | Pattern: 2http://hl7.org/fhir/ValueSet/audit-entity-typefrom the FHIR Standard | ||||
| AuditEvent.entity:data.role | required | RestObjectRoleshttps://profiles.ihe.net/ITI/BALP/ValueSet/RestObjectRolesfrom this IG | ||||
| AuditEvent.entity:data.lifecycle | extensible | ObjectLifecycleEventshttp://hl7.org/fhir/ValueSet/object-lifecycle-events | ||||
| AuditEvent.entity:data.securityLabel | extensible | All Security Labelshttp://hl7.org/fhir/ValueSet/security-labelsfrom the FHIR Standard | ||||
| AuditEvent.entity:patient.type | extensible | Pattern: 1http://hl7.org/fhir/ValueSet/audit-entity-typefrom the FHIR Standard | ||||
| AuditEvent.entity:patient.role | extensible | Pattern: 1http://hl7.org/fhir/ValueSet/object-rolefrom the FHIR Standard | ||||
| AuditEvent.entity:patient.lifecycle | extensible | ObjectLifecycleEventshttp://hl7.org/fhir/ValueSet/object-lifecycle-events | ||||
| AuditEvent.entity:patient.securityLabel | extensible | All Security Labelshttp://hl7.org/fhir/ValueSet/security-labelsfrom the FHIR Standard |
This structure is derived from Read
Other representations of profile: CSV, Excel, Schematron
IG © 2022+ IHE IT Infrastructure Technical Committee. Package ihe.iti.balp#1.1.4-current based on FHIR 4.0.1. Generated 2024-11-14
Links: Table of Contents |
QA Report
| New Issue | Issues
Version History |
|
Propose a change