Test with Redox FHIR sandbox data

Last updated: Feb 23, 2026

DEVELOPER

IMPLEMENTATION

HEALTH TECH VENDOR

The Redox FHIR® sandbox allows you to test your FHIR® workflows with test patients. Use this full-featured sandbox during implementation to test an end-to-end integrated workflow against a FHIR® server—and to mirror how an integration might look when connecting to legacy systems.

Send sandbox requests to redox-fhir-sandbox. We seed our sandbox with a robust set of test patient data covering most of the FHIR® resources in our API suite. See our FHIR® specs.

You can test reads, queries, and even writebacks.

When Redox refreshes the sandbox

We want our sandbox to be useful to everyone. To achieve that, we occasionally refresh the sandbox, which reverts the environment to its original state with only Redox-seeded test data. This keeps test data valuable to all customers and clears the sandbox of any potentially confidential test data. We only refresh as necessary to ensure the overall health of the sandbox.

Discover test patient data

Our FHIR® sandbox supports reading and querying for data. This allows you to test your search workflows.

Search tips

The Redox FHIR® sandbox uses exact matching for patient searches.

For identifiers, we include one or more of the following for each test patient:

Medical Record ID (MR)
driver’s license number (DL)
passport number (PPN)
Social Security number (SSN)

The system for MR, DL, and PPN is the Redox FHIR® API sandbox environment. The system for SSN is http://hl7.org/fhir/side/us-ssn. Learn more about searching with patient identifiers.

For demographics, we include one or more of the following for each test patient:

given name
family name
gender
birthdate
address-city
address-state
address-postalcode
home phone
mobile phone
email address

Phone and address parameters

A couple of things to note for patient searches:

First, the phone parameter matches either a home or mobile phone.

Second, you may notice that the address is split into three parameters (address-city, address-state, address-postalcode) and doesn’t include the street address. The FHIR® API sandbox doesn’t support searching for a street address. Instead, you can search by city, state, or postal code—or a combination of the three.

Learn more about searching with patient demographics.

Redox test patients

See the pre-seeded Redox test patients below. Most of these test patients can’t be modified.

Patient	Identifiers / Demographics	Resources
Synthia Davis	FHIR® ID: fbee8d6b-5acf-370c-7edd-af0d84f5288c MR: 3Y67hJYUopQywm8frKLGBf DOB: 2000-10-10 gender: female address: Revere, MA 02151	Appointment CarePlan CareTeam Condition Coverage Device DiagnosticReport DocumentReference Encounter Goal Immunization MedicationRequest Observation Patient Procedure ServiceRequest
Micheal Shields	FHIR® ID: 307b6419-5147-4716-10b1-bb458ac191c3 MR: 5Z89kLZWqrSzvn9gtNMHCh DOB: 2003-07-19 gender: female address: Fairhaven, MA	AllergyIntolerance Appointment CarePlan CareTeam Condition Coverage DiagnosticReport DocumentReference Encounter Medication MedicationAdministration MedicationRequest Observation Patient Procedure
Narcisa Torphy	FHIR® ID: 18022a84-1fd7-ba38-3567-efbc6a50e9d4 MR: 7A12mNXYstUvop2huOPJDi DOB: 1967-05-11 gender: female address: Dedham, MA 02026	Condition Coverage DiagnosticReport DocumentReference Encounter ImagingStudy Observation Patient Procedure
Roosevelt Turner	FHIR® ID: 7673112e-f252-3c46-a7e7-ac1e1fe3fa45 MR: 9B34oPZWuwQxyj4kvQRKEj DOB: 1994-08-29 gender: male address: Boston, MA 02467	AllergyIntolerance CarePlan CareTeam Condition Coverage DiagnosticReport DocumentReference Encounter Observation Patient Procedure ServiceRequest
Keva Green	FHIR® ID: 81c2f5eb-f99f-40c4-b504-59483e6148d7 MR: kyHGADnvX3xbkU4V9ayaqh DOB: 1995-08-26 gender: female address: Hillsboro, OR 97123 Note: This is an editable test patient, so demographic data may be different from what you see listed here.	Account AllergyIntolerance Appointment Condition Coverage DiagnosticReport DocumentReference Encounter Immunization MedicationRequest MedicationAdministration RelatedPerson ServiceRequest Specimen

