Redox | Organization

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.

New
Update
Query
QueryResponse

New

BETA

Fields

Show Required Fields Only

Show Translation Fields

Meta
- Meta.DataModel
  String
  Reliable
  Required
  Organization
- Meta.EventType
  String
  Reliable
  Required
  New
- Meta.EventDateTime
  DateTime
  Reliable
  Displays the UTC date and time that an outgoing request is delivered or an incoming request is received.
  ISO 8601 Format
- Meta.Test
  Boolean
  Reliable
  Indicates whether the request is a test.
- Meta.Source
  String
  Reliable
  Contains the information for the system originating the message, including the source ID and name.
  Included in messages from Redox
- Meta.Source.ID
  String
  Reliable
  Identifies the system that originates the message. If you're using OAuth keys, this value is required; if you're using legacy API keys, this value is optional since legacy keys are specific to a given originating system.
  UUID
- Meta.Source.Name
  String
  Reliable
  Displays the name of the system that originates the message.
- Meta.Destinations[]
  Array of Objects
  Reliable
  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.
- Meta.Destinations[].ID
  String
  Reliable
  Identifies the endpoint that the request is directed to.
  UUID
- Meta.Destinations[].Name
  String
  Reliable
  Displays the name of the endpoint that the request is directed to.
- Meta.Logs[]
  Array of Objects
  Reliable
  Contains the log identifier(s) for the request.
- Meta.Logs[].ID
  String
  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
- Meta.Logs[].AttemptID
  String
  Reliable
  Identifies the request log attempt value, which is useful when retries are possible.
  UUID
- Meta.Message
  String
  Reliable
  Record in Redox that corresponds to the communication sent from the source system to Redox.
  Included in requests from Redox.
- Meta.Message.ID
  Numeric
  Reliable
  Retired
  Identifies the numeric value of the message created in Redox.
  (Deprecated. Slated for removal on or after Apr. 30, 2023. Use Meta.Logs[].ID instead).
- Meta.Transmission
  String
  Reliable
  Record in Redox that corresponds to the communication sent from Redox to the destination endpoint.
  Included in messages from Redox.
- Meta.Transmission.ID
  Numeric
  Reliable
  Retired
  Identifies the numeric value of the transmission created in Redox.
  (Deprecated. Slated for removal on or after Apr. 30, 2023. Use Meta.Logs[].ID instead).
- Meta.FacilityCode
  String
  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
- Directory
  String
  Probable
  Required
  Directory this organization belongs to.
  one of: Carequality
Organizations
- Organizations[].Active
  Boolean
  Probable
  Required
  If this organization is considered active
- Organizations[].Name
  String
  Probable
  Required
  The name of the organization
- Organizations[].Aliases[]
  Array of Strings
  Probable
  Name aliases for this organization
- Organizations[].Identifiers[]
  Array of objects
  Probable
  An array of IDs and IDTypes to identify this organization
- Organizations[].Identifiers[].ID
  String
  Probable
  The ID for the organization
- Organizations[].Identifiers[].IDType
  String
  Probable
  The IDType associated with the ID
- Organizations[].Type
  Object
  Probable
  The type of organization
- Organizations[].Type.System
  String
  Probable
  The system used to define the type
- Organizations[].Type.Value
  String
  Probable
  The value of the type of organization
- Organizations[].PartOf
  Object
  Probable
  Information/identifiers of the owning/maintaining organization
- Organizations[].PartOf.Identifier
  Object
  Probable
  Identifying information for the owning organization
- Organizations[].PartOf.Identifier.Type
  Object
  Probable
  ID Type
- Organizations[].PartOf.Identifier.System
  Object
  Probable
  The ID Type system used
- Organizations[].PartOf.Identifier.Value
  Object
  Probable
  The ID
- Organizations[].Contacts[]
  Array of objects
  Probable
  Any specified contact information for the organization
- Organizations[].Contacts[].Purpose
  String
  Probable
  The contact's role at this organization
- Organizations[].Contacts[].Name
  String
  Probable
  The contact's full name
