Organization Service FacilitiesV2

Update organization service facility

Beta
PATCH
https://api.joincandidhealth.com/api/organization-service-facilities/v2/:organization_service_facility_id

Path parameters

organization_service_facility_id
UUID

Request

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

Response

This endpoint return 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
optional string
A description of the service facility.
npi
optional string
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
optional enum
The status of the service facility.
Allowed values: activeinactivesuspended
operational_status
optional enum
The operational status of the service facility.
mode
optional enum
The mode of the service facility.
Allowed values: instancekind
type
optional enum
The type of the service facility.
physical_type
optional enum
The physical type of the service facility.

Errors

PATCH
/api/organization-service-facilities/v2/:organization_service_facility_id
curl -X PATCH https://api.joincandidhealth.com/api/organization-service-facilities/v2/30F55EE6-8C0E-43FC-A7FC-DAC00D5BF569 \
-H "Authorization: Bearer <token>" \
-H "Content-Type: application/json" \
-d '{
"name": "Test Service Facility",
"aliases": [
"Test Service Facility Alias"
],
"description": "Test Service Facility Description",
"status": "active",
"operational_status": "C",
"mode": "instance",
"type": "DX",
"physical_type": "si",
"telecoms": [
"555-555-5555"
],
"address": {
"address1": "123 Main St",
"city": "New York",
"state": "NY",
"zip_code": "10001",
"zip_plus_four_code": "1234",
"address2": "Apt 1"
}
}'
Response
{
"organization_service_facility_id": "30F55EE6-8C0E-43FC-A7FC-DAC00D5BF569",
"name": "Test Service Facility",
"aliases": [
"Test Service Facility Alias"
],
"telecoms": [
"555-555-5555"
],
"address": {
"address1": "123 Main St",
"city": "New York",
"state": "NY",
"zip_code": "10001",
"zip_plus_four_code": "1234",
"address2": "Apt 1"
},
"description": "Test Service Facility Description",
"status": "active",
"operational_status": "C",
"mode": "instance",
"type": "DX",
"physical_type": "si"
}