Patient

Identifiers / Demographics

Resources

Synthia Davis

FHIR® ID: fbee8d6b-5acf-370c-7edd-af0d84f5288c

MR: 3Y67hJYUopQywm8frKLGBf

DOB: 2000-10-10

gender: female

address: Revere, MA 02151

Appointment

CarePlan

CareTeam

Condition

Coverage

Device

DiagnosticReport

DocumentReference

Encounter

Goal

Immunization

MedicationRequest

Observation

Patient

Procedure

ServiceRequest

Micheal Shields

FHIR® ID: 307b6419-5147-4716-10b1-bb458ac191c3

MR: 5Z89kLZWqrSzvn9gtNMHCh

DOB: 2003-07-19

gender: female

address: Fairhaven, MA

AllergyIntolerance

Appointment

CarePlan

CareTeam

Condition

Coverage

DiagnosticReport

DocumentReference

Encounter

Medication

MedicationAdministration

MedicationRequest

Observation

Patient

Procedure

Narcisa Torphy

FHIR® ID: 18022a84-1fd7-ba38-3567-efbc6a50e9d4

MR: 7A12mNXYstUvop2huOPJDi

DOB: 1967-05-11

gender: female

address: Dedham, MA 02026

Condition

Coverage

DiagnosticReport

DocumentReference

Encounter

ImagingStudy

Observation

Patient

Procedure

Roosevelt Turner

FHIR® ID: 7673112e-f252-3c46-a7e7-ac1e1fe3fa45

MR: 9B34oPZWuwQxyj4kvQRKEj

DOB: 1994-08-29

gender: male

address: Boston, MA 02467

AllergyIntolerance

CarePlan

CareTeam

Condition

Coverage

DiagnosticReport

DocumentReference

Encounter

Observation

Patient

Procedure

ServiceRequest

Keva Green

FHIR® ID: 81c2f5eb-f99f-40c4-b504-59483e6148d7

MR: kyHGADnvX3xbkU4V9ayaqh

DOB: 1995-08-26

gender: female

address: Hillsboro, OR 97123

Note: This is an editable test patient, so demographic data may be different from what you see listed here.

Account

AllergyIntolerance

Appointment

Condition

Coverage

DiagnosticReport

DocumentReference

Encounter

Immunization

MedicationRequest

MedicationAdministration

RelatedPerson

ServiceRequest

Specimen

Test patients CSV file

Our sandbox environment has hundreds of available test patients seeded with associated clinical data. Find the Test Patients CSV file on the Developer > Test Tools > Dev Tool Downloads page of the Redox dashboard. The patients in the CSV file support read, query, and writeback requests. Learn how to use developer test tools.

Download a CSV file with the test patients available in the Redox FHIR sandbox.

FYI: Data from Synthea

We generated some of our test data from an open-source dataset called Synthea™.

Jason Walonoski, Mark Kramer, Joseph Nichols, Andre Quina, Chris Moesel, Dylan Hall, Carlton Duffett, Kudakwashe Dube, Thomas Gallagher, Scott McLachlan, Synthea: An approach, method, and software mechanism for generating synthetic patients and the synthetic electronic health care record, Journal of the American Medical Informatics Association, Volume 25, Issue 3, March 2018, Pages 230–238, https://doi.org/10.1093/jamia/ocx079

Example search responses

Refer to the code examples below to see what kind of responses to expect. So you know, the bundle.id field in the response is different for each request.

Example: Response for a patient search with MR identifier

json

