This page is part of the Situational Awareness for Novel Epidemic Response (v0.1.0: STU 1 Ballot 1) based on FHIR R4. The current version which supercedes this version is 1.0.0. For a full list of available versions, see the Directory of published versions
Defining URL: | http://hl7.org/fhir/uv/saner/StructureDefinition/AuditEventBase |
Version: | 0.1.0 |
Name: | AuditEventBase |
Title: | General Audit Event Requirements |
Status: | Active as of 2020-10-19T21:09:16+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: 15 elements (3 nested mandatory 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 | 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 | 1..1 | code | Type of action performed during the event | |
period | 1..1 | Period | When the activity occurred | |
agent | 2..* | (Slice Definition) | Actor involved in the event Slice: Unordered, Open At End by pattern:role, pattern:requestor | |
agent:Source | 1..1 | BackboneElement | Actor involved in the event | |
role | 1..* | CodeableConcept | Agent role in 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 | |
name | 1..1 | string | Human friendly name for the agent | |
requestor | 1..1 | boolean | Whether user is initiator Required Pattern: false | |
agent:HumanRequestor | 0..* | BackboneElement | Actor involved in the event | |
role | 1..1 | CodeableConcept | Agent role in the event | |
who | 1..1 | Reference(PractitionerRole | Practitioner | Organization | Device | Patient | RelatedPerson) | Identifier of who | |
name | 1..1 | string | Human friendly name for the agent | |
requestor | 1..1 | boolean | Whether user is initiator Required Pattern: true | |
agent:Destination | 1..1 | BackboneElement | Actor involved in the event | |
role | 1..* | CodeableConcept | Agent role in 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 | |
name | 1..1 | string | Human friendly name for the agent | |
requestor | 1..1 | boolean | Whether user is initiator Required Pattern: false | |
source | ||||
site | 1..1 | string | Logical source location within the enterprise | |
type | 1..1 | Coding | The type of source where event originated | |
entity | 1..* | BackboneElement | Data or objects used | |
role | 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 | |
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) |
subtype | Σ | 1..1 | Coding | More specific type/id for the event Binding: AuditEventSub-Type (extensible) |
id | 0..1 | string | Unique id for inter-element referencing | |
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 | Σ | 1..1 | code | Type of action performed during the event Binding: AuditEventAction (required) |
period | 1..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) |
outcomeDesc | Σ | 0..1 | string | Description of the event outcome |
purposeOfEvent | Σ | 0..* | CodeableConcept | The purposeOfUse of the event Binding: PurposeOfUse (extensible) |
agent | 2..* | (Slice Definition) | Actor involved in the event Slice: Unordered, Open At End by pattern:role, pattern: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) | |
role | 0..* | CodeableConcept | Agent role in the event Binding: SecurityRoleType (example) | |
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) | |
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) | |
purposeOfUse | 0..* | CodeableConcept | Reason given for this user Binding: PurposeOfUse (extensible) | |
agent:Source | 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) | |
role | 1..* | CodeableConcept | Agent role in the event Binding: SecurityRoleType (example) 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 | |
who | Σ | 1..1 | Reference(PractitionerRole | Practitioner | Organization | Device | Patient | RelatedPerson) | Identifier of who |
altId | 0..1 | string | Alternative User identity | |
name | 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) | |
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) | |
purposeOfUse | 0..* | CodeableConcept | Reason given for this user Binding: PurposeOfUse (extensible) | |
agent:HumanRequestor | 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) | |
role | 1..1 | CodeableConcept | Agent role in the event Binding: SecurityRoleType (example) | |
who | Σ | 1..1 | Reference(PractitionerRole | Practitioner | Organization | Device | Patient | RelatedPerson) | Identifier of who |
altId | 0..1 | string | Alternative User identity | |
name | 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) | |
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) | |
purposeOfUse | 0..* | CodeableConcept | Reason given for this user Binding: PurposeOfUse (extensible) | |
agent:Destination | 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) | |
role | 1..* | CodeableConcept | Agent role in the event Binding: SecurityRoleType (example) 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 | |
who | Σ | 1..1 | Reference(PractitionerRole | Practitioner | Organization | Device | Patient | RelatedPerson) | Identifier of who |
altId | 0..1 | string | Alternative User identity | |
name | 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) | |
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) | |
purposeOfUse | 0..* | CodeableConcept | Reason given for this user Binding: PurposeOfUse (extensible) | |
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 | 1..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 | 1..1 | Coding | The type of source where event originated Binding: AuditEventSourceType (extensible) | |
entity | I | 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) | |
role | 1..1 | Coding | What role the entity played Binding: AuditEventEntityRole (extensible) | |
id | 0..1 | string | Unique id for inter-element referencing | |
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) | |
securityLabel | 0..* | Coding | Security labels on the entity Binding: All Security Labels (extensible) | |
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 | |
Documentation for this format |
This structure is derived from AuditEvent
Summary
Mandatory: 15 elements (3 nested mandatory 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 | 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 | 1..1 | code | Type of action performed during the event | |
period | 1..1 | Period | When the activity occurred | |
agent | 2..* | (Slice Definition) | Actor involved in the event Slice: Unordered, Open At End by pattern:role, pattern:requestor | |
agent:Source | 1..1 | BackboneElement | Actor involved in the event | |
role | 1..* | CodeableConcept | Agent role in 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 | |
name | 1..1 | string | Human friendly name for the agent | |
requestor | 1..1 | boolean | Whether user is initiator Required Pattern: false | |
agent:HumanRequestor | 0..* | BackboneElement | Actor involved in the event | |
role | 1..1 | CodeableConcept | Agent role in the event | |
who | 1..1 | Reference(PractitionerRole | Practitioner | Organization | Device | Patient | RelatedPerson) | Identifier of who | |
name | 1..1 | string | Human friendly name for the agent | |
requestor | 1..1 | boolean | Whether user is initiator Required Pattern: true | |
agent:Destination | 1..1 | BackboneElement | Actor involved in the event | |
role | 1..* | CodeableConcept | Agent role in 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 | |
name | 1..1 | string | Human friendly name for the agent | |
requestor | 1..1 | boolean | Whether user is initiator Required Pattern: false | |
source | ||||
site | 1..1 | string | Logical source location within the enterprise | |
type | 1..1 | Coding | The type of source where event originated | |
entity | 1..* | BackboneElement | Data or objects used | |
role | 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 | |
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) |
subtype | Σ | 1..1 | Coding | More specific type/id for the event Binding: AuditEventSub-Type (extensible) |
id | 0..1 | string | Unique id for inter-element referencing | |
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 | Σ | 1..1 | code | Type of action performed during the event Binding: AuditEventAction (required) |
period | 1..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) |
outcomeDesc | Σ | 0..1 | string | Description of the event outcome |
purposeOfEvent | Σ | 0..* | CodeableConcept | The purposeOfUse of the event Binding: PurposeOfUse (extensible) |
agent | 2..* | (Slice Definition) | Actor involved in the event Slice: Unordered, Open At End by pattern:role, pattern: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) | |
role | 0..* | CodeableConcept | Agent role in the event Binding: SecurityRoleType (example) | |
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) | |
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) | |
purposeOfUse | 0..* | CodeableConcept | Reason given for this user Binding: PurposeOfUse (extensible) | |
agent:Source | 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) | |
role | 1..* | CodeableConcept | Agent role in the event Binding: SecurityRoleType (example) 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 | |
who | Σ | 1..1 | Reference(PractitionerRole | Practitioner | Organization | Device | Patient | RelatedPerson) | Identifier of who |
altId | 0..1 | string | Alternative User identity | |
name | 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) | |
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) | |
purposeOfUse | 0..* | CodeableConcept | Reason given for this user Binding: PurposeOfUse (extensible) | |
agent:HumanRequestor | 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) | |
role | 1..1 | CodeableConcept | Agent role in the event Binding: SecurityRoleType (example) | |
who | Σ | 1..1 | Reference(PractitionerRole | Practitioner | Organization | Device | Patient | RelatedPerson) | Identifier of who |
altId | 0..1 | string | Alternative User identity | |
name | 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) | |
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) | |
purposeOfUse | 0..* | CodeableConcept | Reason given for this user Binding: PurposeOfUse (extensible) | |
agent:Destination | 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) | |
role | 1..* | CodeableConcept | Agent role in the event Binding: SecurityRoleType (example) 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 | |
who | Σ | 1..1 | Reference(PractitionerRole | Practitioner | Organization | Device | Patient | RelatedPerson) | Identifier of who |
altId | 0..1 | string | Alternative User identity | |
name | 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) | |
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) | |
purposeOfUse | 0..* | CodeableConcept | Reason given for this user Binding: PurposeOfUse (extensible) | |
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 | 1..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 | 1..1 | Coding | The type of source where event originated Binding: AuditEventSourceType (extensible) | |
entity | I | 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) | |
role | 1..1 | Coding | What role the entity played Binding: AuditEventEntityRole (extensible) | |
id | 0..1 | string | Unique id for inter-element referencing | |
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) | |
securityLabel | 0..* | Coding | Security labels on the entity Binding: All Security Labels (extensible) | |
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: Schematron
Path | Conformance | ValueSet / Code |
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 | example | Pattern: 110153("Source Role ID") |
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 | example | SecurityRoleType |
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 | example | Pattern: 110152("Destination Role ID") |
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 |