> For the complete documentation index, see [llms.txt](https://docs.welkinhealth.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.welkinhealth.com/api-reference/assessment-formation.md).

# Assessment Formation

An assessment consists of 3 parts: main, scoring, condition settings.

The main part contains a list of sections. Each section contains a list of fields. The **viewType** parameter in the field indicates how the field will be displayed. The parameter can take one of two values: *readOnly* and *question*. The *readOnly* value of the parameter indicates that the field will be displayed as a text comment. The *question* value of the parameter indicates that the field will be displayed as a question with the possibility of user input. If the value of the **viewType** parameter is equal to *question* then parameters **refCdtName**, **refCdtFieldName** and **meta** are required. The combination of parameter values **refCdtName** and **refCdtFieldName** must be unique among all fields in the assessment.

The scoring part describes the rules for calculating the assessment score. The **formula** parameter indicates how the score will be calculated. The parameter can take one of two values: *SUM* and *AVG*. The *SUM* value of the parameter indicates that the group scores will be summed up. The *AVG* value of the parameter indicates that the average of the group scores will be calculated. Each group also has the **formula** parameter which takes the same values. The group score calculates from the field's scores. To associate fields in scoring with questions, you must specify **refCdtName** and **refCdtFieldName**.

The condition settings are divided into two parts: **elements** and **events**. The **elements** part describes how sections or questions will be displayed based on user answers. The **events** part describes which custom events will be hit based on user answers.

The collection supports several interactions

1. Allows to obtain a list of assessment
2. Allows to obtain a certain assessment
3. Allows to obtain a list of CDTs that is associated with an assessments

## Get all Assessments

> 1\.  First variable is your Tenant name. We will use \*\*gh\*\* as a tenant name through this set of api docs\
> 2\.  Second variable is your Instance name. We will use \*\*sb-demo\*\* as an instance name through this set of api docs\
> 3\.  Third variable is your formation version. We will use \*\*current\*\* to get published version and \*\*draft\*\* to get version in draft.\
>     \
> \
> \*   HTTP Method: GET\
> \*   HTTP URL: \`<https://api.live.welkincloud.io/gh/sb-demo/formation/current/assessments\\`\\>
> \*   HTTP Response Codes: 200

```json
{"openapi":"3.0.3","info":{"title":"Welkin Health API","version":"1.0.0"},"tags":[{"name":"Assessment formation","description":"An assessment consists of 3 parts: main, scoring, condition settings.\n\nThe main part contains a list of sections. Each section contains a list of fields. The **viewType** parameter in the field indicates how the field will be displayed. The parameter can take one of two values: *readOnly* and *question*. The *readOnly* value of the parameter indicates that the field will be displayed as a text comment. The *question* value of the parameter indicates that the field will be displayed as a question with the possibility of user input. If the value of the **viewType** parameter is equal to *question* then parameters **refCdtName**, **refCdtFieldName** and **meta** are required. The combination of parameter values **refCdtName** and **refCdtFieldName** must be unique among all fields in the assessment.\n\nThe scoring part describes the rules for calculating the assessment score. The **formula** parameter indicates how the score will be calculated. The parameter can take one of two values: *SUM* and *AVG*. The *SUM* value of the parameter indicates that the group scores will be summed up. The *AVG* value of the parameter indicates that the average of the group scores will be calculated. Each group also has the **formula** parameter which takes the same values. The group score calculates from the field's scores. To associate fields in scoring with questions, you must specify **refCdtName** and **refCdtFieldName**.\n\nThe condition settings are divided into two parts: **elements** and **events**. The **elements** part describes how sections or questions will be displayed based on user answers. The **events** part describes which custom events will be hit based on user answers.\n\nThe collection supports several interactions\n\n1.  Allows to obtain a list of assessment\n2.  Allows to obtain a certain assessment\n3.  Allows to obtain a list of CDTs that is associated with an assessments"}],"servers":[{"url":"https://api.live.welkincloud.io","description":"Welkin Health production API"}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","description":"Bearer token obtained from `POST /{tenantName}/admin/api_clients/{clientName}`. Valid for 60 minutes."}},"parameters":{"TenantName":{"name":"tenantName","in":"path","required":true,"description":"Your organization (tenant) name, e.g. `acme-health`","schema":{"type":"string"}},"InstanceName":{"name":"instanceName","in":"path","required":true,"description":"Your environment name: `live`, `sandbox`, or a custom name","schema":{"type":"string"}}},"schemas":{"Assessment":{"type":"object","required":["name","sections"],"properties":{"id":{"type":"string","format":"uuid","readOnly":true},"title":{"type":"string","nullable":true},"name":{"type":"string","pattern":"^[a-z0-9\\-_]+$","maxLength":75},"version":{"type":"integer","readOnly":true},"sections":{"type":"array","items":{"$ref":"#/components/schemas/AssessmentSection"}},"scoring":{"$ref":"#/components/schemas/AssessmentScoring"},"programs":{"type":"array","items":{"$ref":"#/components/schemas/AssessmentProgramRelation"}},"_containsPHI":{"type":"boolean","readOnly":true},"displayType":{"$ref":"#/components/schemas/AssessmentDisplayType","default":"SECTIONS"},"autoCompleted":{"type":"boolean"}}},"AssessmentSection":{"type":"object","required":["name","order"],"properties":{"title":{"type":"string","nullable":true},"name":{"type":"string"},"order":{"type":"integer"},"fields":{"type":"array","items":{"$ref":"#/components/schemas/AssessmentSectionField"}}}},"AssessmentSectionField":{"type":"object","description":"Polymorphic on `viewType`: `question`/`readOnly`/`consent` fields carry `refCdtFieldName` + `meta`; `fieldGroup` fields carry a nested `fields` array instead.","properties":{"viewType":{"type":"string","enum":["question","readOnly","consent","fieldGroup"]},"label":{"type":"string","nullable":true},"name":{"type":"string","nullable":true},"refCdtName":{"type":"string","nullable":true},"order":{"type":"integer"},"refCdtFieldName":{"type":"string","nullable":true},"meta":{"type":"object","nullable":true,"properties":{"type":{"$ref":"#/components/schemas/FieldTypeEnum"},"required":{"type":"boolean","nullable":true}}},"fields":{"type":"array","nullable":true,"description":"Present only when viewType is fieldGroup.","items":{"type":"object","additionalProperties":true}}}},"FieldTypeEnum":{"type":"string","enum":["TEXT","TEXTAREA","PASSWORD","EMAIL","INTEGER","FLOAT","PERCENT","RADIO","CHECKBOX","SELECT","CHOICE","DATE","TIME","DATETIME","FILE","IMAGE","URL","PHONE","UUID","SSN","ADDRESS","LOCATION","FORMULA","OBJECT","SIGNATURE"]},"AssessmentScoring":{"type":"object","properties":{"formula":{"type":"string","enum":["SUM","AVG","SCALED_AVG"],"default":"SUM"},"groups":{"type":"array","items":{"$ref":"#/components/schemas/AssessmentScoringGroup"}}}},"AssessmentScoringGroup":{"type":"object","required":["name","title","fields"],"properties":{"name":{"type":"string"},"title":{"type":"string"},"fields":{"type":"array","items":{"$ref":"#/components/schemas/AssessmentScoringField"}},"formula":{"type":"string","enum":["SUM","AVG","SCALED_AVG"],"default":"SUM"},"scalingFactor":{"type":"number","nullable":true}}},"AssessmentScoringField":{"type":"object","properties":{"refCdtName":{"type":"string"},"refCdtFieldName":{"type":"string"},"type":{"type":"string","enum":["select"]},"scores":{"type":"array","items":{"type":"object","properties":{"answer":{},"score":{"type":"number"},"notApplicable":{"type":"boolean"}}}}}},"AssessmentProgramRelation":{"type":"object","required":["program"],"properties":{"program":{"type":"string"},"phases":{"type":"array","items":{"type":"string"}}}},"AssessmentDisplayType":{"type":"string","enum":["SECTIONS","STEPS"]}},"responses":{"BadRequest":{"description":"Bad request — the request could not be understood or was missing required parameters."},"Unauthorized":{"description":"Unauthorized — the Bearer token is missing, expired, or invalid."},"Forbidden":{"description":"Forbidden — the API client role does not have permission for this resource. Check the role and security policy in Admin."},"NotFound":{"description":"Not found — the requested resource does not exist."},"TooManyRequests":{"description":"Too many requests — rate limit exceeded. Implement exponential backoff."},"InternalError":{"description":"Internal server error."}}},"paths":{"/{tenantName}/{instanceName}/formations/current/assessments":{"get":{"summary":"Get all Assessments","tags":["Assessment formation"],"operationId":"Get_all_Assessments","parameters":[{"$ref":"#/components/parameters/TenantName"},{"$ref":"#/components/parameters/InstanceName"}],"responses":{"200":{"description":"List of assessment formations","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Assessment"}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalError"}},"description":"1.  First variable is your Tenant name. We will use **gh** as a tenant name through this set of api docs\n2.  Second variable is your Instance name. We will use **sb-demo** as an instance name through this set of api docs\n3.  Third variable is your formation version. We will use **current** to get published version and **draft** to get version in draft.\n    \n\n*   HTTP Method: GET\n*   HTTP URL: `https://api.live.welkincloud.io/gh/sb-demo/formation/current/assessments`\n*   HTTP Response Codes: 200"}}}}
```

## Get all CDTs related to Assessment

> 1\.  First variable is your Tenant name. We will use \*\*gh\*\* as a tenant name through this set of api docs\
> 2\.  Second variable is your Instance name. We will use \*\*sb-demo\*\* as an instance name through this set of api docs\
> 3\.  Third variable is your formation version. We will use \*\*current\*\* to get published version and \*\*draft\*\* to get version in draft.\
> &#x20;   \
> \
> \*   HTTP Method: GET\
> \*   HTTP URL: \`<https://api.live.welkincloud.io/gh/sb-demo/formation/current/assessments\\`\\>
> \*   HTTP Response Codes: 200

```json
{"openapi":"3.0.3","info":{"title":"Welkin Health API","version":"1.0.0"},"tags":[{"name":"Assessment formation","description":"An assessment consists of 3 parts: main, scoring, condition settings.\n\nThe main part contains a list of sections. Each section contains a list of fields. The **viewType** parameter in the field indicates how the field will be displayed. The parameter can take one of two values: *readOnly* and *question*. The *readOnly* value of the parameter indicates that the field will be displayed as a text comment. The *question* value of the parameter indicates that the field will be displayed as a question with the possibility of user input. If the value of the **viewType** parameter is equal to *question* then parameters **refCdtName**, **refCdtFieldName** and **meta** are required. The combination of parameter values **refCdtName** and **refCdtFieldName** must be unique among all fields in the assessment.\n\nThe scoring part describes the rules for calculating the assessment score. The **formula** parameter indicates how the score will be calculated. The parameter can take one of two values: *SUM* and *AVG*. The *SUM* value of the parameter indicates that the group scores will be summed up. The *AVG* value of the parameter indicates that the average of the group scores will be calculated. Each group also has the **formula** parameter which takes the same values. The group score calculates from the field's scores. To associate fields in scoring with questions, you must specify **refCdtName** and **refCdtFieldName**.\n\nThe condition settings are divided into two parts: **elements** and **events**. The **elements** part describes how sections or questions will be displayed based on user answers. The **events** part describes which custom events will be hit based on user answers.\n\nThe collection supports several interactions\n\n1.  Allows to obtain a list of assessment\n2.  Allows to obtain a certain assessment\n3.  Allows to obtain a list of CDTs that is associated with an assessments"}],"servers":[{"url":"https://api.live.welkincloud.io","description":"Welkin Health production API"}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","description":"Bearer token obtained from `POST /{tenantName}/admin/api_clients/{clientName}`. Valid for 60 minutes."}},"parameters":{"TenantName":{"name":"tenantName","in":"path","required":true,"description":"Your organization (tenant) name, e.g. `acme-health`","schema":{"type":"string"}},"InstanceName":{"name":"instanceName","in":"path","required":true,"description":"Your environment name: `live`, `sandbox`, or a custom name","schema":{"type":"string"}}},"schemas":{"Cdt":{"type":"object","required":["name","fields"],"properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string","pattern":"^[a-z0-9\\-_]+$"},"title":{"type":"string"},"label":{"type":"string"},"version":{"type":"integer"},"internal":{"type":"boolean"},"readable":{"type":"boolean","default":true},"updatable":{"type":"boolean","default":true},"type":{"$ref":"#/components/schemas/DtType"},"relation":{"$ref":"#/components/schemas/CdtRelation"},"fields":{"type":"array","items":{"$ref":"#/components/schemas/DtField"}}}},"DtType":{"type":"string","enum":["SINGLE_RECORD","MULTI_RECORD"]},"CdtRelation":{"type":"string","enum":["COMMON","PATIENT_INFO","PATIENT","PATIENT_GOAL","ENCOUNTER","ENCOUNTER_DISPOSITION","ENCOUNTER_ASSESSMENT","ASSESSMENT","ASSESSMENT_SCORING","ASSESSMENT_CONSENT","ASSESSMENT_RESULTS_FILE","ASSESSMENT_GROUP","DOCUMENT_SUMMARY","DOCUMENT_TYPE","BILLING_CLAIMS_STATUS","INVOICE","SUPERBILL"]},"DtField":{"type":"object","required":["name","type","meta"],"properties":{"name":{"type":"string","pattern":"^[a-z0-9\\-_]+$"},"type":{"$ref":"#/components/schemas/FieldTypeEnum"},"formula":{"type":"string","nullable":true},"dictionary":{"type":"object","nullable":true,"properties":{"name":{"type":"string"},"field":{"type":"string"}}},"profileDataType":{"type":"object","nullable":true,"properties":{"name":{"type":"string"},"fields":{"type":"array","items":{"type":"string"}}}},"customDataType":{"type":"object","nullable":true,"properties":{"name":{"type":"string"},"fields":{"type":"array","items":{"type":"string"}}}},"customFieldType":{"type":"string","nullable":true},"editable":{"type":"boolean","default":true},"searchable":{"type":"boolean"},"bulkEdit":{"type":"boolean"},"phi":{"type":"boolean"},"disable":{"type":"boolean","description":"JSON key for the \"disabled\" field."},"injectedSource":{"type":"boolean"},"displayType":{"$ref":"#/components/schemas/DtFieldDisplayType"},"valueType":{"$ref":"#/components/schemas/DtFieldValueType"},"meta":{"$ref":"#/components/schemas/DtFieldMeta"},"mask":{"$ref":"#/components/schemas/FieldMask"},"richTextEnabled":{"type":"boolean"}}},"FieldTypeEnum":{"type":"string","enum":["TEXT","TEXTAREA","PASSWORD","EMAIL","INTEGER","FLOAT","PERCENT","RADIO","CHECKBOX","SELECT","CHOICE","DATE","TIME","DATETIME","FILE","IMAGE","URL","PHONE","UUID","SSN","ADDRESS","LOCATION","FORMULA","OBJECT","SIGNATURE"]},"DtFieldDisplayType":{"type":"string","enum":["CHECKBOX","RADIO","SELECT"]},"DtFieldValueType":{"type":"string","enum":["STRING","INTEGER","FLOAT","OBJECT"]},"DtFieldMeta":{"type":"object","properties":{"label":{"type":"string"},"minLength":{"type":"integer","nullable":true},"maxLength":{"type":"integer","nullable":true},"minValue":{"type":"string","nullable":true},"maxValue":{"type":"string","nullable":true},"fileTypes":{"type":"array","items":{"type":"string"}},"maxFiles":{"type":"integer","nullable":true},"maxTotalFileSize":{"type":"integer","nullable":true,"description":"Bytes"},"required":{"type":"boolean","nullable":true},"options":{"type":"array","items":{"$ref":"#/components/schemas/OptionItem"}},"multiple":{"type":"boolean","nullable":true},"patterns":{"type":"array","items":{"type":"string","enum":["NUMBERS_ONLY","LETTERS_ONLY"]}}}},"OptionItem":{"type":"object","properties":{"label":{"type":"string"},"value":{},"refCdtName":{"type":"string","nullable":true}}},"FieldMask":{"type":"object","properties":{"symbol":{"type":"string","minLength":1,"maxLength":1,"default":"*"},"startPosition":{"type":"integer","minimum":1},"endPosition":{"type":"integer","nullable":true}}}},"responses":{"BadRequest":{"description":"Bad request — the request could not be understood or was missing required parameters."},"Unauthorized":{"description":"Unauthorized — the Bearer token is missing, expired, or invalid."},"Forbidden":{"description":"Forbidden — the API client role does not have permission for this resource. Check the role and security policy in Admin."},"NotFound":{"description":"Not found — the requested resource does not exist."},"TooManyRequests":{"description":"Too many requests — rate limit exceeded. Implement exponential backoff."},"InternalError":{"description":"Internal server error."}}},"paths":{"/{tenantName}/{instanceName}/formations/current/assessments/cdts":{"get":{"summary":"Get all CDTs related to Assessment","tags":["Assessment formation"],"operationId":"Get_all_CDTs_related_to_Assessment","parameters":[{"$ref":"#/components/parameters/TenantName"},{"$ref":"#/components/parameters/InstanceName"}],"responses":{"200":{"description":"CDT formations referenced by assessments","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Cdt"}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalError"}},"description":"1.  First variable is your Tenant name. We will use **gh** as a tenant name through this set of api docs\n2.  Second variable is your Instance name. We will use **sb-demo** as an instance name through this set of api docs\n3.  Third variable is your formation version. We will use **current** to get published version and **draft** to get version in draft.\n    \n\n*   HTTP Method: GET\n*   HTTP URL: `https://api.live.welkincloud.io/gh/sb-demo/formation/current/assessments`\n*   HTTP Response Codes: 200"}}}}
```

## Get one Assessment

> A certain assessment formation would be located at the following URL\
> \
> \`URL Structure: <https://api.live.welkincloud.io/{tenantName}/{instanceName}/formation/{}/assessments/{}\\`\\>
> \
> 1\.  First variable is your Tenant name. We will use \*\*gh\*\* as a tenant name through this set of api docs\
> 2\.  Second variable is your Instance name. We will use \*\*sb-demo\*\* as an instance name through this set of api docs\
> 3\.  Third variable is your formation version. We will use \*\*current\*\* to get published version and \*\*draft\*\* to get version in draft\
> 4\.  Fourth parameter is assessment name. We will specify an assessment name which we want to get\
> &#x20;   \
> \
> Example request:\
> \
> \*   HTTP Method: GET\
> \*   HTTP URL: \`<https://api.live.welkincloud.io/gh/sb-demo/formation/current/assessments/phq\\_v1\\`\\>
> \*   HTTP Response Codes: 200, 404

```json
{"openapi":"3.0.3","info":{"title":"Welkin Health API","version":"1.0.0"},"tags":[{"name":"Assessment formation","description":"An assessment consists of 3 parts: main, scoring, condition settings.\n\nThe main part contains a list of sections. Each section contains a list of fields. The **viewType** parameter in the field indicates how the field will be displayed. The parameter can take one of two values: *readOnly* and *question*. The *readOnly* value of the parameter indicates that the field will be displayed as a text comment. The *question* value of the parameter indicates that the field will be displayed as a question with the possibility of user input. If the value of the **viewType** parameter is equal to *question* then parameters **refCdtName**, **refCdtFieldName** and **meta** are required. The combination of parameter values **refCdtName** and **refCdtFieldName** must be unique among all fields in the assessment.\n\nThe scoring part describes the rules for calculating the assessment score. The **formula** parameter indicates how the score will be calculated. The parameter can take one of two values: *SUM* and *AVG*. The *SUM* value of the parameter indicates that the group scores will be summed up. The *AVG* value of the parameter indicates that the average of the group scores will be calculated. Each group also has the **formula** parameter which takes the same values. The group score calculates from the field's scores. To associate fields in scoring with questions, you must specify **refCdtName** and **refCdtFieldName**.\n\nThe condition settings are divided into two parts: **elements** and **events**. The **elements** part describes how sections or questions will be displayed based on user answers. The **events** part describes which custom events will be hit based on user answers.\n\nThe collection supports several interactions\n\n1.  Allows to obtain a list of assessment\n2.  Allows to obtain a certain assessment\n3.  Allows to obtain a list of CDTs that is associated with an assessments"}],"servers":[{"url":"https://api.live.welkincloud.io","description":"Welkin Health production API"}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","description":"Bearer token obtained from `POST /{tenantName}/admin/api_clients/{clientName}`. Valid for 60 minutes."}},"parameters":{"TenantName":{"name":"tenantName","in":"path","required":true,"description":"Your organization (tenant) name, e.g. `acme-health`","schema":{"type":"string"}},"InstanceName":{"name":"instanceName","in":"path","required":true,"description":"Your environment name: `live`, `sandbox`, or a custom name","schema":{"type":"string"}}},"schemas":{"Assessment":{"type":"object","required":["name","sections"],"properties":{"id":{"type":"string","format":"uuid","readOnly":true},"title":{"type":"string","nullable":true},"name":{"type":"string","pattern":"^[a-z0-9\\-_]+$","maxLength":75},"version":{"type":"integer","readOnly":true},"sections":{"type":"array","items":{"$ref":"#/components/schemas/AssessmentSection"}},"scoring":{"$ref":"#/components/schemas/AssessmentScoring"},"programs":{"type":"array","items":{"$ref":"#/components/schemas/AssessmentProgramRelation"}},"_containsPHI":{"type":"boolean","readOnly":true},"displayType":{"$ref":"#/components/schemas/AssessmentDisplayType","default":"SECTIONS"},"autoCompleted":{"type":"boolean"}}},"AssessmentSection":{"type":"object","required":["name","order"],"properties":{"title":{"type":"string","nullable":true},"name":{"type":"string"},"order":{"type":"integer"},"fields":{"type":"array","items":{"$ref":"#/components/schemas/AssessmentSectionField"}}}},"AssessmentSectionField":{"type":"object","description":"Polymorphic on `viewType`: `question`/`readOnly`/`consent` fields carry `refCdtFieldName` + `meta`; `fieldGroup` fields carry a nested `fields` array instead.","properties":{"viewType":{"type":"string","enum":["question","readOnly","consent","fieldGroup"]},"label":{"type":"string","nullable":true},"name":{"type":"string","nullable":true},"refCdtName":{"type":"string","nullable":true},"order":{"type":"integer"},"refCdtFieldName":{"type":"string","nullable":true},"meta":{"type":"object","nullable":true,"properties":{"type":{"$ref":"#/components/schemas/FieldTypeEnum"},"required":{"type":"boolean","nullable":true}}},"fields":{"type":"array","nullable":true,"description":"Present only when viewType is fieldGroup.","items":{"type":"object","additionalProperties":true}}}},"FieldTypeEnum":{"type":"string","enum":["TEXT","TEXTAREA","PASSWORD","EMAIL","INTEGER","FLOAT","PERCENT","RADIO","CHECKBOX","SELECT","CHOICE","DATE","TIME","DATETIME","FILE","IMAGE","URL","PHONE","UUID","SSN","ADDRESS","LOCATION","FORMULA","OBJECT","SIGNATURE"]},"AssessmentScoring":{"type":"object","properties":{"formula":{"type":"string","enum":["SUM","AVG","SCALED_AVG"],"default":"SUM"},"groups":{"type":"array","items":{"$ref":"#/components/schemas/AssessmentScoringGroup"}}}},"AssessmentScoringGroup":{"type":"object","required":["name","title","fields"],"properties":{"name":{"type":"string"},"title":{"type":"string"},"fields":{"type":"array","items":{"$ref":"#/components/schemas/AssessmentScoringField"}},"formula":{"type":"string","enum":["SUM","AVG","SCALED_AVG"],"default":"SUM"},"scalingFactor":{"type":"number","nullable":true}}},"AssessmentScoringField":{"type":"object","properties":{"refCdtName":{"type":"string"},"refCdtFieldName":{"type":"string"},"type":{"type":"string","enum":["select"]},"scores":{"type":"array","items":{"type":"object","properties":{"answer":{},"score":{"type":"number"},"notApplicable":{"type":"boolean"}}}}}},"AssessmentProgramRelation":{"type":"object","required":["program"],"properties":{"program":{"type":"string"},"phases":{"type":"array","items":{"type":"string"}}}},"AssessmentDisplayType":{"type":"string","enum":["SECTIONS","STEPS"]}},"responses":{"BadRequest":{"description":"Bad request — the request could not be understood or was missing required parameters."},"Unauthorized":{"description":"Unauthorized — the Bearer token is missing, expired, or invalid."},"Forbidden":{"description":"Forbidden — the API client role does not have permission for this resource. Check the role and security policy in Admin."},"NotFound":{"description":"Not found — the requested resource does not exist."},"TooManyRequests":{"description":"Too many requests — rate limit exceeded. Implement exponential backoff."},"InternalError":{"description":"Internal server error."}}},"paths":{"/{tenantName}/{instanceName}/formations/current/assessments/{assessmentName}":{"get":{"summary":"Get one Assessment","tags":["Assessment formation"],"operationId":"Get_one_Assessment","parameters":[{"$ref":"#/components/parameters/TenantName"},{"$ref":"#/components/parameters/InstanceName"},{"name":"assessmentName","in":"path","required":true,"description":"Machine-readable assessment name","schema":{"type":"string"}}],"responses":{"200":{"description":"Assessment formation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Assessment"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalError"}},"description":"A certain assessment formation would be located at the following URL\n\n`URL Structure: https://api.live.welkincloud.io/{tenantName}/{instanceName}/formation/{}/assessments/{}`\n\n1.  First variable is your Tenant name. We will use **gh** as a tenant name through this set of api docs\n2.  Second variable is your Instance name. We will use **sb-demo** as an instance name through this set of api docs\n3.  Third variable is your formation version. We will use **current** to get published version and **draft** to get version in draft\n4.  Fourth parameter is assessment name. We will specify an assessment name which we want to get\n    \n\nExample request:\n\n*   HTTP Method: GET\n*   HTTP URL: `https://api.live.welkincloud.io/gh/sb-demo/formation/current/assessments/phq_v1`\n*   HTTP Response Codes: 200, 404"}}}}
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.welkinhealth.com/api-reference/assessment-formation.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.