Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Table of Contents

...

CONNECT is not currently designed for Carequality exchange.

...

Do I need to build CONNECT from source code

...

?

Source Code: https://github.com/CONNECT-Solution/CONNECT

Schema: https://github.com/CONNECT-Solution/Common-Types

WSDL: https://github.com/CONNECT-Solution/CONNECT-Webservices

Do I need to build CONNECT from source code?

You can You can Downloading CONNECT Binaries and Source Code as a pre-compiled binary. Please note that each CONNECT release has its own version of the Admin GUI, which has only been tested for compatibility with those specific CONNECT versions. These CONNECT and Admin GUI files are clearly grouped together on our download page.

How do I install CONNECT?

Depending on which release you wish to build, you can get installation instructions from the following wiki page - Downloading CONNECT Binaries and Source Code as a pre-compiled binary. Please note that each CONNECT release has its own version of the Admin GUI, which has only been tested for compatibility with those specific CONNECT versions. These CONNECT and Admin GUI files are clearly grouped together on our download page.

How do I install CONNECT?

Depending on which release you wish to build, you can get installation instructions from the following wiki page - Downloading CONNECT Binaries and Source Code.  Software requirements and deployment instructions for each application server, binary or source code installation instructions are available through each release link. 

How to do configurable builds?

An in-depth summary can be found here for details on building a customized CONNECT EAR. In short, the EAR is sectioned into various Maven profiles which will add the chosen services into the compiled EAR. If the profile is not specified, it will not be deployed. They are as follows:

...

.  Software requirements and deployment instructions for each application server, binary or source code installation instructions are available through each release link. 

How to do configurable builds?

An in-depth summary can be found here for details on building a customized CONNECT EAR. In short, the EAR is sectioned into various Maven profiles which will add the chosen services into the compiled EAR. If the profile is not specified, it will not be deployed. They are as follows:

  • AD - Admin Distribution
  • PD - Patient Discovery
  • DQ - Document Query
  • DR - Document Retrieve
  • DS - Document Submission
  • DDS - Document Data Submission (Pilot)
  • X12 - Core X12
  • Direct - Direct Core
  • admingui - Administrative GUI *.WAR, and the corresponding web services into the compiled *.EAR.
  • was - Enterprise Application Archive (EAR ) for websphere application server
  • weblogic - Enterprise Application Archive (EAR ) for weblogic application server 
  • jboss7 - Enterprise Application Archive (EAR ) for Jboss EAP 7 and wildfly application server.

How can I switch from MySQL to Oracle database?

...

For more information, please see FAQ from HL7: https://wiki.hl7.org/index.php?title=HL7_OID_Registry_Frequently_Asked_Questions

General:

What are the different layers of CONNECT, and how are they used?

  • Entity - Internal endpoints used to construct NwHin requests to be sent to an external Gateway via NwHin endpoints.
  • NwHin - Endpoints that will be hit from an external gateway. This is the crossover point between the Initiating and Responding gateways. For the Initiating gateways, this will be an outbound request to another implementor. For the Responder, this will be an inbound request in which the gateway is expected to process and respond to the request by calling its Adapter.
  • Adapter - Implementor specific components which will serve as the communication layers between CONNECT and the proprietary databases,architecture, and services of the implementor. These get called by CONNECT through the NwHin layer when the gateway in question is a responder to a request.

What are these beans defined in the proxy property files for each service?

Each service may have a respective property file to configure a proxy to be used when communicating with a service. By default, there may be up to four pre-configured beans: NoOp, Java, Secured and Unsecured beans.

  • NoOp - Will always return a successful invocation, or a blank response - depending on the expected context of the bean. Does not invoke any web services or call any methods.
  • Java - Will use pure java calls to CONNECT code, can be substituted for any java class compiled with the CONNECT EAR, including custom Entity, NwHin, and Adapter implementations
  • Secured - Will use a secured port to communicate to a given endpoint configured via the internalExchangeInfo.xml file.
  • Unsecured - will use an unsecured port to communicate to a given endpoint configured via the internalExchangeInfo.xml file.

What is the difference between Standard and Passthrough Modes?

Currently, the CONNECT gateway is designed to operate in two modes, entity (standard) and passthrough. Entity (Standard) allows for further processing by the gateway including policy checks, mpi queries, and fan-out capabilities. Passthrough sends the message directly from gateway to adapter and vice versa. 

When downloading CONNECT SOURCE, there are lots of repeats like DocumentSubmission_10, DocumentSubmission_20, etc. Are they different versions?

CONNECT supports both 2010 and Summer 2011 Nationwide Health Information Network specifications. . The 20, 10 etc. suffix is used to indicate the spec version for any service and is dependent on the service.

Information on the design can be found in 'UDDI-Based Backwards Compatibility'
There is a document link in the wiki page above that has details.(This feature was introduced in Release 3.3)

Also a list of the interfaces can be found at - Service Interfaces

What is the Admin GUI, and how can I use it?

Admin GUI is front-end user application. It is meant to serve as an extension to CONNECT in order to manage the gateway, certificates, properties, and perform basic queries for information about the gateway. Admin GUI is also capable of serving a cross query client, as well as an interface for viewing Audit and Failure logs. Admin GUI may be deployed either on the same servlet container, as well as on a different server entirely (There may be some additional setup steps in order to configure your Admin GUI onto an external server).

