CONNECT Solaris NIST XDS Document Registry and Repository ...

perchmysteriousData Management

Nov 30, 2012 (4 years and 8 months ago)

471 views









CONNECT
Solaris NIST XDS Document
Registry and Repository Installation and
Configuration Manual


Version 4.0

CONNECT Release 2.4

18 March 2010






CONNECT_
Solaris_NIST
_
Manual

i

Release 2.4

3/18/10


REVISION HISTORY


REVISIO
N

DATE

DESCRIPTION

1.0

4 August

2009

Initial Release

2.0

29 September 2009

Updated to reflect CONNECT Release 2.2

3.0

05 January 2010

Updated to reflect CONNECT Release 2.
3

4.0

18 March 2010

Updated to reflect CONNECT Release 2.
4


























CONNECT_
Solaris_NIST
_
Manual

ii

Release 2.4

3/18/10


TABLE OF CONTENTS

1.0

INTRODUCTION

................................
................................
................................
.............

1

1.1

P
URPOSE

................................
................................
................................
......................

1

1.2

S
COPE

................................
................................
................................
..........................

1

1.3

D
OCUMENT
D
ESCRIPTION

................................
................................
...............................

1

2.0

REFERENCED DOCUMENTS

................................
................................
........................

1

3.0


INSTALLATION AND CON
FIGURATION CHECKLIST

................................
................

2

4.0


ENVIRONMENT FOOTPRIN
T

................................
................................
.......................

2

4.1

H
ARDWARE
R
EQUIREMENTS FOR
I
NSTALLATION

................................
................................

2

4.2

S
OFTWARE
R
EQUIREMENTS FOR
I
NSTALLATION

................................
................................

3

5.0


OBTAIN MEDIA/ SOFTWA
RE

................................
................................
.......................

4

6.0


SOLARIS INSTALL AND
CONFIGURATION INSTRU
CTIONS

................................
....

4

6.1

U
NZIP THE
NHIN

CONNECT

G
ATEWAY
F
ILE

................................
................................
...

4

6.2

I
NSTALL
S
OFTWARE ON
S
OLARIS

................................
................................
.....................

4

6.2.1

JAVA SE Development Kit

................................
................................
.......................

4

6.2.2


Configure PostgreSQL

................................
................................
............................

4

6.2.3


Create the NIST Supporting Databases

................................
................................
..

5

6.2.4


Install Tomcat Servers

................................
................................
.............................

7

6.2.5


Install the XDS Server Code into Tomcat

................................
................................

8

6.2.6


Configure the Installation

................................
................................
.......................

12

6.2.6.1

Change the Physical Location where Documents are Stored on the NIST XDS
Repository

................................
................................
................................
...........

12

6.2.6.2

Change the Metadata Codes that are Validated by the NIST XDS Registry and
Repository

................................
................................
................................
...........

14

6.2.6.3

Change the Assigning Authority Value for Patients that will have Documents
Stored in the Repository

................................
................................
.....................

16

6.2.6.4

Change the Document Repository Unique Id

................................
......................

17

6.2.6.5

Change the NIST XDS Registry and Repository Software to not Validate Patient
Ids

................................
................................
................................
.......................

18

6.2.7


Test the Installation

................................
................................
...............................

20

6.2.7.1

Store a Test Document to the NIST XDS Repository

................................
.........

20

6.2.7.2

Query for a Test Document from the NIST XDS Repository

...............................

24

6.2.7.3

Retrieve a Test Document from the NIST XDS Repository
................................
.

25

6.2.8


Configure CONNECT to Connect to the NIST XDS Repository

............................

27

7.0


EXAMPLE TEST REQUEST

MESSAGES
................................
................................
...

29

7.1

D
OCUMENT
S
TORAGE

................................
................................
................................
...

29

7.2

D
OCUMENT
Q
UERY
................................
................................
................................
.......

37

7.3

D
OCUMENT
R
ETRIEVAL

................................
................................
................................
.

38

8.0


USEFUL LINKS

................................
................................
................................
...........

39

9.0


ACRONYMS

................................
................................
................................
.................

40



CONNECT_
Solaris_NIST
_
Manual

1

Release 2.4

3/18/10


1.0

INTRODUCTION

1.1

Purpose

This document is the installation and configuration manual for installing the
National Institute of
Standards Technology (NIST) XDS Document Registry and Repository software
.

This document describes the process for installing the NIST XDS Document Registry

and
Repository software with the NHIN CONNECT Gateway and Adapter software. The NIST XDS
Registry and Repository software is the chosen NHIN CONNECT document registry and
repository components for enterprise
-
type installations for this release of NHIN CON
NECT.

This document includes installation and configuration instructions for the Solaris Operating
Systems. The NIST XDS Document Registry and Repository software contains installation
instructions (see C:
\
xds_support_bin_2
\
install.pdf file after executin
g the steps in section 6.1
in this document) for a Unix
-
like platform, which this document is based on. The reader should
feel free to use the NIST XDS install.pdf installation guide as needed.

1.2

Scope

The procedures in this document are applicable to
CONNECT users who are running the
Solaris Operating System.

1.3

Document Description

This document includes the following sections:



Section 1.0 Introduction



Section 2.0 Referenced Documents



Section 3.0 Installation and Configuration Checklist



Section 4.0 E
nvironment Footprint



Section 5.0 Obtain Media/Software



Section 6.0
Solaris

Install and Configuration Instructions



Section 7.0 Example Test Request Messages



Section 8.0 Useful Links



Section 9.0 Acronyms


2.0

REFERENCED DOCUMENTS

The following list of documents
is referenced within this manual and can be found on the
CONNECT web site:



NIST XDS Installation Guide (NIST XDS install.pdf)



CONNECT

Solaris

Release

2
.3
System

Installation and Configuration

Full

Binary

Manual


CONNECT_
Solaris_NIST
_
Manual

2

Release 2.4

3/18/10


The original NIST software installation guide

(listed above) can be found in the zip file
downloaded from the CONNECT site (see section 5.0). When extracted (see section 6.1) the
original NIST installation manual can be located at

/nhin/xds_support_bin_2/install.pdf


3.0


INSTALLATION AND
CONFIGURATION CHECKL
IST


Item

Procedural Step


=
䑯an汯ld⁴he⁎䥓q⁘䑓a剥o楳瑲i⁡nd⁒=po獩瑯特⁳=f瑷a牥rf牯m⁴he=
么䥎⁃低久䍔⁒=汥a獥⁓楴e⸠=pee⁳=捴楯n=R.
=
=
啮r楰i瑨e⁎䥓q⁘䑓a剥o楳瑲y⁡nd⁒=po獩瑯特⁳=f瑷a牥⁴o⁴he=
app牯p物a瑥=ca瑩tn⸠=pee⁳e捴楯n=
S.N
.
=
=
bn獵牥r瑨e⁊=va‱⸶⁵pdate‱P⁳=晴wa牥⁩猠楮獴a汬ed⸠pee⁳=捴楯n‶.O⸱
=
=
䍯Cf楧u牥⁐o獴s牥rni⸠pee⁳=捴楯n‶⸲.O
=
=
䍲ea瑥⁴he⁎=p吠獵ppo牴rng=
da瑡ba獥献⁓ee⁳e捴楯n=S⸲⸳
=
=
䥮獴s汬⁴he=qomca琠獥牶e牳⸠ree⁳=捴con‶⸲.4
=
=
䥮獴s汬⁴he⁘䑓a獥牶e爠捯de⁩n瑯=瑯m捡琮⁓ee=獥捴楯n=S⸲⸵
=
=
䍯Cf楧u牥⁴he⁩=獴a汬a瑩tn⸠pee⁳e捴楯n‶.O⸶
=
=
qes琠瑨e⁩=獴a汬a瑩tn⸠pee⁳=c瑩tn=S⸲⸷
=
=
䍯Cf楧u牥⁴he⁃低久䍔=
ga瑥way⁳=牶e爠瑯⁰o楮i=瑯⁴he⁎=pq⁘䑓a
䑯捵men琠oeg楳瑲i⁡nd⁒=po獩瑯特⁳=牶e牳⸠pee⁳e捴楯n‶.O⸸.
=
=
4.0


ENVIRONMENT FOOTPRIN
T

4.1

Hardware Requirements for Installation

This section describes the recommended minimum hardware component infrastructure,
including processor performance, disk space, and RAM for the application server platform.
This information is subject to change based on continued development. This informat
ion
mirrors the hardware requirements for CONNECT Release
2.3

and is repeated here for your
convenience.

Item

Version

Processor

Minimum dual 2GHz CPU

RAM

Minimum of 4 GB

Hard Disk Size

