Situational Awareness for Novel Epidemic Response - Local Development build (v0.1.0). See the Directory of published versions
Defines constraints on the AuditEvent Resource to record when a record has been accessed.
The official URL for this profile is:
http://hl7.org/fhir/us/saner/StructureDefinition/audit-event-read
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from AuditEvent
This structure is derived from AuditEvent
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
AuditEvent | 0..* | AuditEvent | Event record kept for security purposes | |
Documentation for this format |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
AuditEvent | I | 0..* | AuditEvent | Event record kept for security purposes |
id | Σ | 0..1 | string | Logical id of this artifact |
meta | ΣI | 0..1 | Meta | Metadata about the resource |
implicitRules | ?!ΣI | 0..1 | uri | A set of rules under which this content was created |
language | I | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred) Max Binding: AllLanguages |
text | I | 0..1 | Narrative | Text summary of the resource, for human interpretation |
contained | 0..* | Resource | Contained, inline Resources | |
extension | I | 0..* | Extension | Additional content defined by implementations |
modifierExtension | ?!I | 0..* | Extension | Extensions that cannot be ignored |
type | ΣI | 1..1 | Coding | Type/identifier of event Binding: AuditEventID (extensible) |
subtype | ΣI | 0..* | Coding | More specific type/id for the event Binding: AuditEventSub-Type (extensible) |
action | ΣI | 0..1 | code | Type of action performed during the event Binding: AuditEventAction (required) |
period | I | 0..1 | Period | When the activity occurred |
recorded | ΣI | 1..1 | instant | Time when the event was recorded |
outcome | ΣI | 0..1 | code | Whether the event succeeded or failed Binding: AuditEventOutcome (required) |
outcomeDesc | ΣI | 0..1 | string | Description of the event outcome |
purposeOfEvent | ΣI | 0..* | CodeableConcept | The purposeOfUse of the event Binding: V3 Value SetPurposeOfUse (extensible) |
agent | I | 1..* | BackboneElement | Actor involved in the event |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | I | 0..* | Extension | Additional content defined by implementations |
modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
type | I | 0..1 | CodeableConcept | How agent participated Binding: ParticipationRoleType (extensible) |
role | I | 0..* | CodeableConcept | Agent role in the event Binding: SecurityRoleType (example) |
who | ΣI | 0..1 | Reference(PractitionerRole | Practitioner | Organization | Device | Patient | RelatedPerson) | Identifier of who |
altId | I | 0..1 | string | Alternative User identity |
name | I | 0..1 | string | Human friendly name for the agent |
requestor | ΣI | 1..1 | boolean | Whether user is initiator |
location | I | 0..1 | Reference(Location) | Where |
policy | I | 0..* | uri | Policy that authorized event |
media | I | 0..1 | Coding | Type of media Binding: MediaTypeCode (extensible) |
network | I | 0..1 | BackboneElement | Logical network location for application activity |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | I | 0..* | Extension | Additional content defined by implementations |
modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
address | I | 0..1 | string | Identifier for the network access point of the user device |
type | I | 0..1 | code | The type of network access point Binding: AuditEventAgentNetworkType (required) |
purposeOfUse | I | 0..* | CodeableConcept | Reason given for this user Binding: V3 Value SetPurposeOfUse (extensible) |
source | I | 1..1 | BackboneElement | Audit Event Reporter |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | I | 0..* | Extension | Additional content defined by implementations |
modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
site | I | 0..1 | string | Logical source location within the enterprise |
observer | ΣI | 1..1 | Reference(PractitionerRole | Practitioner | Organization | Device | Patient | RelatedPerson) | The identity of source detecting the event |
type | I | 0..* | Coding | The type of source where event originated Binding: AuditEventSourceType (extensible) |
entity | I | 0..* | BackboneElement | Data or objects used sev-1: Either a name or a query (NOT both) |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | I | 0..* | Extension | Additional content defined by implementations |
modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
what | ΣI | 0..1 | Reference(Resource) | Specific instance of resource |
type | I | 0..1 | Coding | Type of entity involved Binding: AuditEventEntityType (extensible) |
role | I | 0..1 | Coding | What role the entity played Binding: AuditEventEntityRole (extensible) |
lifecycle | I | 0..1 | Coding | Life-cycle stage for the entity Binding: ObjectLifecycleEvents (extensible) |
securityLabel | I | 0..* | Coding | Security labels on the entity Binding: All Security Labels (extensible) |
name | ΣI | 0..1 | string | Descriptor for entity |
description | I | 0..1 | string | Descriptive text |
query | ΣI | 0..1 | base64Binary | Query parameters |
detail | I | 0..* | BackboneElement | Additional Information about the entity |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | I | 0..* | Extension | Additional content defined by implementations |
modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
type | I | 1..1 | string | Name of the property |
value[x] | I | 1..1 | Property value | |
valueString | string | |||
valueBase64Binary | base64Binary | |||
Documentation for this format |
This structure is derived from AuditEvent
Differential View
This structure is derived from AuditEvent
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
AuditEvent | 0..* | AuditEvent | Event record kept for security purposes | |
Documentation for this format |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
AuditEvent | I | 0..* | AuditEvent | Event record kept for security purposes |
id | Σ | 0..1 | string | Logical id of this artifact |
meta | ΣI | 0..1 | Meta | Metadata about the resource |
implicitRules | ?!ΣI | 0..1 | uri | A set of rules under which this content was created |
language | I | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred) Max Binding: AllLanguages |
text | I | 0..1 | Narrative | Text summary of the resource, for human interpretation |
contained | 0..* | Resource | Contained, inline Resources | |
extension | I | 0..* | Extension | Additional content defined by implementations |
modifierExtension | ?!I | 0..* | Extension | Extensions that cannot be ignored |
type | ΣI | 1..1 | Coding | Type/identifier of event Binding: AuditEventID (extensible) |
subtype | ΣI | 0..* | Coding | More specific type/id for the event Binding: AuditEventSub-Type (extensible) |
action | ΣI | 0..1 | code | Type of action performed during the event Binding: AuditEventAction (required) |
period | I | 0..1 | Period | When the activity occurred |
recorded | ΣI | 1..1 | instant | Time when the event was recorded |
outcome | ΣI | 0..1 | code | Whether the event succeeded or failed Binding: AuditEventOutcome (required) |
outcomeDesc | ΣI | 0..1 | string | Description of the event outcome |
purposeOfEvent | ΣI | 0..* | CodeableConcept | The purposeOfUse of the event Binding: V3 Value SetPurposeOfUse (extensible) |
agent | I | 1..* | BackboneElement | Actor involved in the event |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | I | 0..* | Extension | Additional content defined by implementations |
modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
type | I | 0..1 | CodeableConcept | How agent participated Binding: ParticipationRoleType (extensible) |
role | I | 0..* | CodeableConcept | Agent role in the event Binding: SecurityRoleType (example) |
who | ΣI | 0..1 | Reference(PractitionerRole | Practitioner | Organization | Device | Patient | RelatedPerson) | Identifier of who |
altId | I | 0..1 | string | Alternative User identity |
name | I | 0..1 | string | Human friendly name for the agent |
requestor | ΣI | 1..1 | boolean | Whether user is initiator |
location | I | 0..1 | Reference(Location) | Where |
policy | I | 0..* | uri | Policy that authorized event |
media | I | 0..1 | Coding | Type of media Binding: MediaTypeCode (extensible) |
network | I | 0..1 | BackboneElement | Logical network location for application activity |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | I | 0..* | Extension | Additional content defined by implementations |
modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
address | I | 0..1 | string | Identifier for the network access point of the user device |
type | I | 0..1 | code | The type of network access point Binding: AuditEventAgentNetworkType (required) |
purposeOfUse | I | 0..* | CodeableConcept | Reason given for this user Binding: V3 Value SetPurposeOfUse (extensible) |
source | I | 1..1 | BackboneElement | Audit Event Reporter |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | I | 0..* | Extension | Additional content defined by implementations |
modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
site | I | 0..1 | string | Logical source location within the enterprise |
observer | ΣI | 1..1 | Reference(PractitionerRole | Practitioner | Organization | Device | Patient | RelatedPerson) | The identity of source detecting the event |
type | I | 0..* | Coding | The type of source where event originated Binding: AuditEventSourceType (extensible) |
entity | I | 0..* | BackboneElement | Data or objects used sev-1: Either a name or a query (NOT both) |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | I | 0..* | Extension | Additional content defined by implementations |
modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
what | ΣI | 0..1 | Reference(Resource) | Specific instance of resource |
type | I | 0..1 | Coding | Type of entity involved Binding: AuditEventEntityType (extensible) |
role | I | 0..1 | Coding | What role the entity played Binding: AuditEventEntityRole (extensible) |
lifecycle | I | 0..1 | Coding | Life-cycle stage for the entity Binding: ObjectLifecycleEvents (extensible) |
securityLabel | I | 0..* | Coding | Security labels on the entity Binding: All Security Labels (extensible) |
name | ΣI | 0..1 | string | Descriptor for entity |
description | I | 0..1 | string | Descriptive text |
query | ΣI | 0..1 | base64Binary | Query parameters |
detail | I | 0..* | BackboneElement | Additional Information about the entity |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | I | 0..* | Extension | Additional content defined by implementations |
modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
type | I | 1..1 | string | Name of the property |
value[x] | I | 1..1 | Property value | |
valueString | string | |||
valueBase64Binary | base64Binary | |||
Documentation for this format |
Other representations of profile: 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 | v3.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 | v3.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 |
Id | Path | Details | Requirements |
sev-1 | AuditEvent.entity | Either a name or a query (NOT both) : name.empty() or query.empty() |