Sharing Valuesets, Codes, and Maps (SVCM)
1.5.1 - Trial-Implementation
Sharing Valuesets, Codes, and Maps (SVCM)
1.5.1 - Trial-Implementation
This page is part of the Sharing Valuesets, Codes, and Maps (SVCM) (v1.5.1: Publication) based on FHIR R4. This is the current published version. For a full list of available versions, see the Directory of published versions 
| Official URL: https://profiles.ihe.net/ITI/SVCM/StructureDefinition/IHE.SVCM.Audit.Operation | Version: 1.5.1 | |||
| Active as of 2023-08-02 | Computable Name: OperationEvent | |||
A basic AuditEvent profile for when a RESTful Operation action happens successfully.
Note: the pattern defined in DICOM and IHE have the client is identified as the Source Role ID, and the server is identified as the Destination Role ID. This represents the query parameters are flowing from the client to the server. This may not be so obvious, as the data actually flows the opposite direction. This pattern is established and thus followed here.
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from AuditEvent
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  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 | |
 display | 1..1 | string | Representation defined by the system Fixed Value: Restful Operation | |
 Slices for subtype | 1..* | Coding | More specific type/id for the event Slice: Unordered, Open by value:$this | |
  subtype:operation | 1..1 | Coding | More specific type/id for the event Required Pattern: At least the following | |
  system | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/restful-interaction | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: operation | |
 display | 1..1 | string | Representation defined by the system Fixed Value: operation | |
| action | 0..1 | code | Type of action performed during the event Required Pattern: E | |
| outcome | 0..1 | code | Whether the event succeeded or failed Required Pattern: 0 | |
| Slices for agent | 2..* | BackboneElement | Actor involved in the event Slice: Unordered, Open by pattern:type | |
 agent:client | 1..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://dicom.nema.org/resources/ontology/DCM | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 110153 | |
| display | 1..1 | string | Representation defined by the system Fixed Value: Source Role ID | |
| who | 1..1 | Reference(PractitionerRole | Practitioner | Organization | Device | Patient | RelatedPerson) | Identifier of who | |
| media | 0..0 | |||
| network | 1..1 | BackboneElement | Logical network location for application activity | |
| agent:server | 1..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://dicom.nema.org/resources/ontology/DCM | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 110152 | |
| display | 1..1 | string | Representation defined by the system Fixed Value: Destination Role ID | |
| who | 1..1 | Reference(PractitionerRole | Practitioner | Organization | Device | Patient | RelatedPerson) | Identifier of who | |
| media | 0..0 | |||
| network | 1..1 | BackboneElement | Logical network location for application activity | |
| 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 | |
| display | 1..1 | string | Representation defined by the system Fixed Value: information recipient | |
| role | S | 0..* | CodeableConcept | Agent role 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 | |
| media | 0..0 | |||
| network | 0..0 | |||
| purposeOfUse | S | 0..* | CodeableConcept | Reason given for this user |
| source | S | 1..1 | BackboneElement | Audit Event Reporter |
| Slices for entity | 1..* | BackboneElement | Data or objects used Slice: Unordered, Open by pattern:type | |
| entity:transaction | 0..1 | BackboneElement | Data or objects used | |
| what | ||||
| identifier | ||||
| value | 1..1 | string | the value of 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:parameters | 1..1 | BackboneElement | Data or objects used | |
 what | 1..1 | Reference(Parameters) | 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: 2 | |
