Note: This release is in preview. Features described here don’t become generally available until the latest general availability date that Salesforce announces for this release. Before then, and where features are noted as beta, pilot, or developer preview, we can’t guarantee general availability within any particular time frame or at all. Make your purchase decisions only on the basis of generally available products and features.

Assessment Responses

Save assessment responses from an OmniScript built with the Assessment Questions app.

This feature requires OmniStudio and Discovery Framework licenses. To build an OmniScript using the Assessment Questions app, see Create a Form.

In in Health Cloud, this API captures supporting information for a Prior Authorization (PA) by recording responses from the Documentation Template and Rules Questionnaire. It associates these responses with a specific PA request and is triggered as part of the $submit API from Mulesoft.

Resource

1/connect/discovery-framework/assessment-responses/omniScriptId

Available version

60.0

HTTP methods

POST

Request body for POST

JSON example

1{
2  "inputs": {
3    "questionResponses": {
4      "ootb__DF_API_MSelect1": "Y;N",
5      "ootb__DF_API_MSelect2": "1;2;3",
6      "ootb__DF_API_RG1": {
7        "ootb__DF_API_Radio1": "Y",
8        "ootb__DF_API_Radio2": "N",
9        "ootb__DF_API_Radio3": "M"
10      },
11      "ootb__DF_API_Text": "TestingDF",
12      "ootb__DF_API_Select1": "1",
13      "ootb__DF_API_Select2": "w",
14      "ootb__DF_API_EditBlock2": {
15        "ootb__DF_API_Int": 5
16      },
17      "ootb__DF_API_Boolean": true,
18      "ootb__DF_API_Formula": true
19    }
20  },
21  "contextId": "0U3B00000004IhWKAU",
22  "assessmentValues": {
23    "Assessment.AssessmentStatus": "Completed"
24  },
25  "completedDateTime": "2024-10-23T14:45:29.123+05:30",
26  "assessor": "001SG00000laIWPYA2",
27  "identifier": "Test identifier",
28  "assessmentDetails": {
29    "assessmentReasons": [
30      {
31        "referenceRecord": "0jySG0000000qRdYAI"
32      },
33      {
34        "referenceRecord": "0SqSG00000005HR0AY"
35      },
36      {
37        "referenceRecord": "0kmSG0000000n7BYAQ",
38        "referenceValue": "Medication Request sample"
39      },
40      {
41        "referenceValue": "Reference Record not present"
42      }
43    ],
44    "assessmentQuestionsResponseDetails": {
45      "First_Name": {
46        "originType": "Auto",
47        "reviewerRole": "0hsSG0000002t8TYAQ",
48        "reviewer": "003SG00000BTzxpYAD"
49      },
50      "Last_Name": {
51        "originType": "Auto",
52        "reviewerRole": "0hsSG0000002t8TYAQ",
53        "reviewer": "003SG00000BTzxpYAD"
54      },
55      "Email": {
56        "originType": "Auto",
57        "reviewerRole": "0hsSG0000002t8TYAQ",
58        "reviewer": "003SG00000BTzxpYAD"
59      },
60      "Phone": {
61        "originType": "Auto",
62        "reviewerRole": "0hsSG0000002t8TYAQ",
63        "reviewer": "003SG00000BTzxpYAD"
64      },
65      "Multi_Select": {
66        "originType": "Auto",
67        "reviewerRole": "0hsSG0000002t8TYAQ",
68        "reviewer": "003SG00000BTzxpYAD"
69      }
70    }
71  }
72}

Properties

Name	Type	Description	Required or Optional	Available Version
`assessmentValues`	Assessment Values Input>[]	Values of Assessment fields.	Optional	60.0
`contextId`	String	Context record for the OmniScript.	Optional	60.0
`inputs`	Question Responses Input[]	Responses for Assessment Questions.	Optional	60.0

Response body for POST

Assessment Responses Output

Public Sector Developer Guide

Assessment Responses