Integrating the Healthcare Enterprise (IHE) Accelerator Reference

Transcription

1 IBM Initiate Master Data Serice Integrating the Healthcare Enterprise (IHE) Accelerator Reference Version9Release7 SC

2

3 IBM Initiate Master Data Serice Integrating the Healthcare Enterprise (IHE) Accelerator Reference Version9Release7 SC

4 Note Before using this information and the product that it supports, read the information in Notices and trademarks on page 41. Copyright IBM Corporation 1995, US Goernment Users Restricted Rights Use, duplication or disclosure restricted by GSA ADP Schedule Contract with IBM Corp.

5 Contents Introduction to IHE Accelerator..... Chapter 1. IHE Oeriew XDS.b profile ATNA logging profile PIX profile PDQ profile Chapter 2. IHE Accelerator Project... 5 Prerequisites Project components Master Data Engine enironment and IBM Initiate Workbench project Viewing IHE Accelerator relationships in IBM Initiate Inspector Chapter 3. IBM Initiate IHE Web Serice 9 proxy.config.xml proxy.config.xsd IBM-Initiate-IHE.war Status page IHE web serice installation IHE web serice installation on Tomcat IHE web serice installation on IBM WebSphere 17 IHE web serice installation on Oracle WebLogic Serer Editing paths and ariables in your configuration files Enabling SSL for broker to hub communication 27 Enabling HTTP communication Enabling ATNA Logging Troubleshooting your IHE installation Chapter 4. Configuration Files XML and XPath Inbound broker configuration files Query broker configuration files ATNA logging configuration file Query error responses XDS stored query configuration Patient erification identifier Testing Legal Statement Notices and trademarks Index Contacting IBM Copyright IBM Corp. 1995, 2011 iii

6 i Integrating the Healthcare Enterprise (IHE) Accelerator Reference

7 Introduction to IHE Accelerator The IBM Initiate Integrating the Healthcare Enterprise (IHE) Accelerator Reference proides an oeriew of selected profiles established by Integrating the Healthcare Enterprise (IHE) for arious Connectathon eents and the solutions to meet the profiles using the Message Broker Suite. The content in this document is intended to proide the serices team with information that can assist in the implementation of healthcare-related projects. The IHE profile descriptions do not attempt to proide a full definition of the specifications, rather they offer a high-leel oeriew. Copyright IBM Corp. 1995, 2011

8 i Integrating the Healthcare Enterprise (IHE) Accelerator Reference

9 Chapter 1. IHE Oeriew XDS.b profile Through forums and eents, such as the Connectathon, Integrating the Healthcare Enterprise (IHE) defines a technical framework for implementing messaging standards. Connectathon eents encourage participants to deelop solutions and engage in rigorous testing to meet the technical requirements. IBM Initiate Integrating the Healthcare Enterprise (IHE) Accelerator Reference presents a high-leel oeriew of the IHE profiles and the transactions that were met using the IBM Initiate Master Data Serice and Message Broker Suite. Because IHE specifications are fluid, this document is not meant to describe the full specifications for the supported profiles. For detailed requirements, see the IHE IT Infrastructure (ITI) Technical Framework ( Cross Enterprise Document Sharing (XDS) registers and shares electronic health record documents between healthcare enterprises, ranging from physician offices to clinics to acute care in-patient facilities. XDS.b support permits healthcare organizations that belong to an XDS Affinity Domain to cooperate in sharing clinical records (documents). The 9.7 release supports XDS.b. XDS actors While the IBM Initiate Master Data Serice participates in only a portion of the XDS profile, the full profile requirement includes the following actors: Document Repository - is responsible for storing documents and assigning the Uniform Resource Identifier (URI), which is used by the consumer during requests. Document Registry - stores information about the documents. The IBM Initiate Master Data Serice Hub seres as a Document Registry. Document Source - is the creator and publisher of the document. Document Consumer - this is the source requesting the document from the repository. Patient Identity Source - is the proider of a unique patient identifier and maintains patient identity demographics. Integrated Document Source/Repository - combines the functions of a document source and document repository. XDS transactions The IHE Accelerator supports the following required IHE transactions: Registry stored query. Registry stored queries are predefined queries that return folders or documents, or both. Register document set.b. Using SOAP, this transaction moes document metadata from the document repository to the registry. Successful processing of the following transactions is optional; howeer, the IHE Accelerator supports these transactions. Copyright IBM Corp. 1995,

10 ATNA logging profile Multiple document submission - the document source includes multiple documents in a single submission set request. Document life cycle management - the source submits an addendum to another document existing in the registry and repository. It also submits a document transformation of another document existing in the registry and repository. Folder management - the source creates a folder and adds one or more documents to the folder. Consumer systems can then query the registry for the folder. XDS messages For a basic understanding of XDS messages, it is helpful to understand the metadata objects and the IDs contained within the messages. See the IHE standards and profiles at the IHE website for information about message format and content. XDS.b use case A doctor (general practitioner) wants to pull up records for a patient who recently isited the emergency room (ER) for a broken leg. An x-ray of the leg was taken when the patient was admitted to the ER. The ER stored the x-ray in their x-ray document repository. The doctor pulls up the patient record from the office system. Linked to the patient profile is the patient x-ray results. The doctor clicks on the link in the patient record. The office system is the registry. The registry determines where the x -rays are stored across the enterprise based on document location information stored as part of the patient profile. The doctor iews the x-rays, pulled from the correct enterprise repository. The doctor then ealuates the patient, makes notes about the isit, and dispenses additional medications and treatment recommendations. The records from the patient isits are later scanned. The new record is submitted to the local repository and registered with the patient profile in the document registry for future user iewing. The Audit Trail and Node Authentication (ATNA) profile assists the implementation of confidentiality policies through user authentication and tracking. The IHE Accelerator solution uses SSL to authenticate users. Audit logging can be used to produce ATNA logs for the following actions. ATNA messages are written to the IBM-Initiate-IHE-ATNA.log file. RegisterDocument-b RegistryStoredQuery PRPA_IN201301UV02 - Patient Registry Record Added PRPA_IN201302UV02 - Patient Registry Record Reised PRPA_IN201304UV02 - Patient Registry Record Merged PRPA_IN201305UV02 - Patient Registry Find Candidates Query PRPA_IN201309UV02 - Patient Registry Get Identifiers Query Note: Specifications for HL73 ATNA logging were unaailable at the time this document was published, howeer ATNA logging for RegisterDocument-b and RegistryStoredQuery are fully implemented in the IBM Initiate Integrating the Healthcare (IHE) Accelerator project. 2 Integrating the Healthcare Enterprise (IHE) Accelerator Reference

11 PIX profile PIX (Patient Identifier Cross-reference) profile supports the cross-referencing of patient identifiers from multiple Patient Identifier Domains (for example, hospitals, clinics, and physician offices). These cross-referenced patient identifiers are used by identity consumer systems to relate patient information from sources that know a gien patient by different identifiers. PIX actors While the IBM Initiate Master Data Serice participates in only a portion of the PIX profile, the full profile requirement includes the following actors: Patient Identity Source - A single source system responsible for assigning the unique Patient Identifier. Patient Identifier Cross-reference Consumer - A consuming system that requests information about a patient. Patient Identifier Cross-reference Manager - A system responsible for creating, maintaining, and proiding lists of identifiers. PIX transactions Successful completion of the following transactions is required for IHE-compliance. Patient Identity Feed - Is used by a Patient Identity Source actor to notify a Patient Identity Cross-Referencing actor of all eents related to patient identification (creation, update, merge, and other eents). A Patient Identity Feed triggers on Admit/Register or Update messages. PIX Query - Is used by a Patient Identity Consumer to find out the identification of a patient in different Patient Identification Domains. The serices of a Patient Identity Cross-reference Manager actor are used. PIX Update Notification - Is used by a Patient Identity Cross-reference Manager to notify a Patient Identity Consumer of patient identification changes. The Document Registry does not participate in PIX Update Notifications. PDQ profile PDQ (Patient Demographics Query) profile supports queries for a lists of patients (based on user-defined search criteria) It also supports retrieal of patient demographic data into the consuming application. PDQ actors The Patient Demographics Supplier and the Patient Demographics Consumer are the two actors directly inoled with PDQ. Patient Demographics Supplier - supplies patient information to the requesting consumer. The IBM Initiate Master Data Serice acts as the supplier in this profile. Patient Demographics Consumer - is the requesting system. PDQ transactions The Patient Demographics Query transaction is required for both the Patient Demographics Supplier and Consumer. Patient Demographics and Visit Query is an optional transaction for both actors. Chapter 1. IHE Oeriew 3

12 The Patient Demographics Supplier receies patient registration and update messages from sources and responds with the required information. The Supplier receies either a Patient Demographics or Patient Demographics and Visit query from the Consumer, and returns the demographics from multiple or single domains. 4 Integrating the Healthcare Enterprise (IHE) Accelerator Reference

13 Chapter 2. IHE Accelerator Project Prerequisites The IHE Accelerator project proides a basic framework from which you can build an XDS.b registry deployment. An IBM Initiate Workbench project is included to assist in defining the basic objects in the registry, and the relationships between these objects. Initialization files for the IHE Web Serice Broker are also proided, and match the framework configuration. Additionally, IHE-configured Inbound Message Broker and Query Broker configuration files are proided. The IHE Accelerator solution supports: The subset of the XDS.b specification known as the document registry HL73 XML formatted messages SOAP 1.1 and 1.2 (synchronous communication) The IHE Accelerator project further supports two key features: 1) improed Broker search capabilities and 2) parent-child relationships. To meet the search requirements for XDS, three search filters are implemented in the brokers. Date range filter for documents, folders and submission sets based on a specified range of dates. This search works exactly like normal date range searches found in components like IBM Initiate Inspector. For example, request/return documents created (submitted) between June 12, 2009 and July 12, Deterministic filter that uses AND logic that returns documents, submission sets, and folders based on an exact specified search criteria. For example, request and return a specific document or folder. Wildcard character filter permits the use of certain characters to search for documents, submission sets, and folders. For example, request and return all documents matching E* Jones. The search parameters used for documents, folders or submission sets is controlled by the IHE specification. Taking adantage of the relationship logic in the Master Data Engine and the isual representation of these relationships in IBM Initiate Inspector is one unique feature of the IHE Accelerator. Patient records can be associated to documents and submission sets, documents associated to folders, and folders associated to submission sets. Relationships are built upon the Patient ID attribute of the document, folder, or submission set. The relationship rules are created when the Patient ID attribute matches an existing Patient MemIdnum. You must install and configure certain IBM Initiate Master Data Serice components in order to use the IHE Accelerator project. Begin by installing: Master Data Engine Copyright IBM Corp. 1995,

