STU 3 Ballot

This page is part of the FHIR Specification (v1.6.0: STU 3 Ballot 4). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions . Page versions: R4 R3 R2

E.1 StructureDefinition: EHRSRLE-AuditEvent

This profile is marked as a draft.

The official URL for this profile is: 

http://hl7.org/fhir/StructureDefinition/ehrsrle-auditevent

Defines the elements to be supported within the AuditEvent resource in order to conform with the Electronic Health Record System Functional Model Record Lifecycle Event standard

This profile was published on Thu, Dec 4, 2014 00:00+1100 as a draft by Health Level Seven International (Electronic Health Record).

E.1.1 Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots, and how the XML and JSON presentations work.

This structure is derived from AuditEvent.

Summary

Must-Support: 27 elements

NameFlagsCard.TypeDescription & Constraintsdoco
.. AuditEvent I0..*Event record kept for security purposes
dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
dom-1: If the resource is contained in another resource, it SHALL NOT contain any narrative
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource
... id ∑0..1idLogical id of this artifact
... meta ∑0..1MetaMetadata about the resource
... implicitRules ?!∑0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: Common Languages (extensible)
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional Content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... type S∑1..1CodingType/identifier of event
Binding: Audit Event ID (extensible)
... subtype S∑0..*CodingMore specific type/id for the event
Binding: Audit Event Sub-Type (extensible)
... action S∑0..1codeType of action performed during the event
Binding: AuditEventAction (required)
... recorded S∑1..1instantTime when the event occurred on source
... outcome ∑0..1codeWhether the event succeeded or failed
Binding: AuditEventOutcome (required)
... outcomeDesc ∑0..1stringDescription of the event outcome
... purposeOfEvent S∑0..*CodingThe purposeOfUse of the event
Binding: PurposeOfUse (extensible)
... agent S1..*BackboneElementActor involved in the event
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!∑0..*ExtensionExtensions that cannot be ignored
.... role S0..*CodeableConceptAgent role in the event
Binding: Audit agent Role ID Code (extensible)
.... reference S∑0..1Reference(Practitioner | Organization | Device | Patient | RelatedPerson)Direct reference to resource
.... userId S∑0..1IdentifierUnique identifier for the user
.... altId 0..1stringAlternative User id e.g. authentication
.... name 0..1stringHuman-meaningful name for the agent
.... requestor S1..1booleanWhether user is initiator
.... location S0..1Reference(Location)Where
.... policy S0..*uriPolicy that authorized event
.... media 0..1CodingType of media
Binding: Media Type Code (extensible)
.... network S0..1BackboneElementLogical network location for application activity
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
..... modifierExtension ?!∑0..*ExtensionExtensions that cannot be ignored
..... address S0..1stringIdentifier for the network access point of the user device
..... type S0..1codeThe type of network access point
Binding: AuditEventAgentNetworkType (required)
.... purposeOfUse S0..*CodingReason given for this user
Binding: PurposeOfUse (extensible)
... source S1..1BackboneElementAudit Event Reporter
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!∑0..*ExtensionExtensions that cannot be ignored
.... site S0..1stringLogical source location within the enterprise
.... identifier S∑1..1IdentifierThe identity of source detecting the event
.... type S0..*CodingThe type of source where event originated
Binding: Audit Event Source Type (extensible)
... entity SI0..*BackboneElementData or objects used
sev-1: Either a name or a query (NOT both)
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!∑0..*ExtensionExtensions that cannot be ignored
.... identifier S∑0..1IdentifierSpecific instance of object
.... reference S∑0..1Reference(Resource)Specific instance of resource
.... type S0..1CodingType of entity involved
Binding: AuditEventEntityType (extensible)
.... role S0..1CodingWhat role the entity played
Binding: AuditEventEntityRole (extensible)
.... lifecycle S0..1CodingLife-cycle stage for the entity
Binding: AuditEventEntityLifecycle (extensible)
.... securityLabel S0..*CodingSecurity labels on the entity
Binding: All Security Labels (extensible)
.... name ∑I0..1stringDescriptor for entity
.... description 0..1stringDescriptive text
.... query ∑I0..1base64BinaryQuery parameters
.... detail 0..*BackboneElementAdditional Information about the entity
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
..... modifierExtension ?!∑0..*ExtensionExtensions that cannot be ignored
..... type 1..1stringName of the property
..... value 1..1base64BinaryProperty value

doco Documentation for this format

todo

This structure is derived from AuditEvent.

Summary