1
{
2
  "id": "30e87b5f-f3ae-4118-99e2-6b06621c1d37",
3
  "resourceType": "Bundle",
4
  "type": "searchset",
5
  "entry": [
6
    {
7
      "resource": {
8
        "id": "5a8ca233-5aee-47a7-b5d1-9976a94a98f7",
9
        "environment_id": "d7c2d4d0-4349-49ac-bd58-9bc9d722d359",
10
        "identifier": [
11
          {
12
            "value": "1X45iGXUozTwnc5dsJKFAe",
13
            "system": "urn:redox:redox-fhir-sandbox:MR"
14
          },
15
          {
16
            "use": "secondary",
17
            "value": "S99910612",
18
            "system": "urn:redox:redox-fhir-sandbox:DL"
19
          },
20
          {
21
            "use": "secondary",
22
            "value": "X37324658X",
23
            "system": "urn:redox:redox-fhir-sandbox:PPN"
24
          },
25
          {
26
            "use": "secondary",
27
            "value": "999-68-4590",
28
            "system": "http://hl7.org/fhir/sid/us-ssn"
29
          }
30
        ],
31
        "active": true,
32
        "name": [
33
          {
34
            "use": "official",
35
            "given": ["Gus"],
36
            "family": "Smitham"
37
          }
38
        ],
39
        "telecom": [
40
          {
41
            "use": "home",
42
            "value": "555-100-8501",
43
            "system": "phone"
44
          },
45
          {
46
            "use": "mobile",
47
            "value": "555-817-9005",
48
            "system": "phone"
49
          },
50
          {
51
            "value": "Gus.Smitham-98@syntheamail.com",
52
            "system": "email"
53
          }
54
        ],
55
        "gender": "male",
56
        "birthDate": "1948-01-06",
57
        "deceasedDateTime": null,
58
        "address": [
59
          {
60
            "use": "home",
61
            "city": "Beaverton",
62
            "line": ["933 Fritsch Way"],
63
            "state": "MI",
64
            "country": "US",
65
            "postalCode": "48612"
66
          }
67
        ],
68
        "maritalStatus": {
69
          "text": "S",
70
          "coding": [
71
            {
72
              "code": "S",
73
              "system": "http://hl7.org/fhir/v3/MaritalStatus",
74
              "display": "Never Married"
75
            }
76
          ]
77
        },
78
        "generalPractitioner": [
79
          {
80
            "reference": "Practitioner/88c69bfc-96ce-4bc7-b9dc-9420ba14b6fc"
81
          }
82
        ],
83
        "link": null,
84
        "created_at": "2020-10-12T18:23:12.162Z",
85
        "updated_at": null,
86
        "contact": null,
87
        "extension": [
88
          {
89
            "url": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-race",
90
            "extension": [
91
              {
92
                "url": "text",
93
                "valueString": "White"
94
              }
95
            ]
96
          },
97
          {
98
            "url": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity",
99
            "extension": [
100
              {
101
                "url": "ombCategory",
102
                "valueCoding": {
103
                  "code": "2186-5",
104
                  "system": "urn:oid:2.16.840.1.113883.6.238",
105
                  "display": "Non Hispanic or Latino"
106
                }
107
              },
108
              {
109
                "url": "text",
110
                "valueString": "Not Hispanic"
111
              }
112
            ]
113
          }
114
        ],
115
        "communication": [
116
          {
117
            "language": {
118
              "text": "English"
119
            }
120
          }
121
        ],
122
        "meta": null,
123
        "contained": null,
124
        "resourceType": "Patient"
125
      },
126
      "search": {
127
        "mode": "match",
128
        "score": 1
129
      }
130
    }
131
  ],
132
  "total": 1
133
}

Example: Response for a patient search with SSN identifier

json

