Patient Identifier Cross-referencing for mobile (PIXm)
3.0.2 - Trial-Implementation
This page is part of the IHE Patient Identifier Cross-referencing for Mobile (v3.0.2: Trial Implementation) based on FHIR R4. This is the current published version. For a full list of available versions, see the Directory of published versions
Official URL: https://profiles.ihe.net/ITI/PIXm/StructureDefinition/IHE.PIXm.Feed.Audit.Manager | Version: 3.0.2 | |||
Active as of 2022-02-28 | Computable Name: AuditPixmFeedManager | |||
Copyright/Legal: IHE http://www.ihe.net/Governance/#Intellectual_Property |
Defines constraints on the AuditEvent Resource to record when a Patient Identity Feed FHIR Transaction happens, as recorded by the Patient Identifier Cross-reference Manager.
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from AuditEvent
Summary
Mandatory: 14 elements
Must-Support: 1 element
Prohibited: 1 element
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 | |
modifierExtension | 0..0 | |||
type | 1..1 | Coding | Type/identifier of event Required Pattern: At least the following | |
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: 110110 | |
display | 1..1 | string | Representation defined by the system Fixed Value: Patient Record | |
subtype | 0..* | Coding | More specific type/id for the event Required Pattern: At least the following | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: urn:ihe:event-type-code | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: ITI-104 | |
display | 1..1 | string | Representation defined by the system Fixed Value: Patient Identity Feed FHIR | |
action | 0..1 | code | C (create) , U (update), or D (delete) as appropriate | |
outcome | 1..1 | code | Whether the event succeeded or failed | |
outcomeDesc | S | 0..1 | string | Description of the event outcome |
Slices for agent | 2..* | BackboneElement | Actor involved in the event Slice: Unordered, Open by pattern:type | |
agent:source | 1..1 | BackboneElement | Actor involved in the event | |
type | 1..1 | CodeableConcept | How agent participated 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 | |
network | 1..1 | BackboneElement | Logical network location for application activity | |
agent:destination | I | 1..1 | BackboneElement | Actor involved in the event val-audit-source: The Audit Source is this agent too. |
type | 1..1 | CodeableConcept | How agent participated 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 | |
network | 1..1 | BackboneElement | Logical network location for application activity | |
Slices for entity | 1..1 | BackboneElement | Data or objects used Slice: Unordered, Closed by pattern:type | |
entity:patient | 1..1 | BackboneElement | Data or objects used | |
what | 1..1 | Reference(Resource) | Specific instance of resource | |
identifier | 1..1 | Identifier | Logical reference, when literal reference is not known | |
type | 1..1 | Coding | Type of entity involved Required Pattern: At least the following | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/audit-entity-type | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 1 | |
display | 1..1 | string | Representation defined by the system Fixed Value: Person | |
role | 0..1 | Coding | What role the entity played Required Pattern: At least the following | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/object-role | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 1 | |
display | 1..1 | string | Representation defined by the system Fixed Value: Patient | |
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 | |
type | Σ | 1..1 | Coding | Type/identifier of event Binding: AuditEventID (extensible): Type of event. Required Pattern: At least the following |
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: 110110 | |
display | 1..1 | string | Representation defined by the system Fixed Value: Patient Record | |
userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |
subtype | Σ | 0..* | Coding | More specific type/id for the event Binding: AuditEventSub-Type (extensible): Sub-type of event. Required Pattern: At least the following |
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: urn:ihe:event-type-code | |
version | 0..1 | string | Version of the system - if relevant | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: ITI-104 | |
display | 1..1 | string | Representation defined by the system Fixed Value: Patient Identity Feed FHIR | |
userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |
action | Σ | 0..1 | code | C (create) , U (update), or D (delete) as appropriate Binding: AuditEventAction (required): Indicator for type of action performed during the event that generated the event. |
period | 0..1 | Period | When the activity occurred | |
recorded | Σ | 1..1 | instant | Time when the event was recorded |
outcome | Σ | 1..1 | code | Whether the event succeeded or failed Binding: AuditEventOutcome (required): Indicates whether the event succeeded or failed. |
outcomeDesc | SΣ | 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 by pattern:type | |
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 | 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 | 1..1 | CodeableConcept | How agent participated Binding: ParticipationRoleType (extensible): The Participation type of the agent to the event. 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 | |
role | 0..* | CodeableConcept | Agent role in the event Binding: SecurityRoleType (example): What security role enabled the agent to participate in the event. | |
who | Σ | 1..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 | 1..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 | I | 1..1 | BackboneElement | Actor involved in the event val-audit-source: The Audit Source is this agent too. |
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 | CodeableConcept | How agent participated Binding: ParticipationRoleType (extensible): The Participation type of the agent to the event. 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 | |
role | 0..* | CodeableConcept | Agent role in the event Binding: SecurityRoleType (example): What security role enabled the agent to participate in the event. | |
who | Σ | 1..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 | 1..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. | |
Slices for entity | I | 1..1 | BackboneElement | Data or objects used Slice: Unordered, Closed by pattern:type |
entity: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 |
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 | 0..1 | Coding | What role the entity played Binding: AuditEventEntityRole (extensible): Code representing the role the entity played in the audit event. | |
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 | |||
entity:patient | I | 1..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 | Σ | 1..1 | Reference(Resource) | Specific instance of resource |
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 | |
reference | ΣI | 0..1 | string | Literal reference, Relative, internal or absolute URL |
type | Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). |
identifier | Σ | 1..1 | Identifier | Logical reference, when literal reference is not known |
display | Σ | 0..1 | string | Text alternative for the resource |
type | 1..1 | Coding | Type of entity involved Binding: AuditEventEntityType (extensible): Code for the entity type involved in the audit event. Required Pattern: At least the following | |
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://terminology.hl7.org/CodeSystem/audit-entity-type | |
version | 0..1 | string | Version of the system - if relevant | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 1 | |
display | 1..1 | string | Representation defined by the system Fixed Value: Person | |
userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |
role | 0..1 | Coding | What role the entity played Binding: AuditEventEntityRole (extensible): Code representing the role the entity played in the audit event. Required Pattern: At least the following | |
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://terminology.hl7.org/CodeSystem/object-role | |
version | 0..1 | string | Version of the system - if relevant | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 1 | |
display | 1..1 | string | Representation defined by the system Fixed Value: Patient | |
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 | |
outcomeDesc | Σ | 0..1 | string | Description of the event outcome |
Documentation for this format |
This structure is derived from AuditEvent
Summary
Mandatory: 14 elements
Must-Support: 1 element
Prohibited: 1 element
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 | |
modifierExtension | 0..0 | |||
type | 1..1 | Coding | Type/identifier of event Required Pattern: At least the following | |
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: 110110 | |
display | 1..1 | string | Representation defined by the system Fixed Value: Patient Record | |
subtype | 0..* | Coding | More specific type/id for the event Required Pattern: At least the following | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: urn:ihe:event-type-code | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: ITI-104 | |
display | 1..1 | string | Representation defined by the system Fixed Value: Patient Identity Feed FHIR | |
action | 0..1 | code | C (create) , U (update), or D (delete) as appropriate | |
outcome | 1..1 | code | Whether the event succeeded or failed | |
outcomeDesc | S | 0..1 | string | Description of the event outcome |
Slices for agent | 2..* | BackboneElement | Actor involved in the event Slice: Unordered, Open by pattern:type | |
agent:source | 1..1 | BackboneElement | Actor involved in the event | |
type | 1..1 | CodeableConcept | How agent participated 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 | |
network | 1..1 | BackboneElement | Logical network location for application activity | |
agent:destination | I | 1..1 | BackboneElement | Actor involved in the event val-audit-source: The Audit Source is this agent too. |
type | 1..1 | CodeableConcept | How agent participated 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 | |
network | 1..1 | BackboneElement | Logical network location for application activity | |
Slices for entity | 1..1 | BackboneElement | Data or objects used Slice: Unordered, Closed by pattern:type | |
entity:patient | 1..1 | BackboneElement | Data or objects used | |
what | 1..1 | Reference(Resource) | Specific instance of resource | |
identifier | 1..1 | Identifier | Logical reference, when literal reference is not known | |
type | 1..1 | Coding | Type of entity involved Required Pattern: At least the following | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/audit-entity-type | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 1 | |
display | 1..1 | string | Representation defined by the system Fixed Value: Person | |
role | 0..1 | Coding | What role the entity played Required Pattern: At least the following | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/object-role | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 1 | |
display | 1..1 | string | Representation defined by the system Fixed Value: Patient | |
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 | |
type | Σ | 1..1 | Coding | Type/identifier of event Binding: AuditEventID (extensible): Type of event. Required Pattern: At least the following |
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: 110110 | |
display | 1..1 | string | Representation defined by the system Fixed Value: Patient Record | |
userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |
subtype | Σ | 0..* | Coding | More specific type/id for the event Binding: AuditEventSub-Type (extensible): Sub-type of event. Required Pattern: At least the following |
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: urn:ihe:event-type-code | |
version | 0..1 | string | Version of the system - if relevant | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: ITI-104 | |
display | 1..1 | string | Representation defined by the system Fixed Value: Patient Identity Feed FHIR | |
userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |
action | Σ | 0..1 | code | C (create) , U (update), or D (delete) as appropriate Binding: AuditEventAction (required): Indicator for type of action performed during the event that generated the event. |
period | 0..1 | Period | When the activity occurred | |
recorded | Σ | 1..1 | instant | Time when the event was recorded |
outcome | Σ | 1..1 | code | Whether the event succeeded or failed Binding: AuditEventOutcome (required): Indicates whether the event succeeded or failed. |
outcomeDesc | SΣ | 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 by pattern:type | |
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 | 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 | 1..1 | CodeableConcept | How agent participated Binding: ParticipationRoleType (extensible): The Participation type of the agent to the event. 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 | |
role | 0..* | CodeableConcept | Agent role in the event Binding: SecurityRoleType (example): What security role enabled the agent to participate in the event. | |
who | Σ | 1..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 | 1..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 | I | 1..1 | BackboneElement | Actor involved in the event val-audit-source: The Audit Source is this agent too. |
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 | CodeableConcept | How agent participated Binding: ParticipationRoleType (extensible): The Participation type of the agent to the event. 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 | |
role | 0..* | CodeableConcept | Agent role in the event Binding: SecurityRoleType (example): What security role enabled the agent to participate in the event. | |
who | Σ | 1..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 | 1..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. | |
Slices for entity | I | 1..1 | BackboneElement | Data or objects used Slice: Unordered, Closed by pattern:type |
entity: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 |
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 | 0..1 | Coding | What role the entity played Binding: AuditEventEntityRole (extensible): Code representing the role the entity played in the audit event. | |
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 | |||
entity:patient | I | 1..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 | Σ | 1..1 | Reference(Resource) | Specific instance of resource |
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 | |
reference | ΣI | 0..1 | string | Literal reference, Relative, internal or absolute URL |
type | Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). |
identifier | Σ | 1..1 | Identifier | Logical reference, when literal reference is not known |
display | Σ | 0..1 | string | Text alternative for the resource |
type | 1..1 | Coding | Type of entity involved Binding: AuditEventEntityType (extensible): Code for the entity type involved in the audit event. Required Pattern: At least the following | |
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://terminology.hl7.org/CodeSystem/audit-entity-type | |
version | 0..1 | string | Version of the system - if relevant | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 1 | |
display | 1..1 | string | Representation defined by the system Fixed Value: Person | |
userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |
role | 0..1 | Coding | What role the entity played Binding: AuditEventEntityRole (extensible): Code representing the role the entity played in the audit event. Required Pattern: At least the following | |
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://terminology.hl7.org/CodeSystem/object-role | |
version | 0..1 | string | Version of the system - if relevant | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 1 | |
display | 1..1 | string | Representation defined by the system Fixed Value: Patient | |
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 / Code |
AuditEvent.language | preferred | CommonLanguages Max Binding: AllLanguages |
AuditEvent.type | extensible | Pattern: 110110("Patient Record") |
AuditEvent.subtype | extensible | Pattern: ITI-104("Patient Identity Feed FHIR") |
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 | Pattern: 110153("Source Role ID") |
AuditEvent.agent:source.role | example | SecurityRoleType |
AuditEvent.agent:source.media | extensible | MediaTypeCode |
AuditEvent.agent:source.network.type | required | AuditEventAgentNetworkType |
AuditEvent.agent:source.purposeOfUse | extensible | PurposeOfUse |
AuditEvent.agent:destination.type | extensible | Pattern: 110152("Destination Role ID") |
AuditEvent.agent:destination.role | example | SecurityRoleType |
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 |
AuditEvent.entity:patient.what.type | extensible | ResourceType |
AuditEvent.entity:patient.type | extensible | Pattern: 1("Person") |
AuditEvent.entity:patient.role | extensible | Pattern: 1("Patient") |
AuditEvent.entity:patient.lifecycle | extensible | ObjectLifecycleEvents |
AuditEvent.entity:patient.securityLabel | extensible | All Security Labels |
Id | Grade | Path | Details | Requirements |
val-audit-source | error | AuditEvent.agent:destination | The Audit Source is this agent too. : $this.who = %resource.source.observer |