Loading

Direct 2.0
Collapse

Health Care Organizations

ProductD&B Data Exchange
Data ProviderStratCenter
Product Code(s)n/a
Level(s)n/a
Monitoring AvailableNo
InterfaceREST
MethodPOST
Format(s)JSON, XML
ServiceDataExchange
{version}1.0
Initial ReleaseSeptember 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 _______.

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 December 14, 2018.

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)>
Example
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

Sample Request (Select)
http://10.162.236.116:80//dataexchange/hds/rest/OrganizationSelect
Autherization: <<MyToken>>
Sample Request (Search)
http://10.162.236.116:80//dataexchange/hds/rest/ProviderGeoSearch
Autherization: <<MyToken>> 
Sample Request (GeoSearch)
http://10.162.236.116:80//dataexchange/hds/rest/OrganizationGeoSearch
Autherization: <<MyToken>> 
Select (OrganizationSelectRequest object)
Name Characteristics
CompanyIDsinteger, optional (unlimited)
DUNSNumbersstring, optional (unlimited)
UserTransactionIdstring, optional
{
	"CompanyIds":    [
	231613,
	563
	],
	"DUNSNumbers":    [
	"829209258",
	"130073708 "
	],
	"UserTransactionId": "12345"
}
Search (OrganizationSearchRequest object)
Name Usage Data Type Exact Starts With Fuzzy
[DUNS] Optional string x

ACOCompanyName Optional string x
x
ACOID Optional string X

Address1 Optional string x

City Optional string x

CompanyID Optional int x

CompanyName Optional string x x x
CompanyTypeConceptId Optional string x

CompanyTypeName Optional string x

CompanyTypeParentCompanyTypeName Optional string x

EHR_Indicator Optional string x

EHR_Vendor Name Optional string
x x
Fax Optional string x

GLN Optional string x

GLNBillTo Optional string x

GLNDeliverTo Optional string x

GLNShipTo Optional string x

GLNSingle Optional string x

GPOAmerinet Optional string x

GPOHPG Optional string x

GPOMedAssets Optional string x

GPONovation Optional string x

GPOPremier Optional string x

GroupId Optional
x

GroupName Optional string x x x
HIN Optional string x

HINSingle Optional string x

IDNCompanyName Optional string x
x
IDNId Optional string x

NPI2 Optional string x

Parent1CompanyName Optional string x
x
Parent1CompanyTypeName Optional string x

Parent1Id Optional string x

Parent2CompanyName Optional string x
x
Parent2Id Optional string x

Parent3CompanyName Optional string x
x
Parent3Id Optional string


Parent4CompanyName Optional string x
x
Parent4Id Optional string


Phone Optional string x

Practice_Medicare_ID Optional string x

SiteSpecialtyCategory Optional string x
x
State Optional string x

SystemParentCompanyName Optional string x
x
SystemParentId Optional string x

Zip Optional string x

GeoSearch (OrganizationGeoSearchRequest object)
Name Usage Data Type Exact Starts With Fuzzy
ACOCompanyName Optional string x
x
City Optional string x

CompanyName Optional string x x x
Distance Optional string


EHR_Indicator Optional string x

EHR_Vendor Name Optional string
x x
GPOAmerinet Optional string x

GPOHPG Optional string x

GPOMedAssets Optional string x

GPONovation Optional string x

GPOPremier Optional string x

GroupName Optional string x x x
KeyMetricNumBedsMax Optional int


KeyMetricNumBedsMin Optional int


Latitude Optional string


Longitude Optional string


Parent1CompanyName Optional string x
x
ParentCompanyName Optional string


SiteSpecialtyCategory Optional string x
x
State Optional string x

Zip Optional string x

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.

SELSEAGEOREST (DataExchange)
Y  POST https://direct.dnb.com/dataexchange/hds/rest/OrganizationSelect
 Y POST https://direct.dnb.com/dataexchange/hds/rest/OrganizationSearch
  YPOST 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.

Sample Response
{
   "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
      }
   ]
}
Name Characteristics
CompanyID integer

Unique numerical identifier assigned to the company

CompanyName string

The legal name of the company

Address1 string
Address2 string
City string
State string
Zip string
Phone string
Fax string
CountyName string
MetroName string
CompanyTypeConceptId string

Numerical identifier for class of trade

CompanyTypeParentCompanyTypeName string

Grouping of similar class of trades (e.g. Company Type parent of Hospitals will include Med/Surg, Children’s, and Academic Hospitals)

CompanyTypeName string

Class of trade name (e.g., hospital, imagining facility)

CompanyinfoHSCURL string

a hyperlink to www. http://healthcaresupplychain.com that provides more detail for this record

CompanyinfoOscarURL string

a hyperlink to www.StratCenter.com that provides more detail for this record

OfficeSize string

Number of Providers in the Office

EmployeeSize string

Number of Employees at Site

SalesVolume string

