API Reference Organization Service Facilities V2

Create organization service facility

Beta

POST

Request

This endpoint expects an object.

namestringRequired

The name of the service facility.

aliaseslist of stringsRequired

A list of alternate names for the service facility.

telecomslist of stringsRequired

A list of contact methods for the service facility.

addressobjectRequired

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

Allowed values: activeinactivesuspended

The status of the service facility.

operational_statusenumOptional

The operational status of the service facility.

mode"instance" or "kind"Optional

Allowed values: instancekind

The mode of the service facility.

typeenumOptional

The type of the service facility.

physical_typeenumOptional

The physical type of the service facility.

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

Allowed values: activeinactivesuspended

The status of the service facility.

operational_statusenumOptional

The operational status of the service facility.

mode"instance" or "kind"Optional

Allowed values: instancekind

The mode of the service facility.

typeenumOptional

The type of the service facility.

physical_typeenumOptional

The physical type of the service facility.

Errors

POST

1 curl -X POST https://api.joincandidhealth.com/api/organization-service-facilities/v2 \
2      -H "Authorization: Bearer <token>" \
3      -H "Content-Type: application/json" \
4      -d '{
5   "name": "Test Service Facility",
6   "aliases": [
7     "Test Service Facility Alias"
8   ],
9   "description": "Test Service Facility Description",
10   "status": "active",
11   "operational_status": "C",
12   "mode": "instance",
13   "type": "DX",
14   "physical_type": "si",
15   "telecoms": [
16     "555-555-5555"
17   ],
18   "address": {
19     "address1": "123 Main St",
20     "address2": "Apt 1",
21     "city": "New York",
22     "state": "NY",
23     "zip_code": "10001",
24     "zip_plus_four_code": "1234"
25   }
26 }'

1 {
2   "organization_service_facility_id": "30F55EE6-8C0E-43FC-A7FC-DAC00D5BF569",
3   "name": "Test Service Facility",
4   "aliases": [
5     "Test Service Facility Alias"
6   ],
7   "description": "Test Service Facility Description",
8   "status": "active",
9   "operational_status": "C",
10   "mode": "instance",
11   "type": "DX",
12   "physical_type": "si",
13   "telecoms": [
14     "555-555-5555"
15   ],
16   "address": {
17     "address1": "123 Main St",
18     "address2": "Apt 1",
19     "city": "New York",
20     "state": "NY",
21     "zip_code": "10001",
22     "zip_plus_four_code": "1234"
23   }
24 }