v1

latestOpenAPI 3.0.32026-07-247462851.8 MB

Patient History Retrieval

Check the status of a job

This endpoint returns information about the given job, including current status.

get/patient-history/jobs/{job-id}

Path parameters

job-idstring uuid required

The ID of a patient history job.

Example:ae6c5bfc-c082-47f0-a605-792d7c5958ad

ID of the patient history job.

Headers

Zus-Accountstring uuid

The Builder ID of another builder on whose behalf the caller is acting. This requires that the provider builder has a cross-builder grant allowing access to the caller.

Example:ae6c5bfc-c082-47f0-a605-792d7c5958ad

Response

Status of a job is returned.

Example response

{
  "data": {
    "type": "patient-history/jobs",
    "id": "ae6c5bfc-c082-47f0-a605-792d7c5958ad",
    "attributes": {
      "targetDate": "2023-01-20T12:18:46Z",
      "createdAt": "1683886930",
      "jobStatus": "done",
      "lastUpdatedAt": "1683886930",
      "providers": [
        {
          "service": "commonwell",
          "status": "done"
        }
      ],
      "provider": {
        "npi": "1234567893",
        "role": "158965000",
        "name": "Dr Smith"
      },
      "practitioner": {
        "npi": "1234567893",
        "role": "158965000",
        "name": "Dr Smith"
      }
    },
    "relationships": {
      "patient": {
        "data": {
          "type": "fhir/Patient",
          "id": "ae6c5bfc-c082-47f0-a605-792d7c5958ad"
        }
      }
    }
  }
}