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.

• You must have qualified for TEFCA and set up your credentials and OIDs. Learn more about setting up your onramp to TEFCA.
• Be familiar with the following terms and concepts to send requests to TEFCA-CommonWell:

  TEFCA-CommonWell terms to know

  Term	Description
  Organization or object ID (OID)	Identifies a particular healthcare organization within the TEFCA-CommonWell network. When you create a new organization record within TEFCA, the returned OID becomes the sender organization ID for your later queries.
  Patient Identity Assigning Authority (PIAA)	The entity that assigns patient identifiers in the healthcare system. This value becomes the ID type in the metadata of TEFCA-CommonWell queries for documents.

  Metadata for TEFCA-CommonWell requests

  This table contains the metadata fields for Redox data models if you’re querying or sending requests to TEFCA-CommonWell via the Redox Data Model API.

  Field	Description	Notes
  Meta.Destinations.ID	A universally unique identifier (UUID) for the destination you wish to search. This ID is different for staging and production environments. Check out the destination ID table for specifics.	For patient searches, this is a CommonWell EMPI destination. For document searches, this is a CommonWell XCA destination. For responding with information about your patients, this is your own document repository.
  Meta.FacilityCode	Set to your organization OID or null.	This is required for document searches. A less common workflow might include directly querying to an external organization within the network. In that case, use their organization OID.
  Meta.Extensions.organization-name	The name of the organization running the query.	Generally, this is the name of your organization or the covered entity that you’re providing services for.
  Meta.Extensions.sender-organization-id	The organizational OID to identify your organization as the one sending the request.	This field is used for audit purposes and for search logic. To generate your organization OID for the sender-organization-id extension, refer to TEFCA identity and organization structure.
  Meta.Extensions.user-id	Either the name of the user sending the request or the relevant provider. This should be a human-readable identifier and is required for audit purposes.	The provider’s name should still be populated when an automated process runs the query. For example, a provider may have an automated process triggered after completing a patient visit. In that case, the query runs in the background on the provider’s behalf.
  Meta.Extensions.user-role	The role of the user sending the request.	You must use a SNOMED value for this field. See SNOMED codes.
  Meta.Extensions.purpose-of-use	The purpose of use for this request (e.g., Treatment).	You must qualify for a "Treatment" purpose of use when using Network Onramps.

  Destination IDs for TEFCA-CommonWell

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

  Query purpose	Development ID	Production ID
  Perform a patient search (PatientSearch.LocationQuery)	3122bfff-f1fb-4fdf-97de-294f24338229	7fd005ac-d788-40c5-b4e8-b57bb8e310a9
  Create or update an organization (Organization.New, Organization.Update)	3122bfff-f1fb-4fdf-97de-294f24338229	7fd005ac-d788-40c5-b4e8-b57bb8e310a9
  Search for a clinical summary/document (ClinicalSummary.DocumentQuery, ClinicalSummary.DocumentGet)	cf1dca0e-98de-432b-8c9a-dd039816df0e	79981c00-b9c4-40a9-9844-01980e6e524e
  Save patient details to your repository (PatientAdmin.NewPatient, PatientAdmin.PatientUpdate, PatientAdmin.PatientMerge)	3122bfff-f1fb-4fdf-97de-294f24338229	7fd005ac-d788-40c5-b4e8-b57bb8e310a9
  Save documents to your repository (ClinicalSummary.VisitQuery, ClinicalSummary.VisitPush)	This is specific to your organization. Redox provides the correct ID.	This is specific to your organization. Redox provides the correct ID.

When testing, create an organization record in your development environment, then in your production environment once you’ve finished testing.

