XML audit messages
The format of an XML audit message that is sent to the ATNAAudit nodes varies according to the IHE actor and transaction that are being audited.
XML message content
The following table details the XML audit messages that can be created and the associated IHE transactions that are audited. Click the XML audit message name to see the schema that you use to create the XML audit message that is sent to the ATNAAudit node, in order for the node to create a valid ATNA audit message. Many of the XML audit messages schemas have elements of a common, pre-defined type. See Common types that are used by XML message schemas for the definitions of these common, pre-defined types.Note: The XML audit
message schemas can be downloaded from the pattern resources for the Healthcare:
HL7 to HL7 or Healthcare:
HL7 to HL7 DFDL patterns.
Actor name | IHE transaction that is audited | XML audit message that is used to audit the transaction |
---|---|---|
PIX Manager | ITI-8 Patient Identity Feed (create) | AuditPIXManagerCreatePatientRecordEvent |
ITI-8 Patient Identity Feed (delete) | AuditPIXManagerDeletePatientRecordEvent | |
ITI-8 Patient identity Feed (update) | AuditPIXManagerUpdatePatientRecordEvent | |
ITI-9 PIX Query | AuditPIXManagerPIXQueryEvent | |
ITI-10 PIX Update Notification | AuditPIXManagerUpdateNotificationEvent | |
ITI-21 Patient Demographic Query | AuditPIXManagerPDQQueryEvent | |
ITI-22 Patient Demographic Query and Visit | AuditPIXManagerPDQQueryVisitEvent | |
PIX Consumer | ITI-9 PIX Query | AuditPIXConsumerQueryEvent |
ITI-10 PIX Update Notification | AuditPIXConsumerUpdateNotificationEvent | |
ITI-45 PIXV3 Query | AuditPIXConsumerQueryV3Event | |
ITI-46 PICV3 Update Notification | AuditPIXConsumerUpdateNotificationV3Event | |
PDQ Consumer | ITI-21 Patient Demographic Query | AuditPDQConsumerQueryEvent |
ITI-22 Patient Demographic Query and Visit | AuditPDQConsumerQueryVisitEvent | |
ITI-47 Patient Demographic Query HL7 V3 | AuditPDQConsumerQueryV3Event | |
PIX Source | ITI-8 Patient Identity Feed (create) | AuditPIXSourceCreatePatientRecordEvent |
ITI-8 Patient Identity Feed (delete) | AuditPIXSourceDeletePatientRecordEvent | |
ITI-8 Patient Identity Feed (update) | AuditPIXSourceUpdatePatientRecordEvent | |
ITI-44 Patient Identity Feed HL7V3 (create) | AuditPIXSouceCreatePatientRecordV3Event | |
ITI-44 Patient Identity Feed HL7V3 (delete) | AuditPIXSourceDeletePatientRecordV3Event | |
ITI-44 Patient Identity Feed HL7V3 (update) | AuditPIXSourceUpdatePatientRecordV3Event | |
XDS Consumer | ITI-16 Registry Query | AuditXDSConsumerRegistryQueryEvent |
ITI-17 Retrieve Document | AuditXDSConsumerRetrieveDocumentEvent | |
ITI-18 Registry Stored Query | AuditXDSConsumerRegistryStoredQueryEvent | |
ITI-43 Retrieve Document Set | AuditXDSConsumerRetrieveDocumentSetEventMultipleDocumentIDs | |
ITI-43 Retrieve Document Set (with multiple repositories) | AuditXDSConsumerRetrieveDocumentSetEventMultipleRepositoryIDs | |
ITI-43 Retrieve Document Set (with multiple communities) | AuditXDSConsumerRetrieveDocumentSetEventMultipleCommunityIDs | |
XDS Source | ITI-15 Provide and Register Document Set | AuditXDSSourceProvideAndRegisterDocumentSetEvent |
ITI-41 Provide and Register Document Set-b | AuditXDSSourceProvideAndRegisterDocumentSetBEvent | |
XDS Registry | ITI-14 Register Document Set | AuditXDSRegistryRegisterDocumentSetEvent |
ITI-16 Registry Query | AuditXDSRegistryQueryEvent | |
ITI-18 Stored Query | AuditXDSRegistryStoredQueryEvent | |
ITI-42 Register Document Set-b | AuditXDSRegistryRegisterDocumentSetBEvent | |
XDS Repository | ITI-14 Register Document Set | AuditXDSRepositoryRegisterDocumentSetEvent |
ITI-15 Provide and Register Document Set | AuditXDSRepositoryProvideAndRegisterDocumentSetEvent | |
ITI-17 Retrieve Document | AuditXDSRepositoryRetrieveDocumentEvent | |
ITI-41 Provide and Register Document Set-b | AuditXDSRepositoryProvideAndRegisterDocumentSetBEvent | |
ITI-42 Register Document Set-b | AuditXDSRepositoryRegisterDocumentSetBEvent | |
ITI-43 Retrieve Document Set | AuditXDSRepositoryRetrieveDocumentSetEventMultipleDocumentIDs | |
ITI-43 Retrieve Document Set (with multiple repositories) | AuditXDSRepositoryRetrieveDocumentSetEventMultipleRepositoryIDs | |
ITI-43 Retrieve Document Set (with multiple communities) | AuditXDSRepositoryRetrieveDocumentSetEventMultipleCommunityIDs | |
XCA Initiating Gateway | ITI-38 Cross Gateway Query | AuditXCAInitiatingGatewayCrossGatewayQueryEvent |
ITI-39 Cross Gateway Retrieve | AuditXCAInitiatingGatewayCrossGatewayRetrieveEvent | |
ITI-18 Registry Stored Query (as a document registry) | AuditXCAInitiatingGatewayRegistryStoredQueryEvent | |
ITI-43 Retrieve Document Set (as a document registry) | AuditXCAInitiatingGatewayRetrieveDocumentSetEvent | |
XCA Responding Gateway | ITI-38 Cross Gateway Query | AuditXCARespondingGatewayCrossGatewayQueryEvent |
ITI-39 Cross Gateway Retrieve | AuditXCAInitiatingGatewayCrossGatewayRetrieveEvent | |
ITI-18 Registry Stored Query (as a document consumer) | AuditXCARespondingGatewayRegistryStoredQueryEvent | |
ITI-43 Retrieve Document Set (as a document consumer) | AuditXCARespondingGatewayRetrieveDocumentSetEvent | |
PAM Source | ITI-30 Patient Identity Management (create) | AuditPAMSourceCreatePatientRecordEvent |
ITI-30 Patient Identity Management (delete) | AuditPAMSourceDeletePatientRecordEvent | |
ITI-30 Patient Identity Management (update) | AuditPAMSourceUpdatePatientRecordEvent | |
SVS Consumer | ITI-48 Retrieve Value Set | AuditSVSConsumerRetrieveValueSetEvent |
XDM Portable Media | ITI-32 Distribute Document Set (import) | AuditXDMPortableMediaImport |
ITI-32 Distribute Document Set (export) | AuditXDMPortableMediaExport |
Common types that are used by XML message schemas
The following schema lists the definitions of the common types that are used by many of the XML audit message schemas.
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<xsd:schema xmlns="http://com.ibm.healthcare/ATNA" xmlns:xsd="http://www.w3.org/2001/XMLSchema" attributeFormDefault="unqualified" elementFormDefault="unqualified" targetNamespace="http://com.ibm.healthcare/ATNA">
<xsd:complexType name="PatientIDs">
<xsd:annotation>
<xsd:documentation xml:lang="en">List of patient identifiers for PIX queries</xsd:documentation>
</xsd:annotation>
<xsd:sequence>
<xsd:element maxOccurs="unbounded" minOccurs="0" name="PatientID" type="xsd:string"/>
</xsd:sequence>
</xsd:complexType>
<xsd:complexType name="DocumentUniqueIDs">
<xsd:annotation>
<xsd:documentation xml:lang="en">List of document entry unique IDs for documents retrieved</xsd:documentation>
</xsd:annotation>
<xsd:sequence>
<xsd:element maxOccurs="unbounded" minOccurs="0" name="DocumentUniqueID" type="xsd:string"/>
</xsd:sequence>
</xsd:complexType>
<xsd:complexType name="RepositoryUniqueIDs">
<xsd:annotation>
<xsd:documentation xml:lang="en">List of XDS.b repository unique IDs involved in this transaction (aligned with document unique IDs)</xsd:documentation>
</xsd:annotation>
<xsd:sequence>
<xsd:element maxOccurs="unbounded" minOccurs="0" name="RepositoryUniqueID" type="xsd:string"/>
</xsd:sequence>
</xsd:complexType>
<xsd:complexType name="HomeCommunityIDs">
<xsd:annotation>
<xsd:documentation xml:lang="en">List of XCA home community IDs involved in this transaction (aligned with document unique IDs)</xsd:documentation>
</xsd:annotation>
<xsd:sequence>
<xsd:element maxOccurs="unbounded" minOccurs="0" name="HomeCommunityID" type="xsd:string"/>
</xsd:sequence>
</xsd:complexType>
</xsd:schema>