Home
How to use Redox
Interact with clinical networks
Onramp to TEFCA-CommonWell
Test sandbox for onramp to TEFCA-CommonWell

Test sandbox for onramp to TEFCA-CommonWell

Last updated: Jun 5, 2026
DEVELOPER
HEALTH TECH VENDOR

The CommonWell sandbox within Redox is integrated with the CommonWell environment, which allows you a sneak peek into what querying TEFCA-CommonWell will be like. The sandbox is a data on demand repository where test data lives. Learn more about data on demand.

Redox test patients

In order to query the sandbox, you first have to ingest our test patients. This replicates the behavior of the CommonWell EMPI, which only returns matches for patients that already exist within your organization’s repository. In other words, results won’t be returned from external participants unless a demographics match already exists in your own CommonWell dataset.

You can ingest these test patients with a PatientAdmin feed.

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

Sandbox metadata

You’ll need both of these values in the metadata of your queries to the CommonWell sandbox.

Type

Value

Sandbox organization ID (OID)

2.16.840.1.113883.3.6147.450.0.2.19260.0.1

Patient Identity Assigning Authority (PIAA)

2.16.840.1.113883.3.6147.450.0.2.19260.0.2

Redox sandbox organization

For the quickest approach, use the Redox sandbox organization as the sender-organization-id in the query metadata.

If you want to see results in the development environment of your own Redox organization, you first have to ingest test patients into your organization.

Metadata for TEFCA-CommonWell sandbox requests
json
1
"Extensions": {
2
  "purpose-of-use": {
3
     "url": "https://api.redoxengine.com/extensions/purpose-of-use",
4
     "coding": {
5
       "code": "TREATMENT"
6
     }
7
  },
8
  "sender-organization-id": {
9
     "url": "https://api.redoxengine.com/extensions/sender-organization-id",
10
     "string": "2.16.840.1.113883.3.6147.450.0.2.19260.0.1"
11
  },
12
  "assigning-authority": {
13
     "url": "https://api.redoxengine.com/extensions/assigning-authority",
14
     "string": "2.16.840.1.113883.3.6147.450.0.2.19260.0.2"
15
  },
16
  "user-id": {
17
     "url": "https://api.redoxengine.com/extensions/user-id",
18
     "string": "redox-sandbox-tester"
19
  },
20
  "user-role": {
21
     "url": "https://api.redoxengine.com/extensions/user-role",
22
     "coding": {
23
       "code": "112247003",
24
       "display": "Medical Doctor"
25
     }
26
  }
27
},

