Sign in
latestOpenAPI 3.1.02026-08-194237902.5 MB

563848e0ecc0

MonitoringWorkflow

Fetch a single monitoring workflow by ID

Returns a single monitoring workflow identified by id. Use this endpoint when you already have the workflow ID; use GET /monitoring-workflows to search or paginate. The tenant-id header is mandatory and scopes the lookup. The response is enriched with resolved display names (verifiedByName, assignedByName, assignedToName); records with a non-null deletedAt inside CRUD-enabled practitioner sections (e.g. licenses, dea) are filtered out; and, for callers without the MONITORING_WORKFLOW_NEEDS_VERIFICATION_FLAG permission, flags with status needsVerification are stripped from the flag arrays. Requires MONITORING_WORKFLOW_READ.

get/monitoring-workflows/{id}

Path parameters

idstring required

The monitoring workflow's document ID, obtained from GET /monitoring-workflows or from a previous create/update response

Headers

tenant-idstring required

Tenant ID

Response

The enriched monitoring workflow record.

idstring

Unique identifier for the monitoring workflow

tenantIdstring

ID of the tenant

tenantPractitionerIdstring

ID of the tenant practitioner

certifyPractitionerIdstring

Certify practitioner ID

createdBystring

ID of the user who created the monitoring workflow

updatedBystring

ID of the user who updated the monitoring workflow

createdAtstring date-time
updatedAtstring date-time
allFlagsCountinteger

Total count of all existing flags (excluding new flags)

Example response

{
  "id": "44c8fa75-15a1-4790-a0dd-139058d1f86d",
  "tenantId": "tenant_123456",
  "tenantPractitionerId": "tp_123456",
  "certifyPractitionerId": "cp_123456",
  "data": {
    "monitoringStatus": "IN_PROGRESS",
    "monitoringStatusLastUpdatedDate": "2024-01-15T10:30:00Z"
  },
  "createdBy": "user_123456",
  "updatedBy": "user_123456",
  "createdAt": "2022-03-10T16:15:50Z",
  "updatedAt": "2022-03-10T16:15:50Z",
  "allFlagsCount": 5
}