1
{
2
  "id": "a9ff2e9f-3bb6-4ed4-a154-ebeb6c271f24",
3
  "resourceType": "Bundle",
4
  "type": "searchset",
5
  "entry": [
6
    {
7
      "resource": {
8
        "id": "34d5d139-4cd8-4edc-8736-f25bdcad2b9e",
9
        "environment_id": "d7c2d4d0-4349-49ac-bd58-9bc9d722d359",
10
        "identifier": [
11
          {
12
            "value": "hgJfcpJnHWDpoYFmNWjtpu",
13
            "system": "urn:redox:redox-fhir-sandbox:MR"
14
          },
15
          {
16
            "use": "secondary",
17
            "value": "999-44-3722",
18
            "system": "http://hl7.org/fhir/sid/us-ssn"
19
          }
20
        ],
21
        "active": true,
22
        "name": [
23
          {
24
            "use": "official",
25
            "given": ["Jude"],
26
            "family": "Welch"
27
          }
28
        ],
29
        "telecom": [
30
          {
31
            "use": "home",
32
            "value": "555-360-1507",
33
            "system": "phone"
34
          },
35
          {
36
            "use": "mobile",
37
            "value": "555-798-2412",
38
            "system": "phone"
39
          },
40
          {
41
            "value": "Jude.Welch-19@syntheamail.com",
42
            "system": "email"
43
          }
44
        ],
45
        "gender": "male",
46
        "birthDate": "2008-04-11",
47
        "deceasedDateTime": null,
48
        "address": [
49
          {
50
            "use": "home",
51
            "city": "Troy",
52
            "line": ["806 Durgan Alley Unit 4"],
53
            "state": "OH",
54
            "country": "US",
55
            "postalCode": "45373"
56
          }
57
        ],
58
        "maritalStatus": {
59
          "text": "Never Married",
60
          "coding": [
61
            {
62
              "code": "S",
63
              "system": "http://hl7.org/fhir/v3/MaritalStatus",
64
              "display": "Never Married"
65
            }
66
          ]
67
        },
68
        "generalPractitioner": [
69
          {
70
            "reference": "Practitioner/a09eca7c-f69e-42ac-bf65-d24b33dd9c37"
71
          }
72
        ],
73
        "link": null,
74
        "created_at": "2020-10-12T19:33:46.130Z",
75
        "updated_at": null,
76
        "contact": null,
77
        "extension": [
78
          {
79
            "url": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-race",
80
            "extension": [
81
              {
82
                "url": "text",
83
                "valueString": "White"
84
              }
85
            ]
86
          },
87
          {
88
            "url": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity",
89
            "extension": [
90
              {
91
                "url": "ombCategory",
92
                "valueCoding": {
93
                  "code": "2186-5",
94
                  "system": "urn:oid:2.16.840.1.113883.6.238",
95
                  "display": "Non Hispanic or Latino"
96
                }
97
              },
98
              {
99
                "url": "text",
100
                "valueString": "Not Hispanic"
101
              }
102
            ]
103
          }
104
        ],
105
        "communication": [
106
          {
107
            "language": {
108
              "text": "English"
109
            }
110
          }
111
        ],
112
        "meta": null,
113
        "contained": null,
114
        "resourceType": "Patient"
115
      },
116
      "search": {
117
        "mode": "match",
118
        "score": 1
119
      }
120
    }
121
  ],
122
  "total": 1
123
}

Example: Response for a patient search with demographics and phone number

json