- Organizations[].Contacts[].EmailAddresses[]
  Array of strings
  Probable
  The contact's emails
- Organizations[].Contacts[].PhoneNumber
  Object
  Probable
  The contact's phone numbers
- Organizations[].Contacts[].PhoneNumber.Home
  String
  Probable
  The contact's home number
- Organizations[].Contacts[].PhoneNumber.Work
  String
  Probable
  The contact's work number
- Organizations[].Contacts[].PhoneNumber.Mobile
  String
  Probable
  The contact's mobile number
- Organizations[].Address
  Object
  Probable
  The address information for the organization
- Organizations[].Address.StreetAddress
  String
  Probable
  Street address
- Organizations[].Address.City
  String
  Probable
  City
- Organizations[].Address.State
  String
  Probable
  State
- Organizations[].Address.ZIP
  String
  Probable
  ZIP
- Organizations[].Address.County
  String
  Possible
  County
- Organizations[].Address.Country
  String
  Possible
  ValueSet
  Country
  
  Supported Values
  
  Additional values may be added by Redox in the future.
- Organizations[].Endpoints[]
  Array of Objects
  Probable
  The Endpoints associated with thisorganization
- Organizations[].Endpoints[].Identifiers[]
  Array of Objects
  Probable
  Array of identifiers for this endpoint resource
- Organizations[].Endpoints[].Identifiers[].Type
  String
  Probable
  This should be the type of identifier detailed here. Typically HCID or AAID for Carequality endpoints
- Organizations[].Endpoints[].Identifiers[].System
  String
  Probable
  The system the identifier belongs to. Typically http://www.hl7.org/oid/
- Organizations[].Endpoints[].Identifiers[].Value
  String
  Probable
  The value of the ID
- Organizations[].Endpoints[].ConnectionType
  Object
  Probable
  Defines the type of endpoint this is.
- Organizations[].Endpoints[].ConnectionType.System
  String
  Probable
  The system for the ID. Typically http://hl7.org/fhir/subscription-channel-type
- Organizations[].Endpoints[].ConnectionType.Value
  String
  Probable
  The value for the connection, such as ihe-xcpd
- Organizations[].Endpoints[].Name
  String
  Probable
  A name for this endpoint.
- Organizations[].Endpoints[].Address
  String
  Probable
  This specifies the actual endpoint value, such as the URL
- Organizations[].Endpoints[].MIMEType
  String
  Probable
  Details the type of payload this endpoint is expecting. Text/XML is standard for IHE endpoints
- Organizations[].Endpoints[].Attributes
  Object
  Probable
  Additional information pertaining to this endpoint
- Organizations[].Endpoints[].Attributes.Transaction
  String
  Probable
  Type of transaction for this endpoint, such as XCPD ITI-55
- Organizations[].Endpoints[].Attributes.Actor
  Object
  Probable
  Defines how the endpoint acts, such as "Responding Gateway"
- Organizations[].Endpoints[].Attributes.Actor.System
  String
  Probable
  Actor value system used. Typically https://sequoiaproject.org/StructureDefinition/Endpoint/Actor/1.0.0
- Organizations[].Endpoints[].Attributes.Actor.Value
  String
  Probable
  Value defining this endpoint Actor from the system specified
- Organizations[].Endpoints[].Attributes.Version
  Object
  Probable
  The version of this endpoint in the containing directory
- Organizations[].Endpoints[].Attributes.Version.System
  String
  Probable
  The 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
  Probable
  The value of the version
- Organizations[].Endpoints[].Attributes.UseCases[]
  Array of Objects
  Probable
  Defines how this endpoint should be used
- Organizations[].Endpoints[].Attributes.UseCases[].System
  String
  Probable
  System used for the use case definition. Typically https://sequoiaproject.org/StructureDefinition/Endpoint/UseCases/1.0.0
- Organizations[].Endpoints[].Attributes.UseCases[].Value
  String
  Probable
  the value of the use case
- Organizations[].Endpoints[].Attributes.PurposeOfUse[]
  Array of Objects
  Probable
  Defines what purposes of use this endpoint is setup to support