1. Using Postman or curl, send an Organization.New request to create your organization record in TEFCA-CommonWell.
   • The PIAA ID is your patient identifier assigning authority, which has its own ID. Your IDs will be scoped under this and show up as an IDType in any patient or document queries.
   • For other IDs, TEFCA requires at least one of the following ID types to be assigned to each organization: TIN, NPI Type 1, NPI Type 2. Include all ID types that are applicable to your organization.
   • The PartOf identifier refers to the parent organization, which is Redox. Use the Redox ID value.
   • For Contacts, replace our example data with your organization’s contact information.

     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
               "ID": "{{YOUR-ORGANIZATION-OID}}",
     27
               "IDType": "OID"
     28
             },
     29
            {
     30
               "ID": "{{YOUR-PIAA-ID}}",
     31
               "IDType": "PIAA"
     32
             },
     33
             {
     34
             "ID": "{{YOUR-NPI-TYPE-1-ID}}",
     35
             "IDType": "NPI Type 1"
     36
             },
     37
             {
     38
             "ID": "{{YOUR-NPI-TYPE-2-ID}}",
     39
             "IDType": "NPI Type 2"
     40
             },
     41
             {
     42
             "ID": "{{YOUR-TIN-ID}}",
     43
             "IDType": "Tax Identification Number"
     44
             },
     45
           ],
     46
           "PartOf": {
     47
             "Identifier": {
     48
               "Value": "2.16.840.1.113883.3.6147.458.2"
     49
             }
     50
           },
     51
           "Contacts": [
     52
             {
     53
               "Purpose": "Technical",
     54
               "Name": "Redox CommonWell Support - Test",
     55
               "EmailAddresses": ["support@redoxengine.com"],
     56
               "PhoneNumber": {
     57
                 "Work": "+16085359501",
     58
                 "Mobile": "+16085359501"
     59
               }
     60
             }
     61
           ],
     62
           "Address": {
     63
             "StreetAddress": "2020 Eastwood Dr",
     64
             "City": "Madison",
     65
             "State": "WI",
     66
             "ZIP": "53704",
     67
             "County": "Dane",
     68
             "Country": "USA"
     69
           }
     70
         }
     71
       ]
     72
     }'

     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 must set up DNPR first

   Every organization record created in CommonWell-TEFCA must have an associated Data Network Participant Repository (DNPR) set up within Redox. Only a Redoxer can manage your DNPR. 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 '{  
   6
     "Meta": {
   7
       "DataModel": "Organization",
   8
       "EventType": "Update",
   9
       "Destinations": [
   10
         {
   11
           "ID": "3122bfff-f1fb-4fdf-97de-294f24338229",
   12
           "Name": "CommonWell EMPI [Integration]"
   13
        }
   14
       ]
   15
     },
   16
     "Directory": "CommonWell",
   17
     "Action": "Update",
   18
     "Organizations": [
   19
       {
   20
         "Name": "My Company",
   21
         "Aliases": ["My Company, LLC", "MY"],
   22
         "Active": true,
   23
   
   24
         "Identifiers": [
   25
           {
   26
             "ID": "{{YOUR-ORGANIZATION-OID}}",
   27
             "IDType": "OID"
   28
           },
   29
          {
   30
             "ID": "{{YOUR-PIAA-ID}}",
   31
             "IDType": "PIAA"
   32
           },
   33
           {
   34
           "ID": "{{YOUR-NPI-TYPE-1-ID}}",
   35
           "IDType": "NPI Type 1"
   36
           },
   37
           {
   38
           "ID": "{{YOUR-NPI-TYPE-2-ID}}",
   39
           "IDType": "NPI Type 2"
   40
           },
   41
           {
   42
           "ID": "{{YOUR-TIN-ID}}",
   43
           "IDType": "Tax Identification Number"
   44
           },
   45
         ],
   46
         "PartOf": {
   47
           "Identifier": {
   48
             "Value": "2.16.840.1.113883.3.6147.458.2"
   49
           }
   50
         },
   51
         "Contacts": [
   52
           {
   53
             "Purpose": "Technical",
   54
             "Name": "Redox CommonWell Support - Test",
   55
             "EmailAddresses": ["support@redoxengine.com"],
   56
             "PhoneNumber": {
   57
               "Work": "+16085359501",
   58
               "Mobile": "+16085359501"
   59
             }
   60
           }
   61
         ],
   62
         "Address": {
   63
           "StreetAddress": "2020 Eastwood Dr",
   64
           "City": "Madison",
   65
           "State": "WI",
   66
           "ZIP": "53704",
   67
           "County": "Dane",
   68
           "Country": "USA"
   69
         }
   70
       }
   71
     ]
   72
   }'

   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.

• Populate your patient repository