Create and maintain an organization record

Who can use this how-to

  • Existing customers using digital record retrieval
  • Existing customers with a direct connection to Carequality (i.e., without digital record retrieval)

An organization record (i.e., organization OID in the Redox dashboard) 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.

Use curl for technical validation

You can copy the code examples we provide and send the test requests with curl (learn more about curl) instead of Postman. Keep in mind though that you need to remove the comments from the code examples (starting with //) and replace any variables (e.g., {{variable here}}) to use them. Also, note that some of the code examples are abbreviated, so be mindful of that if you're copying them for your own use.

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 purposeStaging IDProduction ID
Query for/create/update/delete an organizationa07afe3b-d247-4415-827f-6837707e1b8b5d0fd248-6c52-4ad9-b907-ae10bf2dcc39
Search for a patient with record locator serviceadf917b5-1496-4241-87e2-ed20434b1fdb97f2dc1d-c71b-43a7-a436-9b789d44c804
Search for a patient within a specific organization1ca254a8-8d42-4593-abb4-b21399d9de576391b961-55ae-430b-a789-cf575f03fca0
Search for a clinical summary/documentec745338-8849-43ad-a7ce-4bc5bf1d8b89628cbf79-1156-4923-b9d0-285906160ed6
Save patient details and documents to your repositoryThis is specific to your org—you can find the correct ID in the digital record retrieval wizard.This is specific to your org—you can find the correct ID in the digital record retrieval wizard.

Create your organization record

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

    Canada URL

    If you're operating in Canada, you must tweak the Redox hostname slightly. All you need to do is add a ca in that URL like this: https://api.ca.redoxengine.com.

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

If you don't receive the expected response, check out the Appendix for details on common errors.

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

Maintain or delete 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:

  1. Using Postman or curl, send an Organization.Update request with the updated or new organization details. Alternatively, if you need to delete an organization record, you can use this same query but populate the Active field with false to delete the record.

    Deleting an organization record

    Keep in mind that marking an organization as inactive doesn't fully remove all information. In other words, a "deleted" facility is merely inactive.

    Canada URL

    If you're operating in Canada, you must tweak the Redox hostname slightly. All you need to do is add a ca in that URL like this: https://api.ca.redoxengine.com.

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

Next steps

Digital record retrieval resources

Basic information

How-to

Troubleshooting

On this Page