How do you import config into an organization?

To import configurations into your organization, follow these steps:

  1. Prepare Your Configuration: Ensure that your configuration is in the correct JSON format and contains all necessary fields.

  2. Access the Import Endpoint: Use the designated API endpoint for importing configurations.

  3. Execute the Import: Send a POST request with your configuration file to the import endpoint. You can copy and paste the fields from the response of the export process, and the data will be imported into the specified organization.

  4. Verify Import Success: Check the response to ensure that the import was successful and review any logs for errors.

Access Criteria

Only a Config user of the organization can call this API for the given organization ID.

Importable Database Tables/Configurations

The following tables can be imported as part of the configuration import process:

  1. organizationSettings: Contains settings specific to the organization, such as preferences and configurations.

  2. webhookConfiguration: Stores configurations for webhooks, including URLs and event triggers.

  3. emailTemplate: Contains templates for emails sent out by the system.

  4. surveys:

    • questions: The questions associated with surveys.

    • answerOption: Possible answers for questions.

    • enableWhen: Conditions under which certain questions are enabled.

  5. observationGroup:

    • observationCodes: Codes used for observations.

    • observationCodeRange: Ranges of observation codes.

  6. attributeSchema: Defines the schema for attributes used within the organization.

  7. language:

    • orgLabelValue: Language settings and labels used within the organization.

  8. ehrIntegrations: Configurations related to Electronic Health Record integrations.

  9. organizationResourceIntegration: Settings related to resource integrations for the organization.

  10. healthRecordAttribute: Attributes related to health records that can be imported.

Conclusion

This section provides a quick overview of how to import configurations for your organization. Ensure that you adhere to the access criteria to maintain data integrity and security.

Last updated