Situational Awareness for Novel Epidemic Response
1.0.0 - STU Release
Situational Awareness for Novel Epidemic Response
1.0.0 - STU Release
This page is part of the Situational Awareness for Novel Epidemic Response (v1.0.0: STU 1) based on FHIR R4. This is the current published version in its permanent home (it will always be available at this URL). For a full list of available versions, see the Directory of published versions 
| Defining URL: | http://hl7.org/fhir/uv/saner/StructureDefinition/AuditEventBase |
| Version: | 1.0.0 |
| Name: | AuditEventBase |
| Title: | General Audit Event Requirements |
| Status: | Active as of 2021-09-07T19:08:29+00:00 |
| Definition: | Defines general constraints on the AuditEvent Resource. |
| Publisher: | HL7 International Public Health Workgroup |
| Source Resource: | XML / JSON / Turtle |
The official URL for this profile is:
http://hl7.org/fhir/uv/saner/StructureDefinition/AuditEventBase
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from AuditEvent
Summary
Mandatory: 13 elements (3 nested mandatory elements)
Must-Support: 18 elements
Slices
This structure defines the following Slices:
This structure is derived from AuditEvent
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  AuditEvent | 0..* | AuditEvent | Event record kept for security purposes | |
  subtype | S | 1..1 | Coding | More specific type/id for the event |
  system | 0..1 | uri | Identity of the terminology system Required Pattern: http://hl7.org/fhir/restful-interaction | |
 action | S | 1..1 | code | Type of action performed during the event |
| period | S | 1..1 | Period | When the activity occurred |
| recorded | S | 1..1 | instant | Time when the event was recorded |
 Slices for agent | 2..* | BackboneElement | Actor involved in the event Slice: Unordered, Open At End by value:role, value:requestor | |
  agent:Source | S | 1..1 | BackboneElement | Actor involved in the event |
  role | S | 1..1 | CodeableConcept | Agent role in the event Binding: SourceRoles (required) |
| who | S | 1..1 | Reference(PractitionerRole | Practitioner | Organization | Device | Patient | RelatedPerson) | Identifier of who |
| name | S | 1..1 | string | Human friendly name for the agent |
 requestor | 1..1 | boolean | Whether user is initiator Required Pattern: false | |
| agent:HumanRequestor | S | 0..* | BackboneElement | Actor involved in the event |
| role | S | 1..1 | CodeableConcept | Agent role in the event Binding: SourceOrDestinationRoles (required) |
| who | S | 1..1 | Reference(PractitionerRole | Practitioner | Organization | Device | Patient | RelatedPerson) | Identifier of who |
| name | S | 1..1 | string | Human friendly name for the agent |
| requestor | 1..1 | boolean | Whether user is initiator Required Pattern: true | |
 agent:Destination | S | 1..1 | BackboneElement | Actor involved in the event |
 role | S | 1..1 | CodeableConcept | Agent role in the event Binding: DestinationRoles (required) |
| who | S | 1..1 | Reference(PractitionerRole | Practitioner | Organization | Device | Patient | RelatedPerson) | Identifier of who |
| name | S | 1..1 | string | Human friendly name for the agent |
| requestor | 1..1 | boolean | Whether user is initiator Required Pattern: false | |
 entity | S | 1..* | BackboneElement | Data or objects used |
| role | S | 1..1 | Coding | What role the entity played |
| system | 0..1 | uri | Identity of the terminology system Required Pattern: http://terminology.hl7.org/CodeSystem/object-role | |
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| AuditEvent | 0..* | AuditEvent | Event record kept for security purposes | |
 id | Σ | 0..1 | string | 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) Max Binding: AllLanguages: 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. |
