International Patient Access
0.1.0 - draft

International Patient Access, published by HL7. This is not an authorized publication; it is the continuous build for version 0.1.0). This version is based on the current content of https://github.com/grahamegrieve/ipa-candidate/ and changes regularly. See the Directory of published versions

StructureDefinition: IPAAuditEvent

Minimum expectations for an AuditEvent resource when accessed via a International Patient Access API

The official URL for this profile is:

http://hl7.org/fhir/uv/ipa/StructureDefinition/ipa-auditevent

Formal Views of Profile Content

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

This structure is derived from AuditEvent

Summary

Mandatory: 4 elements
Must-Support: 6 elements

Structures

This structure refers to these other structures:

NameFlagsCard.TypeDescription & Constraintsdoco
.. AuditEvent I0..*AuditEventEvent record kept for security purposes
... id Σ0..1stringLogical id of this artifact
... meta ΣI0..1MetaMetadata about the resource
... implicitRules ?!ΣI0..1uriA set of rules under which this content was created
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension I0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!I0..*ExtensionExtensions that cannot be ignored
... type SΣI1..1CodingType/identifier of event
Binding: AuditEventID (extensible)
... subtype ΣI0..*CodingMore specific type/id for the event
Binding: AuditEventSub-Type (extensible)
... action ΣI0..1codeType of action performed during the event
Binding: AuditEventAction (required)
... period I0..1PeriodWhen the activity occurred
... recorded SΣI1..1instantTime when the event was recorded
... outcome ΣI0..1codeWhether the event succeeded or failed
Binding: AuditEventOutcome (required)
... outcomeDesc ΣI0..1stringDescription of the event outcome
... purposeOfEvent ΣI0..*CodeableConceptThe purposeOfUse of the event
Binding: V3 Value SetPurposeOfUse (extensible)
... agent SI1..*BackboneElementActor involved in the event
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... type I0..1CodeableConceptHow agent participated
Binding: ParticipationRoleType (extensible)
.... role I0..*CodeableConceptAgent role in the event
Binding: SecurityRoleType (example)
.... who SΣI1..1Reference(IPA-Practitioner | IPA-PractitionerRole | IPA-RelatedPerson | IPA-Patient | IPA-Device | IPA-Organization)Identifier of who
.... altId I0..1stringAlternative User identity
.... name I0..1stringHuman friendly name for the agent
.... requestor ΣI1..1booleanWhether user is initiator
.... location I0..1Reference(Location)Where
.... policy I0..*uriPolicy that authorized event
.... media I0..1CodingType of media
Binding: MediaTypeCode (extensible)
.... network I0..1BackboneElementLogical network location for application activity
..... id 0..1stringUnique id for inter-element referencing
..... extension I0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... address I0..1stringIdentifier for the network access point of the user device
..... type I0..1codeThe type of network access point
Binding: AuditEventAgentNetworkType (required)
.... purposeOfUse I0..*CodeableConceptReason given for this user
Binding: V3 Value SetPurposeOfUse (extensible)
... source I1..1BackboneElementAudit Event Reporter
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... site I0..1stringLogical source location within the enterprise
.... observer ΣI1..1Reference(PractitionerRole | Practitioner | Organization | Device | Patient | RelatedPerson)The identity of source detecting the event
.... type I0..*CodingThe type of source where event originated
Binding: AuditEventSourceType (extensible)
... entity SI1..*BackboneElementData or objects used
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... what SΣI1..1Reference(Resource)Specific instance of resource
.... type I0..1CodingType of entity involved
Binding: AuditEventEntityType (extensible)
.... role I0..1CodingWhat role the entity played
Binding: AuditEventEntityRole (extensible)
.... lifecycle I0..1CodingLife-cycle stage for the entity
Binding: ObjectLifecycleEvents (extensible)
.... securityLabel I0..*CodingSecurity labels on the entity
Binding: All Security Labels (extensible)
.... name ΣI0..1stringDescriptor for entity
.... description I0..1stringDescriptive text
.... query ΣI0..1base64BinaryQuery parameters
.... detail I0..*BackboneElementAdditional Information about the entity
..... id 0..1stringUnique id for inter-element referencing
..... extension I0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... type I1..1stringName of the property
..... value[x] I1..1Property value
...... valueStringstring
...... valueBase64Binarybase64Binary

doco Documentation for this format

This structure is derived from AuditEvent

Summary

Mandatory: 4 elements
Must-Support: 6 elements

Structures

