FHIR Bulk Data Access group-export

get/fhir/R4/{destinationSlug}/{environmentFlag}/Group/{groupId}/$export
group-export
Beta

Request Parameters

  • destinationSlug
    required, string

    The slug identifier for the destination.

  • environmentFlag
    required, string

    The environment flag (e.g., Development, Staging, Production).

  • groupId
    required, string

    The ID of the Group resource to export data for.

Request Body Schema

  • Meta
    required, object
    • DataModel
      required, string
      Reliable

      FHIR Bulk Data Access

    • EventType
      required, string
      Reliable

      group-export

    • 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.

  • id
    required, string

    The ID of the Group resource to export data for.

  • patient
    string, null

    One or more FHIR Patient references to restrict the export to specific patients within the group. Only valid in HTTP POST kickoff requests.

  • includeAssociatedData
    string, null

    A string of comma-delimited values directing the server to return or omit predefined sets of FHIR resources associated with the request.

  • organizeOutputBy
    string, null

    When provided, directs the server to organize output files by instances of the specified resource type.

  • allowPartialManifests
    boolean, null

    When true, permits the server to distribute bulk data output across multiple manifests with pagination support.

  • _outputFormat
    string, null

    The format for the requested Bulk Data files to be generated. Defaults to application/fhir+ndjson.

  • _since
    string, null

    Only include resources modified after this instant. Compared against Resource.meta.lastUpdated.

  • _until
    string, null

    Only include resources modified before this instant. Compared against Resource.meta.lastUpdated.

  • _type
    string, null

    A string of comma-delimited FHIR resource types. The response SHALL be filtered to only include resources of the specified resource types.

  • _elements
    string, null

    A string of comma-delimited FHIR element paths. When provided, the server SHOULD omit unlisted, non-mandatory elements from the resources returned.

  • _typeFilter
    string, null

    A string of a FHIR REST search query. When provided, the server SHALL filter the data in the response to only include resources matching the query.

Example
json
1
{
2
  "Meta": {
3
    "DataModel": "FHIR Bulk Data Access",
4
    "EventType": "group-export",
5
    "EventDateTime": "2026-05-28T22:44:52.399Z",
6
    "Test": true,
7
    "Source": {
8
      "ID": "7ce6f387-c33c-417d-8682-81e83628cbd9",
9
      "Name": "Redox Dev Tools"
10
    },
11
    "Destinations": [
12
      {
13
        "ID": "af394f14-b34a-464f-8d24-895f370af4c9",
14
        "Name": "Redox EMR"
15
      }
16
    ],
17
    "Logs": [
18
      {
19
        "ID": "d9f5d293-7110-461e-a875-3beb089e79f3",
20
        "AttemptID": "925d1617-2fe0-468c-a14c-f8c04b572c54"
21
      }
22
    ],
23
    "FacilityCode": null
24
  },
25
  "id": "example-group-id",
26
  "_outputFormat": "application/fhir+ndjson",
27
  "_since": "2024-01-01T00:00:00Z",
28
  "_until": null,
29
  "_type": "Patient,Encounter,Observation",
30
  "_elements": null,
31
  "patient": null,
32
  "includeAssociatedData": null,
33
  "_typeFilter": null,
34
  "organizeOutputBy": null,
35
  "allowPartialManifests": null
36
}

FHIR® is a registered trademark of Health Level Seven International (HL7) and is used with the permission of HL7. Use of this trademark does not constitute an endorsement of products/services by HL7®.