- Organizations[].Endpoints[].Attributes.PurposeOfUse[].System
  String
  Probable
  The system used for the definition of the purpose of use
- Organizations[].Endpoints[].Attributes.PurposeOfUse[].Value
  String
  Probable
  the value for this purpose of use
- Organizations[].Endpoints[].Attributes.Roles[]
  Array of Objects
  Probable
  Defines what roles this endpoint serves
- Organizations[].Endpoints[].Attributes.Roles[].System
  String
  Probable
  The sysem used to defined the role. Typically https://sequoiaproject.org/StructureDefinition/Endpoint/Roles/1.0.0
- Organizations[].Endpoints[].Attributes.Roles[].Value
  String
  Probable
  The role value
- Organizations[].DestinationID
  String
  Probable
  The Redox Destination ID that is associated with this Carequality org for receiving query events over the network

Sample MessageDownload JSON Schema

{
   "Meta": {
      "DataModel": "Organization",
      "EventType": "New",
      "EventDateTime": "2022-12-05T21:29:43.047Z",
      "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"
         }
      ],
      "Message": {
         "ID": 5565
      },
      "Transmission": {
         "ID": 12414
      },
      "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"
      }
   ]
}

Update

BETA

Fields

Show Required Fields Only

Show Translation Fields

Meta
- Meta.DataModel
  String
  Reliable
  Required
  Organization
- Meta.EventType
  String
  Reliable
  Required
  Update
- Meta.EventDateTime
  DateTime
  Reliable
  Displays the UTC date and time that an outgoing request is delivered or an incoming request is received.
  ISO 8601 Format
- Meta.Test
  Boolean
  Reliable
  Indicates whether the request is a test.
- Meta.Source
  String
  Reliable
  Contains the information for the system originating the message, including the source ID and name.
  Included in messages from Redox
- Meta.Source.ID
  String
  Reliable
  Identifies the system that originates the message. If you're using OAuth keys, this value is required; if you're using legacy API keys, this value is optional since legacy keys are specific to a given originating system.
  UUID
- Meta.Source.Name
  String
  Reliable
  Displays the name of the system that originates the message.
- Meta.Destinations[]
  Array of Objects
  Reliable
  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.
- Meta.Destinations[].ID
  String
  Reliable
  Identifies the endpoint that the request is directed to.
  UUID
- Meta.Destinations[].Name
  String
  Reliable
  Displays the name of the endpoint that the request is directed to.
- Meta.Logs[]
  Array of Objects
  Reliable
  Contains the log identifier(s) for the request.
- Meta.Logs[].ID
  String
  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
- Meta.Logs[].AttemptID
  String
  Reliable
  Identifies the request log attempt value, which is useful when retries are possible.
  UUID
- Meta.Message
  String
  Reliable
  Record in Redox that corresponds to the communication sent from the source system to Redox.
  Included in requests from Redox.
- Meta.Message.ID
  Numeric
  Reliable
  Retired
  Identifies the numeric value of the message created in Redox.
  (Deprecated. Slated for removal on or after Apr. 30, 2023. Use Meta.Logs[].ID instead).
- Meta.Transmission
  String
  Reliable
  Record in Redox that corresponds to the communication sent from Redox to the destination endpoint.
  Included in messages from Redox.
- Meta.Transmission.ID
  Numeric
  Reliable
  Retired
  Identifies the numeric value of the transmission created in Redox.
  (Deprecated. Slated for removal on or after Apr. 30, 2023. Use Meta.Logs[].ID instead).
- Meta.FacilityCode
  String
  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.
Action
- Action
  String
  Probable
  Required
  Which update action is this for?.
  Update or Delete
Directory
- Directory
  String
  Probable
  Required
  Directory this organization belongs to.
  one of: Carequality
Organizations
- Organizations[].Active
  Boolean
  Probable
  Required
  If this organization is considered active
- Organizations[].Name
  String
  Probable
  Required
  The name of the organization
- Organizations[].Aliases[]
  Array of Strings
  Probable
  Name aliases for this organization
- Organizations[].Identifiers[]
  Array of objects
  Probable
  An array of IDs and IDTypes to identify this organization
