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

> **For external organizations**
>
> Keep in mind this doesn't relate to Redox organizations, sources, or destinations. It's used to synchronize your system with externally maintained lists of organizations.  

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

> **Only one organization at a time**
>
> Even though there’s an array for `Organizations`, we only support creating or updating one organization record at a time. This applies to organization records for either Carequality, CommonWell, or TEFCA-CommonWell.

Status: Beta

## Request body

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `Meta` | object | Yes |  |
| `Meta.DataModel` | string | Yes | Organization |
| `Meta.EventType` | string | Yes | Delete |
| `Meta.EventDateTime` | string or null | No | Displays the UTC date and time that an outgoing request is delivered or an incoming request is received. *[ISO 8601 Format](http://en.wikipedia.org/wiki/ISO_8601)* |
| `Meta.Test` | boolean or null | No | Indicates whether the request is a test or not. |
| `Meta.Source` | object | No | Contains the information for the system initiating the message, including the source ID and name. *Included in messages from Redox* |
| `Meta.Source.ID` | string or null | No | 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* |
| `Meta.Source.Name` | string or null | No | Displays the name of the system initiating the message. |
| `Meta.Destinations` | Array of object | No | 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 or null | No | Identifies the endpoint that the request is directed to. *UUID* |
| `Meta.Destinations[].Name` | string or null | No | Displays the name of the endpoint that the request is directed to. |
| `Meta.Logs` | Array of object | No | Contains the log identifier(s) for the request. |
| `Meta.Logs[].ID` | string or null | No | 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 or null | No | Identifies the request log attempt value, which is useful when retries are possible. *UUID* |
| `Meta.FacilityCode` | string or null | No | 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` | string | Yes | Directory this organization belongs to. *one of: Carequality, TEFCA-CommonWell, CommonWell* |
| `Organizations` | Array of object | No |  |
| `Organizations[].Identifiers` | Array of object | No | ID and ID Type of the organization to delete. *For TEFCA-CommonWell, CommonWell, a PIAA (Patient ID Assigning Authority) identifier is required.* |
| `Organizations[].Identifiers[].ID` | string or null | No | ID of organization to delete. *For TEFCA-CommonWell, CommonWell, this field is required and is the OID representing the organization's primary ID* |
| `Organizations[].Identifiers[].IDType` | string or null | No | IDType of organization to delete. *For TEFCA-CommonWell, CommonWell, this field is required and should be `PIAA`.* |

## Example

```json
{
  "Meta": {
    "DataModel": "Organization",
    "EventType": "Delete",
    "EventDateTime": "2026-11-18T19:05:05.809Z",
    "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": [
    {
      "Identifiers": [
        {
          "ID": "0000000001",
          "IDType": "FACID"
        },
        {
          "ID": "1.2.3.4.5",
          "IDType": "OID"
        },
        {
          "ID": "2.16.840.1.113883.3.9999.123.456",
          "IDType": "PIAA"
        }
      ]
    }
  ]
}
```
