Home
API reference
Redox Data Models
Organization
Update

Organization

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.

Update

Update an existing organization record in an external network or system.

Beta

Request Body Schema

  • Meta
    required, object
    • DataModel
      required, string
      Reliable

      Organization

    • EventType
      required, string
      Reliable

      Update

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

  • Action
    required, string
    Probable

    Which update action is this for?.
    Update or Delete

  • Directory
    required, string
    Probable

    Directory this organization belongs to.
    one of: Carequality

  • Organizations
    required, Array of object
    • Active
      required, boolean
      Probable

      If this organization is considered active

    • Name
      required, string
      Probable

      The name of the organization

    • Aliases
      Array of string

      Name aliases for this organization

    • Identifiers
      Array of object

      An array of IDs and IDTypes to identify this organization

      • ID
        string, null
        Probable

        The ID for the organization

      • IDType
        string, null
        Probable

        The IDType associated with the ID

    • Type
      object

      The type of organization

      • System
        string, null
        Probable

        The system used to define the type

      • Value
        string, null
        Probable

        The value of the type of organization

    • PartOf
      object

      Information/identifiers of the owning/maintaining organization

      • Identifier
        object

        Identifying information for the owning organization

        • Type
          string, null
          Probable

          ID Type

        • System
          string, null
          Probable

          The ID Type system used

        • Value
          string, null
          Probable

          The ID

    • Contacts
      Array of object

      Any specified contact information for the organization

      • Purpose
        string, null
        Probable

        The contact's role at this organization

      • Name
        string, null
        Probable

        The contact's full name

      • EmailAddresses
        Array of string

        The contact's emails

      • PhoneNumber
        object

        The contact's phone numbers

        • Home
          string, null
          Probable

          The contact's home number

        • Work
          string, null
          Probable

          The contact's work number

        • Mobile
          string, null
          Probable

          The contact's mobile number

    • Address
      object

      The address information for the organization

      • StreetAddress
        string, null
        Probable

        Street address

      • City
        string, null
        Probable

        City

      • State
        string, null
        Probable

        State

      • ZIP
        string, null
        Probable

        ZIP

      • County
        string, null
        Possible

        County

      • Country
        string, null
        Possible
        Value Set

        Country

    • Endpoints
      Array of object

      The Endpoints associated with thisorganization

      • Identifiers
        Array of object

        Array of identifiers for this endpoint resource

        • Type
          string, null
          Probable

          This should be the type of identifier detailed here. Typically HCID or AAID for Carequality endpoints

        • System
          string, null
          Probable

          The system the identifier belongs to. Typically http://www.hl7.org/oid/

        • Value
          string, null
          Probable

          The value of the ID

      • ConnectionType
        object

        Defines the type of endpoint this is.

      • Name
        string, null
        Probable

        A name for this endpoint.

      • Address
        string, null
        Probable

        This specifies the actual endpoint value, such as the URL

      • MIMEType
        string, null
        Probable

        Details the type of payload this endpoint is expecting. Text/XML is standard for IHE endpoints

      • Attributes
        object

        Additional information pertaining to this endpoint

        • Transaction
          string, null
          Probable

          Type of transaction for this endpoint, such as XCPD ITI-55

        • Actor
          object

          Defines how the endpoint acts, such as "Responding Gateway"

        • Version
          object

          The version of this endpoint in the containing directory

        • UseCases
          Array of object

          Defines how this endpoint should be used

        • PurposeOfUse
          Array of object

          Defines what purposes of use this endpoint is setup to support

          • System
            string, null
            Probable

            The system used for the definition of the purpose of use

          • Value
            string, null
            Probable

            the value for this purpose of use

        • Roles
          Array of object

          Defines what roles this endpoint serves

    • DestinationID
      string, null
      Probable

      The Redox Destination ID that is associated with this Carequality org for receiving query events over the network

Example
json
1
{
2
  "Meta": {
3
    "DataModel": "Organization",
4
    "EventType": "Update",
5
    "EventDateTime": "2024-12-20T18:11:36.537Z",
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
  "Action": "Update",
26
  "Directory": "Carequality",
27
  "Organizations": [
28
    {
29
      "Active": true,
30
      "Name": "Test Org",
31
      "Aliases": [],
32
      "Identifiers": [
33
        {
34
          "ID": "0000000001",
35
          "IDType": "FACID"
36
        },
37
        {
38
          "ID": "1.2.3.4.5",
39
          "IDType": "OID"
40
        }
41
      ],
42
      "Type": {
43
        "System": "http://hl7.org/fhir/organization-type",
44
        "Value": "Implementer"
45
      },
46
      "PartOf": {
47
        "Identifier": {
48
          "Type": "HCID",
49
          "System": "http://www.hl7.org/oid/",
50
          "Value": "1.2.3.4"
51
        }
52
      },
53
      "Contacts": [
54
        {
55
          "Purpose": null,
56
          "Name": "Bixby, Barbara",
57
          "EmailAddresses": [
58
            "barb.bixby@test.net"
59
          ],
60
          "PhoneNumber": {
61
            "Home": "+18088675303",
62
            "Work": null,
63
            "Mobile": "+19189368865"
64
          }
65
        }
66
      ],
67
      "Address": {
68
        "StreetAddress": "123 Main St.",
69
        "City": "ATown",
70
        "State": "AL",
71
        "ZIP": "86754",
72
        "County": "Madison",
73
        "Country": "USA"
74
      },
75
      "Endpoints": [
76
        {
77
          "Identifiers": [
78
            {
79
              "Type": "HCID",
80
              "System": "http://www.hl7.org/oid/",
81
              "Value": "2.8.1.2"
82
            }
83
          ],
84
          "ConnectionType": {
85
            "System": "http://hl7.org/fhir/subscription-channel-type",
86
            "Value": "ihe-xcpd"
87
          },
88
          "Name": "Patient Discovery",
89
          "Address": "https://fake.fake.com/xcpd",
90
          "MIMEType": "Text/XML",
91
          "Attributes": {
92
            "Transaction": "XCPD ITI-55",
93
            "Actor": {
94
              "System": "https://sequoiaproject.org/StructureDefinition/Endpoint/Actor/1.0.0",
95
              "Value": "Responding Gateway"
96
            },
97
            "Version": {
98
              "System": "https://sequoiaproject.org/StructureDefinition/Endpoint/Version/1.0.0",
99
              "Value": "2.0"
100
            },
101
            "UseCases": [
102
              {
103
                "System": "https://sequoiaproject.org/StructureDefinition/Endpoint/UseCases/1.0.0",
104
                "Value": "QueryBasedDocumentExchange"
105
              }
106
            ],
107
            "PurposeOfUse": [
108
              {
109
                "System": "https://sequoiaproject.org/StructureDefinition/Endpoint/PurposesOfUse/1.0.0",
110
                "Value": "Treatment"
111
              }
112
            ],
113
            "Roles": [
114
              {
115
                "System": "https://sequoiaproject.org/StructureDefinition/Endpoint/Roles/1.0.0",
116
                "Value": "All"
117
              }
118
            ]
119
          }
120
        }
121
      ],
122
      "DestinationID": "5e3dc12b-3a04-438e-880d-a690639e629e"
123
    }
124
  ]
125
}