Skip to content

List patient summaries for a domain

Request

Returns the patient summary view for the specified domain when the caller is authorized. Supports optional filters via query string and offset paging via skip and take.

Response body is a JSON array. Fields below apply to each array item.

Security
Bearer
Path
domainstringrequired

Partner domain identifier for the organisation/tenant. Your bearer token is scoped to one or more domains and requests outside that scope are rejected.

Example:acme
Query
patientIdstring
firstNamestring

Optional patient first name filter. Exact match (case-insensitive); no partial matching.

Example:firstName=Amandeep
lastNamestring

Optional patient last name filter. Exact match (case-insensitive); no partial matching.

Example:lastName=KAUR
dateOfBirthstring, (date)

Optional patient date of birth filter (ISO 8601 date, yyyy-MM-dd). Exact match.

Example:dateOfBirth=1988-03-03
emailstring

Optional patient email filter. Exact match (case-insensitive).

Example:email=user@example.com
mobilePhonestring

Optional patient mobile phone filter. Exact match (case-insensitive); no partial matching.

Example:mobilePhone=0435531162
skipinteger, (int32), [ 0 .. 10000 ]

Optional number of items to skip. Defaults to 0 when omitted. Must be between 0 and 10000.

Default:0
Example:skip=0
takeinteger, (int32), [ 1 .. 500 ]

Optional maximum number of items to return. Defaults to 100 when omitted. Must be between 1 and 500.

Default:100
Example:take=100
Headers
X-Correlation-Idstring

Request correlation identifier. Echoes the incoming X-Correlation-Id header when provided.

Example:4b7f0a91b4f54f2a
curl -i -X GET \
  'https://partnerdocs.qubs.io/_mock/openapi/integrations/v1/acme/patients?patientId=string&firstName=Amandeep&lastName=KAUR&dateOfBirth=1988-03-03&email=user%40example.com&mobilePhone=0435531162&skip=0&take=100' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'X-Correlation-Id: 4b7f0a91b4f54f2a'

Responses

Array of patient summaries for the requested domain.

Headers
X-Correlation-Idstring

Request correlation identifier. Echoes the incoming X-Correlation-Id header when provided.

Example:"4b7f0a91b4f54f2a"
Bodyapplication/json
Array [
domainstringrequired

Domain this patient belongs to.

Example:"Example domain"
patientIdstringrequired

Patient identifier.

Example:"123"
patientNamestringrequired

Patient display name.

Example:"Example Name"
firstNamestring

Patient first name.

Example:"Example Name"
lastNamestring

Patient last name.

Example:"Example Name"
genderstring

Patient gender/sex string as stored in QUBS. No enum is enforced by this API; values can be blank, so map blank, unknown, or unrecognized values to your local Unknown value if required.

Example:"Example gender"
dateOfBirthnull or string, (date)

Patient date of birth (ISO 8601, yyyy-MM-dd).

Example:"2020-01-01"
]
Response
[
  {
    "domain": "acme",
    "patientId": "220000",
    "patientName": "Jane Doe",
    "firstName": "Jane",
    "lastName": "Doe",
    "gender": "F",
    "dateOfBirth": "1988-03-03"
  },
  {
    "domain": "acme",
    "patientId": "220001",
    "patientName": "Alex Smith",
    "firstName": "Alex",
    "lastName": "Smith",
    "gender": "M",
    "dateOfBirth": "1990-04-04"
  }
]