| subtype | SΣ | 1..1 | Coding | More specific type/id for the event Binding: AuditEventSub-Type (extensible): Sub-type of event. |
| id | 0..1 | string | Unique id for inter-element referencing | |
| Slices for extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| system | Σ | 0..1 | uri | Identity of the terminology system Required Pattern: http://hl7.org/fhir/restful-interaction |
| version | Σ | 0..1 | string | Version of the system - if relevant |
| code | Σ | 0..1 | code | Symbol in syntax defined by the system |
| display | Σ | 0..1 | string | Representation defined by the system |
| userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user |
| action | SΣ | 1..1 | code | Type of action performed during the event Binding: AuditEventAction (required): Indicator for type of action performed during the event that generated the event. |
| period | S | 1..1 | Period | When the activity occurred |
| recorded | SΣ | 1..1 | instant | Time when the event was recorded |
| outcome | Σ | 0..1 | code | Whether the event succeeded or failed Binding: AuditEventOutcome (required): Indicates whether the event succeeded or failed. |
| outcomeDesc | Σ | 0..1 | string | Description of the event outcome |
| purposeOfEvent | Σ | 0..* | CodeableConcept | The purposeOfUse of the event Binding: PurposeOfUse (extensible): The reason the activity took place. |
| Slices for agent | 2..* | BackboneElement | Actor involved in the event Slice: Unordered, Open At End by value:role, value:requestor | |
| 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:Source | S | 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 | 0..1 | CodeableConcept | How agent participated Binding: ParticipationRoleType (extensible): The Participation type of the agent to the event. | |
| role | S | 1..1 | CodeableConcept | Agent role in the event Binding: SourceRoles (required) |
| who | SΣ | 1..1 | Reference(PractitionerRole | Practitioner | Organization | Device | Patient | RelatedPerson) | Identifier of who |
| altId | 0..1 | string | Alternative User identity | |
| name | S | 1..1 | string | Human friendly name for the agent |
| requestor | Σ | 1..1 | boolean | Whether user is initiator Required Pattern: false |
| 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:HumanRequestor | S | 0..* | 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 | 0..1 | CodeableConcept | How agent participated Binding: ParticipationRoleType (extensible): The Participation type of the agent to the event. | |
| role | S | 1..1 | CodeableConcept | Agent role in the event Binding: SourceOrDestinationRoles (required) |
| who | SΣ | 1..1 | Reference(PractitionerRole | Practitioner | Organization | Device | Patient | RelatedPerson) | Identifier of who |
| altId | 0..1 | string | Alternative User identity | |
| name | S | 1..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 | |
| 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:Destination | S | 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 | 0..1 | CodeableConcept | How agent participated Binding: ParticipationRoleType (extensible): The Participation type of the agent to the event. | |
| role | S | 1..1 | CodeableConcept | Agent role in the event Binding: DestinationRoles (required) |
| who | SΣ | 1..1 | Reference(PractitionerRole | Practitioner | Organization | Device | Patient | RelatedPerson) | Identifier of who |
| altId | 0..1 | string | Alternative User identity | |
| name | S | 1..1 | string | Human friendly name for the agent |
| requestor | Σ | 1..1 | boolean | Whether user is initiator Required Pattern: false |
| location | 0..1 | Reference(Location) | Where | |
| policy | 0..* | uri | Policy that authorized event | |
| media | 0..1 | Coding | Type of media Binding: MediaTypeCode (extensible): Used when the event is about exporting/importing onto media. | |
| network | 0..1 | BackboneElement | Logical network location for application activity | |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| address | 0..1 | string | Identifier for the network access point of the user device | |
| type | 0..1 | code | The type of network access point Binding: AuditEventAgentNetworkType (required): The type of network access point of this agent in the audit event. | |
| purposeOfUse | 0..* | CodeableConcept | Reason given for this user Binding: PurposeOfUse (extensible): The reason the activity took place. | |
| source | 1..1 | BackboneElement | Audit Event Reporter | |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| site | 0..1 | string | Logical source location within the enterprise | |
| observer | Σ | 1..1 | Reference(PractitionerRole | Practitioner | Organization | Device | Patient | RelatedPerson) | The identity of source detecting the event |
| type | 0..* | Coding | The type of source where event originated Binding: AuditEventSourceType (extensible): Code specifying the type of system that detected and recorded the event. | |
| entity | SI | 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 |
| type | 0..1 | Coding | Type of entity involved Binding: AuditEventEntityType (extensible): Code for the entity type involved in the audit event. | |
| role | S | 1..1 | Coding | What role the entity played Binding: AuditEventEntityRole (extensible): Code representing the role the entity played in the audit event. |
| id | 0..1 | string | Unique id for inter-element referencing | |
| Slices for extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| system | Σ | 0..1 | uri | Identity of the terminology system Required Pattern: http://terminology.hl7.org/CodeSystem/object-role |
| version | Σ | 0..1 | string | Version of the system - if relevant |
| code | Σ | 0..1 | code | Symbol in syntax defined by the system |
| display | Σ | 0..1 | string | Representation defined by the system |
| userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user |
| lifecycle | 0..1 | Coding | Life-cycle stage for the entity Binding: ObjectLifecycleEvents (extensible): Identifier for the data life-cycle stage for the entity. | |
| securityLabel | 0..* | Coding | Security labels on the entity Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. | |
| name | ΣI | 0..1 | string | Descriptor for entity |
| description | 0..1 | string | Descriptive text | |
| query | ΣI | 0..1 | base64Binary | Query parameters |
| detail | 0..* | BackboneElement | Additional Information about the entity | |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| type | 1..1 | string | Name of the property | |
 value[x] | 1..1 | Property value | ||
