Create a Carequality organization record

Last updated: Apr 16, 2026

IMPLEMENTATION

HEALTH TECH VENDOR

Who can use this how-to

Existing customers using Network Onramps to connect to the Carequality Interoperability Framework.
Existing customers with a direct connection to the Carequality Interoperability Framework (i.e., without Redox).

An organization record (i.e., OID in the Redox organization) is the unique identifier for your organization within the Carequality Interoperability Framework. The organization OID is how you identify yourself when searching for patients—and how other Carequality participants can find you and your patients.

You should plan to register at least one organization record per unique master patient index (MPI) or physical location. Learn more about OIDs and identity to understand why you may want to register more than one organization.

FHIR option

Did you know you can also do this workflow with Redox FHIR®? Learn how to create an organization record with FHIR®.

Use curl for technical validation

You can copy our code examples and send the test requests with curl (learn more about curl) instead of Postman. If you do, remember to:

Remove the comments from the code examples (starting with //).
Replace any variables with your specific data (e.g., your organization's OID) before sending the request.
- $VARIABLE: An environment variable you can set in your terminal before running the command.
- {{variable here}}: A placeholder for your specific data.
Add the source-id if you have multiple sources. We don’t include {{source-id}} in the code examples, so you’ll have to add them yourself. Learn about including source details.
Make sure you have a full request for your own use since some of the code examples are abbreviated.

Check out these troubleshooting guides if you run into errors:

Destination IDs

You must populate any test requests with the appropriate destination ID in the Meta.Destinations array based on the environment and type of requests:

Request purpose	Development ID	Production ID
Perform a broad patient search	`adf917b5-1496-4241-87e2-ed20434b1fdb`	`97f2dc1d-c71b-43a7-a436-9b789d44c804`
Perform a patient search within a specific organization	`1ca254a8-8d42-4593-abb4-b21399d9de57`	`6391b961-55ae-430b-a789-cf575f03fca0`
Query for/create/update/delete an organization	`a07afe3b-d247-4415-827f-6837707e1b8b`	`5d0fd248-6c52-4ad9-b907-ae10bf2dcc39`
Search for a clinical summary/document	`ec745338-8849-43ad-a7ce-4bc5bf1d8b89`	`628cbf79-1156-4923-b9d0-285906160ed6`
Save patient details and documents to your data on demand repository	This is specific to your organization. Redox provides the destination ID for data on demand.	This is specific to your organization. Redox provides the destination ID for data on demand.

Create your organization record

Using Postman or curl, send an Organization.New request to create your organization record in Carequality.

There are two different destination IDs in this request:

Meta.Destinations.ID: The Carequality destination ID from the reference table above. This routes the request to the appropriate destination, or endpoint.

Organizations.DestinationID: The Redox destination ID where you receive inbound traffic from Carequality via Redox. You can use null for testing.

Example: Create an organization record in Carequality

bash

1
curl \
2
-X POST https://api.redoxengine.com/endpoint \
3
-H "Content-Type: application/json" \
4
-H "Authorization: Bearer $API_TOKEN" \
5
-d '{
6
  "Meta": {
7
    "DataModel": "Organization",
8
    "EventType": "New",
9
    "Destinations": [
10
      {
11
        "ID": "a07afe3b-d247-4415-827f-6837707e1b8b"
12
      }
13
    ]
14
  },
15
  "Directory": "Carequality",
16
  "Action": "Create",
17
  "Organizations": [
18
    {
19
      "Name": "My Company",
20
      "DestinationID": "{{YOUR-REDOX-DESTINATION-ID}}",
21
      "Aliases": ["My Company, LLC", "MY"],
22
      "Active": true,
23
      // OID is the only required identifier, but you can include your own identifiers as needed.
24
      "Identifiers": [
25
        {
26
          "ID": "{{YOUR-ORGANIZATION-OID}}",
27
          "IDType": "OID"
28
        }
29
      ],
30
      // This references Redox as your top-level, and your other organizations for levels below.
31
      "PartOf": {
32
        "Identifier": {
33
          // Your "PartOf" or parent should be Redox: 2.16.840.1.113883.3.6147.458.2
34
          "Value": "{{YOUR-BASE-OID}}"
35
        }
36
      },
37
      // Replace this information with your contact information.
38
      "Contacts": [
39
        {
40
          "Purpose": "Technical",
41
          "Name": "Redox Carequality Support - Test",
42
          "EmailAddresses": ["support@redoxengine.com"],
43
          "PhoneNumber": {
44
            "Work": "+16085359501",
45
            "Mobile": "+16085359501"
46
          }
47
        }
48
      ],
49
      // Replace this information with your address information.
50
      "Address": {
51
        "StreetAddress": "2020 Eastwood Dr",
52
        "City": "Madison",
53
        "State": "WI",
54
        "ZIP": "53704",
55
        "County": "Dane",
56
        "Country": "USA"
57
      }
58
    }
59
  ]
60
}'

API reference

Review the Organization data model schema for more technical details.

If the request is successful, you receive a synchronous response indicating that your organization record was created.

Example: Successful response for creating an organization record

json

1
{
2
  "Meta": {
3
    "DataModel": "Organization",
4
    "EventType": "New",
5
    "Message": {
6
      "ID": 4606153124
7
    },
8
    "Source": {
9
      "ID": "7f296bb4-83fd-498d-92f3-a76960648788",
10
    },
11
    "Destinations": [
12
      {
13
        "ID": "a07afe3b-d247-4415-827f-6837707e1b8b"
14
      }
15
    ],
16
    "Extensions": {
17
      "ResponseDetail": {
18
        "string": "New organization was added successfully."
19
      }
20
    }
21
  }
22
}

If you don't receive the expected response, review common Carequality errors.

Once you complete all of your testing, you need to repeat these steps to create your organization record in production, too.

Update your organization

Whenever there are changes to your organization details (e.g., address or contact information), follow these steps to keep your organization record up-to-date:

Using Postman or curl, send an Organization.Update request with the updated organization details.

Set the EventType and Action fields to Update.

Example: Update a Carequality organization record

bash

1
curl \
2
-X POST https://api.redoxengine.com/endpoint \
3
-H "Content-Type: application/json" \
4
-H "Authorization: Bearer $API_TOKEN" \
5
-d '{
6
  "Meta": {
7
    "DataModel": "Organization",
8
    "EventType": "Update",
9
    "Destinations": [
10
      {
11
        "ID": "a07afe3b-d247-4415-827f-6837707e1b8b"
12
      }
13
    ]
14
  },
15
  "Directory": "Carequality",
16
  "Action": "Update",
17
  "Organizations": [
18
    {
19
      "Name": "My Company Facility 1 Update",
20
      "DestinationID": "{{YOUR-REDOX-DESTINATION-ID}}",
21
      "Active": true,
22
      "Identifiers": [
23
        {
24
          "ID": "{{YOUR-ORGANIZATION-OID}}",
25
          "IDType": "OID"
26
        }
27
      ],
28
      // This references the top-level Redox organization.
29
      "PartOf": {
30
        "Identifier": {
31
          "Value": "{{YOUR-BASE-OID}}"
32
        }
33
      },
34
      "Contacts": [
35
        {
36
          "Purpose": "Technical",
37
          "Name": "Redox Carequality Support - Test",
38
          "EmailAddresses": ["support@redoxengine.com"],
39
          "PhoneNumber": {
40
            "Work": "+16085359501",
41
            "Mobile": "+16085359501"
42
          }
43
        }
44
      ],
45
      "Address": {
46
        "StreetAddress": "2020 Westwood Drive",
47
        "City": "Madison",
48
        "State": "WI",
49
        "ZIP": "53704",
50
        "County": "Dane",
51
        "Country": "USA"
52
      }
53
    }
54
  ]
55
}'

