Update organization service facility | Candid

Authentication

AuthorizationBearer

OAuth authentication of the form <token>.

Path parameters

organization_service_facility_idUUIDRequired

Request

This endpoint expects an object.

namestringOptional

The name of the service facility.

aliaseslist of stringsOptional

A list of alternate names for the service facility.

descriptionstringOptional

A description of the service facility.

external_idstringOptional

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

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.

place_of_service_codeenumOptional

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

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.

telecomslist of stringsOptional

A list of contact methods for the service facility.

addressobjectOptional

The address 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.

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.

1	curl -X PATCH https://api.joincandidhealth.com/api/organization-service-facilities/v2/30F55EE6-8C0E-43FC-A7FC-DAC00D5BF569 \
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	"city": "New York",
21	"state": "NY",
22	"zip_code": "10001",
23	"zip_plus_four_code": "1234",
24	"address2": "Apt 1"
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	"telecoms": [
8	"555-555-5555"
9	],
10	"address": {
11	"address1": "123 Main St",
12	"city": "New York",
13	"state": "NY",
14	"zip_code": "10001",
15	"zip_plus_four_code": "1234",
16	"address2": "Apt 1"
17	},
18	"description": "Test Service Facility Description",
19	"status": "active",
20	"operational_status": "C",
21	"mode": "instance",
22	"type": "DX",
23	"physical_type": "si"
24	}

Authentication

Path parameters

Request

Response

Errors