Create an Assessment with Discovery Framework

Create an assessment form using the OmniScript designer in the OmniStudio app. The Assessment Component shows assessments that you create using the Discovery Framework.

Available in: Lightning Experience

Available in: Enterprise and Unlimited Editions with Health Cloud or Health Cloud for Life Sciences


User Permissions Needed
To create a Discovery Framework OmniScript: OmniStudio User

AND

Create, Read, Edit, and Delete on assessment questions

  1. Create an assessment question set.
    1. From the App Launcher, find and select Assessment Question Sets.
    2. Click New.
    3. Enter the name of the question set.
      Use the name of the overall assessment as the name of the assessment question set. For example, Mental Health Assessment.
    4. Enter the developer name.
      The developer name can contain only underscores and alphanumeric characters, and must be unique in your org. It must begin with a letter, not include spaces, not end with an underscore, and not contain two consecutive underscores. In managed packages, this field prevents naming conflicts for package installations.
    5. Save your work.
  2. Create assessment questions.
    1. From the App Launcher, find and select Assessment Questions.
    2. Click New.
    3. Enter the Name, Developer Name, Data Type, Category, and Question Text for the question.
    4. To make this question the active version, select Active.
    5. When you create a question, the data type that you select corresponds to an OmniScript element that you can add to the OmniScript structure. See Supported Data Types for Questions.
    6. Choose the Assessment Question Set for this question.
      To associate the question with other Assessment Question Sets, use the Assessment Question Assignments related list on the Assessment Question detail page.
    7. Save your work.
    8. Repeat these steps for each assessment question.
  3. Create a form.
    1. On the Assessment Questions list view, click Select Questions.
    2. In the OmniScript Details section, enter the name of the assessment.
    3. Enter the Type of assessment.
      The type and sub type give an OmniScript its unique identity. Only one active OmniScript has the same type, sub type, and language at any time. Though not required, it’s recommended that an OmniScript’s type starts with a lower case letter.
    4. Enter the Sub Type of the assessment.
    5. Enter a Language.
    6. Find the questions you created by selecting the Question Set (1).
      A screen shot of the form builder showing five areas of the screen. 1-question search, 2- add a step, 3-edit step name, 4- choose questions, 5- build an omniscript
    7. To add more steps, click Add Step (2).
    8. Edit the name of the step (3).
    9. Drag each question into a Step (4).
      Steps correspond to the questions in your form. You can group multiple questions in a single step. You can also create multiple steps in a single form.
    10. Click Build OmniScript (5).
      This operation creates an OmniScript that's of type Discovery Framework for the form, and then opens the OmniScript in the OmniScript Designer on a new tab.
    11. For Usage Type, select Health Cloud.
    12. Save your work.
  4. Use OmniScript Designer to customize the assessment further if needed.
  5. On the designer header, click Preview to test the form.
  6. On the designer header, click Activate Version when you’re ready to deploy the form.

    Activating the OmniScript generates a Lightning Web Component that you can publish on a Lightning page or Experience Cloud site. The Assessments component adds the ability to view all OmniScripts with Discovery Framework in a single place.

    Note

  7. Navigate to the Assessment component on the patient record page. Verify that the assessment appears in the All Assessments tab.