{"info":{"_postman_id":"18a63330-0610-4828-b80d-9627612f9412","name":"CareLynx API","description":"

📘 Overview

CareLynx provides a comprehensive set of RESTful endpoints to access both clinical and non-clinical data of care recipients. We currently offer 21 endpoints, with new endpoints continuously added to simplify and improve third-party integrations.

This documentation includes:

Detailed overview of each endpoint
\n
Real-world usage examples
\n
Schema for request and response payloads
\n

Developer-Friendly Features

Select your preferred programming language from the dropdown to view code samples.
\n
Switch between Light and Dark mode using the toggle at the top right for your comfort.
\n

✅ Prerequisites

Before you begin, ensure the following:

🔧 Tools

Postman Collection: Click the Run in Postman button located in the top right corner of this page
\n
Swagger UI: Swagger UI
\n

Helpful Resources:

Postman Docs
\n
Swagger UI Docs
\n

🔐 Authentication

CareLynx API uses OAuth 2.0 for secure authentication.

Learn more: OAuth 2.0 Overview

🛠 Required Configuration

You’ll need the following config variables to use the API:

CLIENT_ID
\n
CLIENT_SECRET
\n
API_KEY
\n
SCOPE
\n
BASE_URL
\n
AUTH_URL
\n

\n
⚠️ NOTE
\n

\n
Every API request must include an x-api-key header containing your API_KEY value. This is required to authenticate and authorize access to all endpoints.
\n

If you need access to these values or face issues, email us at

📧 support@carelynx.com.

🔧 Postman Authorization Setup Sample

\n\n

🔧 Postman Header Setup Sample

\n\n

📂 Available Endpoints

GET /api/v2/careRecipients
\n
→ Fetch a list of all care recipients
\n

All the following endpoints are scoped to a specific care recipient via :careRecipientId.

Personal & Administrative Details

GET /api/v2/careRecipients/:careRecipientId/peopleResponsible
\n
GET /api/v2/careRecipients/:careRecipientId/medicalOfficerDetails
\n
GET /api/v2/careRecipients/:careRecipientId/medicareAndInsuranceDetails
\n
GET /api/v2/careRecipients/:careRecipientId/pensionAndBenefitsDetails
\n
GET /api/v2/careRecipients/:careRecipientId/personalDetails
\n
GET /api/v2/careRecipients/:careRecipientId/contacts
\n

Clinical Records

GET /api/v2/careRecipients/:careRecipientId/allergies
\n
GET /api/v2/careRecipients/:careRecipientId/observations
\n
GET /api/v2/careRecipients/:careRecipientId/bowelObservations
\n
GET /api/v2/careRecipients/:careRecipientId/wounds
\n
GET /api/v2/careRecipients/:careRecipientId/infectionControl
\n
GET /api/v2/careRecipients/:careRecipientId/behaviours
\n
GET /api/v2/careRecipients/:careRecipientId/technicalNursingRequirements
\n
GET /api/v2/careRecipients/:careRecipientId/rugAdls
\n
GET /api/v2/careRecipients/:careRecipientId/akps
\n
GET /api/v2/careRecipients/:careRecipientId/palliativeCares
\n
GET /api/v2/careRecipients/:careRecipientId/frailties
\n
GET /api/v2/careRecipients/:careRecipientId/accidentsAndIncidents
\n

Allied Health

GET /api/v2/careRecipients/:careRecipientId/alliedHealthDetails
\n
GET /api/v2/careRecipients/:careRecipientId/alliedHealthReferralVisits
\n

⚠️ HTTP Status Codes

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Code	Meaning
200	✅ Success
400	❌ Bad Request – Missing parameter (e.g., page, careRecipientId)
401	🔒 Unauthorized – Invalid CLIENT_ID, CLIENT_SECRET, or SCOPE
403	⛔ Forbidden – Invalid or expired API_KEY
404	🔎 Not Found – Invalid careRecipientId
500	💥 Server Error – Something went wrong on our end. Please send your request payload or curl to support for investigation.

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"41091850","collectionId":"18a63330-0610-4828-b80d-9627612f9412","publishedId":"2sB2qcCgRe","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"279989"},"publishDate":"2025-10-14T06:45:41.000Z"},"item":[{"name":"Get Care Recipients","id":"74f748da-bbe3-42b2-95c9-25c9eec27576","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"scope","value":"{{SCOPE}}"},{"key":"clientId","value":"{{CLIENT_ID}}"},{"key":"headerPrefix","value":""},{"key":"refreshTokenUrl","value":"{{AUTH_URL}}"},{"key":"accessTokenUrl","value":"{{AUTH_URL}}"},{"key":"clientSecret","value":"{{CLIENT_SECRET}}"},{"key":"tokenName","value":""},{"key":"client_authentication","value":""},{"key":"grant_type","value":""},{"key":"password","value":"{{password}}"},{"key":"username","value":"{{username}}"}]},"isInherited":false},"method":"GET","header":[{"key":"x-api-key","value":"{{API_KEY}}","type":"text"}],"url":"{{BASE_URL}}/api/v2/careRecipients?page=1","description":"

📄 Endpoint Overview

This endpoint returns a paginated list/array of Care Recipients, with a maximum of 10 records per page.

A mandatory query parameter named page must be provided. To retrieve the initial set of results, set page=1.

The successful response includes pagination metadata such as:

careRecipients: A paginated list of Care Recipients (max 10 records)
\n
totalPages: Total number of pages available
\n
currentPage: Current page number returned
\n
totalRecords: Total number of Care Recipient records in the system
\n

Response Schema

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Attribute	Type	Description
anACCClassification	string	AN-ACC classification. Can be null.
archived	boolean	Whether the care recipient record is archived.
archivedDate	datetime	Date when the care recipient was archived. Can be null.
bedNumber	string	Bed ID assigned to the care recipient. May be an empty string.
build	string	Physical build description. May be an empty string.
createdOn	datetime	Timestamp when the care recipient record was created.
dob	date	Care recipient’s date of birth. Can be null.
eyeColour	string	Eye colour. May be an empty string.
facility	string	Facility/Group allocated to the Care Recipient. Can be null or empty string.
firstName	string	First name of the care recipient.
gender	string	Represents Care Recipient gender.
hairColour	string	Hair colour. May be an empty string.
height	string	Height in centimeters as a string (e.g., “172.00 cm”). Can be null.
lastName	string	Last name of the care recipient.
middleName	string	Middle name of the care recipient. Can be null.
myAgeCareId	string	My Aged Care ID. Can be null.
ndis	string	NDIS identifier. May be an empty string.
preferredName	string	Care recipient’s preferred name. Can be null.
lastUpdatedOn	datetime	Timestamp of last update.
uuid	uuid	Unique identifier for the care recipient.
wing	string	Wing/SubGroup allocated to the Care Recipient. Can be null or empty string.

