Page Comparison

...

refreshInterval: This property is used to configure the scheduled download process. The value is in minutes and default is 1440 (1 day in minutes).
maxNumberOfBackups: This is used to configure the maximum number of backups allowed for exchangeInfo.xml. A value of 1, means that CONNECT will keep only one backup of exchangeInfo.xml. the backup file name will be exchangeInfo.xml.<last-update-timestamp>, for example exchangeInfo.xml.01-02-2018_08-39-11. If this property is missing or has a value of zero, no backup will be created during exchange refresh.
defaultExchange: CONNECT can have more than exchanges in exchangeInfo.xml. defaultExchange holds the name of exchange that is used to look up services with a given HCID. If not defined, then the service are looked based on organization HCID only.This field is mandatory as of CONNECT 5.2+
type: Exchange type is a mandatory element and can have three four values only
1. uddi - indicates an UDDI Web Service Registry
2. fhir - indicates FHIR directory
3. local - indicates your local CONNECT instance
4. overrides - indicates that this exchange should override endpoints specified in another exchange with the same name and HCID.
name: name of an exchange.
url: url for downloading the web services endpoints during a refresh
disabled: if disabled set to true, CONNECT will not download from this exchange. This should be set to true for internal exchanges
lastUpdated: holds the timestamp when the exchange was last refreshed.
certificateAlias: A mandatory element which specifies which certificate alias to use for a given exchange or exchange override. (CONNECT 5.3 only)
sniName: An optional element, if present, is send to responding gateway to initiate an SSL connection. The responding gateway will pick the appropriate certificate, based on sniName, to present for SSL handshake. If absent, responding gateway will use the default certificate for SSL handshake. (CONNECT 5.3 only)

Samples

Code Block

title	exchangeInfo.xml
collapse	true

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<exchangeInfo xmlns="urn:gov:hhs:fha:nhinc:exchange" xmlns:ns2="urn:gov:hhs:fha:nhinc:exchange:directory">
  <refreshInterval>1440</refreshInterval>
  <maxNumberOfBackups>1</maxNumberOfBackups>
  <defaultExchange>Exchange 1</defaultExchange>
  <exchanges>
    <exchange type="uddi">
      <name>Exchange 1</name>
      <url>https://YourUDDIExchangeUrl/</url>
      <disabled>true</disabled>
      <lastUpdated></lastUpdated>
      <organizationList>
        <organization>
          <ns2:name>Gateway 1</ns2:name>
          <ns2:hcid>urn:oid:1.1</ns2:hcid>
          <ns2:endpointList>
            <ns2:endpoint>
              <ns2:name>QueryForDocuments</ns2:name>
              <ns2:endpointConfigurationList>
                <ns2:endpointConfiguration>
                  <ns2:url>https://localhost:8181/Gateway/DocumentQuery/2_0/NhinService/RespondingGateway_Query_Service/DocQuery</ns2:url>
                  <ns2:version>2.0</ns2:version>
                </ns2:endpointConfiguration>
                <ns2:endpointConfiguration>
                  <ns2:url>https://localhost:8181/Gateway/DocumentQuery/3_0/NhinService/RespondingGateway_Query_Service/DocQuery</ns2:url>
                  <ns2:version>3.0</ns2:version>
                </ns2:endpointConfiguration>
              </ns2:endpointConfigurationList>
            </ns2:endpoint>
		  </ns2:endpointList>
        </organization>
      </organizationList>
    </exchange>
    <exchange type="fhir">
      <name>Exchange 2</name>
      <url>https://YourFhirDirectoryServer/Organization/?_format=json</url>
      <disabled>true</disabled>
      <lastUpdated></lastUpdated>
    </exchange>
  </exchanges>
</exchangeInfo>

...

When a request is triggered, CONNECT will scan through the override entries first in locating endpoints. If an entry exists that matches the HCID, service type and spec version*, the corresponding service URL (if defined) will be used as the target endpoint. If no match is made or no service URL is defined, CONNECT will continue with normal endpoint lookup processing. The following is a summary of the override process from a code perspective:

...

*spec version maps to the <version> element in the exchangeInfo.xml and not the <useSpecVersion> element from <nhinTargetCommunities>

Code Block

