Test with Redox FHIR sandbox data

Last updated: Apr 26, 2024

You can use the Redox FHIR® API sandbox environment to send test requests for test patients. You simply need to send requests to redox-fhir-sandbox.

Just know that the Redox FHIR® sandbox is read-only. So you can send messages and receive realistic responses, but you can't write to the sandbox. For example, if you send a test Patient$patient-create or Organization/create to our FHIR® sandbox, you'll get a successful message back, but the underlying sandbox data won't change. If you're wondering why the sandbox is read-only, it's because we wanted all of our customers to have a consistent testing experience with pre-loaded data.

Any test writeback messages receive a 200 OK response with the following body:

Redox FHIR sandbox writeback response

json

1
{
2
     "resourceType": "OperationOutcome",
3
     "id": "4e6883ba-80b6-470c-a71c-8f7aca41989e",
4
     "issue": [
5
        {
6
            "severity": "information",
7
            "code": "informational",
8
            "details": { 
9
               "text": "FHIR payload received."
10
            }
11
        {
12
     ]
13
}

So, with that said, use the test patient data below to get started.

Test patient data

We have test patient data you can use for patient, document, insurance, or encounter searches.

For patient searches

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

You can search for the following patients:

Patient name	Identifiers	Demographics
Keva Green	MR: kyHGADnvX3xbkU4V9ayaqh	DOB: 1995-08-26 Gender: Female Address: Hillsboro, OR 97123
Debra Dickens	MR: 59hoCFbR6vKPDSx2uQhbVD DL: S99933682 PPN: X46551063X SSN: 999-78-1319	DOB: 1968-06-25 Gender: Female Address: Fostoria, OH Mobile phone: (555) 578-5675 Email: Debra.Dickens-23@syntheamail.com
Earnest Mitchell	MR: ctQgwYF6kNCgiuxdb7z7p9 DL: S99921352 PPN: X10211256X SSN: 999-26-7604	DOB: 1998-06-10 Gender: Male Address: Summit, NJ Home phone: (555) 762-3229 Email: Earnest.Mitchell-15@syntheamail.com
Ana Luisa Salgado	MR: vnFCX1PcEi7FAm32jrbnjj DL: S99987926 SSN: 999-37-3216	DOB: 2003-11-25 Gender: Female Address: Paterson, NJ 07502 Home phone: (555) 252-2071 Mobile phone: (555) 310-4913 Email: Ana Luisa.Salgado-41@syntheamail.com
Gus Smitham	MR: 1X45iGXUozTwnc5dsJKFAe DL: S99910612 PPN: X37324658X SSN: 999-68-4590	DOB: 1948-01-06 Gender: Male Address: Beaverton, MI 48612 Home phone: (555) 100-8501 Mobile phone: (555) 817-9005 Email: Gus.Smitham-98@syntheamail.com
Jude Welch	MR: hgJfcpJnHWDpoYFmNWjtpu SSN: 999-44-3722	DOB: 2008-04-11 Gender: Male Address: Troy, OH 45373 Home phone: (555) 360-1507 Mobile phone: (555) 798-2412 Email: Jude.Welch-19@syntheamail.com

Some of the test patients have extra data associated with them, like document, insurance, or encounter data. If available for a given test patient, we include:

the document ID to use with the DocumentReference resource;
an indicator that insurance information exists so that you can retrieve Account and Coverage resources; and
the number of encounters so that you can retrieve the Encounter resource.

For document searches

You can search for this patient and associated documents with the DocumentReference resource:

Patient name	Identifiers	Demographics	Additional data
Laverne Rodriguez	MR: qBckEMrTPxkU4XFRZ2qxQR	DOB: 1968-03-15 Gender: Male Address: Nashville, TN	DocumentReferenceID: 197c2a40-debb-4989-a157-4a8198cab637

For insurance searches

You can search for this patient and associated insurance data with the Account and Coverage resources:

Patient name	Identifiers	Demographics	Additional data
Edmund Rowe	MR: sVyqANP4BXqmPBScTnH3y5 DL: S99927866 PPN: X8554584X SSN: 999-68-9002	DOB: 1988-06-05 Gender: Male Address: Germantown, MD	Insurance: Y

For encounter searches

You can search for this patient and associated encounter data with the Encounter resource:

Patient name	Identifiers	Demographics	Additional data
Sulema Gerhold	MR: ruS4MtiboeYjsA6tnE3nKu DL: S99965348 PPN: X36705103X SSN: 999-51-9707	DOB: 1980-07-01 Gender: Female Address: Leland, MS 38756 Mobile phone: 555-852-9398 Email: Sulema.Gerhold-84@syntheamail.com	Encounters: 5

Example responses

If you're testing against the sandbox environment and want to know what kind of responses to expect, you can refer to the examples below.

Just 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
}

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