Application Dependent on
the deployment
configuration. For sizing
purposes, assume 100K
per CCD record, 1K per

CONNECT_
Solaris_NIST
_
Manual

3

Release 2.4

3/18/10


Item

Version

audit log record.

Hard Disk Speed

Minimum of 7200 RPM
and 10000 RPM preferred.

Network Interface

100MB Ethernet
acceptable; 1GB Ethernet
desirable

4.2

Software Requirements for Installation

This section
describes dependent software products.

Item

Description

Operating
System

Solaris 10


Java
-
JRE/JDK

Java SDK 1.6 Update 13, Build 3.

Application
Servers

Apache Tomcat Version 5.5.23 (for the
NIST software)

Apache Tomcat Version 5.0.19 (for the
backend
xmlrr document registry)

Communicatio
n Stack

Axis2 v1.3

Network
Protocol

TCP/IP

Relational
Database

PostgreSQL v.8.2 or higher

Recommende
d Test Tools
(Optional)

soapUI v2.5.1


CONNECT_
Solaris_NIST
_
Manual

4

Release 2.4

3/18/10



5.0


OBTAIN MEDIA/ SOFTWA
RE

Download the NIST components packages from the CONNECT Site.

Step

Action Input

Expected Result

1

Download the
NIST_XDS_Registry_Repository_
2.3
.x.xxx
.zip file from the NHIN
CONNECT release site.

The file is now located on your
computer.


6.0


SOLARIS
INSTALL AND CONFIGUR
ATION INSTRUCTIONS

In order to install the NIST XDS Document Registry and Repository CONNECT Adapter
component, you will need to download and install the NIST software .The PostgreSQL
database server software is included with the Solari
s 10 OS and will need to be configured
during this process. The zip file you downloaded from the CONNECT website will contain the
NIST software (which will come with the needed Apache Tomcat application servers).

6.1

Unzip the NHIN CONNECT Gateway File

Unzip t
he NIST_XDS_Registry_Repository_
2.3.x.xxx
.zip.

cd /nhin

su

unzip NIST_XDS_Registry_Repository_
2.3.x.xxx
.zip

This will uncompress into the /nhin/postrgres /nhin/xds_support_bin_2 and
/nhin/xds_server_bin_1_0 directories

6.2

Install Software on Solaris

This
section describes the installation of the additional software required for the NIST XDS
Document Registry and Repository software to be installed on your computer.

6.2.1

JAVA SE Development Kit

Install the Java JDK 1.6 update 13 onto your computer if it ha
s not already been installed.
These installation instructions will assume that the appropriate java version is already installed
on your computer with the JAVA_HOME environment variable preset. Installation instructions
for this required component are co
ntained in the following CONNECT installation manuals
located on the CONNECT web site and will not be repeated here.



CONNECT

Solaris

Release

2
.3
System

Installation and Configuration

Full

Binary

Manual


CONNECT_
Solaris_NIST
_
Manual

5

Release 2.4

3/18/10


6.2.2


Configure PostgreSQL

Configure PostgreSQL v8.2

onto your computer. The PostgreSQL database server is released
with Solaris 10. The configuration of postgres only requires a few steps. As root, change users
to postgres. Also, postgres is a role and does not have a password.

su
-

postgres

Create the
PostgreSQL database cluster:

/usr/postgres/8.2/bin/initdb

䐠⽶a爯ro獴s牥猯U⸲⽤a瑡
=
A猠牯o琬⁵獥⁴he⁓ola物猠se牶楣攠janagement⁆=捩c楴i
卍䘩⁴o⁳=a牴⁐o獴s牥r兌.⁖楥i⁴he=晵汬=
獥牶楣攠name=by⁥xe捵瑩tg⁴he=景汬ow楮iW
=
獶捳⁰o獴s牥獱l
=
啳rng⁴he⁆䵒䤠⡆au
汴ljanaged⁒=sou牣攠䥤en瑩f楥爩=f牯m⁴he⁳=捳⁣cmmandⰠenab汥lthe=
獥牶楣攮
=
⽵獲⽳s楮i獶捡dm⁥nable‼
fmri from the above svcs command
>

Restart the server. When the system reboots, view the postgresql service again and verify that
it’s in the online state.

6.2.3


Create the NIST Supporting Databases

The NIST XDS Registry and Repository software requires several supporting databases in the
PostgreSQL database server you just installed. Follow the steps listed below to create those
databases on your newly inst
alled database server.

Create the following environment variables.

export POSTGRESQL_HOME=/var/postgres/8.2/data

export PATH=${PATH}:${POSTGRESQL_HOME}:/usr/postgres/8.2/bin

export CLASSPATH=${CLASSPATH}:/usr/postgres/8.2/lib

Change directory to
/nhin/xds_support_bin_2”.Execute the following command:


CONNECT_
Solaris_NIST
_
Manual

6

Release 2.4

3/18/10


createuser
-
U postgres
-
s
-
P ebxmlrr

Hit the return key when prompted for the new role’s password.

Enter password for the new role: <return_key>

Hit the return key when prompted to enter the new role
’s password again.

Enter it again: <return_key>

Execute the following command:

createuser
-
U postgres
-
s
-
P xdsoper

Enter xdsoper when prompted for the new role’s password.

Enter password for the new role: xdsoper

Enter xdsoper when prompted to enter the
new role’s password again.

Enter it again: xdsoper

Execute the following command:


createuser
-
U postgres
-
s
-
P logs


Enter xdslogs when prompted for the new role’s password.

Enter password for the new role: xdslogs

Enter xdslogs when prompted to enter
the new role’s password again.

Enter it again: xdslogs

Execute the following set of commands:


createuser
-
U postgres
-
s
-
P bill

createdb

唠po獴s牥猠

传xd獯pe爠reg楳瑲i
=
捲敡瑥db=

唠po獴s牥猠adt
=
捲敡瑥db=

唠po獴s牥猠

传汯l猠汯gO
=

CONNECT_
Solaris_NIST
_
Manual

7

Release 2.4

3/18/10


pg_restore

U postgres

d r
egistry

Ft init_data/xds/xds_init.tar

pg_restore

U postgres

d adt init_data/adt/adt.dump


6.2.4


Install Tomcat Servers

The two tomcat servers were already extracted as part of the instructions in section 6.1. This
section will create a user
environment variable that you will use to start the two versions of
tomcat and verify that they can be started correctly.

For an explanation of the two tomcat versions, please refer to the NIST XDS installation guide.
When executing these steps, it is advi
sed to execute the tomcat1 and tomcat2 configuration
from two separate xterms. Monitor the /nhin/xds_support_bin_2/tomcat*/logs/catalina.out
logfile (where tomcat* is either tomcat1 or tomcat2) for an errors/exceptions.

Set the CATALINA_HOME environment va
riable and change directory to the bin directory.

export CATALINA_HOME=/nhin/xds_support_bin_2/tomcat1

cd $CATALINA_HOME/bin

Start tomcat1 by executing the following commands:

su

chmod +x *.sh

./startup.sh

Copy the xalan.jar from the expanded zip to the
tomcat2 server directory tree.

cp /nhin/xds_support_bin_2/xalan.jar
/nhin/xds_support_bin_2/tomcat2/webapps/ebxmlrr/WEB
-
INF/lib/xalan.jar

From the other xterm, set the CATALINA_HOME environment variable to the tomcat2 directory
and change directories to t
hat location.

export CATALINA_HOME=/nhin/xds_support_bin_2/tomcat2

cd $CATALINA_HOME/bin


CONNECT_
Solaris_NIST
_
Manual

8

Release 2.4

3/18/10


Start the tomcat2 server. Edit the startup.sh script to remove the enabling of assertions
JAVA_OPTS
.

su

chmod +x *.sh

./startup.sh

Shutdown both tomcat servers

cd
/nhin/xds_support_bin_2/tomcat1/bin

./shutdown.sh

cd /nhin/xds_support_bin_2/tomcat2/bin

./shutdown.sh


6.2.5


Install the XDS Server Code into Tomcat

The precompiled NIST XDS software can be found in the /nhin/xds_server_bin_1_0 directory
as extracted fr
om the instructions in section 6.1. This section will install the precompiled
software into the appropriate tomcat version.

Copy the following files into the tomcat1 services directory.

cd /nhin/xds_server_bin_1_0

cp xds.aar /nhin/xds_support_bin_2/tomcat1
/webapps/axis2/WEB
-
INF/services/.

cp xdsref.war /nhin/xds_support_bin_2/tomcat1/webapps/.

cp LogReader.war /nhin/xds_support_bin_2/tomcat1/webapps/.

cp xdstools.war /nhin/xds_support_bin_2/tomcat1/webapps/.

