FHIR Bulk Data Access status-check-response

Request Body Schema

• Meta

  required, object

  • DataModel

    required, string

    Reliable

    FHIR Bulk Data Access
  • EventType

    required, string

    Reliable

    status-check-response
  • EventDateTime

    string, null

    Reliable

    Displays the UTC date and time that an outgoing request is delivered or an incoming request is received.
    ISO 8601 Format
  • Test

    boolean, null

    Reliable

    Indicates whether the request is a test or not.
  • Source

    object

    Contains the information for the system initiating the message, including the source ID and name.
    Included in messages from Redox

    • ID

      string, null

      Reliable

      Identifies the system initiating the message. If you have multiple OAuth API keys per environment type, this value is required. If you have only one OAuth API key per environment type, or you're using legacy API keys, this value is optional.
      UUID
    • Name

      string, null

      Reliable

      Displays the name of the system initiating the message.
  • Destinations

    Array of object

    Contains the information for the endpoint(s) receiving the request. A request must contain at least one destination, but asynchronous requests can have more than one destination. Synchronous requests like queries can only support one destination.
    Required when sending data to Redox.

    • ID

      string, null

      Reliable

      Identifies the endpoint that the request is directed to.
      UUID
    • Name

      string, null

      Reliable

      Displays the name of the endpoint that the request is directed to.
  • Logs

    Array of object

    Contains the log identifier(s) for the request.

    • ID

      string, null

      Reliable

      Identifies the request log(s) that correspond to this request. You can use this value to locate the relevant log in the Redox dashboard for support and reference.
      UUID
    • AttemptID

      string, null

      Reliable

      Identifies the request log attempt value, which is useful when retries are possible.
      UUID
  • FacilityCode

    string, null

    Possible

    Code for the facility related to the message.
    Only use this field if a health system indicates you should. The code is specific to the health system's EHR and might not be unique across health systems. In general, the facility fields within the data models (e.g. OrderingFacility) are more reliable and informative.
• status

  required, string

  The HTTP status code of the status check response. 202 indicates the export is still in progress; 200 indicates the export is complete.
• output

  required, Array of object

  An array of output file entries, each representing a FHIR resource type exported as an NDJSON file.

  • type

    required, string

    The FHIR resource type contained in this output file (e.g., Patient, Encounter, Observation).
  • url

    required, string

    The URL where the NDJSON file for this resource type can be downloaded.
• progress

  string, null

  A human-readable progress indicator returned via the X-Progress header when the export is still in progress (e.g., "50%").
• transactionTime

  string, null

  Indicates the server time when the export query was run. Returned when the export is complete.
• request

  string, null

  The original $export request URL that initiated this bulk export job.
• requiresAccessToken

  boolean, null

  Indicates whether the file URLs in the output require an access token to download.