ITI-18 - Registry Stored Query

The ITI-18 IHE transaction, which is used by the XDS.a and XDS.b Document Consumer IHE actors, XDS.a and XDS.b Document Registry IHE actors, and the XCA Initiating Gateway IHE actor can be audited by using an ATNAAudit node.

You can audit the ITI-18 IHE transaction by creating the following XML audit messages. Click on an XML audit message name in the list to see the schema you use to create the XML audit message that is sent to the ATNAAudit node.

AuditXDSConsumerRegistryStoredQueryEvent
AuditXDSRegistryStoredQueryEvent
AuditXCAInitiatingGatewayRegistryStoredQueryEvent
AuditXCARespondingGatewayRegistryStoredQueryEvent

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 this document repository Note: This is only required for auditing transactions used by the XCA Initiating Gateway actor.
RegistryEndpointURI	The endpoint of the registry in this transaction. Note: This is not required for auditing transactions used by the XCA Initiating Gateway 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.a and XDS.b Document Registry actors.
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.a and XDS.b Document Registry actors.
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.a and XDS.b Document Registry actors.
StoredQueryUUID	The UUID of the stored query.
AdhocQueryRequestPayload	The payload of the ad-hoc query request element.
HomeCommunityID	The home community ID of the transaction (if present).
PatientID	The patient ID queried (if query pertained to a specific patient).

The following sections list the schemas you use to create the XML messages that are sent to the ATNAAudit node.

AuditXDSConsumerRegistryStoredQueryEvent

Audits an ITI-18 Registry Stored Query event for XDS.a and XDS.b Document Consumer 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="AuditXDSConsumerRegistryStoredQueryEvent" type="AuditXDSConsumerRegistryStoredQueryEvent"/>
    <xsd:complexType name="AuditXDSConsumerRegistryStoredQueryEvent">
        <xsd:annotation>
            <xsd:documentation xml:lang="en">Audits an ITI-18 Registry Stored Query event for XDS.a and XDS.b Document Consumer actors</xsd:documentation>
        </xsd:annotation>
        <xsd:sequence>
            <xsd:element name="EventOutcome" type="xsd:string"/>
            <xsd:element name="RegistryEndpointURI" type="xsd:string"/>
            <xsd:element name="StoredQueryUUID" type="xsd:string"/>
            <xsd:element name="AdhocQueryRequestPayload" type="xsd:string"/>
            <xsd:element name="HomeCommunityID" type="xsd:string"/>
            <xsd:element name="PatientID" type="xsd:string"/>
        </xsd:sequence>
    </xsd:complexType>
</xsd:schema>

For details of the values you need to enter for each element, see Element Descriptions.

AuditXDSRegistryStoredQueryEvent

Audits an ITI-18 Registry Stored Query event for XDS.a and XDS.b Document Registry 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="AuditXDSRegistryStoredQueryEvent" type="AuditXDSRegistryStoredQueryEvent"/>
    <xsd:complexType name="AuditXDSRegistryStoredQueryEvent">
        <xsd:annotation>
            <xsd:documentation xml:lang="en">Audits an ITI-18 Registry Stored Query event for XDS.a and XDS.b Document Registry actors</xsd:documentation>
        </xsd:annotation>
        <xsd:sequence>
            <xsd:element name="EventOutcome" type="xsd:string"/>
            <xsd:element name="RegistryEndpointURI" 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="StoredQueryUUID" type="xsd:string"/>
            <xsd:element name="AdhocQueryRequestPayload" type="xsd:string"/>
            <xsd:element name="HomeCommunityID" type="xsd:string"/>
            <xsd:element name="PatientID" type="xsd:string"/>
        </xsd:sequence>
    </xsd:complexType>
</xsd:schema>

For details of the values you need to enter for each element, see Element Descriptions.

AuditXCAInitiatingGatewayRegistryStoredQueryEvent

Audits an ITI-18 Registry Stored Query 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="AuditXCAInitiatingGatewayRegistryStoredQueryEvent" type="AuditXCAInitiatingGatewayRegistryStoredQueryEvent"/>
    <xsd:complexType name="AuditXCAInitiatingGatewayRegistryStoredQueryEvent">
        <xsd:annotation>
            <xsd:documentation xml:lang="en">Audits an ITI-18 Registry Stored Query 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="StoredQueryUUID" type="xsd:string"/>
            <xsd:element name="AdhocQueryRequestPayload" type="xsd:string"/>
            <xsd:element name="HomeCommunityID" type="xsd:string"/>
            <xsd:element name="PatientID" type="xsd:string"/>
        </xsd:sequence>
    </xsd:complexType>
</xsd:schema>

For details of the values you need to enter for each element, see Element Descriptions.

AuditXCARespondingGatewayRegistryStoredQueryEvent

Audits an ITI-18 Registry Stored Query 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="AuditXCARespondingGatewayRegistryStoredQueryEvent" type="AuditXCARespondingGatewayRegistryStoredQueryEvent"/>
    <xsd:complexType name="AuditXCARespondingGatewayRegistryStoredQueryEvent">
        <xsd:annotation>
            <xsd:documentation xml:lang="en">Audits an ITI-18 Registry Stored Query event for XCA Responding Gateway actors</xsd:documentation>
        </xsd:annotation>
        <xsd:sequence>
            <xsd:element name="EventOutcome" type="xsd:string"/>
            <xsd:element name="RegistryEndpointURI" type="xsd:string"/>
            <xsd:element name="StoredQueryUUID" type="xsd:string"/>
            <xsd:element name="AdhocQueryRequestPayload" type="xsd:string"/>
            <xsd:element name="HomeCommunityID" type="xsd:string"/>
            <xsd:element name="PatientID" type="xsd:string"/>
        </xsd:sequence>
    </xsd:complexType>
</xsd:schema>

For details of the values you need to enter for each element, see Element Descriptions.

Last updated : 2015-12-07 16:17:41

Reference topic | Version 3.0.0.1 | ha05230-18