Verify that the PostgreSQL database server is
running by executing the following command.

psql

唠ro獴s牥r
=
y
q
=

CONNECT_
Solaris_NIST
_
Manual

9

Release 2.4

3/18/10


From each tomcat xterm, restart the tomcat server and monitor the catalina.out log file.

cd $CATALINA_HOME/bin

./startup.sh

Open a web browser and hit the following URL:

http://localhost:9080/xdstools/

The browser should display the following:


Next hit the following URL to display an image similar to the following

http://localhost:8080/



CONNECT_
Solaris_NIST
_
Manual

10

Release 2.4

3/18/10



Next hit the
following URL which should present an image similar to the following:

http://localhost:9080/xdsref/


CONNECT_
Solaris_NIST
_
Manual

11

Release 2.4

3/18/10



Finally hi
t the following URL

http://localhost:9080/LogReader/

The LogReader web application reads data from the log2 database that will be initialized by
the server the first time there is something to log. In the meantime, you will receive some http
500 errors and a page that looks s
imilar to the following screen shot:


CONNECT_
Solaris_NIST
_
Manual

12

Release 2.4

3/18/10



As a quick reference, the NIST XDS start order as noted from the NIST XDS installation guide
that you extracted in section 6.1 is:



Start the postgres server



Start the tomcat2 server



Start the tomcat1 server



Check the
log files to verify the two application servers started correctly

6.2.6


Configure the Installation

The following steps will need to be performed to configure your installation of the NIST XDS
software. Some of the configuration steps are optional.

6.2.6.1

Change the Physical Location where Documents are Stored on the NIST
XDS Repository

This process is necessary in order to store documents on your computer properly. Stop both
tomcat servers

cd /nhin/xds_support_bin_2/tomcat1/bin

./shutdown.sh

cd /nhin/xds
_support_bin_2/tomcat2/bin

./shutdown.sh


CONNECT_
Solaris_NIST
_
Manual

13

Release 2.4

3/18/10


Copy the xds.aar file from /nhin/xds_support_bin_2/tomcat1/webapps/axis2/WEB
-
INF/services
to a temporary location with nothing else in the directory
.

cd /tmp

mkdir xds_aar

cd xds_aar

cp
/nhin/xds_support_bin_2/tomcat1/webapps/axis2/WEB
-
INF/services/xds.aar .

Extract the contents of the file.

jar

xf⁸d献sar
=
bd楴⁴he⁸d献s牯pe牴re猠f楬e⁩n⁹ou爠favo物瑥⁥d楴o爮⁃桡nge⁲=po獩so特_ba獥_d楲⁡nd⁳=ve⁹ou爠
捨anges
=
牥ro獩瑯特_ba獥_d楲=⽮h楮ixd
獟獵ppo牴rb楮iO⽴om捡琱⽷ebapps⽒L佔⽒Lpo獩so特
=
=
bxe捵瑥⁴he=景汬ow楮i⁣ommand⁴o⁲=捯n獴牵捴⁴he⁸d献sa爠f楬e⁡nd⁣opy⁴he=f楬e=ba捫⁴o⁴he=
瑯mca琱=d楲e捴c特.
=
=
橡爠

cf⁸d献sa爠r
=
捰⁸d献sa爠⽮h楮ixd獟suppo牴rb楮_OL⁴om捡tNLwebapp猯sx楳㈯tb_
J
f乆⽳L牶楣敳i.
=
剥獴a牴⁢o瑨=瑯m捡t⁳=牶e牳⸠䙲om⁥a捨=瑯mca琠x瑥牭Ⱐ牥r瑡牴⁴he⁴om捡琠se牶e爠rnd=mon楴o爠
瑨e⁣a瑡汩na⹯u琠汯l=f楬e.
=
捤․䍁qAi䥎f_䡏eb⽢楮
=
ⸯ獴s牴rp⹳.
=
=


CONNECT_
Solaris_NIST
_
Manual

14

Release 2.4

3/18/10


6.2.6.2

Change the Metadata Codes that are Validated by the NIST XDS Registry and
Repository

The
NIST XDS Registry and Repository software will validate certain metadata values using a
file called, “codes.xml”, located at

/nhin/xds_support_bin_2/tomcat1/webapps/xdsref/codes/codes.xml

Some of the codes used with NHIN have been included in a codes.xml f
ile included in the zip
file you downloaded in section 6. You may choose to use these codes in your NIST software
installation. If so, simply follow the steps below.

Rename the codes.xml file to keep the original.

cd /nhin/ xds_support_bin_2/tomcat1/webapp
s/xdsref/codes

mv codes.xml codes.xml.orig

Copy the file containing the NHIN codes in to replace the original.

cp /nhin/xds_support_bin_2/codes.xml
/nhin/xds_support_bin_2/tomcat1/webapps/xdsref/codes/.


As additional NHIN codes or the needs of your
organization change such that new codes need
to be added or existing codes need to be modified, the following example steps outline how
this may be accomplished. This example will use the NHIN document class code metadata
item to illustrate where to go to
modify this code should it ever need to change (e.g., the
XNHIN
-
CONSENT class code may change to a real LOINC document class code at some
point in the future).

Step

Action Input

Expected Result

1

Open the following file in a text editor
of your choice:


/nhin/xds_support_bin_2/tomcat1/we
bapps/xdsref/codes/codes.xml

The codes.xml file will be open
in your text editor and will be
ready for your modifications.

2

Locate the “classCode” metadata
楴im⸠
=
=
=
vou爠rd楴i爠獨ou汤⁢e=on⁴he=
汩ne⁴ha琠汯l歳楫攠瑨e=
景汬ow楮iW
=
=
<䍯Ceqype=name="捬c獳䍯se"=
捬慳獓捨eme="u牮㩵uid㨴NaRUU

J
UUSR
J
4挰9
J
ad昷
J
ePSO4TRbN4Pa">
=

CONNECT_
Solaris_NIST
_
Manual

15

Release 2.4

3/18/10


Step

Action Input

Expected Result


Note: Document class codes
will be listed as sub
-
elements to
the classCode element
identified here.

3

Find the class code sub
-
element for
“XNHIN
-
CONSENT”.

If there is no
such element, one can be created by
entering the following text within the
class code element (e.g., as the last
sub
-
element in the list):


<Code code="XNHIN
-
CONSENT"
display="XNHIN Consent CPP doc"
codingScheme="2.16.840.1.113883.
6.1"/>

You editor will display the line
containing the XNHIN
-
CONSENT class code.

4

Change the code, display, or coding
scheme attribute as appropriate to
your circumstance.


The following is a brief explanation of
the attributes:



Code


the actual document
cla
ss code as found in the
“nodeRepresentation”
attribute of the “Classification”
XDS metadata element for a
document.



Display


the display name of
the class code (e.g., XNHIN
Consent CPP doc) as found in
the “Name” sub
-
element of
the “Classification” XDS
metadata element for a
document.



Coding Scheme


the coding
scheme of the class code
(e.g., LOINC, SNOMED, an
OID coded value representing
a coding scheme, etc.) as
found in the “slot” sub
-
element named,
“codingScheme”, of the
“Classification” XDS metadata

element for a document.



The code, display or coding
scheme value will be changed
to the values needed by your
organization.


CONNECT_
Solaris_NIST
_
Manual

16

Release 2.4

3/18/10


Step

Action Input

Expected Result

5

Save the codes.xml document. Your
changes may be tested by
submitting a document to the
repository as discussed in the next
section.

The codes.xml document will be
saved.


6.2.6.3

Change the Assigning Authority Value for Patients that will have Documents
Stored in the Repository

Documents can only be stored in the NIST XDS Registry and Repository for patients that have
a valid

assigning authority as defined in the codes.xml file. The NIST registry has a mechanism
for assigning patient ids using an assigning authority; but that functionality is used more during
the IHE XDS Connect
-
a
-
thon testing events, and will not be modified
here. For more
information, check the original NIST XDS Registry and Repository installation guide located at
/nhin/xds_support_bin_2/install.pdf.

The following steps provide an example of modifying the patientId assigning authority value.
This value will
need to match the other assigning authority properties found in your CONNECT
Full Binary Installation and Configuration Manual (e.g., adapter.properties file. See section
7.5).

Step

Action Input

Expected Result

1

Open the following file in a text editor

of your choice:


/nhin/xds_support_bin_2/tomcat1/we
bapps/xdsref/codes/codes.xml

The codes.xml file will be open
in your text editor and will be
ready for your modifications.

2

