API ReferenceOrganization Service FacilitiesV2

Get organization service facility by external_id

Beta

Looks up a single organization service facility by its external_id field. This can be useful for finding service facilities within Candid which are associated with service facilities in an external system.

Path parameters

external_idstringRequired

Response

This endpoint returns an object.
organization_service_facility_idUUID
namestring
The name of the service facility.
aliaseslist of strings
A list of alternate names for the service facility.
telecomslist of strings
A list of contact methods for the service facility.
addressobject
The address of the service facility.
descriptionstring or null
A description of the service facility.
external_idstring or null

An ID for this service facility used in an external system (e.g. your EMR). Service facilities can be queried by this field.

npistring or null

An NPI specific to the service facility if applicable, i.e. if it has one and is not under the billing provider’s NPI. Box 32 section (a) of the CMS-1500 claim form.

place_of_service_codeenum or null

The Place of Service (POS) code for this service facility.

statusenum or null
The status of the service facility.
Allowed values:
operational_statusenum or null
The operational status of the service facility.
modeenum or null
The mode of the service facility.
Allowed values:
typeenum or null
The type of the service facility.
physical_typeenum or null
The physical type of the service facility.

Errors