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.
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.
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 | Staging ID | Production ID |
---|---|---|
Query for/create/update/delete an organization | a07afe3b-d247-4415-827f-6837707e1b8b | 5d0fd248-6c52-4ad9-b907-ae10bf2dcc39 |
Search for a patient with record locator service | adf917b5-1496-4241-87e2-ed20434b1fdb | 97f2dc1d-c71b-43a7-a436-9b789d44c804 |
Search for a patient within a specific organization | 1ca254a8-8d42-4593-abb4-b21399d9de57 | 6391b961-55ae-430b-a789-cf575f03fca0 |
Search for a clinical summary/document | ec745338-8849-43ad-a7ce-4bc5bf1d8b89 | 628cbf79-1156-4923-b9d0-285906160ed6 |
Save patient details and documents to your repository | This 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. |
curl
, send an Organization.New request to create your organization record in Carequality.
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
.
curl \-X POST https://api.redoxengine.com/endpoint \-H "Content-Type: application/json" \-H "Authorization: Bearer [access token]" \-d '{"Meta": {"DataModel": "Organization","EventType": "New","Destinations": [{"ID": "a07afe3b-d247-4415-827f-6837707e1b8b"}]},"Directory": "Carequality", # Currently, only Carequality is supported"Action": "Create","Organizations": [{"Name": "My Company",# The destination ID should be your Redox destination UUID where you# will receive inbound traffic (you can use null for testing)"DestinationID": "5e3dc12b-3a04-438e-880d-a690639e629e","Aliases": ["My Company, LLC", "MY"],"Active": true,# OID is the only required identifier, but you can include your own identifiers as needed"Identifiers": [{"ID": "[Your OID here]","IDType": "OID"}],# This references Redox for your top-level, and your other Organizations for levels below"PartOf": {"Identifier": {# Your "PartOf" or parent should be Redox: 2.16.840.1.113883.3.6147.458.2"Value": "[Your base OID here]"}},# This section should be replaced with your contact information"Contacts": [{"Purpose": "Technical","Name": "Redox Carequality Support - Test","EmailAddresses": ["support@redoxengine.com"],"PhoneNumber": {"Work": "+16085359501","Mobile": "+16085359501"}}],# This section should be replaced with your address information"Address": {"StreetAddress": "2020 Eastwood Dr","City": "Madison","State": "WI","ZIP": "53704","County": "Dane","Country": "USA"}}]}'
{"Meta": {"DataModel": "Organization","EventType": "New","Message": {"ID": 4606153124},"Source": {"ID": "7f296bb4-83fd-498d-92f3-a76960648788",},"Destinations": [{"ID": "a07afe3b-d247-4415-827f-6837707e1b8b"}],"Extensions": {"ResponseDetail": {"string": "New organization was added successfully."}}}}
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.
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:
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.
Keep in mind that marking an organization as inactive doesn't fully remove all information. In other words, a "deleted" facility is merely inactive.
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
.
curl \-X POST https://api.redoxengine.com/endpoint \-H "Content-Type: application/json" \-H "Authorization: Bearer [access token]" \-d '{"Meta": {"DataModel": "Organization",# Everything can stay the same as New except here and the "Action" field below"EventType": "Update","Destinations": [{"ID": "a07afe3b-d247-4415-827f-6837707e1b8b"}]},"Directory": "Carequality",# This must also change to "Update""Action": "Update","Organizations": [{"Name": "My Company Facility 1 Update","DestinationID": "5e3dc12b-3a04-438e-880d-a690639e629e",# This will effectively "delete" the organization"Active": false,"Identifiers": [{"ID": "[Your OID here].1","IDType": "OID"}],# This references the top-level Redox organization"PartOf": {"Identifier": {"Value": "[Your base OID here]"}},"Contacts": [{"Purpose": "Technical","Name": "Redox Carequality Support - Test","EmailAddresses": ["support@redoxengine.com"],"PhoneNumber": {"Work": "+16085359501","Mobile": "+16085359501"}}],"Address": {"StreetAddress": "2020 Eastwood Dr","City": "Madison","State": "WI","ZIP": "53704","County": "Dane","Country": "USA"}}]}'
{"Meta": {"DataModel": "Organization","EventType": "Update","Message": {"ID": 4606153124},"Source": {"ID": "7f296bb4-83fd-498d-92f3-a76960648788"},"Destinations": [{"ID": "a07afe3b-d247-4415-827f-6837707e1b8b"}],"Extensions": {"ResponseDetail": {"string": "Organization with id:2.16.840.1.113883.3.6147.5 has been updated successfully."}}}}
Basic information
How-to
Troubleshooting