API reference

Review the Organization data model schema for more technical details.

If the request is successful, you receive a synchronous response indicating that your organization record was updated.

Example: Successful response for organization update

json

1
{
2
  "Meta": {
3
    "DataModel": "Organization",
4
    "EventType": "Update",
5
    "Message": {
6
      "ID": 4606153124
7
    },
8
    "Source": {
9
      "ID": "7f296bb4-83fd-498d-92f3-a76960648788"
10
    },
11
    "Destinations": [
12
      {
13
        "ID": "a07afe3b-d247-4415-827f-6837707e1b8b"
14
      }
15
    ],
16
    "Extensions": {
17
      "ResponseDetail": {
18
        "string": "Organization with id:2.16.840.1.113883.3.6147.5 has been updated successfully."
19
      }
20
    }
21
  }
22
}

Deactivate your organization

You can’t delete or erase a Carequality organization record and its information. However, you can deactivate it if you’re not an active Carequality participant anymore.

Using Postman or curl, send an Organization.Update request with the Active field set to false to deactivate an organization.

Example: Deactivate a Carequality organization record

bash

1
curl \
2
-X POST https://api.redoxengine.com/endpoint \
3
-H "Content-Type: application/json" \
4
-H "Authorization: Bearer $API_TOKEN" \
5
-d '{
6
  "Meta": {
7
    "DataModel": "Organization",
8
    // Everything can stay the same as New except here and the "Action" field below.
9
    "EventType": "Update",
10
    "Destinations": [
11
      {
12
        "ID": "a07afe3b-d247-4415-827f-6837707e1b8b"
13
      }
14
    ]
15
  },
