Search TEFCA-CommonWell for patient records

• You must have populated your Redox data on demand repository with your existing patients. Learn how to populate your patient repository.
• (Optional) Test sending these requests with our TEFCA-CommonWell sandbox. Learn about our TEFCA-CommonWell sandbox.

  Use curl for technical validation

  You can copy our code examples and send the test requests with curl (learn more about curl) instead of Postman. If you do, remember to:

  • Remove any comments from the code examples (starting with //).
  • Replace any variables (e.g., {{YOUR-VARIABLE}}).
  • Add the source-id if you have multiple sources. We don’t include {{source-id}} in the code examples, so you’ll have to add them yourself. Learn about including source details.
  • Make sure you have a full request for your own use since some of the code examples are abbreviated.

  Check out these troubleshooting guides if you run into errors:

  • Troubleshoot TEFCA-CommonWell errors
  • Troubleshoot OAuth API key errors

• Be familiar with the following terms and concepts to send your queries to TEFCA-CommonWell:

  TEFCA-CommonWell terms to know

  Term	Description
  Organization or object ID (OID)	Identifies a particular healthcare organization within the TEFCA-CommonWell network. When you create a new organization record within TEFCA, the returned OID becomes the sender organization ID for your later queries.
  Patient Identity Assigning Authority (PIAA)	The entity that assigns patient identifiers in the healthcare system. This value becomes the ID type in the metadata of TEFCA-CommonWell queries for documents.

  Metadata for TEFCA-CommonWell requests

  This table contains the metadata fields for Redox data models if you’re querying or sending requests to TEFCA-CommonWell via the Redox Data Model API.

  Field	Description	Notes
  Meta.Destinations.ID	A universally unique identifier (UUID) for the destination you wish to search. This ID is different for staging and production environments. Check out the destination ID table for specifics.	For patient searches, this is a CommonWell EMPI destination. For document searches, this is a CommonWell XCA destination. For responding with information about your patients, this is your own document repository.
  Meta.FacilityCode	Set to your organization OID or null.	This is required for document searches. A less common workflow might include directly querying to an external organization within the network. In that case, use their organization OID.
  Meta.Extensions.organization-name	The name of the organization running the query.	Generally, this is the name of your organization or the covered entity that you’re providing services for.
  Meta.Extensions.sender-organization-id	The organizational OID to identify your organization as the one sending the request.	This field is used for audit purposes and for search logic. To generate your organization OID for the sender-organization-id extension, refer to TEFCA identity and organization structure.
  Meta.Extensions.user-id	Either the name of the user sending the request or the relevant provider. This should be a human-readable identifier and is required for audit purposes.	The provider’s name should still be populated when an automated process runs the query. For example, a provider may have an automated process triggered after completing a patient visit. In that case, the query runs in the background on the provider’s behalf.
  Meta.Extensions.user-role	The role of the user sending the request.	You must use a SNOMED value for this field. See SNOMED codes.
  Meta.Extensions.purpose-of-use	The purpose of use for this request (e.g., Treatment).	You must qualify for a "Treatment" purpose of use when using Network Onramps.

  Destination IDs for TEFCA-CommonWell

  You must populate any test requests with the appropriate destination ID in the Meta.Destinations array based on the environment and type of requests:

  Query purpose	Development ID	Production ID
  Perform a patient search (PatientSearch.LocationQuery)	3122bfff-f1fb-4fdf-97de-294f24338229	7fd005ac-d788-40c5-b4e8-b57bb8e310a9
  Create or update an organization (Organization.New, Organization.Update)	3122bfff-f1fb-4fdf-97de-294f24338229	7fd005ac-d788-40c5-b4e8-b57bb8e310a9
  Search for a clinical summary/document (ClinicalSummary.DocumentQuery, ClinicalSummary.DocumentGet)	cf1dca0e-98de-432b-8c9a-dd039816df0e	79981c00-b9c4-40a9-9844-01980e6e524e
  Save patient details to your repository (PatientAdmin.NewPatient, PatientAdmin.PatientUpdate, PatientAdmin.PatientMerge)	3122bfff-f1fb-4fdf-97de-294f24338229	7fd005ac-d788-40c5-b4e8-b57bb8e310a9
  Save documents to your repository (ClinicalSummary.VisitQuery, ClinicalSummary.VisitPush)	This is specific to your organization. Redox provides the correct ID.	This is specific to your organization. Redox provides the correct ID.

Searching TEFCA-CommonWell for patient records is an optional step if you want to:

• Confirm that you’ve already added a patient record in your repository for TEFCA-CommonWell. If the patient isn’t found with the steps in this how-to guide, you should add it. Learn how to populate your patient repository.
• Locate specific sites to directly query. After locating a site, use the organization OID in the location query response to request patient records.

First, using Postman or curl, send a PatientSearch.LocationQuery request with either the network patient ID or patient demographics to the CommonWell EMPI destination.

• The Meta.Destination.ID changes based on environment type:
  • Development destination ID: adf917b5-1496-4241-87e2-ed20434b1fdb
  • Production destination ID: 97f2dc1d-c71b-43a7-a436-9b789d44c804
• For production queries, set the Test value to false.
• The network patient ID is the patient identifier from TEFCA-CommonWell. If you don’t have it, you can leave the Identifiers array empty and rely on demographic matching.
• For patient demographics, review the LocationQuery schema for full requirements.

1
curl \
2
-X POST https://api.redoxengine.com/endpoint \
3
-H "Content-Type: application/json" \
4
-H "Authorization: Bearer $API_TOKEN" \
5
-d '{
6
    "Meta": {
7
        "Extensions": {
8
            "sender-organization-id": {
9
                "url": "https://api.redoxengine.com/extensions/sender-organization-id",
10
                "string": "{{ORGANIZATION-OID}}"
11
            },
12
            "user-id": {
13
                "url": "https://api.redoxengine.com/extensions/user-id",
14
                "string": "{{SENDING-USER-NAME}}"
15
            },
16
            "user-role": {
17
                "url": "https://api.redoxengine.com/extensions/user-role",
18
                "coding": {
19
                    "code": "112247003",
20
                    "display": "Medical Doctor"
21
                }
22
            },
23
            "purpose-of-use": {
24
                "url": "https://api.redoxengine.com/extensions/purpose-of-use",
25
                "coding": {
26
                    "code": "TREATMENT",
27
                    "display": "Treatment"
28
                }
29
            }
30
        },
31
        "DataModel": "PatientSearch",
32
        "EventType": "LocationQuery",
33
        "Test": true,
34
        "Destinations": [
35
            {
36
                "ID": "adf917b5-1496-4241-87e2-ed20434b1fdb"
37
            }
38
        ]
39
    },
40
    "Patient": {
41
        "Identifiers": [],
42
   "Demographics": {
43
      "FirstName": "Redox",
44
      "MiddleName": null,
45
      "LastName": "Tester",
46
      "DOB": "1910-01-01",
47
      "SSN": "101-01-0001",
48
      "Sex": "Male",
49
      "Race": "White",
50
      "IsHispanic": null,
51
      "Religion": null,
52
      "MaritalStatus": "Single",
53
      "IsDeceased": null,
54
      "DeathDateTime": null,
55
      "Language": "en",
56
      "Citizenship": [],
57
      "Address": {
58
        "ZIP": "56789",
59
      }
60
    }
61
    }
62
}'

