A care assessment of a service user's suitability for a location or service either in-person or via a virtual format (such video call).
A unique Id for the assessment.
The date/time the assessment was anonymized (if anonymized).
The type of assessment booked; in_person, virtual.
The name of the person performing the assessment
The user the assessment is assigned to.
The date/time the assessment was cancelled (if cancelled).
The Id of the care enquiry this assessment has been booked for.
The date/time the assessment was assessment (if completed).
The date/time the assessment was created.
The date/time of the assessment.
The Id of the location the service user is being assessed for.
The date/time the assessment was modified.
Notes regarding the assessment.
Details of any other persons that will be attending the assessment.
The outcome of the assessment; Able to support needs, Not able to support needs.
Notes about the outcome.
The address where the assessment is taking place (if in person).
Address line 1 (e.g. house name/number).
Address line 2 (e.g. street).
Town, city or village.
County.
Postal code.
Country.
{
"_id": "6724fbca4f73a2cebf63857e",
"anonymized": null,
"assessment_type": "in_person",
"assessor": "Jane",
"assigned_to": "6724fbc74f73a2cebf637806",
"cancelled": null,
"care_enquiry": "6724fbca4f73a2cebf638579",
"completed": null,
"created": "2024-11-01 16:03:22",
"date_time": "2024-11-14 14:30:00",
"location": "6724fbc74f73a2cebf6377fa",
"modified": "2024-11-01 16:03:22",
"notes": "",
"other_persons_attending": "",
"outcome": null,
"outcome_notes": null,
"street_address": {
"address_1": "12 Picket Post Close",
"address_2": "",
"country": "",
"county": "Berkshire",
"postcode": "RG12 9FG",
"town": "Bracknell"
}
}
Return a list of assessments booked for care seekers.
['_id']
A list of attributes to include for fetched objects.
unset
A filter that allows assessments to be filtered by whether the assessment is anonymized.
A filter that allows assessments to be filtered by a list of assessment types.
A filter that accepts a list of user Ids and filters assessments by the user they are assigned.
unset
A filter that allows assessments to be filtered by whether the assessment is cancelled.
A filter that accepts a list of care enquiry Ids and filters assessments by the enquiry the assessment has been booked for.
unset
A filter that allows assessments to be filtered by whether the assessment is completed.
A filter that accepts a date and filters assessments to those booked before or on the end date.
A filter that accepts a list of Ids and filters the items returned to those with an Id in the list.
A filter that accepts a list of location Ids and filters assessments by the location they are to.
A filter that accepts a date/time and filters the items returned to those modified after the date/time.
A filter that accepts a date/time and filters the items returned to those modified before the date/time.
A filter that allows assessments to be filtered by outcome.
A case insensitive keyword filter applied to the following fields; notes.
A filter that accepts a date and filters assessments to those booked after or on the start date.
1
The page number to fetch.
10
The number of items to return per page.
_id
A list of fields the returned items can be sorted by. Fields prefixed with minus (-) sign are sorted in descending order.
Returns a page of assessments.
var assessments = apiClient.Request(
HttpMethod.Get,
"assessments",
new MultiValueDict()
.Add("attributes", "care_enquiry", "date_time", "host", "notes")
.Add("filters-cancelled", "no")
.Add("filters-completed", "no")
);
<?php
$assessments = $api_client->request(
'GET',
'assessments',
[
'attributes'=>['care_enquiry', 'date_time', 'host', 'notes'],
'filters-cancelled'=>'no',
'filters-completed'=>'no'
]
);
assessments = api_client(
'GET',
'assessments',
params={
'attributes': ['care_enquiry', 'date_time', 'host', 'notes'],
'filters-cancelled': 'no',
'filters-completed': 'no'
}
)
assessments = api_client.request(
'GET',
'assessments',
params: {
'attributes' => ['care_enquiry', 'date_time', 'host', 'notes'],
'filters-cancelled' => 'no',
'filters-completed' => 'no'
}
)
{
"item_count": 5,
"items": [
{
"_id": "6724fbc94f73a2cebf6381e2",
"care_enquiry": "6724fbc94f73a2cebf6381dd",
"date_time": "2023-01-12 09:24:00",
"notes": ""
},
{
"_id": "6724fbc94f73a2cebf6382fe",
"care_enquiry": "6724fbc94f73a2cebf6382f9",
"date_time": "2023-07-06 16:31:00",
"notes": ""
},
{
"_id": "6724fbc94f73a2cebf63837e",
"care_enquiry": "6724fbc94f73a2cebf638379",
"date_time": "2023-09-15 13:45:00",
"notes": ""
},
{
"_id": "6724fbca4f73a2cebf6383ec",
"care_enquiry": "6724fbca4f73a2cebf6383e7",
"date_time": "2023-12-23 15:59:00",
"notes": ""
},
{
"_id": "6724fbca4f73a2cebf63857e",
"care_enquiry": "6724fbca4f73a2cebf638579",
"date_time": "2024-11-14 14:30:00",
"notes": ""
}
],
"page": 1,
"page_count": 1,
"per_page": 10
}
var assessment = apiClient.Request(
HttpMethod.Get,
$"assessments/{assessmentId}"
);
<?php
$assessment = $api_client->request(
'GET',
'assessments/' . $assessment_id
);
assessment = api_client('GET', f'assessments/{assessment_id}')
assessment = api_client.request('GET', "assessments/#{assessment_id}")
{
"_id": "6724fbca4f73a2cebf63857e",
"anonymized": null,
"assessment_type": "in_person",
"assessor": "Jane",
"assigned_to": "6724fbc74f73a2cebf637806",
"cancelled": null,
"care_enquiry": "6724fbca4f73a2cebf638579",
"completed": null,
"created": "2024-11-01 16:03:22",
"date_time": "2024-11-14 14:30:00",
"location": "6724fbc74f73a2cebf6377fa",
"modified": "2024-11-01 16:03:22",
"notes": "",
"other_persons_attending": "",
"outcome": null,
"outcome_notes": null,
"street_address": {
"address_1": "12 Picket Post Close",
"address_2": "",
"country": "",
"county": "Berkshire",
"postcode": "RG12 9FG",
"town": "Bracknell"
}
}