- Organizations[].Identifiers[].ID
  String
  Probable
  The ID for the organization
- Organizations[].Identifiers[].IDType
  String
  Probable
  The IDType associated with the ID
- Organizations[].Type
  Object
  Probable
  The type of organization
- Organizations[].Type.System
  String
  Probable
  The system used to define the type
- Organizations[].Type.Value
  String
  Probable
  The value of the type of organization
- Organizations[].PartOf
  Object
  Probable
  Information/identifiers of the owning/maintaining organization
- Organizations[].PartOf.Identifier
  Object
  Probable
  Identifying information for the owning organization
- Organizations[].PartOf.Identifier.Type
  Object
  Probable
  ID Type
- Organizations[].PartOf.Identifier.System
  Object
  Probable
  The ID Type system used
- Organizations[].PartOf.Identifier.Value
  Object
  Probable
  The ID
- Organizations[].Contacts[]
  Array of objects
  Probable
  Any specified contact information for the organization
- Organizations[].Contacts[].Purpose
  String
  Probable
  The contact's role at this organization
- Organizations[].Contacts[].Name
  String
  Probable
  The contact's full name
- Organizations[].Contacts[].EmailAddresses[]
  Array of strings
  Probable
  The contact's emails
- Organizations[].Contacts[].PhoneNumber
  Object
  Probable
  The contact's phone numbers
- Organizations[].Contacts[].PhoneNumber.Home
  String
  Probable
  The contact's home number
- Organizations[].Contacts[].PhoneNumber.Work
  String
  Probable
  The contact's work number
- Organizations[].Contacts[].PhoneNumber.Mobile
  String
  Probable
  The contact's mobile number
- Organizations[].Address
  Object
  Probable
  The address information for the organization
- Organizations[].Address.StreetAddress
  String
  Probable
  Street address
- Organizations[].Address.City
  String
  Probable
  City
- Organizations[].Address.State
  String
  Probable
  State
- Organizations[].Address.ZIP
  String
  Probable
  ZIP
- Organizations[].Address.County
  String
  Possible
  County
- Organizations[].Address.Country
  String
  Possible
  ValueSet
  Country
  
  Supported Values
  
  Additional values may be added by Redox in the future.
- Organizations[].Endpoints[]
  Array of Objects
  Probable
  The Endpoints associated with thisorganization
- Organizations[].Endpoints[].Identifiers[]
  Array of Objects
  Probable
  Array of identifiers for this endpoint resource
- Organizations[].Endpoints[].Identifiers[].Type
  String
  Probable
  This should be the type of identifier detailed here. Typically HCID or AAID for Carequality endpoints
- Organizations[].Endpoints[].Identifiers[].System
  String
  Probable
  The system the identifier belongs to. Typically http://www.hl7.org/oid/
- Organizations[].Endpoints[].Identifiers[].Value
  String
  Probable
  The value of the ID
- Organizations[].Endpoints[].ConnectionType
  Object
  Probable
  Defines the type of endpoint this is.
- Organizations[].Endpoints[].ConnectionType.System
  String
  Probable
  The system for the ID. Typically http://hl7.org/fhir/subscription-channel-type
- Organizations[].Endpoints[].ConnectionType.Value
  String
  Probable
  The value for the connection, such as ihe-xcpd
- Organizations[].Endpoints[].Name
  String
  Probable
  A name for this endpoint.
- Organizations[].Endpoints[].Address
  String
  Probable
  This specifies the actual endpoint value, such as the URL
- Organizations[].Endpoints[].MIMEType
  String
  Probable
  Details the type of payload this endpoint is expecting. Text/XML is standard for IHE endpoints
- Organizations[].Endpoints[].Attributes
  Object
  Probable
  Additional information pertaining to this endpoint
- Organizations[].Endpoints[].Attributes.Transaction
  String
  Probable
  Type of transaction for this endpoint, such as XCPD ITI-55
- Organizations[].Endpoints[].Attributes.Actor
  Object
  Probable
  Defines how the endpoint acts, such as "Responding Gateway"