14 Message Broker Suite which includes the following: IHE Accelerator project - XDS Reference Web Serice Inbound broker Query broker IBM Initiate Workbench IBM Initiate Inspector (optional) See the following resources for information about installing and configuring the arious components: IBM Initiate Master Data Serice Engine Installation Guide Project components IBM Initiate Master Data Serice Message Broker Suite Reference (for information about installing the brokers and standard configuration file details) HL7 Query Adapter Reference (for information about query instance creation and configuration files) IBM Initiate Workbench User's Guide (includes IBM Initiate Inspector configuration information) IBM Initiate Workbench Installation Guide IBM Initiate Inspector Installation and Configuration Guide Components of the IBMInitiate IHE Accelerator project include the pre-configured hub, web serice files, and Message Broker Suite configuration files. The IBM Initiate Workbench project (pre-configured hub) file is called the xdsreference.zip and is located in your broker installation directory, for example, install_dir/ibm/initiate/brokers9.x.x/config/xdsreference Web serices files are located in the /proxy directory within your broker installation directory, for example, install_dir/ibm/initiate/brokers9.x.x/ proxy. Chapter 3, IBM Initiate IHE Web Serice, on page 9 Broker configuration files are located in the /config/ihe directory within your broker installation directory, for example, install_dir/ibm/initiate/ Brokers9.x.x/config/IHE. Master Data Engine enironment and IBM Initiate Workbench project Since eery implementation is different, you can customize the framework proided by the IBM Initiate Workbench project to use additional attributes, member types, or relationships as needed. The four objects included in the IHE Accelerator are; Person, Submission Set, Folder, and Document. Each of these objects has been defined with the minimum attributes necessary to support an XDS.b registry. The XDS-only member types hae been configured with a minimal algorithm, from which the system can process keyed searches against these objects in support of XDS.b required functions. The Person object has a more traditional comparison algorithm that can be used to not only search the registry for XDS queries, but proide EMPI capabilities beyond standard XDS functions. The patient ID is the key into the XDS.b objects. All metadata objects (folders, documents, and subsets) hae patient IDs associated to them. 6 Integrating the Healthcare Enterprise (IHE) Accelerator Reference

15 The IHE Accelerator includes a set of relationship rules and IBM Initiate Inspector configuration (inspector.arm) for all of the registry objects. This information can be used to query and iew the registry contents through IBM Initiate Inspector if you want. The project includes: Member type/entity types Assoc/Assoc (Associations) Person/id Document/doc Folder/Folder Subset/Subset (submission set) Relationship types: FOLDERTODOC (folder-to-document) PATTODOC (patient-to-document) PATTOSUB (patient-to-submission set) SUBTODOC (submission set-to-document) SUBTOFOLDER (submission set-to-folder) In IBM Initiate Inspector, these relationships are represented as: - Has Documents (folder-to-document and patient-to-document) - Has Submissions (patient-to-submission set) - Has Folders (submission set-to-folder) Attribute types: In addition to some of the standard attribute types, are the following types. These attribute types hae associated implementation-defined segments). ASSOCIATION (defines document associations) EXTERNALID (defines external object IDs) MEMAUTHOR (originating author of document, folder or submission set contents) NODECLASS (defines the document classification object [metadata]) OBJECTCLASS (defines the object - document, folder, and other objects) XDSFILTER (used to define the search filters) Accessing the IHE Accelerator project You can access the IBM Initiate IHE Accelerator project in IBM Initiate Workbench. Procedure 1. Extract the xds_reference.zip file to your xdsreference directory. 2. From the Naigator iew in IBM Initiate Workbench, right click and select Import. Browse to the xdsreference directory and select the xds.imm file. See IBM Initiate Workbench User's Guide for additional details. Viewing IHE Accelerator relationships in IBM Initiate Inspector The relationships between a patient and associated documents, folders, and submission sets can be iewed in IBM Initiate Inspector. About this task Use this procedure to iew XDS relationships. See IBM Initiate Inspector User's Guide for detailed instructions. Chapter 2. IHE Accelerator Project 7

16 Procedure 1. Search for a member, typically by patient ID or name. 2. Select the preferred record from the returned results. 3. Click the Relationship tab. 8 Integrating the Healthcare Enterprise (IHE) Accelerator Reference

17 Chapter 3. IBM Initiate IHE Web Serice The design of the IHE web serice is unique in that it does not require specific broker instances. Preiously, the web-enabled broker used socket connections to connect the web serer to the broker, at which turn the broker opened MPINET connections with the hub. This method meant that each broker was installed as a separate serice and each serice required multiple connections with the hub. Through the implementation of Jaa Natie Interface (JNI), the need for brokers as separately installed serices/daemons is eliminated (with exception of the ATNA logger that is still installed as a serice). Running the brokers with the IHE web serice means that when you install the brokers with the intent of creating an XDS registry, you do not hae to create broker instances. With this configuration the brokers, libraries, and associated Engine libraries are packaged such that a single, direct line of communication is created between the hub and IHE web serice. proxy.config.xml The IHE web serice uses three main files to manage processing: proxy.config.xml, proxy.config.xsd and IBM-Initiate-IHE.war. These files are located in your broker installation path /proxy directory. Another added feature of the IHE web serice is the status page, which is used to monitor message processing. Currently, the web serice is only supported on Tomcat. See IBM Initiate Master Data Serice System Requirements for details on supported Tomcat ersions. The proxy.config.xml file controls the web serice and enironment configuration, and proides processing directies for using broker function to complete IHE transactions. Users familiar with the serices.ini file will recognize the ariables contained in the first part of the file. Copyright IBM Corp. 1995,

18 When you first open the proxy.config.xml file, you see a number of REPLACE_ME_WITH... entries. Each of these entries must be updated with the specifics of your installation. The examples here show an edited file. The easiest way to handle this edit is to do a search for REPLACE_ME_WITH. Enironment ariable use, such as ${MAD_ROOTDIR}, is not supported inside of configuration files running under web serices. You must enter the full path. Important: Regardless of the operating system on which you are installing, the proxy.config.xml file only accepts forward slashes (/). For example, if you are installing on a Microsoft Windows platform your home directory path might be D:\Program Files\IBM\Initiate\brokerx.x.x. Howeer, it must be entered as D:Program Files/IBM/Initiate/brokerx.x.x in the proxy.config.xml file. <proxy.config xmlns:xsi=" xsi:nonamespaceschemalocation="proxy.config.xsd"> <global.config mad.log_dir="" mad.log_name="d:/ibm/initiate/brokers/log/proxy_log.mlg" mad.root_dir="d:/ibm/initiate/brokers/win32-debug" mad.home_dir="d:/ibm/initiate/brokers/win32-debug" mad.broker_dir="d:/ibm/initiate/brokers/win32-debug" mad.so_timeout="30" mad.conn.str="localhost 16000" mad.login="system" mad.password="system" mad.password.scheme="plain" mad.dtd.dir="d:/ibm/initiate/brokers/dtd" ihe.home.community.id="ihe:homecommunityid" > In this example, the ihe.home.community.id="ihe:homecommunityid" attribute is used in ATNA logging. The second part of the file, the body, is where the actual transactions (serices) are defined. There are two types of serices: IHE serices and generic serices. The IHE handler.config portion of the body contains the name of the serice (for example, "XDS_b_DocumentRegistry" or "PIX Manager") and the serice action (for example, RegisterDocumentSet-b", RegistryStored Query or PRPA_IN201301UV02 ). The serice name identifies an associated IHE web serice (which contains a grouping of IHE actions or profiles). The action name or element is the action (profile) to be performed, followed by the type of broker (for example, broker.inbound or broker.query) that processes the profile. The associated configuration file (for example, RegisterDocumentSetB.ini) used for the action is also identified. The broker.inbound processes requests to register or record information in the document registry. The broker.query processes serice requests for information from the registry. All supported IHE profiles are automatically listed in the proxy.config.xml file. The profiles defined are XDS.b Document Registry, PIX Manager, and PDQ Supplier. Unless you hae a reason to deiate from the IHE standards, you not hae to edit this section. The next example shows an optional attribute that can be added to the handler.config sections to turn on ATNA logging: atnalogger=" :8087". 10 Integrating the Healthcare Enterprise (IHE) Accelerator Reference

19 <handler.config sericename="xds_b_documentregistry" atnalogger=" :8087"> <action actionname="registerdocumentset-b"> <broker.inbound> <config.file.request>d:/ibm/initiate/brokers/config/ihe/msgbr oker/registerdocumentsetb.ini</config.file.request> <config.file.reject.response>d:/ibm/initiate/brokers/config/i HE/msgBroker/MsgReaderFailureXDS.ini</config.file.reject.response> <config.file.success.response>d:/ibm/initiate/brokers/config/ IHE/msgBroker/MsgReaderSuccessXDS.ini</config.file.success.respons e> <config.file.path>d:/ibm/initiate/brokers/config/ihe/msgbroke r</config.file.path> <queue.dir>d:/ibm/initiate/brokers/inbound</queue.dir> <queue.success.name>success</queue.success.name> <queue.reject.name>reject</queue.reject.name> <attribute.update.queue.dir></attribute.update.queue.dir> <attribute.update.queue.name></attribute.update.queue.name> <attribute.update.filter></attribute.update.filter> <attribute.update></attribute.update> <manage.duplicates></manage.duplicates> <application.name></application.name> <parser.handler.lib>parser_xds.dll</parser.handler.lib> </broker.inbound> <message.type.xml> <xml.doc.handler.lib>document_handler_xds.dll</xml.doc.handler. lib> <xml.doc.name></xml.doc.name> <xml.doc.public.id></xml.doc.public.id> <xml.doc.system.id></xml.doc.system.id> <message.type.xml> </action> <action actionname="registrystoredquery"> <broker.query> <config.file>d:/ibm/initiate/brokers/config/ihe/querybroke r/registrystoredquery.ini</config.file> <config.file.path>d:/ibm/initiate/brokers/config/ihe/query Broker</config.file.path> <queue.dir>d:/ibm/initiate/brokers/query</queue.dir> <queue.request.name>req</queue.request.name> <queue.response.name>resp</queue.response.name> </broker.query> </action> In the example aboe, the parser.handler.lib is operating-system-specific. This example shows a Microsoft Windows library extension of.dll (parser_xds.dll). Other operating system (OS) libraries hae the OS-specific extension and follow the conention set by all of our natie libraries. The libraries are named in the lib folder of the proxy installation directory. Following the IHE-specific actions, there is a section for generic broker serices that is used for custom serices and actions. Serices can be define to process the addition of patient records to the Hub using XML, delimited, fixed-length, or HL72 messages. The message type is defined by the <message.type.*> tag (for example, <message.type.xml>). The next example shows the XML message configuration portion. Chapter 3. IBM Initiate IHE Web Serice 11

