Room rate types

Room rate types describe the types of rate that can be set for rooms.

The room rate types object

Attributes

  • _id
    string

    A unique Id for the room rate type.

  • code
    string

    A unique short code for the room rate (e.g. PN).

  • created
    string

    The date/time the room rate type was created.

  • duration_types
    string

    A list of duration types the room rate includes; |(permanent|respite)

  • exclude_from_averages
    boolean

    Flag indiciating if the this room rate should be excluded when calculating average weekly room rates (only applicable to weekly rates).

  • funding_types
    list of strings

    A list of the funding types the room rate includes; private, local_authority, local_authority_top_up, chc, chc_lifestyle, block_bed, dta_spot.

  • modified
    string

    The date/time the room rate type was modified.

  • name
    string

    A unique name for the room rate (e.g. Private nursing).

  • position
    integer

    The position of the room rate relevant to other room rates when presented.

  • quoted_rate
    boolean

    A flag indicating if the rate can be quoted to care seekers.

  • rate_period
    string

    The period the room rate covers;daily, weekly.

  • types_of_care
    list of strings

    A list of the type of care the room rate covers; bariatric_care, learning_disability_care, residential, residential_dementia, nursing, nursing_dementia, specialist_care.

The room rate types object
{
    "_id": "66bfb4bc9ab4e3d6eb73493a",
    "code": "P/R",
    "created": "2024-08-16 20:21:16",
    "duration_types": [
        "permanent",
        "respite"
    ],
    "exclude_from_averages": false,
    "funding_types": [
        "private"
    ],
    "modified": "2024-08-16 20:21:16",
    "name": "Private residential",
    "position": 1,
    "quoted_rate": true,
    "rate_period": "weekly",
    "types_of_care": [
        "residential"
    ]
}

List all room rate types

Return a list of room rate types setup for your account on CareHQ.

Parameters

  • attributes
    optional
    default ['_id']

    A list of attributes to include for fetched objects.

  • filters-ids
    optional

    A filter that accepts a list of Ids and filters the items returned to those with an Id in the list.

  • filters-modified_after
    optional

    A filter that accepts a date/time and filters the items returned to those modified after the date/time.

  • filters-modified_before
    optional

    A filter that accepts a date/time and filters the items returned to those modified before the date/time.

  • filters-q
    optional

    A case insensitive keyword filter applied to the following fields; name, code.

  • page
    optional
    default 1

    The page number to fetch.

  • per_page
    optional
    default 10

    The number of items to return per page.

  • sort_by
    optional
    default _id

    A list of fields the returned items can be sorted by. Fields prefixed with minus (-) sign are sorted in descending order.

    • _id
    • created
    • modified
    • name
    • position

Response

Returns a page of room rate type.

GET
/v1/room-rate-types
var roomRateTypes = apiClient.Request(
    HttpMethod.Get,
    "room-rate-types",
    new MultiValueDict()
        .Add(
            "attributes", 
            "funding_types", 
            "name", 
            "rate_period", 
            "types_of_care"
        )
);
<?php

$room_rate_types = $api_client->request(
    'GET',
    'room-rate-types',
    [
        'attributes'=>[
            'funding_types',
            'name',
            'rate_period',
            'types_of_care'
        ]
    ]
);
room_rate_types = api_client(
    'GET',
    'room-rate-types',
    params={
        'attributes': [
            'funding_types',
            'name',
            'rate_period',
            'types_of_care'
        ]
    }
)
room_rate_types = api_client.request(
    'GET',
    'room-rate-types',
    params: {
        'attributes' => [
            'funding_types',
            'name',
            'rate_period',
            'types_of_care'
        ]
    }
)
Response
{
    "item_count": 6,
    "items": [
        {
            "_id": "66bfb4bc9ab4e3d6eb734930",
            "funding_types": [
                "local_authority",
                "local_authority_top_up",
                "chc",
                "chc_lifestyle",
                "block_bed",
                "dta_spot"
            ],
            "name": "Funded dementia",
            "rate_period": "weekly",
            "types_of_care": [
                "residential_dementia",
                "nursing_dementia"
            ]
        },
        {
            "_id": "66bfb4bc9ab4e3d6eb734932",
            "funding_types": [
                "local_authority",
                "local_authority_top_up",
                "chc",
                "chc_lifestyle",
                "block_bed",
                "dta_spot"
            ],
            "name": "Funded nursing",
            "rate_period": "weekly",
            "types_of_care": [
                "nursing"
            ]
        },
        {
            "_id": "66bfb4bc9ab4e3d6eb734934",
            "funding_types": [
                "local_authority",
                "local_authority_top_up",
                "chc",
                "chc_lifestyle",
                "block_bed",
                "dta_spot"
            ],
            "name": "Funded residential",
            "rate_period": "weekly",
            "types_of_care": [
                "residential"
            ]
        },
        {
            "_id": "66bfb4bc9ab4e3d6eb734936",
            "funding_types": [
                "private"
            ],
            "name": "Private dementia",
            "rate_period": "weekly",
            "types_of_care": [
                "residential_dementia",
                "nursing_dementia"
            ]
        },
        {
            "_id": "66bfb4bc9ab4e3d6eb734938",
            "funding_types": [
                "private"
            ],
            "name": "Private nursing",
            "rate_period": "weekly",
            "types_of_care": [
                "nursing"
            ]
        },
        {
            "_id": "66bfb4bc9ab4e3d6eb73493a",
            "funding_types": [
                "private"
            ],
            "name": "Private residential",
            "rate_period": "weekly",
            "types_of_care": [
                "residential"
            ]
        }
    ],
    "page": 1,
    "page_count": 1,
    "per_page": 10
}

Retrieve a room rate type

Retrieve a room rate type object.

Response

Returns a room rate type object.

GET
/v1/room-rate-types/<room_rate_type_id>
var roomRateType = apiClient.Request(
    HttpMethod.Get,
    $"room-rate-types/{roomRateTypeId}"
);
<?php

$room_rate_type = $api_client->request(
    'GET',
    'room-rate-types/' . $room_rate_type_id
);
room_rate_type = api_client('GET', f'room-rate-types/{room_rate_type_id}')
room_rate_type = api_client.request(
    'GET',
    "room-rate-types/#{room_rate_type_id}"
)
Response
{
    "_id": "66bfb4bc9ab4e3d6eb73493a",
    "code": "P/R",
    "created": "2024-08-16 20:21:16",
    "duration_types": [
        "permanent",
        "respite"
    ],
    "exclude_from_averages": false,
    "funding_types": [
        "private"
    ],
    "modified": "2024-08-16 20:21:16",
    "name": "Private residential",
    "position": 1,
    "quoted_rate": true,
    "rate_period": "weekly",
    "types_of_care": [
        "residential"
    ]
}