ITI-43 - Retrieve Document Set
The ITI-43 IHE transaction, which is used by the XDS.b Document Consumer, XDS.b Document Repository, and XCA Initiating Gateway IHE actors, can be audited by using an ATNAAudit node.
- AuditXDSConsumerRetrieveDocumentSetEventMultipleDocumentIDs
- AuditXDSConsumerRetrieveDocumentSetEventMultipleRepositoryIDs
- AuditXDSConsumerRetrieveDocumentSetEventMultipleCommunityIDs
- AuditXDSRepositoryRetrieveDocumentSetEventMultipleDocumentIDs
- AuditXDSRepositoryRetrieveDocumentSetEventMultipleRepositoryIDs
- AuditXDSRepositoryRetrieveDocumentSetEventMultipleCommunityIDs
- AuditXCAInitiatingGatewayRetrieveDocumentSetEvent
- AuditXCARespondingGatewayRetrieveDocumentSetEvent
Element Descriptions
The following table describes the value that needs to be assigned to each element in the message.
Element | Description |
---|---|
EventOutcome | The event outcome indicator. |
RepositoryEndpointURI | The web service endpoint URI for the document repository. |
PatientID | The patient ID to which the document or documents
relate (if known) Note: This is only required for auditing transactions
used by the XDS.b Document Consumer actor.
|
ConsumerUserID | The "Active Participant" user ID for the document
consumer (if using WS-Addressing). Note: This is only required for
auditing transactions used by the XDS.b Document Repository actor
and the XCA Initiating Gateway actor.
|
ConsumerUserName | The "Active Participant" user name for the document
consumer (if using WS-Security or XUA). Note: This is only required
for auditing transactions used by the XDS.b Document Repository actor
and the XCA Initiating Gateway actor.
|
ConsumerIPAddress | The IP address or DNS name of the document consumer
that initiated the transaction. Note: This is only required for auditing
transactions used by the XDS.b Document Repository actor and the XCA
Initiating Gateway actor.
|
DocumentUniqueIDs | The list of document unique IDs for the document or documents retrieved. |
RepositoryUniqueID | The XDS.b repository unique ID value for the
repository. Note: This is only required for the following audit messages
(where there is exactly one repository specified in the transaction).
|
RepisitoryUniqueIDs | The list of XDS.b repository unique IDs involved
in this transaction (aligned with DocumentUniqueIDs). Note: This is
only required for the following audit messages (where there is more
than one repository specified in the transaction).
|
HomeCommunityID | The XCA home community ID used in the transaction. Note: This
is only required for the following audit messages (where there is
zero or one community specified in the transaction).
|
HomeCommunityIDs | The list of XCA home community IDs involved
in this transaction (aligned with DocumentUniqueIDs) Note: This is
only required for the following audit messages (where there is more
than one community specified in the transaction).
|
The following sections list the schemas you use to create the XML messages that are sent to the ATNAAudit node.
AuditXDSConsumerRetrieveDocumentSetEventMultipleDocumentIDs
Audits an ITI-43 Retrieve Document Set event for XDS.b Document Consumer actors - sends audit messages for situations when exactly one repository and zero or one community are specified in the transaction.
<?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:include schemaLocation="ATNATypes.xsd"/>
<xsd:element name="AuditXDSConsumerRetrieveDocumentSetEventMultipleDocumentIDs" type="AuditXDSConsumerRetrieveDocumentSetEventMultipleDocumentIDs"/>
<xsd:complexType name="AuditXDSConsumerRetrieveDocumentSetEventMultipleDocumentIDs">
<xsd:annotation>
<xsd:documentation xml:lang="en">Audits an ITI-43 Retrieve Document Set event for XDS.b Document Consumer actors - sends audit
messages for situations when exactly one repository and zero or one community are specified in the transaction</xsd:documentation>
</xsd:annotation>
<xsd:sequence>
<xsd:element name="EventOutcome" type="xsd:string"/>
<xsd:element name="RepositoryEndpointURI" type="xsd:string"/>
<xsd:element name="RepositoryUniqueID" type="xsd:string"/>
<xsd:element name="HomeCommunityID" type="xsd:string"/>
<xsd:element name="PatientID" type="xsd:string"/>
<xsd:element name="DocumentUniqueIDs" type="DocumentUniqueIDs"/>
</xsd:sequence>
</xsd:complexType>
</xsd:schema>
For details of the values you need to enter for each element, see Element Descriptions.
For the definition of the DocumentUniqueIDs type, see Common types that are used by XML message schemas.
AuditXDSConsumerRetrieveDocumentSetEventMultipleRepositoryIDs
Audits an ITI-43 Retrieve Document Set event for XDS.b Document Consumer actors - sends audit messages for situations when more than one repository and zero or one community are specified in the transaction.
<?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:include schemaLocation="ATNATypes.xsd"/>
<xsd:element name="AuditXDSConsumerRetrieveDocumentSetEventMultipleRepositoryIDs" type="AuditXDSConsumerRetrieveDocumentSetEventMultipleRepositoryIDs"/>
<xsd:complexType name="AuditXDSConsumerRetrieveDocumentSetEventMultipleRepositoryIDs">
<xsd:annotation>
<xsd:documentation xml:lang="en">Audits an ITI-43 Retrieve Document Set event for XDS.b Document Consumer actors - sends audit
messages for situations when more than one repository and zero or one community are specified in the transaction</xsd:documentation>
</xsd:annotation>
<xsd:sequence>
<xsd:element name="EventOutcome" type="xsd:string"/>
<xsd:element name="RepositoryEndpointURI" type="xsd:string"/>
<xsd:element name="HomeCommunityID" type="xsd:string"/>
<xsd:element name="PatientID" type="xsd:string"/>
<xsd:element name="DocumentUniqueIDs" type="DocumentUniqueIDs"/>
<xsd:element name="RepositoryUniqueIDs" type="RepositoryUniqueIDs"/>
</xsd:sequence>
</xsd:complexType>
</xsd:schema>
For details of the values you need to enter for each element, see Element Descriptions.
For the definition of the DocumentUniqueIDs and RepositoryUniqueIDs types, see Common types that are used by XML message schemas.
AuditXDSConsumerRetrieveDocumentSetEventMultipleCommunityIDs
Audits an ITI-43 Retrieve Document Set event for XDS.b Document Consumer actors - sends audit messages for situations when more than one repository and more than one community are specified in the transaction.
<?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:include schemaLocation="ATNATypes.xsd"/>
<xsd:element name="AuditXDSConsumerRetrieveDocumentSetEventMultipleCommunityIDs" type="AuditXDSConsumerRetrieveDocumentSetEventMultipleCommunityIDs"/>
<xsd:complexType name="AuditXDSConsumerRetrieveDocumentSetEventMultipleCommunityIDs">
<xsd:annotation>
<xsd:documentation xml:lang="en">Audits an ITI-43 Retrieve Document Set event for XDS.b Document Consumer actors - sends audit
messages for situations when more than one repository and more than one community are specified in the transaction</xsd:documentation>
</xsd:annotation>
<xsd:sequence>
<xsd:element name="EventOutcome" type="xsd:string"/>
<xsd:element name="RepositoryEndpointURI" type="xsd:string"/>
<xsd:element name="PatientID" type="xsd:string"/>
<xsd:element name="DocumentUniqueIDs" type="DocumentUniqueIDs"/>
<xsd:element name="RepositoryUniqueIDs" type="RepositoryUniqueIDs"/>
<xsd:element name="HomeCommunityIDs" type="HomeCommunityIDs"/>
</xsd:sequence>
</xsd:complexType>
</xsd:schema>
For details of the values you need to enter for each element, see Element Descriptions.
For the definition of the DocumentUniqueIDs, RepositoryUniqueIDs and HomeCommunityIDs types, see Common types that are used by XML message schemas.
AuditXDSRepositoryRetrieveDocumentSetEventMultipleDocumentIDs
Audits an ITI-43 Retrieve Document Set-b event for XDS.b Document Repository actors - sends audit messages for situations when exactly one repository and zero or one community are specified in the transaction.
<?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:include schemaLocation="ATNATypes.xsd"/>
<xsd:element name="AuditXDSRepositoryRetrieveDocumentSetEventMultipleDocumentIDs" type="AuditXDSRepositoryRetrieveDocumentSetEventMultipleDocumentIDs"/>
<xsd:complexType name="AuditXDSRepositoryRetrieveDocumentSetEventMultipleDocumentIDs">
<xsd:annotation>
<xsd:documentation xml:lang="en">Audits an ITI-43 Retrieve Document Set-b event for XDS.b Document Repository actors - sends audit
messages for situations when exactly one repository and zero or one community are specified in the transaction</xsd:documentation>
</xsd:annotation>
<xsd:sequence>
<xsd:element name="EventOutcome" type="xsd:string"/>
<xsd:element name="RepositoryEndpointURI" type="xsd:string"/>
<xsd:element name="ConsumerUserID" type="xsd:string"/>
<xsd:element name="ConsumerUserName" type="xsd:string"/>
<xsd:element name="ConsumerIPAddress" type="xsd:string"/>
<xsd:element name="RepositoryUniqueID" type="xsd:string"/>
<xsd:element name="HomeCommunityID" type="xsd:string"/>
<xsd:element name="DocumentUniqueIDs" type="DocumentUniqueIDs"/>
</xsd:sequence>
</xsd:complexType>
</xsd:schema>
For details of the values you need to enter for each element, see Element Descriptions.
For the definition of the DocumentUniqueIDs type, see Common types that are used by XML message schemas.
AuditXDSRepositoryRetrieveDocumentSetEventMultipleRepositoryIDs
Audits an ITI-43 Retrieve Document Set-b event for XDS.b Document Repository actors - sends audit messages for situations when more than one repository and zero or one community are specified in the transaction.
<?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:include schemaLocation="ATNATypes.xsd"/>
<xsd:element name="AuditXDSRepositoryRetrieveDocumentSetEventMultipleRepositoryIDs" type="AuditXDSRepositoryRetrieveDocumentSetEventMultipleRepositoryIDs"/>
<xsd:complexType name="AuditXDSRepositoryRetrieveDocumentSetEventMultipleRepositoryIDs">
<xsd:annotation>
<xsd:documentation xml:lang="en">Audits an ITI-43 Retrieve Document Set-b event for XDS.b Document Repository actors - sends audit
messages for situations when more than one repository and zero or one community are specified in the transaction</xsd:documentation>
</xsd:annotation>
<xsd:sequence>
<xsd:element name="EventOutcome" type="xsd:string"/>
<xsd:element name="RepositoryEndpointURI" type="xsd:string"/>
<xsd:element name="ConsumerUserID" type="xsd:string"/>
<xsd:element name="ConsumerUserName" type="xsd:string"/>
<xsd:element name="ConsumerIPAddress" type="xsd:string"/>
<xsd:element name="HomeCommunityID" type="xsd:string"/>
<xsd:element name="DocumentUniqueIDs" type="DocumentUniqueIDs"/>
<xsd:element name="RepositoryUniqueIDs" type="RepositoryUniqueIDs"/>
</xsd:sequence>
</xsd:complexType>
</xsd:schema>
For details of the values you need to enter for each element, see Element Descriptions.
For the definition of the DocumentUniqueIDs and RepositoryUniqueIDs types, see Common types that are used by XML message schemas.
AuditXDSRepositoryRetrieveDocumentSetEventMultipleCommunityIDs
Audits an ITI-43 Retrieve Document Set-b event for XDS.b Document Repository actors - sends audit messages for situations when more than one repository and more than one community are specified in the transaction.
<?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:include schemaLocation="ATNATypes.xsd"/>
<xsd:element name="AuditXDSRepositoryRetrieveDocumentSetEventMultipleCommunityIDs" type="AuditXDSRepositoryRetrieveDocumentSetEventMultipleCommunityIDs"/>
<xsd:complexType name="AuditXDSRepositoryRetrieveDocumentSetEventMultipleCommunityIDs">
<xsd:annotation>
<xsd:documentation xml:lang="en">Audits an ITI-43 Retrieve Document Set-b event for XDS.b Document Repository actors - sends audit
messages for situations when more than one repository and more than one community are specified in the transaction</xsd:documentation>
</xsd:annotation>
<xsd:sequence>
<xsd:element name="EventOutcome" type="xsd:string"/>
<xsd:element name="RepositoryEndpointURI" type="xsd:string"/>
<xsd:element name="ConsumerUserID" type="xsd:string"/>
<xsd:element name="ConsumerUserName" type="xsd:string"/>
<xsd:element name="ConsumerIPAddress" type="xsd:string"/>
<xsd:element name="DocumentUniqueIDs" type="DocumentUniqueIDs"/>
<xsd:element name="RepositoryUniqueIDs" type="RepositoryUniqueIDs"/>
<xsd:element name="HomeCommunityIDs" type="HomeCommunityIDs"/>
</xsd:sequence>
</xsd:complexType>
</xsd:schema>
For details of the values you need to enter for each element, see Element Descriptions.
For the definition of the DocumentUniqueIDs, RepositoryUniqueIDs and HomeCommunityIDs types, see Common types that are used by XML message schemas.
AuditXCAInitiatingGatewayRetrieveDocumentSetEvent
Audits an ITI-43 Retrieve Document Set-b event for XCA Initiating Gateway actors - audits as an XDS Document Registry.
<?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:include schemaLocation="ATNATypes.xsd"/>
<xsd:element name="AuditXCAInitiatingGatewayRetrieveDocumentSetEvent" type="AuditXCAInitiatingGatewayRetrieveDocumentSetEvent"/>
<xsd:complexType name="AuditXCAInitiatingGatewayRetrieveDocumentSetEvent">
<xsd:annotation>
<xsd:documentation xml:lang="en">Audits an ITI-43 Retrieve Document Set-b event for XCA Initiating Gateway actors - audits as an XDS Document Registry</xsd:documentation>
</xsd:annotation>
<xsd:sequence>
<xsd:element name="EventOutcome" type="xsd:string"/>
<xsd:element name="ConsumerUserID" type="xsd:string"/>
<xsd:element name="ConsumerUserName" type="xsd:string"/>
<xsd:element name="ConsumerIPAddress" type="xsd:string"/>
<xsd:element name="RepositoryEndpointURI" type="xsd:string"/>
<xsd:element name="DocumentUniqueIDs" type="DocumentUniqueIDs"/>
<xsd:element name="RepositoryUniqueIDs" type="RepositoryUniqueIDs"/>
<xsd:element name="HomeCommunityIDs" type="HomeCommunityIDs"/>
</xsd:sequence>
</xsd:complexType>
</xsd:schema>
For details of the values you need to enter for each element, see Element Descriptions.
For the definition of the DocumentUniqueIDs, RepositoryUniqueIDs and HomeCommunityIDs types, see Common types that are used by XML message schemas.
AuditXCARespondingGatewayRetrieveDocumentSetEvent
Audits an ITI-43 Retrieve Document Set event for XCA Responding Gateway actors.
<?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:include schemaLocation="ATNATypes.xsd"/>
<xsd:element name="AuditXCARespondingGatewayRetrieveDocumentSetEvent" type="AuditXCARespondingGatewayRetrieveDocumentSetEvent"/>
<xsd:complexType name="AuditXCARespondingGatewayRetrieveDocumentSetEvent">
<xsd:annotation>
<xsd:documentation xml:lang="en">Audits an ITI-43 Retrieve Document Set event for XCA Responding Gateway actors</xsd:documentation>
</xsd:annotation>
<xsd:sequence>
<xsd:element name="EventOutcome" type="xsd:string"/>
<xsd:element name="RepositoryEndpointURI" type="xsd:string"/>
<xsd:element name="HomeCommunityID" type="xsd:string"/>
<xsd:element name="DocumentUniqueIDs" type="DocumentUniqueIDs"/>
<xsd:element name="RepositoryUniqueIDs" type="RepositoryUniqueIDs"/>
</xsd:sequence>
</xsd:complexType>
</xsd:schema>
For details of the values you need to enter for each element, see Element Descriptions.
For the definition of the DocumentUniqueIDs and RepositoryUniqueIDs types, see Common types that are used by XML message schemas.