Create a TEFCA-CommonWell organization record

An organization record (i.e., OID in the Redox organization) is the unique identifier for your organization within the CommonWell Health Alliance. The organization OID is how you identify yourself when searching for patients—and how other TEFCA-CommonWell 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.

1. In your staging environment, using Postman or curl, send an Organization.New request to create your organization record in TEFCA-CommonWell.

   Example: Create a TEFCA-CommonWell 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": "New",
   9
       "Destinations": [
   10
         {
   11
           "ID": "3122bfff-f1fb-4fdf-97de-294f24338229",
   12
           "Name": "CommonWell EMPI [Integration]"
   13
        }
   14
       ]
   15
     },
   16
     "Directory": "CommonWell",
   17
     "Action": "Create",
   18
     "Organizations": [
   19
       {
   20
         "Name": "My Company",
   21
         "Aliases": ["My Company, LLC", "MY"],
   22
         "Active": true,
   23
   
   24
         "Identifiers": [
   25
           {
   26
            // OID is your organization's ID .
   27
             "ID": "{{your-OID}}",
   28
             "IDType": "OID"
   29
           },
   30
          {
   31
            // Your PIAA is your patient identifier assigning authority.
   32
            // Your IDs will be scoped under this and show up as an 'IDType' in patient / document queries.
   33
             "ID": "{{your-PIAA}}",
   34
             "IDType": "PIAA"
   35
           },
   36
         ],
   37
         // This references Redox as your top-level, and your other organizations for levels below.
   38
         "PartOf": {
   39
           "Identifier": {
   40
             // Your "PartOf" or parent should be Redox: 2.16.840.1.113883.3.6147.458.2
   41
             "Value": "{{your-base-OID}}"
   42
           }
   43
         },
   44
         // Replace this information with your contact information.
   45
         "Contacts": [
   46
           {
   47
             "Purpose": "Technical",
   48
             "Name": "Redox CommonWell Support - Test",
   49
             "EmailAddresses": ["support@redoxengine.com"],
   50
             "PhoneNumber": {
   51
               "Work": "+16085359501",
   52
               "Mobile": "+16085359501"
   53
             }
   54
           }
   55
         ],
   56
         // Replace this information with your address information.
   57
         "Address": {
   58
           "StreetAddress": "2020 Eastwood Dr",
   59
           "City": "Madison",
   60
           "State": "WI",
   61
           "ZIP": "53704",
   62
           "County": "Dane",
   63
           "Country": "USA"
   64
         }
   65
       }
   66
     ]
   67
   }'

   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 new TEFCA-CommonWell 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
   }

   Redoxer setup must be done

   Every organization record created in CommonWell-TEFCA must have an associated Data Network Participant Repository (DNPR) setup within Redox. Only a Redoxer can manage your DNPR setup. If you don’t receive the expected response, submit a Help Center request to get help. In the ticket, include your organization OID, your destination ID for document responding, and your supported purpose(s) of use.

   For help with errors, review common TEFCA-CommonWell errors.

3. Once you complete all of your testing, 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 or new organization details.

   Example: Update a TEFCA-CommonWell 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 '  "Meta": {
   6
       "DataModel": "Organization",
   7
       "EventType": "New",
   8
       "Destinations": [
   9
         {
   10
           "ID": "3122bfff-f1fb-4fdf-97de-294f24338229",
   11
           "Name": "CommonWell EMPI [Integration]"
   12
        }
   13
       ]
   14
     },
   15
     "Directory": "CommonWell",
   16
     "Action": "Create",
   17
     "Organizations": [
   18
       {
   19
         "Name": "My Company",
   20
         "Aliases": ["My Company, LLC", "MY"],
   21
         "Active": true,
   22
   
   23
         "Identifiers": [
   24
           {
   25
            // OID is your organization's ID .
   26
             "ID": "{{your-OID}}",
   27
             "IDType": "OID"
   28
           },
   29
          {
   30
            // Your PIAA is your patient identifier assigning authority.
   31
            // Your IDs will be scoped under this and show up as an 'IDType' in patient / document queries.
   32
             "ID": "{{your-PIAA}}",
   33
             "IDType": "PIAA"
   34
           },
   35
         ],
   36
         // This references Redox as your top-level, and your other organizations for levels below.
   37
         "PartOf": {
   38
           "Identifier": {
   39
             // Your "PartOf" or parent should be Redox: 2.16.840.1.113883.3.6147.458.2
   40
             "Value": "{{your-base-OID}}"
   41
           }
   42
         },
   43
         // Replace this information with your contact information.
   44
         "Contacts": [
   45
           {
   46
             "Purpose": "Technical",
   47
             "Name": "Redox CommonWell Support - Test",
   48
             "EmailAddresses": ["support@redoxengine.com"],
   49
             "PhoneNumber": {
   50
               "Work": "+16085359501",
   51
               "Mobile": "+16085359501"
   52
             }
   53
           }
   54
         ],
   55
         // Replace this information with your address information.
   56
         "Address": {
   57
           "StreetAddress": "2020 Eastwood Dr",
   58
           "City": "Madison",
   59
           "State": "WI",
   60
           "ZIP": "53704",
   61
           "County": "Dane",
   62
           "Country": "USA"
   63
         }
   64
       }
   65
     ]
   66
   }'

   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.

• Search for patient records