Service Interfaces
- Patrick Lobre (Unlicensed)
- Eric McDonald (Unlicensed)
Interface Description Document
The Interface Description Document contains a description of the externally facing WSDL and Schema files for the CONNECT Gateway and Adapter interfaces.
With multiple specification compliance the version of the specification supported is now included in the context root (the location of the web-service). This helps integration in a multiple supported specification environment by decoupling the the context root from the connect release version.Â
Below is a table gateway interfaces (including NHIN and Entity interfaces) and their corresponding context roots.
NwHIN Specification | Ver. | Context Root |
|---|---|---|
Administrative Distribution | 1.0 | /Gateway/AdminDistribution/1_0 |
Administrative Distribution | 2.0 | /Gateway/AdminDistribution/2_0 |
Document Submission | 1.1.0 | /Gateway/DocumentSubmission/1_1 |
Document Submission | 2.0 | /Gateway/DocumentSubmission/2_0 |
Patient Discovery | 1.0.0.7 | /Gateway/PatientDiscovery/1_0 |
Patient Discovery | 2.0 | /Gateway/PatientDiscovery/1_0 |
Query for Documents | 2.0 | /Gateway/DocumentQuery/2_0 |
Query for Documents | 3.0 | /Gateway/DocumentQuery/2_0 |
Retrieve Documents | 2.0 | /Gateway/DocumentRetrieve/2_0 |
Retrieve Documents | 3.0 | /Gateway/DocumentRetrieve/3_0 |
| Core X12 Document Submission | 1.0 | /Gateway/CORE_X12DocumentSubmission/1_0 |
| Patient Location Query [1] | 1.0 | /Gateway/PatientDiscovery/1_0/ |
Document Data Submission [2] | 1.0 | /Gateway/DocumentDataSubmission/1_0/ |
Another introduction with multiple specification compliance is a de-coupling of adapter versions to gateway version. Each adapter has an API version associated with. This helps to insulate changes when upgrading. Below is a table describing the relationship between the specification version and the adapter API level.
NwHIN Specification | Ver. | Context Root |
|---|---|---|
Administrative Distribution | 1.0 | /Adapter/AdminDistribution/A_0 |
Administrative Distribution | 2.0 | /Adapter/AdminDistribution/A_0 |
Document Submission | 1.1.0 | /Adapter/DocumentSubmission/A_0 |
Document Submission | 2.0 | /Adapter/DocumentSubmission/A_0 |
Patient Discovery | 1.0.0.7 | /Adapter/PatientDiscovery/A_0 |
Patient Discovery | 2.0 | /Adapter/PatientDiscovery/A_0 |
Query for Documents | 2.0 | /Adapter/DocumentQuery/A_0 |
Query for Documents | 3.0 | /Adapter/DocumentQuery/A_0 |
Retrieve Documents | 2.0 | /Adapter/DocumentRetrieve/A_0 |
Retrieve Documents | 3.0 | /Adapter/DocumentRetrieve/A_1 |
| Core X12 Document Submission | 1.0 | /Adapter/CORE_X12DocumentSubmission/A_0 |
| Patient Location Query [1] | 1.0 | /Adapter/PatientDiscovery/A_0/ |
Document Data Submission [2]Â | 1.0 | /Adapter/DocumentDataSubmission/A_0/ |
Description of Attachments
File Name | Description |
|---|---|
The table below lists all of the public WSDL Interfaces currently supported by the Federal Gateway. |
 1.The NwHIN interface for PatientLocationQuery is defined in the NhinPatientDiscovery as both services share the same namespace and hence the same context root for NwHIN and Adapter interfaces.