| valueString | string | |||
| valueBase64Binary | base64Binary | |||
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| AuditEvent | 0..* | AuditEvent | Event record kept for security purposes | |
| subtype | Σ | 1..1 | Coding | More specific type/id for the event Binding: AuditEventSub-Type (extensible): Sub-type of event. |
| action | Σ | 1..1 | code | Type of action performed during the event Binding: AuditEventAction (required): Indicator for type of action performed during the event that generated the event. |
| period | 1..1 | Period | When the activity occurred | |
| recorded | Σ | 1..1 | instant | Time when the event was recorded |
| agent:Source | 1..1 | BackboneElement | Actor involved in the event | |
| role | 1..1 | CodeableConcept | Agent role in the event Binding: SourceRoles (required) | |
| who | Σ | 1..1 | Reference(PractitionerRole | Practitioner | Organization | Device | Patient | RelatedPerson) | Identifier of who |
| name | 1..1 | string | Human friendly name for the agent | |
| agent:HumanRequestor | 0..* | BackboneElement | Actor involved in the event | |
| role | 1..1 | CodeableConcept | Agent role in the event Binding: SourceOrDestinationRoles (required) | |
| who | Σ | 1..1 | Reference(PractitionerRole | Practitioner | Organization | Device | Patient | RelatedPerson) | Identifier of who |
| name | 1..1 | string | Human friendly name for the agent | |
| agent:Destination | 1..1 | BackboneElement | Actor involved in the event | |
| role | 1..1 | CodeableConcept | Agent role in the event Binding: DestinationRoles (required) | |
| who | Σ | 1..1 | Reference(PractitionerRole | Practitioner | Organization | Device | Patient | RelatedPerson) | Identifier of who |
| name | 1..1 | string | Human friendly name for the agent | |
| entity | I | 1..* | BackboneElement | Data or objects used |
| role | 1..1 | Coding | What role the entity played Binding: AuditEventEntityRole (extensible): Code representing the role the entity played in the audit event. | |
| Documentation for this format | ||||
This structure is derived from AuditEvent
Summary
Mandatory: 13 elements (3 nested mandatory elements)
Must-Support: 18 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 | |
| subtype | S | 1..1 | Coding | More specific type/id for the event |
| system | 0..1 | uri | Identity of the terminology system Required Pattern: http://hl7.org/fhir/restful-interaction | |
| action | S | 1..1 | code | Type of action performed during the event |
| period | S | 1..1 | Period | When the activity occurred |
| recorded | S | 1..1 | instant | Time when the event was recorded |
| Slices for agent | 2..* | BackboneElement | Actor involved in the event Slice: Unordered, Open At End by value:role, value:requestor | |
| agent:Source | S | 1..1 | BackboneElement | Actor involved in the event |
| role | S | 1..1 | CodeableConcept | Agent role in the event Binding: SourceRoles (required) |
| who | S | 1..1 | Reference(PractitionerRole | Practitioner | Organization | Device | Patient | RelatedPerson) | Identifier of who |
| name | S | 1..1 | string | Human friendly name for the agent |
| requestor | 1..1 | boolean | Whether user is initiator Required Pattern: false | |
| agent:HumanRequestor | S | 0..* | BackboneElement | Actor involved in the event |
| role | S | 1..1 | CodeableConcept | Agent role in the event Binding: SourceOrDestinationRoles (required) |
| who | S | 1..1 | Reference(PractitionerRole | Practitioner | Organization | Device | Patient | RelatedPerson) | Identifier of who |
| name | S | 1..1 | string | Human friendly name for the agent |
| requestor | 1..1 | boolean | Whether user is initiator Required Pattern: true | |
| agent:Destination | S | 1..1 | BackboneElement | Actor involved in the event |
| role | S | 1..1 | CodeableConcept | Agent role in the event Binding: DestinationRoles (required) |
| who | S | 1..1 | Reference(PractitionerRole | Practitioner | Organization | Device | Patient | RelatedPerson) | Identifier of who |
| name | S | 1..1 | string | Human friendly name for the agent |
| requestor | 1..1 | boolean | Whether user is initiator Required Pattern: false | |
| entity | S | 1..* | BackboneElement | Data or objects used |
| role | S | 1..1 | Coding | What role the entity played |
| system | 0..1 | uri | Identity of the terminology system Required Pattern: http://terminology.hl7.org/CodeSystem/object-role | |
| Documentation for this format | ||||
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| AuditEvent | 0..* | AuditEvent | Event record kept for security purposes | |
| id | Σ | 0..1 | string | 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) Max Binding: AllLanguages: 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. |
| subtype | SΣ | 1..1 | Coding | More specific type/id for the event Binding: AuditEventSub-Type (extensible): Sub-type of event. |
| id | 0..1 | string | Unique id for inter-element referencing | |
| Slices for extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| system | Σ | 0..1 | uri | Identity of the terminology system Required Pattern: http://hl7.org/fhir/restful-interaction |
| version | Σ | 0..1 | string | Version of the system - if relevant |
| code | Σ | 0..1 | code | Symbol in syntax defined by the system |
| display | Σ | 0..1 | string | Representation defined by the system |
| userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user |
| action | SΣ | 1..1 | code | Type of action performed during the event Binding: AuditEventAction (required): Indicator for type of action performed during the event that generated the event. |
| period | S | 1..1 | Period | When the activity occurred |
| recorded | SΣ | 1..1 | instant | Time when the event was recorded |
| outcome | Σ | 0..1 | code | Whether the event succeeded or failed Binding: AuditEventOutcome (required): Indicates whether the event succeeded or failed. |
| outcomeDesc | Σ | 0..1 | string | Description of the event outcome |
| purposeOfEvent | Σ | 0..* | CodeableConcept | The purposeOfUse of the event Binding: PurposeOfUse (extensible): The reason the activity took place. |
| Slices for agent | 2..* | BackboneElement | Actor involved in the event Slice: Unordered, Open At End by value:role, value:requestor | |
| 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:Source | S | 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 | 0..1 | CodeableConcept | How agent participated Binding: ParticipationRoleType (extensible): The Participation type of the agent to the event. | |
| role | S | 1..1 | CodeableConcept | Agent role in the event Binding: SourceRoles (required) |
| who | SΣ | 1..1 | Reference(PractitionerRole | Practitioner | Organization | Device | Patient | RelatedPerson) | Identifier of who |
| altId | 0..1 | string | Alternative User identity | |
| name | S | 1..1 | string | Human friendly name for the agent |
| requestor | Σ | 1..1 | boolean | Whether user is initiator Required Pattern: false |
| 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:HumanRequestor | S | 0..* | 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 | 0..1 | CodeableConcept | How agent participated Binding: ParticipationRoleType (extensible): The Participation type of the agent to the event. | |
| role | S | 1..1 | CodeableConcept | Agent role in the event Binding: SourceOrDestinationRoles (required) |
| who | SΣ | 1..1 | Reference(PractitionerRole | Practitioner | Organization | Device | Patient | RelatedPerson) | Identifier of who |
| altId | 0..1 | string | Alternative User identity | |
| name | S | 1..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 | |
| 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:Destination | S | 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 | 0..1 | CodeableConcept | How agent participated Binding: ParticipationRoleType (extensible): The Participation type of the agent to the event. | |
| role | S | 1..1 | CodeableConcept | Agent role in the event Binding: DestinationRoles (required) |
| who | SΣ | 1..1 | Reference(PractitionerRole | Practitioner | Organization | Device | Patient | RelatedPerson) | Identifier of who |
| altId | 0..1 | string | Alternative User identity | |
| name | S | 1..1 | string | Human friendly name for the agent |
| requestor | Σ | 1..1 | boolean | Whether user is initiator Required Pattern: false |
| location | 0..1 | Reference(Location) | Where | |
| policy | 0..* | uri | Policy that authorized event | |
| media | 0..1 | Coding | Type of media Binding: MediaTypeCode (extensible): Used when the event is about exporting/importing onto media. | |
| network | 0..1 | BackboneElement | Logical network location for application activity | |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| address | 0..1 | string | Identifier for the network access point of the user device | |
| type | 0..1 | code | The type of network access point Binding: AuditEventAgentNetworkType (required): The type of network access point of this agent in the audit event. | |
| purposeOfUse | 0..* | CodeableConcept | Reason given for this user Binding: PurposeOfUse (extensible): The reason the activity took place. | |
| source | 1..1 | BackboneElement | Audit Event Reporter | |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| site | 0..1 | string | Logical source location within the enterprise | |
| observer | Σ | 1..1 | Reference(PractitionerRole | Practitioner | Organization | Device | Patient | RelatedPerson) | The identity of source detecting the event |
| type | 0..* | Coding | The type of source where event originated Binding: AuditEventSourceType (extensible): Code specifying the type of system that detected and recorded the event. | |
| entity | SI | 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 |
| type | 0..1 | Coding | Type of entity involved Binding: AuditEventEntityType (extensible): Code for the entity type involved in the audit event. | |
| role | S | 1..1 | Coding | What role the entity played Binding: AuditEventEntityRole (extensible): Code representing the role the entity played in the audit event. |
| id | 0..1 | string | Unique id for inter-element referencing | |
| Slices for extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| system | Σ | 0..1 | uri | Identity of the terminology system Required Pattern: http://terminology.hl7.org/CodeSystem/object-role |
| version | Σ | 0..1 | string | Version of the system - if relevant |
| code | Σ | 0..1 | code | Symbol in syntax defined by the system |
| display | Σ | 0..1 | string | Representation defined by the system |
| userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user |
| lifecycle | 0..1 | Coding | Life-cycle stage for the entity Binding: ObjectLifecycleEvents (extensible): Identifier for the data life-cycle stage for the entity. | |
| securityLabel | 0..* | Coding | Security labels on the entity Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. | |
| name | ΣI | 0..1 | string | Descriptor for entity |
| description | 0..1 | string | Descriptive text | |
| query | ΣI | 0..1 | base64Binary | Query parameters |
| detail | 0..* | BackboneElement | Additional Information about the entity | |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| type | 1..1 | string | Name of the property | |
| value[x] | 1..1 | Property value | ||
| valueString | string | |||
| valueBase64Binary | base64Binary | |||
| Documentation for this format | ||||
Other representations of profile: CSV, Excel, Schematron
| Path | Conformance | ValueSet |
| AuditEvent.language | preferred | CommonLanguages Max Binding: AllLanguages |
| AuditEvent.type | extensible | AuditEventID |
| AuditEvent.subtype | extensible | AuditEventSub-Type |
| AuditEvent.action | required | AuditEventAction |
| AuditEvent.outcome | required | AuditEventOutcome |
| 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:Source.type | extensible | ParticipationRoleType |
| AuditEvent.agent:Source.role | required | SourceRoles |
| AuditEvent.agent:Source.media | extensible | MediaTypeCode |
| AuditEvent.agent:Source.network.type | required | AuditEventAgentNetworkType |
| AuditEvent.agent:Source.purposeOfUse | extensible | PurposeOfUse |
| AuditEvent.agent:HumanRequestor.type | extensible | ParticipationRoleType |
| AuditEvent.agent:HumanRequestor.role | required | SourceOrDestinationRoles |
| AuditEvent.agent:HumanRequestor.media | extensible | MediaTypeCode |
| AuditEvent.agent:HumanRequestor.network.type | required | AuditEventAgentNetworkType |
| AuditEvent.agent:HumanRequestor.purposeOfUse | extensible | PurposeOfUse |
| AuditEvent.agent:Destination.type | extensible | ParticipationRoleType |
| AuditEvent.agent:Destination.role | required | DestinationRoles |
| AuditEvent.agent:Destination.media | extensible | MediaTypeCode |
| AuditEvent.agent:Destination.network.type | required | AuditEventAgentNetworkType |
| AuditEvent.agent:Destination.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 |
IG © 2020+ HL7 International Public Health Workgroup. Package hl7.fhir.uv.saner#1.0.0 based on FHIR 4.0.1. Generated 2021-09-07
Links: Table of Contents |
QA Report
| Version History |
Search |
|
Propose a change