latestOpenAPI 3.1.02026-08-194237902.5 MB

563848e0ecc0

Facility

Add a specialty to a facility

Adds a new specialty association to an existing facility. Use this to associate a single specialty with a facility; to apply multiple specialty changes in one call, use PATCH /facilities/{id}/specialties instead. Cascade to each additional level is not a separate flag — it is triggered purely by which optional ID fields are present in the request body: certifyLocationId alone cascades to the facility-location level; certifyGroupId cascades to the group level; certifyLocationId together with locationSpecialtyEffectiveDate cascades to the group-location level; certifyNetworkId cascades to the group-network level. Cascade levels are attempted independently — a failure on one level does not roll back or block the others; any level that fails is reported in the notCreated array of the response rather than failing the whole request.

post/facilities/{id}/specialties

Path parameters

idstring required

Facility ID

Headers

tenant-idstring

Request body

tenantSpecialtyIdstring required

ID of the tenant specialty

facilitySpecialtyEffectiveDatestring

Effective date for the facility specialty (YYYY-MM-DD)

facilitySpecialtyIsPrimaryboolean required

Indicates if the specialty is primary

certifyLocationIdstring

Certify location ID to associate the specialty at the facility-location level

facilityLocationSpecialtyEffectiveDatestring

Effective date for the facility location specialty (YYYY-MM-DD)

facilityLocationSpecialtyIsPrimaryboolean

Indicates if the location specialty is primary

certifyGroupIdstring

Certify group ID to associate the specialty at the group-facility level

certifyNetworkIdstring

Certify network ID to associate the specialty at the group-facility-network level (requires certifyGroupId)

groupSpecialtyEffectiveDatestring

Effective date for the group facility specialty (YYYY-MM-DD)

locationSpecialtyEffectiveDatestring

Effective date for the group facility location specialty (YYYY-MM-DD). Triggers group-location specialty creation when both certifyGroupId and certifyLocationId are provided.

networkSpecialtyEffectiveDatestring

Effective date for the group facility network specialty (YYYY-MM-DD)

Example request

{
  "tenantSpecialtyId": "ts_123456",
  "facilitySpecialtyEffectiveDate": "2024-01-01",
  "facilitySpecialtyIsPrimary": true,
  "certifyLocationId": "loc_123456",
  "facilityLocationSpecialtyEffectiveDate": "2024-01-01",
  "facilityLocationSpecialtyIsPrimary": true,
  "certifyGroupId": "grp_123456",
  "certifyNetworkId": "net_123456"
}

Response

Facility specialty successfully created