A full user manual on the Admin GUI can be found here.

Is there documentation of the fields in the drop-down menu lists?

The contents of the drop-down menus are configurable. They currently come from a properties file in CONNECT. The NHIN specification team has defined what code sets they come from. When you install CONNECT you can see the list, but again that is configurable.

How do I configure my own Entity, NwHIN, and Adapter processors?

Injection points into CONNECT are controlled by Spring Bean lookups. Injection can be done in one of 2 ways: Java or Web Services.

For Java injections, simply point the bean for the service you wish to replace in its respective property file to your custom implementation. For example, to change the Document Submission Adapter, the "adapterdocsubmission" alias inside the DocumentSubmissionProxyConfig.xml file would be changed to your custom bean. By default, there are example beans for most services with the "java" postfix - in this case "adapterdocsubmissionjava". This pre-defined bean may be repurposed by changing the "class" to your own java class file.

...

Where is the CONNECT source code repository?

Source Code: https://github.com/CONNECT-Solution/CONNECT

Schema: https://github.com/CONNECT-Solution/Common-Types

WSDL: https://github.com/CONNECT-Solution/CONNECT-Webservices

General:

How do I configure my own Entity, NwHIN, and Adapter processors?

Injection points into CONNECT are controlled by Spring Bean lookups. Injection can be done in one of 2 ways: Java or Web Services.

For Java injections, simply point the bean for the service you wish to replace in its respective property file to your custom implementation. For example, to change the Document Submission Adapter, the "adapterdocsubmission" alias inside the DocumentSubmissionProxyConfig.xml file would be changed to your custom bean. By default, there are example beans for most services with the "java" postfix - in this case "adapterdocsubmissionjava". This pre-defined bean may be repurposed by changing the "class" to your own java class file.

For webservice injections, the bean alias would be set to either the secure or unsecure beans already defined in the respective XML file. Instead of injecting a custom java class, the appropriate endpoint inside of the internalExchangeInfo.xml file must be changed to point to the URL of where your custom service is deployed. As an example, if we wanted to change the Document Submission Adapter endpoint, we would find the "adapterxdrsecured" service name (Or "adapterxdr" if you are using an unsecured service) and change its URL to point to the custom service. It should be noted that these custom services must implement their respective WSDLs

Is there documentation of the fields in the drop-down menu lists?

The contents of the drop-down menus are configurable. They currently come from a properties file in CONNECT. The NHIN specification team has defined what code sets they come from. When you install CONNECT you can see the list, but again that is configurable.

What is the Admin GUI, and how can I use it?

Admin GUI is front-end user application. It is meant to serve as an extension to CONNECT in order to manage the gateway, certificates, properties, and perform basic queries for information about the gateway. Admin GUI is also capable of serving a cross query client, as well as an interface for viewing Audit and Failure logs. Admin GUI may be deployed either on the same servlet container, as well as on a different server entirely (There may be some additional setup steps in order to configure your Admin GUI onto an external server).

A full user manual on the Admin GUI can be found here.

What is the difference between Standard and Passthrough Modes?

Currently, the CONNECT gateway is designed to operate in two modes, entity (standard) and passthrough. Entity (Standard) allows for further processing by the gateway including policy checks, mpi queries, and fan-out capabilities. Passthrough sends the message directly from gateway to adapter and vice versa. 

What are the different layers of CONNECT, and how are they used?

  • Entity - Internal endpoints used to construct NwHin requests to be sent to an external Gateway via NwHin endpoints.
  • NwHin - Endpoints that will be hit from an external gateway. This is the crossover point between the Initiating and Responding gateways. For the Initiating gateways, this will be an outbound request to another implementor. For the Responder, this will be an inbound request in which the gateway is expected to process and respond to the request by calling its Adapter.
  • Adapter - Implementor specific components which will serve as the communication layers between CONNECT and the proprietary databases,architecture, and services of the implementor. These get called by CONNECT through the NwHin layer when the gateway in question is a responder to a request.

What are these beans defined in the proxy property files for each service?

Each service may have a respective property file to configure a proxy to be used when communicating with a service. By default, there may be up to four pre-configured beans: NoOp, Java, Secured and Unsecured beans.

  • NoOp - Will always return a successful invocation, or a blank response - depending on the expected context of the bean. Does not invoke any web services or call any methods.
  • Java - Will use pure java calls to CONNECT code, can be substituted for any java class compiled with the CONNECT EAR, including custom Entity, NwHin, and Adapter implementations
  • Secured - Will use a secured port to communicate to a given endpoint configured via the internalExchangeInfo.xml file.
  • Unsecured - will use an unsecured port to communicate to a given endpoint configured via the internalExchangeInfo.xml file.

When downloading CONNECT SOURCE, there are lots of repeats like DocumentSubmission_10, DocumentSubmission_20, etc. Are they different versions?

CONNECT supports both 2010 and Summer 2011 Nationwide Health Information Network specifications. . The 20, 10 etc. suffix is used to indicate the spec version for any service and is dependent on the service.

Information on the design can be found in 'UDDI-Based Backwards Compatibility'
There is a document link in the wiki page above that has details.(This feature was introduced in Release 3.3)

Also a list of the interfaces can be found at - Service Interfaces

Exchange:

Can I override exchange's partners endpoints locally?

...