Use the TEFCA-CommonWell sandbox

  1. Create an API source in your development environment to interface with the CommonWell network.
  2. Your Technical Account Manager creates:
    1. Your data on demand destination, which houses test patient data for you. They add a unique ID type that matches your CommonWell PIAA. Learn about OIDs for CommonWell.
    2. Your CommonWell DNPR.
    3. Subscriptions with the source you created in step 1. Each subscription includes your API source and one of these data models:
      1. PatientAdmin
        Ingesting patient data

        This data model enables you to ingest test patient data into your system. Keep in mind that you can re-ingest Redox test patients using your own patient identifier, ID type, and sender-organization-id.

      2. PatientSearch
      3. ClinicalSummary
      4. Organization
  3. Create a TEFCA-CommonWell organization record for the sandbox.
    1. For the organization ID, use the directory OID from the data on demand DNPR your Technical Account Manager created for you in step 2.
    2. For the ID type, use PIAA.
    3. Set "Test": true to mark this as a sandbox organization record. This value should be false for production organizations.
    4. Replace the example values below with the source and destination IDs that were created in steps 1 and 2.
      Example: Create a development organization record
      json
      1
      {
      2
        "Meta": {
      3
          "DataModel": "Organization",
      4
          "EventType": "New",
      5
          "EventDateTime": null,
      6
          "Test": true,
      7
          "Source": {
      8
            "ID": "84fe7f6b-fe6a-48cf-a45b-ef2f195dbaaf",
      9
            "Name": "cw-sender-source"
      10
          },
      11
          "Destinations": [
      12
            {
      13
              "ID": "3122bfff-f1fb-4fdf-97de-294f24338229",
      14
              "Name": "CommonWell EMPI [Integration]"
      15
            }
      16
          ],
      17
          "Logs": [
      18
            {
      19
              "ID": "0196f43b-9f99-7111-b4c6-5d2850b767bc",
      20
              "AttemptID": "0196f43b-9f99-7b9b-bda6-bb3ec95dbaf4"
      21
            }
      22
          ],
      23
          "FacilityCode": null
      24
        },
      25
        "Directory": "CommonWell",
      26
        "Organizations": [
      27
          {
      28
            "Active": true,
      29
            "Name": "{{your-organization-name}}",
      30
            "Aliases": [],
      31
            "Identifiers": [
      32
              {
      33
                "ID": "{{assigning-authority}}",
      34
                "IDType": "PIAA"
      35
              },
      36
              {
      37
                "ID": "{{organization-OID}}",
      38
                "IDType": "OID"
      39
              }
      40
            ],
      41
            "Type": {
      42
              "System": "http://hl7.org/fhir/organization-type",
      43
              "Value": "HOSPITAL"
      44
            },
      45
            "PartOf": {
      46
              "Identifier": {
      47
                "Type": "HCID",
      48
                "System": "http://www.hl7.org/oid/",
      49
                "Value": "1.2.3.4"
      50
              }
      51
            },
      52
            "Contacts": [
      53
              {
      54
                "Purpose": null,
      55
                "Name": "Bixby, Barbara",
      56
                "EmailAddresses": [
      57
                  "barb.bixby@test.net"
      58
                ],
      59
                "PhoneNumber": {
      60
                  "Home": "+18088675303",
      61
                  "Work": null,
      62
                  "Mobile": "+19189368865"
      63
                }
      64
              }
      65
            ],
      66
            "Address": {
      67
              "StreetAddress": "123 Main St.",
      68
              "City": "ATown",
      69
              "State": "AL",
      70
              "ZIP": "86754",
      71
              "County": "Madison",
      72
              "Country": "USA"
      73
            },
      74
            "Endpoints": [
      75
              {
      76
                "Identifiers": [
      77
                  {
      78
                    "Type": "HCID",
      79
                    "System": "http://www.hl7.org/oid/",
      80
                    "Value": "2.8.1.2"
      81
                  }
      82
                ],
      83
                "ConnectionType": {
      84
                  "System": "http://hl7.org/fhir/subscription-channel-type",
      85
                  "Value": "ihe-xcpd"
      86
                },
      87
                "Name": "Patient Discovery",
      88
                "Address": "https://fake.fake.com/xcpd",
      89
                "MIMEType": "Text/XML",
      90
                "Attributes": {
      91
                  "Transaction": "XCPD ITI-55",
      92
                  "Actor": {
      93
                    "System": "https://sequoiaproject.org/StructureDefinition/Endpoint/Actor/1.0.0",
      94
                    "Value": "Responding Gateway"
      95
                  },
      96
                  "Version": {
      97
                    "System": "https://sequoiaproject.org/StructureDefinition/Endpoint/Version/1.0.0",
      98
                    "Value": "2.0"
      99
                  },
      100
                  "UseCases": [
      101
                    {
      102
                      "System": "https://sequoiaproject.org/StructureDefinition/Endpoint/UseCases/1.0.0",
      103
                      "Value": "QueryBasedDocumentExchange"
      104
                    }
      105
                  ],
      106
                  "PurposeOfUse": [
      107
                    {
      108
                      "System": "https://sequoiaproject.org/StructureDefinition/Endpoint/PurposesOfUse/1.0.0",
      109
                      "Value": "Treatment"
      110
                    }
      111
                  ],
      112
                  "Roles": [
      113
                    {
      114
                      "System": "https://sequoiaproject.org/StructureDefinition/Endpoint/Roles/1.0.0",
      115
                      "Value": "All"
      116
                    }
      117
                  ]
      118
                }
      119
              }
      120
            ],
      121
            "DestinationID": "3122bfff-f1fb-4fdf-97de-294f24338229"
      122
          }
      123
        ]
      124
      }
  4. Ingest Redox test patients with your PatientAdmin subscription.
  5. Search for patient records in the TEFCA-CommonWell sandbox.
No real PHI

You shouldn’t include any real PHI in your development environment.

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