1
{
2
  "id": "d4440bbb-bb71-46b7-8d1a-316cd84a5ebf",
3
  "resourceType": "Bundle",
4
  "type": "searchset",
5
  "entry": [
6
    {
7
      "resource": {
8
        "id": "35cc950a-aa90-4130-b6a8-9dd83965fc42",
9
        "environment_id": "d7c2d4d0-4349-49ac-bd58-9bc9d722d359",
10
        "identifier": [
11
          {
12
            "value": "ctQgwYF6kNCgiuxdb7z7p9",
13
            "system": "urn:redox:redox-fhir-sandbox:MR"
14
          },
15
          {
16
            "use": "secondary",
17
            "value": "S99921352",
18
            "system": "urn:redox:redox-fhir-sandbox:DL"
19
          },
20
          {
21
            "use": "secondary",
22
            "value": "X10211256X",
23
            "system": "urn:redox:redox-fhir-sandbox:PPN"
24
          },
25
          {
26
            "use": "secondary",
27
            "value": "999-26-7604",
28
            "system": "http://hl7.org/fhir/sid/us-ssn"
29
          }
30
        ],
31
        "active": true,
32
        "name": [
33
          {
34
            "use": "official",
35
            "given": ["Earnest"],
36
            "family": "Mitchell"
37
          }
38
        ],
39
        "telecom": [
40
          {
41
            "use": "home",
42
            "value": "555-762-3229",
43
            "system": "phone"
44
          },
45
          {
46
            "value": "Earnest.Mitchell-15@syntheamail.com",
47
            "system": "email"
48
          }
49
        ],
50
        "gender": "male",
51
        "birthDate": "1998-06-10",
52
        "deceasedDateTime": null,
53
        "address": [
54
          {
55
            "use": "home",
56
            "city": "Summit",
57
            "line": ["746 Kohler Trail"],
58
            "state": "NJ",
59
            "country": "US"
60
          }
61
        ],
62
        "maritalStatus": {
63
          "text": "Never Married",
64
          "coding": [
65
            {
66
              "code": "S",
67
              "system": "http://hl7.org/fhir/v3/MaritalStatus",
68
              "display": "Never Married"
69
            }
70
          ]
71
        },
72
        "generalPractitioner": [
73
          {
74
            "reference": "Practitioner/03ed22e7-1b0a-4313-9c7d-0fb09d219483"
75
          }
76
        ],
77
        "link": null,
78
        "created_at": "2020-10-12T17:55:58.565Z",
79
        "updated_at": null,
80
        "contact": null,
81
        "extension": [
82
          {
83
            "url": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-race",
84
            "extension": [
85
              {
86
                "url": "text",
87
                "valueString": "White"
88
              }
89
            ]
90
          },
91
          {
92
            "url": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity",
93
            "extension": [
94
              {
95
                "url": "ombCategory",
96
                "valueCoding": {
97
                  "code": "2186-5",
98
                  "system": "urn:oid:2.16.840.1.113883.6.238",
99
                  "display": "Non Hispanic or Latino"
100
                }
101
              },
102
              {
103
                "url": "text",
104
                "valueString": "Not Hispanic"
105
              }
106
            ]
107
          }
108
        ],
109
        "communication": [
110
          {
111
            "language": {
112
              "text": "English"
113
            }
114
          }
115
        ],
116
        "meta": null,
117
        "contained": null,
118
        "resourceType": "Patient"
119
      },
120
      "search": {
121
        "mode": "match",
122
        "score": 1
123
      }
124
    }
125
  ],
126
  "total": 1
127
}

Example: Response for a patient search with demographics and city/state

json