Locate the “AssigningAuthority”
e汥浥l琮=
=
=
=
vou爠rd楴i爠獨ou汤⁢e=on⁴he=
汩ne=
瑨a琠汯l歳⁳業楬a爠ro⁴he=
景汬ow楮iW
=
=
<A獳楧n楮iAu瑨o物瑹=
楤㴢iampXN⸳.S⸱⸴.N⸲NPST⸲M
MR⸳⸷Camp㭉p伢⼾
=
P
=
Modify the “id” attribute value to
ma瑣h⁴he⁏䥄fa獳楧n楮i⁡u瑨o物瑹=
de獩sed.
=
=
乯ke㨠make⁳=牥⁴o=ave⁴he=
"&amp;” and “ISO” values. Just
捨ange⁴h
e=佉䐠aa汵l⸠qh楳⁷楬氠
en獵牥r瑨a琠瑨e=
“XDSDocumentEntry.patientId”
metada瑡⁩=em=fo爠rou爠ro捵men琠
The OID portion of the “id”
a瑴物bute⁶a汵l映瑨e⁡獳楧n楮i=
au瑨o物瑹⁥汥len琠w楬氠
扥b
捨anged=瑯⁹ou爠re獩sed⁶a汵l.
=

CONNECT_
Solaris_NIST
_
Manual

17

Release 2.4

3/18/10


Step

Action Input

Expected Result

submissions match on the assigning
authority and are in the HL7 format.

4

Save the codes.xml file. Your
changes may be tested by
submitting a document to the
repository as discussed in the next
section.

File will be saved.


6.2.6.4

Change the Document Repository Unique Id

You may need to
modify the NIST XDS Repository software’s unique document repository
identifier value.

The following steps provide an example of modifying the document repository’s unique
identifier value. This value will need to match the other document repository unique

id
properties found in your CONNECT installation.

Stop both tomcat servers

cd /nhin/xds_support_bin_2/tomcat1/bin

./shutdown.sh

cd /nhin/xds_support_bin_2/tomcat2/bin

./shutdown.sh


Step

Action Input

Expected Result

1

Copy the xds.aar file from
/nhin/xds_support_bin_2/tomcat1/we
bapps/axis2/WEB
-
INF/services to a
temporary location with nothing else
in the directory (e.g., /tmp/xds_aar).

A copy of the xds.aar file will be
in the empty folder.

2

Execute the following command:


jar
-
xf xds.aar

The
xds.aar file will be
expanded in this directory.

3

Open the xds.properties file in the
text editor of your choice.

The xds.properties file will be
opened in your favorite text
editor.

4

Change the “repository_unique_id”
p牯re牴r⁴o⁹ou爠re獩sed⁏䥄⁶a汵l
=
and⁳ave⁹ou爠捨ange献
=
=
qhe
=
牥ro獩瑯特_un楱ue_楤i
p牯re牴r⁷楬氠lave⁴he=de獩sed=
va汵l.
=

CONNECT_
Solaris_NIST
_
Manual

18

Release 2.4

3/18/10


Step

Action Input

Expected Result

* Other xds configuration changes
may be made while you are here.
Some changes are referenced in this
document. For other changes,
please see the original NIST XDS
installation guide located at
c:
\
xds_support_bin_2
\
install.pdf.

5

Execute the following command to
reconstruct the xds.aar file:


jar

cf xds.aar *


Note: you may have to type the text
of this command by hand as a mere
cut
-
and
-
paste operation from this
docum
ent has been known to not
execute the command properly.

The xds.aar file will be
recreated with the modified
xds.properties file within.

6

Copy the modified xds.aar file back
to the following directory:


/nhin/xds_support_bin_2/tomcat1/we
bapps/axis2/WEB
-
INF/services

The modified xds.aar file will
have replaced the previous file.

7

Create the following directory if it
doesn’t already exist:


/nhin/xds_support_bin_2/tomcat1/we
bapps/R
OOT
/Repository

The direc
tory where documents
will be physically stored on your
computer will have been
created.

Restart both tomcat servers. From each tomcat xterm, restart the tomcat server and monitor
the catalina.out log file.

cd $CATALINA_HOME/bin

./startup.sh


6.2.6.5

Change the NIST XDS Registry and Repository Software to not Validate
Patient Ids

In accordance with the NIST software installation guide, the registry does not accept a real
XDS patient identity feed transaction, but uses an internal web page to allocate p
atient ids for
validation. You may wish to turn off this validation for this release of CONNECT
(recommended). The following steps demonstrate how this is done.

Stop
both tomcat servers.


CONNECT_
Solaris_NIST
_
Manual

19

Release 2.4

3/18/10


cd /nhin/xds_support_bin_2/tomcat1/bin

./shutdown.sh

cd /nhin/xds_sup
port_bin_2/tomcat2/bin

./shutdown.sh



Step

Action Input

Expected Result

1

Copy the xds.aar file from
/nhin/xds_support_bin_2/tomcat1/we
bapps/axis2/WEB
-
INF/services to a
temporary location with nothing else
in the directory (e.g., /tmp/xds_aar).

A copy
of the xds.aar file will be
in the empty folder.

2

Execute the following command:


jar
-
xf xds.aar

The xds.aar file will be
expanded in this directory.

3

Open the xds.properties file in the
text editor of your choice.

The xds.properties file will be
opened in your favorite text
editor.

4

Change the
“validate_patient_id=true” property to
“validate_patient_id=false”.
=
=
⨠*瑨e爠rd猠捯nf楧u牡瑩on⁣=ange猠
may⁢e=made⁷h楬e⁹ou⁡牥rhe牥r=
pome⁣=ange猠sre⁲=晥牥r捥d⁩=⁴h楳i
do捵men琮=
=
qhe⁶a汩da瑥_pa瑩tnt_楤
=
p牯re牴r=
wi汬⁢e⁲=
J
a獳楧ned⁡⁶a汵l=of=
晡汳攠獯⁴ha琠pa瑩tn琠楤iva汵l猠
wi汬o琠be⁶a汩da瑥d=us楮i⁴he=
义kq⁳of瑷a牥r
=
R
=
bxe捵瑥⁴he=景汬ow楮i⁣ommand⁴o=
牥捯n獴牵捴⁴he⁸d献sar⁦楬e㨠
=
=
橡爠

cf⁸d献sa爠r
=
=
乯ke㨠you=may⁨ave⁴o⁴ype⁴he⁴ex琠
of⁴h楳⁣omma
nd⁢y⁨and⁡s⁡=me牥=
捵t
J
慮a
J
pa獴spe牡瑩rn=f牯m⁴h楳i
do捵men琠ha猠seen=own⁴oo琠
exe捵瑥⁴he⁣ommand=p牯re牬y.
=
qhe⁸d献sa爠f楬e⁷楬氠le=
牥捲敡瑥d⁷楴i⁴he=mod楦楥d=
xd献s牯re牴re猠f楬e⁷楴i楮i
=
S
=
䍯Cy⁴he=modified⁸d献aa爠f楬e⁢a捫c
瑯⁴he=景汬ow楮i=
d楲e捴c特W
=
=
⽮h楮ixd獟獵ppo牴rb楮_O⽴omca琱⽷e
bapp猯sx楳㈯tb_
J
䥎䘯獥牶楣敳
=
qhe=modif楥d⁸d献sa爠fi汥lw楬氠
have⁲=p污捥d⁴he=p牥r楯i猠f楬e.
=

CONNECT_
Solaris_NIST
_
Manual

20

Release 2.4

3/18/10


Step

Action Input

Expected Result

7

Create the following directory if it
doesn’t already exist:


/nhin/xds_support_bin_2/tomcat1/we
bapps/Root/Reposito
ry


The directory where documents
will be physically stored on your
computer will have been
created.

Restart both tomcat servers. From each tomcat xterm, restart the tomcat server and monitor
the catalina.out log file.

cd $CATALINA_HOME/bin

./startup.sh


6.2.7


Test the Installation

Now that the NIST XDS software is installed and configured, you should test your installation.
Tests referenced in this document use the soapUI application to submit SOAP request
messages and receive SOAP response messages to/
from the NIST repository. NIST offers a
free test kit that can be used to help test your installation. Setup and use of this test kit is
beyond the scope of this document. The test kit can be downloaded at the following location:

http://ihexds.nist.gov:9080/XdsDocs/testkit/

After initially testing the NIST XDS software installation, you may choose to use the document
query and document retrieve tests from the SelfTestSuite that is downloadable fro
m the
CONNECT website. Details of using this test suite are beyond the scope of this document.

The following steps outline some of the tests you may wish to execute.

6.2.7.1

Store a Test Document to the NIST XDS Repository


Step

Action Input

Expected Resu
lt

1

Copy the SOAP 1.1 store document request
message located in section 7.0 of this
document and paste it as a new file into your
text/xml editor of choice.