20 <!--handler.config.generic sericename="genericbrokerserice"> <action rootelement="xmlwrapped"> <broker.inbound> <config.file.request>d:/ibm/initiate/brokers/config/ihe/ms gbroker/cust_addpatient.ini</config.file.request> <config.file.reject.response>d:/ibm/initiate/brokers/confi g/msgbroker/msgreaderfailurexml.ini</config.file.reject.respons e> <config.file.success.response>d:/ibm/initiate/brokers/conf ig/msgbroker/msgreadersuccessxml.ini</config.file.success.respo nse> <config.file.path>d:/ibm/initiate/brokers/config/ihe/msgbr oker</config.file.path> <queue.dir>d:/ibm/initiate/brokers/inbound</queue.dir> <queue.success.name>success</queue.success.name> <queue.reject.name>reject</queue.reject.name> <attribute.update.filter></attribute.update.filter> <manage.duplicates></manage.duplicates> <application.name></application.name> <manage.attribute.update></manage.attribute.update> <attribute.update.queue.dir></attribute.update.queue.dir> <attribute.update.queue.name></attribute.update.queue.name> </broker.inbound> <message.type.xml> <xml.doc.handler.lib></xml.doc.handler.lib> <xml.doc.name></xml.doc.name> <xml.doc.public.id></xml.doc.public.id> <xml.doc.system.id></xml.doc.system.id> </message.type.xml> </action> proxy.config.xsd IBM-Initiate-IHE.war The proxy.config.xsd file is an XML schema that is used to help alidate the XML element alues before starting the web serice. The.xsd file defines (goerns) the proxy.config.xml file and not be augmented. If you must change the proxy.config.xml file (for example, deiate from the IHE standards), contact IBM Software Support. The IBM-Initiate-IHE.war file is a jar used to distribute the collection of files and libraries that make up the web application. Deployment of the war file is further discussed in the web serice installation topics. Status page The web serice status page proides a static iew of the web serice actions, such as RegisterDocumentSet-b, that are being run. The Total column represents the total number of messages processed for this action. The min and max fields show the minimum and maximum amount of time (in milliseconds) it takes to process each message. If the message cannot be processed because of an error condition, the number of errors is shown. 12 Integrating the Healthcare Enterprise (IHE) Accelerator Reference

