Skip to content

Patients

Partner-facing endpoints for retrieving patients within a domain.

Operations

Get patient summary by domain and patient id

Request

Returns the patient summary view for the specified domain and patient id when the caller is authorized.

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
patientIdstringrequired

Patient identifier within the specified domain.

Example:220000
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/220000 \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'X-Correlation-Id: 4b7f0a91b4f54f2a'

Responses

OK

Headers
X-Correlation-Idstring

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

Example:"4b7f0a91b4f54f2a"
Bodyapplication/json
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"
}