Total Predicited Sales for a Practice

SiteSpecialtyCategoryCode string

Code describing the Aggregate Specialty of a site

SiteSpecialtyCategory string

Aggregate Specialty of a site determined by specialties of providers

GPOAmerinet string

Y indicates that this company is a member of Amerinet

GPOHPG string

Y indicates that this company is a member of HealthTrust

GPOMedAssets string

Y indicates that this company is a member of MedAssets

GPONovation string

Y indicates that this company is a member of Novation

GPOPremier string

Y indicates that this company is a member of Premier Inc

GroupId

Unique Identifier for the Group of Practices

GroupName string

Name of the Group of Practices

SystemParentId string

Unique numerical identifier for the Corporate parent of this facility. There may be multiple parents listed (parent 1..4) with different relationships (e.g., owned, managed, leased, etc.). This System parent is the Corporate parent.

SystemParentCompanyName string

The Company Name that corresponds to the Company defined by System parent_StratCenterID

IDNCompanyName string

The name of the IDN (or geographical cluster) that this facility is grouped with

IDNId string

Unique numerical identifier for the IDN

Parent1Id string

Numerical identifier for the company’s parent

Parent1CompanyName string

Name of parent Company

Parent1Size string

Total Number of Providers at all Child Companies for parent 1

Parent1CompanyCity string

City where parent Company is located

Parent1CompanyRegion string

State where parent Company is located

Parent1RelationshipTypeName string

Relationship type between parent and Child companies

Parent1CompanyTypeName string

Name of parent Company

Parent2Id string

Numerical identifier for the company’s parent

Parent2CompanyName string

Name of parent Company

Parent2Size string

Total Number of Providers at all Child Companies for parent2

Parent2CompanyCity string

City where parent Company is located

Parent2CompanyRegion string

State where parent Company is located

Parent2RelationshipTypeName string

Relationship type between parent and Child companies

Parent2CompanyTypeName string

Relationship type between and Child companies

Parent3Id string

Numerical identifier for the company’s parent

Parent3CompanyName string

Name of parent Company

Parent3Size string

Total Number of Providers at all Child Companies for parent3

Parent3CompanyCity string

City where parent Company is located

Parent3CompanyRegion string

State where parent Company is located

Parent3RelationshipTypeName string

Relationship type between parent and Child companies

Parent3CompanyTypeName string

parent’s Class of Trade/Company Type

Parent4Id string

Numerical identifier for the company’s parent

Parent4CompanyName string

City where parent Company is located

Parent4Size string

Total Number of Providers at all Child Companies for parent4

Parent4CompanyCity string

City where parent Company is located

Parent4CompanyRegion string

State where parent Company is located

Parent4RelationshipTypeName string

Relationship type between parent and Child companies

Parent4CompanyTypeName string

parent’s Class of Trade/Company Type

ACOID string

Numerical Identifier for this company

ACOCompanyName string

Name of ACO

ACOCompanyCity string

City where ACO is located

ACOCompanyRegion string

State where ACO is located

ACORelationshipTypeName string

Type of relationship between ACO and child company

KeyMetricNumStates string

The total number of states where the parent company has children facilities

KeyMetricNumAllChildren string

The total number of facilities controlled  by the parent company

KeyMetricNumHosp string

The total number of hospitals controlled  by the parent company

KeyMetricNumAltCare string

The total number of alternate care (non-hospital) facilities controlled  by the parent company

KeyMetricNumAdmis string

The total number of admissions for all facilities controlled by the parent company

KeyMetricNumOPVisits string

The total number of outpatient for all facilities controlled by the parent company

KeyMetricNumOR string

Number of Operating Rooms in this child faciltiy

KeyMetricNumSystemsChainsIDNs string

The total number of IDNs controlled by this parent Company

KeyMetricNumHHAHospice string

The total number of Home Health and Hospices  that are controlled by the parent  company

KeyMetricNumASC string

The total number of Ambulatory Surgery Centers  that are controlled by the parent  company

KeyMetricNum_Multiplex_Facil string

The total number of Physician Sites controlled by the parent Company

KeyMetricNumImaging string

The total number of Diagnostic Imaging Centers  that are controlled by the parent  company

KeyMetricNumDialysis string

The total number of Dialyisis Centers  that are controlled by the parent  company

KeyMetricNumLTC string

The total number of Long Term Care facilities  that are controlled by the parent  company

KeyMetricNumLab string

The total number of Long Term Care facilities that are controlled by the parent company

KeyMetricNumSpecHospitals string

The total number of Specialty Hospitals that are controlled by the parent company

KeyMetricNumPharmacy string

The total number of Pharmacies that are controlled by the parent company

KeyMetricNumAnimal string

The total number of Animal Health facilities that are controlled by the parent company

KeyMetricNumCancerCenter string

The total number of Cancer Centers  that are controlled by the parent  company

NPI2 string

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)>
Example
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