21 IHE web serice installation The first message to run, per action, has a maximum time of 0. This number is due to the spin-up of serices that take place for the initial request. The minimum time for the first message is the actual time it took to process. The true reflections of min/max time per serice begin with the second message. Failure to process a message constitutes an error. For example, if a request comes in and the broker does not respond, that is considered an error. If a requested document or patient is not in the hub, that is not considered an error because the broker processed the request. An error count other than 0 indicates that there is a problem in either the broker.ini files or the web serice portion of the product. Consult the logs for information about the errors. The IHE web serice can be installed on Tomcat, IBM WebSphere, or Oracle WebLogic Serer. The web serices files are located in the proxy directory within your broker install directory (for example, C:/Program Files/IBM/Initiate/Brokers/proxy These instructions assume that you hae already installed the Message Broker Suite and deployed the IHE Accelerator project to a hub. IHE web serice installation on Tomcat Installing the IHE web serice on Tomcat is supported. Before beginning installation, there are some prerequisites that must be met. In these instructions, the following alues must be replaced with alues specific to your configuration. These settings can be added to the TOMCAT_HOME/bin/startup.*: TOMCAT_HOST is the serer name on which Tomcat is running TOMCAT_PORT is the port number used by TOMCAT TOMCAT_HOME is the directory in which TOMCAT is installed, also called CATALINA_HOME Verify that the following tasks hae been completed. You hae already installed the Message Broker Suite (see the IBM Initiate Master Data Serice Message Broker Suite Reference ) and deployed the XDS Reference.zip file (see Project components on page 6). You hae the JAVA_HOME path set in your system enironment ariables, for example: Variable = JAVA_HOME Value = C:/Program Files/Jaa/jre1.6.0_02 You hae installed Tomcat 6.0. Verify that the path to the Tomcat libraries is set in your system ariables. (You can also add the ariables directly in the Tomcat startup script (TOMCAT_HOME/bin/startup.*). On the Apache Tomcat Properties dialog, under the Jaa tab, erify that the Jaa library is set. For example: Jaa Virtual Machine: C:/Program Files/Jaa/jre1.6.0_02/bin/client/ jm.dll or C:/Program Files/Jaa/jre6/bin/serer/jm.dll Jaa Classpath: C:/Program Files/IBM/Initiate/Tomcat 6.0/bin/ bootstrap.jar Jaa Options: Chapter 3. IBM Initiate IHE Web Serice 13

22 -Dcatalina.home=TOMCAT_HOME/Tomcat 6.0 -Dcatalina.base=TOMCAT_HOME/Tomcat 6.0 -Djaa.endorsed.dirs=TOMCAT_HOME/Tomcat 6.0/endorsed -Djaa.io.tmpdir=TOMCAT_HOME/Tomcat 6.0/temp -Djaa.util.logging.manager=org.apache.juli.ClassLoaderLogManager -Djaa.util.logging.config.file=TOMCAT_HOME/Tomcat 6.0/conf/logging.properties -Djaa.library.path=TOMCAT_HOME/Tomcat 6.0/shared/lib You must reboot your system after adding any ariables. Storing the proxy.config.xml and shared libraries - Tomcat installation For IBM Initiate IHE web serice installation on Tomcat, the proxy.config.xml and shared libraries must be stored in the shared libraries path. Procedure 1. Shut down the Tomcat serer. 2. Install Tomcat. For Tomcat 6.x or later, modify the YOUR_TOMCAT_HOME/conf/ catalina.properties file so that the shared classloader mechanism works the same as Tomcat 5.x. Verify that the entry beginning with shared.loader= reads: shared.loader=${catalina.base}/shared/classes,${catalina.base}/shared/ lib/*.jar. 3. If it does not exist, create a shared/classes directory under the YOUR_TOMCAT_HOME directory. 4. Copy your proxy.config.xml and proxyconfig.xsd files file into YOUR_TOMCAT_HOME/shared/classes directory. 5. Copy the schemas folder from.../proxy to YOUR_TOMCAT_HOME/shared/classes. 6. All of the libraries in the proxy/lib folder must be copied to YOUR_TOMCAT_HOME/shared/lib. In order for the natie Tomcat library loader to see the shared libraries during run time, the YOUR_TOMCAT_HOME/shared/lib must be added to the jaa.library.path. Set an enironment ariable JAVA_OPT as such: JAVA_OPT=-Djaa.library.path=YOUR_TOMCAT_HOME/shared/lib 7. Depending upon your operating system, make sure that you add the following information: Microsoft Windows: The YOUR_TOMCAT_HOME/shared/lib; also must be added to the system's PATH. Linux or Solaris: Add the YOUR_TOMCAT_HOME/shared/lib to the enironment's LD_LIBRARY_PATH. AIX : Add the YOUR_TOMCAT_HOME/shared/lib to the enironment's LIBPATH. HP-UX: Add the YOUR_TOMCAT_HOME/shared/lib to the enironments SHLIB_PATH. 8. IBM AIX, Linux, Solaris, or HP-UX only, add these lines to the.bash_profile: export JAVA_OPTS=-Djaa.library.path=$CATALINA_HOME/shared/lib export CATALINA_OPTS="-Xms128m -Xmx1024m" Make sure that you do not include any statements related to MAD_DBTYPE or MAD_CTXLIB. Doing so results in a data source name not found error. 9. Due to the large memory footprint of the IHE schemas, the default memory limits in Tomcat are not sufficient. You should allow 1G for the Tomcat instance running this serice. This increase can be done by using the CATALINA_OPTS enironment ariable. For example: CATALINA_OPTS=-Xms128m -Xmx1024m instructs Tomcat to start the heap size at 128 megabytes and grow it to the maximum of 1 gigabyte. 14 Integrating the Healthcare Enterprise (IHE) Accelerator Reference

23 Installing the IHE web application on Tomcat After storing the proxy.config.xml and shared libraries, you can begin to install the IBM Initiate IHE web application on Tomcat. Procedure 1. Restart Tomcat. 2. In a web browser, enter You should see the The Apache Jakarta Project" page with links for Tomcat Administration and Tomcat Manager. 3. Click the link for the Tomcat Manager and log in with the name and password of a Tomcat administrator account. 4. In the Install section, click Browse in the WAR file to deploy area and go to the IBM-Initiate-IHE.war file. Click Deploy. Results The IBM Initiate IHE web application is deployed. When the Apache Jakarta Project page refreshes, you should see an IBM-Initiate-IHE row in the Applications section with a Display Name of IBM-Initiate-IHE. As an alternatie, Tomcat can be configured by default to auto-deploy any war file dropped into the YOUR_TOMCAT_HOME/webapps directory. Enabling XDS.b Serice on Tomcat The XDS.b serice is disabled by default when you install the IBM Initiate IHE web application. Use this procedure to enable the XDS.b serice on Tomcat. Procedure 1. After installing the IHE web application, shut down the Tomcat serer. 2. Extract the IBM-Initiate-IHE.aar file located in the expanded IHE web application serices directory. For example, TOMCAT_HOME/webapps/IBM- Initiate-IHE/WEB-INF/serices. 3. Open the serices.xml file located in the extracted /META-INF directory. Remoe the comments surrounding the XDS.b serice. 4. Compress the IBM-Initiate-IHE.aar file. 5. Go to the TOMCAT_HOME/shared/classes directory and open the proxy.config.xml file. Remoe the comment surrounding the XDS.b serice. 6. Restart the Tomcat serer. Updating an existing installation on Tomcat There are specific steps you must take to update an existing IBM Initiate IHE web serice installation on Tomcat. Updates are patch releases within a major ersion. For example, updating build to build , where 9.0 is the major ersion number. Procedure 1. Remoe the IHE web serice application from the Tomcat Manager page. In some cases, a shutdown of the Tomcat serer and remoal of the YOUR_TOMCAT_HOME/webapps/IBM-Initiate-IHE and YOUR_TOMCAT_HOME/webapps/ IBM-Initiate-IHE.war files are required. This happens because Tomcat places a lock on one of the jars in the IBM-Initiate-IHE.war and preents the serice from being remoed while Tomcat is running. Chapter 3. IBM Initiate IHE Web Serice 15

24 2. Follow the installation steps from Storing the proxy.config.xml and shared libraries - Tomcat installation on page 14). a. Replace the shared libraries in YOUR_TOMCAT_HOME/shared/lib. b. If the layout of the proxy.config.xml has changed (see IBM Initiate Master Data Serice Release Notes), port your settings from the existing proxy.config.xml to the new format and replace the YOUR_TOMCAT_HOME/ shared/classes/proxy.config.xml and proxy.config.xsd with the new ersion. c. In the proxy.config.xml file, do a search for REPLACE_ME_WITH and in each instance, replace the text with the specifics for your installation. Enironment ariable use, such as ${MAD_ROOTDIR}, is not supported inside of configuration files running under web serices. You must enter the full path. 3. Follow the instructions for deployment of the IBM-Initiate-IHE.war (see Installing the IHE web application on Tomcat on page 15). Upgrading an existing installation on Tomcat There are specific steps you must take to upgrade an IBM Initiate IHE web serice on Tomcat from a major ersion to a new major ersion (for example, 9.0 to 9.2 or later). Procedure 1. Remoe the IHE web serice application from the Tomcat Manager page. In some cases, a shutdown of the Tomcat serer and remoal of the YOUR_TOMCAT_HOME/webapps/brokerproxy and YOUR_TOMCAT_HOME/webapps/ brokerproxy.war files is required. This happens because Tomcat places a lock on one of the jars in the brokerproxy.war and preents the serice from being remoed while Tomcat is running. 2. Follow the installation steps from Storing the proxy.config.xml and shared libraries - Tomcat installation on page 14): a. Replace the shared libraries. b. If the layout of the proxy.config.xml has changed (see IBM Initiate Master Data Serice Release Notes), port your settings from the existing proxy.config.xml file to the new format and replace the YOUR_TOMCAT_HOME/shared/classes/proxy.config.xml with the new ersion. 3. Follow the instructions for deployment of the IBM-Initiate-IHE.war (see Installing the IHE web application on Tomcat on page 15). Related tasks Editing paths and ariables in your configuration files on page 26 The proxy.config.xml file and some of the broker.ini files contain "REPLACE_ME_WITH_" text which must be customized with path information specific to your install. Changing the logging configuration on Tomcat You hae the option of changing the default IBM Initiate IHE web serice logging configuration on Tomcat. Procedure 1. The logging configuration is controlled by the log4j.properties file located in the expanded web application classes directory. See YOUR_TOMCAT_HOME/webapps/ brokerproxy/web-inf/classes. 2. Find the section "# Initiate Systems Logging." Edit the line: log4j.logger.com.initiatesystems=your_al, ISwhere your_al is one of the 16 Integrating the Healthcare Enterprise (IHE) Accelerator Reference

25 following: TRACE, DEBUG, INFO, WARN, FATAL. You get less logging as you moe further to the right in the list. The default setting is WARN. TRACE logs eery message to and from the JNI layer, so use it with caution. (The logs can contain personal health information [PHI] information in some cases.) TRACE and DEBUG settings are meant to be used during the deelopment and testing phases. In this section, you can also change the location of the IBM-Initiate-IHE.log and other log4j properties. 3. Restart Tomcat. IHE web serice installation on IBM WebSphere Installing the IHE web serice on IBM WebSphere is supported. Before beginning installation, there are some prerequisites that must be met. Verify that the following tasks hae been completed. The proxy.config.xml file has been modified to match your installation configuration. The proxy.config.xml, proxy.config.xsd, and the schemas folder has been copied to the WebSphere/AppSerer/properties folder. The contents of the BROKER_ROOTDIR/proxy/lib directory has been copied to WebSphere/AppSerer/bin. Storing the proxy.config.xml and shared libraries - IBM WebSphere installation For IBM Initiate IHE web serice installation on IBM WebSphere, the proxy.config.xml and shared libraries must be stored in the shared libraries path. Procedure 1. Shut down the WebSphere serer. 2. Place the proxy.config.xml and the proxy.config.xsd files along with the schemas folder into the YOUR_WEBSHPERE_DIR/AppSerer/properties directory. 3. Place the contents of the YOUR_BROKER_INSTALL_DIR/proxy/lib directory in to the YOUR_WEBSHPERE_DIR/AppSerer/bin directory. Installing the IHE web application on IBM WebSphere After storing the proxy.config.xml and shared libraries, you can begin to install the IBM Initiate IHE web application on IBM WebSphere. Procedure 1. Access the Integrated Solutions Console. The default address is: 2. Select Applications > New Applications > New Enterprise Application. 3. Under Path to the new application, go to the IBM-Initiate-IHE.war file and select Open. Then select Next. 4. Under "How do you want to install the application", select Detailed - Show all installation options and parameters. Select Next. a. On the Application Security Warnings page, select Continue. b. For the Select installation options step, leae all defaults and select Next. c. For the Map modules to serers step, leae all defaults (options cleared) and select Next. Chapter 3. IBM Initiate IHE Web Serice 17

26 d. For the Proide JSP reloading options for Web modules step, leae all defaults and select Next. e. For the Map shared libraries step, leae all defaults and select Next. f. For the Map shared library relationshipsstep, leae all defaults and select Next. g. For the Map irtual hosts for Web modules step, leae all defaults and select Next. h. For the Map context roots for Web modules step, type IBM-Initiate-IHE in the Context Root field. Select Next. i. For the Summary step, select Finish. 5. At the end of the installation process, select Sae to sae the changes directly to the master configuration. 6. Under the Applications > Application Types menu on the left of the admin console, select WebSphere enterprise applications. 7. Examine the status of IBM-Initiate-IHE_war. A red X indicates the application is stopped. Check the box next to IBM-Initiate-IHE_war, and then select Start. Results The message "Application IBM-Initiate-IHE_war on serer serer name and node node name started successfully" is displayed. The application status for IBM-Initiate-IHE_war has a green arrow indicating that the application has started. What to do next Continue with "Turning off web serices scanning and setting maximum heap size". Turning off web serices scanning and setting maximum heap size on IBM WepSphere You can turn off web serices scanning and to set your maximum heap size for your web serice application. Procedure 1. From the Integrated Solutions Console, select Serers > Serer Types > WebSphere Application Serers. 2. Under Application serers, select the link associated with your serer (for example, serer1). 3. Under Serer Infrastructure, select Jaa and Process Management > Process Definition. 4. Under Additional Properties, select the link for the Jaa Virtual Machine. 5. Set the Generic JVM arguments parameter to: -Dcom.ibm.WebSphere.webserices.DisableIBMJAXWSEngine=true 6. Set the Maximum heap size to Select Apply and Sae your changes. What to do next Continue with setting your class loader order. 18 Integrating the Healthcare Enterprise (IHE) Accelerator Reference

27 Setting the class loader order on IBM WebSphere You can set the class loader order on your IBM Initiate IHE web application installation. Procedure 1. From the Integrated Solutions Console, select Applications > Application Types > WebSphere enterprise applications > IBM-Initiate-IHE_war > Manage Modules > IBM-Initiate-IHE. 2. Set the Class loader order to Classes loaded with local class loader first (parent last). 3. Select Apply and Sae your changes. 4. Go to the WebSphere/AppSerer/profiles/AppSr/installedApps/yourNode/IBM- Initiate-IHE_war.ear/IBM-Initiate-IHE.war/WEB-INF/ directory. Open the ibm-web-ext.xmi file and add the following lines. <jspattributes xmi:id="jspattribute_n" name="jdksourceleel" alue="16"/> <jspattributes xmi:id="jspattribute_n" name="disablejspruntimecompilation" alue="false"/> 5. Go to the WebSphere/AppSerer/profiles/AppSr/installedApps/yourNode/IBM- Initiate-IHE_war.ear/IBM-Initiate-IHE.war/WEB-INF/lib/ directory. Make a copy of the wsdl4j jar file and place the copy in the WebSphere/AppSerer/jaa/jre/lib/ext/ directory. 6. Go to the WebSphere/AppSerer/profiles/AppSr/installedApps/yourNode/IBM- Initiate-IHE_war.ear/IBM-Initiate-IHE.war/WEB-INF/classes/ directory. Open the log4j.properties file and find this line: log4j.appender.is.file=${catalina.base}/logs/ibm-initiate-ihe.log Change the line to: log4j.appender.is.file=websphere/appserer/profiles/appsr/logs/ IBM-Initiate-IHE.log Find the line: log4j.appender.isatna.file=${catalina.base}/logs/ IBM-Initiate-IHE-ATNA.log Change the line to: log4j.appender.isatna.file=websphere/appserer/profiles/appsr/ logs/ibm-initiate-ihe-atna.log 7. Restart the serer. What to do next The IBM Initiate IHE application is located at: Initiate-IHE. Access this URL to erify that the application is installed correctly. If the WebSphere port is different from 9080, replace it with the correct port number. Completing the IHE web serice installation on IBM WebSphere After performing the initial installation steps, there are a few additional steps you need to take to complete the process. About this task This task assumes that you hae already completed the following: Storing the proxy.config.xml and shared libraries - IBM WebSphere installation on page 17 Chapter 3. IBM Initiate IHE Web Serice 19

28 Installing the IHE web application on IBM WebSphere on page 17 Turning off web serices scanning and setting maximum heap size on IBM WepSphere on page 18 Setting the class loader order on IBM WebSphere on page 19 Procedure 1. Verify that WebSphere is off. 2. Go to the YOUR_WEBSPHERE_DIR/AppSerer/profiles/YOUR_APPSRV/ installedapps/your_node/ibm-initiate-ihe_war.ear/ibm-initiate-ihe.war/ WEB-INF/ directory. Open the ibm-web-ext.xmi file and add the following lines. <jspattributes xmi:id="jspattribute_n" name="jdksourceleel" alue="16"/> <jspattributes xmi:id="jspattribute_n" name="disablejspruntimecompilation" alue="false"/> 3. Go to the YOUR_WEBSPHERE_DIR/AppSerer/profiles/YOUR_APPSRV/ installedapps/your_node/ibm-initiate-ihe_war.ear/ibm-initiate-ihe.war/ WEB-INF/lib/ directory. Make a copy of the wsdl4j jar file and place the copy in the WebSphere/AppSerer/jaa/jre/lib/ext/ directory. 4. Go to the YOUR_WEBSPHERE_DIR/AppSerer/profiles/YOUR_APPSRV/ installedapps/your_node/ibm-initiate-ihe_war.ear/ibm-initiate-ihe.war/ WEB-INF/classes/ directory. Open the log4j.properties file and find this line: log4j.appender.is.file=${catalina.base}/logs/ibm-initiate-ihe.log Change the line to: log4j.appender.is.file=your_websphere_dir/appserer/ profiles/your_appsrv/logs/ibm-initiate-ihe.log Find the line: log4j.appender.isatna.file=${catalina.base}/logs/ibm-initiate-ihe-atna.log Change the line to: log4j.appender.isatna.file=your_websphere_dir/appserer /profiles/your_appsrv/logs/ibm-initiate-ihe-atna.log 5. Restart the IBM WebSphere serer. What to do next The IBM Initiate IHE application is located at: Initiate-IHE. Access this URL to erify that the application is installed correctly. If the IBM WebSphere port is different from 9080, replace it with the correct port number. Enabling XDS.b Serice on IBM WebSphere The XDS.b serice is disabled by default when you install the IBM Initiate IHE web application. Use this procedure to enable the XDS.b serice on IBM WebSphere. Procedure 1. After installing the IHE web application, shut down the IBM WebSphere serer. 2. Extract the IBM-Initiate-IHE.aar file located in the expanded IHE web application serices directory. For example, YOUR_WEBSPHERE_DIR/AppSerer/ profiles/your_appserver/installapps/node_cell/ibm-initiate-ihe_war.ear/ IBM-Initiate-IHE.war/WEB-INF/serices. 20 Integrating the Healthcare Enterprise (IHE) Accelerator Reference

29 3. Open the serices.xml file located in the extracted /META-INF directory. Remoe the comments surrounding the XDS.b serice. 4. Compress the IBM-Initiate-IHE.aar file. 5. Go to the YOUR_WEBSPHERE_DIR/AppSerer/profiles/ directory and open theproxy.config.xml file. Remoe the comment surrounding the XDS.b serice. 6. Restart the IBM WebSphere serer. Updating an existing installation on IBM WebSphere There are specific steps you must take to update an existing IBM Initiate IHE installation in IBM WebSphere with a patch release. Patch releases are updates within a major ersion. For example, updating build to build , where 9.0 is the major ersion number. Procedure 1. Verify that WebSphere is turned off. 2. Replace the shared libraries. a. Copy the schemas folder to the YOUR_WEBSPHERE_DIR/AppSerer/properties directory. b. Copy the contents of the YOUR_BROKER_INSTALL_DIR/proxy/lib directory to YOUR_WEBSPHERE_DIR/AppSerer/bin directory. 3. If the layout of the proxy.config.xml has changed (see IBM Initiate Master Data Serice Release Notes), port your settings from the existing proxy.config.xml to the new format and replace the proxy.config.xml and proxy.config.xsd inside YOUR_WEBSPHERE_DIR/AppSerer/properties with the new ersion. 4. Restart IBM WebSphere. 5. Access the Integrated Solutions Console. The default address is 6. Select Applications > Application Types > Websphere Enterprise Application. 7. Select the IBM-Initiate-IHE_war check box and click Uninstall. 8. Select OK. 9. Sae your changes. 10. Follow the steps in these topics: a. Turning off web serices scanning and setting maximum heap size on IBM WepSphere on page 18 b. Setting the class loader order on IBM WebSphere on page 19 c. Completing the IHE web serice installation on IBM WebSphere on page Restart IBM WebSphere. Upgrading an existing installation on IBM WebSphere There are specific steps you must take to upgrade an IBM Initiate IHE web serice on IBM WebSphere from a major ersion to a new major ersion (for example, 9.0 to 9.2 or later). Procedure 1. Verify that WebSphere is turned off. 2. Replace the shared libraries. a. Copy the schemas folder to the YOUR_WEBSPHERE_DIR/AppSerer/properties directory. Chapter 3. IBM Initiate IHE Web Serice 21

30 b. Copy the contents of the YOUR_BROKER_INSTALL_DIR/proxy/lib directory to YOUR_WEBSPHERE_DIR/AppSerer/bin directory. 3. If the layout of the proxy.config.xml has changed (see IBM Initiate Master Data Serice Release Notes), port your settings from the existing proxy.config.xml to the new format and replace the proxy.config.xml and.xsd inside YOUR_WEBSPHERE_DIR/AppSerer/properties with the new ersion. 4. Search for REPLACE_ME text in your broker configuration files in YOUR_BROKER_INSTALL_DIR/config/IHE/* (including subdirectories) and proxy.config.xml. Replace that text with the path specific to your install. Enironment ariable use (such as ${MAD_ROOTDIR}) is not supported inside configuration files that run under web serices. 5. Start IBM WebSphere. 6. Access the Integrated Solutions Console. The default address is 7. Select Applications > Application Types > Websphere Enterprise Application. 8. Select the IBM-Initiate-IHE_war check box and click Uninstall. 9. Select OK. 10. Sae your changes. 11. Follow the steps in these topics: a. Turning off web serices scanning and setting maximum heap size on IBM WepSphere on page 18 b. Setting the class loader order on IBM WebSphere on page 19 c. Completing the IHE web serice installation on IBM WebSphere on page Restart IBM WebSphere. Related tasks Editing paths and ariables in your configuration files on page 26 The proxy.config.xml file and some of the broker.ini files contain "REPLACE_ME_WITH_" text which must be customized with path information specific to your install. Changing the logging configuration on IBM WebSphere You hae the option of changing the default IBM Initiate IHE web serice logging configuration on IBM WebSphere. Procedure 1. The logging configuration is controlled by the log4j.properties file located in the expanded web application classes directory. See YOUR_WEBSPHERE_DIR/ AppSerer/profiles/YOUR_APPSRV/installedApps/YOUR_NODE_CELL/IBM- Initiate-IHE_war.ear/ IBM-Initiate-IHE.war/WEB-INF/classes. 2. Find the section "# Initiate Systems Logging." Edit the line: log4j.logger.com.initiatesystems=your_al, ISwhere your_al is one of the following: TRACE, DEBUG, INFO, WARN, FATAL. You get less logging as you moe further to the right in the list. The default setting is WARN. TRACE logs eery message to and from the JNI layer, so use it with caution. (The logs can contain personal health information [PHI] information in some cases.) TRACE and DEBUG settings are meant to be used during the deelopment and testing phases. 22 Integrating the Healthcare Enterprise (IHE) Accelerator Reference

31 In this section, you can also change the location of the IBM-Initiate-IHE.log and other log4j properties (for example, the size of the log files). 3. Select Deployments for your domain under Domain Structure. 4. Select the IBM-Initiate-IHE check box and click Stop > Force Stop Now. 5. Select the IBM-Initiate-IHE check box and click Delete. 6. Follow the installation steps in Installing the IHE web application on IBM WebSphere on page Restart Tomcat. IHE web serice installation on Oracle WebLogic Serer Installing the IHE web serice on Oracle WebLogic Serer is supported. Before beginning installation, there are some prerequisites that must be met. In these instructions, the following alues must be replaced with alues specific to your configuration. These settings can be added to the BEA_HOME/bin/startup.*: WEBLOGIC_HOST is the serer name on which WebLogic is running. You can also use localhost if you are installing on the same serer. BEA_HOME is the location of the BEA directory. WEBLOGIC_PORT is the port number that WebLogic is using. WEBLOGIC_HOME is the directory in which WebLogic is installed. DOMAIN_NAME is the name of your current WebLogic Domain. BROKER_INSTALL_DIR is the path to the installation of the Message Broker Suite. BROKER_LOG_DIR is the path to the Message Broker Suite logs folder. YOUR_OS is the operating system. YOUR_OS_ARCH is the current operating system architecture. Verify that the following tasks hae been completed. You hae already installed the Message Broker Suite (see the IBM Initiate Master Data Serice Message Broker Suite Reference ) Deployed the XDS Reference.zip file (see Project components on page 6). Storing the proxy.config.xml and shared libraries - Oracle WebLogic Serer For IBM Initiate IHE web serice installation on Oracle WebLogic Serer, the proxy.config.xml, proxy.config.xsd, and shared libraries must be stored in the shared libraries path. Procedure 1. If it does not exists, create a weblogic_sp.jar inside your WEBLOGIC_HOMEserer/lib directory. 2. Copy your proxy.config.xml file, proxyconfig.xsd file, and schemas folder into the weblogic_sp.jar. 3. Copy the contents of the BROKER_INSTALL_DIR/proxy/lib directory into the WEBLOGIC_HOME/serer/natie/YOUR_OSYOUR_OS_ARCH directory. 4. Due to the large memory footprint of the IHE schemas, the default memory limits in Oracle WebLogic Serer are not sufficient. Allow 500M for the Oracle WebLogic Serer domain running this serice. This increase can be done by changing the MEM_ARGS setting inside BEA_HOME/user_projects/ domains/domain_name/bin/setdomainen.*. Change MEM_ARGS to Chapter 3. IBM Initiate IHE Web Serice 23

32 MEM_ARGS="Xms256m -Xms1024m". This setting instructs Oracle WebLogic Serer to start the heap size at 256 megabytes and grow it to the maximum of 1 gigabyte. Installing the IHE web serice on Oracle WebLogic Serer After storing the proxy.config.xml, proxy.config.xsd, and shared libraries, you can begin to install the IBM Initiate IHE web application on Oracle WebLogic Serer. Procedure 1. Extract the contents of BROKER_INSTALL_DIR/proxy/IBM-Initiate-IHE.war into BROKER_INSTALL_DIR/proxy/IBM-Initiate-IHE. 2. Go to BROKER_INSTALL_DIR/proxy/IBM-Initiate-IHE/WEB-INF/Classes. a. Open the log4j.properties file. b. Change the alue for log4j.appender.is.file to BROKER_LOG_DIR/IBM- Initiate-IHE.log and log4j.appender.isatna.file to BROKER_LOG_DIR/IBM-Initiate-IHE-ATNA.log 3. Start Oracle WebLogic Serer. 4. Open a web browser and access the Administratie console (for example, 5. Under Domain Structure, select Deployments for your domain. 6. Click Install. 7. Open the IBM-Initiate-IHE Directory under BROKER_INSTALL_DIR/proxy and click Next. 8. Select Install this deployment as an application and click Next. 9. Click Next. 10. Verify that the Yes, take me to the deployment's configuration screen is selected and click Finish. 11. Select the IBM-Initiate-IHE check box and click Start > Sericing All Requests. 12. Restart Oracle WebLogic Serer. Results The IHE web application is deployed. Enabling XDS. b serice Oracle WebLogic Serer The XDS.b serice is disabled by default when you install the IBM Initiate IHE web application. Use this procedure to enable the XDS.b serice on Oracle WebLogic Serer. Procedure 1. After installing the IHE web application, shut down the Oracle WebLogic Serer serer. 2. Extract the IBM-Initiate-IHE.aar file located in the expanded IHE web application serices directory. For example, BROKER_INSTALL_DIR/proxy/ webapps/ibm-initiate-ihe/web-inf/serices. 3. Open the serices.xml file located in the extracted /META-INF directory. Remoe the comments surrounding the XDS.b serice. 4. Compress the IBM-Initiate-IHE.aar file. 5. In the WEBLOGIC_HOME/serer/lib, extract the weblogic_sp.jar file. 24 Integrating the Healthcare Enterprise (IHE) Accelerator Reference

33 6. Open the proxy.config.xml file and remoe the comment surrounding the XDS.b entries. 7. Compress the weblogic_sp.jar. 8. Restart the Oracle WebLogic Serer serer. Updating an existing installation on Oracle WebLogic Serer There are specific steps you must take to update an existing IBM Initiate IHE web serice installation on Oracle WebLogic Serer. Updates are patch releases within a major ersion. For example, updating build to build , where 9.0 is the major ersion number. Procedure 1. Open a web browser and access the Administratie console. 2. Under Domain Structure, select Deployments. 3. Select the IBM-Initiate-IHE check box and click Stop > Force Stop Now. 4. Select the IBM-Initiate-IHE check box and click Delete. 5. Replace the shared libraries in the WEBLOGIC_HOME/serer/natie/YOUR_OS/ YOUR_OS_ARCH directory. 6. If the layout of the proxy.config.xml has changed, port your settings from the existing proxy.config.xml to the new format. Replace the proxy.config.xml and proxy.config.xsd inside WEBLOGIC_HOME/serer/lib.weblogic_sp.jar with the new ersion. 7. Follow the instructions for deployment of the IBM-Initiate-IHE.war. See Installing the IHE web serice on Oracle WebLogic Serer on page 24. Upgrading an existing installation on Oracle WebLogic Serer There are specific steps you must take to upgrade an IBM Initiate IHE web serice on Oracle WebLogic Serer. Upgrades are moing from a major ersion to a new major ersion (for example, 9.0 to 9.2 or later). Procedure 1. Open a web browser and access the Administratie console. 2. Under Domain Structure, select Deployments. 3. Select the IBM-Initiate-IHE check box and click Stop > Force Stop Now. 4. Select the IBM-Initiate-IHE check box and click Delete. 5. Replace the shared libraries in the WEBLOGIC_HOME/serer/natie/YOUR_OS/ YOUR_OS_ARCH directory. 6. If the layout of the proxy.config.xml has changed, port your settings from the existing proxy.config.xml to the new format. Replace the proxy.config.xml and proxy.config.xsd inside WEBLOGIC_HOME/serer/lib.weblogic_sp.jar with the new ersion. 7. Follow the instructions for deployment of the IBM-Initiate-IHE.war. See Installing the IHE web serice on Oracle WebLogic Serer on page 24. Chapter 3. IBM Initiate IHE Web Serice 25

34 Related tasks Editing paths and ariables in your configuration files The proxy.config.xml file and some of the broker.ini files contain "REPLACE_ME_WITH_" text which must be customized with path information specific to your install. Changing the logging configuration on Oracle WebLogic Serer You hae the option of changing the default IBM Initiate IHE web serice logging configuration on Oracle WebLogic Serer. Procedure 1. The logging configuration is controlled by the log4j.properties file located in the expanded web application classes directory. See BROKER_INSTALL_DIR/proxy/ webapps/ibm-initiate-ihe/web-inf/classes. 2. Find the section "# Initiate Systems Logging." Edit the line: log4j.logger.com.initiatesystems=your_al, ISwhere your_al is one of the following: TRACE, DEBUG, INFO, WARN, FATAL. You get less logging as you moe further to the right in the list. The default setting is WARN. TRACE logs eery message to and from the JNI layer, so use it with caution. (The logs can contain personal health information [PHI] information in some cases.) TRACE and DEBUG settings are meant to be used during the deelopment and testing phases. In this section, you can also change the location of the IBM-Initiate-IHE.log and other log4j properties. 3. Under Domain Structure, select Deployments. 4. Select the IBM-Initiate-IHE check box and click Stop > Force Stop Now. 5. Select the IBM-Initiate-IHE check box and click Delete. 6. Restart Oracle WebLogic Serer. Editing paths and ariables in your configuration files The proxy.config.xml file and some of the broker.ini files contain "REPLACE_ME_WITH_" text which must be customized with path information specific to your install. About this task You can use any text editor to edit these files. Regardless of the operating system on which you are installing, the proxy.config.xml file only accepts forward slashes (/). Procedure 1. Open the proxy.config.xml file. a. Search for eery occurrence of these phrases. Replace the phrases with the path to your broker instance directory. REPLACE_ME_WITH_DESIRED_LOG_DIR REPLACE_ME_WITH_PROPER_QUEUE REPLACE_ME_WITH_PATH_TO_BROKER_HOME_DIR b. Search for eery occurrence of these phrases. Replace the phrases with the path to your broker installation directory. For example, C:/Program Files/IBM/Initiate/Brokers 26 Integrating the Healthcare Enterprise (IHE) Accelerator Reference

35 REPLACE_ME_WITH_PATH_TO_BROKER_ROOT_DIR REPLACE_ME_WITH_PATH_TO_BROKER_ROOTDIR REPLACE_ME_WITH_PATH_TO_BROKER_DIR c. Search for REPLACE_ME_WITH_PATH_TO_DTD_DIR and replace it with your broker DTD directory. For example, C:/Program Files/IBM/Initiate/dtd d. Edit the mad.conn.str ariable, if necessary, to use the correct host and port. For example: mad.conn.str="localhost 16000" e. For IBM AIX, Linux, Solaris, or HP-UX implementations only, change the default Microsoft Windows settings to match the UNIX and Linux settings. Change parser_xds.dll to libmiparser_xds.so Change document_handler_xds.dll to libmidocument_handler_xds.so Change query_xds.dll to libmiquery_xds.so f. Sae and close the file. 2. In the broker configuration files, located in the instance config/ihe directory, search for REPLACE_ME_WITH_PATH_TO_BROKER_ROOTDIR in each file. Replace this line with your broker installation path. In particular, edit these configuration files. In the querybroker directory: CUST_QueryPatient.ini IHE_QueryHL72.ini IHE_QueryHL73.ini RegistryStoredQuery.ini In the msgbroker directory: MsgReaderPIX_PDQ.ini MsgReaderXDS.ini Enabling SSL for broker to hub communication To set SSL encryption between the IBM Initiate IHE web serice and your Master Data Engine, certain enironment ariables must be set. About this task For Tomcat: add the ariables to TOMCAT_HOME/bin/startup.*. For IBM WebSphere: add the ariables to YOUR_WEBSPHERE_DIR/AppSerer/ profiles/your_appsr/bin/setupcmdline.*. For Oracle WebLogic Serer : add the ariables to your BEA_HOME/user_projects/ domains/domain_name//bin/setdomainen.*. Microsoft Windows: MAD_IPVERSION=4 MAD_SECLIB=SSL MAD_SSLLIB=ssleay32.dll MAD_SSLCRYPTOLIB=libeay32.dll MAD_SSLCACERTFILE=BROKER_INSTALL_DIR/conf/ibmcorporationcert.pem MAD_SSLCERTFILE=BROKER_INSTALL_DIR/conf/ibmcorporationcert.pem MAD_SSLPKEYFILE=BROKER_INSTALL_DIR/ibmcorporationkey.pem MAD_SSLTIMEOUT=0 Chapter 3. IBM Initiate IHE Web Serice 27

36 MAD_SSLVERSION=SSL3 MAD_SSLVERIFYDEPTH=9 MAD_SSLFIPSMODE=0 IBM AIX, Linux, Solaris, or HP-UX: MAD_IPVERSION=4 MAD_SECLIB=SSL MAD_SSLLIB=libssl.so MAD_SSLCRYPTOLIB=libcrypto.so MAD_SSLCACERTFILE=BROKER_INSTALL_DIR/conf/ibmcorporationcert.pem MAD_SSLCERTFILE=BROKER_INSTALL_DIR/conf/ibmcorporationcert.pem MAD_SSLPKEYFILE=BROKER_INSTALL_DIR/ibmcorporationkey.pem MAD_SSLTIMEOUT=0 MAD_SSLVERSION=SSL3 MAD_SSLVERIFYDEPTH=9 MAD_SSLFIPSMODE=0 If you hae a FIPS-enabled implementation, set these ariables: MAD_SSLFIPSMODE=1 MAD_SSLAESKEYFILE=BROKER_INSTALL_DIR/conf/initiateaeskey.dat MAD_SSLAESIVFILE=BROKER_INSTALL_DIRconf/initiateaesi.dat MAD_SSLVERSION=TLS1 For specifics on these ariables, see IBM Initiate Master Data Serice Message Broker Suite Reference. Enabling HTTP communication You can enable HTTP communication from the broker to the hub. About this task To enable HTTP encoding between the IBM Initiate IHE web serice and your Master Data Engine, there are certain enironment ariables that must be added. HTTP communication must be enabled for the Master Data Engine before setting for the broker. For Tomcat: add the ariables to TOMCAT_HOME/bin/startup.*. For IBM WebSphere: add the ariables to YOUR_WEBSPHERE_DIR/AppSerer/ profiles/your_appsr/bin/setupcmdline.*. For Oracle WebLogic Serer : add the ariables to your BEA_HOME/user_projects/ domains/domain_name//bin/setdomainen.*. Procedure 1. Open the appropriate file for your application serer. 2. Add this ariable: MAD_COMTYPE=HTTP 3. Reboot your system after adding ariables. 28 Integrating the Healthcare Enterprise (IHE) Accelerator Reference

37 Enabling ATNA Logging To start ATNA logging, you must add information to your proxy.config.xml file. When ATNA logging is enabled, the ATNA messages are written to the IBM-Initiate-IHE-ATNA.log file. Procedure 1. In the global.config section, add the following attribute: ihe.home.community.id="ihe:homecommunityid". 2. Add the atnalogger attribute to the handler.config sections. The format is IP number:port number. For example: <handler.config sericename="xds_b_documentregistry" atnalogger=" :8087">. Troubleshooting your IHE installation There are two errors in particular that you might encounter after installing your IBMInitiate IHE web serice. Error: Open() - The fopen failed on file path_to/inbound/ reject-proc.pos If this error occurs, you must create the default broker folders one called inbound, one called query within the root directory where the instance is running. If these default names must be different (and you can change them within the proxy.config.xml file), then add these folders as appropriate. Error: Unable to resole segment definition with segmentcode 'MEMAUTHOR' and element code 'institution1' to the mpi_segxfld table If this error occurs, it means that the configuration files are of a later ersion than the.imm segment fields. To resole, replace the IHE folder in the /config directory with an older ersion that does not hae the updated segments. After replacing the IHE folder, you must search each.ini file and replace the ersion number with the current ersion. For example, if you installed ersion 9.7 of the brokers, and you replace the.ini files with files from the 9.5 ersion, you would replace C:/IBM/InitiateSystems/software/Brokers9.5.0 with C:/IBM/InitiateSystems/software/Brokers Chapter 3. IBM Initiate IHE Web Serice 29

38 30 Integrating the Healthcare Enterprise (IHE) Accelerator Reference

39 Chapter 4. Configuration Files XML and XPath The IHE Accelerator project proides configuration files (.ini files) for Inbound and Query Brokers, and ATNA logging. All IHE configuration files are stored in the /config/ihe directory of yourmessage Broker Suite install directory. XDS.b messages are IHE-specific XML messages. IHE has defined schemas that define how the messages are constructed. XPath is used to read and write data from the XML document. XPath is a language used for addressing parts of an XML document and operates on the abstract, logical structure of an XML document. Used in the XDS configuration files, XPath acts as an indirect pointer to the objects (documents, folder, or submission sets) described in the XML file. XPath models an XML document as a tree of nodes. A proprietary XPath is used to manage XML node data to and from an XML document. This XML document is used in the examples that follow. <?xml ersion="1.0" encoding="iso "?> <bookstore> <book> <title lang="eng">joe Public</title> <price>29.99</price> </book> <book> <title lang="eng">learning XML</title> <price>39.95</price> </book> </bookstore> XPath uses path expressions to select a node in an XML document to read or write to. The node is selected by following a path or steps. The most useful path expressions are listed below. Expression Description / Selects from the root node. // Selects nodes in the XML document from the current node that match the selection no matter where they are. This expression cannot be used to define a write XPATH Selects attributes Below are some path expressions and the result of the expressions: Copyright IBM Corp. 1995,

40 Path Expression Result /bookstore Selects the root element bookstore. If the path starts with a slash (/), it always represents an absolute path to an element. /bookstore/book Selects all book elements that are children of bookstore. //book Selects all book elements no matter where they are in the document. /bookstore//book Selects all book elements that are the descendant of the bookstore element, no matter where they are under the bookstore element. /bookstore/book/title/@lang Selects all attributes that are named lang. Path expressions: XPath path expressions are designed to read and write a single XML node. If the XPath expression returns multiple XML nodes, an XPath exception is returned. Predicates can be used to guarantee a single XML node. Predicates are used to find a specific node or a node that contains a specific alue. Predicates are always embedded in square brackets. The following example lists some path expressions with predicates and the result of the expressions: Path Expression Result /bookstore/book[1] Selects the first book element that is the child of the bookstore element. /bookstore/book[title= Joe Public ][price] Selects the price of the Joe Public book. //title[@lang][1] Selects the first language of the book titles. /[fn:name()] Selects the element name of the root element. /bookstore/book[fn:data(@lang)][title= Joe Public ] Selects the language of the Joe Public book. Predicates: It is important to note that only the XPath data and name functions: fn:data() and fn:name() are supported. XPath wildcards can be used to select unknown XML elements. Wildcard Description * Matches any element Matches any attribute node. boo*tore Matches any node that begins with boo and ends with tore 32 Integrating the Healthcare Enterprise (IHE) Accelerator Reference

41 XPath wildcards: The following lists some path expressions and the result of the expressions: Path Expression Result /bookstore/* Selects all the child nodes of the bookstore element. /bookstore/book[title= Joe* ][price] Selects the price of all books starting with Joe. Selects all title elements which hae any attribute. Inbound broker configuration files When you install the Message Broker Suite, an IHE-specific folder is created under the /config/ihe directory. These files are used to support XDS, PIX, and PDQ profiles. The /msgbroker folder contains the.ini files used configure the Inbound Message Broker: CUST_AddPatient.ini IHE_InboundProcessor.ini RegisterDocumentSetB.ini There are indiidual files used to configure the Message Reader for XDS and PIX_PDQ: MsgReaderprofile.ini MsgReaderFailureprofile.ini MsgReaderRequestprofile.ini MsgReaderSuccessprofile.ini Most implementors are familiar with the contents of broker configuration files. For a refresher, see IBM Initiate Master Data Serice Message Broker Suite Reference. As with standard broker configurations, you can apply iterators within the data and eent sections to copy a preious data definition within a section of the same configuration file. CUST_AddPatient.ini This configuration file directs the addition of Patients to the hub. The inbound message should contain the source code, patient name, and patient OID number. The contents of this file contains an example of a generic inbound XML message. IHE_InboundProcessor.ini This file is the inbound HL73 configuration file used to process PIX/PDQ messages from the IHE profile. XDS.b uses the PIX/PDQ inbound message to load patient data into the XDS.b Registry. If a patient does not exist in the Registry, the message is rejected. Within the configuration file, MemHead is the surior member and MergedMemHead is the obsolete member. Chapter 4. Configuration Files 33

42 MsgReaderprofile.ini The Message Reader can now manage custom acknowledgments. The MsgReader configuration files (MsgReaderXDS, MsgReaderFailureXDS, MsgReaderRequestXDS MsgReaderSuccessXDS, MsgReaderPIX_PDQ, MsgReaderFailurePIX_PDQ, MsgReaderRequestPIX_PDQ, and MsgReaderSucessPIX_PDQ) are like the query broker configuration files. The MsgReaderXDS.ini file is the main, or director, configuration file that determines which handle processes the message. The Request, Failure and Success configuration files determine how the message is processed and what the response looks like. The Interaction Handle section of the MsgReaderXDS.ini and MsgReaderPIX_PDQ.ini files contain a number of REPLACE_ME_WITH_PATH_TO_BROKER_ROOTDIR entries. Replace this text with the appropriate path to your request, success, and failure.ini files. RegisterDocumentSetB.ini This file manages the inbound XDS.b messages. In order to simplify the implementation of XDS, the data section logic is handled in the custom library document_handler_xds.dll. You can see the following entry in the.ini file. This entry identifies an XDS eent to the broker, which results in different MemPut settings being used. 0 MSGHEADER ettype ADDXDS The eent section has a Manage Generic Eents section. Generic eents are data management eents that clean the data before any other processing occurs. The IBM Initiate Master Data Serice Message Broker Suite Reference lists other data elements that are not used in XDS.b. See the IHE specifications for a description of items like ExtrinsicObject and UUIDs. Query broker configuration files When you install the Message Broker Suite, an IHE-specific folder is created under the /config/ihe/querybroker directory. This folder contains all of the.ini files you need to configure the Query Broker for the IHE XDS, PIX_PDQ, and ATNA logging profiles. The following describes the aailable query configuration files. CUST_QueryPatient.ini This file contains an example of a non-ihe, or generic, HL72 query configuration file. The Handle section has HL7 segment order definition entries for MSH, MSA, ERR, QAK, and other definitions. The definition tells the HL7 response to reorder the segments in the listed order. IHE_QueryHL7(2 and 3).ini These are IHE PIX/PDQ specific configuration files used for the queries. 34 Integrating the Healthcare Enterprise (IHE) Accelerator Reference

43 IHE_QueryCancelRequestHL73.ini This file is used to manage HL73 cancel messages. The IHE Accelerator does not support cancel and the message returns a failure response. IHE_QueryCancelResponseHL73.ini This file is used to define the failure response for the cancel requests. IHE_QueryPDQ.ini The query PDQ files support both HL72 and 3. The files include ErrorResponse, NotFoundResponse, SuccessResponse, and Request. Request builds the API call, while the response files manage the result of the request call. IHE_QueryPIX.ini The query PIX files support both HL72 and 3. The files include ErrorResponse, NotFoundResponse, SuccessResponse, and Request. Request builds the API call, while the response files manage the result of the request call. RegistryStoredQuery.ini This is the main configuration file that directs which query handles are called to manage the requests. (This file replaces the IXNDocumentGet_.ini file, which has been remoed from the package.) XDSProcessRequest.ini The XDS process configuration files support query requests from a document consumer. The Request file builds the API call to process the query against the registry. The response messages from the registry are configured in the following files: XDSProcessResponseFailure.ini XDSProcessResponseLeafClassSuccess.ini XDSProcessResponseNotFound.ini XDSProcessResponseObjectRefSuccess.ini. ATNA logging configuration file There are a number of IHE actions that can produce ATNA logs. The file used for ATNA logging configuration depends on the ersion of HL7 you are using. The IHE_AtnaLog.ini file is used to configure ATNA logging for HL72. XDS.b and HL73 ATNA logging is configured in proxy.config.xml. ATNA messages are written to the IBM-Initiate-IHE-ATNA.log file. The following actions produce ATNA logs: RegisterDocument-b RegistryStoredQuery PRPA_IN201301UV02 - Patient Registry Record Added PRPA_IN201302UV02 - Patient Registry Record Reised PRPA_IN201304UV02 - Patient Registry Record Merged Chapter 4. Configuration Files 35

44 PRPA_IN201305UV02 - Patient Registry Find Candidates Query PRPA_IN201309UV02 - Patient Registry Get Identifiers Query Query error responses See Enabling ATNA Logging on page 29 for instructions to start ATNA logging. When a query is submitted to the document registry and the registry is unable to fulfill the request, a detailed error message is returned. The error messages are found in both the IBMInitiate IHE and the broker log files. The web serice writes errors to the IBM-Initiate-IHE.log and the natie broker writes errors to the proxy.log file. Both log file names can be changed. Per the IHE specifications, the registry error must return two attributes: errorcode and codecontext. The broker response always contains two re:registryerror elements, which are bolded in the following broker response example. <query:adhocqueryresponse status="urn:oasis:names:tc:ebxml-regrep:responsestatustype:failure" xmlns:query="urn:oasis:names:tc:ebxml-regrep:xsd:query:3.0" xmlns:rim="urn:oasis:names:tc:ebxml-regrep:xsd:rim:3.0" xmlns:rs="urn:oasis:names:tc:ebxml-regrep:xsd:rs:3.0"> <rs:registryerrorlist> <rs:registryerror codecontext="getfolders requires either XDSFolderUniqueId or XDSFolderUUID" errorcode="xdsstoredquerymissingparam" seerity="urn:oasis:names:tc:ebxml-regrep:errorseeritytype:error"> </rs:registryerror> <rs:registryerror codecontext="no error returned from the engine" errorcode="ok" seerity="urn:oasis:names:tc:ebxml-regrep:errorseeritytype:error"> </rs:registryerror> </rs:registryerrorlist> <rim:registryobjectlist></rim:registryobjectlist> </query:adhocqueryresponse> The first RegistryError element reports exceptions caught in the XDS proxy. Field Description Default errorcode codecontext Most releant exception caught by the XDS proxy. A brief description of the exception. The codecontext is set in the code and the output is dependent upon the exception caught. XDSRegistryError A general error was returned from the Document Registry, see log files for more information. Default erbiage is set in the eent section of the XDSProcessResponseFailure.ini file. The second RegistryError element reports any errors thrown by the IBM Initiate Master Data Serice API calls. Field Description Default errorcode codecontext Error code (errorcode) returned from the API call. Error text (errtext) returned from the API call. OK No error returned from the Master Data Serice. 36 Integrating the Healthcare Enterprise (IHE) Accelerator Reference

45 XDS stored query configuration Patient erification identifier Testing An XDS Stored Query supports LeafClass and ObjectRef responses. The RegistryStoredQuery.ini file determines the response type requested and uses the set of configuration files defined in the Interaction Handle section of the configuration file. Implementations using the IHE-compliant Register Document web serice depend upon the ID being sent to the serice being the same ID that the registry is using to locate and register patients. For example, an implementation can elect to use the local source patient ID as their primary identifier. This means that the document registry system must use that same local source ID for patient erification. The IHE Accelerator default behaior is to use the alue of the patientid' field to erify the patient in the registry. If your implementation is sending the patient information in a different field, you can oerride the default behaior in the proxy.config.xml file. Use the alidate.patient.info" property found in the RegisterDocumentSet-b action. This property is only alid for the "broker.inbound" node. This property is a '.' delimited attrcode/field pair. For example: <alidate.patient.info>dspatid.attrval</alidate.patient.info> In this example, 'DSPATID.attrVal' indicates that the patient identifier to use in erifying a patient's existence is stored as the 'DSPATID' attribute code, and that the 'attrval' field contains the identifier to erify. Omitting this property, or leaing it empty, indicates that the patientid is the field used in patient erification. After starting the web serice, you can check to see if all serices were installed properly. Go to the IHE main page. If all serices are functioning, the splash page lists each of the serices. If a serice fails to start it is not listed on the splash page. Chapter 4. Configuration Files 37

46 38 Integrating the Healthcare Enterprise (IHE) Accelerator Reference

47 Legal Statement Licensed Materials Property of IBM Copyright IBM Corporation, 1995, US Goernment Users Restricted Rights - Use, duplication or disclosure restricted by GSA ADP Schedule Contract with IBM Corp. IBM, the IBM logo, Initiate, and Initiate Master Data Serice are trademarks of IBM Corp., registered in many jurisdictions worldwide. Jaa and all Jaa-based trademarks and logos are trademarks or registered trademarks of Oracle and/or its affiliates. Other product and serice names might be trademarks of IBM, or other companies. This Program is licensed under the terms of the license agreement accompanying the Program. This license agreement may be either located in a Program directory folder or library identified as "License" or "Non-IBM License", if applicable, or proided as a printed license agreement. Please read this agreement carefully before using the Program. By using the Program, you agree to these terms. Copyright IBM Corp. 1995,

48 40 Integrating the Healthcare Enterprise (IHE) Accelerator Reference

49 Notices and trademarks This information was deeloped for products and serices offered in the U.S.A. Notices IBM may not offer the products, serices, or features discussed in this document in other countries. Consult your local IBM representatie for information on the products and serices currently aailable in your area. Any reference to an IBM product, program, or serice is not intended to state or imply that only that IBM product, program, or serice may be used. Any functionally equialent product, program, or serice that does not infringe any IBM intellectual property right may be used instead. Howeer, it is the user's responsibility to ealuate and erify the operation of any non-ibm product, program, or serice. IBM may hae patents or pending patent applications coering subject matter described in this document. The furnishing of this document does not grant you any license to these patents. You can send license inquiries, in writing, to: IBM Director of Licensing IBM Corporation North Castle Drie Armonk, NY U.S.A. For license inquiries regarding double-byte character set (DBCS) information, contact the IBM Intellectual Property Department in your country or send inquiries, in writing, to: Intellectual Property Licensing Legal and Intellectual Property Law IBM Japan Ltd , Shimotsuruma, Yamato-shi Kanagawa Japan The following paragraph does not apply to the United Kingdom or any other country where such proisions are inconsistent with local law: INTERNATIONAL BUSINESS MACHINES CORPORATION PROVIDES THIS PUBLICATION "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF NON-INFRINGEMENT, MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. Some states do not allow disclaimer of express or implied warranties in certain transactions, therefore, this statement may not apply to you. This information could include technical inaccuracies or typographical errors. Changes are periodically made to the information herein; these changes will be incorporated in new editions of the publication. IBM may make improements and/or changes in the product(s) and/or the program(s) described in this publication at any time without notice. Any references in this information to non-ibm Web sites are proided for conenience only and do not in any manner sere as an endorsement of those Web Copyright IBM Corp. 1995,

50 sites. The materials at those Web sites are not part of the materials for this IBM product and use of those Web sites is at your own risk. IBM may use or distribute any of the information you supply in any way it beliees appropriate without incurring any obligation to you. Licensees of this program who wish to hae information about it for the purpose of enabling: (i) the exchange of information between independently created programs and other programs (including this one) and (ii) the mutual use of the information which has been exchanged, should contact: IBM Corporation J46A/G4 555 Bailey Aenue San Jose, CA U.S.A. Such information may be aailable, subject to appropriate terms and conditions, including in some cases, payment of a fee. The licensed program described in this document and all licensed material aailable for it are proided by IBM under terms of the IBM Customer Agreement, IBM International Program License Agreement or any equialent agreement between us. Any performance data contained herein was determined in a controlled enironment. Therefore, the results obtained in other operating enironments may ary significantly. Some measurements may hae been made on deelopment-leel systems and there is no guarantee that these measurements will be the same on generally aailable systems. Furthermore, some measurements may hae been estimated through extrapolation. Actual results may ary. Users of this document should erify the applicable data for their specific enironment. Information concerning non-ibm products was obtained from the suppliers of those products, their published announcements or other publicly aailable sources. IBM has not tested those products and cannot confirm the accuracy of performance, compatibility or any other claims related to non-ibm products. Questions on the capabilities of non-ibm products should be addressed to the suppliers of those products. All statements regarding IBM's future direction or intent are subject to change or withdrawal without notice, and represent goals and objecties only. This information is for planning purposes only. The information herein is subject to change before the products described become aailable. This information contains examples of data and reports used in daily business operations. To illustrate them as completely as possible, the examples include the names of indiiduals, companies, brands, and products. All of these names are fictitious and any similarity to the names and addresses used by an actual business enterprise is entirely coincidental. COPYRIGHT LICENSE: This information contains sample application programs in source language, which illustrate programming techniques on arious operating platforms. You may copy, modify, and distribute these sample programs in any form without payment to 42 Integrating the Healthcare Enterprise (IHE) Accelerator Reference

51 IBM, for the purposes of deeloping, using, marketing or distributing application programs conforming to the application programming interface for the operating platform for which the sample programs are written. These examples hae not been thoroughly tested under all conditions. IBM, therefore, cannot guarantee or imply reliability, sericeability, or function of these programs. The sample programs are proided "AS IS", without warranty of any kind. IBM shall not be liable for any damages arising out of your use of the sample programs. Each copy or any portion of these sample programs or any deriatie work, must include a copyright notice as follows: (your company name) (year). Portions of this code are deried from IBM Corp. Sample Programs. Copyright IBM Corp. _enter the year or years_. All rights resered. If you are iewing this information softcopy, the photographs and color illustrations may not appear. Trademarks IBM, the IBM logo, and ibm.com are trademarks or registered trademarks of International Business Machines Corp., registered in many jurisdictions worldwide. Other product and serice names might be trademarks of IBM or other companies. A current list of IBM trademarks is aailable on the web at "Copyright and trademark information" at The following terms are trademarks or registered trademarks of other companies: Adobe is a registered trademark of Adobe Systems Incorporated in the United States, and/or other countries. Linux is a registered trademark of Linus Toralds in the United States, other countries, or both. Microsoft, Windows, and Windows NT are trademarks of Microsoft Corporation in the United States, other countries, or both. UNIX is a registered trademark of The Open Group in the United States and other countries. Jaa and all Jaa-based trademarks and logos are trademarks or registered trademarks of Oracle and/or its affiliates. Notices and trademarks 43

52 44 Integrating the Healthcare Enterprise (IHE) Accelerator Reference

53 Index A Accelerator attribute types 7 components 6 member types and entity types 7 oeriew 5 relationship types 7 Workbench project 6 Actors 1 attribute types 7 C Configuration CUST_AddPatient 33 CUST_QueryPatient 34 IHE_InboundProcessor 33 IHE_QueryCancelRequest 35 IHE_QueryCancelResponse 35 IHE_QueryHL7 34 IHE_QueryPDQ 35 IHE_QueryPIX 35 IHE_QueryProcessRequest 35 inbound broker files 33 MsgReaderXDS 34 query broker files 34 RegisterDocumentSetB 34 RegistryStoredQuery 35 XDS stored Query 37 CUST_AddPatient 33 CUST_QueryPatient 34 customer support contacting 47 D Date range filter 5 Deterministic filter 5 Document consumer 1 register document set.b transaction 1 Registry 1 repository 1 source 1 E entity types 7 I IBM-Initiate-IHE.war file 12 IHE accelerator oeriew 5 accelerator project 6 accelerator project components 6 IHE_InboundProcessor 33 IHE_QueryCancelRequest 35 IHE_QueryCancelResponse 35 IHE_QueryHL7 34 IHE_QueryPDQ 35 IHE_QueryPIX 35 IHE_QueryProcessRequest 35 Inbound configuration files 33 CUST_AddPatient 33 IHE_InboundProcessor 33 MsgReaderXDS 34 L legal notices 41 M member types 7 MsgReaderXDS 34 P Patient Identity Source 1 Patient Demographics Query 3 Patient Identifier Cross-reference 3 PDQ 3 PIX 3 proxy.config.xml 9 proxy.config.xsd 12 Q Query configuration files. 34 CUST_QueryPatient 34 IHE_QueryCancelRequest 35 IHE_QueryCancelResponse 35 IHE_QueryHL7 34 IHE_QueryPDQ 35 IHE_QueryPIX 35 IHE_QueryProcessRequest 35 registry stored transaction 1 RegistryStoredQuery 35 R RegisterDocumentSetB 34 Manage Generic Eents 34 Registry 1 RegistryStoredQuery 35 relationship types 7 Relationships iewing 7 Repository 1 S Search filter date range 5 deterministic 5 wildcard 5 software serices contacting 47 Status page 12 support customer 47 T trademarks list of 41 Transaction register document set.b 1 registry stored query 1 W Web serice IBM-Initiate-IHE.war 12 install 13, 17, 23 oeriew 9 proxy.config.xml 9 proxy.config.xsd 12 status page 12 Web Serice oeriew 9 Wildcard filter 5 X XDS stored query configuration 37 XDS.b actors 1 Document Consumer 1 Document Registry 1 document repository 1 Document Source 1 Patient Identity Source 1 profile 1 XML 31 XPath 31 expressions 31 path expressions 32 predicates 32 wildcard path expressions 33 wildcards 32 Copyright IBM Corp. 1995,

54 46 Integrating the Healthcare Enterprise (IHE) Accelerator Reference

55 Contacting IBM You can contact IBM for customer support, software serices, product information, and general information. You also can proide feedback to IBM about products and documentation. The following table lists resources for customer support, software serices, training, and product and solutions information. Table 1. IBM resources Resource IBM Support Portal Software serices My IBM Training and certification IBM representaties Description and location You can customize support information by choosing the products and the topics that interest you at entry/portal/oeriew/software/ Information_Management/IBM Initiate_Master_Data_Serice You can find information about software, IT, and business consulting serices, on the solutions site at businesssolutions/ You can manage links to IBM web sites and information that meet your specific technical support needs by creating an account on the My IBM site at You can learn about technical training and education serices designed for indiiduals, companies, and public organizations to acquire, maintain, and optimize their IT skills at You can contact an IBM representatie to learn about solutions at Proiding feedback The following table describes how to proide feedback to IBM about products and product documentation. Table 2. Proiding feedback to IBM Type of feedback Product feedback Action You can proide general product feedback through the Consumability Surey at consumability-surey Copyright IBM Corp. 1995,

56 Table 2. Proiding feedback to IBM (continued) Type of feedback Action Documentation feedback To comment on the information center, click the Feedback link on the top right side of any topic in the information center. You can also send comments about PDF file books, the information center, or any other documentation in the following ways: Online reader comment form: Integrating the Healthcare Enterprise (IHE) Accelerator Reference

57

58 Printed in USA SC