ZUzushealth
BackfillRequest

Create a Backfill Request

API endpoint for triggering a backfill of patient data from an EHR. The backfill request pulls data such as patient demographic information and clinical data. The exact content varies by EHR.

post/backfill-request

Request

  • Base URL
    https://ehr-hooks.zusapi.com
  • URL
    https://ehr-hooks.zusapi.com/backfill-request
  • Auth
    none declared

Request body

Example request

{
  "data": {
    "type": "backfill-request",
    "attributes": {
      "ignoreRateLimit": true
    },
    "relationships": {
      "builder": {
        "data": {
          "type": "auth/builder"
        }
      },
      "patient": {
        "data": {
          "type": "fhir/Patient",
          "identifierSystemURL": "https://fhir.athena.io/sid/ah-patient"
        }
      }
    }
  }
}

Response

Backfill request created successfully

Example response

{
  "data": {
    "type": "backfill-request",
    "attributes": {
      "status": "success"
    }
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.