Sign in
latestOpenAPI 3.1.02026-08-194237902.5 MB

563848e0ecc0

CredentialingWorkflow

Record a status transition event for a credentialing workflow

Creates a new timeline event (status transition) for the credentialing workflow identified by workflowId. This is the primary mechanism for advancing a workflow through its credentialing lifecycle. Call GET /credentialing-workflows/{workflowId}/timeline-events/status-options first to retrieve the set of valid name values (status transitions) available to the current user. Only works on the latest workflow version for a practitioner — returns 409 if a newer version exists. Creating certain events (e.g. triggering PSV generation) may cause asynchronous side effects. To override a completed PSV event, use POST /credentialing-workflows/{workflowId}/override-timeline-events.

post/credentialing-workflows/{workflowId}/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"
}