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.
Query for an organization’s details, including its OID, using a ZIP code radius or organization name. Results are returned in Organization.QueryReponse.
Request Body Schema
- Metarequired, object
- DataModelrequired, stringReliable
Organization
- EventTyperequired, stringReliable
Query
- EventDateTimestring, nullReliable
Displays the UTC date and time that an outgoing request is delivered or an incoming request is received.
ISO 8601 Format - Testboolean, nullReliable
Indicates whether the request is a test or not.
- Sourceobject
Contains the information for the system initiating the message, including the source ID and name.
Included in messages from Redox- IDstring, nullReliable
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 - Namestring, nullReliable
Displays the name of the system initiating the message.
- DestinationsArray 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.- IDstring, nullReliable
Identifies the endpoint that the request is directed to.
UUID - Namestring, nullReliable
Displays the name of the endpoint that the request is directed to.
- LogsArray of object
Contains the log identifier(s) for the request.
- IDstring, nullReliable
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 - AttemptIDstring, nullReliable
Identifies the request log attempt value, which is useful when retries are possible.
UUID
- FacilityCodestring, nullPossible
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.
- Directoryrequired, stringProbable
Directory to query.
one of: Carequality, TEFCA-CommonWell, CommonWell - Identifierobject
ID and ID Type of the organization to query information for.
Use this object to target a specific organization. Available on all networks.- IDstring, nullProbable
ID of organization to query information for.
Available on all networks (Carequality, TEFCA-CommonWell, CommonWell) - IDTypestring, nullProbable
IDType of organization to query information for.
Available on Carequality only. Not supported for TEFCA-CommonWell or CommonWell networks.
- NameSearchobject
An object to specify name search parameters.
Available on all networks (Carequality, TEFCA-CommonWell, CommonWell)- SearchTypestring, nullProbable
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. - Valuestring, nullProbable
The value to use in the NameSearch (the name).
Available on all networks (Carequality, TEFCA-CommonWell, CommonWell)
- Statestring, nullProbable
The state to search for organizations in.
Available on Carequality only. Not supported for TEFCA-CommonWell or CommonWell networks. - RadiusSearchobject
An object to specify radius query parameters.
Available on Carequality only. Not supported for TEFCA-CommonWell or CommonWell networks.- ZipCodestring, nullProbable
The ZipCode to target for a zip radius search.
Available on Carequality only. Not supported for TEFCA-CommonWell or CommonWell networks. - Radiusstring, nullProbable
The radius, in miles, to search for organizations around the provided ZipCode.
Available on Carequality only. Not supported for TEFCA-CommonWell or CommonWell networks.
- LastUpdatedstring, nullProbable
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. - Indexstring, nullProbable
The index to return results starting from. Used for paged results.
Available on all networks (Carequality, TEFCA-CommonWell, CommonWell) - Limitstring, nullProbable
The maximum results you want in the response. default: 500.
Available on all networks (Carequality, TEFCA-CommonWell, CommonWell) - Activeboolean, nullProbable
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.