pulse.clients.getById(id)

Returns full client detail by UID. Includes identity, address, contact, physical description, additional info, and status. Joins with ProviderOffice and eVVJurisdiction.

Added in 0.1.0

Parameters

Name	Type	Description
id	number	The client UID to look up

Response — ClientDetail | null

Field	Type	Description
uid	number	Unique client identifier
firstName	string \| null	Client first name
middleName	string \| null	Client middle name
lastName	string \| null	Client last name
nickName	string \| null	Preferred name
dob	string \| null	Date of birth (YYYY-MM-DD)
startDate	string \| null	Service start date (YYYY-MM-DD)
ssn	string \| null	Social Security number
uciNumber	string \| null	UCI identification number
address1	string \| null	Street address line 1
address2	string \| null	Street address line 2
city	string \| null	City
state	string \| null	State (2-letter code)
zip	string \| null	ZIP code
county	string \| null	County
homePhone	string \| null	Home phone number
cellPhone	string \| null	Cell phone number
otherPhone	string \| null	Other phone number
faxNumber	string \| null	Fax number
email	string \| null	Email address
gender	string \| null	Gender
height	string \| null	Height
weight	string \| null	Weight
eyes	string \| null	Eye color
hair	string \| null	Hair color
ethnicity	string \| null	Ethnicity
language	string \| null	Primary language
identifyingCharacteristics	string \| null	Physical identifying characteristics
commChallenges	string \| null	Communication challenges
drivingDirections	string \| null	Driving directions to client
stateId	string \| null	State ID number
ssiNumber	string \| null	SSI number
ssaNumber	string \| null	SSA number
medicaid	string \| null	Medicaid/Medi-Cal number
medicare	string \| null	Medicare number
evv	boolean	Electronic Visit Verification enabled
jurisdictionalEntity	string \| null	Jurisdictional entity (from eVVJurisdiction join)
comments	string \| null	General comments
photoConsent	boolean	Client consents to photo release
conserved	boolean	Client is conserved
shirtSize	string \| null	Shirt size
status	string \| null	Current client status
officeName	string \| null	Provider office name (from ProviderOffice join)
providerOfficeUID	number \| null	Provider office UID (foreign key)
photo	string \| null	Photo URL or blob reference

Code Example

import { createPulseClient } from '@qsp-life/pulse';

const pulse = createPulseClient({
  server: process.env.PULSE_DB_SERVER!,
  database: process.env.PULSE_DB_DATABASE!,
  user: process.env.PULSE_DB_USER!,
  password: process.env.PULSE_DB_PASSWORD!,
});

const client = await pulse.clients.getById(5417);

if (client) {
  client.firstName   // "Captain"
  client.officeName  // "Compass Cares"
  client.evv         // false
  client.status      // "Active"
}

await pulse.disconnect();

Live Preview

Connection is closed.