Beta

Get organization service facility

GET

/api/organization-service-facilities/v2/:organization_service_facility_id

GET

1 import uuid
2 
3 from candid import CandidApiClient
4 
5 client = CandidApiClient(
6     client_id="YOUR_CLIENT_ID",
7     client_secret="YOUR_CLIENT_SECRET",
8 )
9 client.organization_service_facilities.v_2.get(
10     organization_service_facility_id=uuid.UUID(
11         "30f55ee6-8c0e-43fc-a7fc-dac00d5bf569",
12     ),
13 )

Play

200Retrieved

1 {
2   "organization_service_facility_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
3   "name": "string",
4   "aliases": [
5     "string"
6   ],
7   "telecoms": [
8     "string"
9   ],
10   "address": {
11     "address1": "string",
12     "city": "string",
13     "state": "AA",
14     "zip_code": "string",
15     "zip_plus_four_code": "string",
16     "address2": "string"
17   },
18   "description": "string",
19   "npi": "string",
20   "status": "active",
21   "operational_status": "C",
22   "mode": "instance",
23   "type": "DX",
24   "physical_type": "si"
25 }

Path parameters

organization_service_facility_idUUIDRequired

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.

descriptionstringOptional

A description of the service facility.

npistringOptional

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.

statusenumOptional

The status of the service facility.

Allowed values:

operational_statusenumOptional

The operational status of the service facility.

modeenumOptional

The mode of the service facility.

Allowed values:

typeenumOptional

The type of the service facility.

physical_typeenumOptional

The physical type of the service facility.

Get organization service facility

Path parameters

Headers

Response

Errors