--- title: "Get Patient" method: GET path: "/user/patient/{patient_id}" tags: ["provider", "user"] --- # Get Patient `GET /user/patient/{patient_id}` ## Request - Base URL: `https://docs.decodahealth.com` (the document declares no server; this is the origin it was published from) - URL: `https://docs.decodahealth.com/user/patient/{patient_id}` - Auth: none declared. Required headers: `TENANT`, `API-KEY` - TypeScript: (a function with typed inputs; its response is checked against the schema) ## Path parameters - `patient_id` string, required ## Headers - `TENANT` string, required - `API-KEY` string, required ## Response `200` Successful Response - PatientChart: Extended patient model for the patient detail/chart endpoint that includes health data. - `id` string, required: The unique identifier for the user. - `firstName` string, nullable: The user's first name. - `lastName` string, nullable: The user's last name. - `phoneNumber` string, nullable: The user's phone number. - `email` string, nullable: The user's email address. - `type` 'PROVIDER' | 'PATIENT' | 'ASSISTANT', required - `locationId` string, nullable: The location of the user. - `externalId` string, nullable: The user's external identifier if available. - `address` string, nullable: The user's primary address. - `addressLineTwo` string, nullable: Additional address information. - `city` string, nullable: The city of the user's address. - `state` string, nullable: The state of the user's address. - `zipCode` string, nullable: The postal code of the user's address. - `country` string, nullable: The country of the user's address. - `createdDate` string, date-time, required: The date and time when the user was created. - `addressValid` boolean, nullable: Whether the user's address is valid. - `meta` object, nullable: Any additional metadata about the user relevant to your system. - `isArchived` boolean, nullable: Whether the user is archived. - `primaryLocationId` string, nullable: The primary location of the user. - `gender` string, nullable: The gender of the patient. - `dateOfBirth` string, date, nullable: The date of birth of the patient. - `patientMedications` string[], nullable: List of patient's self-reported medications. - `onSchedulingBlacklist` boolean, nullable: Whether the patient is on the scheduling blacklist. - `surchargeDisabled` boolean, nullable: Whether surcharges are disabled for this patient. - `tags` PatientTagSummary[], nullable: List of patient tags - `id` string, required: Unique identifier for the patient tag - `name` string, required: Name of the patient tag - `emoji` string, nullable: Emoji associated with the tag - `color` string, nullable: Color code for the tag (hex format) - `isActive` boolean, required: Whether the tag is active - `createdDate` string, date-time, required: Date and time when the tag was created - `updatedDate` string, date-time, nullable: Date and time when the tag was last updated - `creditBalance` integer, nullable: Patient's credit balance in cents. - `preferredProviderId` string, nullable: The preferred provider ID for this patient. - `memberships` MemberTiny[], nullable: List of memberships for this patient - `id` string, required: Unique identifier for the member - `membership` MembershipTiny, required - `id` string, required: Unique identifier for the membership - `name` string, required: Name of the membership - `textColor` string, nullable: Text color of the membership - `startDate` string, date-time, required: When the patient joined the membership - `status` 'ACTIVE' | 'EXPIRED' | 'CANCELLED' | 'DELINQUENT' | 'FROZEN', required - `goalWeight` number, nullable: The goal weight of the patient. - `measurements` MeasurementSummary[], nullable: List of patient's measurements. - `height` number, nullable: The height of the patient in cms. - `weight` number, nullable: The weight of the patient in kgs. - `systolicBp` number, nullable - `diastolicBp` number, nullable - `pulse` number, nullable - `temperature` number, nullable - `waistCircumference` number, nullable: The waist circumference of the patient in cms. - `patientId` string, required - `noteId` string, nullable - `measurementDate` string, date-time: The date and time the measurement was taken. Defaults to now if not provided. - `eventId` string, nullable: The event that the measurement was taken for. - `createdDate` string, date-time, required - `id` string, required - `creatorId` string, nullable: ID of the user who created this measurement (optional for legacy measurements) - `medications` DeprecatedMedicationSummary[], nullable: List of provider-administered medication doses. - `id` string, required - `createdDate` string, date-time, required - `patientId` string, required - `providerId` string, nullable - `name` string, required - `sideEffects` string, nullable - `administrationLocation` string, nullable - `amount` number, nullable - `unit` 'AMPOULES' | 'APPLICATORS' | 'BOTTLES' | 'BOXES' | 'CAPSULES' | 'CUPS' | 'DOSES' | 'G_PER_ML' | 'GRAMS' | 'IU' | 'IU_PER_ML' | 'OUNCES' | 'FLUID_OUNCES' | 'KG' | 'KITS' | 'LITERS' | 'MCG' | 'MG' | 'MG_PER_ML' | 'ML' | 'MMOL' | 'MICROGRAM_PER_ML' | 'PACKS' | 'PAIRS' | 'PATCHES' | 'PERCENTAGE' | 'PIECES' | 'POUCHES' | 'ROLLS' | 'SACHETS' | 'SHEETS' | 'SPRAYS' | 'STRIPS' | 'SYRINGES' | 'TABLETS' | 'TABLETS_PER_DAY' | 'TESTS' | 'TUBES' | 'UNITS' | 'VIALS' | 'TREATMENTS' | 'SESSIONS' | 'PULSES' | 'JOULES' | 'CENTIMETERS' | 'THREAD_COUNT' | 'INJECTIONS' | 'WRINKLE_UNITS' | 'POUNDS' | 'FEET' | 'INCHES' - `lotNumber` string, nullable - `stockId` string, nullable - `noteId` string, nullable - `doseDate` string, date-time, nullable - `comment` string, nullable - `frequency` string, nullable - `quantity` number, nullable - `isUsedAsTemplate` boolean, nullable - `signedOffProviderId` string, nullable - `signedOffDate` string, date-time, nullable - `provider` UserTiny - `id` string, required: The unique identifier for the user. - `firstName` string, nullable: The user's first name. - `lastName` string, nullable: The user's last name. - `phoneNumber` string, nullable: The user's phone number. - `email` string, nullable: The user's email address. - `type` 'PROVIDER' | 'PATIENT' | 'ASSISTANT', required - `locationId` string, nullable: The location of the user. - `optedOutOfSms` boolean, nullable: Whether patient has opted out of SMS - `appointmentCount` integer, nullable: Total number of appointments for this patient - `totalSpent` integer, nullable: Total amount spent by this patient in cents - `healthData` object, nullable: Dynamic health fields and values - `profilePictureUrl` string, nullable: URL to the patient's profile picture. ## Other responses - `422`: Validation Error --- [API](https://skmtc.dev/decodahealth/apis/decoda-api.md) - [All operations](https://skmtc.dev/decodahealth/apis/decoda-api/llms.txt) - [OpenAPI document](https://skmtc.dev/decodahealth/apis/decoda-api/revisions/4ab18c80f9e9?raw)