Health Care Organizations
| Product | D&B Data Exchange |
| Data Provider | StratCenter |
| Product Code(s) | n/a |
| Level(s) | n/a |
| Monitoring Available | No |
| Interface | REST |
| Method | POST |
| Format(s) | JSON, XML |
| Service | DataExchange |
| {version} | 1.0 |
| Initial Release | September 30, 2014 |
This feature provides information such as Healthcare facility type (Acute care, Dialysis Center, Ob/Gyn etc.), primary type of business as reported to Centers for Medicare & Medicaid Services, and facility's members in GPO, IDN, and ACO networks. Additionally, information regarding the facility's active listing on a GPO participation roster is available.
The Select operation is suggested to be used when request detailed information on particular organizations.
The Search operation is suggested to be used when searching for specific organizations based on search criteria.
The GeoSearch operation is suggested to be used when searching for specific organizations based on search criteria and within a distance of a _______.
IMPORTANT: Please note all Data Exchange APIs are decommissioned.
Update History
No modifications have been made to this data layer since the initial release.
Feature Request
IMPORTANT: Please see the new Online Services Security Enhancement Release, effective November 09, 2020.
Overview
When requesting this D&B Data Exchange feature, [OPTIONS]
Global Availability
This data layer is only available for businesses domiciled in the United States.
Data Layer Entitlement
For customers in U.S. and Canadian markets, the API is provisioned for specific collections of products, reports, and/or features (collectively referred to as data layers) for production and trial usage. Entitlement is not required for testing in the sandbox environment.
- This feature is entitled as "Data Exchange" for D&B Direct 2.0 customers.
For customers in the UK, Ireland, Belgium, Netherlands and Luxembourg markets, the API is provisioned as a specific set of data layers for production, trial, and sandbox usage.
- This particular data layer is NOT included in the D&B Direct Onboard suite.
Data Exchange Request Setup
D&B Direct specific request parameters are submitted to D&B Data Exchange service requests in the HTTP Header. Partner specific request parameters are submitted in the URL (GET) or body (POST).
GET/POST/PUT/DELETE https://direct.dnb.com/dataexchange/{PartnerIndentifier}/{Partners’s URI}?{Partner’s Query Parameters}
ApplicationTransactionID: <Transaction ID assigned by the customer>
Accept: application/json
Authorization: <Customer’s Authentication Token>
ArchiveProductOptOutIndicator: <true/false>
ExtendArchivePeriodIndicator: <true/false>
Content-Type: application/json
[BODY]
<Partner Request (POST only)>GET https://direct.dnb.com/dataexchange/profound/domain/abbott.com Authorization: <MyToken> ApplicationTransactionID: ID_001 ArchiveProductOptOutIndicator: false ExtendArchivePeriodIndicator: false CustomerReferenceText: Order placed by Joe CustomerBillingEndorsementText: Order placed by Joe for abbot.com
NOTE: This feature will return an XML response if the Content-Type is specified as application/xml.
Specification
http://10.162.236.116:80//dataexchange/hds/rest/OrganizationSelect Autherization: <<MyToken>>
http://10.162.236.116:80//dataexchange/hds/rest/ProviderGeoSearch Autherization: <<MyToken>>
http://10.162.236.116:80//dataexchange/hds/rest/OrganizationGeoSearch Autherization: <<MyToken>>
| Name | Characteristics |
|---|---|
| CompanyIDs | integer, optional (unlimited) |
| DUNSNumbers | string, optional (unlimited) |
| UserTransactionId | string, optional |
{
"CompanyIds": [
231613,
563
],
"DUNSNumbers": [
"829209258",
"130073708 "
],
"UserTransactionId": "12345"
}
Endpoint
For each D&B Data Exchange partner operations, a partner identifier and URI are appended to a standard Data Exchange REST URL. As a result of this approach, there may be instances where a partner URI contains version information that is different from the D&B Data Exchange version.
Use the following endpoint for requesting this feature.
| SEL | SEA | GEO | REST (DataExchange) |
|---|---|---|---|
| Y | POST https://direct.dnb.com/dataexchange/hds/rest/OrganizationSelect | ||
| Y | POST https://direct.dnb.com/dataexchange/hds/rest/OrganizationSearch | ||
| Y | POST https://direct.dnb.com/dataexchange/hds/rest/OrganizationGeoSearch |
Testing
This operation is currently unavailable in the D&B Direct sandbox (test) environment.
Feature Response
Specification
NOTE: The information returned from this Data Exchange feature will not be presented in the product canonical model used by other D&B Direct services.
The following is a list of the possible data fields returned by this operation.
NOTE: The D-U-N-S Number returned in the response will be a nine-digit zero-padded, numeric value.
{
"TransactionId": "9022a125-f422-4c7c-b4e8-d93cae1e5ee7",
"Count": 4,
"Organizations": [
{
"CompanyId": 344259,
"CompanyName": "Temecula Vlly Day Surgery-Pain Therapy Center",
"Address1": "25495 Medical Center Dr Ste 101",
"City": "Murrieta",
"State": "CA",
"Zip": "92562",
"Phone": "9512007777",
"CompanyTypeParentCompanyTypeName": "Surgery Centers",
"CompanyTypeName": "Ambulatory/Outpatient Surgery Center (ASC)",
"SystemParentCompany": "Universal Health Services, King Of Prussia, PA [68243] - Own",
"DUNS": "030339604",
"Distance": 35.68
},
{
"CompanyId": 42927,
"CompanyName": "Menifee Valley Medical Center",
"Address1": "28400 Mccall Blvd",
"City": "Sun City",
"State": "CA",
"Zip": "92585",
"Phone": "9516798888",
"CompanyTypeParentCompanyTypeName": "Hospitals / Short-Term Acute Care",
"CompanyTypeName": "Hospital, Acute (Gen'l Med/Surg)",
"SystemParentCompany": "Physicians For Healthy Hospitals, Hemet, CA [69536] - Own",
"DUNS": "602083891",
"Distance": 43.22
},
{
"CompanyId": 308339,
"CompanyName": "Moreno Valley Family Health Center",
"Address1": "22675 Alessandro Blvd Ste 1",
"City": "Moreno Valley",
"State": "CA",
"Zip": "92553",
"Phone": "9515712300",
"CompanyTypeParentCompanyTypeName": "Multiplex Facilities",
"CompanyTypeName": "Federally Qualified Health Ctr",
"DUNS": "139594261",
"Distance": 43.83
},
{
"CompanyId": 78605,
"CompanyName": "Premier Outpatient Surgery Center",
"Address1": "900 E Washington St Ste 155",
"City": "Colton",
"State": "CA",
"Zip": "92324",
"Phone": "9093702190",
"CompanyTypeParentCompanyTypeName": "Surgery Centers",
"CompanyTypeName": "Ambulatory/Outpatient Surgery Center (ASC)",
"DUNS": "023377794",
"Distance": 46.63
}
]
}
Data Exchange Response Delivery
D&B Direct specific fields are returned in D&B Data Exchange service responses via the HTTP Header. D&B Direct error information will be returned in case of the following scenarios – Failure to connect to Partner; Authentication / entitlement failure for the user -- and the Partner response will not be returned.
ApplicationTransactionID: <ID passed in request> DNB-ServiceTransactionID: <ID assigned by the Service> DNB-ResultID: <PCM Result Code> DNB-ResultText: <PCM Result Text> DNB-PortfolioAssetID: <Portfolio Asset ID> [BODY] <Partner Response (JSON/XML/SOAP)>
HTTP/1.1 200 OK
ApplicationTransactionID: ID_001
CustomerBillingEndorsementText: Order placed by Joe for abbot.com
CustomerReferenceText: Order placed by Joe
Date: Tue, 12 Nov 2013 15:54:00 GMT
DNB-PortfolioAssetID: 36590291
DNB-ResultID: CM000
DNB-ResultText: success
DNB-ServiceTransactionID: Id-4d7cd8c752824f1822fb470b
{"domain":"abbott.com","country_code":"US","datestamp":20130303,"company_name":"Abbott Laboratories","duns":"001307602","url":"http://www.abbott.com/","view":"basic"}
Response Codes & Error Handling
Responses from this Data Exchange feature will return a D&B response code, along with a partner response code, unless the partner service is not accessible at the time of the request.
Successful service requests will return a CM000 response code in the DNB-ResultID header field. Otherwise, one of the D&B Direct standard response codes will be returned.
This operation may return the following response codes: CM004, SC001-SC009.
NOTE: When a CM004 response code is received, the HTTP status code will be the value returned by the Data Exchange partner.
D&B Direct 2.0 API requests are provided on a metered basis; and may require entitlement prior to use in the production environment. In addition, a concurrency limit (QPS) is monitored to ensure that it is not exceeded. An error code will be returned in the event that a transaction is throttled.
Qualified usage (e.g., a successful response) is tracked and billed according to the terms & conditions of the customer's contract. The response code CM000 is considered successful. A built-in feature exists to prevent duplicate billing when multiple successful feature requests with the same D-U-N-S Number are submitted on the same calendar day (which is based on Eastern Standard Time [GMT-5]).
Feature Notes
This will return information on the organizations requested limited to the fields included in the customer’s configuration. Only populated data members that are enabled in the active layout will be included for each record returned in the response.
This D&B Data Exchange feature will pass-thru the partner HTTP status code whenever a CM004 error is delivered in the DNB-ResultID header field. The following are the possible values from this partner.
- 403 Invalid Access
- © Dun & Bradstreet, Inc. 2019 – 2024. All rights reserved.