Organization
The Organization data model is used to retrieve information about organizations from an external directory (e.g., Carequality Interoperability Framework) or EHR-maintained list. The most common use case for the Organization data model is to understand the list of available organizations to query when integrating through Carequality.
Keep in mind that the Organization data model doesn't relate to Redox concepts of organizations, sources, or destinations. It's used to synchronize your system with externally maintained lists of organizations.
Newlink
BETAFields
Meta
Meta.DataModel
String
ReliableRequiredOrganization
Meta.EventType
String
ReliableRequiredNew
Meta.EventDateTime
DateTime
ReliableDisplays the UTC date and time that an outgoing request is delivered or an incoming request is received.
ISO 8601 Format
Meta.Test
Boolean
ReliableIndicates whether the request is a test or not.
Meta.Source
String
ReliableContains the information for the system initiating the message, including the source ID and name.
Included in messages from Redox
Meta.Source.ID
String
ReliableIdentifies 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
Meta.Source.Name
String
ReliableDisplays the name of the system initiating the message.
Meta.Destinations[]
Array of Objects
ReliableContains 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.
Meta.Destinations[].ID
String
ReliableIdentifies the endpoint that the request is directed to.
UUID
Meta.Destinations[].Name
String
ReliableDisplays the name of the endpoint that the request is directed to.
Meta.Logs[]
Array of Objects
ReliableContains the log identifier(s) for the request.
Meta.Logs[].ID
String
ReliableIdentifies 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
Meta.Logs[].AttemptID
String
ReliableIdentifies the request log attempt value, which is useful when retries are possible.
UUID
Meta.FacilityCode
String
PossibleCode 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
Directory
String
ProbableRequiredDirectory this organization belongs to.
one of: Carequality
Organizations
Organizations[].Active
Boolean
ProbableRequiredIf this organization is considered active
Organizations[].Name
String
ProbableRequiredThe name of the organization
Organizations[].Aliases[]
Array of Strings
ProbableName aliases for this organization
Organizations[].Identifiers[]
Array of objects
ProbableAn array of IDs and IDTypes to identify this organization
Organizations[].Identifiers[].ID
String
ProbableThe ID for the organization
Organizations[].Identifiers[].IDType
String
ProbableThe IDType associated with the ID
Organizations[].Type
Object
ProbableThe type of organization
Organizations[].Type.System
String
ProbableThe system used to define the type
Organizations[].Type.Value
String
ProbableThe value of the type of organization
Organizations[].PartOf
Object
ProbableInformation/identifiers of the owning/maintaining organization
Organizations[].PartOf.Identifier
Object
ProbableIdentifying information for the owning organization
Organizations[].PartOf.Identifier.Type
Object
ProbableID Type
Organizations[].PartOf.Identifier.System
Object
ProbableThe ID Type system used
Organizations[].PartOf.Identifier.Value
Object
ProbableThe ID
Organizations[].Contacts[]
Array of objects
ProbableAny specified contact information for the organization
Organizations[].Contacts[].Purpose
String
ProbableThe contact's role at this organization
Organizations[].Contacts[].Name
String
ProbableThe contact's full name
Organizations[].Contacts[].EmailAddresses[]
Array of strings
ProbableThe contact's emails
Organizations[].Contacts[].PhoneNumber
Object
ProbableThe contact's phone numbers
Organizations[].Contacts[].PhoneNumber.Home
String
ProbableThe contact's home number
Organizations[].Contacts[].PhoneNumber.Work
String
ProbableThe contact's work number
Organizations[].Contacts[].PhoneNumber.Mobile
String
ProbableThe contact's mobile number
Organizations[].Address
Object
ProbableThe address information for the organization
Organizations[].Address.StreetAddress
String
ProbableStreet address
Organizations[].Address.City
String
ProbableCity
Organizations[].Address.State
String
ProbableState
Organizations[].Address.ZIP
String
ProbableZIP
Organizations[].Address.County
String
PossibleCounty
Organizations[].Address.Country
String
PossibleValueSetCountry
-
Additional values may be added by Redox in the future.
-
Organizations[].Endpoints[]
Array of Objects
ProbableThe Endpoints associated with thisorganization
Organizations[].Endpoints[].Identifiers[]
Array of Objects
ProbableArray of identifiers for this endpoint resource
Organizations[].Endpoints[].Identifiers[].Type
String
ProbableThis should be the type of identifier detailed here. Typically HCID or AAID for Carequality endpoints
Organizations[].Endpoints[].Identifiers[].System
String
ProbableThe system the identifier belongs to. Typically http://www.hl7.org/oid/
Organizations[].Endpoints[].Identifiers[].Value
String
ProbableThe value of the ID
Organizations[].Endpoints[].ConnectionType
Object
ProbableDefines the type of endpoint this is.
Organizations[].Endpoints[].ConnectionType.System
String
ProbableThe system for the ID. Typically http://hl7.org/fhir/subscription-channel-type
Organizations[].Endpoints[].ConnectionType.Value
String
ProbableThe value for the connection, such as ihe-xcpd
Organizations[].Endpoints[].Name
String
ProbableA name for this endpoint.
Organizations[].Endpoints[].Address
String
ProbableThis specifies the actual endpoint value, such as the URL
Organizations[].Endpoints[].MIMEType
String
ProbableDetails the type of payload this endpoint is expecting. Text/XML is standard for IHE endpoints
Organizations[].Endpoints[].Attributes
Object
ProbableAdditional information pertaining to this endpoint
Organizations[].Endpoints[].Attributes.Transaction
String
ProbableType of transaction for this endpoint, such as XCPD ITI-55
Organizations[].Endpoints[].Attributes.Actor
Object
ProbableDefines how the endpoint acts, such as "Responding Gateway"
Organizations[].Endpoints[].Attributes.Actor.System
String
ProbableActor value system used. Typically https://sequoiaproject.org/StructureDefinition/Endpoint/Actor/1.0.0
Organizations[].Endpoints[].Attributes.Actor.Value
String
ProbableValue defining this endpoint Actor from the system specified
Organizations[].Endpoints[].Attributes.Version
Object
ProbableThe version of this endpoint in the containing directory
Organizations[].Endpoints[].Attributes.Version.System
String
ProbableThe system that defines the list of permissable values for the version. Typically https://sequoiaproject.org/StructureDefinition/Endpoint/Version/1.0.0
Organizations[].Endpoints[].Attributes.Version.Value
String
ProbableThe value of the version
Organizations[].Endpoints[].Attributes.UseCases[]
Array of Objects
ProbableDefines how this endpoint should be used
Organizations[].Endpoints[].Attributes.UseCases[].System
String
ProbableSystem used for the use case definition. Typically https://sequoiaproject.org/StructureDefinition/Endpoint/UseCases/1.0.0
Organizations[].Endpoints[].Attributes.UseCases[].Value
String
Probablethe value of the use case
Organizations[].Endpoints[].Attributes.PurposeOfUse[]
Array of Objects
ProbableDefines what purposes of use this endpoint is setup to support
Organizations[].Endpoints[].Attributes.PurposeOfUse[].System
String
ProbableThe system used for the definition of the purpose of use
Organizations[].Endpoints[].Attributes.PurposeOfUse[].Value
String
Probablethe value for this purpose of use
Organizations[].Endpoints[].Attributes.Roles[]
Array of Objects
ProbableDefines what roles this endpoint serves
Organizations[].Endpoints[].Attributes.Roles[].System
String
ProbableThe sysem used to defined the role. Typically https://sequoiaproject.org/StructureDefinition/Endpoint/Roles/1.0.0
Organizations[].Endpoints[].Attributes.Roles[].Value
String
ProbableThe role value
Organizations[].DestinationID
String
ProbableThe Redox Destination ID that is associated with this Carequality org for receiving query events over the network
{
"Meta": {
"DataModel": "Organization",
"EventType": "New",
"EventDateTime": "2024-07-29T16:55:22.999Z",
"Test": true,
"Source": {
"ID": "7ce6f387-c33c-417d-8682-81e83628cbd9",
"Name": "Redox Dev Tools"
},
"Destinations": [
{
"ID": "af394f14-b34a-464f-8d24-895f370af4c9",
"Name": "Redox EMR"
}
],
"Logs": [
{
"ID": "d9f5d293-7110-461e-a875-3beb089e79f3",
"AttemptID": "925d1617-2fe0-468c-a14c-f8c04b572c54"
}
],
"FacilityCode": null
},
"Directory": "Carequality",
"Organizations": [
{
"Active": true,
"Name": "Test Org",
"Aliases": [],
"Identifiers": [
{
"ID": "0000000001",
"IDType": "FACID"
},
{
"ID": "1.2.3.4.5",
"IDType": "OID"
}
],
"Type": {
"System": "http://hl7.org/fhir/organization-type",
"Value": "Implementer"
},
"PartOf": {
"Identifier": {
"Type": "HCID",
"System": "http://www.hl7.org/oid/",
"Value": "1.2.3.4"
}
},
"Contacts": [
{
"Purpose": null,
"Name": "Bixby, Barbara",
"EmailAddresses": [
"[email protected]"
],
"PhoneNumber": {
"Home": "+18088675303",
"Work": null,
"Mobile": "+19189368865"
}
}
],
"Address": {
"StreetAddress": "123 Main St.",
"City": "ATown",
"State": "AL",
"ZIP": "86754",
"County": "Madison",
"Country": "USA"
},
"Endpoints": [
{
"Identifiers": [
{
"Type": "HCID",
"System": "http://www.hl7.org/oid/",
"Value": "2.8.1.2"
}
],
"ConnectionType": {
"System": "http://hl7.org/fhir/subscription-channel-type",
"Value": "ihe-xcpd"
},
"Name": "Patient Discovery",
"Address": "https://fake.fake.com/xcpd",
"MIMEType": "Text/XML",
"Attributes": {
"Transaction": "XCPD ITI-55",
"Actor": {
"System": "https://sequoiaproject.org/StructureDefinition/Endpoint/Actor/1.0.0",
"Value": "Responding Gateway"
},
"Version": {
"System": "https://sequoiaproject.org/StructureDefinition/Endpoint/Version/1.0.0",
"Value": "2.0"
},
"UseCases": [
{
"System": "https://sequoiaproject.org/StructureDefinition/Endpoint/UseCases/1.0.0",
"Value": "QueryBasedDocumentExchange"
}
],
"PurposeOfUse": [
{
"System": "https://sequoiaproject.org/StructureDefinition/Endpoint/PurposesOfUse/1.0.0",
"Value": "Treatment"
}
],
"Roles": [
{
"System": "https://sequoiaproject.org/StructureDefinition/Endpoint/Roles/1.0.0",
"Value": "All"
}
]
}
}
],
"DestinationID": "5e3dc12b-3a04-438e-880d-a690639e629e"
}
]
}
Updatelink
BETAFields
Meta
Meta.DataModel
String
ReliableRequiredOrganization
Meta.EventType
String
ReliableRequiredUpdate
Meta.EventDateTime
DateTime
ReliableDisplays the UTC date and time that an outgoing request is delivered or an incoming request is received.
ISO 8601 Format
Meta.Test
Boolean
ReliableIndicates whether the request is a test or not.
Meta.Source
String
ReliableContains the information for the system initiating the message, including the source ID and name.
Included in messages from Redox
Meta.Source.ID
String
ReliableIdentifies 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
Meta.Source.Name
String
ReliableDisplays the name of the system initiating the message.
Meta.Destinations[]
Array of Objects
ReliableContains 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.
Meta.Destinations[].ID
String
ReliableIdentifies the endpoint that the request is directed to.
UUID
Meta.Destinations[].Name
String
ReliableDisplays the name of the endpoint that the request is directed to.
Meta.Logs[]
Array of Objects
ReliableContains the log identifier(s) for the request.
Meta.Logs[].ID
String
ReliableIdentifies 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
Meta.Logs[].AttemptID
String
ReliableIdentifies the request log attempt value, which is useful when retries are possible.
UUID
Meta.FacilityCode
String
PossibleCode 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.
Action
Action
String
ProbableRequiredWhich update action is this for?.
Update or Delete
Directory
Directory
String
ProbableRequiredDirectory this organization belongs to.
one of: Carequality
Organizations
Organizations[].Active
Boolean
ProbableRequiredIf this organization is considered active
Organizations[].Name
String
ProbableRequiredThe name of the organization
Organizations[].Aliases[]
Array of Strings
ProbableName aliases for this organization
Organizations[].Identifiers[]
Array of objects
ProbableAn array of IDs and IDTypes to identify this organization
Organizations[].Identifiers[].ID
String
ProbableThe ID for the organization
Organizations[].Identifiers[].IDType
String
ProbableThe IDType associated with the ID
Organizations[].Type
Object
ProbableThe type of organization
Organizations[].Type.System
String
ProbableThe system used to define the type
Organizations[].Type.Value
String
ProbableThe value of the type of organization
Organizations[].PartOf
Object
ProbableInformation/identifiers of the owning/maintaining organization
Organizations[].PartOf.Identifier
Object
ProbableIdentifying information for the owning organization
Organizations[].PartOf.Identifier.Type
Object
ProbableID Type
Organizations[].PartOf.Identifier.System
Object
ProbableThe ID Type system used
Organizations[].PartOf.Identifier.Value
Object
ProbableThe ID
Organizations[].Contacts[]
Array of objects
ProbableAny specified contact information for the organization
Organizations[].Contacts[].Purpose
String
ProbableThe contact's role at this organization
Organizations[].Contacts[].Name
String
ProbableThe contact's full name
Organizations[].Contacts[].EmailAddresses[]
Array of strings
ProbableThe contact's emails
Organizations[].Contacts[].PhoneNumber
Object
ProbableThe contact's phone numbers
Organizations[].Contacts[].PhoneNumber.Home
String
ProbableThe contact's home number
Organizations[].Contacts[].PhoneNumber.Work
String
ProbableThe contact's work number
Organizations[].Contacts[].PhoneNumber.Mobile
String
ProbableThe contact's mobile number
Organizations[].Address
Object
ProbableThe address information for the organization
Organizations[].Address.StreetAddress
String
ProbableStreet address
Organizations[].Address.City
String
ProbableCity
Organizations[].Address.State
String
ProbableState
Organizations[].Address.ZIP
String
ProbableZIP
Organizations[].Address.County
String
PossibleCounty
Organizations[].Address.Country
String
PossibleValueSetCountry
-
Additional values may be added by Redox in the future.
-
Organizations[].Endpoints[]
Array of Objects
ProbableThe Endpoints associated with thisorganization
Organizations[].Endpoints[].Identifiers[]
Array of Objects
ProbableArray of identifiers for this endpoint resource
Organizations[].Endpoints[].Identifiers[].Type
String
ProbableThis should be the type of identifier detailed here. Typically HCID or AAID for Carequality endpoints
Organizations[].Endpoints[].Identifiers[].System
String
ProbableThe system the identifier belongs to. Typically http://www.hl7.org/oid/
Organizations[].Endpoints[].Identifiers[].Value
String
ProbableThe value of the ID
Organizations[].Endpoints[].ConnectionType
Object
ProbableDefines the type of endpoint this is.
Organizations[].Endpoints[].ConnectionType.System
String
ProbableThe system for the ID. Typically http://hl7.org/fhir/subscription-channel-type
Organizations[].Endpoints[].ConnectionType.Value
String
ProbableThe value for the connection, such as ihe-xcpd
Organizations[].Endpoints[].Name
String
ProbableA name for this endpoint.
Organizations[].Endpoints[].Address
String
ProbableThis specifies the actual endpoint value, such as the URL
Organizations[].Endpoints[].MIMEType
String
ProbableDetails the type of payload this endpoint is expecting. Text/XML is standard for IHE endpoints
Organizations[].Endpoints[].Attributes
Object
ProbableAdditional information pertaining to this endpoint
Organizations[].Endpoints[].Attributes.Transaction
String
ProbableType of transaction for this endpoint, such as XCPD ITI-55
Organizations[].Endpoints[].Attributes.Actor
Object
ProbableDefines how the endpoint acts, such as "Responding Gateway"
Organizations[].Endpoints[].Attributes.Actor.System
String
ProbableActor value system used. Typically https://sequoiaproject.org/StructureDefinition/Endpoint/Actor/1.0.0
Organizations[].Endpoints[].Attributes.Actor.Value
String
ProbableValue defining this endpoint Actor from the system specified
Organizations[].Endpoints[].Attributes.Version
Object
ProbableThe version of this endpoint in the containing directory
Organizations[].Endpoints[].Attributes.Version.System
String
ProbableThe system that defines the list of permissable values for the version. Typically https://sequoiaproject.org/StructureDefinition/Endpoint/Version/1.0.0
Organizations[].Endpoints[].Attributes.Version.Value
String
ProbableThe value of the version
Organizations[].Endpoints[].Attributes.UseCases[]
Array of Objects
ProbableDefines how this endpoint should be used
Organizations[].Endpoints[].Attributes.UseCases[].System
String
ProbableSystem used for the use case definition. Typically https://sequoiaproject.org/StructureDefinition/Endpoint/UseCases/1.0.0
Organizations[].Endpoints[].Attributes.UseCases[].Value
String
Probablethe value of the use case
Organizations[].Endpoints[].Attributes.PurposeOfUse[]
Array of Objects
ProbableDefines what purposes of use this endpoint is setup to support
Organizations[].Endpoints[].Attributes.PurposeOfUse[].System
String
ProbableThe system used for the definition of the purpose of use
Organizations[].Endpoints[].Attributes.PurposeOfUse[].Value
String
Probablethe value for this purpose of use
Organizations[].Endpoints[].Attributes.Roles[]
Array of Objects
ProbableDefines what roles this endpoint serves
Organizations[].Endpoints[].Attributes.Roles[].System
String
ProbableThe sysem used to defined the role. Typically https://sequoiaproject.org/StructureDefinition/Endpoint/Roles/1.0.0
Organizations[].Endpoints[].Attributes.Roles[].Value
String
ProbableThe role value
Organizations[].DestinationID
String
ProbableThe Redox Destination ID that is associated with this Carequality org for receiving query events over the network
{
"Meta": {
"DataModel": "Organization",
"EventType": "Update",
"EventDateTime": "2024-07-29T16:55:22.999Z",
"Test": true,
"Source": {
"ID": "7ce6f387-c33c-417d-8682-81e83628cbd9",
"Name": "Redox Dev Tools"
},
"Destinations": [
{
"ID": "af394f14-b34a-464f-8d24-895f370af4c9",
"Name": "Redox EMR"
}
],
"Logs": [
{
"ID": "d9f5d293-7110-461e-a875-3beb089e79f3",
"AttemptID": "925d1617-2fe0-468c-a14c-f8c04b572c54"
}
],
"FacilityCode": null
},
"Action": "Update",
"Directory": "Carequality",
"Organizations": [
{
"Active": true,
"Name": "Test Org",
"Aliases": [],
"Identifiers": [
{
"ID": "0000000001",
"IDType": "FACID"
},
{
"ID": "1.2.3.4.5",
"IDType": "OID"
}
],
"Type": {
"System": "http://hl7.org/fhir/organization-type",
"Value": "Implementer"
},
"PartOf": {
"Identifier": {
"Type": "HCID",
"System": "http://www.hl7.org/oid/",
"Value": "1.2.3.4"
}
},
"Contacts": [
{
"Purpose": null,
"Name": "Bixby, Barbara",
"EmailAddresses": [
"[email protected]"
],
"PhoneNumber": {
"Home": "+18088675303",
"Work": null,
"Mobile": "+19189368865"
}
}
],
"Address": {
"StreetAddress": "123 Main St.",
"City": "ATown",
"State": "AL",
"ZIP": "86754",
"County": "Madison",
"Country": "USA"
},
"Endpoints": [
{
"Identifiers": [
{
"Type": "HCID",
"System": "http://www.hl7.org/oid/",
"Value": "2.8.1.2"
}
],
"ConnectionType": {
"System": "http://hl7.org/fhir/subscription-channel-type",
"Value": "ihe-xcpd"
},
"Name": "Patient Discovery",
"Address": "https://fake.fake.com/xcpd",
"MIMEType": "Text/XML",
"Attributes": {
"Transaction": "XCPD ITI-55",
"Actor": {
"System": "https://sequoiaproject.org/StructureDefinition/Endpoint/Actor/1.0.0",
"Value": "Responding Gateway"
},
"Version": {
"System": "https://sequoiaproject.org/StructureDefinition/Endpoint/Version/1.0.0",
"Value": "2.0"
},
"UseCases": [
{
"System": "https://sequoiaproject.org/StructureDefinition/Endpoint/UseCases/1.0.0",
"Value": "QueryBasedDocumentExchange"
}
],
"PurposeOfUse": [
{
"System": "https://sequoiaproject.org/StructureDefinition/Endpoint/PurposesOfUse/1.0.0",
"Value": "Treatment"
}
],
"Roles": [
{
"System": "https://sequoiaproject.org/StructureDefinition/Endpoint/Roles/1.0.0",
"Value": "All"
}
]
}
}
],
"DestinationID": "5e3dc12b-3a04-438e-880d-a690639e629e"
}
]
}
Querylink
BETAFields
Meta
Meta.DataModel
String
ReliableRequiredOrganization
Meta.EventType
String
ReliableRequiredQuery
Meta.EventDateTime
DateTime
ReliableDisplays the UTC date and time that an outgoing request is delivered or an incoming request is received.
ISO 8601 Format
Meta.Test
Boolean
ReliableIndicates whether the request is a test or not.
Meta.Source
String
ReliableContains the information for the system initiating the message, including the source ID and name.
Included in messages from Redox
Meta.Source.ID
String
ReliableIdentifies 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
Meta.Source.Name
String
ReliableDisplays the name of the system initiating the message.
Meta.Destinations[]
Array of Objects
ReliableContains 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.
Meta.Destinations[].ID
String
ReliableIdentifies the endpoint that the request is directed to.
UUID
Meta.Destinations[].Name
String
ReliableDisplays the name of the endpoint that the request is directed to.
Meta.Logs[]
Array of Objects
ReliableContains the log identifier(s) for the request.
Meta.Logs[].ID
String
ReliableIdentifies 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
Meta.Logs[].AttemptID
String
ReliableIdentifies the request log attempt value, which is useful when retries are possible.
UUID
Meta.FacilityCode
String
PossibleCode 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
Directory
String
ProbableRequiredDirectory to query.
one of: Carequality
Identifier
Identifier
Object
ProbableID and ID Type of the organization to query information for.
Use this object to target a specific organization
Identifier.ID
String
ProbableID of organization to query information for
Identifier.IDType
String
ProbableIDType of organization to query information for
NameSearch
NameSearch
Object
ProbableAn object to specify name search parameters
NameSearch.SearchType
String
ProbableThe 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
NameSearch.Value
String
ProbableThe value to use in the NameSearch (the name)
State
State
String
ProbableThe state to search for organizations in.
CeQ network does not current support location-based organization queries using this parameter. Visit CeQ Directory for location-based organization searching.
RadiusSearch
RadiusSearch
Object
ProbableAn object to specify radius query parameters.
CeQ network does not current support location-based organization queries using this parameter. Visit CeQ Directory for location-based organization searching.
RadiusSearch.ZipCode
String
ProbableThe ZipCode to target for a zip radius search.
CeQ network does not current support location-based organization queries using this parameter. Visit CeQ Directory for location-based organization searching.
RadiusSearch.Radius
String
ProbableThe radius, in miles, to search for organizations around the provided ZipCode.
CeQ network does not current support location-based organization queries using this parameter. Visit CeQ Directory for location-based organization searching.
LastUpdated
LastUpdated
DateTime
ProbableThe earliest last updated DateTime to be included.
If populated, only organizations that were last updated on or after this DateTime will be returned.
Index
Index
String
ProbableThe index to return results starting from. Used for paged results
Limit
Limit
String
ProbableThe maximum results you want in the response. default: 500
Active
Active
Boolean
ProbableIf the organization is considered active.
If true, only active organizations will be returned. If false, only inactive organizations will be returned. Default: true.
{
"Meta": {
"DataModel": "Organization",
"EventType": "Query",
"EventDateTime": "2024-07-29T16:55:22.999Z",
"Test": true,
"Source": {
"ID": "7ce6f387-c33c-417d-8682-81e83628cbd9",
"Name": "Redox Dev Tools"
},
"Destinations": [
{
"ID": "af394f14-b34a-464f-8d24-895f370af4c9",
"Name": "Redox EMR"
}
],
"Logs": [
{
"ID": "d9f5d293-7110-461e-a875-3beb089e79f3",
"AttemptID": "925d1617-2fe0-468c-a14c-f8c04b572c54"
}
],
"FacilityCode": null
},
"Directory": "Carequality",
"Identifier": {
"ID": "1.3.6.1",
"IDType": "OID"
},
"NameSearch": {
"SearchType": null,
"Value": null
},
"State": null,
"RadiusSearch": {
"ZipCode": null,
"Radius": null
},
"LastUpdated": "2020-02-11T14:58:03.532Z",
"Index": null,
"Limit": 20,
"Active": null
}
Fields
Meta
Meta.DataModel
String
ReliableRequiredOrganization
Meta.EventType
String
ReliableRequiredQueryResponse
Meta.EventDateTime
DateTime
ReliableDisplays the UTC date and time that an outgoing request is delivered or an incoming request is received.
ISO 8601 Format
Meta.Test
Boolean
ReliableIndicates whether the request is a test or not.
Meta.Source
String
ReliableContains the information for the system initiating the message, including the source ID and name.
Included in messages from Redox
Meta.Source.ID
String
ReliableIdentifies 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
Meta.Source.Name
String
ReliableDisplays the name of the system initiating the message.
Meta.Destinations[]
Array of Objects
ReliableContains 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.
Meta.Destinations[].ID
String
ReliableIdentifies the endpoint that the request is directed to.
UUID
Meta.Destinations[].Name
String
ReliableDisplays the name of the endpoint that the request is directed to.
Meta.Logs[]
Array of Objects
ReliableContains the log identifier(s) for the request.
Meta.Logs[].ID
String
ReliableIdentifies 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
Meta.Logs[].AttemptID
String
ReliableIdentifies the request log attempt value, which is useful when retries are possible.
UUID
Meta.FacilityCode
String
PossibleCode 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
Directory
String
ProbableRequiredDirectory this organization belongs to.
one of: Carequality
Organizations
Organizations[].Active
Boolean
ProbableRequiredIf this organization is considered active
Organizations[].Name
String
ProbableRequiredThe name of the organization
Organizations[].Aliases[]
Array of Strings
ProbableName aliases for this organization
Organizations[].Identifiers[]
Array of objects
ProbableAn array of IDs and IDTypes to identify this organization
Organizations[].Identifiers[].ID
String
ProbableThe ID for the organization
Organizations[].Identifiers[].IDType
String
ProbableThe IDType associated with the ID
Organizations[].Type
Object
ProbableThe type of organization
Organizations[].Type.System
String
ProbableThe system used to define the type
Organizations[].Type.Value
String
ProbableThe value of the type of organization
Organizations[].PartOf
Object
ProbableInformation/identifiers of the owning/maintaining organization
Organizations[].PartOf.Identifier
Object
ProbableIdentifying information for the owning organization
Organizations[].PartOf.Identifier.Type
Object
ProbableID Type
Organizations[].PartOf.Identifier.System
Object
ProbableThe ID Type system used
Organizations[].PartOf.Identifier.Value
Object
ProbableThe ID
Organizations[].Contacts[]
Array of objects
ProbableAny specified contact information for the organization
Organizations[].Contacts[].Purpose
String
ProbableThe contact's role at this organization
Organizations[].Contacts[].Name
String
ProbableThe contact's full name
Organizations[].Contacts[].EmailAddresses[]
Array of strings
ProbableThe contact's emails
Organizations[].Contacts[].PhoneNumber
Object
ProbableThe contact's phone numbers
Organizations[].Contacts[].PhoneNumber.Home
String
ProbableThe contact's home number
Organizations[].Contacts[].PhoneNumber.Work
String
ProbableThe contact's work number
Organizations[].Contacts[].PhoneNumber.Mobile
String
ProbableThe contact's mobile number
Organizations[].Address
Object
ProbableThe address information for the organization
Organizations[].Address.StreetAddress
String
ProbableStreet address
Organizations[].Address.City
String
ProbableCity
Organizations[].Address.State
String
ProbableState
Organizations[].Address.ZIP
String
ProbableZIP
Organizations[].Address.County
String
PossibleCounty
Organizations[].Address.Country
String
PossibleValueSetCountry
-
Additional values may be added by Redox in the future.
-
Organizations[].ManagingOrg
String
ProbableThe managing organization
Paging
Paging
object
Probableinformation related to a paged response
Paging.Count
Numeric
ProbableThe count of responses returned in this response
Paging.Index
Numeric
ProbableThe index used to return the above array of responses
{
"Meta": {
"DataModel": "Organization",
"EventType": "QueryResponse",
"EventDateTime": "2024-07-29T16:55:22.999Z",
"Test": true,
"Source": {
"ID": "7ce6f387-c33c-417d-8682-81e83628cbd9",
"Name": "Redox Dev Tools"
},
"Destinations": [
{
"ID": "af394f14-b34a-464f-8d24-895f370af4c9",
"Name": "Redox EMR"
}
],
"Logs": [
{
"ID": "d9f5d293-7110-461e-a875-3beb089e79f3",
"AttemptID": "925d1617-2fe0-468c-a14c-f8c04b572c54"
}
],
"FacilityCode": null
},
"Directory": "Carequality",
"Organizations": [
{
"Active": true,
"Name": "Test Org",
"Aliases": [],
"Identifiers": [
{
"ID": "0000000001",
"IDType": "FACID"
},
{
"ID": "1.2.3.4.5",
"IDType": "OID"
}
],
"Type": {
"System": "http://hl7.org/fhir/organization-type",
"Value": "Implementer"
},
"PartOf": {
"Identifier": {
"Type": "HCID",
"System": "http://www.hl7.org/oid/",
"Value": "1.2.3.4"
}
},
"Contacts": [
{
"Purpose": null,
"Name": "Bixby, Barbara",
"EmailAddresses": [
"[email protected]"
],
"PhoneNumber": {
"Home": "+18088675303",
"Work": null,
"Mobile": "+19189368865"
}
}
],
"Address": {
"StreetAddress": "123 Main St.",
"City": "ATown",
"State": "AL",
"ZIP": "86754",
"County": "Madison",
"Country": "USA"
},
"ManagingOrg": "Redox Health System"
}
],
"Paging": {
"Count": 1,
"Index": 0
}
}