- Organizations[].Endpoints[].Attributes.Actor.System
  String
  Probable
  Actor value system used. Typically https://sequoiaproject.org/StructureDefinition/Endpoint/Actor/1.0.0
- Organizations[].Endpoints[].Attributes.Actor.Value
  String
  Probable
  Value defining this endpoint Actor from the system specified
- Organizations[].Endpoints[].Attributes.Version
  Object
  Probable
  The version of this endpoint in the containing directory
- Organizations[].Endpoints[].Attributes.Version.System
  String
  Probable
  The 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
  Probable
  The value of the version
- Organizations[].Endpoints[].Attributes.UseCases[]
  Array of Objects
  Probable
  Defines how this endpoint should be used
- Organizations[].Endpoints[].Attributes.UseCases[].System
  String
  Probable
  System used for the use case definition. Typically https://sequoiaproject.org/StructureDefinition/Endpoint/UseCases/1.0.0
- Organizations[].Endpoints[].Attributes.UseCases[].Value
  String
  Probable
  the value of the use case
- Organizations[].Endpoints[].Attributes.PurposeOfUse[]
  Array of Objects
  Probable
  Defines what purposes of use this endpoint is setup to support
- Organizations[].Endpoints[].Attributes.PurposeOfUse[].System
  String
  Probable
  The system used for the definition of the purpose of use
- Organizations[].Endpoints[].Attributes.PurposeOfUse[].Value
  String
  Probable
  the value for this purpose of use
- Organizations[].Endpoints[].Attributes.Roles[]
  Array of Objects
  Probable
  Defines what roles this endpoint serves
- Organizations[].Endpoints[].Attributes.Roles[].System
  String
  Probable
  The sysem used to defined the role. Typically https://sequoiaproject.org/StructureDefinition/Endpoint/Roles/1.0.0
- Organizations[].Endpoints[].Attributes.Roles[].Value
  String
  Probable
  The role value
- Organizations[].DestinationID
  String
  Probable
  The Redox Destination ID that is associated with this Carequality org for receiving query events over the network

Sample MessageDownload JSON Schema

{
   "Meta": {
      "DataModel": "Organization",
      "EventType": "Update",
      "EventDateTime": "2022-12-05T21:29:43.047Z",
      "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"
         }
      ],
      "Message": {
         "ID": 5565
      },
      "Transmission": {
         "ID": 12414
      },
      "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"
      }
   ]
}

Query

BETA

Fields

Show Required Fields Only

Show Translation Fields

Meta
- Meta.DataModel
  String
  Reliable
  Required
  Organization
- Meta.EventType
  String
  Reliable
  Required
  Query
- Meta.EventDateTime
  DateTime
  Reliable
  Displays the UTC date and time that an outgoing request is delivered or an incoming request is received.
  ISO 8601 Format
- Meta.Test
  Boolean
  Reliable
  Indicates whether the request is a test.
- Meta.Source
  String
  Reliable
  Contains the information for the system originating the message, including the source ID and name.
  Included in messages from Redox
- Meta.Source.ID
  String
  Reliable
  Identifies the system that originates the message. If you're using OAuth keys, this value is required; if you're using legacy API keys, this value is optional since legacy keys are specific to a given originating system.
  UUID
- Meta.Source.Name
  String
  Reliable
  Displays the name of the system that originates the message.
- Meta.Destinations[]
  Array of Objects
  Reliable
  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.
- Meta.Destinations[].ID
  String
  Reliable
  Identifies the endpoint that the request is directed to.
  UUID
- Meta.Destinations[].Name
  String
  Reliable
  Displays the name of the endpoint that the request is directed to.
- Meta.Logs[]
  Array of Objects
  Reliable
  Contains the log identifier(s) for the request.
- Meta.Logs[].ID
  String
  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
- Meta.Logs[].AttemptID
  String
  Reliable
  Identifies the request log attempt value, which is useful when retries are possible.
  UUID
- Meta.Message
  String
  Reliable
  Record in Redox that corresponds to the communication sent from the source system to Redox.
  Included in requests from Redox.