A new xml file will be created
with the store document request
message.

2

Locate the metadata
entry for the patient id by
searching for:


"289fb07d8a6f441^^^&amp;1.3.6.1.4.1.21367
.2005.3.7&amp;ISO"

Your editor should advance you
within your new document to the
patient id value on the left.

3

If you have changed your assigning authority
value as ou
tlined in the NIST XDS
configuration section, then you need to
The patient’s assigning authority
po牴ron=of⁴he=pa瑩en琠id⁳=ould=
ma瑣h⁴he⁡獳楧n楮i⁡u瑨o物瑹=

CONNECT_
Solaris_NIST
_
Manual

21

Release 2.4

3/18/10


Step

Action Input

Expected Resu
lt

change the OID portion of the patient id to
match the assigning authority OID value
found in your codes.xml file. The assigning
authority portion of the patient id is highlighted
below.


"289fb
07d8a6f441^^^&amp;
1.3.6.1.4.1.21367
.2005.3.7
&amp;ISO"

OID found in the codes.xml file.

4

Save the file for later reference.

The new file will be saved.

5

Open the soapUI.

The soapUI application will start.

6

Click on the File|New Project menu item



The “New soapUI Project” menu
item will appear.

7

Enter the following values in the new project
dialog box appropriate to your environment.
For an example,
refer to the screen shot
below:




Be sure to use the correct port as configured
in the previous section of this document.

The soapUI project name and
wsdl location match your
environment.

8

Click on the OK button.

The new project will be created
and soa
pUI will connect to the
wsdl location entered in the last
step. The soapUI application will
then look similar to the following
screen shot.


CONNECT_
Solaris_NIST
_
Manual

22

Release 2.4

3/18/10


Step

Action Input

Expected Resu
lt



9

Expand the xdsrepositorybSOAP11Binding
node if it has not already been expanded.

The soapUI application will
display the following sub
-
nodes:



getServiceName



ProvideAndRegisterDocu
mentSetRequest



RetrieveDocumentSetRe
quest



runContentValidationServ
ice

10

Expand the
ProvideAndRegisterDocumentSetRequest
node and double click on the sub
-
node
entitled, “Request 1”.



The soapUI application will
generate a stub SOAP 1.1
request and open it for editing.




Note: feel free to maximize this
window for convenience.

11

Copy the contents of the store documents
request file you created in steps 1


4 above
into the “Request
1” window overwriting the
soapUI generated request.


The new store documents
request message is copied into
the soapUI “Request 1” window.


CONNECT_
Solaris_NIST
_
Manual

23

Release 2.4

3/18/10


Step

Action Input

Expected Resu
lt


12

Click on the arrow at the left
-
top most corner
of the “Request 1” window to submit the
request.



The
request to store the test
document will be submitted to
the repository.

13

Check the response to the request. If
successful, you will see a response similar to
the following:


<soapenv:Envelope
xmlns:soapenv="http://schemas.xmlsoap.org/
soap/envelope/">


<soapenv:Body>


<rs:RegistryResponse
status="urn:oasis:names:tc:ebxml
-
regrep:ResponseStatusType:
Success
"
xmlns:rs="urn:oasis:names:tc:ebxml
-
regrep:xsd:rs:3.0">


</rs:RegistryResponse>


</soapenv:Body>

</soapenv:Envelope>

A successful respons
e message
should be returned similar to the
one shown to the left.



CONNECT_
Solaris_NIST
_
Manual

24

Release 2.4

3/18/10


6.2.7.2

Query for a Test Document from the NIST XDS Repository


Step

Action Input

Expected Result

1

Copy the SOAP 1.1 query document request
message located in section 7 of this
document and
paste it as a new file into your
text/xml editor of choice.

A new xml file will be created
with the store document request
message.

2

Locate the metadata entry for the patient id by
searching for:


"289fb07d8a6f441^^^&amp;1.3.6.1.4.1.21367
.2005.3.7&amp;IS
O"

Your editor should advance you
within your new document to the
patient id value on the left.

3

If you changed your assigning authority value
as outlined in the NIST XDS configuration
section, then you need to change the OID
portion of the patient id to

match the assigning
authority OID value found in your codes.xml
file. The assigning authority portion of the
patient id is highlighted below.


"289fb07d8a6f441^^^&amp;
1.3.6.1.4.1.21367
.2005.3.7
&amp;ISO"

The patient’s assigning authority
portion of the pat
ient id should
match the assigning authority
OID found in the codes.xml file.

4

Save the file for later reference.

The new file will be saved.

5

Open the soapUI and create a new project
similar to the one created for the store
document test using the
following wsdl
location as a guide:


http://localhost:9080/axis2/services/xdsregistr
yb?wsdl


Note: make sure you use the same port that
you configured in the configuration section
above
.

A new soapUI project will be
created pointing to the NIST
registry web service.

6

Expand the xdsregistrybSOAP11Binding node
if it has not already been expanded.

The soapUI application will
display the following sub
-
nodes:



AdhocQueryRequest



getServiceName



runContentValidationServ
ice



SubmitObjectsRequest

7

Expand the AdhocQueryRequest node and
double click on the sub
-
node entitled,
“Request 1”.

The soapUI application will
generate a stub SOAP 1.1
request and open it for editing.

8

Copy the
contents of the query documents
request file you created in step 1


4 above
into the “Request 1” window overwriting the
The new adhoc query request
message is copied into the
soapUI “Request 1” window.


CONNECT_
Solaris_NIST
_
Manual

25

Release 2.4

3/18/10


Step

Action Input

Expected Result

soapUI generated request.



9

Click on the arrow at

the left
-
top most corner
of the “Request 1” window to submit the
request.



The query request for the test
patient will be submitted to the
registry.

10

Check the response to the request. If
successful, you will see a response containing
the metadata
associated with the document
submitted previously.

A successful response message
should return the document
metadata submitted to the
repository earlier.


6.2.7.3

Retrieve a Test Document from the NIST XDS Repository


Step

Action Input

Expected Result

1

Copy the SOAP 1.1 retrieve document
request message located in section 7.0 of this
document and paste it as a new file into your
text/xml editor of choice.

A new xml file will be created
with the store document request
message.

2

Make sure that the
DocumentUniqueId
element value contains the same document id
as the document previously stored and
queried (i.e., the
$XDSDocumentEntry.UniqueId metadata
item). This value should “192.168.25.94.101”.

The DocumentUniqueId element
should have a value of
“192
.168.25.94.101”.


CONNECT_
Solaris_NIST
_
Manual

26

Release 2.4

3/18/10


Step

Action Input

Expected Result

3

Make sure that the RepositoryUniqueId
element value contains the same repository id
as that configured previously.

The RepositoryUniqueId
element should have a value
consistent with the repository id
assigned in the configuration
section above.

4

Save the file for later reference.

The new file will be saved.

5

Open the soapUI project used to store the test
document as previously created in this
document.


A new soapUI project that was
used to store a test document
should be open.

6

Expand the xdsregistrybSOAP11Binding node
if it has not already been expanded.

The soapUI application will
display the following sub
-
nodes:



getServiceName



ProvideAndRegisterDocu
mentSetRequest



RetrieveDocumentSetRe
quest



runContentValidationServ
ice

7

Expand the RetrieveDocumentSetRequest
node and double click on the sub
-
node
entitled, “Request 1”.

The soapUI application will
generate a stub SOAP 1.1
request and open it for editing.

8

Copy the contents of the retrieve document
request file you created
in steps 1


4 above
into the “Request 1” window overwriting the
soapUI generated request.



The new retrieve document
request message is copied into
the soapUI “Request 1” window.

9

Click on the arrow at the left
-
top most corner
of the “Request 1”
window to submit the
request.


The retrieve document request
for the test patient will be
submitted to the registry.


CONNECT_
Solaris_NIST
_
Manual

27

Release 2.4

3/18/10


Step

Action Input

Expected Result


10

Check the response to the request. If
successful, you will see a response containing
the base64 encoded representation of the
docum
ent submitted previously.

A successful response message
should return the base64
encode representation of the
document submitted to the
repository earlier.


6.2.8


Configure CONNECT to Connect to the NIST XDS Repository

In order for the CONNECT software
to communicate with your newly installed NIST XDS
Repository server, you will need to modify the internalConnectionInfo.xml file on the
CONNECT gateway machine as referenced in the other CONNECT installation manuals. From
the CONNECT installation manual, t
he location of this file is referenced by the

NHINC_PROPERTIES_DIR”

environment variable. This variable should have the following
value:

NHINC_PROPERTIES_DIR=$AS_HOME/domains/domain1/config/nhin

