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 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 Redox Access wizard. | This is specific to your org—you can find the correct ID in the Redox Access wizard. |
- In your staging environment, using Postman or curl, send an Organization.New request to create your organization record in Carequality.Canada URL
Example: Create an organization record
- If the request is successful, you receive a synchronous response indicating that your organization record was created.
Example: Successful response for creating an organization record
If you don't receive the expected response, review common Carequality 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:
- 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 recordCanada URL
Example: Update an organization record
- If the request is successful, you receive a synchronous response indicating that your organization record was updated.
Example: Successful response for organization update