Last updated June 16, 2009 16:55, by Bernie Thuman
Contents
xconfig.xml
HIEOS configuration details (web service endpoints, unique ids, etc.) are specified in the xconfig.xml file. This file is located at «HIEOS_ROOT»\src\xref\web\config\xconfig.xml. After setup and deployment, it is accessible via the http://localhost:8080/xref/config/xconfig.xml URL. The location for xconfig.xml is also specified by the HIEOSxConfigFile environment variable.
Configuration Elements (xconfig.xml)
The following table summarizes the key configuration elements specified in xconfig.xml:
| Node | Description | Multiplicity |
|---|---|---|
| ‹HomeCommunity› | HIEOS global properties for the designated home community. | 1 |
| ‹AssigningAuthority› | List of assigning authorities. The XCA Initiating Gateway will use this configuration to target a specific registry and list of XCA Responding Gateways when a query is made for a specific patient id [when no home community id is present]. | 0..* |
| ‹Registry› | Configuration details for the designated XDS.b Registry. | 1 |
| ‹Repository› | Configuration details for the list of XDS.b Repositories utilized by HIEOS. | 1..* |
| ‹Gateway› | Configuration details for the list of XCA Gateways utilized by HIEOS. | 0..* |
Example Configuration File (xconfig.xml)
An example xconfig.xml file is provided below:
<?xml version="1.0" encoding="UTF-8"?>
<Config>
<!-- Configuration for the Home Community -->
<HomeCommunity name="home">
<!-- Home community id -->
<Property name="HomeCommunityId">urn:oid:1.3.6.1.4.1.21367.2009.1.2.2020</Property>
<!-- Designated Initiating Gateway. Refers to /Config/Gateway in this file. -->
<Property name="InitiatingGateway">localig</Property>
<!-- Designated Responding Gateway. Refers to /Config/Gateway in this file. -->
<Property name="RespondingGateway">localrg</Property>
<!-- Set to "true" if patient identifiers should be validated during XDS.b Registry
"Register" transactions -->
<Property name="ValidatePatientId">true</Property>
<!-- Place to find the "codes.xml" file. Alternatively, you can set the HIEOSxCodesFile
environment variable. -->
<Property name="CodesLocation">http://localhost:8080/xref/codes/codes.xml</Property>
<!-- Designates the local repository (refers to /Config/Repository in this file).
This is used only by the "Provide and Register" transaction. -->
<Property name="LocalRepository">localrepository</Property>
<!-- ATNA configuration parameters. -->
<!-- Set to "true" if ATNA logging should be performed. -->
<Property name="ATNAPerformAudit">true</Property>
<!-- NIST ATNA log -->
<!-- NIST syslog (browser URL: http://129.6.24.109:9080/SyslogBrowser/) -->
<Property name="ATNAsyslogHost">129.6.24.109</Property>
<Property name="ATNAsyslogPort">8087</Property>
<!-- Timeout (in milliseconds) to use for SOAP messaging. -->
<Property name="SOAPTimeOutInMilliseconds">45000</Property> <!-- 45 seconds -->
<!-- Set to "true" if internal logging should be performed. -->
<Property name="LogEnabled">true</Property>
<!-- Class name that implements the XDS.b Repository storage mechanism. -->
<Property name="RepoStorageClassImpl">com.vangent.hieos.services.xds.repository.storage.XDSRepositoryStorageSQL</Property>
<!-- Other global properties will go here. -->
</HomeCommunity>
<!-- List of assigning authorities ... -->
<!-- Used by the Initiating Gateway when a patient ID is specified (and no home community id)
on a query request. Determines what registry and responding gateways to direct requests. -->
<AssigningAuthority name = "xtest">
<UniqueId>&1.3.6.1.4.1.21367.2005.3.7&ISO</UniqueId>
<!-- Optional registry. Refers to /Config/Registry in this file. -->
<Registry>localregistry</Registry>
<!-- Optional gateways. Refers to /Config/Gateway in this file. -->
<Gateway>nistrg</Gateway>
<!-- Other gateways go here. -->
</AssigningAuthority>
<!-- The master assigning authority used in all Connectathon and HIMSS Affinity Domains. -->
<AssigningAuthority name = "IHENA">
<UniqueId>&1.3.6.1.4.1.21367.2009.1.2.300&ISO</UniqueId>
<!-- Optional registry. Refers to /Config/Registry in this file. -->
<Registry>localregistry</Registry>
<!-- Optional gateways. Refers to /Config/Gateway in this file. -->
<Gateway>nistrg</Gateway>
<!-- Other gateways go here. -->
</AssigningAuthority>
<!-- HIMSS Registration System. -->
<AssigningAuthority name = "PAMX">
<UniqueId>&1.3.6.1.4.1.21367.2009.1.2.315&ISO</UniqueId>
<!-- Optional registry. Refers to /Config/Registry in this file. -->
<Registry>localregistry</Registry>
<!-- Optional gateways. Refers to /Config/Gateway in this file. -->
<Gateway>nistrg</Gateway>
<!-- Other gateways go here. -->
</AssigningAuthority>
<!-- List of XDS.b registries (in practice, should only have one entry in this file). -->
<Registry name="localregistry"><UniqueId>NA</UniqueId>
<UseSecureEndpoints>true</UseSecureEndpoints> <!-- true to use TLS -->
<Transaction name="RegisterDocumentSet-b">
http://localhost:8080/axis2/services/xdsregistryb
</Transaction>
<Transaction name="RegisterDocumentSet-b">
https://localhost:8181/axis2/services/xdsregistryb
</Transaction>
<Transaction name="RegistryStoredQuery">
http://localhost:8080/axis2/services/xdsregistryb
</Transaction>
<Transaction name="RegistryStoredQuery">
https://localhost:8181/axis2/services/xdsregistryb
</Transaction>
<!-- "ReceiverDeviceId" is used by the patient identity feed to identify the registry in ACKs -->
<Property name="ReceiverDeviceId">1.3.6.1.4.1.21367.2009.1.3.4.600</Property>
<Property name="ReceiverDeviceName">GATEWAY_SUNVAN_XDSbRegistry</Property>
</Registry>
<!-- List of XDS.b repositories ... -->
<Repository name="localrepository">
<UniqueId>1.3.6.1.4.1.21367.2009.1.2.1010</UniqueId>
<UseSecureEndpoints>true</UseSecureEndpoints> <!-- true to use TLS -->
<Transaction name="RetrieveDocumentSet">
http://localhost:8080/axis2/services/xdsrepositoryb
</Transaction>
<Transaction name="RetrieveDocumentSet">
https://localhost:8181/axis2/services/xdsrepositoryb
</Transaction>
<Transaction name="ProvideAndRegisterDocumentSet-b">
http://localhost:8080/axis2/services/xdsrepositoryb
</Transaction>
<Transaction name="ProvideAndRegisterDocumentSet-b">
https://localhost:8181/axis2/services/xdsrepositoryb
</Transaction>
<!-- This tells the XDS.b Repository what XDS.b Registry to utilize during "Provide and Register".
Refers to /Config/Registry in this file. -->
<Registry>localregistry</Registry>
</Repository>
<!-- Other Repositories ... -->
<Repository name="nistrepository">
<UniqueId>1.19.6.24.109.42.1.5</UniqueId>
<UseSecureEndpoints>true</UseSecureEndpoints> <!-- true to use TLS -->
<Transaction name="RetrieveDocumentSet">
http://ihexds.nist.gov:9080/tf5/services/xdsrepositoryb
</Transaction>
<Transaction name="RetrieveDocumentSet">
https://ihexds.nist.gov:9085/tf5/services/xdsrepositoryb
</Transaction>
<Transaction name="ProvideAndRegisterDocumentSet-b">
http://ihexds.nist.gov:9080/tf5/services/xdsrepositoryb
</Transaction>
<Transaction name="ProvideAndRegisterDocumentSet-b">
https://ihexds.nist.gov:9085/tf5/services/xdsrepositoryb
</Transaction>
</Repository>
<!-- List of XCA gateways ... -->
<!-- Local Initiating Gateway -->
<Gateway name="localig">
<UniqueId>urn:oid:1.3.6.1.4.1.21367.2009.1.2.2020</UniqueId> <!-- Home Community ID -->
<UseSecureEndpoints>true</UseSecureEndpoints> <!-- true to use TLS -->
<Transaction name="RegistryStoredQuery">
http://localhost:8080/axis2/services/xcaig
</Transaction>
<Transaction name="RegistryStoredQuery">
https://localhost:8181/axis2/services/xcaig
</Transaction>
<Transaction name="RetrieveDocumentSet">
http://localhost:8080/axis2/services/xcaig
</Transaction>
<Transaction name="RetrieveDocumentSet">
https://localhost:8181/axis2/services/xcaig
</Transaction>
<!-- In support of XDS Affinity Domain Option -->
<!-- Placed here so the gateway knows where to direct local registry requests.
Refers to /Config/Registry in this file. -->
<Registry>localregistry</Registry>
</Gateway>
<!-- Local Responding Gateway -->
<Gateway name="localrg">
<UniqueId>urn:oid:1.3.6.1.4.1.21367.2009.1.2.2020</UniqueId> <!-- Home Community ID -->
<UseSecureEndpoints>true</UseSecureEndpoints> <!-- true to use TLS -->
<Transaction name="CrossGatewayQuery">
http://localhost:8080/axis2/services/xcarg
</Transaction>
<Transaction name="CrossGatewayQuery">
https://localhost:8181/axis2/services/xcarg
</Transaction>
<Transaction name="CrossGatewayRetrieve">
http://localhost:8080/axis2/services/xcarg
</Transaction>
<Transaction name="CrossGatewayRetrieve">
https://localhost:8181/axis2/services/xcarg
</Transaction>
<!-- In support of XDS Affinity Domain Option -->
<!-- Placed here so the gateway knows where to direct local registry requests.
Refers to /Config/Registry in this file. -->
<Registry>localregistry</Registry>
</Gateway>
<!-- Other Responding Gateways ... -->
<Gateway name="nistrg">
<UniqueId>urn:oid:1.19.6.24.109.42.1.3</UniqueId> <!-- Home Community ID -->
<UseSecureEndpoints>true</UseSecureEndpoints> <!-- true to use TLS -->
<Transaction name="CrossGatewayQuery">
http://ihexds.nist.gov:9080/tf5/services/rg
</Transaction>
<Transaction name="CrossGatewayQuery">
https://ihexds.nist.gov:9085/tf5/services/rg
</Transaction>
<Transaction name="CrossGatewayRetrieve">
http://ihexds.nist.gov:9080/tf5/services/rg
</Transaction>
<Transaction name="CrossGatewayRetrieve">
https://ihexds.nist.gov:9085/tf5/services/rg
</Transaction>
</Gateway>
</Config>
codes.xml
HIEOS registry health codes are specified in the codes.xml file. The contents of this file is utilized to validate that XDS.b Registry meta-data values are consistent with XDS Affinity Domain policy. This file is located at «HIEOS_ROOT»\src\xref\web\codes\codes.xml. After setup and deployment, it is accessible via the http://localhost:8080/xref/codes/codes.xml URL. The location for codes.xml is also specified by the HIEOSxCodesFile environment variable.
Configuration Elements (codes.xml)
The following table summarizes the key configuration elements specified in codes.xml:
| Node | Description | Multiplicity |
|---|---|---|
| ‹CodeType› | Represents a given coding scheme. | 1..* |
| ‹Code› | A code within a given ‹CodeType› coding scheme. | 1..* within a ‹CodeType› |
Example Configuration File (codes.xml)
An example codes.xml file is provided below (many details omitted):
<?xml version="1.0" encoding="UTF-8"?>
<Codes>
<CodeType name="contentTypeCode"
classScheme="urn:uuid:aa543740-bdda-424e-8c96-df4873be8500">
<Code code="Communication" display="Communication"
codingScheme="Connect-a-thon contentTypeCodes"/>
<Code code="Evaluation and management" display="Evaluation and management"
codingScheme="Connect-a-thon contentTypeCodes"/>
<Code code="Conference" display="Conference"
codingScheme="Connect-a-thon contentTypeCodes"/>
<Code code="Case conference" display="Case conference"
codingScheme="Connect-a-thon contentTypeCodes"/>
<Code code="Consult" display="Consult"
codingScheme="Connect-a-thon contentTypeCodes"/>
<Code code="Confirmatory consultation" display="Confirmatory consultation"
codingScheme="Connect-a-thon contentTypeCodes"/>
<!-- Other values omitted. -->
</CodeType>
<CodeType name="classCode"
classScheme="urn:uuid:41a5887f-8865-4c09-adf7-e362475b143a">
<Code code="Consent" display="Consent"
codingScheme="Connect-a-thon classCodes"/>
<Code code="Communication" display="Communication"
codingScheme="Connect-a-thon classCodes"/>
<Code code="Communication" display="Communication"
codingScheme="Connect-a-thon classCodes 2"/>
<Code code="Evaluation and management" display="Evaluation and management"
codingScheme="Connect-a-thon classCodes"/>
<Code code="Conference" display="Conference"
codingScheme="Connect-a-thon classCodes"/>
<!-- Other values omitted. -->
</CodeType>
<CodeType name="confidentialityCode"
classScheme="urn:uuid:f4f85eac-e6cb-4883-b524-f2705394840f">
<!-- The following codes represent policies that may be used as XDS
Metadata ConfidentialityCodes to indicate the policy that must be
followed as defined BPPC options -->
<Code code="1.3.6.1.4.1.21367.2006.7.107" display="Normal Sharing"
codingScheme="Connect-a-thon confidentialityCodes"/>
<Code code="1.3.6.1.4.1.21367.2006.7.109" display="Restricted Sharing"
codingScheme="Connect-a-thon confidentialityCodes"/>
<Code code="1.3.6.1.4.1.21367.2006.7.110" display="Emergency Responder Accessible"
codingScheme="Connect-a-thon confidentialityCodes"/>
<!-- Other values omitted. -->
</CodeType>
<!-- Other CodeType entries omitted. -->
<!-- List of supported mime types. -->
<CodeType name="mimeType">
<Code code="application/pdf" ext="pdf"/>
<!-- used only by ACC, I think, now obsolete
<Code code="text/x-cda-r2+xml"/> -->
<Code code="text/xml" ext="xml"/>
<Code code="application/x-hl7" ext="hl7"/>
<Code code="application/dicom" ext="dicom"/>
<Code code="text/plain" ext="txt"/>
<Code code="multipart/related" ext="mpr"/>
<Code code="image/tiff" ext="tiff"/>
<Code code="image/jpeg" ext="jpeg"/>
<Code code="image/gif" ext="gif"/>
</CodeType>
</Codes>
