latestOpenAPI 3.1.02026-08-194237902.5 MB

563848e0ecc0

FacilityCredentialingWorkflow

Advance a facility workflow status via a timeline event

Creates a new timeline event for the specified facility credentialing workflow, driving a status transition and updating the workflow's credentialingStatus and relevant dates. When to use: Call this to move a workflow from one credentialing status to another. Before calling, use GET /facility-credentialing-workflows/{workflowId}/timelin e-events/status-options to discover which statuses are available for the workflow's current state and the caller's permissions. For overriding a PSV step with a blocker, use POST /{workflowId}/override-timeline-events instead. Preconditions: The workflow must exist and belong to the caller's tenant. Side effects: The workflow's credentialingStatus, status dates, and related fields are updated as a result of the transition. Returns: 201 Created with the created timeline event and the updated workflow status reflected in the response body.

post/facility-credentialing-workflows/{workflowId}/timeline-events

Path parameters

workflowIdstring required

ID of the facility credentialing workflow

Headers

tenant-idstring required

Tenant ID

Request body

namestring required
changeReasonstring
credentialingDecisionDatestring date
nextCredentialingDatestring date
overrideReasonstring
isOverrideboolean

Example request

{
  "credentialingDecisionDate": "2022-03-10",
  "nextCredentialingDate": "2022-03-10"
}

Response

Successfully created the timeline event

idstring
workflowIdstring
createdBystring
createdAtstring date
updatedAtstring date
updatedBystring