The steps to modify this file so that the CONNECT software
will use the NIST XDS Repository
server is as follows:

Step

Action Input

Expected Result

1

Open the internalConnectionInfo.xml file in
your preferred text editor on the CONNECT
gateway machine. The
internalConnectionInfo.xml file is located in
the
directory referenced by the
NHINC_PROPERTIES_DIR environment
variable as mentioned above.

The internalConnectionInfo.xml
file will open in your preferred
text editor.

2

Search for the following text:


“adapterxdsbdocrepository”
=
vou爠r牥fe牲ed=瑥x琠ed楴o爠
w楬氠
汯捡瑥=瑨e⁳=a牣r⁴ex琠on⁴he=晴.
=
P
=
Modify the “<endpointURL> tag to point to
you爠rewly⁩=獴s汬ed⁎䥓q⁘䑓a牥ro獩瑯特=
a捣c牤楮g⁴o=瑨e=fo汬ow楮iW
=
=
<endpoin瑕剌t
=
.
=
qhe⁥ndoin瑕剌t景爠瑨e=
adap瑥牸d獢do捲cpo獩so特⁩猠
upda瑥d⁴o⁰o楮琠瑯⁹ou爠rewly=
楮獴a汬ed⁎=p吠q䑓a牥ro獩瑯特=
獥牶e爮
=

CONNECT_
Solaris_NIST
_
Manual

28

Release 2.4

3/18/10


Step

Action Input

Expected Result


Where the “<NISTXDS
-
IP>”text is the real IP
address of the machine with the NIST XD
S
repository.

4

Search for the following text:


“adapterxdsbdocregistry”

Your preferred text editor will
locate the search text on the
left.

5

Modify the “<endpointURL> tag to point to
your newly installed NIST XDS registry
according to the following:


<endpointURL>http://<NISTXDS
-
IP>:9080/axis2/services/xdsregistryb</endpoi
ntURL>


Where the “<NISTXDS
-
IP>”text is the real IP
address of
the machine with the NIST XDS
registry.

The endpointURL for the
adapterxdsbdocregistry is
updated to point to your newly
installed NIST XDS registry
server.

6

Save the file.

The internalConnectionInfo.xml
file is saved.

You will also need to verify the a
ssigning authority and the home community id property
settings in the CONNECT adapter.properties file.

The steps to verify the above properties in this file are as follows:

Step

Action Input

Expected Result

1

Open the adapter.properties file in your
preferred text editor on the CONNECT
gateway and adapter machine. The
adapter.properties file is located in the
directory referenced by the
NHINC_PROPERTIES_DIR environment
variable as mentioned above.

The adapter.properties file will
be open in your prefe
rred text
editor.

2

Search for the following text:


“assigningAuthorityId”
=
vou爠r牥fe牲ed=瑥x琠ed楴o爠r楬氠
汯捡瑥=瑨e⁳=a牣r⁴ex琠on⁴he=晴.
=
P
=
se物fy⁴ha琠the=a獳楧n楮i⁡u瑨o物瑹a瑣te猠
瑨e=a獳楧n楮i⁡u瑨o物瑹t景und⁩=⁴he⁣=de献sm氠
f楬e⁲=晥牥n捥d⁩n
=
獥捴con‶⸲.S⸳.
=
qhe⁡獳楧n楮iAutho物瑹䥤=
p牯re牴ra瑣tes⁴he⁡獳楧n楮i=
au瑨o物瑹⁰牯re牴r⁩=⁹ou爠rew汹=
installed NISTXDS server’s
捯de献sm氠f楬e.
=
4
=
pea牣栠景爠瑨e=景汬ow楮i⁴ex琺
=
=
“XDSbHomeCommunityId”
=
vou爠r牥fe牲ed=瑥x琠ed楴o爠r楬氠
汯捡瑥=瑨e⁳=a牣r
=
瑥x琠on⁴he=晴.
=
R
=
se物fy⁴ha琠the=home⁣ommun楴i⁩=a瑣he猠
瑨e=ca氠lome⁣=mmun楴i⁩=⁰牯re牴r⁳=瑴楮i猠
qhe⁘䑓a䡯浥䍯mmun楴i䥤=
ma瑣he猠she=

CONNECT_
Solaris_NIST
_
Manual

29

Release 2.4

3/18/10


Step

Action Input

Expected Result

found in the gateway.properties file in the
same directory as the adapter.properties file
you are verifying.


Note: This step is applicable provid
ed the
newly installed NIST software resides in the
same home community as the CONNECT
gateway.

localHomeCommunityId value
found in the gateway.properties
file.

6

Save the file if modifications were made.

The
adapter.properties file is
saved.


7.0


EXAMPLE TEST REQUEST

MESSAGES

This section will list some sample SOAP 1.1 request messages that you may modify and use
to test your NIST XDS Registry and Repository software.

7.1

Document Storage


Sample SOAP 1.1
ProvideAndRegisterDocumentSet Request
Message

<soapenv:Envelope
xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">


<soapenv:Header/>


<soapenv:Body>


<xdsb:ProvideAndRegisterDocumentSetRequest
xmlns:xdsb="urn:ihe:iti:xds
-
b:2007">


<lcm:Submit
ObjectsRequest
xmlns:lcm="urn:oasis:names:tc:ebxml
-
regrep:xsd:lcm:3.0">



<rim:RegistryObjectList
xmlns:rim="urn:oasis:names:tc:ebxml
-
regrep:xsd:rim:3.0">




<rim:ExtrinsicObject id="Document1"
mimeType="text/plain" objectType="urn:uuid:7edca82f
-
054d
-
47f2
-
a032
-
9b2a5b5186c1">





<rim:Slot name="creationTime">






<rim:ValueList>







<rim:Value>20051224</rim:Value>






</rim:ValueList>





</rim:Slot>





<rim:Slot name="languageCode">






<rim:ValueList>







<rim:Value>en
-
us</rim:Value>






<
/rim:ValueList>





</rim:Slot>





<rim:Slot name="serviceStartTime">


CONNECT_
Solaris_NIST
_
Manual

30

Release 2.4

3/18/10


Sample SOAP 1.1
ProvideAndRegisterDocumentSet Request
Message






<rim:ValueList>







<rim:Value>200512240800</rim:Value>






</rim:ValueList>





</rim:Slot>





<rim:Slot name="serviceStopTime">






<rim:ValueList>







<rim:Value>20051224
1100</rim:Value>






</rim:ValueList>





</rim:Slot>





<rim:Slot name="sourcePatientId">






<rim:ValueList>







<rim:Value>89765a87b^^^fj34r</rim:Value>






</rim:ValueList>





</rim:Slot>





<rim:Slot name="sourcePatientInfo">






<rim:ValueLi
st>







<rim:Value>PID
-
3|pid1^^^domain</rim:Value>







<rim:Value>PID
-
5|Doe^John^^^</rim:Value>







<rim:Value>PID
-
7|19560527</rim:Value>







<rim:Value>PID
-
8|M</rim:Value>







<rim:Value>PID
-
11|100 Main
St^^Riverton^Ut^84065^USA</rim:Value>






</rim:ValueList>





</rim:Slot>





<rim:Name>






<rim:LocalizedString
value="Physical" />





</rim:Name>





<rim:Description />





<rim:Classification
classificationScheme="urn:uuid:93606bcf
-
9494
-
43ec
-
9b4e
-
a7748d1a838d" classifiedObject="Document1"

nodeRepresentation=""
objectType="urn:oasis:names:tc:ebxml
-
regrep:ObjectType:RegistryObject:Classification" id="id_1">






<rim:Slot name="authorPerson">







<rim:ValueList>








<rim:Value>^Smitty^Gerald^^^</rim:Value>







</rim:ValueList>






</
rim:Slot>


CONNECT_
Solaris_NIST
_
Manual

31

Release 2.4

3/18/10


Sample SOAP 1.1
ProvideAndRegisterDocumentSet Request
Message






<rim:Slot name="authorInstitution">







<rim:ValueList>








<rim:Value>Cleveland
Clinic</rim:Value>








<rim:Value>Parma
Community</rim:Value>







</rim:ValueList>






</rim:Slot>






<rim:Slot name="authorRole">







<rim:Value
List>








<rim:Value>Attending</rim:Value>







</rim:ValueList>






</rim:Slot>






<rim:Slot name="authorSpecialty">







<rim:ValueList>








<rim:Value>Orthopedic</rim:Value>







</rim:ValueList>






</rim:Slot>





</rim:Classification>





<rim:Classification
classificationScheme="urn:uuid:93606bcf
-
9494
-
43ec
-
9b4e
-
a7748d1a838d" classifiedObject="Document1" nodeRepresentation=""
objectType="urn:oasis:names:tc:ebxml
-
regrep:ObjectType:RegistryObject:Classification" id="id_2">