- Meta.Message.ID
  Numeric
  Reliable
  Retired
  Identifies the numeric value of the message created in Redox.
  (Deprecated. Slated for removal on or after Apr. 30, 2023. Use Meta.Logs[].ID instead).
- Meta.Transmission
  String
  Reliable
  Record in Redox that corresponds to the communication sent from Redox to the destination endpoint.
  Included in messages from Redox.
- Meta.Transmission.ID
  Numeric
  Reliable
  Retired
  Identifies the numeric value of the transmission created in Redox.
  (Deprecated. Slated for removal on or after Apr. 30, 2023. Use Meta.Logs[].ID instead).
- Meta.FacilityCode
  String
  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
- Directory
  String
  Probable
  Required
  Directory to query.
  one of: Carequality
Identifier
- Identifier
  Object
  Probable
  ID and ID Type of the organization to query information for.
  Use this object to target a specific organization
- Identifier.ID
  String
  Probable
  ID of organization to query information for
- Identifier.IDType
  String
  Probable
  IDType of organization to query information for
NameSearch
- NameSearch
  Object
  Probable
  An object to specify name search parameters
- NameSearch.SearchType
  String
  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
- NameSearch.Value
  String
  Probable
  The value to use in the NameSearch (the name)
State
- State
  String
  Probable
  The 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
  Probable
  An 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
  Probable
  The 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
  Probable
  The 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
  Probable
  The 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
  Probable
  The index to return results starting from. Used for paged results
Limit
- Limit
  String
  Probable
  The maximum results you want in the response. default: 500
Active
- Active
  Boolean
  Probable
  If the organization is considered active.
  If true, only active organizations will be returned. If false, only inactive organizations will be returned. Default: true.

Sample MessageDownload JSON Schema

{
   "Meta": {
      "DataModel": "Organization",
      "EventType": "Query",
      "EventDateTime": "2022-12-05T21:29:43.047Z",
      "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"
         }
      ],
      "Message": {
         "ID": 5565
      },
      "Transmission": {
         "ID": 12414
      },
      "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
}

QueryResponse

BETA

Fields

Show Required Fields Only

Show Translation Fields

Meta
- Meta.DataModel
  String
  Reliable
  Required
  Organization
- Meta.EventType
  String
  Reliable
  Required
  QueryResponse
- Meta.EventDateTime
  DateTime
  Reliable
  Displays the UTC date and time that an outgoing request is delivered or an incoming request is received.
  ISO 8601 Format
- Meta.Test
  Boolean
  Reliable
  Indicates whether the request is a test.
- Meta.Source
  String
  Reliable
  Contains the information for the system originating the message, including the source ID and name.
  Included in messages from Redox
- Meta.Source.ID
  String
  Reliable
  Identifies the system that originates the message. If you're using OAuth keys, this value is required; if you're using legacy API keys, this value is optional since legacy keys are specific to a given originating system.
  UUID
- Meta.Source.Name
  String
  Reliable
  Displays the name of the system that originates the message.
- Meta.Destinations[]
  Array of Objects
  Reliable
  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.
- Meta.Destinations[].ID
  String
  Reliable
  Identifies the endpoint that the request is directed to.
  UUID
- Meta.Destinations[].Name
  String
  Reliable
  Displays the name of the endpoint that the request is directed to.
- Meta.Logs[]
  Array of Objects
  Reliable
  Contains the log identifier(s) for the request.
- Meta.Logs[].ID
  String
  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
- Meta.Logs[].AttemptID
  String
  Reliable
  Identifies the request log attempt value, which is useful when retries are possible.
  UUID
- Meta.Message
  String
  Reliable
  Record in Redox that corresponds to the communication sent from the source system to Redox.
  Included in requests from Redox.
- Meta.Message.ID
  Numeric
  Reliable
  Retired
  Identifies the numeric value of the message created in Redox.
  (Deprecated. Slated for removal on or after Apr. 30, 2023. Use Meta.Logs[].ID instead).
- Meta.Transmission
  String
  Reliable
  Record in Redox that corresponds to the communication sent from Redox to the destination endpoint.
  Included in messages from Redox.
