Skip to content

Create resident

Request

Security
bearer
Bodyapplication/jsonrequired
nameobject(ResidentNameDto)required
homestringrequired

Home ID

Example:"507f1f77bcf86cd799439011"
dateOfBirthstringrequired

ISO 8601 date

Example:"1945-06-15"
genderstring
Enum:"male""female""any""unknown""unspecified""other"
statusstring
Enum:"active""inactive""hospitalised""deceased""discharged""pre-assessment""dummy"
externalSourceobject(ExternalSourceDto)
POST
/api/residents
curl -i -X POST \
  https://data.logmycare.co.uk/openapi/api/residents \
  -H 'Content-Type: application/json' \
  -d '{
    "name": {
      "first": "Jane",
      "last": "Smith",
      "full": "Jane Smith"
    },
    "home": "507f1f77bcf86cd799439011",
    "dateOfBirth": "1945-06-15",
    "gender": "male",
    "status": "active",
    "externalSource": {
      "sourceName": "my-integration",
      "sourceId": "ext-12345",
      "sourceType": "api",
      "externalCreatedAt": "2024-01-15T09:30:00.000Z",
      "sourceRecordUrl": "https://app.example.com/residents/ext-12345",
      "metadata": {
        "region": "north",
        "ward": "A"
      }
    }
  }'

Responses

Successfully created resident

Bodyapplication/json
any
Response
{
  "id": "69613fc010eecc5386f987ae",
  "name": {
    "first": "Margaret",
    "last": "Thompson"
  },
  "email": "margaret.thompson@example.com",
  "gender": "female",
  "dateOfBirth": "1945-06-15T00:00:00.000Z",
  "createdOn": "2026-01-15T09:30:00.000Z",
  "admissionDate": "2026-01-10T00:00:00.000Z",
  "preferredName": "Maggie",
  "status": "active",
  "statusChangedOn": "2026-01-20T10:00:00.000Z",
  "isInactive": false,
  "home": {
    "id": "66e2aeef14dce156439010d5",
    "name": "Sunrise Care Home"
  },
  "location": {
    "roomName": "Room 12",
    "unit": "Oak Wing",
    "floor": "1"
  },
  "nhsNumber": "999 000 0001",
  "bloodType": "O+",
  "allergies": "Penicillin",
  "hasAllergies": true,
  "noKnownAllergies": false,
  "residentAllergies": [
    "Penicillin",
    "Latex"
  ],
  "medicalHistory": "Hypertension, Type 2 diabetes",
  "height": "165cm",
  "gpCode": "G1234567",
  "gpName": "Dr. Sarah Williams",
  "gpEmail": "sarah.williams@nhs.example.com",
  "gpTelephone": "+44 1632 960123",
  "gpAddress": {
    "street1": "1 Example Lane",
    "suburb": "Exampletown",
    "postcode": "EX1 1CD",
    "country": "United Kingdom"
  },
  "gpSurgeryName": "Example Medical Practice",
  "phones": [
    { … }
  ],
  "addresses": [
    { … }
  ],
  "importantContacts": [
    { … }
  ],
  "preferredContactMethod": "noPreference",
  "religion": "Christian",
  "ethnicity": "White British",
  "nationality": "British",
  "nationalities": [
    "British"
  ],
  "languagesSpoken": [
    "English"
  ],
  "maritalStatus": "widowed",
  "birthplace": "York",
  "sexualPreference": "heterosexual",
  "carePackage": {
    "fundingSource": "localAuthority",
    "fundingSourceNotes": "Funded by York City Council",
    "fundingSourceOther": ""
  },
  "fundingSource": "localAuthority",
  "fundingSourceNotes": "Funded by York City Council",
  "fundingSourceOther": "",
  "keyworkers": [
    "68406c31e55ca6b6d2262f56"
  ],
  "carerPreferences": {
    "gender": "female",
    "language": "English"
  },
  "preferredDrink": "Tea with milk",
  "preferredAdminRoute": "oral",
  "dols": {
    "status": "authorised",
    "startDate": "2026-02-01T00:00:00.000Z",
    "endDate": "2026-08-01T00:00:00.000Z",
    "reviewDate": "2026-05-01T00:00:00.000Z",
    "applicationDate": "2026-01-15T00:00:00.000Z"
  },
  "dolsStartDate": "2026-02-01T00:00:00.000Z",
  "dolsEndDate": "2026-08-01T00:00:00.000Z",
  "dolsReviewDate": "2026-05-01T00:00:00.000Z",
  "dolsApplicationDate": "2026-01-15T00:00:00.000Z",
  "dnacpr": {
    "hasDnacpr": true,
    "details": "DNACPR in place, reviewed by GP",
    "reviewDate": "2026-06-01T00:00:00.000Z",
    "formPhysicalLocation": "Front of care file"
  },
  "dnacprDetails": "DNACPR in place, reviewed by GP",
  "dnacprReviewDate": "2026-06-01T00:00:00.000Z",
  "dnacprFormPhysicalLocation": "Front of care file",
  "recentMustScore": "1",
  "recentWaterlowScore": "12",
  "recentDrinkConsumption": "1500ml",
  "hasChokingRisk": false,
  "prnMedsNote": "Paracetamol PRN for pain",
  "nationalInsurance": "QQ123456C",
  "summary": "Margaret is a friendly resident who enjoys gardening and reading.",
  "otherIdentifiers": [
    { … }
  ],
  "customId": "example-resident-id-123",
  "ageYears": 80
}