patients

Retrieve a patient by ID

Returns a single patient

get/patients/{id}

Request

  • Base URL: https://api.ritten.io/v1
  • URL: https://api.ritten.io/v1/patients/{id}
  • Auth: none declared

Path parameters

idstring required

ID of patient to return

Response

success

idstring
externalIdstring

An external identifier for the patient (e.g. an ID from a third-party system)

dobstring

date of birth

createdAtstring date-time

Patient record creation timestamp.

mrnstring

Ritten Medical Record Number

programStatus'prospective' | 'active'
phonesstring[]

Flattened phone contact point values. Primary phone numbers appear first when known; remaining values are ordered newest-first.

emailsstring[]

Flattened email contact point values. Primary email addresses appear first when known; remaining values are ordered newest-first.

Example response

{
  "id": "182c2e54-3494-4b85-aba5-038cf539d5bf",
  "createdAt": "2024-01-01T00:00:00Z",
  "name": {
    "first": "Doe",
    "last": "John",
    "pronouns": "he/him",
    "chosenName": "Johnny"
  },
  "careTeam": {
    "primaryClinician": {
      "id": "182c2e54-3494-4b85-aba5-038cf539d5bf",
      "email": "johndoe@ritclinic.ritten.io",
      "first": "Doe",
      "last": "John",
      "lastAccessedAt": "2024-01-15T14:32:00Z"
    }
  },
  "phones": [
    "+15555555555"
  ],
  "emails": [
    "john@example.com"
  ],
  "addresses": [
    {
      "id": "182c2e54-3494-4b85-aba5-038cf539d5bf"
    }
  ],
  "referrals": [
    {
      "id": "182c2e54-3494-4b85-aba5-038cf539d5bf",
      "referralTypeId": "15b57ab4-9247-468e-85db-d86f7897207f",
      "organizationId": "66c2350d-a532-4d19-b063-24570269ef50",
      "personId": "e330e20b-b075-48c2-9432-c66a75c5d436"
    }
  ],
  "insurance": [
    {
      "id": "182c2e54-3494-4b85-aba5-038cf539d5bf",
      "payerId": "15b57ab4-9247-468e-85db-d86f7897207f",
      "birthDate": "1990-02-23"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.