","urlObject":{"path":["api","v2","careRecipients"],"host":["{{BASE_URL}}"],"query":[{"key":"page","value":"1"}],"variable":[]}},"response":[{"id":"d1b8ca69-7300-4508-8bb7-f34af30e82c1","name":"400: Missing page query param","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"{{API_KEY}}","type":"text"}],"url":{"raw":"{{BASE_URL}}/api/v2/careRecipients?page=1","host":["{{BASE_URL}}"],"path":["api","v2","careRecipients"],"query":[{"key":"page","value":"1"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"58"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Sun, 25 May 2025 09:25:49 GMT"},{"key":"x-amz-apigw-id","value":"LHhEpFU8SwMEOxQ="},{"key":"x-amzn-RequestId","value":"b4fd6636-4498-4009-a28a-64c189484d2e"},{"key":"x-amzn-ErrorType","value":"BadRequestException"},{"key":"X-Cache","value":"Error from cloudfront"},{"key":"Via","value":"1.1 0ea9275b520295dc60df246b1de3192a.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"BNE50-P1"},{"key":"X-Amz-Cf-Id","value":"XQ3waTATe3RkYfTK63JTCYRXfYbhArS34VCB4n9I6cG2iEmxx0o9jA=="}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Missing required request parameters: [page]\"\n}"},{"id":"9fb61e9f-661d-4de8-8775-761579285116","name":"401: Missing or Invalid Client ID or Secret or Scope","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"{{API_KEY}}","type":"text"}],"url":{"raw":"{{BASE_URL}}/api/v2/careRecipients?page=1","host":["{{BASE_URL}}"],"path":["api","v2","careRecipients"],"query":[{"key":"page","value":"1"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"26"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Sun, 25 May 2025 09:29:09 GMT"},{"key":"x-amz-apigw-id","value":"LHhj3EHtywMEX4A="},{"key":"x-amzn-RequestId","value":"e01a9e9f-29bf-48dd-9123-f301088446e9"},{"key":"x-amzn-ErrorType","value":"UnauthorizedException"},{"key":"X-Cache","value":"Error from cloudfront"},{"key":"Via","value":"1.1 48d8e85703699c2da097b0f28aa75248.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"BNE50-P1"},{"key":"X-Amz-Cf-Id","value":"-OgDu0lVqAYYM_z3M_RK9qMQhFcucIHIuz0kZCZVSfcdGNtTnY3nxQ=="}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Unauthorized\"\n}"},{"id":"f179e9a9-55ee-4abc-ab38-fd45971f2cfd","name":"403: Invalid API key","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"{{API_KEY}}1","type":"text"}],"url":{"raw":"{{BASE_URL}}/api/v2/careRecipients","host":["{{BASE_URL}}"],"path":["api","v2","careRecipients"],"query":[{"key":"page","value":"1","disabled":true}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"23"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Sun, 25 May 2025 09:26:56 GMT"},{"key":"x-amz-apigw-id","value":"LHhPEEjmywMEFlQ="},{"key":"x-amzn-RequestId","value":"e138bc0d-063c-43a9-b7c8-201365502485"},{"key":"x-amzn-ErrorType","value":"ForbiddenException"},{"key":"X-Cache","value":"Error from cloudfront"},{"key":"Via","value":"1.1 48d8e85703699c2da097b0f28aa75248.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"BNE50-P1"},{"key":"X-Amz-Cf-Id","value":"zzep1jP3Re6JxDjsoKbeJtjXqlMomxEX9sN1gcaZ1ZTTviB63-MKaQ=="}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Forbidden\"\n}"},{"id":"f557c66b-d173-4047-a142-32faf2d13874","name":"403: Invalid token","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"{{API_KEY}}","type":"text"}],"url":{"raw":"{{BASE_URL}}/api/v2/careRecipients","host":["{{BASE_URL}}"],"path":["api","v2","careRecipients"],"query":[{"key":"page","value":"1","disabled":true}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"27"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Sun, 25 May 2025 09:27:33 GMT"},{"key":"x-amz-apigw-id","value":"LHhU8FokSwMEVmg="},{"key":"x-amzn-RequestId","value":"85f89526-d9e6-4513-b43d-a6082da40a5c"},{"key":"x-amzn-ErrorType","value":"AccessDeniedException"},{"key":"X-Cache","value":"Error from cloudfront"},{"key":"Via","value":"1.1 48d8e85703699c2da097b0f28aa75248.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"BNE50-P1"},{"key":"X-Amz-Cf-Id","value":"7S5xp2WF7wVu3wdmEo8OLVhemqn1GWrqa2_HDDIpxxBrDS_SLp12jA=="}],"cookie":[],"responseTime":null,"body":"{\n \"Message\": \"Access Denied\"\n}"},{"id":"e0e943a8-f18a-4aea-b864-5cb19ec9df10","name":"200: Success","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"{{API_KEY}}","type":"text"}],"url":{"raw":"{{BASE_URL}}/api/v2/careRecipients?page=1","host":["{{BASE_URL}}"],"path":["api","v2","careRecipients"],"query":[{"key":"page","value":"1"}]}},"status":"OK","code":200,"_postman_previewlanguage":null,"header":[{"key":"Date","value":"Tue, 07 Oct 2025 13:10:31 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"5005"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"935d529a-830f-43ae-bd14-48f64ca5915c"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"SE-irGcsSwMEPUQ="},{"key":"X-Amzn-Trace-Id","value":"Root=1-68e51143-66bdc0d37ddbe58f491f4a80;Parent=501fd5c3d7368f7c;Sampled=0;Lineage=1:ea5b5c31:0"}],"cookie":[],"responseTime":null,"body":"{\n \"careRecipients\": [\n {\n \"anACCClassification\": \"Class 6\",\n \"archived\": false,\n \"archivedDate\": null,\n \"bedNumber\": \"10\",\n \"build\": \"large\",\n \"createdOn\": \"2023-11-02T10:56:30.357+10:00\",\n \"dob\": \"1936-06-20\",\n \"eyeColour\": \"brown\",\n \"facility\": \"CareLynx Facility\",\n \"firstName\": \"Aidan\",\n \"gender\": \"female\",\n \"hairColour\": \"grey\",\n \"height\": \"155.0 cm\",\n \"lastName\": \"COLLIER\",\n \"middleName\": \"\",\n \"myAgeCareId\": \"\",\n \"ndis\": \"\",\n \"preferredName\": \"\",\n \"lastUpdatedOn\": \"2025-10-03T15:52:53.606+10:00\",\n \"status\": \"\",\n \"uuid\": \"38a8fea6-cae6-4261-a2ef-dce40c424179\",\n \"wing\": \"\"\n },\n {\n \"anACCClassification\": \"Class 4\",\n \"archived\": false,\n \"archivedDate\": null,\n \"bedNumber\": \"27\",\n \"build\": \"\",\n \"createdOn\": \"2024-11-20T11:34:51.997+10:00\",\n \"dob\": \"1935-02-09\",\n \"eyeColour\": \"\",\n \"facility\": \"CareLynx Facility\",\n \"firstName\": \"Alex\",\n \"gender\": \"male\",\n \"hairColour\": \"grey\",\n \"height\": \"180.0 cm\",\n \"lastName\": \"ROBERTSON\",\n \"middleName\": \"John\",\n \"myAgeCareId\": \"AC98670326\",\n \"ndis\": \"\",\n \"preferredName\": \"\",\n \"lastUpdatedOn\": \"2025-10-03T15:52:56.468+10:00\",\n \"status\": null,\n \"uuid\": \"8e41a192-004b-4752-ac8a-674f02408abb\",\n \"wing\": \"\"\n },\n {\n \"anACCClassification\": \"Class 11\",\n \"archived\": false,\n \"archivedDate\": null,\n \"bedNumber\": \"16\",\n \"build\": \"\",\n \"createdOn\": \"2022-09-11T19:40:40.523+10:00\",\n \"dob\": \"1943-01-19\",\n \"eyeColour\": \"brown\",\n \"facility\": \"CareLynx Facility\",\n \"firstName\": \"Alice\",\n \"gender\": \"female\",\n \"hairColour\": \"grey\",\n \"height\": \"0.02 cm\",\n \"lastName\": \"WALTER\",\n \"middleName\": \"\",\n \"myAgeCareId\": \"\",\n \"ndis\": \"\",\n \"preferredName\": \"Antonia\",\n \"lastUpdatedOn\": \"2025-10-03T15:52:44.375+10:00\",\n \"status\": \"\",\n \"uuid\": \"6791a3e5-ab01-4bdb-8004-9e7d0933d8d1\",\n \"wing\": \"\"\n },\n {\n \"anACCClassification\": \"\",\n \"archived\": false,\n \"archivedDate\": null,\n \"bedNumber\": \"29\",\n \"build\": \"solid\",\n \"createdOn\": \"2024-12-05T13:40:56.926+10:00\",\n \"dob\": \"1948-04-20\",\n \"eyeColour\": \"brown\",\n \"facility\": \"CareLynx Facility\",\n \"firstName\": \"Amelia\",\n \"gender\": \"male\",\n \"hairColour\": \"grey\",\n \"height\": \"NaN cm\",\n \"lastName\": \"ERDMAN\",\n \"middleName\": \"\",\n \"myAgeCareId\": \"AC63097265\",\n \"ndis\": \"\",\n \"preferredName\": \"Con\",\n \"lastUpdatedOn\": \"2025-10-03T15:52:56.692+10:00\",\n \"status\": null,\n \"uuid\": \"a432a8b2-ff03-4482-8d6e-47abe6e70676\",\n \"wing\": \"\"\n },\n {\n \"anACCClassification\": \"\",\n \"archived\": false,\n \"archivedDate\": null,\n \"bedNumber\": \"15\",\n \"build\": \"thin\",\n \"createdOn\": \"2025-05-15T13:04:06.595+10:00\",\n \"dob\": \"1942-05-08\",\n \"eyeColour\": \"brown\",\n \"facility\": \"CareLynx Facility\",\n \"firstName\": \"Anna\",\n \"gender\": \"female\",\n \"hairColour\": \"grey\",\n \"height\": \"NaN cm\",\n \"lastName\": \"FLATLEY\",\n \"middleName\": \"Mary\",\n \"myAgeCareId\": \"\",\n \"ndis\": \"\",\n \"preferredName\": \"\",\n \"lastUpdatedOn\": \"2025-10-03T15:52:57.740+10:00\",\n \"status\": null,\n \"uuid\": \"524af8d8-46e3-4eb6-bbcd-b3dea0a1d85b\",\n \"wing\": \"\"\n },\n {\n \"anACCClassification\": \"Class 7\",\n \"archived\": false,\n \"archivedDate\": null,\n \"bedNumber\": \"03D\",\n \"build\": \"average\",\n \"createdOn\": \"2023-06-21T10:19:53.823+10:00\",\n \"dob\": \"1940-12-24\",\n \"eyeColour\": \"brown\",\n \"facility\": \"CareLynx Facility\",\n \"firstName\": \"Annabelle\",\n \"gender\": \"male\",\n \"hairColour\": \"grey\",\n \"height\": \"165.0 cm\",\n \"lastName\": \"MILLS\",\n \"middleName\": \"\",\n \"myAgeCareId\": \"\",\n \"ndis\": \"\",\n \"preferredName\": \"\",\n \"lastUpdatedOn\": \"2025-10-03T15:52:52.509+10:00\",\n \"status\": null,\n \"uuid\": \"3b5ccf7e-6686-4f49-a7c4-9eb559aec8c1\",\n \"wing\": \"\"\n },\n {\n \"anACCClassification\": \"Class 11\",\n \"archived\": false,\n \"archivedDate\": null,\n \"bedNumber\": \"18\",\n \"build\": \"average\",\n \"createdOn\": \"2024-02-19T09:20:12.926+10:00\",\n \"dob\": \"1929-11-24\",\n \"eyeColour\": \"brown\",\n \"facility\": \"CareLynx Facility\",\n \"firstName\": \"Annabelle\",\n \"gender\": \"male\",\n \"hairColour\": \"grey\",\n \"height\": \"165.0 cm\",\n \"lastName\": \"MARKS\",\n \"middleName\": \"\",\n \"myAgeCareId\": \"\",\n \"ndis\": \"\",\n \"preferredName\": \"\",\n \"lastUpdatedOn\": \"2025-10-03T15:52:54.837+10:00\",\n \"status\": \"\",\n \"uuid\": \"ca66be68-5cfa-42db-848b-cd379a15b018\",\n \"wing\": \"\"\n },\n {\n \"anACCClassification\": \"\",\n \"archived\": false,\n \"archivedDate\": null,\n \"bedNumber\": \"01B\",\n \"build\": \"\",\n \"createdOn\": \"2025-04-16T20:51:23.630+10:00\",\n \"dob\": \"1933-05-15\",\n \"eyeColour\": \"\",\n \"facility\": \"CareLynx Facility\",\n \"firstName\": \"Blake\",\n \"gender\": \"female\",\n \"hairColour\": \"\",\n \"height\": \"146.0 cm\",\n \"lastName\": \"KOVACEK\",\n \"middleName\": \"\",\n \"myAgeCareId\": \"\",\n \"ndis\": \"\",\n \"preferredName\": \"Cena\",\n \"lastUpdatedOn\": \"2025-10-03T15:52:57.365+10:00\",\n \"status\": \"\",\n \"uuid\": \"7445dac5-30c0-46d0-b3da-7620f94c8cc7\",\n \"wing\": \"\"\n },\n {\n \"anACCClassification\": \"Class 5\",\n \"archived\": false,\n \"archivedDate\": null,\n \"bedNumber\": \"12\",\n \"build\": \"\",\n \"createdOn\": \"2022-09-11T19:38:21.977+10:00\",\n \"dob\": \"1944-12-08\",\n \"eyeColour\": \"\",\n \"facility\": \"CareLynx Facility\",\n \"firstName\": \"Caleb\",\n \"gender\": \"female\",\n \"hairColour\": \"grey\",\n \"height\": \"162.0 cm\",\n \"lastName\": \"GRIFFITHS\",\n \"middleName\": \"\",\n \"myAgeCareId\": \"\",\n \"ndis\": \"\",\n \"preferredName\": \"Sophia\",\n \"lastUpdatedOn\": \"2025-10-03T15:52:44.113+10:00\",\n \"status\": null,\n \"uuid\": \"42549cf5-dbb1-4cd3-b93b-12cb88751ce7\",\n \"wing\": \"\"\n },\n {\n \"anACCClassification\": \"Class 4\",\n \"archived\": false,\n \"archivedDate\": null,\n \"bedNumber\": \"08\",\n \"build\": \"\",\n \"createdOn\": \"2022-09-11T19:35:19.293+10:00\",\n \"dob\": \"1950-01-19\",\n \"eyeColour\": \"\",\n \"facility\": \"CareLynx Facility\",\n \"firstName\": \"Caleb\",\n \"gender\": \"male\",\n \"hairColour\": \"\",\n \"height\": \"184.0 cm\",\n \"lastName\": \"BAILEY\",\n \"middleName\": \"\",\n \"myAgeCareId\": \"\",\n \"ndis\": \"\",\n \"preferredName\": \"Theo\",\n \"lastUpdatedOn\": \"2025-10-03T15:52:43.556+10:00\",\n \"status\": null,\n \"uuid\": \"d5edbb8f-9c15-44e6-b5e9-8bc0f30765ad\",\n \"wing\": \"\"\n }\n ],\n \"totalPages\": 8,\n \"currentPage\": 1,\n \"totalRecords\": 71\n}"}],"_postman_id":"74f748da-bbe3-42b2-95c9-25c9eec27576"},{"name":"Get People Responsible","id":"ebd2da65-e246-4ef3-ba46-1b1b72605ab2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"client_authentication","value":""},{"key":"scope","value":"{{SCOPE}}"},{"key":"headerPrefix","value":""},{"key":"refreshTokenUrl","value":"{{AUTH_URL}}"},{"key":"accessTokenUrl","value":"{{AUTH_URL}}"},{"key":"clientSecret","value":"{{CLIENT_SECRET}}"},{"key":"clientId","value":"{{CLIENT_ID}}"},{"key":"tokenName","value":""},{"key":"grant_type","value":""},{"key":"password","value":"{{password}}"},{"key":"username","value":"{{username}}"}]},"isInherited":false},"method":"GET","header":[{"key":"x-api-key","value":"{{API_KEY}}","type":"text"}],"url":"{{BASE_URL}}/api/v2/careRecipients/:careRecipientId/peopleResponsible","description":"

📄 Endpoint Overview

This endpoint returns a list/array of all Responsible People who are allocated to a specific Care Recipient.

The successful response includes the following:

peopleResponsible: A list of all Responsible People

Response Schema

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Attribute	Type	Description
emailAddress	string	Email address of the Responsible Person.
firstName	string	First name of the Responsible Person.
lastName	string	Last name of the Responsible Person.
mobileNumber	string	Mobile number. Can be null or empty string.
title	string	Role or designation. Can be null.
uuid	uuid	Unique identifier for the person.

","urlObject":{"path":["api","v2","careRecipients",":careRecipientId","peopleResponsible"],"host":["{{BASE_URL}}"],"query":[],"variable":[{"type":"any","value":"{{CARE_RECIPIENT_ID}}","key":"careRecipientId"}]}},"response":[{"id":"ebba53ee-4ed4-4a88-b5f0-2fb1b8e31b4a","name":"401: Missing or Invalid Client ID or Secret or Scope","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"{{API_KEY}}","type":"text"}],"url":{"raw":"{{BASE_URL}}/api/v2/careRecipients/:careRecipientId/peopleResponsible","host":["{{BASE_URL}}"],"path":["api","v2","careRecipients",":careRecipientId","peopleResponsible"],"variable":[{"key":"careRecipientId","value":"6f57349d-ebe1-460e-81f1-ce9c1778ee8b"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"26"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Sun, 25 May 2025 10:37:36 GMT"},{"key":"x-amz-apigw-id","value":"LHrlmEDrywMENMw="},{"key":"x-amzn-RequestId","value":"06fefc7e-ca03-47e8-b77c-c0434fafdefd"},{"key":"x-amzn-ErrorType","value":"UnauthorizedException"},{"key":"X-Cache","value":"Error from cloudfront"},{"key":"Via","value":"1.1 c2b0b14414d87fbf9985559b5d1be1b0.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"BNE50-P1"},{"key":"X-Amz-Cf-Id","value":"9vKxLeFojZ_a-X2FabXk-sUt3oXGQOQGGm-gEa5IAVkbnZFoQiVGvw=="}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Unauthorized\"\n}"},{"id":"6e6fbd7b-80bd-480c-8573-bb9dc69d32fe","name":"403: Invalid API key","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"{{API_KEY}}1","type":"text"}],"url":{"raw":"{{BASE_URL}}/api/v2/careRecipients/:careRecipientId/peopleResponsible","host":["{{BASE_URL}}"],"path":["api","v2","careRecipients",":careRecipientId","peopleResponsible"],"variable":[{"key":"careRecipientId","value":"6f57349d-ebe1-460e-81f1-ce9c1778ee8b"}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"23"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Sun, 25 May 2025 10:35:11 GMT"},{"key":"x-amz-apigw-id","value":"LHrPAEVkSwMEFmg="},{"key":"x-amzn-RequestId","value":"1dee70cf-3d28-416b-8608-319d2402d3a0"},{"key":"x-amzn-ErrorType","value":"ForbiddenException"},{"key":"X-Cache","value":"Error from cloudfront"},{"key":"Via","value":"1.1 8746917a03e290c5d72efdb8c6127ca0.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"BNE50-P1"},{"key":"X-Amz-Cf-Id","value":"1iifihyGv4p7QWchz1IGJHw4qrTG0fTn1oOZR8fzCvu-BHw00TNRNQ=="}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Forbidden\"\n}"},{"id":"7f3ea811-30f1-4a7f-9626-b8c828e8371d","name":"403: Invalid token","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"{{API_KEY}}","type":"text"}],"url":{"raw":"{{BASE_URL}}/api/v2/careRecipients/:careRecipientId/peopleResponsible","host":["{{BASE_URL}}"],"path":["api","v2","careRecipients",":careRecipientId","peopleResponsible"],"variable":[{"key":"careRecipientId","value":"6f57349d-ebe1-460e-81f1-ce9c1778ee8b"}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"27"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Sun, 25 May 2025 10:36:38 GMT"},{"key":"x-amz-apigw-id","value":"LHrclGmgSwMEEEw="},{"key":"x-amzn-RequestId","value":"aa24411d-e7f6-4766-b797-f5fa2e752a47"},{"key":"x-amzn-ErrorType","value":"AccessDeniedException"},{"key":"X-Cache","value":"Error from cloudfront"},{"key":"Via","value":"1.1 c2b0b14414d87fbf9985559b5d1be1b0.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"BNE50-P1"},{"key":"X-Amz-Cf-Id","value":"juk7VWWqziz2hmnvHQT_CsocLF9YHjcVjlEvjRmHBCqX-2uRfXMZcQ=="}],"cookie":[],"responseTime":null,"body":"{\n \"Message\": \"Access Denied\"\n}"},{"id":"5b65bdd6-d129-4796-82ad-121d35fd37da","name":"404: Invalid Care Recipient ID","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"{{API_KEY}}","type":"text"}],"url":{"raw":"{{BASE_URL}}/api/v2/careRecipients/:careRecipientId/peopleResponsible","host":["{{BASE_URL}}"],"path":["api","v2","careRecipients",":careRecipientId","peopleResponsible"],"variable":[{"key":"careRecipientId","value":"6f57349d-ebe1-460e-81f1-ce9c1778ee8b1"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"28"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Sun, 25 May 2025 09:52:39 GMT"},{"key":"X-Amzn-Trace-Id","value":"Root=1-6832e865-2f764c35394a342470870918;Parent=684f4fc866419c07;Sampled=0;Lineage=1:ba0e08d5:0"},{"key":"x-amzn-RequestId","value":"06b90d9f-868d-41bd-a7d2-077d4dba9090"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"LHk_8HqrywMESNA="},{"key":"X-Cache","value":"Error from cloudfront"},{"key":"Via","value":"1.1 4eefe477dad367c2eec11fc546f27dd4.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"BNE50-P1"},{"key":"X-Amz-Cf-Id","value":"QhosQFzOQI-M5bBqpzcHTk3FBJuoGqkNw39U5jn_dsQVWuziJoujMw=="}],"cookie":[],"responseTime":null,"body":"{\n \"error\": \"Record Not Found\"\n}"},{"id":"bddff937-f847-44b8-9e97-5bfd346da98a","name":"200: Success","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"{{API_KEY}}","type":"text"}],"url":{"raw":"{{BASE_URL}}/api/v2/careRecipients/:careRecipientId/peopleResponsible","host":["{{BASE_URL}}"],"path":["api","v2","careRecipients",":careRecipientId","peopleResponsible"],"variable":[{"key":"careRecipientId","value":"{{CARE_RECIPIENT_ID}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":null,"header":[{"key":"Date","value":"Tue, 07 Oct 2025 13:27:09 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"196"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"eff64bf0-6d46-47dd-80b7-6c09090aad8c"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"SFA_CE1SywMEmNA="},{"key":"X-Amzn-Trace-Id","value":"Root=1-68e5152c-0e288c0b72067c1e2791a9bd;Parent=4f17833a58a54b74;Sampled=0;Lineage=1:ba0e08d5:0"}],"cookie":[],"responseTime":null,"body":"{\n \"peopleResponsible\": [\n {\n \"emailAddress\": \"alisia@kutch.net\",\n \"firstName\": \"Addison\",\n \"lastName\": \"Goodwin\",\n \"mobileNumber\": \"\",\n \"title\": \"Personal Carer (PC)\",\n \"uuid\": \"7a802f7b-6c5d-480a-a234-75ee279ff3b1\"\n }\n ]\n}"}],"_postman_id":"ebd2da65-e246-4ef3-ba46-1b1b72605ab2"},{"name":"Get Medical Officer Details","id":"383535cc-60ff-4eeb-8fc2-9605faf9afc3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"client_authentication","value":""},{"key":"scope","value":"{{SCOPE}}"},{"key":"headerPrefix","value":""},{"key":"refreshTokenUrl","value":"{{AUTH_URL}}"},{"key":"accessTokenUrl","value":"{{AUTH_URL}}"},{"key":"clientSecret","value":"{{CLIENT_SECRET}}"},{"key":"clientId","value":"{{CLIENT_ID}}"},{"key":"tokenName","value":""},{"key":"grant_type","value":""},{"key":"password","value":"{{password}}"},{"key":"username","value":"{{username}}"}]},"isInherited":false},"method":"GET","header":[{"key":"x-api-key","value":"{{API_KEY}}","type":"text"}],"url":"{{BASE_URL}}/api/v2/careRecipients/:careRecipientId/medicalOfficerDetails","description":"

📄 Endpoint Overview

This endpoint returns an object containing the details of the Medical Officer assigned to a specific Care Recipient.

The successful response includes the following:

medicalOfficerDetails: An object that contains the Medical officer details

Response Schema

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Attribute	Type	Description
emailAddress	string	Email address of the medical officer. Can be null.
fax	string	Fax number. Can be null.
mobileNumber	string	Mobile number. Can be null.
name	string	Full name of the medical officer. Can be null.
phone	string	Landline or primary phone number. Can be null.
practiceAddress	string	Address of the medical officer’s practice. Can be null.
practiceName	string	Name of the medical practice. Can be null.

","urlObject":{"path":["api","v2","careRecipients",":careRecipientId","medicalOfficerDetails"],"host":["{{BASE_URL}}"],"query":[],"variable":[{"type":"any","value":"{{CARE_RECIPIENT_ID}}","key":"careRecipientId"}]}},"response":[{"id":"801cbf86-fc7e-473b-add2-71a8065536e4","name":"401: Missing or Invalid Client ID or Secret or Scope","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"{{API_KEY}}","type":"text"}],"url":{"raw":"{{BASE_URL}}/api/v2/careRecipients/:careRecipientId/medicalOfficerDetails","host":["{{BASE_URL}}"],"path":["api","v2","careRecipients",":careRecipientId","medicalOfficerDetails"],"variable":[{"key":"careRecipientId","value":"6f57349d-ebe1-460e-81f1-ce9c1778ee8b"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"26"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Sun, 25 May 2025 10:38:13 GMT"},{"key":"x-amz-apigw-id","value":"LHrrcGB3SwMEC-Q="},{"key":"x-amzn-RequestId","value":"bbf1a78d-727e-48f1-bf1f-6e6b449f7158"},{"key":"x-amzn-ErrorType","value":"UnauthorizedException"},{"key":"X-Cache","value":"Error from cloudfront"},{"key":"Via","value":"1.1 c2b0b14414d87fbf9985559b5d1be1b0.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"BNE50-P1"},{"key":"X-Amz-Cf-Id","value":"Bn7B0k-u639avfcveflIuq9pL0ThuRjr9Iec2Pmoj7sXlXmjYKrqbg=="}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Unauthorized\"\n}"},{"id":"3b4eeb5a-0a27-43bd-8680-63781bcd57ef","name":"403: Invalid API key","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"{{API_KEY}}1","type":"text"}],"url":{"raw":"{{BASE_URL}}/api/v2/careRecipients/:careRecipientId/medicalOfficerDetails","host":["{{BASE_URL}}"],"path":["api","v2","careRecipients",":careRecipientId","medicalOfficerDetails"],"variable":[{"key":"careRecipientId","value":"6f57349d-ebe1-460e-81f1-ce9c1778ee8b"}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"23"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Sun, 25 May 2025 10:58:08 GMT"},{"key":"x-amz-apigw-id","value":"LHumFFiuywMEWtA="},{"key":"x-amzn-RequestId","value":"00918187-9972-47b6-84e3-578f95e4f271"},{"key":"x-amzn-ErrorType","value":"ForbiddenException"},{"key":"X-Cache","value":"Error from cloudfront"},{"key":"Via","value":"1.1 532bae2476fbb28a84cd6a0ce4a429b8.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"BNE50-P1"},{"key":"X-Amz-Cf-Id","value":"hknA2RSL7EwexwQqEiSOMhOYClDfpbmwlOpjEykB0HAj1M1Tja6RSg=="}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Forbidden\"\n}"},{"id":"d2661764-492b-48b5-b510-2df81222e8c0","name":"404: Invalid Care Recipient ID","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"{{API_KEY}}","type":"text"}],"url":{"raw":"{{BASE_URL}}/api/v2/careRecipients/:careRecipientId/medicalOfficerDetails","host":["{{BASE_URL}}"],"path":["api","v2","careRecipients",":careRecipientId","medicalOfficerDetails"],"variable":[{"key":"careRecipientId","value":"6f57349d-ebe1-460e-81f1-ce9c1778ee8b1"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"28"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Sun, 25 May 2025 11:30:03 GMT"},{"key":"X-Amzn-Trace-Id","value":"Root=1-6832ff39-3af9d88e7430c8296dbb0f72;Parent=6ad0770e760768cf;Sampled=0;Lineage=1:fbca7632:0"},{"key":"x-amzn-RequestId","value":"9cc5c442-b069-40d3-9d62-eda806122d23"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"LHzRHEvxSwMEgxA="},{"key":"X-Cache","value":"Error from cloudfront"},{"key":"Via","value":"1.1 9348b3d5d666c07df33489b432ed8cae.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"BNE50-P1"},{"key":"X-Amz-Cf-Id","value":"HBMZ547Qz5Uhsbn3D42Cj3WGWlBLOWUgaf3mBcpyfYyW45Dr01hAKQ=="}],"cookie":[],"responseTime":null,"body":"{\n \"error\": \"Record Not Found\"\n}"},{"id":"5a2880ba-5f6c-4993-9bf4-108db7d5ba07","name":"200: Success","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"{{API_KEY}}","type":"text"}],"url":{"raw":"{{BASE_URL}}/api/v2/careRecipients/:careRecipientId/medicalOfficerDetails","host":["{{BASE_URL}}"],"path":["api","v2","careRecipients",":careRecipientId","medicalOfficerDetails"],"variable":[{"key":"careRecipientId","value":"{{CARE_RECIPIENT_ID}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":null,"header":[{"key":"Date","value":"Tue, 07 Oct 2025 13:29:17 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"146"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"2755359b-b220-47ae-8193-91e7946214ae"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"SFBS6GjFywMEfew="},{"key":"X-Amzn-Trace-Id","value":"Root=1-68e515ab-6cd7991e16ef02ff2d1a5d1c;Parent=662a36f87b65ebaf;Sampled=0;Lineage=1:fbca7632:0"}],"cookie":[],"responseTime":null,"body":"{\n \"medicalOfficerDetails\": {\n \"emailAddress\": null,\n \"fax\": null,\n \"mobileNumber\": null,\n \"name\": null,\n \"phone\": null,\n \"practiceAddress\": null,\n \"practiceName\": null\n }\n}"}],"_postman_id":"383535cc-60ff-4eeb-8fc2-9605faf9afc3"},{"name":"Get Medicare and Insurance Details","id":"97aec106-dd31-4d79-9b3d-3bf72e4ef5c4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"client_authentication","value":""},{"key":"scope","value":"{{SCOPE}}"},{"key":"headerPrefix","value":""},{"key":"refreshTokenUrl","value":"{{AUTH_URL}}"},{"key":"accessTokenUrl","value":"{{AUTH_URL}}"},{"key":"clientSecret","value":"{{CLIENT_SECRET}}"},{"key":"clientId","value":"{{CLIENT_ID}}"},{"key":"tokenName","value":""},{"key":"grant_type","value":""},{"key":"password","value":"{{password}}"},{"key":"username","value":"{{username}}"}]},"isInherited":false},"method":"GET","header":[{"key":"x-api-key","value":"{{API_KEY}}","type":"text"}],"url":"{{BASE_URL}}/api/v2/careRecipients/:careRecipientId/medicareAndInsuranceDetails","description":"

📄 Endpoint Overview

This endpoint returns an object containing the Medicare and Insurance details of a specific Care Recipient.

The successful response includes the following:

medicareAndInsuranceDetails: An object that contains the Medicare and Insurance details

Response Schema

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Attribute	Type	Description
healthFundName	string	Name of the health fund. Can be null.
healthFundNumber	string	Membership or policy number associated with the health fund. Can be null.
medicareCardExpiry	string	Expiry date of the Medicare card (MM/YY). Can be null.
medicareNumber	string	Medicare number. Can be null.
medicarePositionOnCard	string	Position on the Medicare card. Can be null.

","urlObject":{"path":["api","v2","careRecipients",":careRecipientId","medicareAndInsuranceDetails"],"host":["{{BASE_URL}}"],"query":[],"variable":[{"type":"any","value":"{{CARE_RECIPIENT_ID}}","key":"careRecipientId"}]}},"response":[{"id":"13661a9e-0506-4484-9124-5962fb59f314","name":"401: Missing or Invalid Client ID or Secret or Scope","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"{{API_KEY}}","type":"text"}],"url":{"raw":"{{BASE_URL}}/api/v2/careRecipients/:careRecipientId/medicareAndInsuranceDetails","host":["{{BASE_URL}}"],"path":["api","v2","careRecipients",":careRecipientId","medicareAndInsuranceDetails"],"variable":[{"key":"careRecipientId","value":"6f57349d-ebe1-460e-81f1-ce9c1778ee8b"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"26"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Sun, 25 May 2025 10:45:03 GMT"},{"key":"x-amz-apigw-id","value":"LHsrcHexywMEcaA="},{"key":"x-amzn-RequestId","value":"05ef0976-d245-4960-83ad-a2cc69a098de"},{"key":"x-amzn-ErrorType","value":"UnauthorizedException"},{"key":"X-Cache","value":"Error from cloudfront"},{"key":"Via","value":"1.1 c2b0b14414d87fbf9985559b5d1be1b0.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"BNE50-P1"},{"key":"X-Amz-Cf-Id","value":"Mc3yErj1xsFi0maHUURZFJCXgtjn2KfEWEFRD9-QkguJWnn2R_8WmQ=="}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Unauthorized\"\n}"},{"id":"732e959d-eec9-422e-b53b-b719f78caf94","name":"403: Invalid API key","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"{{API_KEY}}1","type":"text"}],"url":{"raw":"{{BASE_URL}}/api/v2/careRecipients/:careRecipientId/medicareAndInsuranceDetails","host":["{{BASE_URL}}"],"path":["api","v2","careRecipients",":careRecipientId","medicareAndInsuranceDetails"],"variable":[{"key":"careRecipientId","value":"6f57349d-ebe1-460e-81f1-ce9c1778ee8b"}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"23"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Sun, 25 May 2025 10:58:21 GMT"},{"key":"x-amz-apigw-id","value":"LHuoJE_8ywMEnug="},{"key":"x-amzn-RequestId","value":"3bf006e0-0102-4650-8032-97e4c2b8e9a7"},{"key":"x-amzn-ErrorType","value":"ForbiddenException"},{"key":"X-Cache","value":"Error from cloudfront"},{"key":"Via","value":"1.1 532bae2476fbb28a84cd6a0ce4a429b8.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"BNE50-P1"},{"key":"X-Amz-Cf-Id","value":"DxkQfyCDPfNM61m8j1JCEVv6VrJ78paIVWVCsCRAbevLxX6ur45IHQ=="}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Forbidden\"\n}"},{"id":"15793f9c-9757-43d6-a902-f2084cd84e31","name":"404: Invalid Care Recipient ID","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"{{API_KEY}}","type":"text"}],"url":{"raw":"{{BASE_URL}}/api/v2/careRecipients/:careRecipientId/medicareAndInsuranceDetails","host":["{{BASE_URL}}"],"path":["api","v2","careRecipients",":careRecipientId","medicareAndInsuranceDetails"],"variable":[{"key":"careRecipientId","value":"6f57349d-ebe1-460e-81f1-ce9c1778ee8b1"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"28"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Sun, 25 May 2025 11:30:18 GMT"},{"key":"X-Amzn-Trace-Id","value":"Root=1-6832ff48-17d8200f0695049d5daa5823;Parent=3b8508627ccc19b0;Sampled=0;Lineage=1:2d99c1d3:0"},{"key":"x-amzn-RequestId","value":"8cfc3ec2-a96b-45bd-990d-168972cd49fd"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"LHzTcEwGSwMECDA="},{"key":"X-Cache","value":"Error from cloudfront"},{"key":"Via","value":"1.1 9348b3d5d666c07df33489b432ed8cae.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"BNE50-P1"},{"key":"X-Amz-Cf-Id","value":"Z1t_3F-8Qu_eVZNrEYbeY-8LOkcw1k04c8IPZa7zz4Sh8LMTNH8OJQ=="}],"cookie":[],"responseTime":null,"body":"{\n \"error\": \"Record Not Found\"\n}"},{"id":"fb11e559-3157-42c6-942e-783fc656215a","name":"200: Success","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"{{API_KEY}}","type":"text"}],"url":{"raw":"{{BASE_URL}}/api/v2/careRecipients/:careRecipientId/medicareAndInsuranceDetails","host":["{{BASE_URL}}"],"path":["api","v2","careRecipients",":careRecipientId","medicareAndInsuranceDetails"],"variable":[{"key":"careRecipientId","value":"{{CARE_RECIPIENT_ID}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":null,"header":[{"key":"Date","value":"Tue, 07 Oct 2025 13:30:54 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"170"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"91b0b7c9-40b8-4eea-b082-18bab3d4b7da"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"SFBiGGKqywMEvxA="},{"key":"X-Amzn-Trace-Id","value":"Root=1-68e5160d-07454313045ab07e2e3506fd;Parent=210e12b6c5a876ed;Sampled=0;Lineage=1:2d99c1d3:0"}],"cookie":[],"responseTime":null,"body":"{\n \"medicareAndInsuranceDetails\": {\n \"healthFundName\": \"N/A\",\n \"healthFundNumber\": null,\n \"medicareCardExpiry\": \"05/2028\",\n \"medicareNumber\": \"4067265684\",\n \"medicarePositionOnCard\": \"2\"\n }\n}"}],"_postman_id":"97aec106-dd31-4d79-9b3d-3bf72e4ef5c4"},{"name":"Get Pension and Benefits Details","id":"2b377c31-e397-435c-b70d-581ef8736684","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"client_authentication","value":""},{"key":"scope","value":"{{SCOPE}}"},{"key":"headerPrefix","value":""},{"key":"refreshTokenUrl","value":"{{AUTH_URL}}"},{"key":"accessTokenUrl","value":"{{AUTH_URL}}"},{"key":"clientSecret","value":"{{CLIENT_SECRET}}"},{"key":"clientId","value":"{{CLIENT_ID}}"},{"key":"tokenName","value":""},{"key":"grant_type","value":""},{"key":"password","value":"{{password}}"},{"key":"username","value":"{{username}}"}]},"isInherited":false},"method":"GET","header":[{"key":"x-api-key","value":"{{API_KEY}}","type":"text"}],"url":"{{BASE_URL}}/api/v2/careRecipients/:careRecipientId/pensionAndBenefitDetails","description":"

📄 Endpoint Overview

This endpoint returns an object containing the Pension and Benefits details of a specific Care Recipient.

The successful response includes the following:

pensionAndBenefitsDetails: An object that contains the Pension and Benefits details

Response Schema

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Attribute	Type	Description
ambulanceMembershipNumber	string	Ambulance membership number. Can be null.
concessionCardNumber	string	Concession card number. Can be null.
fullPensioner	boolean	Indicates full pensioner status. Can be null.
myHealthRecordNumber	string	My Health Record number. Can be null.
ndssNumber	string	National Diabetes Services Scheme (NDSS) number. Can be null.
nonPensioner	boolean	Indicates non-pensioner status. Can be null.
partPensioner	boolean	Indicates part-pensioner status. Can be null.
pensionNumber	string	Pension number. Can be null.

","urlObject":{"path":["api","v2","careRecipients",":careRecipientId","pensionAndBenefitDetails"],"host":["{{BASE_URL}}"],"query":[],"variable":[{"type":"any","value":"{{CARE_RECIPIENT_ID}}","key":"careRecipientId"}]}},"response":[{"id":"ae377c0f-c2ad-49bb-903c-c10ad2a8b62c","name":"401: Missing or Invalid Client ID or Secret or Scope","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"{{API_KEY}}","type":"text"}],"url":{"raw":"{{BASE_URL}}/api/v2/careRecipients/:careRecipientId/pensionAndBenefitDetails","host":["{{BASE_URL}}"],"path":["api","v2","careRecipients",":careRecipientId","pensionAndBenefitDetails"],"variable":[{"key":"careRecipientId","value":"6f57349d-ebe1-460e-81f1-ce9c1778ee8b"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"26"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Sun, 25 May 2025 10:45:23 GMT"},{"key":"x-amz-apigw-id","value":"LHsuoF8ZywMEHUQ="},{"key":"x-amzn-RequestId","value":"b93f5158-6547-4d67-b941-dfe30ed2a751"},{"key":"x-amzn-ErrorType","value":"UnauthorizedException"},{"key":"X-Cache","value":"Error from cloudfront"},{"key":"Via","value":"1.1 c2b0b14414d87fbf9985559b5d1be1b0.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"BNE50-P1"},{"key":"X-Amz-Cf-Id","value":"sgaKk-wkmKIYnTPKUuJWz7WvXnH3mv3gqFBsNKJs4IPywNPlDm2XZg=="}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Unauthorized\"\n}"},{"id":"28271958-8109-445c-befd-84f01871b4cd","name":"403: Invalid API key","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"{{API_KEY}}1","type":"text"}],"url":{"raw":"{{BASE_URL}}/api/v2/careRecipients/:careRecipientId/pensionAndBenefitDetails","host":["{{BASE_URL}}"],"path":["api","v2","careRecipients",":careRecipientId","pensionAndBenefitDetails"],"variable":[{"key":"careRecipientId","value":"6f57349d-ebe1-460e-81f1-ce9c1778ee8b"}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"23"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Sun, 25 May 2025 10:58:33 GMT"},{"key":"x-amz-apigw-id","value":"LHuqAH8jSwMEYpg="},{"key":"x-amzn-RequestId","value":"245830cd-b884-4783-9d84-0a31b539fac1"},{"key":"x-amzn-ErrorType","value":"ForbiddenException"},{"key":"X-Cache","value":"Error from cloudfront"},{"key":"Via","value":"1.1 532bae2476fbb28a84cd6a0ce4a429b8.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"BNE50-P1"},{"key":"X-Amz-Cf-Id","value":"7RgaPN9xyfnBuruVaSjenhN3psgT_06P4Bz4xwXcG0eaXFKQsqFfAw=="}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Forbidden\"\n}"},{"id":"a8299885-bfc9-4c62-b247-672f230471ee","name":"404: Invalid Care Recipient ID","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"{{API_KEY}}","type":"text"}],"url":{"raw":"{{BASE_URL}}/api/v2/careRecipients/:careRecipientId/pensionAndBenefitDetails","host":["{{BASE_URL}}"],"path":["api","v2","careRecipients",":careRecipientId","pensionAndBenefitDetails"],"variable":[{"key":"careRecipientId","value":"6f57349d-ebe1-460e-81f1-ce9c1778ee8b1"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"28"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Sun, 25 May 2025 11:30:31 GMT"},{"key":"X-Amzn-Trace-Id","value":"Root=1-6832ff56-3f103c222cf920af41229764;Parent=44f15890772cb9cd;Sampled=0;Lineage=1:1e7b2ac1:0"},{"key":"x-amzn-RequestId","value":"06a04f14-a326-45a0-8595-376eef019c1b"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"LHzVgHd7ywMEG2w="},{"key":"X-Cache","value":"Error from cloudfront"},{"key":"Via","value":"1.1 9348b3d5d666c07df33489b432ed8cae.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"BNE50-P1"},{"key":"X-Amz-Cf-Id","value":"BBfceWA9Mt5ru3DfsaTpfr5QeyOa0Lr7rJxTKpitFk0yxJeWFxJMag=="}],"cookie":[],"responseTime":null,"body":"{\n \"error\": \"Record Not Found\"\n}"},{"id":"6ef5a96b-4548-411d-87b5-1abd9abbf12f","name":"200: Success","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"{{API_KEY}}","type":"text"}],"url":{"raw":"{{BASE_URL}}/api/v2/careRecipients/:careRecipientId/pensionAndBenefitDetails","host":["{{BASE_URL}}"],"path":["api","v2","careRecipients",":careRecipientId","pensionAndBenefitDetails"],"variable":[{"key":"careRecipientId","value":"{{CARE_RECIPIENT_ID}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":null,"header":[{"key":"Date","value":"Tue, 07 Oct 2025 13:33:27 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"245"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"6d50c1d1-6041-45e3-939f-6729df6ae643"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"SFB56FFcywMEZXQ="},{"key":"X-Amzn-Trace-Id","value":"Root=1-68e516a5-39d92e7e066e37bf35d594d4;Parent=1c9741b70d962c01;Sampled=0;Lineage=1:1e7b2ac1:0"}],"cookie":[],"responseTime":null,"body":"{\n \"pensionAndBenefitsDetails\": {\n \"ambulanceMembershipNumber\": null,\n \"concessionCardNumber\": null,\n \"fullPensioner\": null,\n \"myHealthRecordNumber\": null,\n \"ndssNumber\": null,\n \"nonPensioner\": null,\n \"partPensioner\": null,\n \"pensionNumber\": \"QXI65455A\",\n \"dvaNumber\": null\n }\n}"}],"_postman_id":"2b377c31-e397-435c-b70d-581ef8736684"},{"name":"Get Personal Details","id":"6b498170-db31-4790-869a-9cbe53fc6f9a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"client_authentication","value":""},{"key":"scope","value":"{{SCOPE}}"},{"key":"headerPrefix","value":""},{"key":"refreshTokenUrl","value":"{{AUTH_URL}}"},{"key":"accessTokenUrl","value":"{{AUTH_URL}}"},{"key":"clientSecret","value":"{{CLIENT_SECRET}}"},{"key":"clientId","value":"{{CLIENT_ID}}"},{"key":"tokenName","value":""},{"key":"grant_type","value":""},{"key":"password","value":"{{password}}"},{"key":"username","value":"{{username}}"}]},"isInherited":false},"method":"GET","header":[{"key":"x-api-key","value":"{{API_KEY}}","type":"text"}],"url":"{{BASE_URL}}/api/v2/careRecipients/:careRecipientId/personalDetails","description":"

📄 Endpoint Overview

This endpoint returns an object containing the Personal details of a specific Care Recipient.

The successful response includes the following:

personalDetails: An object that contains the Personal details

Response Schema

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Attribute	Type	Description
address	string	Residential address. Can be null.
countryOfBirth	string	Country where the person was born. Can be null.
emailAddress	string	Email address. Can be null.
firstLanguage	string	First language spoken. Can be null.
hasInterpreter	boolean	Whether an interpreter is required. Can be null.
hasPacemaker	boolean	Whether the person has a pacemaker. Can be null.
identifyAs	string	Self-identified cultural background (e.g., Aboriginal). Can be null.
interpreterName	string	Name of the interpreter. Can be null.
interpreterOtherDetails	string	Additional interpreter-related details. Can be null.
interpreterPhone	string	Phone number of the interpreter. Can be null.
maritalStatus	string	Marital status (e.g., Single, Married). Can be null.
practicingReligion	boolean	Whether the person practices a religion. Can be null.
preferredLanguage	string	Preferred spoken language(s). Can be null.
religion	string	Religion. Can be null.
residentPhone	string	Phone number of the care recipient. Can be null.

","urlObject":{"path":["api","v2","careRecipients",":careRecipientId","personalDetails"],"host":["{{BASE_URL}}"],"query":[],"variable":[{"type":"any","value":"{{CARE_RECIPIENT_ID}}","key":"careRecipientId"}]}},"response":[{"id":"09291dfb-9e1c-45bc-b303-6d1a37563f00","name":"401: Missing or Invalid Client ID or Secret or Scope","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"{{API_KEY}}","type":"text"}],"url":{"raw":"{{BASE_URL}}/api/v2/careRecipients/:careRecipientId/personalDetails","host":["{{BASE_URL}}"],"path":["api","v2","careRecipients",":careRecipientId","personalDetails"],"variable":[{"key":"careRecipientId","value":"6f57349d-ebe1-460e-81f1-ce9c1778ee8b"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"26"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Sun, 25 May 2025 10:46:05 GMT"},{"key":"x-amz-apigw-id","value":"LHs1IG_YywMENxQ="},{"key":"x-amzn-RequestId","value":"053701aa-258c-4b3c-99ae-cd1c4fd290a7"},{"key":"x-amzn-ErrorType","value":"UnauthorizedException"},{"key":"X-Cache","value":"Error from cloudfront"},{"key":"Via","value":"1.1 c2b0b14414d87fbf9985559b5d1be1b0.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"BNE50-P1"},{"key":"X-Amz-Cf-Id","value":"ieYSnFsaGiWvs1ZzGORxrHsdb-FKn1fhi8GUgbDeaX2lAF8PVAT9qQ=="}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Unauthorized\"\n}"},{"id":"6495642f-82b2-4298-94a8-a8e5f6923463","name":"403: Invalid API key","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"{{API_KEY}}1","type":"text"}],"url":{"raw":"{{BASE_URL}}/api/v2/careRecipients/:careRecipientId/personalDetails","host":["{{BASE_URL}}"],"path":["api","v2","careRecipients",":careRecipientId","personalDetails"],"variable":[{"key":"careRecipientId","value":"6f57349d-ebe1-460e-81f1-ce9c1778ee8b"}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"23"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Sun, 25 May 2025 10:59:20 GMT"},{"key":"x-amz-apigw-id","value":"LHuxYE4nSwMEOdg="},{"key":"x-amzn-RequestId","value":"be9cd99d-00aa-46b2-b87f-d76f30b7afd8"},{"key":"x-amzn-ErrorType","value":"ForbiddenException"},{"key":"X-Cache","value":"Error from cloudfront"},{"key":"Via","value":"1.1 532bae2476fbb28a84cd6a0ce4a429b8.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"BNE50-P1"},{"key":"X-Amz-Cf-Id","value":"gGaY0u9-156-DVnQx0_u5Ni2gSWjdmU86Tvh7rnvqJSjCpQk8pBf1Q=="}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Forbidden\"\n}"},{"id":"6a823e5e-7a0a-485a-afe9-77b8268c9e46","name":"404: Invalid Care Recipient ID","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"{{API_KEY}}","type":"text"}],"url":{"raw":"{{BASE_URL}}/api/v2/careRecipients/:careRecipientId/personalDetails","host":["{{BASE_URL}}"],"path":["api","v2","careRecipients",":careRecipientId","personalDetails"],"variable":[{"key":"careRecipientId","value":"6f57349d-ebe1-460e-81f1-ce9c1778ee8b1"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"28"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Sun, 25 May 2025 11:31:02 GMT"},{"key":"X-Amzn-Trace-Id","value":"Root=1-6832ff74-02b7016016403e0120f74f5d;Parent=279efff2e53fc438;Sampled=0;Lineage=1:d278ef2c:0"},{"key":"x-amzn-RequestId","value":"99dd95e2-c21b-4a4b-8bb6-72d5e0c7aca7"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"LHzaUFuJywMEZzQ="},{"key":"X-Cache","value":"Error from cloudfront"},{"key":"Via","value":"1.1 9348b3d5d666c07df33489b432ed8cae.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"BNE50-P1"},{"key":"X-Amz-Cf-Id","value":"vwc4QXjStOQZkdQykoaJse-BRjBy3yeh7wKpd5LjzozzshUTelkGHA=="}],"cookie":[],"responseTime":null,"body":"{\n \"error\": \"Record Not Found\"\n}"},{"id":"2e321539-fda8-4bbd-81d8-eb91091e37fc","name":"200: Success","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"{{API_KEY}}","type":"text"}],"url":{"raw":"{{BASE_URL}}/api/v2/careRecipients/:careRecipientId/personalDetails","host":["{{BASE_URL}}"],"path":["api","v2","careRecipients",":careRecipientId","personalDetails"],"variable":[{"key":"careRecipientId","value":"{{CARE_RECIPIENT_ID}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":null,"header":[{"key":"Date","value":"Tue, 07 Oct 2025 13:34:44 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"444"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"38824524-b037-43b0-82a8-d3b4c7f52951"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"SFCF-GdcSwMEaxA="},{"key":"X-Amzn-Trace-Id","value":"Root=1-68e516f2-0eeb91e9645fbb62212a298a;Parent=054ac31dd055b528;Sampled=0;Lineage=1:d278ef2c:0"}],"cookie":[],"responseTime":null,"body":"{\n \"personalDetails\": {\n \"address\": \"2760 Cox Pass, Kundeview, NSW 7714\",\n \"countryOfBirth\": \"Greece\",\n \"emailAddress\": \"ronnie@kertzmann.net\",\n \"firstLanguage\": \"Greek\",\n \"hasInterpreter\": true,\n \"hasPacemaker\": null,\n \"identifyAs\": \"N/A\",\n \"interpreterName\": null,\n \"interpreterOtherDetails\": null,\n \"interpreterPhone\": null,\n \"maritalStatus\": \"Widowed\",\n \"practicingReligion\": null,\n \"preferredLanguage\": \"Greek\",\n \"religion\": \"Eastern Orthodox (Greek)\",\n \"residentPhone\": \"07 8556 2306\"\n }\n}"}],"_postman_id":"6b498170-db31-4790-869a-9cbe53fc6f9a"},{"name":"Get Allergies","id":"fc1c58fd-137e-458a-8f95-719d1f178474","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"client_authentication","value":""},{"key":"scope","value":"{{SCOPE}}"},{"key":"headerPrefix","value":""},{"key":"refreshTokenUrl","value":"{{AUTH_URL}}"},{"key":"accessTokenUrl","value":"{{AUTH_URL}}"},{"key":"clientSecret","value":"{{CLIENT_SECRET}}"},{"key":"clientId","value":"{{CLIENT_ID}}"},{"key":"tokenName","value":""},{"key":"grant_type","value":""},{"key":"password","value":"{{password}}"},{"key":"username","value":"{{username}}"}]},"isInherited":false},"method":"GET","header":[{"key":"x-api-key","value":"{{API_KEY}}","type":"text"}],"url":"{{BASE_URL}}/api/v2/careRecipients/:careRecipientId/allergies","description":"

📄 Endpoint Overview

This endpoint returns an object containing all the Allergies of a specific Care Recipient.

The successful response includes the following:

foodAllergies: A string that contains the Food Allergies
\n
otherAllergies: A string that contains other Allergies
\n

Response Schema

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Attribute	Type	Description
foodAllergies	string	Comma-separated list of food allergies. Can be null.
otherAllergies	string	Comma-separated list of other allergies. Can be null.

","urlObject":{"path":["api","v2","careRecipients",":careRecipientId","allergies"],"host":["{{BASE_URL}}"],"query":[],"variable":[{"type":"any","value":"{{CARE_RECIPIENT_ID}}","key":"careRecipientId"}]}},"response":[{"id":"b6855ef6-7ba2-417d-bc1f-28f7403f1723","name":"401: Missing or Invalid Client ID or Secret or Scope","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"{{API_KEY}}","type":"text"}],"url":{"raw":"{{BASE_URL}}/api/v2/careRecipients/:careRecipientId/allergies","host":["{{BASE_URL}}"],"path":["api","v2","careRecipients",":careRecipientId","allergies"],"variable":[{"key":"careRecipientId","value":"6f57349d-ebe1-460e-81f1-ce9c1778ee8b"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"26"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Sun, 25 May 2025 10:46:26 GMT"},{"key":"x-amz-apigw-id","value":"LHs4hFYQSwMERnw="},{"key":"x-amzn-RequestId","value":"154b749e-6411-4a22-8fdd-34af6b4ce508"},{"key":"x-amzn-ErrorType","value":"UnauthorizedException"},{"key":"X-Cache","value":"Error from cloudfront"},{"key":"Via","value":"1.1 c2b0b14414d87fbf9985559b5d1be1b0.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"BNE50-P1"},{"key":"X-Amz-Cf-Id","value":"jDjfbxglpP-9V1SOVc6pUdKQC8rPNitDZ-wVgfe3gCKBIPfBDIwPgA=="}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Unauthorized\"\n}"},{"id":"85b57957-cf6c-449c-a46f-3b3d5eb07874","name":"403: Invalid API key","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"{{API_KEY}}1","type":"text"}],"url":{"raw":"{{BASE_URL}}/api/v2/careRecipients/:careRecipientId/allergies","host":["{{BASE_URL}}"],"path":["api","v2","careRecipients",":careRecipientId","allergies"],"variable":[{"key":"careRecipientId","value":"6f57349d-ebe1-460e-81f1-ce9c1778ee8b"}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"23"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Sun, 25 May 2025 10:59:52 GMT"},{"key":"x-amz-apigw-id","value":"LHu2VH4FSwMEpQw="},{"key":"x-amzn-RequestId","value":"fea61972-df9b-4814-ac91-b6fafcf789d5"},{"key":"x-amzn-ErrorType","value":"ForbiddenException"},{"key":"X-Cache","value":"Error from cloudfront"},{"key":"Via","value":"1.1 532bae2476fbb28a84cd6a0ce4a429b8.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"BNE50-P1"},{"key":"X-Amz-Cf-Id","value":"WmKDTKqCt5PK5jw6JzWKxo-POnqzSXK4Cqz4Tc_hgu8YV-9naDLk8A=="}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Forbidden\"\n}"},{"id":"b24075a7-cd15-4d90-b1d7-a31535230cc1","name":"404: Invalid Care Recipient ID","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"{{API_KEY}}","type":"text"}],"url":{"raw":"{{BASE_URL}}/api/v2/careRecipients/:careRecipientId/allergies","host":["{{BASE_URL}}"],"path":["api","v2","careRecipients",":careRecipientId","allergies"],"variable":[{"key":"careRecipientId","value":"6f57349d-ebe1-460e-81f1-ce9c1778ee8b1"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"28"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Sun, 25 May 2025 11:31:20 GMT"},{"key":"X-Amzn-Trace-Id","value":"Root=1-6832ff86-2620b2b74f1ec5f3242c88a3;Parent=774179545f3788de;Sampled=0;Lineage=1:0cd14599:0"},{"key":"x-amzn-RequestId","value":"e368329d-dd50-4c95-b57d-6b87f28a2e52"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"LHzdDFppSwMEWtA="},{"key":"X-Cache","value":"Error from cloudfront"},{"key":"Via","value":"1.1 9348b3d5d666c07df33489b432ed8cae.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"BNE50-P1"},{"key":"X-Amz-Cf-Id","value":"r0AeiUVhntPTKT9sEn4rGpxx6GhDtg2miyNe6f1Z-GT0Q_6RY2_ecg=="}],"cookie":[],"responseTime":null,"body":"{\n \"error\": \"Record Not Found\"\n}"},{"id":"b02d22dd-6ab8-4f00-9085-6bb5b0620bd8","name":"200: Success","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"{{API_KEY}}","type":"text"}],"url":{"raw":"{{BASE_URL}}/api/v2/careRecipients/:careRecipientId/allergies","host":["{{BASE_URL}}"],"path":["api","v2","careRecipients",":careRecipientId","allergies"],"variable":[{"key":"careRecipientId","value":"{{CARE_RECIPIENT_ID}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":null,"header":[{"key":"Date","value":"Tue, 07 Oct 2025 13:36:19 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"42"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"0150299f-2155-4ea8-b1e5-893230d591c0"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"SFCU1GsfSwMEZQg="},{"key":"X-Amzn-Trace-Id","value":"Root=1-68e51751-04f152a72daa044157418ef0;Parent=78141f192e5874e2;Sampled=0;Lineage=1:0cd14599:0"}],"cookie":[],"responseTime":null,"body":"{\n \"foodAllergies\": \"\",\n \"otherAllergies\": null\n}"}],"_postman_id":"fc1c58fd-137e-458a-8f95-719d1f178474"},{"name":"Get Contacts","id":"d469d207-4a44-49aa-9cf1-4e4ea60eac2a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"client_authentication","value":""},{"key":"scope","value":"{{SCOPE}}"},{"key":"headerPrefix","value":""},{"key":"refreshTokenUrl","value":"{{AUTH_URL}}"},{"key":"accessTokenUrl","value":"{{AUTH_URL}}"},{"key":"clientSecret","value":"{{CLIENT_SECRET}}"},{"key":"clientId","value":"{{CLIENT_ID}}"},{"key":"tokenName","value":""},{"key":"grant_type","value":""},{"key":"password","value":"{{password}}"},{"key":"username","value":"{{username}}"}]},"isInherited":false},"method":"GET","header":[{"key":"x-api-key","value":"{{API_KEY}}","type":"text"}],"url":"{{BASE_URL}}/api/v2/careRecipients/:careRecipientId/contactsDetails","description":"

📄 Endpoint Overview

This endpoint returns a list/array of all the Contacts that are assigned to a specific Care Recipient.

The successful response includes the following:

contactsDetails: A list of all Contacts

Response Schema

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Attribute	Type	Description
address	string	Contact’s address. Can be null.
courtOrder	boolean	Indicates if a court order applies to this contact. Can be null.
emailAddress	string	Email address of the contact. Can be null.
mobileNumber	string	Mobile number. Can be null.
name	string	Full name of the contact.
notifyToUpdate	boolean	Whether this contact should be notified of updates. Can be null.
phoneNumber	string	Landline or secondary phone number. Can be null.
relationship	string	Relationship to the care recipient. Can be null.

","urlObject":{"path":["api","v2","careRecipients",":careRecipientId","contactsDetails"],"host":["{{BASE_URL}}"],"query":[],"variable":[{"type":"any","value":"{{CARE_RECIPIENT_ID}}","key":"careRecipientId"}]}},"response":[{"id":"f59f60a0-7800-4828-a885-d44b9e900902","name":"401: Missing or Invalid Client ID or Secret or Scope","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"{{API_KEY}}","type":"text"}],"url":{"raw":"{{BASE_URL}}/api/v2/careRecipients/:careRecipientId/contactsDetails","host":["{{BASE_URL}}"],"path":["api","v2","careRecipients",":careRecipientId","contactsDetails"],"variable":[{"key":"careRecipientId","value":"6f57349d-ebe1-460e-81f1-ce9c1778ee8b"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"26"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Sun, 25 May 2025 10:46:50 GMT"},{"key":"x-amz-apigw-id","value":"LHs8QEhxywMEk4A="},{"key":"x-amzn-RequestId","value":"4425ffb0-9cc7-4f2c-9abe-1d0730f57209"},{"key":"x-amzn-ErrorType","value":"UnauthorizedException"},{"key":"X-Cache","value":"Error from cloudfront"},{"key":"Via","value":"1.1 c2b0b14414d87fbf9985559b5d1be1b0.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"BNE50-P1"},{"key":"X-Amz-Cf-Id","value":"60bCvxYIgobIpoAn6zXdSuIKwA5SY-67Et_uFBY-VNYumXkCV087Sg=="}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Unauthorized\"\n}"},{"id":"72a39d40-ffa7-4696-bf00-983d1b96959f","name":"403: Invalid API key","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"{{API_KEY}}1","type":"text"}],"url":{"raw":"{{BASE_URL}}/api/v2/careRecipients/:careRecipientId/contactsDetails","host":["{{BASE_URL}}"],"path":["api","v2","careRecipients",":careRecipientId","contactsDetails"],"variable":[{"key":"careRecipientId","value":"6f57349d-ebe1-460e-81f1-ce9c1778ee8b"}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"23"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Sun, 25 May 2025 11:00:03 GMT"},{"key":"x-amz-apigw-id","value":"LHu4IG0dSwMEVmg="},{"key":"x-amzn-RequestId","value":"2f144c6d-8db8-4605-9df4-2dac023370fa"},{"key":"x-amzn-ErrorType","value":"ForbiddenException"},{"key":"X-Cache","value":"Error from cloudfront"},{"key":"Via","value":"1.1 532bae2476fbb28a84cd6a0ce4a429b8.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"BNE50-P1"},{"key":"X-Amz-Cf-Id","value":"kHL9LjQigmFrCBnqAAr1s0faYNltxMJbAcJARniSuDJPj-KjrTVrjg=="}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Forbidden\"\n}"},{"id":"5a556aa8-2c5a-4dc4-886d-e026e173a707","name":"404: Invalid Care Recipient ID","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"{{API_KEY}}","type":"text"}],"url":{"raw":"{{BASE_URL}}/api/v2/careRecipients/:careRecipientId/contactsDetails","host":["{{BASE_URL}}"],"path":["api","v2","careRecipients",":careRecipientId","contactsDetails"],"variable":[{"key":"careRecipientId","value":"6f57349d-ebe1-460e-81f1-ce9c1778ee8b1"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"28"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Sun, 25 May 2025 11:31:37 GMT"},{"key":"X-Amzn-Trace-Id","value":"Root=1-6832ff97-00ccc31a2013e1636fec8cdf;Parent=6cd04618d79c6178;Sampled=0;Lineage=1:58347917:0"},{"key":"x-amzn-RequestId","value":"63858e00-4697-49bd-9d0e-f1786630a485"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"LHzftH5dywMEp2Q="},{"key":"X-Cache","value":"Error from cloudfront"},{"key":"Via","value":"1.1 9348b3d5d666c07df33489b432ed8cae.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"BNE50-P1"},{"key":"X-Amz-Cf-Id","value":"C11s8B2iOwCkuIdU9IMdWtZemSrOydefPnVuElvpNDlRdaqw6NIXKw=="}],"cookie":[],"responseTime":null,"body":"{\n \"error\": \"Record Not Found\"\n}"},{"id":"a2baa59e-65a2-4f61-bbcb-61aa11a8bed8","name":"200: Success","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"{{API_KEY}}","type":"text"}],"url":{"raw":"{{BASE_URL}}/api/v2/careRecipients/:careRecipientId/contactsDetails","host":["{{BASE_URL}}"],"path":["api","v2","careRecipients",":careRecipientId","contactsDetails"],"variable":[{"key":"careRecipientId","value":"{{CARE_RECIPIENT_ID}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":null,"header":[{"key":"Date","value":"Tue, 07 Oct 2025 13:37:26 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"257"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"17d17266-4e1a-45d8-8b24-2df5ee9af57f"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"SFCfVGBiywMEDsA="},{"key":"X-Amzn-Trace-Id","value":"Root=1-68e51794-331b6c6d4872cd9f5de08fbe;Parent=78f4d0da5a640f89;Sampled=0;Lineage=1:58347917:0"}],"cookie":[],"responseTime":null,"body":"{\n \"contactsDetails\": [\n {\n \"address\": \"3457 Rees Avenue, Laylatown, NT 5608\",\n \"courtOrder\": false,\n \"emailAddress\": \"loida@ornblick.biz\",\n \"mobileNumber\": \"0472 66 25 90\",\n \"name\": \"Ms. Isaac Cole\",\n \"notifyToUpdate\": false,\n \"phoneNumber\": \"+61 2 9518 4769\",\n \"relationship\": null\n }\n ]\n}"}],"_postman_id":"d469d207-4a44-49aa-9cf1-4e4ea60eac2a"},{"name":"Get Allied Health Details","id":"0aefb7d5-c815-4f7e-8dd3-b351dbe1ddee","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"client_authentication","value":""},{"key":"scope","value":"{{SCOPE}}"},{"key":"headerPrefix","value":""},{"key":"refreshTokenUrl","value":"{{AUTH_URL}}"},{"key":"accessTokenUrl","value":"{{AUTH_URL}}"},{"key":"clientSecret","value":"{{CLIENT_SECRET}}"},{"key":"clientId","value":"{{CLIENT_ID}}"},{"key":"tokenName","value":""},{"key":"grant_type","value":""},{"key":"password","value":"{{password}}"},{"key":"username","value":"{{username}}"}]},"isInherited":false},"method":"GET","header":[{"key":"x-api-key","value":"{{API_KEY}}","type":"text"}],"url":"{{BASE_URL}}/api/v2/careRecipients/:careRecipientId/alliedHealthDetails","description":"

📄 Endpoint Overview

This endpoint returns an object containing the Allied Health details of a specific Care Recipient.

The successful response includes the following:

alliedHealthDetails: An object that contains the Allied Health details

Response Schema

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Attribute	Type	Description
emailAddress	string	Email address of the allied health contact. Can be null.
mobileNumber	string	Mobile number of the allied health contact. Can be null.

","urlObject":{"path":["api","v2","careRecipients",":careRecipientId","alliedHealthDetails"],"host":["{{BASE_URL}}"],"query":[],"variable":[{"type":"any","value":"{{CARE_RECIPIENT_ID}}","key":"careRecipientId"}]}},"response":[{"id":"55b8482e-b9bf-4acd-9e7d-f092477eebb5","name":"200: Success","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"{{API_KEY}}","type":"text"}],"url":{"raw":"{{BASE_URL}}/api/v2/careRecipients/:careRecipientId/alliedHealthDetails","host":["{{BASE_URL}}"],"path":["api","v2","careRecipients",":careRecipientId","alliedHealthDetails"],"variable":[{"key":"careRecipientId","value":"6f57349d-ebe1-460e-81f1-ce9c1778ee8b"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"91"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Sun, 25 May 2025 10:40:50 GMT"},{"key":"X-Amzn-Trace-Id","value":"Root=1-6832f3b0-524ab3832500fa72347b0d3c;Parent=206f7998c7108b0f;Sampled=0;Lineage=1:1ea2f774:0"},{"key":"x-amzn-RequestId","value":"dc360fc1-4c5a-41cc-ab50-9918dd197cab"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"LHsDsGWQSwMEKHQ="},{"key":"X-Cache","value":"Miss from cloudfront"},{"key":"Via","value":"1.1 c2b0b14414d87fbf9985559b5d1be1b0.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"BNE50-P1"},{"key":"X-Amz-Cf-Id","value":"gxgO8qGwNFJyqvzJskd0Jm199oAbhMkXal13tar04YuHh3VAQu32vg=="}],"cookie":[],"responseTime":null,"body":"{\n \"alliedHealthDetails\": {\n \"emailAddress\": \"allied@example.org\",\n \"mobileNumber\": \"+61456778894\"\n }\n}"},{"id":"c269fa99-c6fc-43be-9a62-14c6be572727","name":"401: Missing or Invalid Client ID or Secret or Scope","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"{{API_KEY}}","type":"text"}],"url":{"raw":"{{BASE_URL}}/api/v2/careRecipients/:careRecipientId/alliedHealthDetails","host":["{{BASE_URL}}"],"path":["api","v2","careRecipients",":careRecipientId","alliedHealthDetails"],"variable":[{"key":"careRecipientId","value":"6f57349d-ebe1-460e-81f1-ce9c1778ee8b"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"26"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Sun, 25 May 2025 10:47:10 GMT"},{"key":"x-amz-apigw-id","value":"LHs_ZEJxywMEl_w="},{"key":"x-amzn-RequestId","value":"766027df-fc5d-402d-b85f-da59431f1249"},{"key":"x-amzn-ErrorType","value":"UnauthorizedException"},{"key":"X-Cache","value":"Error from cloudfront"},{"key":"Via","value":"1.1 c2b0b14414d87fbf9985559b5d1be1b0.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"BNE50-P1"},{"key":"X-Amz-Cf-Id","value":"cOgRf-ey_lBd6BCOZ5zH2EQys9tVra2VhR__rGOCDb-xV5M8VXyJPQ=="}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Unauthorized\"\n}"},{"id":"b0e5df11-ac64-4fac-828f-fa0182a57c84","name":"403: Invalid API key","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"{{API_KEY}}1","type":"text"}],"url":{"raw":"{{BASE_URL}}/api/v2/careRecipients/:careRecipientId/alliedHealthDetails","host":["{{BASE_URL}}"],"path":["api","v2","careRecipients",":careRecipientId","alliedHealthDetails"],"variable":[{"key":"careRecipientId","value":"6f57349d-ebe1-460e-81f1-ce9c1778ee8b"}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"23"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Sun, 25 May 2025 11:00:15 GMT"},{"key":"x-amz-apigw-id","value":"LHu56FiUSwMEHGg="},{"key":"x-amzn-RequestId","value":"926656d1-ff3b-436a-b620-dfbaca429e72"},{"key":"x-amzn-ErrorType","value":"ForbiddenException"},{"key":"X-Cache","value":"Error from cloudfront"},{"key":"Via","value":"1.1 532bae2476fbb28a84cd6a0ce4a429b8.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"BNE50-P1"},{"key":"X-Amz-Cf-Id","value":"QXU84ZvzRz1YbpltNxkrwje3lK2O36OeqmwTeGLWhxonhY3I-tzUOg=="}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Forbidden\"\n}"},{"id":"e3e593ef-2be4-4d58-b719-116b933ad47d","name":"404: Invalid Care Recipient ID","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"{{API_KEY}}","type":"text"}],"url":{"raw":"{{BASE_URL}}/api/v2/careRecipients/:careRecipientId/alliedHealthDetails","host":["{{BASE_URL}}"],"path":["api","v2","careRecipients",":careRecipientId","alliedHealthDetails"],"variable":[{"key":"careRecipientId","value":"6f57349d-ebe1-460e-81f1-ce9c1778ee8b1"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"28"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Sun, 25 May 2025 11:31:52 GMT"},{"key":"X-Amzn-Trace-Id","value":"Root=1-6832ffa6-4540fee812d4efc4153c0785;Parent=30d3ea170177c107;Sampled=0;Lineage=1:1ea2f774:0"},{"key":"x-amzn-RequestId","value":"f376f834-218e-4704-ad10-e7577f98c408"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"LHziEHFuSwMEgpg="},{"key":"X-Cache","value":"Error from cloudfront"},{"key":"Via","value":"1.1 9348b3d5d666c07df33489b432ed8cae.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"BNE50-P1"},{"key":"X-Amz-Cf-Id","value":"K6IKRJSDbrb4e5qEApPGi1WgvdASGAjDPwHm4Vbdf-5mXY-6Uyp7Xw=="}],"cookie":[],"responseTime":null,"body":"{\n \"error\": \"Record Not Found\"\n}"}],"_postman_id":"0aefb7d5-c815-4f7e-8dd3-b351dbe1ddee"},{"name":"Get Observations","id":"6a15cca6-8cf4-494e-9e8b-375fcd148c2e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"client_authentication","value":""},{"key":"scope","value":"{{SCOPE}}"},{"key":"headerPrefix","value":""},{"key":"refreshTokenUrl","value":"{{AUTH_URL}}"},{"key":"accessTokenUrl","value":"{{AUTH_URL}}"},{"key":"clientSecret","value":"{{CLIENT_SECRET}}"},{"key":"clientId","value":"{{CLIENT_ID}}"},{"key":"tokenName","value":""},{"key":"grant_type","value":""},{"key":"password","value":"{{password}}"},{"key":"username","value":"{{username}}"}]},"isInherited":false},"method":"GET","header":[{"key":"x-api-key","value":"{{API_KEY}}","type":"text"}],"url":"{{BASE_URL}}/api/v2/careRecipients/:careRecipientId/observations?page=1","description":"

📄 Endpoint Overview

This endpoint returns a paginated list/array of Observations for a specific Care Recipient, with a maximum of 10 records per page.

A mandatory query parameter named page must be provided. To retrieve the initial set of results, set page=1.

The successful response includes pagination metadata such as:

observations: A paginated list of Observations (max 10 records)
\n
totalPages: Total number of pages available
\n
currentPage: Current page number returned
\n
totalRecords: Total number of Observation records in the system
\n

Response Schema

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Attribute	Type	Description
bloodSugar	string	Blood sugar value with unit (e.g., “6 mmol/L”). Can be null.
bpDia	string	Diastolic blood pressure (e.g., “2 mmHG”). Can be null.
bpSys	string	Systolic blood pressure (e.g., “1 mmHG”). Can be null.
createdOn	datetime	Timestamp when the observation was created.
exceptionalObservation	object	Contains additional clinical assessments. Can be null.
id	integer	Observation record ID.
lastUpdatedOn	datetime	Timestamp of last update.
observationDateAndTime	datetime	Entry date/time of the observation. Can be null.
oxygenSaturation	string	Oxygen saturation level. Can be null.
onDiet	boolean	Indicates if the care recipient is on a diet.
pulse	string	Heart rate (e.g., “72 bpm”). Can be null.
refusedObservation	boolean	Indicates if the observation was refused. Can be null.
respiration	string	Respiration rate (e.g., “18 rpm”). Can be null.
temperature	string	Temperature (e.g., “36.5 °C”). Can be null.
urinalysis	object	Contains urinalysis results. Can be null.
weight	string	Weight (e.g., “60 kg”). Can be null.

Sub-object: observations[].exceptionalObservation

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Attribute	Type	Description
createdOn	datetime	Timestamp when the exceptional observation was created.
gcs	string	Glasgow Coma Scale details. Can be null.
lastUpdatedOn	datetime	Timestamp of last update.
limbStrength	string	Limb strength assessment details. Can be null.
lyingAndStandingBloodPressure	string	Lying and standing blood pressure details. Can be null.
pupilReaction	string	Pupil reaction details. Can be null.

Sub-object: observations[].urinalysis

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Attribute	Type	Description
bilirubin	string	Bilirubin result. Can be null.
blood	string	Presence of blood in urine. Can be null.
createdOn	datetime	Timestamp when the urinalysis record was created.
glucose	string	Glucose result. Can be null.
ketones	string	Ketones result. Can be null.
lastUpdatedOn	datetime	Timestamp when the urinalysis record was last updated.
leukocytes	string	Leukocytes result. Can be null.
nitrites	string	Nitrites result. Can be null.
performedDate	date	Date the urinalysis was performed. Can be null.
ph	string	pH level (e.g., “7 pH”). Can be null.
protein	string	Protein result. Can be null.
specificGravity	string	Specific gravity (e.g., “10 SG”). Can be null.
urobilinogen	string	Urobilinogen result. Can be null.

","urlObject":{"path":["api","v2","careRecipients",":careRecipientId","observations"],"host":["{{BASE_URL}}"],"query":[{"key":"page","value":"1"}],"variable":[{"type":"any","value":"{{CARE_RECIPIENT_ID}}","key":"careRecipientId"}]}},"response":[{"id":"8107f677-388a-4288-a399-fdf3587b9856","name":"200: Success","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"{{API_KEY}}","type":"text"}],"url":{"raw":"{{BASE_URL}}/api/v2/careRecipients/:careRecipientId/observations?page=1","host":["{{BASE_URL}}"],"path":["api","v2","careRecipients",":careRecipientId","observations"],"query":[{"key":"page","value":"1"}],"variable":[{"key":"careRecipientId","value":"6f57349d-ebe1-460e-81f1-ce9c1778ee8b"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"1687"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Sun, 25 May 2025 10:41:07 GMT"},{"key":"X-Amzn-Trace-Id","value":"Root=1-6832f3c0-11627bf51b8c5c88644b1cb7;Parent=206734b30e530727;Sampled=0;Lineage=1:99c474ef:0"},{"key":"x-amzn-RequestId","value":"45f7129f-18e2-4362-8800-d633da2c1c2a"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"LHsGNGymSwMEZvg="},{"key":"X-Cache","value":"Miss from cloudfront"},{"key":"Via","value":"1.1 c2b0b14414d87fbf9985559b5d1be1b0.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"BNE50-P1"},{"key":"X-Amz-Cf-Id","value":"_Z9qLWOux1qHoeNgw4qHeEsDX-gL6uyFuJri3vc9-icFz6g7lpXqew=="}],"cookie":[],"responseTime":null,"body":"{\n \"observations\": [\n {\n \"bloodSugar\": \"6 mmol/L\",\n \"bpDia\": \"2 mmHG\",\n \"bpSys\": \"1 mmHG\",\n \"createdOn\": \"2025-05-24T21:38:27.296+10:00\",\n \"exceptionalObservation\": {\n \"createdOn\": \"2025-05-24T21:38:27.375+10:00\",\n \"gcs\": \"12\",\n \"lastUpdatedOn\": \"2025-05-24T21:38:27.405+10:00\",\n \"limbStrength\": \"14\",\n \"lyingAndStandingBloodPressure\": \"15\",\n \"pupilReaction\": \"13\"\n },\n \"id\": 22309,\n \"lastUpdatedOn\": \"2025-05-24T21:38:27.296+10:00\",\n \"observationDateAndTime\": \"2025-05-24T21:37:38.254+10:00\",\n \"oxygenSaturation\": \"7\",\n \"onDiet\": true,\n \"pulse\": \"3 bpm\",\n \"refusedObservation\": null,\n \"respiration\": \"4 rpm\",\n \"temperature\": \"5 °C\",\n \"urinalysis\": {\n \"bilirubin\": \"Small\",\n \"blood\": \"Large\",\n \"createdOn\": \"2025-05-24T21:38:27.457+10:00\",\n \"glucose\": \"++++\",\n \"ketones\": \"Negative\",\n \"lastUpdatedOn\": \"2025-05-24T21:38:27.481+10:00\",\n \"leukocytes\": \"+\",\n \"nitrites\": \"Negative\",\n \"performedDate\": \"2025-05-23\",\n \"ph\": \"9 pH\",\n \"protein\": \"+++\",\n \"specificGravity\": \"10 SG\",\n \"urobilinogen\": \"Normal\"\n },\n \"weight\": \"60 kg\"\n },\n {\n \"bloodSugar\": null,\n \"bpDia\": null,\n \"bpSys\": null,\n \"createdOn\": \"2025-05-24T21:37:36.372+10:00\",\n \"exceptionalObservation\": {\n \"createdOn\": null,\n \"gcs\": null,\n \"lastUpdatedOn\": null,\n \"limbStrength\": null,\n \"lyingAndStandingBloodPressure\": null,\n \"pupilReaction\": null\n },\n \"id\": 22308,\n \"lastUpdatedOn\": \"2025-05-24T21:37:36.372+10:00\",\n \"observationDateAndTime\": \"2025-05-24T21:37:32.368+10:00\",\n \"oxygenSaturation\": null,\n \"onDiet\": false,\n \"pulse\": null,\n \"refusedObservation\": true,\n \"respiration\": null,\n \"temperature\": null,\n \"urinalysis\": {\n \"bilirubin\": null,\n \"blood\": null,\n \"createdOn\": null,\n \"glucose\": null,\n \"ketones\": null,\n \"lastUpdatedOn\": null,\n \"leukocytes\": null,\n \"nitrites\": null,\n \"performedDate\": null,\n \"ph\": null,\n \"protein\": null,\n \"specificGravity\": null,\n \"urobilinogen\": null\n },\n \"weight\": null\n }\n ],\n \"totalPages\": 1,\n \"currentPage\": 1,\n \"totalRecords\": 2\n}"},{"id":"943a614b-d8b5-4852-a78b-8ea6adf1cf9a","name":"400: Missing page query param","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"{{API_KEY}}","type":"text"}],"url":{"raw":"{{BASE_URL}}/api/v2/careRecipients/:careRecipientId/observations","host":["{{BASE_URL}}"],"path":["api","v2","careRecipients",":careRecipientId","observations"],"query":[{"key":"page","value":"1","disabled":true}],"variable":[{"key":"careRecipientId","value":"6f57349d-ebe1-460e-81f1-ce9c1778ee8b"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"58"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Sun, 25 May 2025 10:54:41 GMT"},{"key":"x-amz-apigw-id","value":"LHuF3HrNywMEeHg="},{"key":"x-amzn-RequestId","value":"588c53eb-7a90-412f-b7a7-a9065e5e3787"},{"key":"x-amzn-ErrorType","value":"BadRequestException"},{"key":"X-Cache","value":"Error from cloudfront"},{"key":"Via","value":"1.1 532bae2476fbb28a84cd6a0ce4a429b8.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"BNE50-P1"},{"key":"X-Amz-Cf-Id","value":"NCyMmCAFbcur57KkdDW05EMJeiUQLNZiVY2gl_nRQnKUkMJ3lqBItw=="}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Missing required request parameters: [page]\"\n}"},{"id":"318a24bf-9c9f-40cf-bd7b-207b197172e2","name":"401: Missing or Invalid Client ID or Secret or Scope","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"{{API_KEY}}","type":"text"}],"url":{"raw":"{{BASE_URL}}/api/v2/careRecipients/:careRecipientId/observations?page=1","host":["{{BASE_URL}}"],"path":["api","v2","careRecipients",":careRecipientId","observations"],"query":[{"key":"page","value":"1"}],"variable":[{"key":"careRecipientId","value":"6f57349d-ebe1-460e-81f1-ce9c1778ee8b"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"26"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Sun, 25 May 2025 10:47:30 GMT"},{"key":"x-amz-apigw-id","value":"LHtCgEe4ywMErbw="},{"key":"x-amzn-RequestId","value":"45216fd3-7e80-4e84-b3a2-3cb99ced8e47"},{"key":"x-amzn-ErrorType","value":"UnauthorizedException"},{"key":"X-Cache","value":"Error from cloudfront"},{"key":"Via","value":"1.1 c2b0b14414d87fbf9985559b5d1be1b0.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"BNE50-P1"},{"key":"X-Amz-Cf-Id","value":"J-WJaUOJbm8_apSIaxjvrLaV4PBdtXwpVr9U0vmAnlzpChaqoqUkzA=="}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Unauthorized\"\n}"},{"id":"f3bf5734-3fe3-4854-97f6-3a7f64fc1341","name":"403: Invalid API key","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"{{API_KEY}}1","type":"text"}],"url":{"raw":"{{BASE_URL}}/api/v2/careRecipients/:careRecipientId/observations?page=1","host":["{{BASE_URL}}"],"path":["api","v2","careRecipients",":careRecipientId","observations"],"query":[{"key":"page","value":"1"}],"variable":[{"key":"careRecipientId","value":"6f57349d-ebe1-460e-81f1-ce9c1778ee8b"}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"23"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Sun, 25 May 2025 11:00:36 GMT"},{"key":"x-amz-apigw-id","value":"LHu9MEcdywMESNA="},{"key":"x-amzn-RequestId","value":"06a8af99-98b6-45c9-8958-cfccd1004b22"},{"key":"x-amzn-ErrorType","value":"ForbiddenException"},{"key":"X-Cache","value":"Error from cloudfront"},{"key":"Via","value":"1.1 532bae2476fbb28a84cd6a0ce4a429b8.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"BNE50-P1"},{"key":"X-Amz-Cf-Id","value":"J7wLkthpxwinZzNyEkqJXHxtDqh20YGT9M3S1BPvLusrGK4zyjGQLA=="}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Forbidden\"\n}"},{"id":"3ba6afa9-132a-4de7-9734-1f2633d55813","name":"404: Invalid Care Recipient ID","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"{{API_KEY}}","type":"text"}],"url":{"raw":"{{BASE_URL}}/api/v2/careRecipients/:careRecipientId/observations?page=1","host":["{{BASE_URL}}"],"path":["api","v2","careRecipients",":careRecipientId","observations"],"query":[{"key":"page","value":"1"}],"variable":[{"key":"careRecipientId","value":"6f57349d-ebe1-460e-81f1-ce9c1778ee8b1"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"28"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Sun, 25 May 2025 11:25:56 GMT"},{"key":"X-Amzn-Trace-Id","value":"Root=1-6832fe43-7ac5dc153833239b6f0a737d;Parent=082559650b7a1def;Sampled=0;Lineage=1:99c474ef:0"},{"key":"x-amzn-RequestId","value":"ea214371-501f-4891-a392-d98604d429c0"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"LHyqkFT4SwMENzA="},{"key":"X-Cache","value":"Error from cloudfront"},{"key":"Via","value":"1.1 d3df131ceff5655dbf6f4afc2093ca56.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"BNE50-P1"},{"key":"X-Amz-Cf-Id","value":"ymOMre0pYSJIvlT53BNy96EqV_3qi0ntQIyO62QkptEZQ6cYZcanUg=="}],"cookie":[],"responseTime":null,"body":"{\n \"error\": \"Record Not Found\"\n}"}],"_postman_id":"6a15cca6-8cf4-494e-9e8b-375fcd148c2e"},{"name":"Get Bowel Observations","id":"01356d98-7368-46a0-af9a-ef9c6629d684","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"client_authentication","value":""},{"key":"scope","value":"{{SCOPE}}"},{"key":"headerPrefix","value":""},{"key":"refreshTokenUrl","value":"{{AUTH_URL}}"},{"key":"accessTokenUrl","value":"{{AUTH_URL}}"},{"key":"clientSecret","value":"{{CLIENT_SECRET}}"},{"key":"clientId","value":"{{CLIENT_ID}}"},{"key":"tokenName","value":""},{"key":"grant_type","value":""},{"key":"password","value":"{{password}}"},{"key":"username","value":"{{username}}"}]},"isInherited":false},"method":"GET","header":[{"key":"x-api-key","value":"{{API_KEY}}","type":"text"}],"url":"{{BASE_URL}}/api/v2/careRecipients/:careRecipientId/bowelObservations?page=1","description":"

📄 Endpoint Overview

This endpoint returns a paginated list/array of Bowel Observations for a specific Care Recipient, with a maximum of 10 records per page.

A mandatory query parameter named page must be provided. To retrieve the initial set of results, set page=1.

The successful response includes pagination metadata such as:

bowelObservations: A paginated list of Bowel Observations (max 10 records)
\n
totalPages: Total number of pages available
\n
currentPage: Current page number returned
\n
totalRecords: Total number of Bowel Observation records in the system
\n

Response Schema

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Attribute	Type	Description
bowelType	string	Bowel type (e.g., “Type 1”, “Type 5”). Can be null.
createdOn	datetime	Timestamp when the bowel observation was created.
id	integer	Unique ID of the bowel observation.
lastUpdatedOn	datetime	Timestamp of the last update to the observation.
notWitnessed	boolean	Indicates whether the event was not witnessed. Can be null.
observationDateAndTime	datetime	Date and time when the observation occurred.
shift	string	Work shift during which the observation was recorded (e.g., “AM”).
size	string	Size of the bowel (e.g., “Smear Only”).

","urlObject":{"path":["api","v2","careRecipients",":careRecipientId","bowelObservations"],"host":["{{BASE_URL}}"],"query":[{"key":"page","value":"1"}],"variable":[{"type":"any","value":"{{CARE_RECIPIENT_ID}}","key":"careRecipientId"}]}},"response":[{"id":"7dcc0072-6a4f-450a-bea8-c6f0119801dd","name":"200: Success","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"{{API_KEY}}","type":"text"}],"url":{"raw":"{{BASE_URL}}/api/v2/careRecipients/:careRecipientId/bowelObservations?page=1","host":["{{BASE_URL}}"],"path":["api","v2","careRecipients",":careRecipientId","bowelObservations"],"query":[{"key":"page","value":"1"}],"variable":[{"key":"careRecipientId","value":"6f57349d-ebe1-460e-81f1-ce9c1778ee8b"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"540"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Sun, 25 May 2025 10:41:23 GMT"},{"key":"X-Amzn-Trace-Id","value":"Root=1-6832f3d1-36be0c652ee520600ed02836;Parent=2f6bee8b90e49072;Sampled=0;Lineage=1:bf8acd03:0"},{"key":"x-amzn-RequestId","value":"a0a3237e-c879-4e01-a6e5-3f45b8b54a58"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"LHsIuEwBywMEMSw="},{"key":"X-Cache","value":"Miss from cloudfront"},{"key":"Via","value":"1.1 c2b0b14414d87fbf9985559b5d1be1b0.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"BNE50-P1"},{"key":"X-Amz-Cf-Id","value":"Occ3sKP_o1Vp39yH0V7k76yDpCZnSq-Y5ca2z71hGynl0YD9uYc6qQ=="}],"cookie":[],"responseTime":null,"body":"{\n \"bowelObservations\": [\n {\n \"bowelType\": \"Type 5\",\n \"createdOn\": \"2025-05-24T21:42:34.368+10:00\",\n \"id\": 130831,\n \"lastUpdatedOn\": \"2025-05-24T21:42:34.368+10:00\",\n \"notWitnessed\": true,\n \"observationDateAndTime\": \"2025-05-24T21:42:28.019+10:00\",\n \"shift\": \"AM\",\n \"size\": null\n },\n {\n \"bowelType\": \"Type 1\",\n \"createdOn\": \"2025-05-24T21:42:26.522+10:00\",\n \"id\": 130830,\n \"lastUpdatedOn\": \"2025-05-24T21:42:26.522+10:00\",\n \"notWitnessed\": null,\n \"observationDateAndTime\": \"2025-05-24T21:42:19.172+10:00\",\n \"shift\": \"Night\",\n \"size\": \"Smear Only\"\n }\n ],\n \"totalPages\": 1,\n \"currentPage\": 1,\n \"totalRecords\": 2\n}"},{"id":"6714610d-a21b-4728-97ec-300e40929ace","name":"400: Missing page query param","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"{{API_KEY}}","type":"text"}],"url":{"raw":"{{BASE_URL}}/api/v2/careRecipients/:careRecipientId/bowelObservations","host":["{{BASE_URL}}"],"path":["api","v2","careRecipients",":careRecipientId","bowelObservations"],"query":[{"key":"page","value":"1","disabled":true}],"variable":[{"key":"careRecipientId","value":"6f57349d-ebe1-460e-81f1-ce9c1778ee8b"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"58"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Sun, 25 May 2025 10:54:57 GMT"},{"key":"x-amz-apigw-id","value":"LHuISE_JywMESHQ="},{"key":"x-amzn-RequestId","value":"fbb88504-083b-42e2-81d7-899907569d2a"},{"key":"x-amzn-ErrorType","value":"BadRequestException"},{"key":"X-Cache","value":"Error from cloudfront"},{"key":"Via","value":"1.1 532bae2476fbb28a84cd6a0ce4a429b8.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"BNE50-P1"},{"key":"X-Amz-Cf-Id","value":"_PSPRMhdaF5On6TBhwTpT2MRud5LtIztgwUGbKH1ZVI_4_F4oHmlkA=="}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Missing required request parameters: [page]\"\n}"},{"id":"b922b478-3745-493f-bf5a-1c42cc5d6d87","name":"401: Missing or Invalid Client ID or Secret or Scope","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"{{API_KEY}}","type":"text"}],"url":{"raw":"{{BASE_URL}}/api/v2/careRecipients/:careRecipientId/bowelObservations?page=1","host":["{{BASE_URL}}"],"path":["api","v2","careRecipients",":careRecipientId","bowelObservations"],"query":[{"key":"page","value":"1"}],"variable":[{"key":"careRecipientId","value":"6f57349d-ebe1-460e-81f1-ce9c1778ee8b"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"26"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Sun, 25 May 2025 10:47:52 GMT"},{"key":"x-amz-apigw-id","value":"LHtF4GNySwMEcWg="},{"key":"x-amzn-RequestId","value":"2c674b62-0358-48c7-8668-05ac7bca7274"},{"key":"x-amzn-ErrorType","value":"UnauthorizedException"},{"key":"X-Cache","value":"Error from cloudfront"},{"key":"Via","value":"1.1 c2b0b14414d87fbf9985559b5d1be1b0.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"BNE50-P1"},{"key":"X-Amz-Cf-Id","value":"yrp85OnMv0fm_vXrU8vWl03CwV5pbJnUXIoH_V2-ZDDoBI0GwaIVtA=="}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Unauthorized\"\n}"},{"id":"2b2ef51d-baa5-4fad-8e78-05cf0956b27f","name":"403: Invalid API key","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"{{API_KEY}}1","type":"text"}],"url":{"raw":"{{BASE_URL}}/api/v2/careRecipients/:careRecipientId/bowelObservations?page=1","host":["{{BASE_URL}}"],"path":["api","v2","careRecipients",":careRecipientId","bowelObservations"],"query":[{"key":"page","value":"1"}],"variable":[{"key":"careRecipientId","value":"6f57349d-ebe1-460e-81f1-ce9c1778ee8b"}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"23"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Sun, 25 May 2025 11:00:52 GMT"},{"key":"x-amz-apigw-id","value":"LHu_yEbsywMEnNQ="},{"key":"x-amzn-RequestId","value":"a3b92eff-9c68-48b8-b3aa-63d22d9556d7"},{"key":"x-amzn-ErrorType","value":"ForbiddenException"},{"key":"X-Cache","value":"Error from cloudfront"},{"key":"Via","value":"1.1 532bae2476fbb28a84cd6a0ce4a429b8.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"BNE50-P1"},{"key":"X-Amz-Cf-Id","value":"DbWmMk9DMywg7HgxnS4E1HZ_ztcr0tUef0gItV1-wjrjM6wWT0MQLw=="}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Forbidden\"\n}"},{"id":"f164f7ab-776d-4c79-82cf-f585bc7bd276","name":"404: Invalid Care Recipient ID","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"{{API_KEY}}","type":"text"}],"url":{"raw":"{{BASE_URL}}/api/v2/careRecipients/:careRecipientId/bowelObservations?page=1","host":["{{BASE_URL}}"],"path":["api","v2","careRecipients",":careRecipientId","bowelObservations"],"query":[{"key":"page","value":"1"}],"variable":[{"key":"careRecipientId","value":"6f57349d-ebe1-460e-81f1-ce9c1778ee8b1"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"28"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Sun, 25 May 2025 11:32:33 GMT"},{"key":"X-Amzn-Trace-Id","value":"Root=1-6832ffcf-0c5b28565fa23e873a00a5b6;Parent=12b8ec40862ec620;Sampled=0;Lineage=1:bf8acd03:0"},{"key":"x-amzn-RequestId","value":"d559fe6d-d240-4594-be6b-1714b3a1bfab"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"LHzofGfnywMECsw="},{"key":"X-Cache","value":"Error from cloudfront"},{"key":"Via","value":"1.1 9348b3d5d666c07df33489b432ed8cae.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"BNE50-P1"},{"key":"X-Amz-Cf-Id","value":"EsmhnaKaV-T4epTxLxGr-e2NQWI0LlyaoAWEi-kYbitanFRMd_dL7A=="}],"cookie":[],"responseTime":null,"body":"{\n \"error\": \"Record Not Found\"\n}"}],"_postman_id":"01356d98-7368-46a0-af9a-ef9c6629d684"},{"name":"Get Allied Health Referral Visits","id":"5b1876f4-3d13-4dee-8ea5-357594638d2f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"client_authentication","value":""},{"key":"scope","value":"{{SCOPE}}"},{"key":"headerPrefix","value":""},{"key":"refreshTokenUrl","value":"{{AUTH_URL}}"},{"key":"accessTokenUrl","value":"{{AUTH_URL}}"},{"key":"clientSecret","value":"{{CLIENT_SECRET}}"},{"key":"clientId","value":"{{CLIENT_ID}}"},{"key":"tokenName","value":""},{"key":"grant_type","value":""},{"key":"password","value":"{{password}}"},{"key":"username","value":"{{username}}"}]},"isInherited":false},"method":"GET","header":[{"key":"x-api-key","value":"{{API_KEY}}","type":"text"}],"url":"{{BASE_URL}}/api/v2/careRecipients/:careRecipientId/alliedHealthReferrals?page=1","description":"

📄 Endpoint Overview

This endpoint returns a paginated list/array of Allied Health Referral Visits for a specific Care Recipient, with a maximum of 10 records per page.

A mandatory query parameter named page must be provided. To retrieve the initial set of results, set page=1.

The successful response includes pagination metadata such as:

alliedHealthReferrals: A paginated list of Allied Health Referral Visits (max 10 records)
\n
totalPages: Total number of pages available
\n
currentPage: Current page number returned
\n
totalRecords: Total number of Allied Health Referral Visits records in the system
\n

Response Schema

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Attribute	Type	Description
createdOn	datetime	Timestamp when the referral was created.
dateReffered	date	Date the referral was made.
id	integer	Unique ID of the referral visit.
lastUpdatedOn	datetime	Timestamp when the referral was last updated.
outcome	string	Outcome of the visit. Can be null.
practitionerName	string	Name of the referred practitioner.
practitionerPhone	string	Contact number of the practitioner. Can be null.
priority	string	Priority level (e.g., “high”, “medium”). Can be null.
reasonForVisit	string	Reason for the visit.
referralFor	string	Referral type or service requested (e.g., “Chaplain / Pastoral Care”).
referralFrequency	string	Frequency of referral (e.g., “Once only”, “Weekly”). Can be null.
referralStatus	string	Current status of the referral (e.g., “scheduled”, “completed”).
visitDate	date	Scheduled visit date.

","urlObject":{"path":["api","v2","careRecipients",":careRecipientId","alliedHealthReferrals"],"host":["{{BASE_URL}}"],"query":[{"key":"page","value":"1"}],"variable":[{"type":"any","value":"{{CARE_RECIPIENT_ID}}","key":"careRecipientId"}]}},"response":[{"id":"4148344e-9c6b-4f00-8efb-58a316252d8c","name":"200: Success","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"{{API_KEY}}","type":"text"}],"url":{"raw":"{{BASE_URL}}/api/v2/careRecipients/:careRecipientId/alliedHealthReferrals?page=1","host":["{{BASE_URL}}"],"path":["api","v2","careRecipients",":careRecipientId","alliedHealthReferrals"],"query":[{"key":"page","value":"1"}],"variable":[{"key":"careRecipientId","value":"6f57349d-ebe1-460e-81f1-ce9c1778ee8b"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"434"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Sun, 25 May 2025 10:41:38 GMT"},{"key":"X-Amzn-Trace-Id","value":"Root=1-6832f3df-696f18961d035aa96334673f;Parent=0eb3d519cff3fc13;Sampled=0;Lineage=1:14e5bdc3:0"},{"key":"x-amzn-RequestId","value":"d2cb020c-563a-4a9b-b201-132dfa1ac9e1"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"LHsLDFj-ywMEALA="},{"key":"X-Cache","value":"Miss from cloudfront"},{"key":"Via","value":"1.1 c2b0b14414d87fbf9985559b5d1be1b0.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"BNE50-P1"},{"key":"X-Amz-Cf-Id","value":"jIcDVAcn2TqAs43Odfw83e076GFlCpanZPIgHtCkDC7WtWyfctMGiw=="}],"cookie":[],"responseTime":null,"body":"{\n \"alliedHealthReferrals\": [\n {\n \"createdOn\": \"2025-05-24T22:03:01.949+10:00\",\n \"dateReffered\": \"2025-05-24\",\n \"id\": 2560,\n \"lastUpdatedOn\": \"2025-05-24T22:03:01.949+10:00\",\n \"outcome\": \"4\",\n \"practitionerName\": \"1\",\n \"practitionerPhone\": \"2\",\n \"priority\": \"high\",\n \"reasonForVisit\": \"3\",\n \"referralFor\": \"Chaplain / Pastoral Care\",\n \"referralFrequency\": \"Once only\",\n \"referralStatus\": \"scheduled\",\n \"visitDate\": \"2025-05-23\"\n }\n ],\n \"totalPages\": 1,\n \"currentPage\": 1,\n \"totalRecords\": 1\n}"},{"id":"b96d2748-6bb5-4f99-a187-349f1b81e234","name":"400: Missing page query param","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"{{API_KEY}}","type":"text"}],"url":{"raw":"{{BASE_URL}}/api/v2/careRecipients/:careRecipientId/alliedHealthReferrals","host":["{{BASE_URL}}"],"path":["api","v2","careRecipients",":careRecipientId","alliedHealthReferrals"],"query":[{"key":"page","value":"1","disabled":true}],"variable":[{"key":"careRecipientId","value":"6f57349d-ebe1-460e-81f1-ce9c1778ee8b"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"58"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Sun, 25 May 2025 10:55:12 GMT"},{"key":"x-amz-apigw-id","value":"LHuKoG76SwMEMnA="},{"key":"x-amzn-RequestId","value":"fd55ca59-87c6-44e2-9ffd-07c59b65ca09"},{"key":"x-amzn-ErrorType","value":"BadRequestException"},{"key":"X-Cache","value":"Error from cloudfront"},{"key":"Via","value":"1.1 532bae2476fbb28a84cd6a0ce4a429b8.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"BNE50-P1"},{"key":"X-Amz-Cf-Id","value":"dF1CzF-Y-m-NbmCOq3Vm5BSmN1JaWBwjJRsGhpCZaTOF3KpdUEoj-Q=="}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Missing required request parameters: [page]\"\n}"},{"id":"35373d40-6b99-4e0b-98cd-a366cd8cc5cd","name":"401: Missing or Invalid Client ID or Secret or Scope","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"{{API_KEY}}","type":"text"}],"url":{"raw":"{{BASE_URL}}/api/v2/careRecipients/:careRecipientId/alliedHealthReferrals?page=1","host":["{{BASE_URL}}"],"path":["api","v2","careRecipients",":careRecipientId","alliedHealthReferrals"],"query":[{"key":"page","value":"1"}],"variable":[{"key":"careRecipientId","value":"6f57349d-ebe1-460e-81f1-ce9c1778ee8b"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"26"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Sun, 25 May 2025 10:48:12 GMT"},{"key":"x-amz-apigw-id","value":"LHtJCHygywMEUJQ="},{"key":"x-amzn-RequestId","value":"8f1fc573-b7a1-4462-88e2-8e6199973380"},{"key":"x-amzn-ErrorType","value":"UnauthorizedException"},{"key":"X-Cache","value":"Error from cloudfront"},{"key":"Via","value":"1.1 c2b0b14414d87fbf9985559b5d1be1b0.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"BNE50-P1"},{"key":"X-Amz-Cf-Id","value":"99UvDikrjkpDV_CIfIqirWSwDNuNL66HZ97m4j6RIEajHXwVtIaXTg=="}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Unauthorized\"\n}"},{"id":"1f4d2ca9-14e1-43b2-b2ce-6e5570baf9e6","name":"403: Invalid API key","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"{{API_KEY}}1","type":"text"}],"url":{"raw":"{{BASE_URL}}/api/v2/careRecipients/:careRecipientId/alliedHealthReferrals?page=1","host":["{{BASE_URL}}"],"path":["api","v2","careRecipients",":careRecipientId","alliedHealthReferrals"],"query":[{"key":"page","value":"1"}],"variable":[{"key":"careRecipientId","value":"6f57349d-ebe1-460e-81f1-ce9c1778ee8b"}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"23"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Sun, 25 May 2025 11:01:03 GMT"},{"key":"x-amz-apigw-id","value":"LHvBaGhEywMEgpg="},{"key":"x-amzn-RequestId","value":"581526bd-489d-43c1-9f74-54b19627232c"},{"key":"x-amzn-ErrorType","value":"ForbiddenException"},{"key":"X-Cache","value":"Error from cloudfront"},{"key":"Via","value":"1.1 532bae2476fbb28a84cd6a0ce4a429b8.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"BNE50-P1"},{"key":"X-Amz-Cf-Id","value":"-pQwE7n4zKM4_woraLqdgvFQNKtJz8869oAG8A3RtqGS2ClmcjHLfA=="}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Forbidden\"\n}"},{"id":"ca0358af-06ce-42a2-a9ce-f2aafd8edfd5","name":"404: Invalid Care Recipient ID","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"{{API_KEY}}","type":"text"}],"url":{"raw":"{{BASE_URL}}/api/v2/careRecipients/:careRecipientId/alliedHealthReferrals?page=1","host":["{{BASE_URL}}"],"path":["api","v2","careRecipients",":careRecipientId","alliedHealthReferrals"],"query":[{"key":"page","value":"1"}],"variable":[{"key":"careRecipientId","value":"6f57349d-ebe1-460e-81f1-ce9c1778ee8b1"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"28"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Sun, 25 May 2025 11:33:02 GMT"},{"key":"X-Amzn-Trace-Id","value":"Root=1-6832ffec-5145708a719dab0a02b07a0c;Parent=508dca684707132a;Sampled=0;Lineage=1:14e5bdc3:0"},{"key":"x-amzn-RequestId","value":"3d34a6ae-317a-4e50-9f7d-86a468b79b8a"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"LHztFFryywMEPQg="},{"key":"X-Cache","value":"Error from cloudfront"},{"key":"Via","value":"1.1 9348b3d5d666c07df33489b432ed8cae.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"BNE50-P1"},{"key":"X-Amz-Cf-Id","value":"w9fIEGQrJ2-gvg1gOIXoqFpQD0HsxeMLh6vYtYlXPthjzrEEZo3hxw=="}],"cookie":[],"responseTime":null,"body":"{\n \"error\": \"Record Not Found\"\n}"}],"_postman_id":"5b1876f4-3d13-4dee-8ea5-357594638d2f"},{"name":"Get Wounds","id":"e920714c-8785-4f03-86b0-2c15102b1d2c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"client_authentication","value":""},{"key":"scope","value":"{{SCOPE}}"},{"key":"headerPrefix","value":""},{"key":"refreshTokenUrl","value":"{{AUTH_URL}}"},{"key":"accessTokenUrl","value":"{{AUTH_URL}}"},{"key":"clientSecret","value":"{{CLIENT_SECRET}}"},{"key":"clientId","value":"{{CLIENT_ID}}"},{"key":"tokenName","value":""},{"key":"grant_type","value":""},{"key":"password","value":"{{password}}"},{"key":"username","value":"{{username}}"}]},"isInherited":false},"method":"GET","header":[{"key":"x-api-key","value":"{{API_KEY}}","type":"text"}],"url":"{{BASE_URL}}/api/v2/careRecipients/:careRecipientId/skinAndWounds?page=1","description":"

📄 Endpoint Overview

This endpoint returns a paginated list/array of Wounds for a specific Care Recipient, with a maximum of 10 records per page.

A mandatory query parameter named page must be provided. To retrieve the initial set of results, set page=1.

The successful response includes pagination metadata such as:

skinAndWounds: A paginated list of Wounds (max 10 records)
\n
totalPages: Total number of pages available
\n
currentPage: Current page number returned
\n
totalRecords: Total number of Wounds records in the system
\n

Response Schema

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Attribute	Type	Description
createdOn	datetime	Timestamp when the wound record was created.
id	integer	Unique ID of the wound record.
initialDateOfWound	date	Date the wound was initially observed.
lastUpdatedOn	datetime	Timestamp when the wound record was last updated.
locationOfWound	string	Body location of the wound (e.g., “Forehead”, “Eye”).
modifier	string	Additional directional modifier (e.g., “Left”, “Front”). C
source	string	Origin of the wound (e.g., “Internal”, “External”). Can be null.
typeOfWound	string	Classification of the wound (e.g., “Abrasion”, “Laceration”).

","urlObject":{"path":["api","v2","careRecipients",":careRecipientId","skinAndWounds"],"host":["{{BASE_URL}}"],"query":[{"key":"page","value":"1"}],"variable":[{"type":"any","value":"{{CARE_RECIPIENT_ID}}","key":"careRecipientId"}]}},"response":[{"id":"908102b8-bfa0-4e7f-ab67-739ce7b2f599","name":"200: Success","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"{{API_KEY}}","type":"text"}],"url":{"raw":"{{BASE_URL}}/api/v2/careRecipients/:careRecipientId/skinAndWounds?page=1","host":["{{BASE_URL}}"],"path":["api","v2","careRecipients",":careRecipientId","skinAndWounds"],"query":[{"key":"page","value":"1"}],"variable":[{"key":"careRecipientId","value":"6f57349d-ebe1-460e-81f1-ce9c1778ee8b"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"515"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Sun, 25 May 2025 10:41:54 GMT"},{"key":"X-Amzn-Trace-Id","value":"Root=1-6832f3f0-5d02f03256d3536e5e89fa5f;Parent=4b78596644938d6d;Sampled=0;Lineage=1:b20ffd69:0"},{"key":"x-amzn-RequestId","value":"322df154-9364-4e79-aa4f-7c7c559d16d4"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"LHsNkFJfywMEjgg="},{"key":"X-Cache","value":"Miss from cloudfront"},{"key":"Via","value":"1.1 c2b0b14414d87fbf9985559b5d1be1b0.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"BNE50-P1"},{"key":"X-Amz-Cf-Id","value":"jTgsQxItfBTxK8CaPXZGbLtVEj7iqtw9bR38FZ2PrLMq4j7XhqG0Ow=="}],"cookie":[],"responseTime":null,"body":"{\n \"skinAndWounds\": [\n {\n \"createdOn\": \"2025-05-24T23:13:14.992+10:00\",\n \"id\": 1366,\n \"initialDateOfWound\": \"2025-05-24\",\n \"lastUpdatedOn\": \"2025-05-24T23:13:14.992+10:00\",\n \"locationOfWound\": \"Eye\",\n \"modifier\": \"Front\",\n \"source\": \"\",\n \"typeOfWound\": \"Abrasion\"\n },\n {\n \"createdOn\": \"2025-05-24T22:14:22.641+10:00\",\n \"id\": 1365,\n \"initialDateOfWound\": \"2025-05-24\",\n \"lastUpdatedOn\": \"2025-05-24T22:14:22.641+10:00\",\n \"locationOfWound\": \"Forehead\",\n \"modifier\": \"Left\",\n \"source\": \"Internal\",\n \"typeOfWound\": \"Abrasion\"\n }\n ],\n \"totalPages\": 1,\n \"currentPage\": 1,\n \"totalRecords\": 2\n}"},{"id":"1755cbc7-e228-400c-b5ce-554b28f309e4","name":"400: Missing page query param","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"{{API_KEY}}","type":"text"}],"url":{"raw":"{{BASE_URL}}/api/v2/careRecipients/:careRecipientId/skinAndWounds","host":["{{BASE_URL}}"],"path":["api","v2","careRecipients",":careRecipientId","skinAndWounds"],"query":[{"key":"page","value":"1","disabled":true}],"variable":[{"key":"careRecipientId","value":"6f57349d-ebe1-460e-81f1-ce9c1778ee8b"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"58"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Sun, 25 May 2025 10:55:24 GMT"},{"key":"x-amz-apigw-id","value":"LHuMgE1_ywMErrA="},{"key":"x-amzn-RequestId","value":"577ec836-80e7-4769-a3a1-0e678d16ab4e"},{"key":"x-amzn-ErrorType","value":"BadRequestException"},{"key":"X-Cache","value":"Error from cloudfront"},{"key":"Via","value":"1.1 532bae2476fbb28a84cd6a0ce4a429b8.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"BNE50-P1"},{"key":"X-Amz-Cf-Id","value":"TxDw6eo1Ob79S_Df-aoEepy5oC2CzS4ue4Att5MYic4ukgVTC9I2Kw=="}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Missing required request parameters: [page]\"\n}"},{"id":"90a607ac-13d8-4cd0-ad27-5f094bc43555","name":"401: Missing or Invalid Client ID or Secret or Scope","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"{{API_KEY}}","type":"text"}],"url":{"raw":"{{BASE_URL}}/api/v2/careRecipients/:careRecipientId/skinAndWounds?page=1","host":["{{BASE_URL}}"],"path":["api","v2","careRecipients",":careRecipientId","skinAndWounds"],"query":[{"key":"page","value":"1"}],"variable":[{"key":"careRecipientId","value":"6f57349d-ebe1-460e-81f1-ce9c1778ee8b"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"26"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Sun, 25 May 2025 10:48:34 GMT"},{"key":"x-amz-apigw-id","value":"LHtMgEWKSwMEMSw="},{"key":"x-amzn-RequestId","value":"d31df948-dd58-4094-97b9-0c1ee37d56ce"},{"key":"x-amzn-ErrorType","value":"UnauthorizedException"},{"key":"X-Cache","value":"Error from cloudfront"},{"key":"Via","value":"1.1 c2b0b14414d87fbf9985559b5d1be1b0.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"BNE50-P1"},{"key":"X-Amz-Cf-Id","value":"v47d66DMpYZFSJtsFycnG3nR_0C1YPfjWhpP1nGdRu3svccJxO-b4Q=="}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Unauthorized\"\n}"},{"id":"a20bc8b2-92b1-401c-9ada-749056c55d39","name":"403: Invalid API key","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"{{API_KEY}}1","type":"text"}],"url":{"raw":"{{BASE_URL}}/api/v2/careRecipients/:careRecipientId/skinAndWounds?page=1","host":["{{BASE_URL}}"],"path":["api","v2","careRecipients",":careRecipientId","skinAndWounds"],"query":[{"key":"page","value":"1"}],"variable":[{"key":"careRecipientId","value":"6f57349d-ebe1-460e-81f1-ce9c1778ee8b"}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"23"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Sun, 25 May 2025 11:01:15 GMT"},{"key":"x-amz-apigw-id","value":"LHvDaF4-SwMEuXw="},{"key":"x-amzn-RequestId","value":"39d097b1-5425-491e-a781-f03736f0aa43"},{"key":"x-amzn-ErrorType","value":"ForbiddenException"},{"key":"X-Cache","value":"Error from cloudfront"},{"key":"Via","value":"1.1 532bae2476fbb28a84cd6a0ce4a429b8.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"BNE50-P1"},{"key":"X-Amz-Cf-Id","value":"-_Xue8H2XEg3mVdH_fft4nICcyuBkrxtp9QLXVQRrKbN4M2kAfyL0A=="}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Forbidden\"\n}"},{"id":"8459da78-a9f4-4885-aca7-212888c653ca","name":"404: Invalid Care Recipient ID","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"{{API_KEY}}","type":"text"}],"url":{"raw":"{{BASE_URL}}/api/v2/careRecipients/:careRecipientId/skinAndWounds?page=1","host":["{{BASE_URL}}"],"path":["api","v2","careRecipients",":careRecipientId","skinAndWounds"],"query":[{"key":"page","value":"1"}],"variable":[{"key":"careRecipientId","value":"6f57349d-ebe1-460e-81f1-ce9c1778ee8b1"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"28"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Sun, 25 May 2025 11:33:18 GMT"},{"key":"X-Amzn-Trace-Id","value":"Root=1-6832fffc-177e02061dd95a36737c5c95;Parent=61efd6acc3764a40;Sampled=0;Lineage=1:b20ffd69:0"},{"key":"x-amzn-RequestId","value":"848828d7-e037-423b-8cde-f1e45b51c5ca"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"LHzviGjyywMEX4A="},{"key":"X-Cache","value":"Error from cloudfront"},{"key":"Via","value":"1.1 9348b3d5d666c07df33489b432ed8cae.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"BNE50-P1"},{"key":"X-Amz-Cf-Id","value":"531tUCLyDxhBQLPChyeUj1Ce10hW_ltGgAgL2AEmxOcwH7LPZeigvA=="}],"cookie":[],"responseTime":null,"body":"{\n \"error\": \"Record Not Found\"\n}"}],"_postman_id":"e920714c-8785-4f03-86b0-2c15102b1d2c"},{"name":"Get Infection Control","id":"931d9a0f-e065-4f88-92c3-8778939ff246","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"client_authentication","value":""},{"key":"scope","value":"{{SCOPE}}"},{"key":"headerPrefix","value":""},{"key":"refreshTokenUrl","value":"{{AUTH_URL}}"},{"key":"accessTokenUrl","value":"{{AUTH_URL}}"},{"key":"clientSecret","value":"{{CLIENT_SECRET}}"},{"key":"clientId","value":"{{CLIENT_ID}}"},{"key":"tokenName","value":""},{"key":"grant_type","value":""},{"key":"password","value":"{{password}}"},{"key":"username","value":"{{username}}"}]},"isInherited":false},"method":"GET","header":[{"key":"x-api-key","value":"{{API_KEY}}","type":"text"}],"url":"{{BASE_URL}}/api/v2/careRecipients/:careRecipientId/infectionControl?page=1","description":"

📄 Endpoint Overview

This endpoint returns a paginated list/array of Infection Control for a specific Care Recipient, with a maximum of 10 records per page.

A mandatory query parameter named page must be provided. To retrieve the initial set of results, set page=1.

The successful response includes pagination metadata such as:

infectionControl: A paginated list of Infection Control (max 10 records)
\n
totalPages: Total number of pages available
\n
currentPage: Current page number returned
\n
totalRecords: Total number of Infection Control records in the system
\n

Response Schema

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Attribute	Type	Description
createdOn	datetime	Timestamp when the infection record was created.
id	integer	Unique ID of the infection record.
infectionType	string	Type of infection (e.g., “Cellulitis”).
initialDateOfInfection	date	Date when the infection was initially recorded.
lastUpdatedOn	datetime	Timestamp of the last update.
locationOfInfection	string	Body location of the infection (e.g., “Forehead”).
modifier	string	Additional directional detail (e.g., “Left”, “Right”).
pathologyTaken	boolean	Indicates if pathology was taken. Defaults to false.
pathologyTakenDate	date	Date when the pathology sample was taken. Can be null.
treatment	string	Comma-separated list of treatments (e.g., “Antibiotics, Antifungal”). Can be null.
typeOfPathogen	string	Type of pathogen identified (if any). Can be null.

","urlObject":{"path":["api","v2","careRecipients",":careRecipientId","infectionControl"],"host":["{{BASE_URL}}"],"query":[{"key":"page","value":"1"}],"variable":[{"type":"any","value":"{{CARE_RECIPIENT_ID}}","key":"careRecipientId"}]}},"response":[{"id":"6456e339-edea-438b-b9bf-a71b1ad463ef","name":"200: Success","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"{{API_KEY}}","type":"text"}],"url":{"raw":"{{BASE_URL}}/api/v2/careRecipients/:careRecipientId/infectionControl?page=1","host":["{{BASE_URL}}"],"path":["api","v2","careRecipients",":careRecipientId","infectionControl"],"query":[{"key":"page","value":"1"}],"variable":[{"key":"careRecipientId","value":"6f57349d-ebe1-460e-81f1-ce9c1778ee8b"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"434"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Sun, 25 May 2025 10:42:10 GMT"},{"key":"X-Amzn-Trace-Id","value":"Root=1-6832f400-3d2097147b4e26134c9e2cc5;Parent=7ec56bcc30170aac;Sampled=0;Lineage=1:50fd8138:0"},{"key":"x-amzn-RequestId","value":"febf957e-85fb-4526-aa42-3750f231e83b"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"LHsQGFkgSwMEGpg="},{"key":"X-Cache","value":"Miss from cloudfront"},{"key":"Via","value":"1.1 c2b0b14414d87fbf9985559b5d1be1b0.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"BNE50-P1"},{"key":"X-Amz-Cf-Id","value":"nOFAhulvwm2hBKXwz4iUnNyzwEVMCHFm8hyIh265K4-LnE_c1k16Xg=="}],"cookie":[],"responseTime":null,"body":"{\n \"infectionControl\": [\n {\n \"createdOn\": \"2025-05-24T22:24:00.737+10:00\",\n \"id\": 431,\n \"infectionType\": \"Cellulitis\",\n \"initialDateOfInfection\": \"2025-05-24\",\n \"lastUpdatedOn\": \"2025-05-24T22:24:27.257+10:00\",\n \"locationOfInfection\": \"Forehead\",\n \"modifier\": \"Left\",\n \"pathologyTaken\": true,\n \"pathologyTakenDate\": \"2025-05-22\",\n \"treatment\": \"Antibiotics, Antifungal, Antiviral, Hospitalisation\",\n \"typeOfPathogen\": \"1\"\n }\n ],\n \"totalPages\": 1,\n \"currentPage\": 1,\n \"totalRecords\": 1\n}"},{"id":"96bb9571-fd75-4b0b-be2a-50829898c4e3","name":"400: Missing page query param","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"{{API_KEY}}","type":"text"}],"url":{"raw":"{{BASE_URL}}/api/v2/careRecipients/:careRecipientId/infectionControl","host":["{{BASE_URL}}"],"path":["api","v2","careRecipients",":careRecipientId","infectionControl"],"query":[{"key":"page","value":"1","disabled":true}],"variable":[{"key":"careRecipientId","value":"6f57349d-ebe1-460e-81f1-ce9c1778ee8b"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"58"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Sun, 25 May 2025 10:55:36 GMT"},{"key":"x-amz-apigw-id","value":"LHuObGhTSwMEj0Q="},{"key":"x-amzn-RequestId","value":"e6257863-fb99-47de-bfa0-651ef322dd71"},{"key":"x-amzn-ErrorType","value":"BadRequestException"},{"key":"X-Cache","value":"Error from cloudfront"},{"key":"Via","value":"1.1 532bae2476fbb28a84cd6a0ce4a429b8.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"BNE50-P1"},{"key":"X-Amz-Cf-Id","value":"kuiH8BmdFCoTLWvzS7TBHy_socVzrNmaMhBgLLSZ6ip0RJq7AI_Y4A=="}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Missing required request parameters: [page]\"\n}"},{"id":"8224967e-e869-4498-99ce-1893ea91b6f1","name":"401: Missing or Invalid Client ID or Secret or Scope","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"{{API_KEY}}","type":"text"}],"url":{"raw":"{{BASE_URL}}/api/v2/careRecipients/:careRecipientId/infectionControl?page=1","host":["{{BASE_URL}}"],"path":["api","v2","careRecipients",":careRecipientId","infectionControl"],"query":[{"key":"page","value":"1"}],"variable":[{"key":"careRecipientId","value":"6f57349d-ebe1-460e-81f1-ce9c1778ee8b"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"26"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Sun, 25 May 2025 10:49:03 GMT"},{"key":"x-amz-apigw-id","value":"LHtQ6EPkSwMEg5A="},{"key":"x-amzn-RequestId","value":"d707d2c6-e03a-4118-8ef8-b7d7974354b9"},{"key":"x-amzn-ErrorType","value":"UnauthorizedException"},{"key":"X-Cache","value":"Error from cloudfront"},{"key":"Via","value":"1.1 c2b0b14414d87fbf9985559b5d1be1b0.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"BNE50-P1"},{"key":"X-Amz-Cf-Id","value":"XlFJcB5CGuDJvLht0XK_oLPfc3MzhF99vS0YEQFL3TWq5tOMQUy1qQ=="}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Unauthorized\"\n}"},{"id":"be59eff9-b400-4b8e-9fa7-0e9c46dab0c7","name":"403: Invalid API key","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"{{API_KEY}}1","type":"text"}],"url":{"raw":"{{BASE_URL}}/api/v2/careRecipients/:careRecipientId/infectionControl?page=1","host":["{{BASE_URL}}"],"path":["api","v2","careRecipients",":careRecipientId","infectionControl"],"query":[{"key":"page","value":"1"}],"variable":[{"key":"careRecipientId","value":"6f57349d-ebe1-460e-81f1-ce9c1778ee8b"}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"23"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Sun, 25 May 2025 11:01:29 GMT"},{"key":"x-amz-apigw-id","value":"LHvFfHsYywMESfQ="},{"key":"x-amzn-RequestId","value":"7b6b0b45-35bf-476a-8d27-4813de5060e7"},{"key":"x-amzn-ErrorType","value":"ForbiddenException"},{"key":"X-Cache","value":"Error from cloudfront"},{"key":"Via","value":"1.1 532bae2476fbb28a84cd6a0ce4a429b8.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"BNE50-P1"},{"key":"X-Amz-Cf-Id","value":"I3R4v8tiB4xx7vYYm9yQG7w8LQla4hVu-P72wv4Xo0rr4nkEVMNJPA=="}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Forbidden\"\n}"},{"id":"184bd1ac-5448-4502-8361-ba89e5d42fc5","name":"404: Invalid Care Recipient ID","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"{{API_KEY}}","type":"text"}],"url":{"raw":"{{BASE_URL}}/api/v2/careRecipients/:careRecipientId/infectionControl?page=1","host":["{{BASE_URL}}"],"path":["api","v2","careRecipients",":careRecipientId","infectionControl"],"query":[{"key":"page","value":"1"}],"variable":[{"key":"careRecipientId","value":"6f57349d-ebe1-460e-81f1-ce9c1778ee8b1"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"28"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Sun, 25 May 2025 11:33:35 GMT"},{"key":"X-Amzn-Trace-Id","value":"Root=1-6833000d-47067c70205ca2a2721e2ccc;Parent=33d08f44b4256f2d;Sampled=0;Lineage=1:50fd8138:0"},{"key":"x-amzn-RequestId","value":"fa435372-c5b9-4529-afa7-5dab92efb6ea"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"LHzyIEOPywMEQgA="},{"key":"X-Cache","value":"Error from cloudfront"},{"key":"Via","value":"1.1 9348b3d5d666c07df33489b432ed8cae.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"BNE50-P1"},{"key":"X-Amz-Cf-Id","value":"AMZRu0sDfCPQ7A2DlmqlXh243tJ2r7w7w71byORzfIh82VdE2s0tqw=="}],"cookie":[],"responseTime":null,"body":"{\n \"error\": \"Record Not Found\"\n}"}],"_postman_id":"931d9a0f-e065-4f88-92c3-8778939ff246"},{"name":"Get Behaviours","id":"33d0ba27-58cb-4288-a5a4-71f563184aff","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"client_authentication","value":""},{"key":"scope","value":"{{SCOPE}}"},{"key":"headerPrefix","value":""},{"key":"refreshTokenUrl","value":"{{AUTH_URL}}"},{"key":"accessTokenUrl","value":"{{AUTH_URL}}"},{"key":"clientSecret","value":"{{CLIENT_SECRET}}"},{"key":"clientId","value":"{{CLIENT_ID}}"},{"key":"tokenName","value":""},{"key":"grant_type","value":""},{"key":"password","value":"{{password}}"},{"key":"username","value":"{{username}}"}]},"isInherited":false},"method":"GET","header":[{"key":"x-api-key","value":"{{API_KEY}}","type":"text"}],"url":"{{BASE_URL}}/api/v2/careRecipients/:careRecipientId/behaviours?page=1","description":"

📄 Endpoint Overview

This endpoint returns a paginated list/array of Behaviours for a specific Care Recipient, with a maximum of 10 records per page.

A mandatory query parameter named page must be provided. To retrieve the initial set of results, set page=1.

The successful response includes pagination metadata such as:

behaviours: A paginated list of Behaviours (max 10 records)
\n
totalPages: Total number of pages available
\n
currentPage: Current page number returned
\n
totalRecords: Total number of Behaviours records in the system
\n

Response Schema

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Attribute	Type	Description
id	integer	Unique ID of the behaviour record.
createdOn	datetime	Timestamp when the behaviour record was created.
lastUpdatedOn	datetime	Timestamp when the behaviour record was last updated.
initialDateAndTimeOfBehaviour	datetime	Date and time the behaviour was first observed.
behaviour	object	Behavioural observations and details.
trigger	object	Triggers that may have caused the behaviour.
strategiesAndInterventions	object	Strategies and interventions applied in response.

Sub-object: behaviours[].behaviour

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Attribute	Type	Description
aggressionAgitation	boolean	Indicates presence of aggression/agitation.
aggressionAgitationOptions	object	Sub-options including comment, physical, verbal, etc.
compulsiveBehaviours	boolean	Indicates compulsive behaviour.
compulsiveBehaviourOptions	object	Sub-options including comment, hoarding, etc.
disorientation	boolean	Indicates disorientation behaviour.
disorientationOptions	object	Sub-options like wandering, other resident’s space.
otherBehaviours	boolean	Indicates presence of other behaviours.
otherBehavioursOptions	object	Comment describing other behaviours.
selfHarm	boolean	Indicates self-harming behaviour.
selfHarmOptions	object	Comment describing the self-harm.
verbal	boolean	Indicates verbal behaviours.
verbalOptions	object	Sub-options like delusional, paranoid, etc.

Sub-object: behaviours[].trigger

Attribute	Type	Description
approachBy	boolean	Triggered by approach.
approachByOptions	object	Options like staff, others, and comment.
attentionSeeking	boolean	Triggered by attention seeking.
attentionSeekingOptions	object	Describe the trigger.
communicationBarrier	boolean	Triggered by communication issues.
communicationBarrierOptions	object	Options like language, verbalisation, etc.
foodDrink	boolean	Triggered by food or drink.
foodDrinkOptions	object	Comment for the trigger.
incontinence	boolean	Triggered by incontinence.
incontinenceOptions	object	Comment for the trigger.
noise	boolean	Triggered by noise.
noiseOptions	object	Comment for the trigger.
other	boolean	Other unclassified triggers.
otherOptions	object	Comment for the trigger.
otherResident	boolean	Triggered by another resident.
otherResidentOptions	object	Comment for the trigger.
painPhysicalDiscomfort	boolean	Triggered by pain or discomfort.
painPhysicalDiscomfortOptions	object	Comment for the trigger.
substanceWithdrawal	boolean	Triggered by withdrawal symptoms.
substanceWithdrawalOptions	object	Options like alcohol, nicotine, comment, etc.
unknown	boolean	Trigger is unknown.
unknownOptions	object	Comment for the unknown trigger.

Sub-object: behaviours[].strategiesAndInterventions

Attribute	Type	Description
attendToPersonalCares	boolean	Strategy to address personal care.
attendToPersonalCaresOptions	object	Comment field.
humour	boolean	Strategy involving humour.
humourOptions	object	Comment field.
leaveResident	boolean	Strategy to leave and return to the resident later.
leaveResidentOptions	object	Sub-options like inOwnRoom, other, comment.
massageTactileTherapy	boolean	Strategy involving massage or tactile therapy.
massageTactileTherapyOptions	object	Comment field.
other	boolean	Other strategy.
otherOptions	object	Comment field.
painRelief	boolean	Pain relief intervention.
painReliefOptions	object	Sub-options: pharmacological, non-pharmacological, etc.
reassurance	boolean	Strategy involving reassurance.
reassuranceOptions	object	Comment field.
redirection	boolean	Strategy involving redirection.
redirectionOptions	object	Comment field.
reminiscing	boolean	Strategy involving reminiscing.
reminiscingOptions	object	Comment field.
visualMonitoring	boolean	Visual monitoring strategy.
visualMonitoringOptions	object	Comment field.

","urlObject":{"path":["api","v2","careRecipients",":careRecipientId","behaviours"],"host":["{{BASE_URL}}"],"query":[{"key":"page","value":"1"}],"variable":[{"type":"any","value":"{{CARE_RECIPIENT_ID}}","key":"careRecipientId"}]}},"response":[{"id":"719d825c-3a87-48a3-a856-5243690097a2","name":"200: Success","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"{{API_KEY}}","type":"text"}],"url":{"raw":"{{BASE_URL}}/api/v2/careRecipients/:careRecipientId/behaviours?page=1","host":["{{BASE_URL}}"],"path":["api","v2","careRecipients",":careRecipientId","behaviours"],"query":[{"key":"page","value":"1"}],"variable":[{"key":"careRecipientId","value":"6f57349d-ebe1-460e-81f1-ce9c1778ee8b"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"2439"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Sun, 25 May 2025 10:42:27 GMT"},{"key":"X-Amzn-Trace-Id","value":"Root=1-6832f411-03de4e7b2076735661842602;Parent=6a3004ccfacb5c9a;Sampled=0;Lineage=1:6e971fbe:0"},{"key":"x-amzn-RequestId","value":"d307e6c3-5d9d-48c1-8ae4-d969eb99c2f2"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"LHsSuF6aSwMEEnQ="},{"key":"X-Cache","value":"Miss from cloudfront"},{"key":"Via","value":"1.1 c2b0b14414d87fbf9985559b5d1be1b0.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"BNE50-P1"},{"key":"X-Amz-Cf-Id","value":"nUoscf-41KUCcDIPtOUGTs6Y1QGoK5FMlud3awEmVw2iz6RPRaWiaA=="}],"cookie":[],"responseTime":null,"body":"{\n \"behaviours\": [\n {\n \"behaviour\": {\n \"aggressionAgitation\": true,\n \"aggressionAgitationOptions\": {\n \"comment\": \"\",\n \"other\": false,\n \"physical\": false,\n \"threat\": false,\n \"verbal\": false\n },\n \"compulsiveBehaviours\": true,\n \"compulsiveBehaviourOptions\": {\n \"comment\": \"1\",\n \"hoarding\": true\n },\n \"disorientation\": false,\n \"disorientationOptions\": {\n \"comment\": \"\",\n \"other\": false,\n \"otherResidentsSpace\": false,\n \"wanderingOwnSpace\": false,\n \"withinFacility\": false\n },\n \"otherBehaviours\": false,\n \"otherBehavioursOptions\": {\n \"comment\": \"\"\n },\n \"selfHarm\": false,\n \"selfHarmOptions\": {\n \"comment\": \"\"\n },\n \"verbal\": true,\n \"verbalOptions\": {\n \"comment\": \"\",\n \"delusional\": false,\n \"disruptionToOthers\": false,\n \"inappropriateness\": true,\n \"other\": false,\n \"paranoid\": false,\n \"refuseToCare\": false\n }\n },\n \"createdOn\": \"2025-05-24T22:34:48.062+10:00\",\n \"id\": 582,\n \"initialDateAndTimeOfBehaviour\": \"2025-05-24T22:34:00.000+10:00\",\n \"lastUpdatedOn\": \"2025-05-24T22:34:48.062+10:00\",\n \"strategiesAndInterventions\": {\n \"attendToPersonalCares\": false,\n \"attendToPersonalCaresOptions\": {\n \"comment\": \"\"\n },\n \"humour\": false,\n \"humourOptions\": {\n \"comment\": \"\"\n },\n \"leaveResident\": false,\n \"leaveResidentOptions\": {\n \"comment\": \"\",\n \"inOwnRoom\": false,\n \"other\": false\n },\n \"massageTactileTherapy\": false,\n \"massageTactileTherapyOptions\": {\n \"comment\": \"\"\n },\n \"other\": false,\n \"otherOptions\": {\n \"comment\": \"\"\n },\n \"painRelief\": false,\n \"painReliefOptions\": {\n \"comment\": \"\",\n \"nonPharmacological\": false,\n \"other\": false,\n \"pharmacological\": false\n },\n \"reassurance\": true,\n \"reassuranceOptions\": {\n \"comment\": \"\"\n },\n \"redirection\": true,\n \"redirectionOptions\": {\n \"comment\": \"\"\n },\n \"reminiscing\": false,\n \"reminiscingOptions\": {\n \"comment\": \"\"\n },\n \"visualMonitoring\": false,\n \"visualMonitoringOptions\": {\n \"comment\": \"\"\n }\n },\n \"trigger\": {\n \"approachBy\": false,\n \"approachByOptions\": {\n \"comment\": \"\",\n \"others\": false,\n \"staff\": false\n },\n \"attentionSeeking\": false,\n \"attentionSeekingOptions\": {\n \"comment\": \"\"\n },\n \"communicationBarrier\": false,\n \"communicationBarrierOptions\": {\n \"comment\": \"\",\n \"inabilityToCommunicate\": false,\n \"language\": false,\n \"other\": false,\n \"verbalisation\": false\n },\n \"foodDrink\": true,\n \"foodDrinkOptions\": {\n \"comment\": \"3\"\n },\n \"incontinence\": false,\n \"incontinenceOptions\": {\n \"comment\": \"\"\n },\n \"noise\": false,\n \"noiseOptions\": {\n \"comment\": \"\"\n },\n \"other\": false,\n \"otherOptions\": {\n \"comment\": \"\"\n },\n \"otherResident\": true,\n \"otherResidentOptions\": {\n \"comment\": \"2\"\n },\n \"painPhysicalDiscomfort\": false,\n \"painPhysicalDiscomfortOptions\": {\n \"comment\": \"\"\n },\n \"substanceWithdrawal\": false,\n \"substanceWithdrawalOptions\": {\n \"alcohol\": false,\n \"comment\": \"\",\n \"nicotine\": false,\n \"other\": false\n },\n \"unknown\": false,\n \"unknownOptions\": {\n \"comment\": \"\"\n }\n }\n }\n ],\n \"totalPages\": 1,\n \"currentPage\": 1,\n \"totalRecords\": 1\n}"},{"id":"8c2a7f42-ba90-44ac-bfbf-048f6544ea6d","name":"400: Missing page query param","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"{{API_KEY}}","type":"text"}],"url":{"raw":"{{BASE_URL}}/api/v2/careRecipients/:careRecipientId/behaviours","host":["{{BASE_URL}}"],"path":["api","v2","careRecipients",":careRecipientId","behaviours"],"query":[{"key":"page","value":"1","disabled":true}],"variable":[{"key":"careRecipientId","value":"6f57349d-ebe1-460e-81f1-ce9c1778ee8b"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"58"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Sun, 25 May 2025 10:55:51 GMT"},{"key":"x-amz-apigw-id","value":"LHuQxFwAywMEREA="},{"key":"x-amzn-RequestId","value":"8b583279-bc02-4866-a1e0-670702d2efb6"},{"key":"x-amzn-ErrorType","value":"BadRequestException"},{"key":"X-Cache","value":"Error from cloudfront"},{"key":"Via","value":"1.1 532bae2476fbb28a84cd6a0ce4a429b8.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"BNE50-P1"},{"key":"X-Amz-Cf-Id","value":"5G69Ffsa0QfJpPWfvXFqgd_qLTzrd48Nzmgl6ILZT3Rp3QYvhnUyRw=="}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Missing required request parameters: [page]\"\n}"},{"id":"22532ce4-1ffc-49f8-b2fd-80071677ea3a","name":"401: Missing or Invalid Client ID or Secret or Scope","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"{{API_KEY}}","type":"text"}],"url":{"raw":"{{BASE_URL}}/api/v2/careRecipients/:careRecipientId/behaviours?page=1","host":["{{BASE_URL}}"],"path":["api","v2","careRecipients",":careRecipientId","behaviours"],"query":[{"key":"page","value":"1"}],"variable":[{"key":"careRecipientId","value":"6f57349d-ebe1-460e-81f1-ce9c1778ee8b"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"26"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Sun, 25 May 2025 10:49:34 GMT"},{"key":"x-amz-apigw-id","value":"LHtVyEFJSwMENzA="},{"key":"x-amzn-RequestId","value":"0cae64ec-8bf5-4b00-948e-7688ceeb1ad9"},{"key":"x-amzn-ErrorType","value":"UnauthorizedException"},{"key":"X-Cache","value":"Error from cloudfront"},{"key":"Via","value":"1.1 c2b0b14414d87fbf9985559b5d1be1b0.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"BNE50-P1"},{"key":"X-Amz-Cf-Id","value":"UxyicI4H4HWFiQZvgMCGA-HW-6rNZUxZ9UG1PGVP4U41zMOhP6azdg=="}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Unauthorized\"\n}"},{"id":"2dd52eac-7986-4095-8973-dd215ec4a80b","name":"403: Invalid API key","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"{{API_KEY}}1","type":"text"}],"url":{"raw":"{{BASE_URL}}/api/v2/careRecipients/:careRecipientId/behaviours?page=1","host":["{{BASE_URL}}"],"path":["api","v2","careRecipients",":careRecipientId","behaviours"],"query":[{"key":"page","value":"1"}],"variable":[{"key":"careRecipientId","value":"6f57349d-ebe1-460e-81f1-ce9c1778ee8b"}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"23"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Sun, 25 May 2025 11:01:41 GMT"},{"key":"x-amz-apigw-id","value":"LHvHZEOOywMEWVg="},{"key":"x-amzn-RequestId","value":"f0e72179-981b-4d76-a84f-0ef8eb2d0997"},{"key":"x-amzn-ErrorType","value":"ForbiddenException"},{"key":"X-Cache","value":"Error from cloudfront"},{"key":"Via","value":"1.1 532bae2476fbb28a84cd6a0ce4a429b8.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"BNE50-P1"},{"key":"X-Amz-Cf-Id","value":"gZ-ZdkNwLEepXYTkFPLAg_ELPa8A_1rNNfNJ_4Ysg1Q5b_WirAtiig=="}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Forbidden\"\n}"},{"id":"22731dfe-1aaa-4896-b4dd-dbead336ad36","name":"404: Invalid Care Recipient ID","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"{{API_KEY}}","type":"text"}],"url":{"raw":"{{BASE_URL}}/api/v2/careRecipients/:careRecipientId/behaviours?page=1","host":["{{BASE_URL}}"],"path":["api","v2","careRecipients",":careRecipientId","behaviours"],"query":[{"key":"page","value":"1"}],"variable":[{"key":"careRecipientId","value":"6f57349d-ebe1-460e-81f1-ce9c1778ee8b1"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"28"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Sun, 25 May 2025 11:34:02 GMT"},{"key":"X-Amzn-Trace-Id","value":"Root=1-68330028-061ac19224e3dd8d443301bc;Parent=5a80bf18c8975620;Sampled=0;Lineage=1:6e971fbe:0"},{"key":"x-amzn-RequestId","value":"84a254b5-6306-4cfe-831c-0d89835ab6ff"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"LHz2bHKLywMEg5A="},{"key":"X-Cache","value":"Error from cloudfront"},{"key":"Via","value":"1.1 9348b3d5d666c07df33489b432ed8cae.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"BNE50-P1"},{"key":"X-Amz-Cf-Id","value":"H9MyRnnQwAi6zVx2FcrZYMYk18McDUkAU58cGS-Aa0KrSM-jOEQd8A=="}],"cookie":[],"responseTime":null,"body":"{\n \"error\": \"Record Not Found\"\n}"}],"_postman_id":"33d0ba27-58cb-4288-a5a4-71f563184aff"},{"name":"Get Technical Nursing Requirements - Assessment","id":"f8f45b85-99e7-4062-bd73-bd5d610c446e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"client_authentication","value":""},{"key":"scope","value":"{{SCOPE}}"},{"key":"headerPrefix","value":""},{"key":"refreshTokenUrl","value":"{{AUTH_URL}}"},{"key":"accessTokenUrl","value":"{{AUTH_URL}}"},{"key":"clientSecret","value":"{{CLIENT_SECRET}}"},{"key":"clientId","value":"{{CLIENT_ID}}"},{"key":"tokenName","value":""},{"key":"grant_type","value":""},{"key":"password","value":"{{password}}"},{"key":"username","value":"{{username}}"}]},"isInherited":false},"method":"GET","header":[{"key":"x-api-key","value":"{{API_KEY}}","type":"text"}],"url":"{{BASE_URL}}/api/v2/careRecipients/:careRecipientId/technicalNursingRequirements?page=1","description":"

📄 Endpoint Overview

This endpoint returns a paginated list/array of Technical Nursing Requirements for a specific Care Recipient, with a maximum of 10 records per page.

A mandatory query parameter named page must be provided. To retrieve the initial set of results, set page=1.

The successful response includes pagination metadata such as:

technicalNursingRequirements: A paginated list of Technical Nursing Requirements (max 10 records)
\n
totalPages: Total number of pages available
\n
currentPage: Current page number returned
\n
totalRecords: Total number of Technical Nursing Requirements records in the system
\n

Response Schema

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Attribute	Type	Description
id	integer	Unique identifier for the technical nursing requirement record.
createdBy	string	Name of the person who created the record. Can be null.
createdOn	datetime	Timestamp when the record was created.
lastUpdatedOn	datetime	Timestamp of the last update.
lastReviewedBy	string	Name of the person who last reviewed the record. Can be null.
reviewDate	date	Date of the review. Can be null.
reviewComments	string	Comments associated with the review. Can be null.
catheter	boolean	Indicates if catheter care is required.
complexWoundManagement	boolean	Indicates if complex wound care is needed.
dailyInjections	boolean	Indicates if daily injections are administered.
enteralFeeding	boolean	Indicates if enteral feeding is required.
oxygen	boolean	Indicates if oxygen support is needed.
peritonealDialysis	boolean	Indicates if peritoneal dialysis is required.
requireThreeOrMorePeopleForTransfers	boolean	Indicates if three or more people are required for transfers.
stoma	boolean	Indicates if stoma care is necessary.
tracheostomy	boolean	Indicates if tracheostomy care is necessary.

","urlObject":{"path":["api","v2","careRecipients",":careRecipientId","technicalNursingRequirements"],"host":["{{BASE_URL}}"],"query":[{"key":"page","value":"1"}],"variable":[{"type":"any","value":"{{CARE_RECIPIENT_ID}}","key":"careRecipientId"}]}},"response":[{"id":"edfedd5c-a9ac-4ee0-ba0a-9573f020696d","name":"200: Success","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"{{API_KEY}}","type":"text"}],"url":{"raw":"{{BASE_URL}}/api/v2/careRecipients/:careRecipientId/technicalNursingRequirements?page=1","host":["{{BASE_URL}}"],"path":["api","v2","careRecipients",":careRecipientId","technicalNursingRequirements"],"query":[{"key":"page","value":"1"}],"variable":[{"key":"careRecipientId","value":"6f57349d-ebe1-460e-81f1-ce9c1778ee8b"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"514"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Sun, 25 May 2025 10:42:43 GMT"},{"key":"X-Amzn-Trace-Id","value":"Root=1-6832f421-62e5d6473eac89f601729af3;Parent=733209d3cee42891;Sampled=0;Lineage=1:8c791136:0"},{"key":"x-amzn-RequestId","value":"f9cc92bf-b949-4327-8230-a59e626a9a2d"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"LHsVSHq1SwMEKNA="},{"key":"X-Cache","value":"Miss from cloudfront"},{"key":"Via","value":"1.1 c2b0b14414d87fbf9985559b5d1be1b0.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"BNE50-P1"},{"key":"X-Amz-Cf-Id","value":"SUokyceVHjciugLDI4iXEPpvf2hBP0IWtCh1iZ016mRHmRKkT9Olkg=="}],"cookie":[],"responseTime":null,"body":"{\n \"technicalNursingRequirements\": [\n {\n \"catheter\": false,\n \"complexWoundManagement\": false,\n \"createdBy\": \"Linton Pinto (RN)\",\n \"createdOn\": \"2025-05-24T22:41:23.194+10:00\",\n \"dailyInjections\": true,\n \"enteralFeeding\": false,\n \"id\": 24,\n \"lastUpdatedOn\": \"2025-05-24T22:41:23.194+10:00\",\n \"oxygen\": true,\n \"peritonealDialysis\": false,\n \"requireThreeOrMorePeopleForTransfers\": true,\n \"reviewComments\": \"123\",\n \"reviewDate\": \"2025-05-23\",\n \"stoma\": true,\n \"tracheostomy\": true,\n \"lastReviewedBy\": \"Linton Pinto (RN)\"\n }\n ],\n \"totalPages\": 1,\n \"currentPage\": 1,\n \"totalRecords\": 1\n}"},{"id":"6e1e2f30-3468-4ee0-9e59-77d26e006d43","name":"400: Missing page query param","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"{{API_KEY}}","type":"text"}],"url":{"raw":"{{BASE_URL}}/api/v2/careRecipients/:careRecipientId/technicalNursingRequirements","host":["{{BASE_URL}}"],"path":["api","v2","careRecipients",":careRecipientId","technicalNursingRequirements"],"query":[{"key":"page","value":"1","disabled":true}],"variable":[{"key":"careRecipientId","value":"6f57349d-ebe1-460e-81f1-ce9c1778ee8b"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"58"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Sun, 25 May 2025 10:56:04 GMT"},{"key":"x-amz-apigw-id","value":"LHuSuFTDSwMEU4Q="},{"key":"x-amzn-RequestId","value":"3001af8e-ab08-458d-88be-e4a47dad7bad"},{"key":"x-amzn-ErrorType","value":"BadRequestException"},{"key":"X-Cache","value":"Error from cloudfront"},{"key":"Via","value":"1.1 532bae2476fbb28a84cd6a0ce4a429b8.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"BNE50-P1"},{"key":"X-Amz-Cf-Id","value":"ZEZA17jJwC64k_tLspHHQMwXsEhEtv6tW53B4aVAao55xmv7XHylfw=="}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Missing required request parameters: [page]\"\n}"},{"id":"392a8e44-b28e-4554-8fd6-5aa989b54916","name":"401: Missing or Invalid Client ID or Secret or Scope","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"{{API_KEY}}","type":"text"}],"url":{"raw":"{{BASE_URL}}/api/v2/careRecipients/:careRecipientId/technicalNursingRequirements?page=1","host":["{{BASE_URL}}"],"path":["api","v2","careRecipients",":careRecipientId","technicalNursingRequirements"],"query":[{"key":"page","value":"1"}],"variable":[{"key":"careRecipientId","value":"6f57349d-ebe1-460e-81f1-ce9c1778ee8b"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"26"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Sun, 25 May 2025 10:50:00 GMT"},{"key":"x-amz-apigw-id","value":"LHtZ9Fq4ywMEktw="},{"key":"x-amzn-RequestId","value":"dc9ec884-ce30-4d1a-a220-b0691a2d5dd6"},{"key":"x-amzn-ErrorType","value":"UnauthorizedException"},{"key":"X-Cache","value":"Error from cloudfront"},{"key":"Via","value":"1.1 c2b0b14414d87fbf9985559b5d1be1b0.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"BNE50-P1"},{"key":"X-Amz-Cf-Id","value":"IyhcBQARB2YoZowM018_S0q98Ll4N78x3r1K3xr2VtshQF9aRjqSYw=="}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Unauthorized\"\n}"},{"id":"8517a63d-b731-445c-ac50-0afb246d207d","name":"403: Invalid API key","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"{{API_KEY}}1","type":"text"}],"url":{"raw":"{{BASE_URL}}/api/v2/careRecipients/:careRecipientId/technicalNursingRequirements?page=1","host":["{{BASE_URL}}"],"path":["api","v2","careRecipients",":careRecipientId","technicalNursingRequirements"],"query":[{"key":"page","value":"1"}],"variable":[{"key":"careRecipientId","value":"6f57349d-ebe1-460e-81f1-ce9c1778ee8b"}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"23"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Sun, 25 May 2025 11:02:20 GMT"},{"key":"x-amz-apigw-id","value":"LHvNiFhTywMEg5A="},{"key":"x-amzn-RequestId","value":"6bf2d28a-ef94-4edf-b91d-55ef47e9d87d"},{"key":"x-amzn-ErrorType","value":"ForbiddenException"},{"key":"X-Cache","value":"Error from cloudfront"},{"key":"Via","value":"1.1 532bae2476fbb28a84cd6a0ce4a429b8.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"BNE50-P1"},{"key":"X-Amz-Cf-Id","value":"CZoTcvBP1cWFnDkSS0Ql2b-hw3CE3osijDtOfQnItKZKoOuC_wOxsw=="}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Forbidden\"\n}"},{"id":"dfdea659-0faa-4af3-854e-dae4c3f5c64e","name":"404: Invalid Care Recipient ID","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"{{API_KEY}}","type":"text"}],"url":{"raw":"{{BASE_URL}}/api/v2/careRecipients/:careRecipientId/technicalNursingRequirements?page=1","host":["{{BASE_URL}}"],"path":["api","v2","careRecipients",":careRecipientId","technicalNursingRequirements"],"query":[{"key":"page","value":"1"}],"variable":[{"key":"careRecipientId","value":"6f57349d-ebe1-460e-81f1-ce9c1778ee8b1"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"28"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Sun, 25 May 2025 11:34:21 GMT"},{"key":"X-Amzn-Trace-Id","value":"Root=1-6833003b-7c9390cd09cfc3b855207212;Parent=4c4b070b753229cc;Sampled=0;Lineage=1:8c791136:0"},{"key":"x-amzn-RequestId","value":"5b751d67-96f4-4b39-bead-9f8e69ffd0fd"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"LHz5WGavSwMEgYQ="},{"key":"X-Cache","value":"Error from cloudfront"},{"key":"Via","value":"1.1 9348b3d5d666c07df33489b432ed8cae.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"BNE50-P1"},{"key":"X-Amz-Cf-Id","value":"pNuwDh216zZtuA2QaBbEyYDrREAziXrvP12cLKGCgUQ5Tx5ynHdWHw=="}],"cookie":[],"responseTime":null,"body":"{\n \"error\": \"Record Not Found\"\n}"}],"_postman_id":"f8f45b85-99e7-4062-bd73-bd5d610c446e"},{"name":"Get RUG ADLs (Resource Utilisation Group Activities of Daily Living) - Assessment","id":"0ba1996a-c6fc-4bb4-b288-b5bdaac65f25","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"client_authentication","value":""},{"key":"scope","value":"{{SCOPE}}"},{"key":"headerPrefix","value":""},{"key":"refreshTokenUrl","value":"{{AUTH_URL}}"},{"key":"accessTokenUrl","value":"{{AUTH_URL}}"},{"key":"clientSecret","value":"{{CLIENT_SECRET}}"},{"key":"clientId","value":"{{CLIENT_ID}}"},{"key":"tokenName","value":""},{"key":"grant_type","value":""},{"key":"password","value":"{{password}}"},{"key":"username","value":"{{username}}"}]},"isInherited":false},"method":"GET","header":[{"key":"x-api-key","value":"{{API_KEY}}","type":"text"}],"url":"{{BASE_URL}}/api/v2/careRecipients/:careRecipientId/rugAdls?page=1","description":"

📄 Endpoint Overview

This endpoint returns a paginated list/array of RUG ADLs for a specific Care Recipient, with a maximum of 10 records per page.

A mandatory query parameter named page must be provided. To retrieve the initial set of results, set page=1.

The successful response includes pagination metadata such as:

rugAdls: A paginated list of RUG ADLs (max 10 records)
\n
totalPages: Total number of pages available
\n
currentPage: Current page number returned
\n
totalRecords: Total number of RUG ADLs records in the system
\n

Response Schema

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Attribute	Type	Description
id	integer	Unique identifier for the RUG ADL record.
createdBy	string	Name of the person who created the record.
createdOn	datetime	Timestamp when the record was created.
lastReviewedBy	string	Name of the person who last reviewed the record.
lastUpdatedOn	datetime	Timestamp of the last update.
reviewDate	date	Date when the review occurred. Can be null.
reviewComments	string	Comments related to the review. Can be null.
bedMobility	integer	ADL score for bed mobility. Can be null.
eating	integer	ADL score for eating. Can be null.
toileting	integer	ADL score for toileting. Can be null.
transfer	integer	ADL score for transferring. Can be null.
totalScore	integer	Sum of ADL component scores. Can be null.

","urlObject":{"path":["api","v2","careRecipients",":careRecipientId","rugAdls"],"host":["{{BASE_URL}}"],"query":[{"key":"page","value":"1"}],"variable":[{"type":"any","value":"{{CARE_RECIPIENT_ID}}","key":"careRecipientId"}]}},"response":[{"id":"d066f7d5-6771-4574-b096-947867b9550c","name":"200: Success","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"{{API_KEY}}","type":"text"}],"url":{"raw":"{{BASE_URL}}/api/v2/careRecipients/:careRecipientId/rugAdls?page=1","host":["{{BASE_URL}}"],"path":["api","v2","careRecipients",":careRecipientId","rugAdls"],"query":[{"key":"page","value":"1"}],"variable":[{"key":"careRecipientId","value":"6f57349d-ebe1-460e-81f1-ce9c1778ee8b"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"351"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Sun, 25 May 2025 10:42:59 GMT"},{"key":"X-Amzn-Trace-Id","value":"Root=1-6832f431-4b7f85720d99de8201011bbf;Parent=1f1d357a6e4bff3e;Sampled=0;Lineage=1:8d1a2b78:0"},{"key":"x-amzn-RequestId","value":"aa12e363-8f31-4222-8a92-b2ee7d058ee2"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"LHsXxGP8SwMElqg="},{"key":"X-Cache","value":"Miss from cloudfront"},{"key":"Via","value":"1.1 c2b0b14414d87fbf9985559b5d1be1b0.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"BNE50-P1"},{"key":"X-Amz-Cf-Id","value":"fk5cCZACTppjoRuvpCrzFwaSxrVGl76kZdfaI3EExLqnovWmCygT7g=="}],"cookie":[],"responseTime":null,"body":"{\n \"rugAdls\": [\n {\n \"bedMobility\": 1,\n \"createdBy\": \"Linton Pinto (RN)\",\n \"createdOn\": \"2025-05-24T22:44:58.453+10:00\",\n \"eating\": 2,\n \"id\": 15,\n \"lastReviewedBy\": \"Linton Pinto (RN)\",\n \"lastUpdatedOn\": \"2025-05-24T22:44:58.453+10:00\",\n \"reviewComments\": \"123\",\n \"reviewDate\": \"2025-05-14\",\n \"toileting\": 3,\n \"totalScore\": 10,\n \"transfer\": 4\n }\n ],\n \"totalPages\": 1,\n \"currentPage\": 1,\n \"totalRecords\": 1\n}"},{"id":"7344ff4d-188a-4558-8f8d-382469241581","name":"400: Missing page query param","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"{{API_KEY}}","type":"text"}],"url":{"raw":"{{BASE_URL}}/api/v2/careRecipients/:careRecipientId/rugAdls","host":["{{BASE_URL}}"],"path":["api","v2","careRecipients",":careRecipientId","rugAdls"],"query":[{"key":"page","value":"1","disabled":true}],"variable":[{"key":"careRecipientId","value":"6f57349d-ebe1-460e-81f1-ce9c1778ee8b"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"58"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Sun, 25 May 2025 10:56:18 GMT"},{"key":"x-amz-apigw-id","value":"LHuU-HLeywMECDA="},{"key":"x-amzn-RequestId","value":"14bf49b5-977f-493d-829e-464f8e07e8a1"},{"key":"x-amzn-ErrorType","value":"BadRequestException"},{"key":"X-Cache","value":"Error from cloudfront"},{"key":"Via","value":"1.1 532bae2476fbb28a84cd6a0ce4a429b8.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"BNE50-P1"},{"key":"X-Amz-Cf-Id","value":"klK_yxDte-woTV4Bqkf_-Vdn0gnxFekBy5Alrbft2EdGSfTh2vNh2g=="}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Missing required request parameters: [page]\"\n}"},{"id":"60e14c3f-68b2-4c6f-987b-285f0282b9b8","name":"401: Missing or Invalid Client ID or Secret or Scope","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"{{API_KEY}}","type":"text"}],"url":{"raw":"{{BASE_URL}}/api/v2/careRecipients/:careRecipientId/rugAdls?page=1","host":["{{BASE_URL}}"],"path":["api","v2","careRecipients",":careRecipientId","rugAdls"],"query":[{"key":"page","value":"1"}],"variable":[{"key":"careRecipientId","value":"6f57349d-ebe1-460e-81f1-ce9c1778ee8b"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"26"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Sun, 25 May 2025 10:50:32 GMT"},{"key":"x-amz-apigw-id","value":"LHte6FvDSwMEU3A="},{"key":"x-amzn-RequestId","value":"b6aeb1ec-1830-4196-bf15-3dfc3ac7b4e2"},{"key":"x-amzn-ErrorType","value":"UnauthorizedException"},{"key":"X-Cache","value":"Error from cloudfront"},{"key":"Via","value":"1.1 c2b0b14414d87fbf9985559b5d1be1b0.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"BNE50-P1"},{"key":"X-Amz-Cf-Id","value":"u9obWlpeDvNCA2brcsEMt0rE3A8tcaNhkSJY84s93RvXAFvuCf7ceg=="}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Unauthorized\"\n}"},{"id":"966beb41-a3ee-42a2-b164-62446a627f48","name":"403: Invalid API key","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"{{API_KEY}}1","type":"text"}],"url":{"raw":"{{BASE_URL}}/api/v2/careRecipients/:careRecipientId/rugAdls?page=1","host":["{{BASE_URL}}"],"path":["api","v2","careRecipients",":careRecipientId","rugAdls"],"query":[{"key":"page","value":"1"}],"variable":[{"key":"careRecipientId","value":"6f57349d-ebe1-460e-81f1-ce9c1778ee8b"}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"23"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Sun, 25 May 2025 11:02:33 GMT"},{"key":"x-amz-apigw-id","value":"LHvPlEboywMEGNQ="},{"key":"x-amzn-RequestId","value":"55caa41b-7f69-42dd-a93f-a6bae40814d8"},{"key":"x-amzn-ErrorType","value":"ForbiddenException"},{"key":"X-Cache","value":"Error from cloudfront"},{"key":"Via","value":"1.1 532bae2476fbb28a84cd6a0ce4a429b8.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"BNE50-P1"},{"key":"X-Amz-Cf-Id","value":"6CrCoWcbsnvWSWgxi1BfeI2Dad3zxTzyecSQT5Fae7OLUwt6xYl8hw=="}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Forbidden\"\n}"},{"id":"2cfd76fb-ed3a-41fe-a6ef-b840d20ecb90","name":"404: Invalid Care Recipient ID","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"{{API_KEY}}","type":"text"}],"url":{"raw":"{{BASE_URL}}/api/v2/careRecipients/:careRecipientId/rugAdls?page=1","host":["{{BASE_URL}}"],"path":["api","v2","careRecipients",":careRecipientId","rugAdls"],"query":[{"key":"page","value":"1"}],"variable":[{"key":"careRecipientId","value":"6f57349d-ebe1-460e-81f1-ce9c1778ee8b1"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"28"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Sun, 25 May 2025 11:34:40 GMT"},{"key":"X-Amzn-Trace-Id","value":"Root=1-6833004e-55a1c641459248f01c05d9d1;Parent=4f58e5ae851fc255;Sampled=0;Lineage=1:8d1a2b78:0"},{"key":"x-amzn-RequestId","value":"5d06eae5-ce17-4539-becd-a43497f9260b"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"LHz8UHkbywMEqIA="},{"key":"X-Cache","value":"Error from cloudfront"},{"key":"Via","value":"1.1 9348b3d5d666c07df33489b432ed8cae.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"BNE50-P1"},{"key":"X-Amz-Cf-Id","value":"B7pA7EGRJdyLGxW1nwIpGBh-Tb0whH0MzViJHFaGIYhLPEkJNnrWTA=="}],"cookie":[],"responseTime":null,"body":"{\n \"error\": \"Record Not Found\"\n}"}],"_postman_id":"0ba1996a-c6fc-4bb4-b288-b5bdaac65f25"},{"name":"Get AKPS (Australia-modified Karnofsky Perfomance Status) - Assessment","id":"4f77b553-a4cb-456f-a716-1d4c21c86688","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"client_authentication","value":""},{"key":"scope","value":"{{SCOPE}}"},{"key":"headerPrefix","value":""},{"key":"refreshTokenUrl","value":"{{AUTH_URL}}"},{"key":"accessTokenUrl","value":"{{AUTH_URL}}"},{"key":"clientSecret","value":"{{CLIENT_SECRET}}"},{"key":"clientId","value":"{{CLIENT_ID}}"},{"key":"tokenName","value":""},{"key":"grant_type","value":""},{"key":"password","value":"{{password}}"},{"key":"username","value":"{{username}}"}]},"isInherited":false},"method":"GET","header":[{"key":"x-api-key","value":"{{API_KEY}}","type":"text"}],"url":"{{BASE_URL}}/api/v2/careRecipients/:careRecipientId/akps?page=1","description":"

📄 Endpoint Overview

This endpoint returns a paginated list/array of AKPS for a specific Care Recipient, with a maximum of 10 records per page.

A mandatory query parameter named page must be provided. To retrieve the initial set of results, set page=1.

The successful response includes pagination metadata such as:

akps: A paginated list of AKPS (max 10 records)
\n
totalPages: Total number of pages available
\n
currentPage: Current page number returned
\n
totalRecords: Total number of AKPS records in the system
\n

Response Schema

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Attribute	Type	Description
id	integer	Unique identifier for the AKPS assessment record.
createdBy	string	Name of the user who created the record.
createdOn	datetime	Timestamp when the assessment was created.
lastReviewedBy	string	Name of the user who last reviewed the record.
lastUpdatedOn	datetime	Timestamp when the record was last updated.
reviewDate	date	Date of the AKPS assessment. Can be null.
reviewComments	string	Any comments or notes added during review. Can be null.
status	string	AKPS status in the format : (e.g., “90: Able to…”).

","urlObject":{"path":["api","v2","careRecipients",":careRecipientId","akps"],"host":["{{BASE_URL}}"],"query":[{"key":"page","value":"1"}],"variable":[{"type":"any","value":"{{CARE_RECIPIENT_ID}}","key":"careRecipientId"}]}},"response":[{"id":"0c4a24b6-2b31-4978-9bf3-0cdc6e397127","name":"200: Success","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"{{API_KEY}}","type":"text"}],"url":{"raw":"{{BASE_URL}}/api/v2/careRecipients/:careRecipientId/akps?page=1","host":["{{BASE_URL}}"],"path":["api","v2","careRecipients",":careRecipientId","akps"],"query":[{"key":"page","value":"1"}],"variable":[{"key":"careRecipientId","value":"6f57349d-ebe1-460e-81f1-ce9c1778ee8b"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"363"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Sun, 25 May 2025 10:43:16 GMT"},{"key":"X-Amzn-Trace-Id","value":"Root=1-6832f442-1e23b2937b2f01d20c6e4cbc;Parent=2fb4fecf80e5ea5f;Sampled=0;Lineage=1:85d6edbb:0"},{"key":"x-amzn-RequestId","value":"dcc39b67-fa35-4c9b-a5a9-57949fafc2f2"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"LHsaeFndSwMEGNQ="},{"key":"X-Cache","value":"Miss from cloudfront"},{"key":"Via","value":"1.1 c2b0b14414d87fbf9985559b5d1be1b0.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"BNE50-P1"},{"key":"X-Amz-Cf-Id","value":"gIM3MUXQiEule2sN_Ot6EwR3dZOS0DWOtt-PQwpbTCi6zVokY0rpSA=="}],"cookie":[],"responseTime":null,"body":"{\n \"akps\": [\n {\n \"createdBy\": \"Linton Pinto (RN)\",\n \"createdOn\": \"2025-05-24T23:11:17.937+10:00\",\n \"id\": 12,\n \"lastReviewedBy\": \"Linton Pinto (RN)\",\n \"lastUpdatedOn\": \"2025-05-24T23:11:17.937+10:00\",\n \"reviewComments\": \"12344\",\n \"reviewDate\": \"2025-05-15\",\n \"status\": \"90: Able to carry on normal activity; minor sign of symptoms of disease\"\n }\n ],\n \"totalPages\": 1,\n \"currentPage\": 1,\n \"totalRecords\": 1\n}"},{"id":"3262ef06-c8f8-4ca0-af31-552ee58136aa","name":"400: Missing page query param","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"{{API_KEY}}","type":"text"}],"url":{"raw":"{{BASE_URL}}/api/v2/careRecipients/:careRecipientId/akps","host":["{{BASE_URL}}"],"path":["api","v2","careRecipients",":careRecipientId","akps"],"query":[{"key":"page","value":"1","disabled":true}],"variable":[{"key":"careRecipientId","value":"6f57349d-ebe1-460e-81f1-ce9c1778ee8b"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"58"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Sun, 25 May 2025 10:56:33 GMT"},{"key":"x-amz-apigw-id","value":"LHuXUHPkywMENzA="},{"key":"x-amzn-RequestId","value":"b963ed4b-2f38-413a-8e4e-63b7d2e0082d"},{"key":"x-amzn-ErrorType","value":"BadRequestException"},{"key":"X-Cache","value":"Error from cloudfront"},{"key":"Via","value":"1.1 532bae2476fbb28a84cd6a0ce4a429b8.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"BNE50-P1"},{"key":"X-Amz-Cf-Id","value":"VrOlhZPp-Bweui7FrDag8hCycg3K6ydzFVhDseH5DLl8QCHpSPlY4g=="}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Missing required request parameters: [page]\"\n}"},{"id":"b373875f-f590-4c1e-a2d8-cba7bb0bc4a1","name":"401: Missing or Invalid Client ID or Secret or Scope","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"{{API_KEY}}","type":"text"}],"url":{"raw":"{{BASE_URL}}/api/v2/careRecipients/:careRecipientId/akps?page=1","host":["{{BASE_URL}}"],"path":["api","v2","careRecipients",":careRecipientId","akps"],"query":[{"key":"page","value":"1"}],"variable":[{"key":"careRecipientId","value":"6f57349d-ebe1-460e-81f1-ce9c1778ee8b"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"26"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Sun, 25 May 2025 10:50:57 GMT"},{"key":"x-amz-apigw-id","value":"LHtivG46SwMEm9Q="},{"key":"x-amzn-RequestId","value":"a909cb7b-b4cf-4e96-b1e0-b27424b35b26"},{"key":"x-amzn-ErrorType","value":"UnauthorizedException"},{"key":"X-Cache","value":"Error from cloudfront"},{"key":"Via","value":"1.1 c2b0b14414d87fbf9985559b5d1be1b0.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"BNE50-P1"},{"key":"X-Amz-Cf-Id","value":"kNokum0AowLhwn4kqABR0RGhXstwxaOb3K02TE0wbWFBn0aTRhqFmQ=="}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Unauthorized\"\n}"},{"id":"4a41e0e2-2c84-4f78-a828-a25afdb597fd","name":"403: Invalid API key","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"{{API_KEY}}1","type":"text"}],"url":{"raw":"{{BASE_URL}}/api/v2/careRecipients/:careRecipientId/akps?page=1","host":["{{BASE_URL}}"],"path":["api","v2","careRecipients",":careRecipientId","akps"],"query":[{"key":"page","value":"1"}],"variable":[{"key":"careRecipientId","value":"6f57349d-ebe1-460e-81f1-ce9c1778ee8b"}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"23"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Sun, 25 May 2025 11:02:47 GMT"},{"key":"x-amz-apigw-id","value":"LHvRtEM_ywMEUoQ="},{"key":"x-amzn-RequestId","value":"f9d865fa-cc80-45b0-a018-ff7350bd8f58"},{"key":"x-amzn-ErrorType","value":"ForbiddenException"},{"key":"X-Cache","value":"Error from cloudfront"},{"key":"Via","value":"1.1 532bae2476fbb28a84cd6a0ce4a429b8.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"BNE50-P1"},{"key":"X-Amz-Cf-Id","value":"c_KQbUfSQ5aBfrLU7P1AZlS0Mx7AsedCOTnfbWzj-laHhDCyP1iRIQ=="}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Forbidden\"\n}"},{"id":"998bbf03-ffbe-4c0f-aede-586bff3a1582","name":"404: Invalid Care Recipient ID","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"{{API_KEY}}","type":"text"}],"url":{"raw":"{{BASE_URL}}/api/v2/careRecipients/:careRecipientId/akps?page=1","host":["{{BASE_URL}}"],"path":["api","v2","careRecipients",":careRecipientId","akps"],"query":[{"key":"page","value":"1"}],"variable":[{"key":"careRecipientId","value":"6f57349d-ebe1-460e-81f1-ce9c1778ee8b1"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"28"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Sun, 25 May 2025 11:34:57 GMT"},{"key":"X-Amzn-Trace-Id","value":"Root=1-6833005f-729bbaae2bccdedc53d6d5e7;Parent=24f0d4391d3d46bd;Sampled=0;Lineage=1:85d6edbb:0"},{"key":"x-amzn-RequestId","value":"864a4bb8-6933-4e5e-9311-3b3027d53aed"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"LHz--FNEywMEo0w="},{"key":"X-Cache","value":"Error from cloudfront"},{"key":"Via","value":"1.1 9348b3d5d666c07df33489b432ed8cae.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"BNE50-P1"},{"key":"X-Amz-Cf-Id","value":"asUWwT1Zc3C-8OSGyw75dZNcum--LJ0D9QRRmqEYstjxP67LkG9x4w=="}],"cookie":[],"responseTime":null,"body":"{\n \"error\": \"Record Not Found\"\n}"}],"_postman_id":"4f77b553-a4cb-456f-a716-1d4c21c86688"},{"name":"Get Palliative Cares - Assessment","id":"c4e14cf6-b8af-40bd-ab89-9ebb95ec46b1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"client_authentication","value":""},{"key":"scope","value":"{{SCOPE}}"},{"key":"headerPrefix","value":""},{"key":"refreshTokenUrl","value":"{{AUTH_URL}}"},{"key":"accessTokenUrl","value":"{{AUTH_URL}}"},{"key":"clientSecret","value":"{{CLIENT_SECRET}}"},{"key":"clientId","value":"{{CLIENT_ID}}"},{"key":"tokenName","value":""},{"key":"grant_type","value":""},{"key":"password","value":"{{password}}"},{"key":"username","value":"{{username}}"}]},"isInherited":false},"method":"GET","header":[{"key":"x-api-key","value":"{{API_KEY}}","type":"text"}],"url":"{{BASE_URL}}/api/v2/careRecipients/:careRecipientId/palliativeCares?page=1","description":"

📄 Endpoint Overview

This endpoint returns a paginated list/array of Palliative Cares for a specific Care Recipient, with a maximum of 10 records per page.

A mandatory query parameter named page must be provided. To retrieve the initial set of results, set page=1.

The successful response includes pagination metadata such as:

palliativeCares: A paginated list of Palliative Cares (max 10 records)
\n
totalPages: Total number of pages available
\n
currentPage: Current page number returned
\n
totalRecords: Total number of Palliative Cares records in the system
\n

Response Schema

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Attribute	Type	Description
id	integer	Unique identifier for the palliative care assessment record.
createdBy	string	Name of the user who created the record.
createdOn	datetime	Timestamp when the record was created.
lastReviewedBy	string	Name of the user who last reviewed the record.
lastUpdatedOn	datetime	Timestamp when the record was last updated.
reviewDate	date	Date of the palliative care review. Can be null.
reviewComments	string	Review comments or notes. Can be null.

","urlObject":{"path":["api","v2","careRecipients",":careRecipientId","palliativeCares"],"host":["{{BASE_URL}}"],"query":[{"key":"page","value":"1"}],"variable":[{"type":"any","value":"{{CARE_RECIPIENT_ID}}","key":"careRecipientId"}]}},"response":[{"id":"c73d105a-feda-4049-9fb2-a64e9092aaa9","name":"200: Success","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"{{API_KEY}}","type":"text"}],"url":{"raw":"{{BASE_URL}}/api/v2/careRecipients/:careRecipientId/palliativeCares?page=1","host":["{{BASE_URL}}"],"path":["api","v2","careRecipients",":careRecipientId","palliativeCares"],"query":[{"key":"page","value":"1"}],"variable":[{"key":"careRecipientId","value":"6f57349d-ebe1-460e-81f1-ce9c1778ee8b"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"290"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Sun, 25 May 2025 10:43:46 GMT"},{"key":"X-Amzn-Trace-Id","value":"Root=1-6832f460-2832bc75176488917de11331;Parent=6e8c84be497a6a35;Sampled=0;Lineage=1:82092459:0"},{"key":"x-amzn-RequestId","value":"89a01342-f649-42fb-98c8-7a0ab7b33fc3"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"LHsfLE8qywMEUGA="},{"key":"X-Cache","value":"Miss from cloudfront"},{"key":"Via","value":"1.1 c2b0b14414d87fbf9985559b5d1be1b0.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"BNE50-P1"},{"key":"X-Amz-Cf-Id","value":"8OUYRL-9L1Z1oCySqbTfY0F4dE3nxzUMvekD_TXV6CpEYRUUu1UruQ=="}],"cookie":[],"responseTime":null,"body":"{\n \"palliativeCares\": [\n {\n \"createdBy\": \"Linton Pinto (RN)\",\n \"createdOn\": \"2025-05-24T23:11:49.483+10:00\",\n \"id\": 48,\n \"lastReviewedBy\": \"Linton Pinto (RN)\",\n \"lastUpdatedOn\": \"2025-05-24T23:11:49.483+10:00\",\n \"reviewComments\": \"1234\",\n \"reviewDate\": \"2025-05-14\"\n }\n ],\n \"totalPages\": 1,\n \"currentPage\": 1,\n \"totalRecords\": 1\n}"},{"id":"307f320d-5433-40d7-a891-00653cf8d6ee","name":"400: Missing page query param","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"{{API_KEY}}","type":"text"}],"url":{"raw":"{{BASE_URL}}/api/v2/careRecipients/:careRecipientId/palliativeCares","host":["{{BASE_URL}}"],"path":["api","v2","careRecipients",":careRecipientId","palliativeCares"],"query":[{"key":"page","value":"1","disabled":true}],"variable":[{"key":"careRecipientId","value":"6f57349d-ebe1-460e-81f1-ce9c1778ee8b"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"58"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Sun, 25 May 2025 10:56:47 GMT"},{"key":"x-amz-apigw-id","value":"LHuZdGwxywMEiCQ="},{"key":"x-amzn-RequestId","value":"ef6fda75-aded-4572-b42d-f04db30c611a"},{"key":"x-amzn-ErrorType","value":"BadRequestException"},{"key":"X-Cache","value":"Error from cloudfront"},{"key":"Via","value":"1.1 532bae2476fbb28a84cd6a0ce4a429b8.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"BNE50-P1"},{"key":"X-Amz-Cf-Id","value":"gSF5b0ZeqyoMObWLjM8SnHhuf6fFEXK_6kwLTIu_eR8y4eG7Egr6FQ=="}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Missing required request parameters: [page]\"\n}"},{"id":"cadf9609-b51c-4d3d-9e57-972c53bbbd72","name":"401: Missing or Invalid Client ID or Secret or Scope","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"{{API_KEY}}","type":"text"}],"url":{"raw":"{{BASE_URL}}/api/v2/careRecipients/:careRecipientId/palliativeCares?page=1","host":["{{BASE_URL}}"],"path":["api","v2","careRecipients",":careRecipientId","palliativeCares"],"query":[{"key":"page","value":"1"}],"variable":[{"key":"careRecipientId","value":"6f57349d-ebe1-460e-81f1-ce9c1778ee8b"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"26"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Sun, 25 May 2025 10:51:20 GMT"},{"key":"x-amz-apigw-id","value":"LHtmaFh2ywMEvKg="},{"key":"x-amzn-RequestId","value":"4a67f48c-5825-4ce2-9e41-bba2d41640c0"},{"key":"x-amzn-ErrorType","value":"UnauthorizedException"},{"key":"X-Cache","value":"Error from cloudfront"},{"key":"Via","value":"1.1 c2b0b14414d87fbf9985559b5d1be1b0.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"BNE50-P1"},{"key":"X-Amz-Cf-Id","value":"EfZwWtxaxz3jraJgoOnZQBQXcriq8PCqV4clrfOYsHdmCUQ_bHdxYw=="}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Unauthorized\"\n}"},{"id":"76834763-1309-43b5-b060-3abe5f287f19","name":"403: Invalid API key","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"{{API_KEY}}1","type":"text"}],"url":{"raw":"{{BASE_URL}}/api/v2/careRecipients/:careRecipientId/palliativeCares?page=1","host":["{{BASE_URL}}"],"path":["api","v2","careRecipients",":careRecipientId","palliativeCares"],"query":[{"key":"page","value":"1"}],"variable":[{"key":"careRecipientId","value":"6f57349d-ebe1-460e-81f1-ce9c1778ee8b"}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"23"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Sun, 25 May 2025 11:03:06 GMT"},{"key":"x-amz-apigw-id","value":"LHvUtFGWSwMEuXg="},{"key":"x-amzn-RequestId","value":"8c3e7042-2139-43ec-9e0f-13e543d48b77"},{"key":"x-amzn-ErrorType","value":"ForbiddenException"},{"key":"X-Cache","value":"Error from cloudfront"},{"key":"Via","value":"1.1 532bae2476fbb28a84cd6a0ce4a429b8.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"BNE50-P1"},{"key":"X-Amz-Cf-Id","value":"IlR0yLqhvSDCpZ9APhlAjR4X5DdIdiejFGaHvlZ8wOpsZXJd5GQZZQ=="}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Forbidden\"\n}"},{"id":"010edab6-18c2-4ff4-9224-c4c2eb38f802","name":"404: Invalid Care Recipient ID","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"{{API_KEY}}","type":"text"}],"url":{"raw":"{{BASE_URL}}/api/v2/careRecipients/:careRecipientId/palliativeCares?page=1","host":["{{BASE_URL}}"],"path":["api","v2","careRecipients",":careRecipientId","palliativeCares"],"query":[{"key":"page","value":"1"}],"variable":[{"key":"careRecipientId","value":"6f57349d-ebe1-460e-81f1-ce9c1778ee8b1"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"28"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Sun, 25 May 2025 11:35:27 GMT"},{"key":"X-Amzn-Trace-Id","value":"Root=1-6833007d-5171770352454db217b14602;Parent=2ba712483027cb59;Sampled=0;Lineage=1:82092459:0"},{"key":"x-amzn-RequestId","value":"9dab1b03-e655-4a07-a4df-2dbbafe95b57"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"LH0DoEK5ywMENzA="},{"key":"X-Cache","value":"Error from cloudfront"},{"key":"Via","value":"1.1 9348b3d5d666c07df33489b432ed8cae.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"BNE50-P1"},{"key":"X-Amz-Cf-Id","value":"kSWNCz9pmGZoJVy-Z76JOI_NAo378aONqRg-vPw6r9GeXrk8cGmq7A=="}],"cookie":[],"responseTime":null,"body":"{\n \"error\": \"Record Not Found\"\n}"}],"_postman_id":"c4e14cf6-b8af-40bd-ab89-9ebb95ec46b1"},{"name":"Get Frailty - Assessments","id":"93f7f8e2-7b37-4851-9233-636fa2f4ea8c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"client_authentication","value":""},{"key":"scope","value":"{{SCOPE}}"},{"key":"headerPrefix","value":""},{"key":"refreshTokenUrl","value":"{{AUTH_URL}}"},{"key":"accessTokenUrl","value":"{{AUTH_URL}}"},{"key":"clientSecret","value":"{{CLIENT_SECRET}}"},{"key":"clientId","value":"{{CLIENT_ID}}"},{"key":"tokenName","value":""},{"key":"grant_type","value":""},{"key":"password","value":"{{password}}"},{"key":"username","value":"{{username}}"}]},"isInherited":false},"method":"GET","header":[{"key":"x-api-key","value":"{{API_KEY}}","type":"text"}],"url":"{{BASE_URL}}/api/v2/careRecipients/:careRecipientId/frailties?page=1","description":"

📄 Endpoint Overview

This endpoint returns a paginated list/array of Frailties for a specific Care Recipient, with a maximum of 10 records per page.

A mandatory query parameter named page must be provided. To retrieve the initial set of results, set page=1.

The successful response includes pagination metadata such as:

frailties: A paginated list of Frailties (max 10 records)
\n
totalPages: Total number of pages available
\n
currentPage: Current page number returned
\n
totalRecords: Total number of Frailties records in the system
\n

Response Schema

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Attribute	Type	Description
id	integer	Unique identifier for the frailty assessment record.
createdBy	string	Name of the user who created the record.
createdOn	datetime	Timestamp when the record was created.
lastReviewedBy	string	Name of the user who last reviewed the record.
lastUpdatedOn	datetime	Timestamp when the record was last updated.
reviewDate	date	Date of the frailty review. Can be null.
reviewComments	string	Comments provided during the review. Can be null.
score	string	Frailty score with description (e.g., \"4 (Vulnerable)\").

","urlObject":{"path":["api","v2","careRecipients",":careRecipientId","frailties"],"host":["{{BASE_URL}}"],"query":[{"key":"page","value":"1"}],"variable":[{"type":"any","value":"{{CARE_RECIPIENT_ID}}","key":"careRecipientId"}]}},"response":[{"id":"e719a9ed-4550-4e70-b8d5-cd898e549050","name":"200: Success","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"{{API_KEY}}","type":"text"}],"url":{"raw":"{{BASE_URL}}/api/v2/careRecipients/:careRecipientId/frailties?page=1","host":["{{BASE_URL}}"],"path":["api","v2","careRecipients",":careRecipientId","frailties"],"query":[{"key":"page","value":"1"}],"variable":[{"key":"careRecipientId","value":"6f57349d-ebe1-460e-81f1-ce9c1778ee8b"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"309"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Sun, 25 May 2025 10:44:06 GMT"},{"key":"X-Amzn-Trace-Id","value":"Root=1-6832f474-6c6834fc5d8293662a7803b9;Parent=6aac51107b91ea7c;Sampled=0;Lineage=1:6945b83c:0"},{"key":"x-amzn-RequestId","value":"03bfc9f7-861d-42b0-b3df-4e0d1119c597"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"LHsiSF7hSwMEcaA="},{"key":"X-Cache","value":"Miss from cloudfront"},{"key":"Via","value":"1.1 c2b0b14414d87fbf9985559b5d1be1b0.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"BNE50-P1"},{"key":"X-Amz-Cf-Id","value":"wZSCoJD4T7d_UmBLUWj1rP4WtuOiFc_d0jGcVPyc6JagrRugtw2lHA=="}],"cookie":[],"responseTime":null,"body":"{\n \"frailties\": [\n {\n \"createdBy\": \"Adam Sand (RN)\",\n \"createdOn\": \"2025-05-24T23:12:10.011+10:00\",\n \"id\": 25,\n \"lastReviewedBy\": \"Adam Sand\",\n \"lastUpdatedOn\": \"2025-05-24T23:12:10.011+10:00\",\n \"reviewComments\": \"1111\",\n \"reviewDate\": \"2025-05-08\",\n \"score\": \"4 (Vulnerable)\"\n }\n ],\n \"totalPages\": 1,\n \"currentPage\": 1,\n \"totalRecords\": 1\n}"},{"id":"431d3476-6d4d-442d-b953-6f7496152276","name":"400: Missing page query param","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"{{API_KEY}}","type":"text"}],"url":{"raw":"{{BASE_URL}}/api/v2/careRecipients/:careRecipientId/frailties","host":["{{BASE_URL}}"],"path":["api","v2","careRecipients",":careRecipientId","frailties"],"query":[{"key":"page","value":"1","disabled":true}],"variable":[{"key":"careRecipientId","value":"6f57349d-ebe1-460e-81f1-ce9c1778ee8b"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"58"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Sun, 25 May 2025 10:57:19 GMT"},{"key":"x-amz-apigw-id","value":"LHuehGHzSwMEpCg="},{"key":"x-amzn-RequestId","value":"cce1e1f8-3409-4375-a573-aaade3a84109"},{"key":"x-amzn-ErrorType","value":"BadRequestException"},{"key":"X-Cache","value":"Error from cloudfront"},{"key":"Via","value":"1.1 532bae2476fbb28a84cd6a0ce4a429b8.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"BNE50-P1"},{"key":"X-Amz-Cf-Id","value":"Khs29MEinxinIhHeINUj8g43Eoe68gfTJXC16k820Y1a3ejG4rTybg=="}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Missing required request parameters: [page]\"\n}"},{"id":"9952a119-2116-4280-9991-1a78a9f4650e","name":"401: Missing or Invalid Client ID or Secret or Scope","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"{{API_KEY}}","type":"text"}],"url":{"raw":"{{BASE_URL}}/api/v2/careRecipients/:careRecipientId/frailties?page=1","host":["{{BASE_URL}}"],"path":["api","v2","careRecipients",":careRecipientId","frailties"],"query":[{"key":"page","value":"1"}],"variable":[{"key":"careRecipientId","value":"6f57349d-ebe1-460e-81f1-ce9c1778ee8b"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"26"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Sun, 25 May 2025 10:51:53 GMT"},{"key":"x-amz-apigw-id","value":"LHtriG__ywMEuIA="},{"key":"x-amzn-RequestId","value":"beaa3173-109a-455f-a32d-248dbf850868"},{"key":"x-amzn-ErrorType","value":"UnauthorizedException"},{"key":"X-Cache","value":"Error from cloudfront"},{"key":"Via","value":"1.1 c2b0b14414d87fbf9985559b5d1be1b0.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"BNE50-P1"},{"key":"X-Amz-Cf-Id","value":"Uzoi0bBGJdLDORJFTOB7F47OI0PG_kL8nI6yoglXQZXwQYmt0EIh2Q=="}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Unauthorized\"\n}"},{"id":"b8628964-cae7-4562-8387-c72c3a6d96ac","name":"403: Invalid API key","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"{{API_KEY}}1","type":"text"}],"url":{"raw":"{{BASE_URL}}/api/v2/careRecipients/:careRecipientId/frailties?page=1","host":["{{BASE_URL}}"],"path":["api","v2","careRecipients",":careRecipientId","frailties"],"query":[{"key":"page","value":"1"}],"variable":[{"key":"careRecipientId","value":"6f57349d-ebe1-460e-81f1-ce9c1778ee8b"}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"23"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Sun, 25 May 2025 11:03:27 GMT"},{"key":"x-amz-apigw-id","value":"LHvYDFX2SwMEhdg="},{"key":"x-amzn-RequestId","value":"00381c02-b648-4799-af47-7fe9903bcef5"},{"key":"x-amzn-ErrorType","value":"ForbiddenException"},{"key":"X-Cache","value":"Error from cloudfront"},{"key":"Via","value":"1.1 532bae2476fbb28a84cd6a0ce4a429b8.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"BNE50-P1"},{"key":"X-Amz-Cf-Id","value":"_ot4rplND3HpFcvHvQiG0jzopPESWthxDaucQTOzb5RHwdoKFBH1Ow=="}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Forbidden\"\n}"},{"id":"46e9d796-6a9b-42a9-aebd-1971baac7b03","name":"404: Invalid Care Recipient ID","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"{{API_KEY}}","type":"text"}],"url":{"raw":"{{BASE_URL}}/api/v2/careRecipients/:careRecipientId/frailties?page=1","host":["{{BASE_URL}}"],"path":["api","v2","careRecipients",":careRecipientId","frailties"],"query":[{"key":"page","value":"1"}],"variable":[{"key":"careRecipientId","value":"6f57349d-ebe1-460e-81f1-ce9c1778ee8b1"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"28"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Sun, 25 May 2025 11:35:43 GMT"},{"key":"X-Amzn-Trace-Id","value":"Root=1-6833008d-45d2ad195db3b366203ab5ca;Parent=40844766079ca4f9;Sampled=0;Lineage=1:6945b83c:0"},{"key":"x-amzn-RequestId","value":"7dcc4047-8998-435d-88ff-690c5d056951"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"LH0GKGttywMEL6A="},{"key":"X-Cache","value":"Error from cloudfront"},{"key":"Via","value":"1.1 9348b3d5d666c07df33489b432ed8cae.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"BNE50-P1"},{"key":"X-Amz-Cf-Id","value":"MLmjngTFgANlT8hz5w1ydpbGJt8LjLnCE4u2iMWbeF9YJSdefgL8kA=="}],"cookie":[],"responseTime":null,"body":"{\n \"error\": \"Record Not Found\"\n}"}],"_postman_id":"93f7f8e2-7b37-4851-9233-636fa2f4ea8c"},{"name":"Get Accidents And Incidents","id":"156d9844-219a-4a27-97ba-6eab4e78230a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"client_authentication","value":""},{"key":"scope","value":"{{SCOPE}}"},{"key":"headerPrefix","value":""},{"key":"refreshTokenUrl","value":"{{AUTH_URL}}"},{"key":"accessTokenUrl","value":"{{AUTH_URL}}"},{"key":"clientSecret","value":"{{CLIENT_SECRET}}"},{"key":"clientId","value":"{{CLIENT_ID}}"},{"key":"tokenName","value":""},{"key":"grant_type","value":""},{"key":"password","value":"{{password}}"},{"key":"username","value":"{{username}}"}]},"isInherited":false},"method":"GET","header":[{"key":"x-api-key","value":"{{API_KEY}}","type":"text"}],"url":"{{BASE_URL}}/api/v2/careRecipients/:careRecipientId/accidentsAndIncidents?page=1","description":"

📄 Endpoint Overview

This endpoint returns a paginated list/array of Accidents And Incidents for a specific Care Recipient, with a maximum of 10 records per page.

A mandatory query parameter named page must be provided. To retrieve the initial set of results, set page=1.

The successful response includes pagination metadata such as:

accidentsAndIncidents: A paginated list of Accidents And Incidents (max 10 records)
\n
totalPages: Total number of pages available
\n
currentPage: Current page number returned
\n
totalRecords: Total number of Accidents And Incidents records in the system
\n

Response Schema

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Attribute	Type	Description
id	integer	Unique identifier for the accident record.
createdOn	datetime	Timestamp when the record was created.
lastUpdatedOn	datetime	Timestamp when the record was last updated.
firstResponder	object	Information reported by the First Responder at the time of the incident.
rnEnShiftSupervisor	object	Registered Nurse/Supervisor’s review and classification of the incident.
managementReport	object	Management-level actions and review details.

Sub-object:accidentsAndIncidents[].firstResponder

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Attribute	Type	Description
dateAndTimeOfTheIncident	datetime	Date and time when the incident occurred.
dateAndTimeReported	datetime	Date and time when the incident was reported.
incidentType	string	Type of the incident (e.g., Clinical). Can be null.
criteria	string	Behaviour or other classification. Can be null.
modifier	string	Contextual modifier (e.g., Physical). Can be null.
witnessed	boolean	Indicates if the incident was witnessed.
notWitnessed	boolean	Indicates if it was not witnessed.
notApplicable	boolean	True if unknown whether it was witnessed.
locationOfIncident	string	Location of the incident. Can be null.
injury	string	Injury description. Can be null.
descriptionOfIncident	string	Narrative description. Can be null.
immediateActionsTaken	array	List of immediate actions taken. Can be empty.

Sub-object:accidentsAndIncidents[].rnEnShiftSupervisor

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Attribute	Type	Description
injuries	array	List of injury records, each with injury, location, modifier.
actionsTaken	array	Actions taken by the supervisor.
incidentSeverity	string	Classification type (e.g., Minor, Major). Can be null.
notificationWhoAndWhen	array	List of notified parties.
notesToManagement	string	Notes addressed to management. Can be null.
actionToPreventReoccurrence	string	Steps to prevent future occurrences. Can be null.
comments	string	Escalation or general comments. Can be null.
dateAndTimeOfCompletion	datetime	Timestamp when the supervisor’s report was completed. Can be null.

Sub-object:accidentsAndIncidents[].managementReport

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Attribute	Type	Description
legislativeCompliance	boolean	Whether the incident was reportable under legislation.
dateRecieved	date	Date the report was received by management. Can be null.
wasThisAfterAWeekend	boolean	Whether the incident was reported after a weekend.
incidentInvestigation	string	Management’s investigation notes. Can be null.
requiredActions	string	Recommendations or actions to be taken. Can be null.
investigatorsName	string	Name of the investigating party. Can be null.
requiresFurtherReview	boolean	Whether further review is required. Can be null.
dateClosedOff	date	Date when the case was closed. Can be null.

","urlObject":{"path":["api","v2","careRecipients",":careRecipientId","accidentsAndIncidents"],"host":["{{BASE_URL}}"],"query":[{"key":"page","value":"1"}],"variable":[{"type":"any","value":"{{CARE_RECIPIENT_ID}}","key":"careRecipientId"}]}},"response":[{"id":"73d89727-1954-495b-9782-e8e2c939c294","name":"200: Success","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"{{API_KEY}}","type":"text"}],"url":{"raw":"{{BASE_URL}}/api/v2/careRecipients/:careRecipientId/accidentsAndIncidents?page=1","host":["{{BASE_URL}}"],"path":["api","v2","careRecipients",":careRecipientId","accidentsAndIncidents"],"query":[{"key":"page","value":"1"}],"variable":[{"key":"careRecipientId","value":"6f57349d-ebe1-460e-81f1-ce9c1778ee8b"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"1321"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Sun, 25 May 2025 10:44:25 GMT"},{"key":"X-Amzn-Trace-Id","value":"Root=1-6832f486-6ee85eef76151ca25c508e41;Parent=001b571f67f179e4;Sampled=0;Lineage=1:517fedb3:0"},{"key":"x-amzn-RequestId","value":"1a7898c2-9d60-41cf-9a8b-41f55309e4b9"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"LHslBEM9ywMEZzQ="},{"key":"X-Cache","value":"Miss from cloudfront"},{"key":"Via","value":"1.1 c2b0b14414d87fbf9985559b5d1be1b0.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"BNE50-P1"},{"key":"X-Amz-Cf-Id","value":"ARfxLUT342RXAXdqIFV0g5Ys9zzmdQ5Zs5hHKZh5xfLR3Op002JgUQ=="}],"cookie":[],"responseTime":null,"body":"{\n \"accidentsAndIncidents\": [\n {\n \"id\": 1617,\n \"lastUpdatedOn\": \"2025-05-24T23:13:07.544+10:00\",\n \"createdOn\": \"2025-05-24T23:13:07.544+10:00\",\n \"firstResponder\": {\n \"dateAndTimeOfTheIncident\": \"2025-05-24T23:12:18.911+10:00\",\n \"dateAndTimeReported\": \"2025-05-24T23:12:18.911+10:00\",\n \"incidentType\": \"Clinical\",\n \"criteria\": \"Behaviour\",\n \"modifier\": \"Physical\",\n \"witnessed\": true,\n \"notWitnessed\": false,\n \"notApplicable\": false,\n \"locationOfIncident\": \"Bathroom\",\n \"injury\": \"Yes, Injury present\",\n \"descriptionOfIncident\": \"1234\",\n \"immediateActionsTaken\": [\n \"Nothing Required\",\n \"Behaviour Chart\",\n \"Neurological observations\",\n \"Falls Checklist\"\n ]\n },\n \"rnEnShiftSupervisor\": {\n \"injuries\": [\n {\n \"injury\": \"Abrasion\",\n \"location\": \"Eye\",\n \"modifier\": \"Front\"\n }\n ],\n \"actionsTaken\": [\n \"Nothing Required\",\n \"Behaviour Chart\",\n \"Care Plan Review\",\n \"Assess for Injuries\",\n \"Falls Checklist\"\n ],\n \"incidentSeverity\": \"Minor\",\n \"notificationWhoAndWhen\": [\n \"Doctor\",\n \"Police\",\n \"Management\",\n \"NOK\"\n ],\n \"notesToManagement\": \"111\",\n \"actionToPreventReoccurrence\": \"2222\",\n \"comments\": \"3333\",\n \"dateAndTimeOfCompletion\": \"2025-05-23T22:45:00.000+10:00\"\n },\n \"managementReport\": {\n \"legislativeCompliance\": true,\n \"dateRecieved\": \"2025-05-22\",\n \"wasThisAfterAWeekend\": true,\n \"incidentInvestigation\": \"1\",\n \"requiredActions\": \"2\",\n \"investigatorsName\": \"3\",\n \"requiresFurtherReview\": null,\n \"dateClosedOff\": \"2025-05-27\"\n }\n }\n ],\n \"totalPages\": 1,\n \"currentPage\": 1,\n \"totalRecords\": 1\n}"},{"id":"68437abb-e430-485a-9ad4-f9bdab335936","name":"400: Missing page query param","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"{{API_KEY}}","type":"text"}],"url":{"raw":"{{BASE_URL}}/api/v2/careRecipients/:careRecipientId/accidentsAndIncidents","host":["{{BASE_URL}}"],"path":["api","v2","careRecipients",":careRecipientId","accidentsAndIncidents"],"query":[{"key":"page","value":"1","disabled":true}],"variable":[{"key":"careRecipientId","value":"6f57349d-ebe1-460e-81f1-ce9c1778ee8b"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"58"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Sun, 25 May 2025 10:57:33 GMT"},{"key":"x-amz-apigw-id","value":"LHugmGXhSwMEe0g="},{"key":"x-amzn-RequestId","value":"89e7be1b-4c1a-47b6-9d4f-767aefa90d0c"},{"key":"x-amzn-ErrorType","value":"BadRequestException"},{"key":"X-Cache","value":"Error from cloudfront"},{"key":"Via","value":"1.1 532bae2476fbb28a84cd6a0ce4a429b8.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"BNE50-P1"},{"key":"X-Amz-Cf-Id","value":"HjUoNjKEEDSBDghcnOUDsPQLEWj75KtIC-FnX2sDiE5M75_VNbjSIg=="}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Missing required request parameters: [page]\"\n}"},{"id":"e5327481-c859-42b8-abb9-581cce399a3b","name":"401: Missing or Invalid Client ID or Secret or Scope","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"{{API_KEY}}","type":"text"}],"url":{"raw":"{{BASE_URL}}/api/v2/careRecipients/:careRecipientId/accidentsAndIncidents?page=1","host":["{{BASE_URL}}"],"path":["api","v2","careRecipients",":careRecipientId","accidentsAndIncidents"],"query":[{"key":"page","value":"1"}],"variable":[{"key":"careRecipientId","value":"6f57349d-ebe1-460e-81f1-ce9c1778ee8b"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"26"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Sun, 25 May 2025 10:52:20 GMT"},{"key":"x-amz-apigw-id","value":"LHtvxHrKSwMEWjg="},{"key":"x-amzn-RequestId","value":"1f34cbae-07fd-4729-b1e0-4eb5479000b0"},{"key":"x-amzn-ErrorType","value":"UnauthorizedException"},{"key":"X-Cache","value":"Error from cloudfront"},{"key":"Via","value":"1.1 c2b0b14414d87fbf9985559b5d1be1b0.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"BNE50-P1"},{"key":"X-Amz-Cf-Id","value":"_jfcYp0WgUZDRnpEpYWQRvyjHOA_BkCC3EVClqCXs_yDhwhb6_mPIw=="}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Unauthorized\"\n}"},{"id":"882cb97e-d59d-4206-b6ad-4562a1b8b08c","name":"403: Invalid API key","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"{{API_KEY}}1","type":"text"}],"url":{"raw":"{{BASE_URL}}/api/v2/careRecipients/:careRecipientId/accidentsAndIncidents?page=1","host":["{{BASE_URL}}"],"path":["api","v2","careRecipients",":careRecipientId","accidentsAndIncidents"],"query":[{"key":"page","value":"1"}],"variable":[{"key":"careRecipientId","value":"6f57349d-ebe1-460e-81f1-ce9c1778ee8b"}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"23"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Sun, 25 May 2025 11:03:45 GMT"},{"key":"x-amz-apigw-id","value":"LHvauHLHSwMEHGg="},{"key":"x-amzn-RequestId","value":"b775989b-3e31-497f-aabf-b1d3909dbfd4"},{"key":"x-amzn-ErrorType","value":"ForbiddenException"},{"key":"X-Cache","value":"Error from cloudfront"},{"key":"Via","value":"1.1 532bae2476fbb28a84cd6a0ce4a429b8.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"BNE50-P1"},{"key":"X-Amz-Cf-Id","value":"k7dAow-4flF5bkVOu4WwqG4opdqQiyHwZvQ3yST5iMhxNpQKFCzIBQ=="}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Forbidden\"\n}"},{"id":"4bccbe48-8327-4358-8d5e-122d975cea1f","name":"404: Invalid Care Recipient ID","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"{{API_KEY}}","type":"text"}],"url":{"raw":"{{BASE_URL}}/api/v2/careRecipients/:careRecipientId/accidentsAndIncidents?page=1","host":["{{BASE_URL}}"],"path":["api","v2","careRecipients",":careRecipientId","accidentsAndIncidents"],"query":[{"key":"page","value":"1"}],"variable":[{"key":"careRecipientId","value":"6f57349d-ebe1-460e-81f1-ce9c1778ee8b1"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"28"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Sun, 25 May 2025 11:36:00 GMT"},{"key":"X-Amzn-Trace-Id","value":"Root=1-6833009e-7995a60e32816f132d3e2c05;Parent=7c1135b58cc8e565;Sampled=0;Lineage=1:517fedb3:0"},{"key":"x-amzn-RequestId","value":"a6df935e-b6b9-484a-aa69-8bf0b2d11ad0"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"LH0IwEp4SwMEjjQ="},{"key":"X-Cache","value":"Error from cloudfront"},{"key":"Via","value":"1.1 9348b3d5d666c07df33489b432ed8cae.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"BNE50-P1"},{"key":"X-Amz-Cf-Id","value":"w3uw2w3H0xJtQa_5smhUp3VewWbKWR1WrQWBKo_zF2SBK30cEW-Qxw=="}],"cookie":[],"responseTime":null,"body":"{\n \"error\": \"Record Not Found\"\n}"}],"_postman_id":"156d9844-219a-4a27-97ba-6eab4e78230a"}],"auth":{"type":"oauth2","oauth2":{"basicConfig":[]}},"event":[{"listen":"prerequest","script":{"type":"text/javascript","packages":{},"exec":[""],"id":"a6463266-8e7d-468d-810e-907def41d68a"}},{"listen":"test","script":{"type":"text/javascript","packages":{},"exec":[""],"id":"131a5d99-54bf-489f-b7a9-4bd9cea1fc68"}}]}