2. Document Data Submission is a pilot feature not build by default.
CONNECT Gateway WSDL InterfacesÂ
The table below lists all of the public WSDL Interfaces currently supported by the Federal Gateway. Included is the name of each WSDL, the services it handles, and whether or not it is SSL. The SSL column would indicate if the service is available on the given application server's HTTP (SSL - No) or HTTPS (SSL - Yes) port.
WSDL | Services | SSL |
|---|---|---|
AdapterAdminDist | Admin Distribution | No |
AdapterAdminDistSecured | Admin Distribution secured | Yes |
AdapterDocQuery | Document Query | No |
AdapterDocQuerySecured | Document Query | Yes |
AdapterDocRetrieve | Document Retrieve | No |
AdapterDocRetrieveSecured | Document Retrieve | Yes |
AdapterPatientDiscovery | Patient Discovery - Synchronous | No |
AdapterPatientDiscoverySecured | Patient Discovery - Synchronous | Yes |
AdapterPatientDiscoveryAsyncReq | Patient Discovery - Deferred | No |
AdapterPatientDiscoverySecuredAsyncReq | Patient Discovery - Deferred | Yes |
AdapterPatientDiscoveryAsyncReqError | Patient Discovery - Deferred | No |
AdapterPatientDiscoverySecuredAsyncReqError | Patient Discovery - Deferred | Yes |
AdapterPatientDiscoveryAsyncReqQueue | Patient Discovery - Deferred | No |
AdapterPatientDiscoverySecuredAsyncReqQueue | Patient Discovery - Deferred | Yes |
AdapterPatientDiscoveryAsyncResp | Patient Discovery - Deferred | No |
AdapterPatientDiscoverySecuredAsyncResp | Patient Discovery - Deferred | Yes |
AdapterComponentXDR | Document Submission - Synchronous | No |
AdapterComponentXDRSecured | Document Submission - Synchronous | Yes |
AdapterXDR | Document Submission | No |
AdapterXDRSecured | Document Submission | Yes |
AdapterXDRRequest | Document Submission - Deferred | No |
AdapterXDRRequestSecured | Document Submission - Deferred | Yes |
AdapterXDRRequestError | Document Submission - Deferred | No |
AdapterXDRRequestSecuredError | Document Submission - Deferred | Yes |
AdapterXDRResponse | Document Submission - Deferred | No |
AdapterXDRResponseSecured | Document Submission - Deferred | Yes |
| AdapterCORERule2.2.0RealTime | X12 Real Time v1.0 | No |
| AdapterCORERule2.2.0RealTimeSecured | X12 Real Time v1.0 | Yes |
| AdapterCORERule2.2.0GenericBatch | X12 Generic Batch v1.0 | No |
| AdapterCORERule2.2.0GenericBatchSecured | X12 Generic Batch v1.0 | Yes |
EntityAdminDist | Admin Distribution v1.0 | No |
EntityAdminDist_g1 | Admin Distribution v2.0 | No |
EntityAdminDistSecured | Admin Distribution v1.0 | Yes |
EntityAdminDistSecured_g1 | Admin Distribution v2.0 | Yes |
EntityDocQuery | Document Query | No |
EntityDocQuerySecured | Document Query | Yes |
EntityDocRetrieve | Document Retrieve | No |
EntityDocRetrieveSecured | Document Retrieve | Yes |
EntityPatientDiscovery | Patient Discovery - Synchronous | No |
EntityPatientDiscoverySecured | Patient Discovery - Synchronous | Yes |
EntityPatientDiscoveryAsyncReq | Patient Discovery - Deferred | No |
EntityPatientDiscoverySecuredAsyncReq | Patient Discovery - Deferred | Yes |
EntityPatientDiscoveryAsyncReqQueue | Patient Discovery - Deferred | No |
EntityPatientDiscoverySecuredAsyncReqQueue | Patient Discovery - Deferred | Yes |
EntityPatientDiscoveryAsyncResp | Patient Discovery - Deferred | No |
EntityPatientDiscoverySecuredAsyncResp | Patient Discovery - Deferred | Yes |
EntityXDR | Document Submission - Synchronous | No |
EntityXDRSecured | Document Submission - Synchronous | Yes |
EntityXDRRequest | Document Submission -Deferred | No |
EntityXDRSecuredRequest | Document Submission -Deferred | Yes |
EntityXDRResponse | Document Submission -Deferred | No |
EntityXDRSecuredResponse | Document Submission -Deferred | Yes |
| EntityCORERule2.2.0RealTime | X12 Real Time v1.0 | No |
| EntityCORERule2.2.0RealTimeSecured | X12 Real Time v1.0 | Yes |
| EntityCORERule2.2.0GenericBatch | X12 Generic Batch v1.0 | No |
| EntityCORERule2.2.0GenericBatchSecured | X12 Generic Batch v1.0 | Yes |
NhinAdminDist | Admin Distribution v1.0 | Yes |
NhinAdminDist_g1 | Admin Distribution v2.0 | Yes |
NhinDocQuery | Document Query | Yes |
NhinDocRetrieve | Document Retrieve | Yes |
NhinPatientDiscovery | Patient Discovery - Synchronous | Yes |
NhinPatientDiscoveryDeferredRequest | Patient Discovery - Deferred | Yes |
NhinPatientDiscoveryDeferredResponse | Patient Discovery - Deferred | Yes |
NhinXDR | Document Submission - Synchronous | Yes |
NhinXDRDeferredRequest | Document Submission -Deferred v1.1 | Yes |
NhinXDRDeferredRequest20 | Document Submission -Deferred v2.0 | Yes |
NhinXDRDeferredResponse | Document Submission -Deferred v1.1 | Yes |
NhinXDRDeferredResponse20 | Document Submission -Deferred v2.0 | Yes |
| CORERule2.2.0RealTime | X12 Real Time v1.0 | Yes |
| CORERule2.2.0GenericBatch | X12 Generic Batch v1.0 | Yes |
| EntityPatientLocationQuerySecured | Patient Location Query v1.0 | Yes |
| EntityPatientLocationQuery | Patient Location Query v1.0 | No |
| AdapterPatientLocationQuerySecured | Patient Location Query v1.0 | Yes |
| AdapterPatientLocationQuery | Patient Location Query v1.0 | No |
| NhinPatientDiscovery | Patient Location Query v1.0 | Yes |
| AdapterDDSSecured | Document Data Submission v1.0 | Yes |
| AdapterDDS | Document Data Submission v1.0 | No |
| EntityDDSSecured | Document Data Submission v1.0 | Yes |
| EntityDDS | Document Data Submission v1.0 | No |
| NhinDDS | Document Data Submission v1.0 | Yes |