<rim:Slot na
me="authorPerson">







<rim:ValueList>








<rim:Value>^Dopplemeyer^Sherry^^^</rim:Value>







</rim:ValueList>






</rim:Slot>






<rim:Slot name="authorInstitution">







<rim:ValueList>








<rim:Value>Cleveland
Clinic</rim:Value>








<
rim:Value>Berea
Community</rim:Value>







</rim:ValueList>






</rim:Slot>






<rim:Slot name="authorRole">







<rim:ValueList>








<rim:Value>Primary
Surgon</rim:Value>







</rim:ValueList>






</rim:Slot>






<rim:Slot name="authorSpecialty"
>


CONNECT_
Solaris_NIST
_
Manual

32

Release 2.4

3/18/10


Sample SOAP 1.1
ProvideAndRegisterDocumentSet Request
Message







<rim:ValueList>








<rim:Value>Orthopedic</rim:Value>







</rim:ValueList>






</rim:Slot>





</rim:Classification>





<rim:Classification
classificationScheme="urn:uuid:41a5887f
-
8865
-
4c09
-
adf7
-
e362475b143a" classifiedObject="Document1"
nod
eRepresentation="Communication"
objectType="urn:oasis:names:tc:ebxml
-
regrep:ObjectType:RegistryObject:Classification" id="id_3">






<rim:Slot name="codingScheme">







<rim:ValueList>








<rim:Value>Connect
-
a
-
thon classCodes</rim:Value>







</rim:V
alueList>






</rim:Slot>






<rim:Name>







<rim:LocalizedString
value="Education" />






</rim:Name>





</rim:Classification>





<rim:Classification
classificationScheme="urn:uuid:f4f85eac
-
e6cb
-
4883
-
b524
-
f2705394840f" classifiedObject="Document1"
nodeRepresentation="1.3.6.1.4.1.21367.2006.7.103"
objectType="urn:oasis:names:tc:ebxml
-
regrep:ObjectType:RegistryObject:Classification" id="id_4">






<rim:Slot name="codingScheme">







<rim:ValueList>








<rim:Value>Connect
-
a
-
thon confidentialityCod
es</rim:Value>







</rim:ValueList>






</rim:Slot>






<rim:Name>







<rim:LocalizedString
value="Clinical
-
Staff" />






</rim:Name>





</rim:Classification>





<rim:Classification
classificationScheme="urn:uuid:a09d5840
-
386c
-
46f2
-
b5ad
-
9c3699a430
9d" classifiedObject="Document1"
nodeRepresentation="CDAR2/IHE 1.0"
objectType="urn:oasis:names:tc:ebxml
-
regrep:ObjectType:RegistryObject:Classification" id="id_5">






<rim:Slot name="codingScheme">


CONNECT_
Solaris_NIST
_
Manual

33

Release 2.4

3/18/10


Sample SOAP 1.1
ProvideAndRegisterDocumentSet Request
Message







<rim:ValueList>








<rim:Value>Connect
-
a
-
thon
formatCodes</rim:Value>







</rim:ValueList>






</rim:Slot>






<rim:Name>







<rim:LocalizedString
value="CDAR2/IHE 1.0" />






</rim:Name>





</rim:Classification>





<rim:Classification
classificationScheme="urn:uuid:f33fb8ac
-
18af
-
42cc
-
ae0e
-
ed
0b0bdb91e1" classifiedObject="Document1"
nodeRepresentation="Hospital Setting"
objectType="urn:oasis:names:tc:ebxml
-
regrep:ObjectType:RegistryObject:Classification" id="id_6">






<rim:Slot name="codingScheme">







<rim:ValueList>








<rim:Value>Conn
ect
-
a
-
thon healthcareFacilityTypeCodes</rim:Value>







</rim:ValueList>






</rim:Slot>






<rim:Name>







<rim:LocalizedString
value="Hospital Setting" />






</rim:Name>





</rim:Classification>





<rim:Classification
classificationScheme="urn:uuid:cccf5598
-
8b07
-
4b77
-
a05e
-
ae952c785ead" classifiedObject="Document1"
nodeRepresentation="General Medicine"
objectType="urn:oasis:names:tc:ebxml
-
regrep:ObjectType:RegistryObject:Classification" id="id_7">






<rim:Slot name="co
dingScheme">







<rim:ValueList>








<rim:Value>Connect
-
a
-
thon practiceSettingCodes</rim:Value>







</rim:ValueList>






</rim:Slot>






<rim:Name>







<rim:LocalizedString
value="General Medicine" />






</rim:Name>





</rim:Classification>





<rim:Classification
classificationScheme="urn:uuid:f0306f51
-
975f
-
434e
-
a61c
-
c59651d33983" classifiedObject="Document1"

CONNECT_
Solaris_NIST
_
Manual

34

Release 2.4

3/18/10


Sample SOAP 1.1
ProvideAndRegisterDocumentSet Request
Message

nodeRepresentation="34108
-
1"
objectType="urn:oasis:names:tc:ebxml
-
regrep:ObjectType:RegistryObject:Classification" id="id_8">






<rim
:Slot name="codingScheme">







<rim:ValueList>








<rim:Value>LOINC</rim:Value>







</rim:ValueList>






</rim:Slot>






<rim:Name>







<rim:LocalizedString
value="Outpatient Evaluation And Management" />






</rim:Name>





</rim:Classificatio
n>





<rim:ExternalIdentifier
identificationScheme="urn:uuid:58a6f841
-
87b3
-
4a3e
-
92fd
-
a8ffeff98427"
value="289fb07d8a6f441^^^&amp;1.3.6.1.4.1.21367.2005.3.7&amp;IS
O" objectType="urn:oasis:names:tc:ebxml
-
regrep:ObjectType:RegistryObject:ExternalIdentifier"
id="id_9"
registryObject="Document1">






<rim:Name>







<rim:LocalizedString
value="XDSDocumentEntry.patientId" />






</rim:Name>





</rim:ExternalIdentifier>





<rim:ExternalIdentifier
identificationScheme="urn:uuid:2e82c1f6
-
a085
-
4c72
-
9da3
-
8640a32e42ab" value="192.168.25.94.101"
objectType="urn:oasis:names:tc:ebxml
-
regrep:ObjectType:RegistryObject:ExternalIdentifier" id="id_10"
registryObject="Document1">






<rim:Name>







<rim:Local
izedString
value="XDSDocumentEntry.uniqueId" />






</rim:Name>





</rim:ExternalIdentifier>




</rim:ExtrinsicObject>








<rim:RegistryPackage id="SubmissionSet01"
objectType="urn:oasis:names:tc:ebxml
-
regrep:ObjectType:RegistryObject:RegistryPackage"
>





<rim:Slot name="submissionTime">






<rim:ValueList>







<rim:Value>20041225235050</rim:Value>






</rim:ValueList>


CONNECT_
Solaris_NIST
_
Manual

35

Release 2.4

3/18/10


Sample SOAP 1.1
ProvideAndRegisterDocumentSet Request
Message





</rim:Slot>





<rim:Name>






<rim:LocalizedString
value="Physical" />





</rim:Name>





<rim:Description>






<rim:Local
izedString value="Annual
physical" />





</rim:Description>





<rim:Classification
classificationScheme="urn:uuid:a7058bb9
-
b4e4
-
4307
-
ba5b
-
e3f0ab85e12d" classifiedObject="SubmissionSet01"
nodeRepresentation="" objectType="urn:oasis:names:tc:ebxml
-
regrep:O
bjectType:RegistryObject:Classification" id="id_20">






<rim:Slot name="authorPerson">







<rim:ValueList>








<rim:Value>^Dopplemeyer^Sherry^^^</rim:Value>







</rim:ValueList>






</rim:Slot>






<rim:Slot name="authorInstitution">







<rim:
ValueList>








<rim:Value>Cleveland
Clinic</rim:Value>








<rim:Value>Berea
Community</rim:Value>







</rim:ValueList>






</rim:Slot>






<rim:Slot name="authorRole">







<rim:ValueList>








<rim:Value>Primary
Surgon</rim:Value>







<
/rim:ValueList>






</rim:Slot>






<rim:Slot name="authorSpecialty">







<rim:ValueList>








<rim:Value>Orthopedic</rim:Value>







</rim:ValueList>






</rim:Slot>





</rim:Classification>





<rim:Classification
classificationScheme="urn:uuid:aa543740
-
bdda
-
424e
-
8c96
-
df4873be8500" classifiedObject="SubmissionSet01"
nodeRepresentation="History and Physical"
objectType="urn:oasis:names:tc:ebxml
-
regrep:ObjectType:Registr
yObject:Classification" id="id_21">