1
{
2
  "id": "b6aad1be-024e-4b7c-80dd-32a144a8c91e",
3
  "resourceType": "Bundle",
4
  "type": "searchset",
5
  "entry": [
6
    {
7
      "resource": {
8
        "id": "4c5d0ad8-cd0f-45fc-a670-5f9c7cabf844",
9
        "environment_id": "d7c2d4d0-4349-49ac-bd58-9bc9d722d359",
10
        "identifier": [
11
          {
12
            "value": "vnFCX1PcEi7FAm32jrbnjj",
13
            "system": "urn:redox:redox-fhir-sandbox:MR"
14
          },
15
          {
16
            "use": "secondary",
17
            "value": "S99987926",
18
            "system": "urn:redox:redox-fhir-sandbox:DL"
19
          },
20
          {
21
            "use": "secondary",
22
            "value": "999-37-3216",
23
            "system": "http://hl7.org/fhir/sid/us-ssn"
24
          }
25
        ],
26
        "active": true,
27
        "name": [
28
          {
29
            "use": "official",
30
            "given": ["Ana Luisa"],
31
            "family": "Salgado"
32
          }
33
        ],
34
        "telecom": [
35
          {
36
            "use": "home",
37
            "value": "555-252-2071",
38
            "system": "phone"
39
          },
40
          {
41
            "use": "mobile",
42
            "value": "555-310-4913",
43
            "system": "phone"
44
          },
45
          {
46
            "value": "Ana Luisa.Salgado-41@syntheamail.com",
47
            "system": "email"
48
          }
49
        ],
50
        "gender": "female",
51
        "birthDate": "2003-11-25",
52
        "deceasedDateTime": null,
53
        "address": [
54
          {
55
            "use": "home",
56
            "city": "Paterson",
57
            "line": ["471 Kuhlman Burg Apt 32"],
58
            "state": "NJ",
59
            "country": "US",
60
            "postalCode": "07502"
61
          }
62
        ],
63
        "maritalStatus": {
64
          "text": "Never Married",
65
          "coding": [
66
            {
67
              "code": "S",
68
              "system": "http://hl7.org/fhir/v3/MaritalStatus",
69
              "display": "Never Married"
70
            }
71
          ]
72
        },
73
        "generalPractitioner": [
74
          {
75
            "reference": "Practitioner/23d36780-ec5b-4491-8a74-046fcbd922bf"
76
          }
77
        ],
78
        "link": null,
79
        "created_at": "2020-10-12T12:42:05.459Z",
80
        "updated_at": "2020-10-12T16:45:01.513Z",
81
        "contact": null,
82
        "extension": [
83
          {
84
            "url": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-race",
85
            "extension": [
86
              {
87
                "url": "text",
88
                "valueString": "White"
89
              }
90
            ]
91
          },
92
          {
93
            "url": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity",
94
            "extension": [
95
              {
96
                "url": "ombCategory",
97
                "valueCoding": {
98
                  "code": "2135-2",
99
                  "system": "urn:oid:2.16.840.1.113883.6.238",
100
                  "display": "Hispanic or Latino"
101
                }
102
              },
103
              {
104
                "url": "text",
105
                "valueString": "Hispanic"
106
              }
107
            ]
108
          }
109
        ],
110
        "communication": [
111
          {
112
            "language": {
113
              "text": "Spanish"
114
            }
115
          }
116
        ],
117
        "meta": null,
118
        "contained": null,
119
        "resourceType": "Patient"
120
      },
121
      "search": {
122
        "mode": "match",
123
        "score": 1
124
      }
125
    }
126
  ],
127
  "total": 1
128
}

Write data to the Redox FHIR® sandbox

Our FHIR® sandbox supports saving information from external systems. This allows you to:

Create unique patient populations specific to your system or product.
Create and assign unique clinical data to patient records.
Write test results or documents to one of your test patient records.
Writeback not supported for Redox patients
You can only perform writeback requests for test patient records you’ve created, not Redox test patients.

The sandbox supports all of our FHIR® writeback requests. Learn about writeback requests.

Confidential data

You shouldn’t include confidential data, like personal health information (PHI), when writing data to the Redox FHIR® sandbox. Since it’s a testing environment, users from multiple organizations may save data with yours. Or if they query, they may unintentionally retrieve your saved data. Like its name suggests, our sandbox is a community tool and should be treated as such.

Writeback only available to Redox customers

You must be a Redox customer to use writeback requests in the FHIR® sandbox. Writeback is available to you as a customer, whether you’re testing your initial development or after you’ve already implemented hundreds of connections.

If you’re not a customer yet, you can still perform reads and queries to the sandbox, but not writebacks. Talk to a Redoxer if you’re interested in the writeback feature of our FHIR® sandbox.

Writeback tips

To send a successful writeback request, we recommend reviewing some best practices.