This structure refers to these other structures:

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. AuditEvent I0..*AuditEventEvent record kept for security purposes
... id Σ0..1stringLogical id of this artifact
... meta ΣI0..1MetaMetadata about the resource
... implicitRules ?!ΣI0..1uriA set of rules under which this content was created
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension I0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!I0..*ExtensionExtensions that cannot be ignored
... type SΣI1..1CodingType/identifier of event
Binding: AuditEventID (extensible)
... subtype ΣI0..*CodingMore specific type/id for the event
Binding: AuditEventSub-Type (extensible)
... action ΣI0..1codeType of action performed during the event
Binding: AuditEventAction (required)
... period I0..1PeriodWhen the activity occurred
... recorded SΣI1..1instantTime when the event was recorded
... outcome ΣI0..1codeWhether the event succeeded or failed
Binding: AuditEventOutcome (required)
... outcomeDesc ΣI0..1stringDescription of the event outcome
... purposeOfEvent ΣI0..*CodeableConceptThe purposeOfUse of the event
Binding: V3 Value SetPurposeOfUse (extensible)
... agent SI1..*BackboneElementActor involved in the event
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... type I0..1CodeableConceptHow agent participated
Binding: ParticipationRoleType (extensible)
.... role I0..*CodeableConceptAgent role in the event
Binding: SecurityRoleType (example)
.... who SΣI1..1Reference(IPA-Practitioner | IPA-PractitionerRole | IPA-RelatedPerson | IPA-Patient | IPA-Device | IPA-Organization)Identifier of who
.... altId I0..1stringAlternative User identity
.... name I0..1stringHuman friendly name for the agent
.... requestor ΣI1..1booleanWhether user is initiator
.... location I0..1Reference(Location)Where
.... policy I0..*uriPolicy that authorized event
.... media I0..1CodingType of media
Binding: MediaTypeCode (extensible)
.... network I0..1BackboneElementLogical network location for application activity
..... id 0..1stringUnique id for inter-element referencing
..... extension I0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... address I0..1stringIdentifier for the network access point of the user device
..... type I0..1codeThe type of network access point
Binding: AuditEventAgentNetworkType (required)
.... purposeOfUse I0..*CodeableConceptReason given for this user
Binding: V3 Value SetPurposeOfUse (extensible)
... source I1..1BackboneElementAudit Event Reporter
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... site I0..1stringLogical source location within the enterprise
.... observer ΣI1..1Reference(PractitionerRole | Practitioner | Organization | Device | Patient | RelatedPerson)The identity of source detecting the event
.... type I0..*CodingThe type of source where event originated
Binding: AuditEventSourceType (extensible)
... entity SI1..*BackboneElementData or objects used
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... what SΣI1..1Reference(Resource)Specific instance of resource
.... type I0..1CodingType of entity involved
Binding: AuditEventEntityType (extensible)
.... role I0..1CodingWhat role the entity played
Binding: AuditEventEntityRole (extensible)
.... lifecycle I0..1CodingLife-cycle stage for the entity
Binding: ObjectLifecycleEvents (extensible)
.... securityLabel I0..*CodingSecurity labels on the entity
Binding: All Security Labels (extensible)
.... name ΣI0..1stringDescriptor for entity
.... description I0..1stringDescriptive text
.... query ΣI0..1base64BinaryQuery parameters
.... detail I0..*BackboneElementAdditional Information about the entity
..... id 0..1stringUnique id for inter-element referencing
..... extension I0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... type I1..1stringName of the property
..... value[x] I1..1Property value
...... valueStringstring
...... valueBase64Binarybase64Binary

doco Documentation for this format

 

Other representations of profile: Schematron

Terminology Bindings

Terminology Bindings

PathConformanceValueSet
AuditEvent.languagepreferredCommonLanguages
Max Binding: AllLanguages
AuditEvent.typeextensibleAuditEventID
AuditEvent.subtypeextensibleAuditEventSub-Type
AuditEvent.actionrequiredAuditEventAction
AuditEvent.outcomerequiredAuditEventOutcome
AuditEvent.purposeOfEventextensiblev3.PurposeOfUse
AuditEvent.agent.typeextensibleParticipationRoleType
AuditEvent.agent.roleexampleSecurityRoleType
AuditEvent.agent.mediaextensibleMediaTypeCode
AuditEvent.agent.network.typerequiredAuditEventAgentNetworkType
AuditEvent.agent.purposeOfUseextensiblev3.PurposeOfUse
AuditEvent.source.typeextensibleAuditEventSourceType
AuditEvent.entity.typeextensibleAuditEventEntityType
AuditEvent.entity.roleextensibleAuditEventEntityRole
AuditEvent.entity.lifecycleextensibleObjectLifecycleEvents
AuditEvent.entity.securityLabelextensibleAll Security Labels

Constraints

Constraints

IdPathDetailsRequirements