CONNECT_
Solaris_NIST
_
Manual

36

Release 2.4

3/18/10


Sample SOAP 1.1
ProvideAndRegisterDocumentSet Request
Message






<rim:Slot name="codingScheme">







<rim:ValueList>








<rim:Value>Connect
-
a
-
thon contentTypeCodes</rim:Value>







</rim:ValueList>






</rim:Slot>






<rim:Name>







<rim:LocalizedString
value="History and Physical" />






</rim:Name>





</rim:Classification>





<rim:ExternalIdentifier
identificationScheme="urn:uuid:96fdda7c
-
d067
-
4183
-
912e
-
bf5ee74998a8" value
="192.168.25.94.104"
objectType="urn:oasis:names:tc:ebxml
-
regrep:ObjectType:RegistryObject:ExternalIdentifier" id="id_22"
registryObject="SubmissionSet01">






<rim:Name>







<rim:LocalizedString
value="XDSSubmissionSet.uniqueId" />






</rim:Name>





</rim:ExternalIdentifier>





<rim:ExternalIdentifier
identificationScheme="urn:uuid:554ac39e
-
e3fe
-
47fe
-
b233
-
965d2a147832" value="129.6.58.92.1.1"
objectType="urn:oasis:names:tc:ebxml
-
regrep:ObjectType:RegistryObject:Ex
ternalIdentifier" id="id_23"
registryObject="SubmissionSet01">






<rim:Name>







<rim:LocalizedString
value="XDSSubmissionSet.sourceId" />






</rim:Name>





</rim:ExternalIdentifier>





<rim:ExternalIdentifier
id
entificationScheme="urn:uuid:6b5aea1a
-
874d
-
4603
-
a4bc
-
96a0a7b38446"
value="289fb07d8a6f441^^^&amp;1.3.6.1.4.1.21367.2005.3.7&amp;IS
O" objectType="urn:oasis:names:tc:ebxml
-
regrep:ObjectType:RegistryObject:ExternalIdentifier" id="id_24"
registryObject="Submis
sionSet01">






<rim:Name>







<rim:LocalizedString
value="XDSSubmissionSet.patientId" />






</rim:Name>





</rim:ExternalIdentifier>




</rim:RegistryPackage>




<rim:Association

CONNECT_
Solaris_NIST
_
Manual

37

Release 2.4

3/18/10


Sample SOAP 1.1
ProvideAndRegisterDocumentSet Request
Message

associationType="urn:o
asis:names:tc:ebxml
-
regrep:AssociationType:HasMember"
sourceObject="SubmissionSet01" targetObject="Document1"
id="ID_25276323_1" objectType="urn:oasis:names:tc:ebxml
-
regrep:ObjectType:RegistryObject:Association">





<rim:Slot name="SubmissionSetStatus">






<rim:ValueList>







<rim:Value>Original</rim:Value>






</rim:ValueList>





</rim:Slot>




</rim:Association>





<rim:Classification
classifiedObject="SubmissionSet01"
classificationNode="urn:uuid:a54d6aa5
-
d40d
-
43f9
-
88c
5
-
b4633d873bdd" id="ID_25276323_3"
objectType="urn:oasis:names:tc:ebxml
-
regrep:ObjectType:RegistryObject:Classification" />



</rim:RegistryObjectList>


</lcm:SubmitObjectsRequest>


<xdsb:Document
id="Document1">VGhpcyBpcyBteSBkb2N1bWVudC4KCkl0IGlzIGdyZ
WF0
IQoK</xdsb:Document>



</xdsb:ProvideAndRegisterDocumentSetRequest>



</soapenv:Body>

</soapenv:Envelope>


7.2

Document Query


Sample SOAP 1.1 ProvideAndRegisterDocumentSet Request
Message

<soapenv:Envelope
xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:ser="http://serviceclasses.ws.registry.nist.gov">


<soapenv:Header/>


<soapenv:Body>



<query:AdhocQueryRequest
xmlns:xsi="http://www.w3.org/2001/XMLSchema
-
instance"


xm
lns:query="urn:oasis:names:tc:ebxml
-
regrep:xsd:query:3.0"


xmlns="urn:oasis:names:tc:ebxml
-
regrep:xsd:rim:3.0"


CONNECT_
Solaris_NIST
_
Manual

38

Release 2.4

3/18/10


Sample SOAP 1.1 ProvideAndRegisterDocumentSet Request
Message


xmlns:rs="urn:oasis:names:tc:ebxml
-
regrep:xsd:rs:3.0">


<query:ResponseOption returnCom
posedObjects="true"
returnType="LeafClass"/>


<AdhocQuery id="urn:uuid:14d4debf
-
8f97
-
4251
-
9a74
-
a90016b0af0d">


<Slot name="$XDSDocumentEntryPatientId">


<ValueList>









<Value>'289fb0
7d8a6f441^^^&amp;1.3.6.1.4.1.21367.2005.3.7&
amp;ISO'</Value>


</ValueList>


</Slot>


<Slot name="$XDSDocumentEntryStatus">


<ValueList>



<Value>('urn:oasis:names:tc:ebxml
-
regrep:StatusType:Approved')</Value>


</ValueList>


</Slot>


</AdhocQuery>


</query:AdhocQueryRequest>




</soapenv:Body>

</
soapenv:Envelope>


7.3

Document Retrieval


Sample SOAP 1.1 ProvideAndRegisterDocumentSet Request
Message

<soapenv:Envelope
xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:ser="http://serviceclasses.ws.registry.nist.gov">


<soapenv:Header/>


<soapenv:Body>



<RetrieveDocumentSetRequest xmlns="urn:ihe:iti:xds
-
b:2007"


xmlns:xsi="http://www.w3.org/2001/XMLSchema
-
instance"


xsi:schemaLocation="urn:ihe:iti:xds
-
b:2007
file:/Users/bill/ihe/Frameworks/ITI
-
4/XDS.b/schema/IHE/XDS.b_DocumentRepository.xsd">


<DocumentRequest>


<RepositoryUniqueId>1.19.6.24.109.42.1.1</RepositoryUniqueId>


<DocumentUniqueId>192.1
68.25.94.101</DocumentUniqueId>


</DocumentRequest>

</RetrieveDocumentSetRequest>


CONNECT_
Solaris_NIST
_
Manual

39

Release 2.4

3/18/10


Sample SOAP 1.1 ProvideAndRegisterDocumentSet Request
Message




</soapenv:Body>

</soapenv:Envelope>


8.0


USEFUL LINKS

http://ihexds.nist.gov/

-

the main NIST XDS web site

http://ihexds.nist.gov:9080/XdsDocs/testkit/

-

NIST XDS test kit

http://ihexds.nist.gov:9080/XdsDocs

-

Other NIST downloads

http://ihewiki.wustl.edu/wiki/index.php/XDS_Test_Kit_2007
-
2008_Test_Descriptions

-

For use
with the XDS test kit.



CONNECT_
Solaris_NIST
_
Manual

40

Release 2.4

3/18/10


9.0


ACRONYMS


CA

Certificate Authority or Composite Application
depending on

the context.

CAC

Common Access Card

CD

Compact Disk

CDC

Centers for Disease Control & Prevention

CMS

Centers for Medicare & Medicaid Services

DAT

Digital Audio Tape

DOD

Department of Defense

DURSA

Data Use and Reciprocal Support Agreement

DVD

Digital Video Disc

EHR

Electronic Health Record

EMR

Electronic Medical Record

ESB

Enterprise Service Bus

FHA

Federal Health Architecture

GB

Gigabyte

HDD

Hard Disk Drive

HITSP

Healthcare Information Technology Standards
Panel

IDE

Integrated Drive
Electronics

IHS

Indian Health Services

IPv6

Internet Protocol Version 6

MB

Megabyte

MPI

Master Patient Index

NCI

National Cancer Institute

NDMS

National Disaster Medical System

NHIE

NHIN Health Information Exchange

NHIN

Nationwide Health
Information Network

NIST

National Institute of Standards and Technology

OID

Object Identifier or Home Community ID

ONC

Office of the National Coordinator

OS

Operating System


CONNECT_
Solaris_NIST
_
Manual

41

Release 2.4

3/18/10


QA

Quality Assurance

RAID

Redundant
Array of Inexpensive Disks

RAM

Random Access Memory

SCSI

Small Computer System Interface

SDK

Software Development Kit

SSA

Social Security Administration

SSL

Secure Sockets Layer

TBD

To Be Determined

USB

Universal Serial Bus

VA

Department of
Veterans Affairs

XDS

Cross Document Sharing