Don’t copy examples from Redox FHIR API schemas

Start with a Bundle object

Include a MessageHeader resource

Use resource IDs and fullURLs correctly

Reference resources within the bundle appropriately

A bundle is an assortment of related but independent FHIR® resources. A reference indicates a one-way relationship from one resource to another. References are crucial for maintaining data integrity and context in a bundle. Check out the FHIR® glossary for more definitions and details.

You can use references to link to existing resources in the FHIR® sandbox. That means you don’t necessarily have to include the full resource every time you reference it. See the example Observation resource below, which includes references to related Patient and Encounter resources.

Example: Observation resource with Patient and Encounter references

json

1
{
2
    "fullUrl": "urn:uuid:c1672713-83ed-69b6-2242-75b0f0cc7d66",
3
    "resource": {
4
      "resourceType": "Observation",
5
      "id": "c1672713-83ed-69b6-2242-75b0f0cc7d66",
6
      "status": "final",
7
      "category": [ {
8
        "coding": [ {
9
          "system": "http://terminology.hl7.org/CodeSystem/observation-category",
10
          "code": "vital-signs",
11
          "display": "vital-signs"
12
        } ]
13
      } ],
14
      "code": {
15
        "coding": [ {
16
          "system": "http://loinc.org",
17
          "code": "8302-2",
18
          "display": "Body Height"
19
        } ],
20
        "text": "Body Height"
21
      },
22
      "subject": {
23
        "reference": "Patient/307b6419-5147-4716-10b1-bb458ac191c3"
24
      },
25
      "encounter": {
26
        "reference": "urn:uuid:1bea528e-d3e4-6f65-bc23-982eee4d618d"
27
      },
28
      "effectiveDateTime": "2021-09-11T20:15:57-04:00",
29
      "issued": "2021-09-11T20:15:57.319-04:00",
30
      "valueQuantity": {
31
        "value": 160.8,
32
        "unit": "cm",
33
        "system": "http://unitsofmeasure.org",
34
        "code": "cm"
35
      }
36
    }
37
}

When creating a writeback bundle, make sure the reference fields contain either the:

resource ID
fullURL

The example above shows both types. If the resource already exists in the FHIR® sandbox, use the resource ID. If the resource doesn’t exist, use the fullURL. Including incorrect references in the bundle will cause your message to fail.

Also, the message may fail if you’re copying example payloads from our FHIR® specs. The intent of our FHIR® specs is to show the full schema shape, not necessarily provide a sample call for you to use.

Know when to create vs. reference resources

Troubleshoot FHIR writeback errors

We all need a little help sometimes. If you run into errors, check out our troubleshooting guide.

Static administration resource examples

You’ll typically need to include administrative references for writeback messages, like Practitioner, Location, and Organization. Below are some example references you can use as inputs to leverage existing resources in your test bundles:

Resource	Examples
Practitioner	Practitioner/7efc2275-b837-42d7-af6d-1386f8a618ae Practitioner/dbed0f85-e3cd-47ac-9305-3f629e138832 Practitioner/264f7ec9-3bd4-3268-b88c-ec9618b4dd1a Practitioner/fff2db55-4039-42b6-a3c1-c61991b6752b Practitioner/ffff2b69-26d1-46a8-bd2d-1cdc38eb7ba0
Location	Location/0066e68c-8ea1-46f2-9716-40410b97894d Location/006eed1d-6691-496a-b36d-90a666f4f27d Location/ed4afd58-9796-4cc5-aed7-5c47345acec9 Location/02321b8d-5096-4797-a7a7-dece90df4342 Location/02bd7825-dd5f-4264-880b-7d9f846de281
Organization	Organization/1aedcb45-c507-3ad0-9010-6583d264ae72 Organization/308b5efa-a9c2-3728-b1ff-d29c5f060731 Organization/90cf148c-69ed-3d33-aa86-b509c6b0b25f Organization/700056a6-3aea-3efd-8423-a9acbd38a5ea Organization/0f7f97f6-693c-3de9-8190-85feaf4632e2

