Create a Carequality organization record

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.

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

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

       Copy

       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.

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

   Copy

   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.

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:

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

     Copy

     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.

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

   Example: Successful response for organization update

   json

   Copy

   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
   }

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.

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

   Copy

   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.

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

   Example: Successful response for organization update

   json

   Copy

   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
   }

• Search for patient records