Non-patient File Sharing (NPFS)
2.2.0 - Trial-Implementation
Non-patient File Sharing (NPFS)
2.2.0 - Trial-Implementation
This page is part of the Non-patient File Sharing (NPFS) (v2.2.0: Publication) 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/NPFS/StructureDefinition/IHE.NPFS.UpdateDocumentReference.Audit.Manager | Version: 2.2.0 | |||
| Active as of 2023-11-16 | Computable Name: AuditUpdateDocumentReferenceManager | |||
Defines constraints on the File Manager AuditEvent Resource to record when a Update DocumentReference Transaction happens, as recorded by the File Manager.
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from Update
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  AuditEvent | 0..* | Update | Event record kept for security purposes | |
  modifierExtension | 0..0 | |||
 subtype | 2..* | Coding | More specific type/id for the event | |
 subtype:iti89 | 1..1 | 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-89 | |
 display | 1..1 | string | Representation defined by the system Fixed Value: Update DocumentReference | |
| agent:client | 1..1 | BackboneElement | File Source | |
| agent:server | C | 1..1 | BackboneElement | File Manager val-audit-source: The Audit Source is this agent too. |
 entity:data | 1..1 | BackboneElement | the DocumentReference reference | |
 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: 3 | |
| display | 1..1 | string | Representation defined by the system Fixed Value: Report | |
| Documentation for this format | ||||
| Id | Grade | Path(s) | Details | Requirements |
| val-audit-source | error | AuditEvent.agent:server | The Audit Source is this agent too. : $this.who = %resource.source.observer |
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| AuditEvent | 0..* | Update | Event record kept for security purposes | |
 implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
 type | Σ | 1..1 | Coding | Type/identifier of event Binding: AuditEventID (extensible): Type of event. Required Pattern: At least the following |
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/audit-event-type | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: rest | |
 Slices for subtype | Σ | 2..* | Coding | More specific type/id for the event Slice: Unordered, Open by value:$this Binding: AuditEventSub-Type (extensible): Sub-type of event. |
 subtype:anyUpdate | Σ | 0..1 | Coding | More specific type/id for the event Binding: AuditEventSub-Type (extensible): Sub-type of event. Required Pattern: At least the following |
 system | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/restful-interaction | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: update | |
| subtype:anyPatch | Σ | 0..1 | Coding | More specific type/id for the event Binding: AuditEventSub-Type (extensible): Sub-type of event. Required Pattern: At least the following |
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/restful-interaction | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: patch | |
 subtype:iti89 | Σ | 1..1 | Coding | More specific type/id for the event Binding: AuditEventSub-Type (extensible): Sub-type of 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-89 | |
| display | 1..1 | string | Representation defined by the system Fixed Value: Update DocumentReference | |
| recorded | Σ | 1..1 | instant | Time when the event was recorded |
| Slices for agent | 2..* | BackboneElement | Actor involved in the event Slice: Unordered, Open by pattern:type | |
| agent:All Slices | Content/Rules for all slices | |||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| requestor | Σ | 1..1 | boolean | Whether user is initiator |
| agent:client | 1..1 | BackboneElement | File Source | |
| 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 | |
 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 | |
 who | Σ | 1..1 | Reference(PractitionerRole | Practitioner | Organization | Device | Patient | RelatedPerson) | Identifier of who |