The response returns identifiers, including both ID and IDType (i.e., PIAA) and demographic information about the patient, including Organization.Identifiers[].ID. Review the LocationQueryResponse schema for full context and technical details.

1
{
2
  "Patients": [
3
    {
4
      "Identifiers": [
5
        {
6
          "ID": "sandbox-tester-123",
7
          "IDType": "2.16.840.1.113883.3.6147.450.0.2.19301.0.1"
8
        }
9
      ],
10
      "Demographics": {
11
        "FirstName": "Redox",
12
        "LastName": "Tester",
13
        "Sex": "Male",
14
        "DOB": "1910-01-01",
15
        "Address": {
16
          "StreetAddress": "123 Pasture Lane",
17
          "City": "Madison",
18
          "State": "WI",
19
          "ZIP": "56789"
20
        },
21
        "PhoneNumber": {
22
          "Home": "+18088675309"
23
        }
24
      },
25
      "Organization": {
26
        "Name": "St. Barnabas Hospital",
27
        "Identifiers": [
28
          {
29
            "ID": "2.16.840.1.113883.3.6147.450.0.2.19301.0.1"
30
          }
31
        ]
32
      }
33
    },
34
    {
35
      "Identifiers": [
36
        {
37
          "ID": "sandbox-tester-on-sandbox-system-456",
38
          "IDType": "2.16.840.1.113883.3.6147.450.0.2.19260.0.2"
39
        }
40
      ],
41
      "Demographics": {
42
        "FirstName": "Redox",
43
        "LastName": "Tester",
44
        "Sex": "Male",
45
        "DOB": "1910-01-01",
46
        "Address": {
47
          "StreetAddress": "123 Pasture Lane",
48
          "City": "Madison",
49
          "State": "WI",
50
          "ZIP": "56789"
51
        },
52
        "PhoneNumber": {
53
          "Home": "+18088675309"
54
        }
55
      },
56
      "Organization": {
57
        "Name": "redox",
58
        "Identifiers": [
59
          {
60
            "ID": "2.16.840.1.113883.3.6147.450.0.2.19260.0.1"
61
          }
62
        ]
63
      }
64
    }
65
  ],
66
  "Meta": {
67
    "DataModel": "PatientSearch",
68
    "EventType": "LocationQuery",
69
    "Source": {
70
      "ID": "6b8c8f4e-7a69-4575-acb7-58efc8593302",
71
      "Name": "Integration-CW EETS"
72
    },
73
    "Destinations": [
74
      {
75
        "ID": "3122bfff-f1fb-4fdf-97de-294f24338229",
76
        "Name": "CommonWell EMPI [Integration]"
77
      }
78
    ],
79
    "Logs": [
80
      {
81
        "ID": "0196f332-ae3c-7ce3-be23-fe2faa35cf7f",
82
        "AttemptID": "0196f332-ae3c-77fd-aadd-484c95063472"
83
      }
84
    ]
85
  }
86
}

• Request patient documents