| display | 1..1 | string | Representation defined by the system Fixed Value: System Object | |
| role | 0..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: 4 | |
| display | 1..1 | string | Representation defined by the system Fixed Value: Domain Resource | |
| lifecycle | 0..0 | |||
| securityLabel | 0..* | Coding | may contain the security labels on the Bundle search set returned | |
| query | 0..0 | |||
| detail | 0..0 | |||
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| 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 |
| 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 | |
| display | 1..1 | string | Representation defined by the system Fixed Value: Restful Operation | |
| 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:operation | Σ | 1..1 | Coding | More specific type/id for the event Binding: AuditEventSub-Type (extensible): Sub-type of event. Required Pattern: At least the following |
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/restful-interaction | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: operation | |
| display | 1..1 | string | Representation defined by the system Fixed Value: operation | |
| 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: E |
| 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. Required Pattern: 0 |
| Slices for agent | 2..* | BackboneElement | Actor involved in the event Slice: Unordered, Open by pattern: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: 110153 | |
| display | 1..1 | string | Representation defined by the system Fixed Value: Source Role ID | |
| 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: 110152 | |
| display | 1..1 | string | Representation defined by the system Fixed Value: Destination Role ID | |
| 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 | |
| display | 1..1 | string | Representation defined by the system Fixed Value: information recipient | |
| 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 | 1..* | BackboneElement | Data or objects used Slice: Unordered, Open by pattern:type |
| 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 |
| 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:parameters | C | 1..1 | BackboneElement | Data or objects used |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| what | Σ | 1..1 | Reference(Parameters) | 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 | |
| display | 1..1 | string | Representation defined by the system Fixed Value: System Object | |
| role | 0..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: 4 | |
| display | 1..1 | string | Representation defined by the system Fixed Value: Domain Resource | |
| securityLabel | 0..* | Coding | may contain the security labels on the Bundle search set returned Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code |
| AuditEvent.type | extensible | Pattern: rest("Restful Operation") |
| AuditEvent.subtype | extensible | AuditEventSub-Type |
| AuditEvent.subtype:operation | extensible | Pattern: operation("operation") |
| AuditEvent.action | required | Pattern: E |
| AuditEvent.outcome | required | Pattern: 0 |
| AuditEvent.agent:client.type | extensible | Pattern: 110153("Source Role ID") |
| AuditEvent.agent:server.type | extensible | Pattern: 110152("Destination Role ID") |
| AuditEvent.agent:user.type | extensible | Pattern: IRCP("information recipient") |
| AuditEvent.agent:user.role | example | SecurityRoleType |
| AuditEvent.agent:user.purposeOfUse | extensible | PurposeOfUse |
| AuditEvent.entity:transaction.type | extensible | Pattern: XrequestId |
| AuditEvent.entity:parameters.type | extensible | Pattern: 2("System Object") |
| AuditEvent.entity:parameters.role | extensible | Pattern: 4("Domain Resource") |
| AuditEvent.entity:parameters.securityLabel | extensible | All Security Labels |
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| 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.
| |||||
| 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 | 1..1 | string | Representation defined by the system Fixed Value: Restful Operation | |||||
| 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:operation | Σ | 1..1 | Coding | More specific type/id for the event Binding: AuditEventSub-Type (extensible): Sub-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://hl7.org/fhir/restful-interaction | |||||
| version | 0..1 | string | Version of the system - if relevant | |||||
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: operation | |||||
| display | 1..1 | string | Representation defined by the system Fixed Value: operation | |||||
| userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |||||
| 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: E | ||||
| 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. 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 pattern: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: 110153 | |||||
| display | 1..1 | string | Representation defined by the system Fixed Value: Source Role ID | |||||
| 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: 110152 | |||||
| display | 1..1 | string | Representation defined by the system Fixed Value: Destination Role ID | |||||
| 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 | 1..1 | string | Representation defined by the system Fixed Value: information recipient | |||||
| 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 | 1..* | BackboneElement | Data or objects used Slice: Unordered, Open by pattern:type | ||||
| 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 | ||||
| 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:parameters | C | 1..1 | BackboneElement | Data or objects used | ||||
| 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(Parameters) | 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 | 1..1 | string | Representation defined by the system Fixed Value: System Object | |||||
| 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. 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: 4 | |||||
| display | 1..1 | string | Representation defined by the system Fixed Value: Domain Resource | |||||
| userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |||||
| securityLabel | 0..* | Coding | may contain the security labels on the Bundle search set 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 | |||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet / Code | ||||
| AuditEvent.language | preferred | CommonLanguages
| ||||
| AuditEvent.type | extensible | Pattern: rest("Restful Operation") | ||||
| AuditEvent.subtype | extensible | AuditEventSub-Type | ||||
| AuditEvent.subtype:operation | extensible | Pattern: operation("operation") | ||||
| AuditEvent.action | required | Pattern: E | ||||
| AuditEvent.outcome | required | Pattern: 0 | ||||
| AuditEvent.purposeOfEvent | extensible | PurposeOfUse | ||||
| AuditEvent.agent.type | extensible | ParticipationRoleType | ||||
| AuditEvent.agent.role | example | SecurityRoleType | ||||
| AuditEvent.agent.media | extensible | MediaTypeCode | ||||
| AuditEvent.agent.network.type | required | AuditEventAgentNetworkType | ||||
| AuditEvent.agent.purposeOfUse | extensible | PurposeOfUse | ||||
| AuditEvent.agent:client.type | extensible | Pattern: 110153("Source Role ID") | ||||
| AuditEvent.agent:client.role | example | SecurityRoleType | ||||
| AuditEvent.agent:client.network.type | required | AuditEventAgentNetworkType | ||||
| AuditEvent.agent:client.purposeOfUse | extensible | PurposeOfUse | ||||
| AuditEvent.agent:server.type | extensible | Pattern: 110152("Destination Role ID") | ||||
| AuditEvent.agent:server.role | example | SecurityRoleType | ||||
| AuditEvent.agent:server.network.type | required | AuditEventAgentNetworkType | ||||
| AuditEvent.agent:server.purposeOfUse | extensible | PurposeOfUse | ||||
| AuditEvent.agent:user.type | extensible | Pattern: IRCP("information recipient") | ||||
| AuditEvent.agent:user.role | example | SecurityRoleType | ||||
| AuditEvent.agent:user.network.type | required | AuditEventAgentNetworkType | ||||
| AuditEvent.agent:user.purposeOfUse | extensible | PurposeOfUse | ||||
| AuditEvent.source.type | extensible | AuditEventSourceType | ||||
| AuditEvent.entity.type | extensible | AuditEventEntityType | ||||
| AuditEvent.entity.role | extensible | AuditEventEntityRole | ||||
| AuditEvent.entity.lifecycle | extensible | ObjectLifecycleEvents | ||||
| AuditEvent.entity.securityLabel | extensible | All Security Labels | ||||
| AuditEvent.entity:transaction.what.type | extensible | ResourceType | ||||
| AuditEvent.entity:transaction.what.identifier.use | required | IdentifierUse | ||||
| AuditEvent.entity:transaction.what.identifier.type | extensible | Identifier Type Codes | ||||
| AuditEvent.entity:transaction.type | extensible | Pattern: XrequestId | ||||
| AuditEvent.entity:transaction.role | extensible | AuditEventEntityRole | ||||
| AuditEvent.entity:transaction.lifecycle | extensible | ObjectLifecycleEvents | ||||
| AuditEvent.entity:transaction.securityLabel | extensible | All Security Labels | ||||
| AuditEvent.entity:parameters.type | extensible | Pattern: 2("System Object") | ||||
| AuditEvent.entity:parameters.role | extensible | Pattern: 4("Domain Resource") | ||||
| AuditEvent.entity:parameters.securityLabel | extensible | All Security Labels |
This structure is derived from AuditEvent
Summary
Mandatory: 14 elements (4 nested mandatory elements)
Must-Support: 4 elements
Prohibited: 7 elements
Slices
This structure defines the following Slices:
Differential View
This structure is derived from AuditEvent
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| 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 | |
| display | 1..1 | string | Representation defined by the system Fixed Value: Restful Operation | |
| Slices for subtype | 1..* | Coding | More specific type/id for the event Slice: Unordered, Open by value:$this | |
| subtype:operation | 1..1 | Coding | More specific type/id for the event Required Pattern: At least the following | |
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/restful-interaction | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: operation | |
| display | 1..1 | string | Representation defined by the system Fixed Value: operation | |
| action | 0..1 | code | Type of action performed during the event Required Pattern: E | |
| outcome | 0..1 | code | Whether the event succeeded or failed Required Pattern: 0 | |
| Slices for agent | 2..* | BackboneElement | Actor involved in the event Slice: Unordered, Open by pattern:type | |
| agent:client | 1..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://dicom.nema.org/resources/ontology/DCM | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 110153 | |
| display | 1..1 | string | Representation defined by the system Fixed Value: Source Role ID | |
| who | 1..1 | Reference(PractitionerRole | Practitioner | Organization | Device | Patient | RelatedPerson) | Identifier of who | |
| media | 0..0 | |||
| network | 1..1 | BackboneElement | Logical network location for application activity | |
| agent:server | 1..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://dicom.nema.org/resources/ontology/DCM | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 110152 | |
| display | 1..1 | string | Representation defined by the system Fixed Value: Destination Role ID | |
| who | 1..1 | Reference(PractitionerRole | Practitioner | Organization | Device | Patient | RelatedPerson) | Identifier of who | |
| media | 0..0 | |||
| network | 1..1 | BackboneElement | Logical network location for application activity | |
| 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 | |
| display | 1..1 | string | Representation defined by the system Fixed Value: information recipient | |
| role | S | 0..* | CodeableConcept | Agent role 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 | |
| media | 0..0 | |||
| network | 0..0 | |||
| purposeOfUse | S | 0..* | CodeableConcept | Reason given for this user |
| source | S | 1..1 | BackboneElement | Audit Event Reporter |
| Slices for entity | 1..* | BackboneElement | Data or objects used Slice: Unordered, Open by pattern:type | |
| entity:transaction | 0..1 | BackboneElement | Data or objects used | |
| what | ||||
| identifier | ||||
| value | 1..1 | string | the value of 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:parameters | 1..1 | BackboneElement | Data or objects used | |
| what | 1..1 | Reference(Parameters) | 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: 2 | |
| display | 1..1 | string | Representation defined by the system Fixed Value: System Object | |
| role | 0..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: 4 | |
| display | 1..1 | string | Representation defined by the system Fixed Value: Domain Resource | |
| lifecycle | 0..0 | |||
| securityLabel | 0..* | Coding | may contain the security labels on the Bundle search set returned | |
| query | 0..0 | |||
| detail | 0..0 | |||
| Documentation for this format | ||||
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| 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 |
| 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 | |
| display | 1..1 | string | Representation defined by the system Fixed Value: Restful Operation | |
| 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:operation | Σ | 1..1 | Coding | More specific type/id for the event Binding: AuditEventSub-Type (extensible): Sub-type of event. Required Pattern: At least the following |
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/restful-interaction | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: operation | |
| display | 1..1 | string | Representation defined by the system Fixed Value: operation | |
| 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: E |
| 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. Required Pattern: 0 |
| Slices for agent | 2..* | BackboneElement | Actor involved in the event Slice: Unordered, Open by pattern: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: 110153 | |
| display | 1..1 | string | Representation defined by the system Fixed Value: Source Role ID | |
| 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: 110152 | |
| display | 1..1 | string | Representation defined by the system Fixed Value: Destination Role ID | |
| 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 | |
| display | 1..1 | string | Representation defined by the system Fixed Value: information recipient | |
| 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 | 1..* | BackboneElement | Data or objects used Slice: Unordered, Open by pattern:type |
| 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 |
| 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:parameters | C | 1..1 | BackboneElement | Data or objects used |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| what | Σ | 1..1 | Reference(Parameters) | 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 | |
| display | 1..1 | string | Representation defined by the system Fixed Value: System Object | |
| role | 0..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: 4 | |
| display | 1..1 | string | Representation defined by the system Fixed Value: Domain Resource | |
| securityLabel | 0..* | Coding | may contain the security labels on the Bundle search set returned Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code |
| AuditEvent.type | extensible | Pattern: rest("Restful Operation") |
| AuditEvent.subtype | extensible | AuditEventSub-Type |
| AuditEvent.subtype:operation | extensible | Pattern: operation("operation") |
| AuditEvent.action | required | Pattern: E |
| AuditEvent.outcome | required | Pattern: 0 |
| AuditEvent.agent:client.type | extensible | Pattern: 110153("Source Role ID") |
| AuditEvent.agent:server.type | extensible | Pattern: 110152("Destination Role ID") |
| AuditEvent.agent:user.type | extensible | Pattern: IRCP("information recipient") |
| AuditEvent.agent:user.role | example | SecurityRoleType |
| AuditEvent.agent:user.purposeOfUse | extensible | PurposeOfUse |
| AuditEvent.entity:transaction.type | extensible | Pattern: XrequestId |
| AuditEvent.entity:parameters.type | extensible | Pattern: 2("System Object") |
| AuditEvent.entity:parameters.role | extensible | Pattern: 4("Domain Resource") |
| AuditEvent.entity:parameters.securityLabel | extensible | All Security Labels |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| 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.
| |||||
| 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 | 1..1 | string | Representation defined by the system Fixed Value: Restful Operation | |||||
| 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:operation | Σ | 1..1 | Coding | More specific type/id for the event Binding: AuditEventSub-Type (extensible): Sub-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://hl7.org/fhir/restful-interaction | |||||
| version | 0..1 | string | Version of the system - if relevant | |||||
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: operation | |||||
| display | 1..1 | string | Representation defined by the system Fixed Value: operation | |||||
| userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |||||
| 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: E | ||||
| 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. 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 pattern: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: 110153 | |||||
| display | 1..1 | string | Representation defined by the system Fixed Value: Source Role ID | |||||
| 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: 110152 | |||||
| display | 1..1 | string | Representation defined by the system Fixed Value: Destination Role ID | |||||
| 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 | 1..1 | string | Representation defined by the system Fixed Value: information recipient | |||||
| 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 | 1..* | BackboneElement | Data or objects used Slice: Unordered, Open by pattern:type | ||||
| 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 | ||||
| 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:parameters | C | 1..1 | BackboneElement | Data or objects used | ||||
| 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(Parameters) | 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 | 1..1 | string | Representation defined by the system Fixed Value: System Object | |||||
| 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. 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: 4 | |||||
| display | 1..1 | string | Representation defined by the system Fixed Value: Domain Resource | |||||
| userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |||||
| securityLabel | 0..* | Coding | may contain the security labels on the Bundle search set 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 | |||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet / Code | ||||
| AuditEvent.language | preferred | CommonLanguages
| ||||
| AuditEvent.type | extensible | Pattern: rest("Restful Operation") | ||||
| AuditEvent.subtype | extensible | AuditEventSub-Type | ||||
| AuditEvent.subtype:operation | extensible | Pattern: operation("operation") | ||||
| AuditEvent.action | required | Pattern: E | ||||
| AuditEvent.outcome | required | Pattern: 0 | ||||
| AuditEvent.purposeOfEvent | extensible | PurposeOfUse | ||||
| AuditEvent.agent.type | extensible | ParticipationRoleType | ||||
| AuditEvent.agent.role | example | SecurityRoleType | ||||
| AuditEvent.agent.media | extensible | MediaTypeCode | ||||
| AuditEvent.agent.network.type | required | AuditEventAgentNetworkType | ||||
| AuditEvent.agent.purposeOfUse | extensible | PurposeOfUse | ||||
| AuditEvent.agent:client.type | extensible | Pattern: 110153("Source Role ID") | ||||
| AuditEvent.agent:client.role | example | SecurityRoleType | ||||
| AuditEvent.agent:client.network.type | required | AuditEventAgentNetworkType | ||||
| AuditEvent.agent:client.purposeOfUse | extensible | PurposeOfUse | ||||
| AuditEvent.agent:server.type | extensible | Pattern: 110152("Destination Role ID") | ||||
| AuditEvent.agent:server.role | example | SecurityRoleType | ||||
| AuditEvent.agent:server.network.type | required | AuditEventAgentNetworkType | ||||
| AuditEvent.agent:server.purposeOfUse | extensible | PurposeOfUse | ||||
| AuditEvent.agent:user.type | extensible | Pattern: IRCP("information recipient") | ||||
| AuditEvent.agent:user.role | example | SecurityRoleType | ||||
| AuditEvent.agent:user.network.type | required | AuditEventAgentNetworkType | ||||
| AuditEvent.agent:user.purposeOfUse | extensible | PurposeOfUse | ||||
| AuditEvent.source.type | extensible | AuditEventSourceType | ||||
| AuditEvent.entity.type | extensible | AuditEventEntityType | ||||
| AuditEvent.entity.role | extensible | AuditEventEntityRole | ||||
| AuditEvent.entity.lifecycle | extensible | ObjectLifecycleEvents | ||||
| AuditEvent.entity.securityLabel | extensible | All Security Labels | ||||
| AuditEvent.entity:transaction.what.type | extensible | ResourceType | ||||
| AuditEvent.entity:transaction.what.identifier.use | required | IdentifierUse | ||||
| AuditEvent.entity:transaction.what.identifier.type | extensible | Identifier Type Codes | ||||
| AuditEvent.entity:transaction.type | extensible | Pattern: XrequestId | ||||
| AuditEvent.entity:transaction.role | extensible | AuditEventEntityRole | ||||
| AuditEvent.entity:transaction.lifecycle | extensible | ObjectLifecycleEvents | ||||
| AuditEvent.entity:transaction.securityLabel | extensible | All Security Labels | ||||
| AuditEvent.entity:parameters.type | extensible | Pattern: 2("System Object") | ||||
| AuditEvent.entity:parameters.role | extensible | Pattern: 4("Domain Resource") | ||||
| AuditEvent.entity:parameters.securityLabel | extensible | All Security Labels |
This structure is derived from AuditEvent
Summary
Mandatory: 14 elements (4 nested mandatory elements)
Must-Support: 4 elements
Prohibited: 7 elements
Slices
This structure defines the following Slices:
Other representations of profile: CSV, Excel, Schematron
IG © 2023+ IHE IT Infrastructure Technical Committee. Package ihe.iti.svcm#1.5.1 based on FHIR 4.0.1. Generated 2023-08-02
Links: Table of Contents |
QA Report
| New Issue | Issues
Version History |
|
Propose a change