Sign in
latestOpenAPI 3.1.02026-08-194237902.5 MB

563848e0ecc0

CredentialingWorkflow

Create a PSV_COMPLETED override timeline event for a workflow

Creates an override timeline event for the credentialing workflow identified by workflowId. Only events of type PSV_COMPLETED may be overridden. The request body must include isOverride: true and a non-empty overrideReason; omitting either field will result in a validation error. A different (elevated) permission is required for this endpoint compared to the standard POST /{workflowId}/timeline-events. Returns 409 if the workflow is not the latest version for this practitioner — resolve by operating on the most recent workflow record.

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

Path parameters

workflowIdstring required

ID of the 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

Unique identifier for the timeline event

workflowIdstring

ID of the associated credentialing workflow

createdBystring

ID of the user who created the timeline event

updatedBystring

ID of the user who last updated the timeline event

createdAtstring date-time
updatedAtstring date-time

Example response

{
  "id": "te_123456",
  "workflowId": "cw_123456",
  "data": {
    "name": "CRED_APPROVED",
    "changeReason": "Application approved by committee",
    "credentialingDecisionDate": "2022-03-10",
    "nextCredentialingDate": "2022-03-10",
    "nextCredentialingDateSource": "SYSTEM_CALCULATED",
    "nextCredentialingDateChangeLog": [
      {
        "changedFrom": "2022-03-10",
        "changedTo": "2022-03-10",
        "changeReason": "Updated based on new license expiration",
        "createdBy": "user_123456",
        "createdAt": "2024-01-15T10:30:00Z"
      }
    ],
    "psvPdfPath": "/files/psv_123456.pdf",
    "overrideReason": "Test override reason",
    "isOverride": true
  },
  "createdBy": "user_123456",
  "updatedBy": "user_123456",
  "createdAt": "2022-03-10T16:15:50Z",
  "updatedAt": "2022-03-10T16:15:50Z"
}