Your organization record in Carequality is how you identify yourself and how others 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.
Our starter package pricing only includes one registered organization. Check our Carequality FAQ to find out when you may need to register more than one organization record.
Our wizard provides you with an organizational OID (unique Object Identifier), which is your unique identifier in the Carequality directory.
Check our Carequality FAQ to learn more about OIDs and identity.
Send an Organization.New request in staging to create your organization record in Carequality. Once you’re finished testing in staging, create your organization record in production too.
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"}}]}'
If the request is successful, you receive a synchronous response indicating that your organization record was created.
{"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.
Send an Organization.Update request whenever there are changes to your organization details (e.g., address or contact information) to keep your organization record up-to-date.
You can also delete your organization record within Carequality using the Organization.Update query. Keep in mind that this does not fully remove all information, but instead marks the “deleted” facility as inactive.
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"}}]}'
If the request is successful, you receive a synchronous response indicating that your organization record was updated.
{"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."}}}}