Get compliance job result

Get compliance job result. Compliance job can be submitted using the POST /compliance/job endpoint.

Path Parameters

jobId string required

Responses

Compliance job result

application/json

Schema
Example (from schema)

Schema

jobId string required
The ID of the compliance job.
status string required
Possible values: [processing, completed, failed]
Status of the compliance job. One of "processing", "completed", "failed".
results object[]
Results of the compliance job. Only available when status is "completed".
Array [
id string required
The ID of the input file (matches submitted id)
processingStatus string required
Possible values: [SUCCESS, FAILURE]
Tracks the status of the system process used to evaluate the file. A SUCCESS status confirms the check ran successfully, not whether the note passed or failed the compliance check. For the note's pass/fail result of the compliance check, see the passed field.
failureReason string
Reason for failure (only present if processingStatus is FAILURE)
passed boolean
Whether the compliance check passed (only present if processingStatus is SUCCESS)
criteria object[]
List of compliance check results for each evaluated criterion (only present if processingStatus is SUCCESS)
Array [
name string
The evaluated compliance criterion
passed boolean
True if criterion evaluation was successful.
reason string
Explanation for why the criterion passed or failed
]
]

{
  "jobId": "ec40b282-8cf3-4659-9976-50d411203c2f",
  "status": "completed",
  "results": [
    {
      "id": "file-123",
      "processingStatus": "SUCCESS",
      "failureReason": "string",
      "passed": true,
      "criteria": [
        {
          "name": "service_modality",
          "passed": true,
          "reason": "The progress note specifies the service modality as individual therapy"
        }
      ]
    }
  ]
}

Get compliance job result​

Get compliance job result