- Meta.Transmission.ID
  Numeric
  Reliable
  Retired
  Identifies the numeric value of the transmission created in Redox.
  (Deprecated. Slated for removal on or after Apr. 30, 2023. Use Meta.Logs[].ID instead).
- Meta.FacilityCode
  String
  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
- Directory
  String
  Probable
  Required
  Directory this organization belongs to.
  one of: Carequality
Organizations
- Organizations[].Active
  Boolean
  Probable
  Required
  If this organization is considered active
- Organizations[].Name
  String
  Probable
  Required
  The name of the organization
- Organizations[].Aliases[]
  Array of Strings
  Probable
  Name aliases for this organization
- Organizations[].Identifiers[]
  Array of objects
  Probable
  An array of IDs and IDTypes to identify this organization
- Organizations[].Identifiers[].ID
  String
  Probable
  The ID for the organization
- Organizations[].Identifiers[].IDType
  String
  Probable
  The IDType associated with the ID
- Organizations[].Type
  Object
  Probable
  The type of organization
- Organizations[].Type.System
  String
  Probable
  The system used to define the type
- Organizations[].Type.Value
  String
  Probable
  The value of the type of organization
- Organizations[].PartOf
  Object
  Probable
  Information/identifiers of the owning/maintaining organization
- Organizations[].PartOf.Identifier
  Object
  Probable
  Identifying information for the owning organization
- Organizations[].PartOf.Identifier.Type
  Object
  Probable
  ID Type
- Organizations[].PartOf.Identifier.System
  Object
  Probable
  The ID Type system used
- Organizations[].PartOf.Identifier.Value
  Object
  Probable
  The ID
- Organizations[].Contacts[]
  Array of objects
  Probable
  Any specified contact information for the organization
- Organizations[].Contacts[].Purpose
  String
  Probable
  The contact's role at this organization
- Organizations[].Contacts[].Name
  String
  Probable
  The contact's full name
- Organizations[].Contacts[].EmailAddresses[]
  Array of strings
  Probable
  The contact's emails
- Organizations[].Contacts[].PhoneNumber
  Object
  Probable
  The contact's phone numbers
- Organizations[].Contacts[].PhoneNumber.Home
  String
  Probable
  The contact's home number
- Organizations[].Contacts[].PhoneNumber.Work
  String
  Probable
  The contact's work number
- Organizations[].Contacts[].PhoneNumber.Mobile
  String
  Probable
  The contact's mobile number
- Organizations[].Address
  Object
  Probable
  The address information for the organization
- Organizations[].Address.StreetAddress
  String
  Probable
  Street address
- Organizations[].Address.City
  String
  Probable
  City
- Organizations[].Address.State
  String
  Probable
  State
- Organizations[].Address.ZIP
  String
  Probable
  ZIP
- Organizations[].Address.County
  String
  Possible
  County
- Organizations[].Address.Country
  String
  Possible
  ValueSet
  Country
  
  Supported Values
  
  Additional values may be added by Redox in the future.
- Organizations[].ManagingOrg
  String
  Probable
  The managing organization
Paging
- Paging
  object
  Probable
  information related to a paged response
- Paging.Count
  Numeric
  Probable
  The count of responses returned in this response
- Paging.Index
  Numeric
  Probable
  The index used to return the above array of responses

Sample MessageDownload JSON Schema

{
   "Meta": {
      "DataModel": "Organization",
      "EventType": "QueryResponse",
      "EventDateTime": "2022-12-05T21:29:43.047Z",
      "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"
         }
      ],
      "Message": {
         "ID": 5565
      },
      "Transmission": {
         "ID": 12414
      },
      "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
   }
}

Organization

Newlink

Fields

Meta

Directory

Organizations

Updatelink

Fields

Meta

Action

Directory

Organizations

Querylink

Fields

Meta

Directory

Identifier

NameSearch

State

RadiusSearch

LastUpdated

Index

Limit

Active

QueryResponselink

Fields

Meta

Directory

Organizations

Paging

New

Update

Query

QueryResponse