Organization Query

This data model allows you to retrieve information about organizations from a clinical network (e.g., Carequality Interoperability Framework) or an EHR-maintained list. The most common use case is to see a list of available organizations to query via the Carequality Framework.

This data model has event types that allow you to:

create a new or update an existing organization record; or
query for and receive organization records.

For external organizations

Keep in mind this doesn't relate to Redox organizations, sources, or destinations. It's used to synchronize your system with externally maintained lists of organizations.

Query

Query for an organization’s details, including its OID, using a ZIP code radius or organization name. Results are returned in Organization.QueryReponse.

Query parameters for CommonWell and TEFCA-CommonWell

CommonWell and TEFCA-CommonWell only support these query parameters:

NameSearch
Identifier.ID

This means you can’t query with State, RadiusSearch, or lastUpdated.

All these query parameters are supported for Carequality queries, though.

Beta

Request Body Schema

Show Required Fields Only

Show Translation Fields

Meta
required, object
- DataModel
  required, string
  Reliable
  Organization
- EventType
  required, string
  Reliable
  Query
- 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.
Directory
required, string
Probable
Directory to query.
one of: Carequality, TEFCA-CommonWell, CommonWell
Identifier
object
ID and ID Type of the organization to query information for.
Use this object to target a specific organization. Available on all networks.
- ID
  string, null
  Probable
  ID of organization to query information for.
  Available on all networks (Carequality, TEFCA-CommonWell, CommonWell)
- IDType
  string, null
  Probable
  IDType of organization to query information for.
  Available on Carequality only. Not supported for TEFCA-CommonWell or CommonWell networks.
NameSearch
object
An object to specify name search parameters.
Available on all networks (Carequality, TEFCA-CommonWell, CommonWell)
- SearchType
  string, null
  Probable
  The search type, which should be one of: exact or contains.
  The contains searchType finds all organizations that are linked to the parent org name you specify in the NameSearch.Value field. Available on all networks.
- Value
  string, null
  Probable
  The value to use in the NameSearch (the name).
  Available on all networks (Carequality, TEFCA-CommonWell, CommonWell)
State
string, null
Probable
The state to search for organizations in.
Available on Carequality only. Not supported for TEFCA-CommonWell or CommonWell networks.
RadiusSearch
object
An object to specify radius query parameters.
Available on Carequality only. Not supported for TEFCA-CommonWell or CommonWell networks.
- ZipCode
  string, null
  Probable
  The ZipCode to target for a zip radius search.
  Available on Carequality only. Not supported for TEFCA-CommonWell or CommonWell networks.
- Radius
  string, null
  Probable
  The radius, in miles, to search for organizations around the provided ZipCode.
  Available on Carequality only. Not supported for TEFCA-CommonWell or CommonWell networks.
LastUpdated
string, null
Probable
The earliest last updated DateTime to be included.
Available on Carequality only. Not supported for TEFCA-CommomWell or CommonWell networks. If populated, only organizations that were last updated on or after this DateTime will be returned.
Index
string, null
Probable
The index to return results starting from. Used for paged results.
Available on all networks (Carequality, TEFCA-CommonWell, CommonWell)
Limit
string, null
Probable
The maximum results you want in the response. default: 500.
Available on all networks (Carequality, TEFCA-CommonWell, CommonWell)
Active
boolean, null
Probable
If the organization is considered active.
Available on Carequality only. Not supported for TEFCA-CommonWell or CommonWell networks. If true, only active organizations will be returned. If false, only inactive organizations will be returned. Default: true.

Example

json

1
{
2
  "Meta": {
3
    "DataModel": "Organization",
4
    "EventType": "Query",
5
    "EventDateTime": "2025-06-18T21:39:39.976Z",
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
  "Directory": "Carequality",
26
  "Identifier": {
27
    "ID": "1.3.6.1",
28
    "IDType": "OID"
29
  },
30
  "NameSearch": {
31
    "SearchType": null,
32
    "Value": null
33
  },
34
  "State": null,
35
  "RadiusSearch": {
36
    "ZipCode": null,
37
    "Radius": null
38
  },
39
  "LastUpdated": "2020-02-11T14:58:03.532Z",
40
  "Index": null,
41
  "Limit": 20,
42
  "Active": null
43
}

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