Audit Events Implementation Guide - Local Development build (v0.1.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions
Mappings for the hira-audit-event resource profile.
| HiraAuditEvent |
| AuditEvent | Entity. Role, or Act, ControlAct[moodCode=EVN] |
| text | Act.text? |
| contained | N/A |
| extension | N/A |
| modifierExtension | N/A |
| type | .code (type, subtype and action are pre-coordinated or sent as translations) |
| subtype | .code (type, subtype and action are pre-coordinated or sent as translations) |
| action | .code (type, subtype and action are pre-coordinated or sent as translations) |
| period | ./effectiveTime[type=IVL_TS] |
| recorded | .effectiveTime |
| outcome | .actionNegationInd |
| outcomeDesc | .outboundRelationship[typeCode=OUT].target.text |
| purposeOfEvent | * .reasonCode [ControlActReason when Act.class = CACT Control Act]
*.outboundRelationship[typeCode=RSON].target |
| agent | .participation |
| id | n/a |
| extension | n/a |
| modifierExtension | N/A |
| type | .typeCode and/or .functionCode |
| role | .role |
| who | .id |
| altId | .id (distinguish id type by root) |
| name | .name |
| requestor | If participation.typeCode was author, then true |
| location | * Role.Class =SDLOC
*Role.Code = ServiceDeliveryLocationRoleType
*Entity.Code = PlaceEntityType = df.Types of places for Entity.Class = PLC
*EntityClass = PLC = df.A physical place or site with its containing structure. May be natural or man-made. The geographic position of a place might or might not be constant. |
| policy | ActPolicyType |
| media | .player.description.mediaType |
| network | .player.description.reference |
| id | n/a |
| extension | n/a |
| modifierExtension | N/A |
| address | pre-coordinated into URL |
| type | pre-coordinated into URL |
| purposeOfUse | *.reasonCode [ActHealthInformationPurposeOfUseReason codes/v:PurposeOfUse
(2.16.840.1.113883.1.11.20448)
* .outboundRelationship[typeCode=RSON or SUBJ].target |
| agent (slf) | .participation |
| id | n/a |
| modifierExtension | N/A |
| type | .typeCode and/or .functionCode |
| role | .role |
| who | .id |
| altId | .id (distinguish id type by root) |
| requestor | If participation.typeCode was author, then true |
| location | * Role.Class =SDLOC
*Role.Code = ServiceDeliveryLocationRoleType
*Entity.Code = PlaceEntityType = df.Types of places for Entity.Class = PLC
*EntityClass = PLC = df.A physical place or site with its containing structure. May be natural or man-made. The geographic position of a place might or might not be constant. |
| policy | ActPolicyType |
| media | .player.description.mediaType |
| network | .player.description.reference |
| id | n/a |
| extension | n/a |
| modifierExtension | N/A |
| address | pre-coordinated into URL |
| type | pre-coordinated into URL |
| purposeOfUse | *.reasonCode [ActHealthInformationPurposeOfUseReason codes/v:PurposeOfUse
(2.16.840.1.113883.1.11.20448)
* .outboundRelationship[typeCode=RSON or SUBJ].target |
| agent (dlg) | .participation |
| id | n/a |
| modifierExtension | N/A |
| type | .typeCode and/or .functionCode |
| role | .role |
| who | .id |
| altId | .id (distinguish id type by root) |
| requestor | If participation.typeCode was author, then true |
| location | * Role.Class =SDLOC
*Role.Code = ServiceDeliveryLocationRoleType
*Entity.Code = PlaceEntityType = df.Types of places for Entity.Class = PLC
*EntityClass = PLC = df.A physical place or site with its containing structure. May be natural or man-made. The geographic position of a place might or might not be constant. |
| policy | ActPolicyType |
| media | .player.description.mediaType |
| network | .player.description.reference |
| id | n/a |
| extension | n/a |
| modifierExtension | N/A |
| address | pre-coordinated into URL |
| type | pre-coordinated into URL |
| purposeOfUse | *.reasonCode [ActHealthInformationPurposeOfUseReason codes/v:PurposeOfUse
(2.16.840.1.113883.1.11.20448)
* .outboundRelationship[typeCode=RSON or SUBJ].target |
| agent (caregiver) | .participation |
| id | n/a |
| modifierExtension | N/A |
| type | .typeCode and/or .functionCode |
| role | .role |
| who | .id |
| altId | .id (distinguish id type by root) |
| requestor | If participation.typeCode was author, then true |
| location | * Role.Class =SDLOC
*Role.Code = ServiceDeliveryLocationRoleType
*Entity.Code = PlaceEntityType = df.Types of places for Entity.Class = PLC
*EntityClass = PLC = df.A physical place or site with its containing structure. May be natural or man-made. The geographic position of a place might or might not be constant. |
| policy | ActPolicyType |
| media | .player.description.mediaType |
| network | .player.description.reference |
| id | n/a |
| extension | n/a |
| modifierExtension | N/A |
| address | pre-coordinated into URL |
| type | pre-coordinated into URL |
| purposeOfUse | *.reasonCode [ActHealthInformationPurposeOfUseReason codes/v:PurposeOfUse
(2.16.840.1.113883.1.11.20448)
* .outboundRelationship[typeCode=RSON or SUBJ].target |
| agent (delegatee) | .participation |
| id | n/a |
| modifierExtension | N/A |
| type | .typeCode and/or .functionCode |
| role | .role |
| who | .id |
| altId | .id (distinguish id type by root) |
| requestor | If participation.typeCode was author, then true |
| location | * Role.Class =SDLOC
*Role.Code = ServiceDeliveryLocationRoleType
*Entity.Code = PlaceEntityType = df.Types of places for Entity.Class = PLC
*EntityClass = PLC = df.A physical place or site with its containing structure. May be natural or man-made. The geographic position of a place might or might not be constant. |
| policy | ActPolicyType |
| media | .player.description.mediaType |
| network | .player.description.reference |
| id | n/a |
| extension | n/a |
| modifierExtension | N/A |
| address | pre-coordinated into URL |
| type | pre-coordinated into URL |
| purposeOfUse | *.reasonCode [ActHealthInformationPurposeOfUseReason codes/v:PurposeOfUse
(2.16.840.1.113883.1.11.20448)
* .outboundRelationship[typeCode=RSON or SUBJ].target |
| agent (healthworkforce) | .participation |
| id | n/a |
| modifierExtension | N/A |
| type | .typeCode and/or .functionCode |
| role | .role |
| who | .id |
| altId | .id (distinguish id type by root) |
| name | .name |
| requestor | If participation.typeCode was author, then true |
| location | * Role.Class =SDLOC
*Role.Code = ServiceDeliveryLocationRoleType
*Entity.Code = PlaceEntityType = df.Types of places for Entity.Class = PLC
*EntityClass = PLC = df.A physical place or site with its containing structure. May be natural or man-made. The geographic position of a place might or might not be constant. |
| policy | ActPolicyType |
| media | .player.description.mediaType |
| network | .player.description.reference |
| id | n/a |
| extension | n/a |
| modifierExtension | N/A |
| address | pre-coordinated into URL |
| type | pre-coordinated into URL |
| purposeOfUse | *.reasonCode [ActHealthInformationPurposeOfUseReason codes/v:PurposeOfUse
(2.16.840.1.113883.1.11.20448)
* .outboundRelationship[typeCode=RSON or SUBJ].target |
| agent (system) | .participation |
| id | n/a |
| modifierExtension | N/A |
| type | .typeCode and/or .functionCode |
| role | .role |
| who | .id |
| altId | .id (distinguish id type by root) |
| name | .name |
| requestor | If participation.typeCode was author, then true |
| location | * Role.Class =SDLOC
*Role.Code = ServiceDeliveryLocationRoleType
*Entity.Code = PlaceEntityType = df.Types of places for Entity.Class = PLC
*EntityClass = PLC = df.A physical place or site with its containing structure. May be natural or man-made. The geographic position of a place might or might not be constant. |
| policy | ActPolicyType |
| media | .player.description.mediaType |
| network | .player.description.reference |
| id | n/a |
| extension | n/a |
| modifierExtension | N/A |
| address | pre-coordinated into URL |
| type | pre-coordinated into URL |
| purposeOfUse | *.reasonCode [ActHealthInformationPurposeOfUseReason codes/v:PurposeOfUse
(2.16.840.1.113883.1.11.20448)
* .outboundRelationship[typeCode=RSON or SUBJ].target |
| agent (organisation) | .participation |
| id | n/a |
| modifierExtension | N/A |
| type | .typeCode and/or .functionCode |
| role | .role |
| who | .id |
| altId | .id (distinguish id type by root) |
| name | .name |
| requestor | If participation.typeCode was author, then true |
| location | * Role.Class =SDLOC
*Role.Code = ServiceDeliveryLocationRoleType
*Entity.Code = PlaceEntityType = df.Types of places for Entity.Class = PLC
*EntityClass = PLC = df.A physical place or site with its containing structure. May be natural or man-made. The geographic position of a place might or might not be constant. |
| policy | ActPolicyType |
| media | .player.description.mediaType |
| network | .player.description.reference |
| id | n/a |
| extension | n/a |
| modifierExtension | N/A |
| address | pre-coordinated into URL |
| type | pre-coordinated into URL |
| purposeOfUse | *.reasonCode [ActHealthInformationPurposeOfUseReason codes/v:PurposeOfUse
(2.16.840.1.113883.1.11.20448)
* .outboundRelationship[typeCode=RSON or SUBJ].target |
| source | .participation[typeCode=INF].role[classCode=ASSIGN].player[classCode=DEV, determinerCode=INSTANCE] |
| id | n/a |
| extension | n/a |
| modifierExtension | N/A |
| site | .scopedRole[classCode=LOCE].player.desc |
| observer | .id |
| id | n/a |
| extension | n/a |
| reference | N/A |
| type | N/A |
| identifier | .identifier |
| display | N/A |
| type | .code |
| entity | .outboundRelationship[typeCode=SUBJ].target or .participation[typeCode=SBJ].role |
| id | n/a |
| extension | n/a |
| modifierExtension | N/A |
| what | .id |
| type | [self::Act].code or role.player.code |
| role | role.code (not sure what this would mean for an Act) |
| lifecycle | target of ObservationEvent[code="lifecycle"].value |
| securityLabel | .confidentialityCode |
| name | .title |
| description | .text |
| query | No mapping |
| detail | .inboundRelationship[typeCode=SUBJ].target[classCode=OBS, moodCode=EVN] |
| id | n/a |
| extension | n/a |
| modifierExtension | N/A |
| type | .code |
| value[x] | .value |
| entity (accessedResource) | .outboundRelationship[typeCode=SUBJ].target or .participation[typeCode=SBJ].role |
| id | n/a |
| extension | n/a |
| modifierExtension | N/A |
| what | .id |
| type | [self::Act].code or role.player.code |
| role | role.code (not sure what this would mean for an Act) |
| lifecycle | target of ObservationEvent[code="lifecycle"].value |
| securityLabel | .confidentialityCode |
| name | .title |
| description | .text |
| query | No mapping |
| detail | .inboundRelationship[typeCode=SUBJ].target[classCode=OBS, moodCode=EVN] |
| id | n/a |
| extension | n/a |
| modifierExtension | N/A |
| type | .code |
| value[x] | .value |
| entity (dataSubject) | .outboundRelationship[typeCode=SUBJ].target or .participation[typeCode=SBJ].role |
| id | n/a |
| extension | n/a |
| modifierExtension | N/A |
| what | .id |
| type | [self::Act].code or role.player.code |
| role | role.code (not sure what this would mean for an Act) |
| lifecycle | target of ObservationEvent[code="lifecycle"].value |
| securityLabel | .confidentialityCode |
| name | .title |
| description | .text |
| query | No mapping |
| detail | .inboundRelationship[typeCode=SUBJ].target[classCode=OBS, moodCode=EVN] |
| id | n/a |
| extension | n/a |
| modifierExtension | N/A |
| type | .code |
| value[x] | .value |
| HiraAuditEvent |
| AuditEvent | Message |
| type | EventId |
| subtype | EventTypeCode |
| action | EventActionCode |
| period | EventDateTime |
| outcome | EventOutcomeIndicator |
| outcomeDesc | EventOutcomeDescription |
| purposeOfEvent | EventPurposeOfUse |
| agent | ActiveParticipant |
| type | RoleIdCode |
| role | RoleIdCode |
| who | UserId |
| altId | AlternativeUserId |
| name | UserName |
| requestor | UserIsRequestor |
| policy | ParticipantRoleIDCode |
| media | MediaType |
| network | |
| address | NetworkAccessPointID |
| type | NetworkAccessPointTypeCode |
| agent (slf) | ActiveParticipant |
| type | RoleIdCode |
| role | RoleIdCode |
| who | UserId |
| altId | AlternativeUserId |
| requestor | UserIsRequestor |
| policy | ParticipantRoleIDCode |
| media | MediaType |
| network | |
| address | NetworkAccessPointID |
| type | NetworkAccessPointTypeCode |
| agent (dlg) | ActiveParticipant |
| type | RoleIdCode |
| role | RoleIdCode |
| who | UserId |
| altId | AlternativeUserId |
| requestor | UserIsRequestor |
| policy | ParticipantRoleIDCode |
| media | MediaType |
| network | |
| address | NetworkAccessPointID |
| type | NetworkAccessPointTypeCode |
| agent (caregiver) | ActiveParticipant |
| type | RoleIdCode |
| role | RoleIdCode |
| who | UserId |
| altId | AlternativeUserId |
| requestor | UserIsRequestor |
| policy | ParticipantRoleIDCode |
| media | MediaType |
| network | |
| address | NetworkAccessPointID |
| type | NetworkAccessPointTypeCode |
| agent (delegatee) | ActiveParticipant |
| type | RoleIdCode |
| role | RoleIdCode |
| who | UserId |
| altId | AlternativeUserId |
| requestor | UserIsRequestor |
| policy | ParticipantRoleIDCode |
| media | MediaType |
| network | |
| address | NetworkAccessPointID |
| type | NetworkAccessPointTypeCode |
| agent (healthworkforce) | ActiveParticipant |
| type | RoleIdCode |
| role | RoleIdCode |
| who | UserId |
| altId | AlternativeUserId |
| name | UserName |
| requestor | UserIsRequestor |
| policy | ParticipantRoleIDCode |
| media | MediaType |
| network | |
| address | NetworkAccessPointID |
| type | NetworkAccessPointTypeCode |
| agent (system) | ActiveParticipant |
| type | RoleIdCode |
| role | RoleIdCode |
| who | UserId |
| altId | AlternativeUserId |
| name | UserName |
| requestor | UserIsRequestor |
| policy | ParticipantRoleIDCode |
| media | MediaType |
| network | |
| address | NetworkAccessPointID |
| type | NetworkAccessPointTypeCode |
| agent (organisation) | ActiveParticipant |
| type | RoleIdCode |
| role | RoleIdCode |
| who | UserId |
| altId | AlternativeUserId |
| name | UserName |
| requestor | UserIsRequestor |
| policy | ParticipantRoleIDCode |
| media | MediaType |
| network | |
| address | NetworkAccessPointID |
| type | NetworkAccessPointTypeCode |
| source | AuditSourceIdentification |
| site | AuditEnterpriseSiteId |
| observer | AuditSourceId |
| type | AuditSourceTypeCode |
| entity | ParticipantObjectIdentification |
| what | ParticipantObjectID and ParticipantObjectIDTypeCode |
| type | ParticipantObjectTypeCode |
| role | ParticipantObjectTypeCodeRole |
| lifecycle | ParticipantObjectDataLifeCycle |
| securityLabel | ParticipantObjectSensitivity |
| name | ParticipantObjectName |
| description | ParticipantObjectDescription |
| query | ParticipantObjectQuery |
| detail | ParticipantObjectDetail |
| type | ParticipantObjectDetail.type |
| value[x] | ParticipantObjectDetail.value |
| entity (accessedResource) | ParticipantObjectIdentification |
| what | ParticipantObjectID and ParticipantObjectIDTypeCode |
| type | ParticipantObjectTypeCode |
| role | ParticipantObjectTypeCodeRole |
| lifecycle | ParticipantObjectDataLifeCycle |
| securityLabel | ParticipantObjectSensitivity |
| name | ParticipantObjectName |
| description | ParticipantObjectDescription |
| query | ParticipantObjectQuery |
| detail | ParticipantObjectDetail |
| type | ParticipantObjectDetail.type |
| value[x] | ParticipantObjectDetail.value |
| entity (dataSubject) | ParticipantObjectIdentification |
| what | ParticipantObjectID and ParticipantObjectIDTypeCode |
| type | ParticipantObjectTypeCode |
| role | ParticipantObjectTypeCodeRole |
| lifecycle | ParticipantObjectDataLifeCycle |
| securityLabel | ParticipantObjectSensitivity |
| name | ParticipantObjectName |
| description | ParticipantObjectDescription |
| query | ParticipantObjectQuery |
| detail | ParticipantObjectDetail |
| type | ParticipantObjectDetail.type |
| value[x] | ParticipantObjectDetail.value |