16
  "Directory": "Carequality",
17
  "Action": "Update",
18
  "Organizations": [
19
    {
20
      "Name": "My Company Facility 1 Update",
21
      "DestinationID": "{{YOUR-REDOX-DESTINATION-ID}}",
22
      "Active": false,
23
      "Identifiers": [
24
        {
25
          "ID": "{{YOUR-ORGANIZATION-OID}}",
26
          "IDType": "OID"
27
        }
28
      ],
29
      // This references the top-level Redox organization.
30
      "PartOf": {
31
        "Identifier": {
32
          "Value": "{{YOUR-BASE-OID}}"
33
        }
34
      },
35
      "Contacts": [
36
        {
37
          "Purpose": "Technical",
38
          "Name": "Redox Carequality Support - Test",
39
          "EmailAddresses": ["support@redoxengine.com"],
40
          "PhoneNumber": {
41
            "Work": "+16085359501",
42
            "Mobile": "+16085359501"
43
          }
44
        }
45
      ],
46
      "Address": {
47
        "StreetAddress": "2020 Eastwood Dr",
48
        "City": "Madison",
49
        "State": "WI",
50
        "ZIP": "53704",
51
        "County": "Dane",
52
        "Country": "USA"
53
      }
54
    }
55
  ]
56
}'

API reference

Review the Organization data model schema for more technical details.

If the request is successful, you receive a synchronous response indicating that your organization record was updated.

Example: Successful response for organization update

json

1
{
2
  "Meta": {
3
    "DataModel": "Organization",
4
    "EventType": "Update",
5
    "Message": {
6
      "ID": 4606153124
7
    },
8
    "Source": {
9
      "ID": "7f296bb4-83fd-498d-92f3-a76960648788"
10
    },
11
    "Destinations": [
12
      {
13
        "ID": "a07afe3b-d247-4415-827f-6837707e1b8b"
14
      }
15
    ],
16
    "Extensions": {
17
      "ResponseDetail": {
18
        "string": "Organization with id:2.16.840.1.113883.3.6147.5 has been updated successfully."
19
      }
20
    }
21
  }
22
}

Next steps

Search for patient records

Onramp to Carequality resources

Basic information

Interact with clinical networks
Carequality identity and organization structure
Carequality FAQ
Carequality test patients (contains patient data to use when testing)

How-to

Troubleshooting

Common Carequality errors

FHIR® is a registered trademark of Health Level Seven International (HL7) and is used with the permission of HL7. Use of this trademark does not constitute an endorsement of products/services by HL7®.