| requestor | Σ | 1..1 | boolean | Whether user is initiator |
| network | 1..1 | BackboneElement | Logical network location for application activity | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| agent:server | C | 1..1 | BackboneElement | File Manager val-audit-source: The Audit Source is this agent too. |
| 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 | |
| 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 | |
| who | Σ | 1..1 | Reference(PractitionerRole | Practitioner | Organization | Device | Patient | RelatedPerson) | Identifier of who |
| requestor | Σ | 1..1 | boolean | Whether user is initiator |
| network | 1..1 | BackboneElement | Logical network location for application activity | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| agent:user | 0..1 | BackboneElement | Actor involved in the event | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| role | S | 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 |
| name | S | 0..1 | string | Human friendly name for the agent |
| requestor | Σ | 1..1 | boolean | Whether user is initiator Required Pattern: true |
| purposeOfUse | S | 0..* | CodeableConcept | Reason given for this user Binding: PurposeOfUse (extensible): The reason the activity took place. |
| source | S | 1..1 | BackboneElement | Audit Event Reporter |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| observer | Σ | 1..1 | Reference(PractitionerRole | Practitioner | Organization | Device | Patient | RelatedPerson) | The identity of source detecting the event |
| Slices for entity | C | 1..* | BackboneElement | Data or objects used Slice: Unordered, Open by pattern:type |
| entity:All Slices | Content/Rules for all slices | |||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| entity:transaction | C | 0..1 | BackboneElement | Data or objects used |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| 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 | |
| system | 1..1 | uri | Identity of the terminology system Fixed Value: https://profiles.ihe.net/ITI/BALP/CodeSystem/BasicAuditEntityType | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: XrequestId | |
| entity:data | C | 1..1 | BackboneElement | the DocumentReference reference |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| what | Σ | 1..1 | Reference(Resource) | Specific instance of 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 | |
| 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: 2 | |
| role | 0..1 | Coding | What role the entity played Binding: RESTful objects role in the event (required) 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: 3 | |
| display | 1..1 | string | Representation defined by the system Fixed Value: Report | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code |
| AuditEvent.type | extensible | Pattern: rest |
| AuditEvent.subtype | extensible | AuditEventSub-Type |
| AuditEvent.subtype:anyUpdate | extensible | Pattern: update |
| AuditEvent.subtype:anyPatch | extensible | Pattern: patch |
| AuditEvent.subtype:iti89 | extensible | Pattern: ITI-89("Update DocumentReference") |
| AuditEvent.agent:client.type | extensible | Pattern: 110153 |
| AuditEvent.agent:server.type | extensible | Pattern: 110152 |
| AuditEvent.agent:user.role | example | SecurityRoleType |
| AuditEvent.agent:user.purposeOfUse | extensible | PurposeOfUse |
| AuditEvent.entity:transaction.type | extensible | Pattern: XrequestId |
| AuditEvent.entity:data.type | extensible | Pattern: 2 |
| AuditEvent.entity:data.role | required | Pattern: 3("Report") |
| Id | Grade | Path(s) | Details | Requirements |
| val-audit-source | error | AuditEvent.agent:server | The Audit Source is this agent too. : $this.who = %resource.source.observer |
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| AuditEvent | 0..* | Update | Event record kept for security purposes | |||||
| id | Σ | 0..1 | id | 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): 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://terminology.hl7.org/CodeSystem/audit-event-type | |||||
| version | 0..1 | string | Version of the system - if relevant | |||||
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: rest | |||||
| display | 0..1 | string | Representation defined by the system | |||||
| userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |||||
| Slices for subtype | Σ | 2..* | Coding | More specific type/id for the event Slice: Unordered, Open by value:$this Binding: AuditEventSub-Type (extensible): Sub-type of event. | ||||
| subtype:anyUpdate | Σ | 0..1 | 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: http://hl7.org/fhir/restful-interaction | |||||
| version | 0..1 | string | Version of the system - if relevant | |||||
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: update | |||||
| display | 0..1 | string | Representation defined by the system | |||||
| userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |||||
| subtype:anyPatch | Σ | 0..1 | 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: http://hl7.org/fhir/restful-interaction | |||||
| version | 0..1 | string | Version of the system - if relevant | |||||
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: patch | |||||
| display | 0..1 | string | Representation defined by the system | |||||
| userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |||||
| subtype:iti89 | Σ | 1..1 | 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-89 | |||||
| display | 1..1 | string | Representation defined by the system Fixed Value: Update DocumentReference | |||||
| userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |||||
| action | Σ | 0..1 | code | Type of action performed during the event Binding: AuditEventAction (required): Indicator for type of action performed during the event that generated the event. Required Pattern: U | ||||
| period | 0..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): Indicates whether the event succeeded or failed. Required Pattern: 0 | ||||
| outcomeDesc | Σ | 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:client | 1..1 | BackboneElement | File Source | |||||
| 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 | 0..1 | string | Representation defined by the system | |||||
| 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 | |||||
| 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:server | C | 1..1 | BackboneElement | File Manager 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 | 0..1 | string | Representation defined by the system | |||||
| 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 | |||||
| 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:user | 0..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: participant source types for RESTful create (required) | |||||
| role | S | 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 | S | 0..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 | |||||
| purposeOfUse | S | 0..* | CodeableConcept | Reason given for this user Binding: PurposeOfUse (extensible): The reason the activity took place. | ||||
| source | S | 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 | C | 1..* | BackboneElement | Data or objects used Slice: Unordered, Open 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 | ΣC | 0..1 | string | Descriptor for entity | ||||
| description | 0..1 | string | Descriptive text | |||||
| query | ΣC | 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:transaction | C | 0..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 | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| reference | ΣC | 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 | Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
| type | Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
| system | Σ | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
| value | Σ | 1..1 | string | the value of X-Request-Id Example General: 123456 | ||||
| period | Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
| assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
| 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: https://profiles.ihe.net/ITI/BALP/CodeSystem/BasicAuditEntityType | |||||
| version | 0..1 | string | Version of the system - if relevant | |||||
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: XrequestId | |||||
| display | 0..1 | string | Representation defined by the system | |||||
| 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. | |||||
| 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 | ΣC | 0..1 | string | Descriptor for entity | ||||
| description | 0..1 | string | Descriptive text | |||||
| query | ΣC | 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:data | C | 1..1 | BackboneElement | the DocumentReference reference | ||||
| 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 | ||||
| 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: 2 | |||||
| display | 0..1 | string | Representation defined by the system | |||||
| userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |||||
| role | 0..1 | Coding | What role the entity played Binding: RESTful objects role in the event (required) 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: 3 | |||||
| display | 1..1 | string | Representation defined by the system Fixed Value: Report | |||||
| 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 | may contain the security labels on the resource returned Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. | |||||
| name | ΣC | 0..1 | string | Descriptor for entity | ||||
| description | 0..1 | string | Descriptive text | |||||
| query | ΣC | 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 | ||||||||
| Path | Conformance | ValueSet / Code | ||||
| AuditEvent.language | preferred | CommonLanguages
| ||||
| AuditEvent.type | extensible | Pattern: rest | ||||
| AuditEvent.subtype | extensible | AuditEventSub-Type | ||||
| AuditEvent.subtype:anyUpdate | extensible | Pattern: update | ||||
| AuditEvent.subtype:anyPatch | extensible | Pattern: patch | ||||
| AuditEvent.subtype:iti89 | extensible | Pattern: ITI-89("Update DocumentReference") | ||||
| AuditEvent.action | required | Pattern: U | ||||
| AuditEvent.outcome | required | Pattern: 0 | ||||
| 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:client.type | extensible | Pattern: 110153 | ||||
| AuditEvent.agent:client.role | example | SecurityRoleType | ||||
| AuditEvent.agent:client.network.type | required | AuditEventAgentNetworkType | ||||
| AuditEvent.agent:client.purposeOfUse | extensible | PurposeOfUse | ||||
| AuditEvent.agent:server.type | extensible | Pattern: 110152 | ||||
| AuditEvent.agent:server.role | example | SecurityRoleType | ||||
| AuditEvent.agent:server.network.type | required | AuditEventAgentNetworkType | ||||
| AuditEvent.agent:server.purposeOfUse | extensible | PurposeOfUse | ||||
| AuditEvent.agent:user.type | required | DataSources | ||||
| AuditEvent.agent:user.role | example | SecurityRoleType | ||||
| AuditEvent.agent:user.network.type | required | AuditEventAgentNetworkType | ||||
| AuditEvent.agent:user.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:transaction.what.type | extensible | ResourceType | ||||
| AuditEvent.entity:transaction.what.identifier.use | required | IdentifierUse | ||||
| AuditEvent.entity:transaction.what.identifier.type | extensible | Identifier Type Codes | ||||
| AuditEvent.entity:transaction.type | extensible | Pattern: XrequestId | ||||
| AuditEvent.entity:transaction.role | extensible | AuditEventEntityRole | ||||
| AuditEvent.entity:transaction.lifecycle | extensible | ObjectLifecycleEvents | ||||
| AuditEvent.entity:transaction.securityLabel | extensible | All Security Labels | ||||
| AuditEvent.entity:data.type | extensible | Pattern: 2 | ||||
| AuditEvent.entity:data.role | required | Pattern: 3("Report") | ||||
| AuditEvent.entity:data.lifecycle | extensible | ObjectLifecycleEvents | ||||
| AuditEvent.entity:data.securityLabel | extensible | All Security Labels |
| Id | Grade | Path(s) | Details | Requirements |
| val-audit-source | error | AuditEvent.agent:server | The Audit Source is this agent too. : $this.who = %resource.source.observer |
This structure is derived from Update
Differential View
This structure is derived from Update
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| AuditEvent | 0..* | Update | Event record kept for security purposes | |
| modifierExtension | 0..0 | |||
| subtype | 2..* | Coding | More specific type/id for the event | |
| subtype:iti89 | 1..1 | 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-89 | |
| display | 1..1 | string | Representation defined by the system Fixed Value: Update DocumentReference | |
| agent:client | 1..1 | BackboneElement | File Source | |
| agent:server | C | 1..1 | BackboneElement | File Manager val-audit-source: The Audit Source is this agent too. |
| entity:data | 1..1 | BackboneElement | the DocumentReference reference | |
| 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: 3 | |
| display | 1..1 | string | Representation defined by the system Fixed Value: Report | |
| Documentation for this format | ||||
| Id | Grade | Path(s) | Details | Requirements |
| val-audit-source | error | AuditEvent.agent:server | The Audit Source is this agent too. : $this.who = %resource.source.observer |
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| AuditEvent | 0..* | Update | Event record kept for security purposes | |
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
| type | Σ | 1..1 | Coding | Type/identifier of event Binding: AuditEventID (extensible): Type of event. Required Pattern: At least the following |
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/audit-event-type | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: rest | |
| Slices for subtype | Σ | 2..* | Coding | More specific type/id for the event Slice: Unordered, Open by value:$this Binding: AuditEventSub-Type (extensible): Sub-type of event. |
| subtype:anyUpdate | Σ | 0..1 | Coding | More specific type/id for the event Binding: AuditEventSub-Type (extensible): Sub-type of event. Required Pattern: At least the following |
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/restful-interaction | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: update | |
| subtype:anyPatch | Σ | 0..1 | Coding | More specific type/id for the event Binding: AuditEventSub-Type (extensible): Sub-type of event. Required Pattern: At least the following |
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/restful-interaction | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: patch | |
| subtype:iti89 | Σ | 1..1 | Coding | More specific type/id for the event Binding: AuditEventSub-Type (extensible): Sub-type of 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-89 | |
| display | 1..1 | string | Representation defined by the system Fixed Value: Update DocumentReference | |
| recorded | Σ | 1..1 | instant | Time when the event was recorded |
| Slices for agent | 2..* | BackboneElement | Actor involved in the event Slice: Unordered, Open by pattern:type | |
| agent:All Slices | Content/Rules for all slices | |||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| requestor | Σ | 1..1 | boolean | Whether user is initiator |
| agent:client | 1..1 | BackboneElement | File Source | |
| 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 | |
| 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 | |
| who | Σ | 1..1 | Reference(PractitionerRole | Practitioner | Organization | Device | Patient | RelatedPerson) | Identifier of who |
| requestor | Σ | 1..1 | boolean | Whether user is initiator |
| network | 1..1 | BackboneElement | Logical network location for application activity | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| agent:server | C | 1..1 | BackboneElement | File Manager val-audit-source: The Audit Source is this agent too. |
| 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 | |
| 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 | |
| who | Σ | 1..1 | Reference(PractitionerRole | Practitioner | Organization | Device | Patient | RelatedPerson) | Identifier of who |
| requestor | Σ | 1..1 | boolean | Whether user is initiator |
| network | 1..1 | BackboneElement | Logical network location for application activity | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| agent:user | 0..1 | BackboneElement | Actor involved in the event | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| role | S | 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 |
| name | S | 0..1 | string | Human friendly name for the agent |
| requestor | Σ | 1..1 | boolean | Whether user is initiator Required Pattern: true |
| purposeOfUse | S | 0..* | CodeableConcept | Reason given for this user Binding: PurposeOfUse (extensible): The reason the activity took place. |
| source | S | 1..1 | BackboneElement | Audit Event Reporter |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| observer | Σ | 1..1 | Reference(PractitionerRole | Practitioner | Organization | Device | Patient | RelatedPerson) | The identity of source detecting the event |
| Slices for entity | C | 1..* | BackboneElement | Data or objects used Slice: Unordered, Open by pattern:type |
| entity:All Slices | Content/Rules for all slices | |||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| entity:transaction | C | 0..1 | BackboneElement | Data or objects used |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| 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 | |
| system | 1..1 | uri | Identity of the terminology system Fixed Value: https://profiles.ihe.net/ITI/BALP/CodeSystem/BasicAuditEntityType | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: XrequestId | |
| entity:data | C | 1..1 | BackboneElement | the DocumentReference reference |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| what | Σ | 1..1 | Reference(Resource) | Specific instance of 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 | |
| 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: 2 | |
| role | 0..1 | Coding | What role the entity played Binding: RESTful objects role in the event (required) 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: 3 | |
| display | 1..1 | string | Representation defined by the system Fixed Value: Report | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code |
| AuditEvent.type | extensible | Pattern: rest |
| AuditEvent.subtype | extensible | AuditEventSub-Type |
| AuditEvent.subtype:anyUpdate | extensible | Pattern: update |
| AuditEvent.subtype:anyPatch | extensible | Pattern: patch |
| AuditEvent.subtype:iti89 | extensible | Pattern: ITI-89("Update DocumentReference") |
| AuditEvent.agent:client.type | extensible | Pattern: 110153 |
| AuditEvent.agent:server.type | extensible | Pattern: 110152 |
| AuditEvent.agent:user.role | example | SecurityRoleType |
| AuditEvent.agent:user.purposeOfUse | extensible | PurposeOfUse |
| AuditEvent.entity:transaction.type | extensible | Pattern: XrequestId |
| AuditEvent.entity:data.type | extensible | Pattern: 2 |
| AuditEvent.entity:data.role | required | Pattern: 3("Report") |
| Id | Grade | Path(s) | Details | Requirements |
| val-audit-source | error | AuditEvent.agent:server | The Audit Source is this agent too. : $this.who = %resource.source.observer |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| AuditEvent | 0..* | Update | Event record kept for security purposes | |||||
| id | Σ | 0..1 | id | 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): 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://terminology.hl7.org/CodeSystem/audit-event-type | |||||
| version | 0..1 | string | Version of the system - if relevant | |||||
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: rest | |||||
| display | 0..1 | string | Representation defined by the system | |||||
| userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |||||
| Slices for subtype | Σ | 2..* | Coding | More specific type/id for the event Slice: Unordered, Open by value:$this Binding: AuditEventSub-Type (extensible): Sub-type of event. | ||||
| subtype:anyUpdate | Σ | 0..1 | 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: http://hl7.org/fhir/restful-interaction | |||||
| version | 0..1 | string | Version of the system - if relevant | |||||
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: update | |||||
| display | 0..1 | string | Representation defined by the system | |||||
| userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |||||
| subtype:anyPatch | Σ | 0..1 | 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: http://hl7.org/fhir/restful-interaction | |||||
| version | 0..1 | string | Version of the system - if relevant | |||||
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: patch | |||||
| display | 0..1 | string | Representation defined by the system | |||||
| userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |||||
| subtype:iti89 | Σ | 1..1 | 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-89 | |||||
| display | 1..1 | string | Representation defined by the system Fixed Value: Update DocumentReference | |||||
| userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |||||
| action | Σ | 0..1 | code | Type of action performed during the event Binding: AuditEventAction (required): Indicator for type of action performed during the event that generated the event. Required Pattern: U | ||||
| period | 0..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): Indicates whether the event succeeded or failed. Required Pattern: 0 | ||||
| outcomeDesc | Σ | 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:client | 1..1 | BackboneElement | File Source | |||||
| 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 | 0..1 | string | Representation defined by the system | |||||
| 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 | |||||
| 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:server | C | 1..1 | BackboneElement | File Manager 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 | 0..1 | string | Representation defined by the system | |||||
| 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 | |||||
| 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:user | 0..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: participant source types for RESTful create (required) | |||||
| role | S | 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 | S | 0..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 | |||||
| purposeOfUse | S | 0..* | CodeableConcept | Reason given for this user Binding: PurposeOfUse (extensible): The reason the activity took place. | ||||
| source | S | 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 | C | 1..* | BackboneElement | Data or objects used Slice: Unordered, Open 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 | ΣC | 0..1 | string | Descriptor for entity | ||||
| description | 0..1 | string | Descriptive text | |||||
| query | ΣC | 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:transaction | C | 0..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 | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| reference | ΣC | 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 | Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
| type | Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
| system | Σ | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
| value | Σ | 1..1 | string | the value of X-Request-Id Example General: 123456 | ||||
| period | Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
| assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
| 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: https://profiles.ihe.net/ITI/BALP/CodeSystem/BasicAuditEntityType | |||||
| version | 0..1 | string | Version of the system - if relevant | |||||
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: XrequestId | |||||
| display | 0..1 | string | Representation defined by the system | |||||
| 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. | |||||
| 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 | ΣC | 0..1 | string | Descriptor for entity | ||||
| description | 0..1 | string | Descriptive text | |||||
| query | ΣC | 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:data | C | 1..1 | BackboneElement | the DocumentReference reference | ||||
| 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 | ||||
| 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: 2 | |||||
| display | 0..1 | string | Representation defined by the system | |||||
| userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |||||
| role | 0..1 | Coding | What role the entity played Binding: RESTful objects role in the event (required) 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: 3 | |||||
| display | 1..1 | string | Representation defined by the system Fixed Value: Report | |||||
| 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 | may contain the security labels on the resource returned Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. | |||||
| name | ΣC | 0..1 | string | Descriptor for entity | ||||
| description | 0..1 | string | Descriptive text | |||||
| query | ΣC | 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 | ||||||||
| Path | Conformance | ValueSet / Code | ||||
| AuditEvent.language | preferred | CommonLanguages
| ||||
| AuditEvent.type | extensible | Pattern: rest | ||||
| AuditEvent.subtype | extensible | AuditEventSub-Type | ||||
| AuditEvent.subtype:anyUpdate | extensible | Pattern: update | ||||
| AuditEvent.subtype:anyPatch | extensible | Pattern: patch | ||||
| AuditEvent.subtype:iti89 | extensible | Pattern: ITI-89("Update DocumentReference") | ||||
| AuditEvent.action | required | Pattern: U | ||||
| AuditEvent.outcome | required | Pattern: 0 | ||||
| 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:client.type | extensible | Pattern: 110153 | ||||
| AuditEvent.agent:client.role | example | SecurityRoleType | ||||
| AuditEvent.agent:client.network.type | required | AuditEventAgentNetworkType | ||||
| AuditEvent.agent:client.purposeOfUse | extensible | PurposeOfUse | ||||
| AuditEvent.agent:server.type | extensible | Pattern: 110152 | ||||
| AuditEvent.agent:server.role | example | SecurityRoleType | ||||
| AuditEvent.agent:server.network.type | required | AuditEventAgentNetworkType | ||||
| AuditEvent.agent:server.purposeOfUse | extensible | PurposeOfUse | ||||
| AuditEvent.agent:user.type | required | DataSources | ||||
| AuditEvent.agent:user.role | example | SecurityRoleType | ||||
| AuditEvent.agent:user.network.type | required | AuditEventAgentNetworkType | ||||
| AuditEvent.agent:user.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:transaction.what.type | extensible | ResourceType | ||||
| AuditEvent.entity:transaction.what.identifier.use | required | IdentifierUse | ||||
| AuditEvent.entity:transaction.what.identifier.type | extensible | Identifier Type Codes | ||||
| AuditEvent.entity:transaction.type | extensible | Pattern: XrequestId | ||||
| AuditEvent.entity:transaction.role | extensible | AuditEventEntityRole | ||||
| AuditEvent.entity:transaction.lifecycle | extensible | ObjectLifecycleEvents | ||||
| AuditEvent.entity:transaction.securityLabel | extensible | All Security Labels | ||||
| AuditEvent.entity:data.type | extensible | Pattern: 2 | ||||
| AuditEvent.entity:data.role | required | Pattern: 3("Report") | ||||
| AuditEvent.entity:data.lifecycle | extensible | ObjectLifecycleEvents | ||||
| AuditEvent.entity:data.securityLabel | extensible | All Security Labels |
| Id | Grade | Path(s) | Details | Requirements |
| val-audit-source | error | AuditEvent.agent:server | The Audit Source is this agent too. : $this.who = %resource.source.observer |
This structure is derived from Update
Other representations of profile: CSV, Excel, Schematron
IG © 2021+ IHE IT Infrastructure Technical Committee. Package ihe.iti.npfs#2.2.0 based on FHIR 4.0.1. Generated 2023-11-16
Links: Table of Contents |
QA Report
| New Issue | Issues
Version History |
|
Propose a change