Resource

Examples

Practitioner

Practitioner/7efc2275-b837-42d7-af6d-1386f8a618ae

Practitioner/dbed0f85-e3cd-47ac-9305-3f629e138832

Practitioner/264f7ec9-3bd4-3268-b88c-ec9618b4dd1a

Practitioner/fff2db55-4039-42b6-a3c1-c61991b6752b

Practitioner/ffff2b69-26d1-46a8-bd2d-1cdc38eb7ba0

Location

Location/0066e68c-8ea1-46f2-9716-40410b97894d

Location/006eed1d-6691-496a-b36d-90a666f4f27d

Location/ed4afd58-9796-4cc5-aed7-5c47345acec9

Location/02321b8d-5096-4797-a7a7-dece90df4342

Location/02bd7825-dd5f-4264-880b-7d9f846de281

Organization

Organization/1aedcb45-c507-3ad0-9010-6583d264ae72

Organization/308b5efa-a9c2-3728-b1ff-d29c5f060731

Organization/90cf148c-69ed-3d33-aa86-b509c6b0b25f

Organization/700056a6-3aea-3efd-8423-a9acbd38a5ea

Organization/0f7f97f6-693c-3de9-8190-85feaf4632e2

Example writeback responses

You can typically expect either a 200 or 201 in response to your writeback message.

HTTP response	Description
200	A resource that already exists in the FHIR® sandbox was successfully updated with the content in your writeback payload. The resource ID was updated can be found in the location value.
201	A resource was created within the FHIR® sandbox. This means the the sandbox didn’t locate a resource that matched the input criteria.

HTTP response

Description

200

A resource that already exists in the FHIR® sandbox was successfully updated with the content in your writeback payload.

The resource ID was updated can be found in the location value.

201

A resource was created within the FHIR® sandbox. This means the the sandbox didn’t locate a resource that matched the input criteria.

Individual resource responses will be included in the entry array of the response. The number of objects depends on the number of resources included within your bundle.

Refer to the example below if you want to know what kind of response to expect.

Example: Successful writeback response

json

1
"body": {
2
    "entry": [
3
      {
4
        "response": {
5
          "etag": "W/\"MTcyMTA2NTY2MzE0OTAyMTAwMA\"",
6
          "lastModified": "2024-07-15T17:47:43.149021+00:00",
7
          "location": "https://fhir.redoxengine.com/fhir-sandbox/Appointment/bf4d58c5-aeaa-4c2f-8c69-c57c9f198637/_history/MTcyMTA2NTY2MzE0OTAyMTAwMA",
8
          "status": "201 Created"
9
        }
10
      },
11
      {
12
        "response": {
13
          "etag": "W/\"MTcyMTA2NTY2MzE0OTAyMTAwMA\"",
14
          "lastModified": "2024-07-15T17:47:43.149021+00:00",
15
          "location": "https://fhir.redoxengine.com/fhir-sandbox/Patient/b0a06ead-cc42-aa48-dad6-841d4aa679fa/_history/MTcyMTA2NTY2MzE0OTAyMTAwMA",
16
          "status": "200 OK"
17
        }
18
      }
19
    ],
20
    "resourceType": "Bundle",
21
    "type": "transaction-response"
22
  }

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

Test with Redox FHIR sandbox data

When Redox refreshes the sandbox

Discover test patient data

Search tips

Redox test patients

Example search responses

Write data to the Redox FHIR® sandbox

Writeback tips

Don’t copy examples from Redox FHIR API schemas

Start with a Bundle object

Include a MessageHeader resource

Use resource IDs and fullURLs correctly

Writing data to existing resources

Creating new resources

Reference resources within the bundle appropriately

Know when to create vs. reference resources

Static administration resource examples

Example writeback responses

Table of Contents