Sign in
latestOpenAPI 3.1.02026-08-194237902.5 MB

563848e0ecc0

CredentialingWorkflow

Update credentialing date fields on a CRED_APPROVED timeline event

Partially updates the timeline event identified by eventId and its associated workflow in a single atomic transaction. Only applicable to events of type CRED_APPROVED. Supports updates to the following fields: nextCredentialingDate (ISO-8601 date), nextCredentialingDateSource (origin of the date value), changeReason (free-text explanation for the date change), and nextCredentialingDateChangeLog (a free-text log entry for date change history). Both the timeline event and the workflow record are updated atomically — either both succeed or neither is changed.

patch/credentialing-workflows/{workflowId}/timeline-events/{eventId}

Path parameters

eventIdstring required

ID of the timeline event to update

workflowIdstring required

ID of the credentialing workflow

Headers

tenant-idstring required

Tenant ID

Request body

nextCredentialingDatestring date
nextCredentialingDateSourcestring
changeReasonstring

Example request

{
  "nextCredentialingDate": "2022-03-10",
  "nextCredentialingDateChangeLog": [
    {
      "changedFrom": "2022-03-10",
      "changedTo": "2022-03-10"
    }
  ]
}

Response

Successfully updated 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"
}