latestOpenAPI 3.1.02026-08-194237902.5 MB

563848e0ecc0

FacilityCredentialingWorkflow

Replace all Medicare star ratings on a facility workflow

Replaces the entire Medicare star ratings list for the specified facility credentialing workflow with the array provided in the request body. When to use: Supply the complete desired list — omitting an existing item removes it. To clear all Medicare star ratings, send an empty array []. Preconditions: The workflow must belong to the caller's tenant. Returns: 200 OK with the updated workflow section. Returns 404 if the workflow is not found, 400 if the request body is invalid.

put/facility-credentialing-workflows/{workflowId}/medicare-star-ratings

Path parameters

workflowIdstring required

Headers

tenant-idstring required

Request body

starRatingstring required

The star rating

reportDatestring

The date of the report

sourcestring required

The source of the rating

createdAtstring

The date the record was created

createdBystring

The user who created the record

updatedAtstring

The date the record was last updated

updatedBystring

The user who last updated the record

verifiedDatestring

The date the rating was verified

verifiedBystring

The user who verified the rating

Example request

[
  {
    "starRating": "4.5",
    "reportDate": "2024-01-01",
    "source": "CMS",
    "createdAt": "2024-01-01",
    "createdBy": "user@example.com",
    "updatedAt": "2024-01-01",
    "updatedBy": "user@example.com",
    "attachments": [
      {
        "createdAt": "2024-01-15T10:30:00Z",
        "fileType": "License",
        "fileUrl": "gs://bucket/facility-credentialing-workflow/attachments/file.pdf",
        "originalFileName": "license.pdf",
        "state": "CA",
        "expirationDate": "2025-12-31",
        "source": "CAQH",
        "createdBy": "user@example.com",
        "updatedAt": "2024-02-15T14:20:00Z",
        "updatedBy": "admin@example.com"
      }
    ],
    "verifiedDate": "2024-01-01",
    "verifiedBy": "verifier@example.com"
  }
]

Response

Medicare star ratings updated successfully