GET api/v1/patients/{id}/careServices?activeOnDate={activeOnDate}&domain={domain}&key={key}&provider_unit={provider_unit}&roles={roles}&careserviceLevel={careserviceLevel}&allowEmpty={allowEmpty}

Patient's care services

Request Information

URI Parameters

NameDescriptionTypeAdditional information
id

The social security number (DDMMYYXXXXX, e.g. 11118793456) or internal Id

 string

Required
activeOnDate

A date in which the patients care service must be active

 string

Required
domain

The domain ID. This is the name of the municipality's meta domain that the API is reading writing data to.

 string

Required
key

The API license key.

 string

Required
provider_unit

Not in use

 string

None.
roles

Not in use

 string

None.
careserviceLevel

If specified, returns only services registered on this level. Wildcard searches with % is allowed. Example: %, %.1, 1.%, 1.%.3.4.5, %.1.2.3, etc

 string

None.
allowEmpty

If true, HTTP status 200 an empty list is returned, if there are no services to return. If false or omitted, a 404 is returned instead. (New in 8.12.9)

 boolean

Default value is False

Body Parameters

None.

Response Information

Resource Description

Patient's care services

PatientServicesResponse
NameDescriptionTypeAdditional information
Careservices

A list of careservices

 Collection of PatientCareservice

None.

Response Formats

application/json, text/json

Sample: 
{
  "Careservices": [
    {
      "CareserviceId": "17776",
      "PlannedAction": "15",
      "PlannedActionName": "Hjemmesykepleie",
      "StartDate": "2024-11-22T20:23:16.9679425+01:00",
      "EndDate": "2025-11-22T19:23:16.9679425+01:00",
      "GeographicalLevels": {
        "1": "Test kommune",
        "1.1": "Hjemmeboende",
        "1.1.1": "Ytre distrikt"
      },
      "CareserviceProviderId": "0"
    },
    {
      "CareserviceId": "17776",
      "PlannedAction": "15.1.1",
      "PlannedActionName": "Stell",
      "StartDate": "2024-11-22T20:23:16.9679425+01:00",
      "EndDate": "0001-01-01T00:00:00",
      "GeographicalLevels": {
        "1": "Test kommune",
        "1.1": "Hjemmeboende",
        "1.1.1": "Ytre distrikt"
      },
      "CareserviceProviderId": "0"
    },
    {
      "CareserviceId": "17776",
      "PlannedAction": "15.1.6",
      "PlannedActionName": "Forflytning",
      "StartDate": "2024-11-22T20:23:16.9679425+01:00",
      "EndDate": "2025-11-22T19:23:16.9679425+01:00",
      "GeographicalLevels": {
        "1": "Test kommune",
        "1.1": "Hjemmeboende",
        "1.1.1": "Ytre distrikt"
      },
      "CareserviceProviderId": "0"
    },
    {
      "CareserviceId": "17776",
      "PlannedAction": "15.1.7",
      "PlannedActionName": "Ut av eller opp i seng",
      "StartDate": "2024-11-22T20:23:16.9679425+01:00",
      "EndDate": "2025-11-22T19:23:16.9679425+01:00",
      "GeographicalLevels": {
        "1": "Test kommune",
        "1.1": "Hjemmeboende",
        "1.1.1": "Ytre distrikt"
      },
      "CareserviceProviderId": "0"
    }
  ]
}

application/xml, text/xml

