GET api/v1/patients?domain={domain}&key={key}&provider_unit={provider_unit}&roles={roles}&geographicalLevel={geographicalLevel}&careServiceLevel={careServiceLevel}&activeOnDate={activeOnDate}&allowEmpty={allowEmpty}

Patients based on the geographicalLevel filter

Request Information

URI Parameters

Name	Description	Type	Additional information
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.
geographicalLevel	Filter represented by level string which returned patients are registered on or under. e.g if the geographicalLevel is set to 1.2 then the result will list all patients which are registered on level 1.2. All patients which are registered on a level below 1.2 will also be listed. In this example a patient registered at geographicalLevel 1.2.3 will be part of the result. Geographical Level is where the user belongs geographically. E.g geographicalLevel 1 is municipality A and geographicalLevel 1.1 is living at home, and 1.1.1 is zone west while geographicalLevel 1.1.2 is zone east in the same municipality. This will vary from municipality to municipality. CareServiceLevel can be used to filter by a given Care service level.	string	None.
careServiceLevel	Filter by careServiceLevel (Tjeneste/tiltak). Dotted string, e.g. "1", "1.2" or "1.2.3", or "1.%" or "1.2.%" to do a wildcard search. New in 9.1.13	string	None.
activeOnDate	Date for which careServiceLevel should be active. Default = "today". "today" or RFC3339 date accepted. New in 9.1.13	string	None.
allowEmpty	If true, HTTP status 200 and an empty list is returned, if there are no patients 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

Patients based on the geographicalLevel filter

Collection of PatientListResponse

Name	Description	Type	Additional information
PatientId	The internal patient Id	integer	None.
SSn	Social security number	string	None.
Name	Name	string	None.
GeographicalLevel	Registered geographical area	string	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "PatientId": 2198,
    "SSn": "11034500000",
    "Name": "Test, Nils",
    "GeographicalLevel": "1"
  },
  {
    "PatientId": 2197,
    "SSn": "11023100000",
    "Name": "Test, Arne",
    "GeographicalLevel": "1"
  }
]

application/xml, text/xml

Sample:

<ArrayOfPatientListResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://lifecare.tieto.com/ec/no/v1">
  <PatientListResponse>
    <GeographicalLevel>1</GeographicalLevel>
    <Name>Test, Nils</Name>
    <PatientId>2198</PatientId>
    <SSn>11034500000</SSn>
  </PatientListResponse>
  <PatientListResponse>
    <GeographicalLevel>1</GeographicalLevel>
    <Name>Test, Arne</Name>
    <PatientId>2197</PatientId>
    <SSn>11023100000</SSn>
  </PatientListResponse>
</ArrayOfPatientListResponse>