Home
API reference
Redox Data Model API
Redox Data Models
Organization
Delete

Organization Delete

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 organization record;
  • update or delete an existing organization record; or
  • query for and receive organization records.

Delete

Delete an existing organization record from an external network or system.

Beta

Request Body Schema

  • Meta
    required, object
    • DataModel
      required, string
      Reliable

      Organization

    • EventType
      required, string
      Reliable

      Delete

    • EventDateTime
      string, null
      Reliable

      Displays the UTC date and time that an outgoing request is delivered or an incoming request is received.
      ISO 8601 Format

    • Test
      boolean, null
      Reliable

      Indicates whether the request is a test or not.

    • Source
      object

      Contains the information for the system initiating the message, including the source ID and name.
      Included in messages from Redox

      • ID
        string, null
        Reliable

        Identifies the system initiating the message. If you have multiple OAuth API keys per environment type, this value is required. If you have only one OAuth API key per environment type, or you're using legacy API keys, this value is optional.
        UUID

      • Name
        string, null
        Reliable

        Displays the name of the system initiating the message.

    • Destinations
      Array of object

      Contains the information for the endpoint(s) receiving the request. A request must contain at least one destination, but asynchronous requests can have more than one destination. Synchronous requests like queries can only support one destination.
      Required when sending data to Redox.

      • ID
        string, null
        Reliable

        Identifies the endpoint that the request is directed to.
        UUID

      • Name
        string, null
        Reliable

        Displays the name of the endpoint that the request is directed to.

    • Logs
      Array of object

      Contains the log identifier(s) for the request.

      • ID
        string, null
        Reliable

        Identifies the request log(s) that correspond to this request. You can use this value to locate the relevant log in the Redox dashboard for support and reference.
        UUID

      • AttemptID
        string, null
        Reliable

        Identifies the request log attempt value, which is useful when retries are possible.
        UUID

    • FacilityCode
      string, null
      Possible

      Code for the facility related to the message.
      Only use this field if a health system indicates you should. The code is specific to the health system's EHR and might not be unique across health systems. In general, the facility fields within the data models (e.g. OrderingFacility) are more reliable and informative.

  • Directory
    required, string
    Probable

    Directory this organization belongs to.
    one of: Carequality, TEFCA-CommonWell, CommonWell

  • Organizations
    Array of object
    • Identifiers
      Array of object

      ID and ID Type of the organization to delete.
      For TEFCA-CommonWell, CommonWell, a PIAA (Patient ID Assigning Authority) identifier is required.

      • ID
        string, null
        Probable

        ID of organization to delete.
        For TEFCA-CommonWell, CommonWell, this field is required and is the OID representing the organization's primary ID

      • IDType
        string, null
        Probable

        IDType of organization to delete.
        For TEFCA-CommonWell, CommonWell, this field is required and should be PIAA.

Example
json
1
{
2
  "Meta": {
3
    "DataModel": "Organization",
4
    "EventType": "Delete",
5
    "EventDateTime": "2026-02-12T23:30:12.516Z",
6
    "Test": true,
7
    "Source": {
8
      "ID": "7ce6f387-c33c-417d-8682-81e83628cbd9",
9
      "Name": "Redox Dev Tools"
10
    },
11
    "Destinations": [
12
      {
13
        "ID": "af394f14-b34a-464f-8d24-895f370af4c9",
14
        "Name": "Redox EMR"
15
      }
16
    ],
17
    "Logs": [
18
      {
19
        "ID": "d9f5d293-7110-461e-a875-3beb089e79f3",
20
        "AttemptID": "925d1617-2fe0-468c-a14c-f8c04b572c54"
21
      }
22
    ],
23
    "FacilityCode": null
24
  },
25
  "Directory": "Carequality",
26
  "Organizations": [
27
    {
28
      "Identifiers": [
29
        {
30
          "ID": "0000000001",
31
          "IDType": "FACID"
32
        },
33
        {
34
          "ID": "1.2.3.4.5",
35
          "IDType": "OID"
36
        },
37
        {
38
          "ID": "2.16.840.1.113883.3.9999.123.456",
39
          "IDType": "PIAA"
40
        }
41
      ]
42
    }
43
  ]
44
}