Organization Service FacilitiesV2

Update organization service facility

Beta
PATCH

Path parameters

organization_service_facility_idUUIDRequired

Request

This endpoint expects an object.
name
stringOptional
The name of the service facility.
aliases
list of stringsOptional
A list of alternate names for the service facility.
description
stringOptional
A description of the service facility.
npi
stringOptional
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.
status
enumOptional
The status of the service facility.
Allowed values: activeinactivesuspended
operational_status
enumOptional
The operational status of the service facility.
mode
enumOptional
The mode of the service facility.
Allowed values: instancekind
type
enumOptional
The type of the service facility.
physical_type
enumOptional
The physical type of the service facility.
telecoms
list of stringsOptional
A list of contact methods for the service facility.
address
objectOptional
The address of the service facility.

Response

This endpoint returns an object
organization_service_facility_id
UUID
name
string
The name of the service facility.
aliases
list of strings
A list of alternate names for the service facility.
telecoms
list of strings
A list of contact methods for the service facility.
address
object
The address of the service facility.
description
stringOptional
A description of the service facility.
npi
stringOptional
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.
status
enumOptional
The status of the service facility.
Allowed values: activeinactivesuspended
operational_status
enumOptional
The operational status of the service facility.
mode
enumOptional
The mode of the service facility.
Allowed values: instancekind
type
enumOptional
The type of the service facility.
physical_type
enumOptional
The physical type of the service facility.

Errors

PATCH
1curl -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}
Built with