> 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-record.md).

# Assessment Record

## Get all Assessment Records

> To get all assessment records would be used at the following URL\
> \
> \`URL Structure: <https://api.live.welkincloud.io/{tenantName}/{instanceName}/patients/{}/assessment-records\\`\\>
> \
> 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 uuid ogf the patient whose records we want to receive\
> &#x20;   \
> \
> Example request:\
> \
> \*   HTTP Method: GET\
> \*   HTTP URL: \`<https://api.live.welkincloud.io/gh/sb-demo/patients/ee66e8e8-6ce1-40d3-b6cb-e5727c5347c8/assessment-records\\`\\>
> \*   HTTP Response Codes: 200

```json
{"openapi":"3.0.3","info":{"title":"Welkin Health API","version":"1.0.0"},"tags":[{"name":"Assessment record","description":""}],"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"}},"PatientId":{"name":"patientId","in":"path","required":true,"description":"UUID of the patient record","schema":{"type":"string","format":"uuid"}}},"schemas":{"AssessmentRecordPage":{"allOf":[{"$ref":"#/components/schemas/PaginatedResponse"},{"type":"object","properties":{"content":{"type":"array","items":{"$ref":"#/components/schemas/AssessmentRecord"}}}}]},"PaginatedResponse":{"type":"object","description":"Standard paginated response wrapper.","properties":{"content":{"type":"array","items":{"type":"object"}},"pageable":{"$ref":"#/components/schemas/PageableInfo"},"totalElements":{"type":"integer","description":"Total number of matching records"},"totalPages":{"type":"integer","description":"Total number of pages"},"last":{"type":"boolean"},"first":{"type":"boolean"},"number":{"type":"integer","description":"Current page number (zero-based)"},"size":{"type":"integer","description":"Page size"},"numberOfElements":{"type":"integer","description":"Number of elements on the current page"},"empty":{"type":"boolean"},"sort":{"$ref":"#/components/schemas/SortInfo"}}},"PageableInfo":{"type":"object","properties":{"sort":{"$ref":"#/components/schemas/SortInfo"},"pageSize":{"type":"integer"},"pageNumber":{"type":"integer"},"offset":{"type":"integer"},"unpaged":{"type":"boolean"},"paged":{"type":"boolean"}}},"SortInfo":{"type":"object","properties":{"sorted":{"type":"boolean"},"unsorted":{"type":"boolean"},"empty":{"type":"boolean"}}},"AssessmentRecord":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"createdByName":{"type":"string"},"updatedByName":{"type":"string"},"finalizedDate":{"type":"string","format":"date-time","nullable":true},"assessmentName":{"type":"string"},"assessmentTitle":{"type":"string","nullable":true},"assessmentCdtName":{"type":"string","nullable":true},"version":{"type":"integer","nullable":true},"completedBy":{"type":"string","format":"uuid","nullable":true},"completedByName":{"type":"string","nullable":true},"completedVersion":{"type":"integer","nullable":true},"patientId":{"type":"string","format":"uuid"},"isPfa":{"type":"boolean","default":false},"templateExists":{"type":"boolean","default":false},"status":{"$ref":"#/components/schemas/AssessmentStatus"},"answers":{"type":"object","additionalProperties":true},"scoring":{"type":"object","additionalProperties":true},"folderId":{"type":"string","format":"uuid","nullable":true},"expirationDate":{"type":"string","format":"date-time","nullable":true},"questions":{"type":"object","additionalProperties":true},"resolvedCdtValues":{"type":"object","additionalProperties":true},"urlAliasId":{"type":"string","format":"uuid","nullable":true},"encounterId":{"type":"string","format":"uuid","nullable":true},"recompletedBy":{"type":"string","format":"uuid","nullable":true},"recompletedByName":{"type":"string","nullable":true},"recompletedAt":{"type":"string","format":"date-time","nullable":true}}},"AssessmentStatus":{"type":"string","enum":["NEW","IN_PROGRESS","SUBMITTED","PARTIALLY_COMPLETED","COMPLETED","EXPIRED"]}},"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}/patients/{patientId}/assessment-records":{"get":{"summary":"Get all Assessment Records","tags":["Assessment record"],"operationId":"Get_all_Assessment_Records","parameters":[{"$ref":"#/components/parameters/TenantName"},{"$ref":"#/components/parameters/InstanceName"},{"$ref":"#/components/parameters/PatientId"},{"name":"statuses","in":"query","required":false,"schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"Paginated assessment records","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AssessmentRecordPage"}}}},"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":"To get all assessment records would be used at the following URL\n\n`URL Structure: https://api.live.welkincloud.io/{tenantName}/{instanceName}/patients/{}/assessment-records`\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 uuid ogf the patient whose records we want to receive\n    \n\nExample request:\n\n*   HTTP Method: GET\n*   HTTP URL: `https://api.live.welkincloud.io/gh/sb-demo/patients/ee66e8e8-6ce1-40d3-b6cb-e5727c5347c8/assessment-records`\n*   HTTP Response Codes: 200"}}}}
```

## Create an Assessment Record

> To create an assessment record would be used at the following URL\
> \
> \`URL Structure: <https://api.live.welkincloud.io/{tenantName}/{instanceName}/patients/{}/assessment-records\\`\\>
> \
> 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 uuid of the patient for whom we want to create the record\
> &#x20;   \
> \
> \*\*\*NOTE\*\*\*\
> \
> \*You cannot save answers through this URL, to save answers see\* \*Update answers of assessment record\*\
> \
> Example request:\
> \
> \*   HTTP Method: POST\
> \*   \[HTTP URL: \`<https://api.live.welkincloud.io/gh/sb-demo/patients/ee66e8e8-6ce1-40d3-b6cb-e5727c5347c8/assessments-records/some-uuid\\`]\\(https://api.live.welkincloud.io/gh/sb-demo/patients/ee66e8e8-6ce1-40d3-b6cb-e5727c5347c8/assessments-records/some-uuid)\\>
> \*   HTTP Response Codes: 200, 404

```json
{"openapi":"3.0.3","info":{"title":"Welkin Health API","version":"1.0.0"},"tags":[{"name":"Assessment record","description":""}],"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"}},"PatientId":{"name":"patientId","in":"path","required":true,"description":"UUID of the patient record","schema":{"type":"string","format":"uuid"}}},"schemas":{"AssessmentRecord":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"createdByName":{"type":"string"},"updatedByName":{"type":"string"},"finalizedDate":{"type":"string","format":"date-time","nullable":true},"assessmentName":{"type":"string"},"assessmentTitle":{"type":"string","nullable":true},"assessmentCdtName":{"type":"string","nullable":true},"version":{"type":"integer","nullable":true},"completedBy":{"type":"string","format":"uuid","nullable":true},"completedByName":{"type":"string","nullable":true},"completedVersion":{"type":"integer","nullable":true},"patientId":{"type":"string","format":"uuid"},"isPfa":{"type":"boolean","default":false},"templateExists":{"type":"boolean","default":false},"status":{"$ref":"#/components/schemas/AssessmentStatus"},"answers":{"type":"object","additionalProperties":true},"scoring":{"type":"object","additionalProperties":true},"folderId":{"type":"string","format":"uuid","nullable":true},"expirationDate":{"type":"string","format":"date-time","nullable":true},"questions":{"type":"object","additionalProperties":true},"resolvedCdtValues":{"type":"object","additionalProperties":true},"urlAliasId":{"type":"string","format":"uuid","nullable":true},"encounterId":{"type":"string","format":"uuid","nullable":true},"recompletedBy":{"type":"string","format":"uuid","nullable":true},"recompletedByName":{"type":"string","nullable":true},"recompletedAt":{"type":"string","format":"date-time","nullable":true}}},"AssessmentStatus":{"type":"string","enum":["NEW","IN_PROGRESS","SUBMITTED","PARTIALLY_COMPLETED","COMPLETED","EXPIRED"]},"AssessmentRecordRequest":{"type":"object","required":["assessmentName"],"properties":{"assessmentName":{"type":"string"},"assessmentTitle":{"type":"string","nullable":true},"patientId":{"type":"string","format":"uuid"},"isPfa":{"type":"boolean","default":false},"status":{"$ref":"#/components/schemas/AssessmentStatus"},"answers":{"type":"object","additionalProperties":true},"scoring":{"type":"object","additionalProperties":true},"folderId":{"type":"string","format":"uuid","nullable":true},"expirationDate":{"type":"string","format":"date-time","nullable":true},"encounterId":{"type":"string","format":"uuid","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}/patients/{patientId}/assessment-records":{"post":{"summary":"Create an Assessment Record","tags":["Assessment record"],"operationId":"Create_an_Assessment_Record","parameters":[{"$ref":"#/components/parameters/TenantName"},{"$ref":"#/components/parameters/InstanceName"},{"$ref":"#/components/parameters/PatientId"}],"responses":{"201":{"description":"Created assessment record","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AssessmentRecord"}}}},"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":"To create an assessment record would be used at the following URL\n\n`URL Structure: https://api.live.welkincloud.io/{tenantName}/{instanceName}/patients/{}/assessment-records`\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 uuid of the patient for whom we want to create the record\n    \n\n***NOTE***\n\n*You cannot save answers through this URL, to save answers see* *Update answers of assessment record*\n\nExample request:\n\n*   HTTP Method: POST\n*   [HTTP URL: `https://api.live.welkincloud.io/gh/sb-demo/patients/ee66e8e8-6ce1-40d3-b6cb-e5727c5347c8/assessments-records/some-uuid`](https://api.live.welkincloud.io/gh/sb-demo/patients/ee66e8e8-6ce1-40d3-b6cb-e5727c5347c8/assessments-records/some-uuid)\n*   HTTP Response Codes: 200, 404","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AssessmentRecordRequest"}}}}}}}}
```

## Get an Assessment Record

> To get an assessment record would be used at the following URL\
> \
> \`URL Structure: <https://api.live.welkincloud.io/{tenantName}/{instanceName}/patients/{}/assessment-records/{}\\`\\>
> \
> 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 uuid of the patient whose records we want to receive\
> 4\.  Fourth variable is uuid of the records which we want to receive\
> &#x20;   \
> \
> Example request:\
> \
> \*   HTTP Method: GET\
> \*   HTTP URL: \`<https://api.live.welkincloud.io/gh/sb-demo/patients/ee66e8e8-6ce1-40d3-b6cb-e5727c5347c8/assessments-records/some-uuid\\`\\>
> \*   HTTP Response Codes: 200, 404

```json
{"openapi":"3.0.3","info":{"title":"Welkin Health API","version":"1.0.0"},"tags":[{"name":"Assessment record","description":""}],"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"}},"PatientId":{"name":"patientId","in":"path","required":true,"description":"UUID of the patient record","schema":{"type":"string","format":"uuid"}}},"schemas":{"AssessmentRecord":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"createdByName":{"type":"string"},"updatedByName":{"type":"string"},"finalizedDate":{"type":"string","format":"date-time","nullable":true},"assessmentName":{"type":"string"},"assessmentTitle":{"type":"string","nullable":true},"assessmentCdtName":{"type":"string","nullable":true},"version":{"type":"integer","nullable":true},"completedBy":{"type":"string","format":"uuid","nullable":true},"completedByName":{"type":"string","nullable":true},"completedVersion":{"type":"integer","nullable":true},"patientId":{"type":"string","format":"uuid"},"isPfa":{"type":"boolean","default":false},"templateExists":{"type":"boolean","default":false},"status":{"$ref":"#/components/schemas/AssessmentStatus"},"answers":{"type":"object","additionalProperties":true},"scoring":{"type":"object","additionalProperties":true},"folderId":{"type":"string","format":"uuid","nullable":true},"expirationDate":{"type":"string","format":"date-time","nullable":true},"questions":{"type":"object","additionalProperties":true},"resolvedCdtValues":{"type":"object","additionalProperties":true},"urlAliasId":{"type":"string","format":"uuid","nullable":true},"encounterId":{"type":"string","format":"uuid","nullable":true},"recompletedBy":{"type":"string","format":"uuid","nullable":true},"recompletedByName":{"type":"string","nullable":true},"recompletedAt":{"type":"string","format":"date-time","nullable":true}}},"AssessmentStatus":{"type":"string","enum":["NEW","IN_PROGRESS","SUBMITTED","PARTIALLY_COMPLETED","COMPLETED","EXPIRED"]}},"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}/patients/{patientId}/assessment-records/{assessmentRecordId}":{"get":{"summary":"Get an Assessment Record","tags":["Assessment record"],"operationId":"Get_an_Assessment_Record","parameters":[{"$ref":"#/components/parameters/TenantName"},{"$ref":"#/components/parameters/InstanceName"},{"$ref":"#/components/parameters/PatientId"},{"name":"assessmentRecordId","in":"path","required":true,"description":"`assessmentRecordId` path parameter","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Assessment record","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AssessmentRecord"}}}},"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":"To get an assessment record would be used at the following URL\n\n`URL Structure: https://api.live.welkincloud.io/{tenantName}/{instanceName}/patients/{}/assessment-records/{}`\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 uuid of the patient whose records we want to receive\n4.  Fourth variable is uuid of the records which we want to receive\n    \n\nExample request:\n\n*   HTTP Method: GET\n*   HTTP URL: `https://api.live.welkincloud.io/gh/sb-demo/patients/ee66e8e8-6ce1-40d3-b6cb-e5727c5347c8/assessments-records/some-uuid`\n*   HTTP Response Codes: 200, 404"}}}}
```

## Update an Assessment Record

> To update an assessment record would be used at the following URL\
> \
> \`URL Structure: <https://api.live.welkincloud.io/{tenantName}/{instanceName}/patients/{}/assessment-records/{}\\`\\>
> \
> 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 uuid of the patient for whom we want to update the record\
> 4\.  Fourth variable is uuid of record which we want to update\
> &#x20;   \
> \
> \*\*\*NOTE\*\*\*\
> \
> \*You cannot save answers through this URL, to save answers see\* \*Update answers of assessment record\*\
> \
> Example request:\
> \
> \*   HTTP Method: PUT\
> \*   HTTP URL: \`<https://api.live.welkincloud.io/gh/sb-demo/patients/ee66e8e8-6ce1-40d3-b6cb-e5727c5347c8/assessments-records/some-uuid\\`\\>
> \*   HTTP Response Codes: 200, 404

```json
{"openapi":"3.0.3","info":{"title":"Welkin Health API","version":"1.0.0"},"tags":[{"name":"Assessment record","description":""}],"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"}},"PatientId":{"name":"patientId","in":"path","required":true,"description":"UUID of the patient record","schema":{"type":"string","format":"uuid"}}},"schemas":{"AssessmentRecord":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"createdByName":{"type":"string"},"updatedByName":{"type":"string"},"finalizedDate":{"type":"string","format":"date-time","nullable":true},"assessmentName":{"type":"string"},"assessmentTitle":{"type":"string","nullable":true},"assessmentCdtName":{"type":"string","nullable":true},"version":{"type":"integer","nullable":true},"completedBy":{"type":"string","format":"uuid","nullable":true},"completedByName":{"type":"string","nullable":true},"completedVersion":{"type":"integer","nullable":true},"patientId":{"type":"string","format":"uuid"},"isPfa":{"type":"boolean","default":false},"templateExists":{"type":"boolean","default":false},"status":{"$ref":"#/components/schemas/AssessmentStatus"},"answers":{"type":"object","additionalProperties":true},"scoring":{"type":"object","additionalProperties":true},"folderId":{"type":"string","format":"uuid","nullable":true},"expirationDate":{"type":"string","format":"date-time","nullable":true},"questions":{"type":"object","additionalProperties":true},"resolvedCdtValues":{"type":"object","additionalProperties":true},"urlAliasId":{"type":"string","format":"uuid","nullable":true},"encounterId":{"type":"string","format":"uuid","nullable":true},"recompletedBy":{"type":"string","format":"uuid","nullable":true},"recompletedByName":{"type":"string","nullable":true},"recompletedAt":{"type":"string","format":"date-time","nullable":true}}},"AssessmentStatus":{"type":"string","enum":["NEW","IN_PROGRESS","SUBMITTED","PARTIALLY_COMPLETED","COMPLETED","EXPIRED"]},"AssessmentRecordRequest":{"type":"object","required":["assessmentName"],"properties":{"assessmentName":{"type":"string"},"assessmentTitle":{"type":"string","nullable":true},"patientId":{"type":"string","format":"uuid"},"isPfa":{"type":"boolean","default":false},"status":{"$ref":"#/components/schemas/AssessmentStatus"},"answers":{"type":"object","additionalProperties":true},"scoring":{"type":"object","additionalProperties":true},"folderId":{"type":"string","format":"uuid","nullable":true},"expirationDate":{"type":"string","format":"date-time","nullable":true},"encounterId":{"type":"string","format":"uuid","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}/patients/{patientId}/assessment-records/{assessmentRecordId}":{"put":{"summary":"Update an Assessment Record","tags":["Assessment record"],"operationId":"Update_an_Assessment_Record","parameters":[{"$ref":"#/components/parameters/TenantName"},{"$ref":"#/components/parameters/InstanceName"},{"$ref":"#/components/parameters/PatientId"},{"name":"assessmentRecordId","in":"path","required":true,"description":"`assessmentRecordId` path parameter","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Updated assessment record","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AssessmentRecord"}}}},"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":"To update an assessment record would be used at the following URL\n\n`URL Structure: https://api.live.welkincloud.io/{tenantName}/{instanceName}/patients/{}/assessment-records/{}`\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 uuid of the patient for whom we want to update the record\n4.  Fourth variable is uuid of record which we want to update\n    \n\n***NOTE***\n\n*You cannot save answers through this URL, to save answers see* *Update answers of assessment record*\n\nExample request:\n\n*   HTTP Method: PUT\n*   HTTP URL: `https://api.live.welkincloud.io/gh/sb-demo/patients/ee66e8e8-6ce1-40d3-b6cb-e5727c5347c8/assessments-records/some-uuid`\n*   HTTP Response Codes: 200, 404","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AssessmentRecordRequest"}}}}}}}}
```

## Delete an Assessment Record

> To delete an assessment record would be used at the following URL\
> \
> \`URL Structure: <https://api.live.welkincloud.io/{tenantName}/{instanceName}/patients/{}/assessment-records/{}\\`\\>
> \
> 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 uuid of the patient for whom we want to update the record\
> 4\.  Fourth variable is uuid of record which we want to delete\
> &#x20;   \
> \
> Example request:\
> \
> \*   HTTP Method: DELETE\
> \*   HTTP URL: \`<https://api.live.welkincloud.io/gh/sb-demo/patients/ee66e8e8-6ce1-40d3-b6cb-e5727c5347c8/assessments-records/some-uuid\\`\\>
> \*   HTTP Response Codes: 200, 404

```json
{"openapi":"3.0.3","info":{"title":"Welkin Health API","version":"1.0.0"},"tags":[{"name":"Assessment record","description":""}],"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"}},"PatientId":{"name":"patientId","in":"path","required":true,"description":"UUID of the patient record","schema":{"type":"string","format":"uuid"}}},"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}/patients/{patientId}/assessment-records/{assessmentRecordId}":{"delete":{"summary":"Delete an Assessment Record","tags":["Assessment record"],"operationId":"Delete_an_Assessment_Record","parameters":[{"$ref":"#/components/parameters/TenantName"},{"$ref":"#/components/parameters/InstanceName"},{"$ref":"#/components/parameters/PatientId"},{"name":"assessmentRecordId","in":"path","required":true,"description":"`assessmentRecordId` path parameter","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Assessment record deleted"},"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":"To delete an assessment record would be used at the following URL\n\n`URL Structure: https://api.live.welkincloud.io/{tenantName}/{instanceName}/patients/{}/assessment-records/{}`\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 uuid of the patient for whom we want to update the record\n4.  Fourth variable is uuid of record which we want to delete\n    \n\nExample request:\n\n*   HTTP Method: DELETE\n*   HTTP URL: `https://api.live.welkincloud.io/gh/sb-demo/patients/ee66e8e8-6ce1-40d3-b6cb-e5727c5347c8/assessments-records/some-uuid`\n*   HTTP Response Codes: 200, 404"}}}}
```

## Update answers of Assessment Record

> To update answers of assessment record would be used at the following URL\
> \
> \`URL Structure: <https://api.live.welkincloud.io/{tenantName}/{instanceName}/patients/{}/assessment-records/{}/answers\\`\\>
> \
> 1\. First variable is your Tenant name. We will use \*\*gh\*\* as a tenant name through this set of api docs\
> &#x20;   \
> 2\. Second variable is your Instance name. We will use \*\*sb-demo\*\* as an instance name through this set of api docs\
> &#x20;   \
> 3\. Third variable is uuid of the patient for whom we want to update the record\
> &#x20;   \
> 4\. Fourth variable is uuid of record whose answers we want to update\
> &#x20;   \
> \
> Example request:\
> \
> \- HTTP Method: PUT\
> &#x20;   \
> \- HTTP URL: \`<https://api.live.welkincloud.io/gh/sb-demo/patients/ee66e8e8-6ce1-40d3-b6cb-e5727c5347c8/assessments-records/some-uuid/answers\\`\\>
> &#x20;   \
> \- HTTP Response Codes: 200, 404\
> &#x20;   \
> \
> \*\*Input examples for fields:\*\*\
> \
> \- String:  \
> &#x20;   "cdt-test\_\_cdtf-test-field": "value"\
> &#x20;   \
> \- List with multiple checkbox:  \
> &#x20;   "cdt-test\_\_cdtf-test-field": \\\["value1", "value2"\\]

```json
{"openapi":"3.0.3","info":{"title":"Welkin Health API","version":"1.0.0"},"tags":[{"name":"Assessment record","description":""}],"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"}},"PatientId":{"name":"patientId","in":"path","required":true,"description":"UUID of the patient record","schema":{"type":"string","format":"uuid"}}},"schemas":{"AssessmentRecord":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"createdByName":{"type":"string"},"updatedByName":{"type":"string"},"finalizedDate":{"type":"string","format":"date-time","nullable":true},"assessmentName":{"type":"string"},"assessmentTitle":{"type":"string","nullable":true},"assessmentCdtName":{"type":"string","nullable":true},"version":{"type":"integer","nullable":true},"completedBy":{"type":"string","format":"uuid","nullable":true},"completedByName":{"type":"string","nullable":true},"completedVersion":{"type":"integer","nullable":true},"patientId":{"type":"string","format":"uuid"},"isPfa":{"type":"boolean","default":false},"templateExists":{"type":"boolean","default":false},"status":{"$ref":"#/components/schemas/AssessmentStatus"},"answers":{"type":"object","additionalProperties":true},"scoring":{"type":"object","additionalProperties":true},"folderId":{"type":"string","format":"uuid","nullable":true},"expirationDate":{"type":"string","format":"date-time","nullable":true},"questions":{"type":"object","additionalProperties":true},"resolvedCdtValues":{"type":"object","additionalProperties":true},"urlAliasId":{"type":"string","format":"uuid","nullable":true},"encounterId":{"type":"string","format":"uuid","nullable":true},"recompletedBy":{"type":"string","format":"uuid","nullable":true},"recompletedByName":{"type":"string","nullable":true},"recompletedAt":{"type":"string","format":"date-time","nullable":true}}},"AssessmentStatus":{"type":"string","enum":["NEW","IN_PROGRESS","SUBMITTED","PARTIALLY_COMPLETED","COMPLETED","EXPIRED"]}},"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}/patients/{patientId}/assessment-records/{assessmentRecordId}/answers":{"put":{"summary":"Update answers of Assessment Record","tags":["Assessment record"],"operationId":"Update_answers_of_Assessment_Record","parameters":[{"$ref":"#/components/parameters/TenantName"},{"$ref":"#/components/parameters/InstanceName"},{"$ref":"#/components/parameters/PatientId"},{"name":"assessmentRecordId","in":"path","required":true,"description":"`assessmentRecordId` path parameter","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Updated assessment record","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AssessmentRecord"}}}},"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":"To update answers of assessment record would be used at the following URL\n\n`URL Structure: https://api.live.welkincloud.io/{tenantName}/{instanceName}/patients/{}/assessment-records/{}/answers`\n\n1. First variable is your Tenant name. We will use **gh** as a tenant name through this set of api docs\n    \n2. Second variable is your Instance name. We will use **sb-demo** as an instance name through this set of api docs\n    \n3. Third variable is uuid of the patient for whom we want to update the record\n    \n4. Fourth variable is uuid of record whose answers we want to update\n    \n\nExample request:\n\n- HTTP Method: PUT\n    \n- HTTP URL: `https://api.live.welkincloud.io/gh/sb-demo/patients/ee66e8e8-6ce1-40d3-b6cb-e5727c5347c8/assessments-records/some-uuid/answers`\n    \n- HTTP Response Codes: 200, 404\n    \n\n**Input examples for fields:**\n\n- String:  \n    \"cdt-test__cdtf-test-field\": \"value\"\n    \n- List with multiple checkbox:  \n    \"cdt-test__cdtf-test-field\": \\[\"value1\", \"value2\"\\]","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"description":"Answer values keyed by CDT field name — shape is dynamic, driven by the assessment formation."}}}}}}}}
```

## Generate results file

> Request to generate a file based on a template added to the assessment

```json
{"openapi":"3.0.3","info":{"title":"Welkin Health API","version":"1.0.0"},"tags":[{"name":"Assessment record","description":""}],"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"}},"PatientId":{"name":"patientId","in":"path","required":true,"description":"UUID of the patient record","schema":{"type":"string","format":"uuid"}}},"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}/patients/{patientId}/assessment-records/{assessmentRecordId}/results-file":{"post":{"summary":"Generate results file","tags":["Assessment record"],"operationId":"Generate_results_file","parameters":[{"$ref":"#/components/parameters/TenantName"},{"$ref":"#/components/parameters/InstanceName"},{"$ref":"#/components/parameters/PatientId"},{"name":"assessmentRecordId","in":"path","required":true,"description":"`assessmentRecordId` path parameter","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Results file generated (no response body; check the X-Unresolved-Variables header)"},"201":{"description":"Success"},"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":"Request to generate a file based on a template added to the assessment"}}}}
```


---

# 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-record.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.