Must-Support: 27 elements

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. AuditEvent I0..*Event record kept for security purposes
dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
dom-1: If the resource is contained in another resource, it SHALL NOT contain any narrative
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource
... id ∑0..1idLogical id of this artifact
... meta ∑0..1MetaMetadata about the resource
... implicitRules ?!∑0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: Common Languages (extensible)
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional Content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... type S∑1..1CodingType/identifier of event
Binding: Audit Event ID (extensible)
... subtype S∑0..*CodingMore specific type/id for the event
Binding: Audit Event Sub-Type (extensible)
... action S∑0..1codeType of action performed during the event
Binding: AuditEventAction (required)
... recorded S∑1..1instantTime when the event occurred on source
... outcome ∑0..1codeWhether the event succeeded or failed
Binding: AuditEventOutcome (required)
... outcomeDesc ∑0..1stringDescription of the event outcome
... purposeOfEvent S∑0..*CodingThe purposeOfUse of the event
Binding: PurposeOfUse (extensible)
... agent S1..*BackboneElementActor involved in the event
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!∑0..*ExtensionExtensions that cannot be ignored
.... role S0..*CodeableConceptAgent role in the event
Binding: Audit agent Role ID Code (extensible)
.... reference S∑0..1Reference(Practitioner | Organization | Device | Patient | RelatedPerson)Direct reference to resource
.... userId S∑0..1IdentifierUnique identifier for the user
.... altId 0..1stringAlternative User id e.g. authentication
.... name 0..1stringHuman-meaningful name for the agent
.... requestor S1..1booleanWhether user is initiator
.... location S0..1Reference(Location)Where
.... policy S0..*uriPolicy that authorized event
.... media 0..1CodingType of media
Binding: Media Type Code (extensible)
.... network S0..1BackboneElementLogical network location for application activity
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
..... modifierExtension ?!∑0..*ExtensionExtensions that cannot be ignored
..... address S0..1stringIdentifier for the network access point of the user device
..... type S0..1codeThe type of network access point
Binding: AuditEventAgentNetworkType (required)
.... purposeOfUse S0..*CodingReason given for this user
Binding: PurposeOfUse (extensible)
... source S1..1BackboneElementAudit Event Reporter
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!∑0..*ExtensionExtensions that cannot be ignored
.... site S0..1stringLogical source location within the enterprise
.... identifier S∑1..1IdentifierThe identity of source detecting the event
.... type S0..*CodingThe type of source where event originated
Binding: Audit Event Source Type (extensible)
... entity SI0..*BackboneElementData or objects used
sev-1: Either a name or a query (NOT both)
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!∑0..*ExtensionExtensions that cannot be ignored
.... identifier S∑0..1IdentifierSpecific instance of object
.... reference S∑0..1Reference(Resource)Specific instance of resource
.... type S0..1CodingType of entity involved
Binding: AuditEventEntityType (extensible)
.... role S0..1CodingWhat role the entity played
Binding: AuditEventEntityRole (extensible)
.... lifecycle S0..1CodingLife-cycle stage for the entity
Binding: AuditEventEntityLifecycle (extensible)
.... securityLabel S0..*CodingSecurity labels on the entity
Binding: All Security Labels (extensible)
.... name ∑I0..1stringDescriptor for entity
.... description 0..1stringDescriptive text
.... query ∑I0..1base64BinaryQuery parameters
.... detail 0..*BackboneElementAdditional Information about the entity
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
..... modifierExtension ?!∑0..*ExtensionExtensions that cannot be ignored
..... type 1..1stringName of the property
..... value 1..1base64BinaryProperty value

doco Documentation for this format

XML Template

JSON Template

todo

 

Other representations of profile: Schematron

E.1.2 Terminology Bindings

PathNameConformanceValueSet
AuditEvent.languageCommon LanguagesextensibleCommon Languages
AuditEvent.typeAudit Event IDextensibleAudit Event ID
AuditEvent.subtypeAudit Event Sub-TypeextensibleAudit Event Sub-Type
AuditEvent.actionAuditEventActionrequiredAuditEventAction
AuditEvent.outcomeAuditEventOutcomerequiredAuditEventOutcome
AuditEvent.purposeOfEventPurposeOfUseextensiblePurposeOfUse
AuditEvent.agent.roleAudit agent Role ID CodeextensibleAudit agent Role ID Code
AuditEvent.agent.mediaMedia Type CodeextensibleMedia Type Code
AuditEvent.agent.network.typeAuditEventAgentNetworkTyperequiredAuditEventAgentNetworkType
AuditEvent.agent.purposeOfUsePurposeOfUseextensiblePurposeOfUse
AuditEvent.source.typeAudit Event Source TypeextensibleAudit Event Source Type
AuditEvent.entity.typeAuditEventEntityTypeextensibleAuditEventEntityType
AuditEvent.entity.roleAuditEventEntityRoleextensibleAuditEventEntityRole
AuditEvent.entity.lifecycleAuditEventEntityLifecycleextensibleAuditEventEntityLifecycle
AuditEvent.entity.securityLabelAll Security LabelsextensibleAll Security Labels

E.1.3 Constraints

IdPathDetailsRequirements
dom-2AuditEventIf the resource is contained in another resource, it SHALL NOT contain nested Resources
XPath: not(parent::f:contained and f:contained)
dom-1AuditEventIf the resource is contained in another resource, it SHALL NOT contain any narrative
XPath: not(parent::f:contained and f:text)
dom-4AuditEventIf a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
XPath: not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))
dom-3AuditEventIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource
XPath: not(exists(for $id in f:contained/*/@id return $id[not(ancestor::f:contained/parent::*/descendant::f:reference/@value=concat('#', $id))]))
sev-1AuditEvent.entityEither a name or a query (NOT both)
XPath: not(exists(f:name)) or not(exists(f:query))
.