language	xml
title	Sample exchangeInfo.xml with overrides Exchange Type
collapse	true

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<exchangeInfo xmlns="urn:gov:hhs:fha:nhinc:exchange" xmlns:ns2="urn:gov:hhs:fha:nhinc:exchange:directory">
  <refreshInterval>1440</refreshInterval>
  <maxNumberOfBackups>0</maxNumberOfBackups>
  <defaultExchange>Exchange 1</defaultExchange>
  <exchanges>
    <exchange type="uddi">
	..
    </exchange>
    <exchange type="overrides">
      <url>https://testurl/uddi/list</url>
      <organizationList>
        <organization>
          <ns2:name>Gateway 2</ns2:name>
          <ns2:hcid>urn:oid:2.2</ns2:hcid>
          <ns2:endpointList>
            <ns2:endpoint>
              <ns2:name>QueryForDocuments</ns2:name>
              <ns2:endpointConfigurationList>
                <ns2:endpointConfiguration>
                  <ns2:url>https://<<server-url:port>>/Gateway/DocumentQuery/2_0/NhinService/RespondingGateway_Query_Service/DocQuery</ns2:url>
                  <ns2:version></ns2:version>
                </ns2:endpointConfiguration>
                <ns2:endpointConfiguration>
                  <ns2:url>https://<<server-url:port>>/Gateway/DocumentQuery/3_0/NhinService/RespondingGateway_Query_Service/DocQuery</ns2:url>                  
                </ns2:endpointConfiguration>
              </ns2:endpointConfigurationList>
            </ns2:endpoint>
            <ns2:endpoint>
              <ns2:name>RetrieveDocuments</ns2:name>
              <ns2:endpointConfigurationList>
                <ns2:endpointConfiguration>
                  <ns2:url>https://<<server-url:port>>/Gateway/DocumentRetrieve/2_0/NhinService/RespondingGateway_Retrieve_Service/DocRetrieve</ns2:url>
                  <ns2:version>2.0</ns2:version>
                </ns2:endpointConfiguration>
                <ns2:endpointConfiguration>
                  <ns2:url>https://<<server-url:port>>/Gateway/DocumentRetrieve/3_0/NhinService/RespondingGateway_Retrieve_Service/DocRetrieve</ns2:url>
                  <ns2:version>3.0</ns2:version>
                </ns2:endpointConfiguration>
              </ns2:endpointConfigurationList>
            </ns2:endpoint>
            <ns2:endpoint>
              <ns2:name>PatientDiscovery</ns2:name>
              <ns2:endpointConfigurationList>
                <ns2:endpointConfiguration>
                  <ns2:url>https://<<server-url:port>>/Gateway/PatientDiscovery/1_0/NhinService/NhinPatientDiscovery</ns2:url>
                  <ns2:version>1.0</ns2:version>
                </ns2:endpointConfiguration>
                <ns2:endpointConfiguration>
                  <ns2:url>https://<<server-url:port>>/Gateway/PatientDiscovery/1_0/NhinService/NhinPatientDiscovery</ns2:url>
                  <ns2:version>2.0</ns2:version>
                </ns2:endpointConfiguration>
              </ns2:endpointConfigurationList>
            </ns2:endpoint>
            <ns2:endpoint>
              <ns2:name>DocSubmission</ns2:name>
              <ns2:endpointConfigurationList>
                <ns2:endpointConfiguration>
                  <ns2:url>https://<<server-url:port>>/Gateway/DocumentSubmission/1_1/DocumentRepositoryXDR_Service</ns2:url>
                  <ns2:version>1.1</ns2:version>
                </ns2:endpointConfiguration>
                <ns2:endpointConfiguration>
                  <ns2:url>https://<<server-url:port>>/Gateway/DocumentSubmission/2_0/DocumentRepositoryXDR_Service</ns2:url>
                  <ns2:version>2.0</ns2:version>
                </ns2:endpointConfiguration>
              </ns2:endpointConfigurationList>
            </ns2:endpoint>
          </ns2:endpointList>
          <ns2:targetRegion>US-NY</ns2:targetRegion>
          <ns2:targetRegion>US-VA</ns2:targetRegion>
        </organization>
      </organizationList>
    </exchange>  
 </exchanges>
</exchangeInfo>

Connection Manager to Exchange Manager conversion

...

Versions Compared

Old Version 1

New Version Current

Key

Samples

Connection Manager to Exchange Manager conversion