Sign in

v1

latestOpenAPI 3.0.32026-07-247462851.8 MB
Patient History Retrieval

Start a job to retrieve information about the patient

This endpoint takes a reference for a patient that is stored in the FHIR server and starts a job that will asynchronously collect, parse and store on the server all documents that are related to this patient that are available on the external sources.

post/patient-history/jobs

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

Request body

OR
OR
OR

Example request

{
  "data": {
    "type": "patient-history/jobs",
    "attributes": {
      "targetDate": "2023-01-20T12:18:46Z",
      "requestConsent": true,
      "provider": {
        "npi": "1234567893",
        "role": "158965000",
        "name": "Dr Smith"
      },
      "chartBuildType": "pro-ehr-only"
    },
    "relationships": {
      "patient": {
        "data": {
          "type": "fhir/Patient",
          "id": "ae6c5bfc-c082-47f0-a605-792d7c5958ad"
        }
      }
    }
  }
}

Response

Patient history retrieval job has been created.

Example response

{
  "data": {
    "type": "patient-history/jobs",
    "id": "ae6c5bfc-c082-47f0-a605-792d7c5958ad",
    "attributes": {
      "targetDate": "2023-01-20T12:18:46Z",
      "createdAt": "1683886930",
      "jobStatus": "in_progress",
      "requestConsent": true,
      "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"
        }
      },
      "practitioner": {
        "data": {
          "type": "fhir/Practitioner",
          "id": "ae6c5bfc-c082-47f0-a605-792d7c5958ad"
        }
      },
      "organization": {
        "data": {
          "type": "fhir/Organization",
          "id": "ae6c5bfc-c082-47f0-a605-792d7c5958ad"
        }
      }
    }
  }
}