Sign in
latestOpenAPI 3.1.02026-08-194237902.5 MB

563848e0ecc0

Facility

Update a facility and its tenant association

Updates the CoreFacility identified by the path certifyFacilityId and its TenantFacility association for the tenant (update path). Use this when the certifyFacilityId is already known; use POST /facilities instead to create a new facility. Stored identity fields not present in the payload are merged in before validation, then the same crosswalk identity used at create time is re-resolved and updated — retrying this call with the same payload is safe and updates the same rows (idempotent). Request body is validated against the same facility-upsert JSON Schema and tenant-specific rules used by POST /facilities. Returns HTTP 201 (not 200) on success — this matches the create endpoint's status code by historical convention rather than by REST semantics for an update; treat any 2xx as success rather than branching on the exact code. Response body is the same ID map as create (crosswalkId, corefacilityId, tenantfacilityId, etc.), not the full facility object. See POST /facilities for the create path.

put/facilities/{id}

Path parameters

idstring required

Facility ID

Headers

tenant-idstring required

Tenant ID

Request body

facilityIdstring

Certify facility ID; only relevant for update flows

namestring required

Facility name

npistring

10-digit National Provider Identifier. Required for default tenants; optional for Pharmacy (ncpdpId) and some external-id / address-hash flows.

tinstring

9-digit Tax Identification Number. Required for default tenants; optional for Pharmacy (ncpdpId) and some external-id / address-hash flows.

ncpdpIdstring

NCPDP identifier for Pharmacy facilities (CP-33224). Required when facilityType is Pharmacy.

facilityTypestring

Facility type

facilityEffectiveDatestring date

Effective date of the facility (YYYY-MM-DD)

externalIdstring

External identifier for the facility, used as crosswalk for some tenants

dbastring

Doing-business-as name

attestationDatestring date

Attestation date (YYYY-MM-DD)

effectiveDatestring date

Effective date (YYYY-MM-DD)

delegationStatus'Delegated' | 'Direct'

Delegation status of the facility

userDefinedFieldsobject

Custom tenant-defined fields. Replaces the entire userDefinedFields object (PUT semantics).

lastCredentialingDatestring date

Date of the last credentialing (YYYY-MM-DD). Required when initialCredentialingDate is provided.

initialCredentialingDatestring date

Date the facility was initially credentialed (YYYY-MM-DD)

nextCredentialingDatestring date

Date of the next credentialing due (YYYY-MM-DD)

Example request

{
  "facilityId": "cf_abc123",
  "name": "Acme Medical Center",
  "npi": "1234567890",
  "tin": "123456789",
  "ncpdpId": "1234567",
  "facilityType": "Hospital",
  "facilityEffectiveDate": "2024-01-01",
  "attestationDate": "2024-01-01",
  "effectiveDate": "2024-01-01",
  "serviceAddress": {
    "state": "CA"
  },
  "officeAddress": {
    "state": "CA"
  },
  "billingAddress": {
    "state": "CA"
  },
  "mailingAddress": {
    "state": "CA"
  },
  "irsAddress": {
    "state": "CA"
  }
}

Response

Facility successfully updated

crosswalkIdstring

Crosswalk ID generated for the CoreFacility record

corefacilityIdstring

Certify facility ID of the upserted CoreFacility record

tenantfacilityIdstring

ID of the upserted TenantFacility record

facilityentityaddressIdstring

ID of the upserted FacilityEntityAddress record; present only when an office, billing, or mailing address was submitted

Example response

{
  "crosswalkId": "1234567890-123456789",
  "corefacilityId": "cf_abc123",
  "tenantfacilityId": "tf_abc123",
  "facilityentityaddressId": "fea_abc123"
}