Sample: 
<PatientServicesResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://lifecare.tieto.com/ec/no/v1">
  <Careservices>
    <PatientCareservice>
      <CareserviceId>17776</CareserviceId>
      <CareserviceProviderId>0</CareserviceProviderId>
      <EndDate>2025-11-22T19:23:16.9679425+01:00</EndDate>
      <GeographicalLevels xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:KeyValueOfstringstring>
          <d4p1:Key>1</d4p1:Key>
          <d4p1:Value>Test kommune</d4p1:Value>
        </d4p1:KeyValueOfstringstring>
        <d4p1:KeyValueOfstringstring>
          <d4p1:Key>1.1</d4p1:Key>
          <d4p1:Value>Hjemmeboende</d4p1:Value>
        </d4p1:KeyValueOfstringstring>
        <d4p1:KeyValueOfstringstring>
          <d4p1:Key>1.1.1</d4p1:Key>
          <d4p1:Value>Ytre distrikt</d4p1:Value>
        </d4p1:KeyValueOfstringstring>
      </GeographicalLevels>
      <PlannedAction>15</PlannedAction>
      <PlannedActionName>Hjemmesykepleie</PlannedActionName>
      <StartDate>2024-11-22T20:23:16.9679425+01:00</StartDate>
    </PatientCareservice>
    <PatientCareservice>
      <CareserviceId>17776</CareserviceId>
      <CareserviceProviderId>0</CareserviceProviderId>
      <EndDate>0001-01-01T00:00:00</EndDate>
      <GeographicalLevels xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:KeyValueOfstringstring>
          <d4p1:Key>1</d4p1:Key>
          <d4p1:Value>Test kommune</d4p1:Value>
        </d4p1:KeyValueOfstringstring>
        <d4p1:KeyValueOfstringstring>
          <d4p1:Key>1.1</d4p1:Key>
          <d4p1:Value>Hjemmeboende</d4p1:Value>
        </d4p1:KeyValueOfstringstring>
        <d4p1:KeyValueOfstringstring>
          <d4p1:Key>1.1.1</d4p1:Key>
          <d4p1:Value>Ytre distrikt</d4p1:Value>
        </d4p1:KeyValueOfstringstring>
      </GeographicalLevels>
      <PlannedAction>15.1.1</PlannedAction>
      <PlannedActionName>Stell</PlannedActionName>
      <StartDate>2024-11-22T20:23:16.9679425+01:00</StartDate>
    </PatientCareservice>
    <PatientCareservice>
      <CareserviceId>17776</CareserviceId>
      <CareserviceProviderId>0</CareserviceProviderId>
      <EndDate>2025-11-22T19:23:16.9679425+01:00</EndDate>
      <GeographicalLevels xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:KeyValueOfstringstring>
          <d4p1:Key>1</d4p1:Key>
          <d4p1:Value>Test kommune</d4p1:Value>
        </d4p1:KeyValueOfstringstring>
        <d4p1:KeyValueOfstringstring>
          <d4p1:Key>1.1</d4p1:Key>
          <d4p1:Value>Hjemmeboende</d4p1:Value>
        </d4p1:KeyValueOfstringstring>
        <d4p1:KeyValueOfstringstring>
          <d4p1:Key>1.1.1</d4p1:Key>
          <d4p1:Value>Ytre distrikt</d4p1:Value>
        </d4p1:KeyValueOfstringstring>
      </GeographicalLevels>
      <PlannedAction>15.1.6</PlannedAction>
      <PlannedActionName>Forflytning</PlannedActionName>
      <StartDate>2024-11-22T20:23:16.9679425+01:00</StartDate>
    </PatientCareservice>
    <PatientCareservice>
      <CareserviceId>17776</CareserviceId>
      <CareserviceProviderId>0</CareserviceProviderId>
      <EndDate>2025-11-22T19:23:16.9679425+01:00</EndDate>
      <GeographicalLevels xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:KeyValueOfstringstring>
          <d4p1:Key>1</d4p1:Key>
          <d4p1:Value>Test kommune</d4p1:Value>
        </d4p1:KeyValueOfstringstring>
        <d4p1:KeyValueOfstringstring>
          <d4p1:Key>1.1</d4p1:Key>
          <d4p1:Value>Hjemmeboende</d4p1:Value>
        </d4p1:KeyValueOfstringstring>
        <d4p1:KeyValueOfstringstring>
          <d4p1:Key>1.1.1</d4p1:Key>
          <d4p1:Value>Ytre distrikt</d4p1:Value>
        </d4p1:KeyValueOfstringstring>
      </GeographicalLevels>
      <PlannedAction>15.1.7</PlannedAction>
      <PlannedActionName>Ut av eller opp i seng</PlannedActionName>
      <StartDate>2024-11-22T20:23:16.9679425+01:00</StartDate>
    </PatientCareservice>
  </Careservices>
</PatientServicesResponse>