v1

latestOpenAPI 3.1.02026-08-063776831.4 MB

Facility

Add a specialty to a facility

Adds a new specialty to an existing facility. Optionally cascades into facility location, group, group-location, and group-network specialty levels.

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