--- title: "View patient" method: GET path: "/patients/{id}" tags: ["Patients"] --- # View patient `GET /patients/{id}` This endpoint returns a single patient. You must provide a valid patient NexHealth ID. ## Path parameters - `id` integer, required ## Query parameters - `subdomain` string, required - `include[]` string[] ## Headers - `Nex-Api-Version` string, required ## Response `200` Successful - APIV20240412EntitiesPatientDetailedResponse — API_V20240412_Entities_PatientDetailed_Response model - `code` boolean — Indicates the success or failure of the request - `description` string — Additional context on the request to help with debugging. - `error` string[] — Any errors that occur during the execution of the request. - `data` APIV20240412EntitiesPatientDetailed - `id` integer — User id - `email` string, nullable — User email - `first_name` string — First name - `middle_name` string, nullable — Middle name - `last_name` string — Last name - `name` string — Full name - `created_at` string, date-time — User creation date in UTC - `updated_at` string, date-time — User last updation date in UTC - `institution_id` integer — The institution this user belongs to - `foreign_id` string, nullable — Foreign Id is a unique identifier from the integrated system - `foreign_id_type` string — Foreign Id type is a unique string identifier for the integrated system - `bio` object — Patient biographical data, fields shown in our example response represent all possible data we retrieve but depending on system and what is actually saved in the health records system you cannot assume any field will consistently be returned - `inactive` boolean — Is the user inactivated? - `last_sync_time` string, date-time, nullable — The most recent time the resource's data changed meaningfully at the source - `guarantor_id` integer, nullable — User id of this patient's responsible party - `billing_type` string, nullable — Used by practices in some integrated systems to categorize and filter patients when creating reports, requesting payments, and performing other related office tasks. Some integrated systems call this an account type rather than a billing type - `chart_id` string, nullable — User-facing ID for referencing patient data, used in some integrated systems. Depending on the system, the chart ID supplements or replaces the foreign_id as the ID visible to EHR users - `preferred_language` string, nullable — Patient's preferred language as an ISO 639-1 code, if specified in the integrated system - `provider_id` integer, nullable — User id of this patient's primary provider - `hipaa` APIV2EntitiesPrivacyAuthorization - `authorization` boolean — Whether the patient has provided HIPAA authorization - `authorization_date` string, date — Date the patient provided HIPAA authorization - `privacy` boolean — Whether the patient has acknowledged HIPAA privacy notice - `privacy_date` string, date — Date the patient acknowledged HIPAA privacy notice - `consent` boolean — Whether the patient has provided HIPAA consent - `consent_date` string, date — Date the patient provided HIPAA consent - `children` APIV2EntitiesUser[] — Patient children - `id` integer — User id - `email` string, nullable — User email - `first_name` string — First name - `middle_name` string, nullable — Middle name - `last_name` string — Last name - `name` string — Full name - `created_at` string, date-time — User creation date in UTC - `updated_at` string, date-time — User last updation date in UTC - `institution_id` integer — The institution this user belongs to - `foreign_id` string, nullable — Foreign Id is a unique identifier from the integrated system - `foreign_id_type` string — Foreign Id type is a unique string identifier for the integrated system - `bio` object — Patient biographical data, fields shown in our example response represent all possible data we retrieve but depending on system and what is actually saved in the health records system you cannot assume any field will consistently be returned - `inactive` boolean — Is the user inactivated? - `last_sync_time` string, date-time, nullable — The most recent time the resource's data changed meaningfully at the source - `guarantor` APIV2EntitiesUser - `id` integer — User id - `email` string, nullable — User email - `first_name` string — First name - `middle_name` string, nullable — Middle name - `last_name` string — Last name - `name` string — Full name - `created_at` string, date-time — User creation date in UTC - `updated_at` string, date-time — User last updation date in UTC - `institution_id` integer — The institution this user belongs to - `foreign_id` string, nullable — Foreign Id is a unique identifier from the integrated system - `foreign_id_type` string — Foreign Id type is a unique string identifier for the integrated system - `bio` object — Patient biographical data, fields shown in our example response represent all possible data we retrieve but depending on system and what is actually saved in the health records system you cannot assume any field will consistently be returned - `inactive` boolean — Is the user inactivated? - `last_sync_time` string, date-time, nullable — The most recent time the resource's data changed meaningfully at the source - `provider` APIV2EntitiesUser - `id` integer — User id - `email` string, nullable — User email - `first_name` string — First name - `middle_name` string, nullable — Middle name - `last_name` string — Last name - `name` string — Full name - `created_at` string, date-time — User creation date in UTC - `updated_at` string, date-time — User last updation date in UTC - `institution_id` integer — The institution this user belongs to - `foreign_id` string, nullable — Foreign Id is a unique identifier from the integrated system - `foreign_id_type` string — Foreign Id type is a unique string identifier for the integrated system - `bio` object — Patient biographical data, fields shown in our example response represent all possible data we retrieve but depending on system and what is actually saved in the health records system you cannot assume any field will consistently be returned - `inactive` boolean — Is the user inactivated? - `last_sync_time` string, date-time, nullable — The most recent time the resource's data changed meaningfully at the source - `last_visited_appointment` APIV2EntitiesAppointmentBasic - `id` integer — Appointment id - `provider_id` integer — Provider id - `provider_name` string — Provider name - `start_time` string, date-time — Start time of the appointment in UTC - `end_time` string, date-time — End time of the appointment in UTC - `location_id` integer — Location id - `confirmed` boolean — Is this appointment confirmed? - `upcoming_appts` APIV2EntitiesAppointmentBasic[] — Scheduled appointments for one year. Not included by default - `id` integer — Appointment id - `provider_id` integer — Provider id - `provider_name` string — Provider name - `start_time` string, date-time — Start time of the appointment in UTC - `end_time` string, date-time — End time of the appointment in UTC - `location_id` integer — Location id - `confirmed` boolean — Is this appointment confirmed? - `procedures` APIV20240412EntitiesProcedure[] — Procedures assigned to the patient. Not included by default - `id` integer — Procedure id - `location_id` integer, nullable — Location id - `patient_id` integer, nullable — Patient id - `provider_id` integer, nullable — Provider id - `appointment_id` integer, nullable — Appointment id. Null when the procedure is not attached to an appointment - `code` string, nullable — Procedure code - `name` string, nullable — Procedure name - `status` 'planned' | 'scheduled' | 'completed' | 'inactive' | 'referred', nullable — Procedure status - `updated_at` string, date-time — Procedure update date in UTC - `body_site` APIV2EntitiesProcedureBodySite - `tooth` string[] — Tooth identifier strings, typically tooth numbers - `surface` string — Tooth surface codes - `fee` APIV2EntitiesPrice - `amount` string — The currency value, in whole units (e.g. dollars) - `currency` string — The ISO currency code - `start_date` string, date, nullable — Start date for procedure - `end_date` string, date, nullable — End date for procedure - `treatment_plan_ids` integer[] — Treatment plan ids - `insurance_coverages` APIV2EntitiesInsurancePatientCoverageForIndividual[] — Active insurance coverages for the patient - `id` integer — Coverage id - `subscription_relation` 'self' | 'spouse' | 'child' | 'employee' | 'handicap_dep' | 'signif_other' | 'injured_plaintiff' | 'life_partner' | 'dependent' | 'other' — The relationship of this patient to the subscriber - `patient_id` integer, nullable — The ID of the covered patient - `priority` integer, nullable — The relative priority of this insurance coverage where the lowest value is the patient's primary insurance and higher values represent secondary and tertiary policies - `plan_id` integer, nullable — The ID of the insurance plan this coverage subscribes to - `subscriber_num` string, nullable — The subscriber's identification number for the plan - `effective_date` string, date, nullable — The date the coverage takes effect - `expiration_date` string, date, nullable — The date the coverage expires - `plan` APIEntitiesInsuranceEhrPlan - `id` integer — Plan id - `payer_id` string, nullable — A unique ID number that is assigned to an insurance company for the purpose of transmitting provider claims electronically - `name` string, nullable — Plan name - `address` string, nullable — Street address - `address2` string, nullable — Street address 2 - `city` string, nullable — City - `state` string, nullable — 2 letter state code - `zip_code` string, nullable — Zip code - `country_code` string, nullable — 2 letter country code - `group_num` string, nullable — Group number - `employer_name` string, nullable — Employer name - `foreign_id` string, nullable — Foreign Id is a unique identifier from the integrated system - `updated_at` string, date-time — Insurance Plan update date in UTC - `deleted_at` string, date-time, nullable — The UTC date and time the insurance plan was deleted. Null unless the plan is soft-deleted; deleted plans are only returned when include_deleted is true - `subscriber` APIV2EntitiesInsuranceSubscriber - `id` integer — The subscriber's id - `name` string — The subscriber's full name - `date_of_birth` string, nullable — The subscriber's date of birth in YYYY-MM-DD format - `adjustments` APIV20240412EntitiesLedgerAdjustment[] — Payment ledger adjustments - `id` integer — Resource id - `foreign_id` string — Unique identifier of this resource from the integrated system - `location_id` integer, nullable — The ID of the location that this item is for - `patient_id` integer, nullable — The ID of the patient that this item is for - `guarantor_id` integer, nullable — The ID of the guarantor that this item is for - `provider_id` integer, nullable — The ID of the provider that this item is for - `updated_at` string, date-time — Last updated time for item in UTC - `description` string, nullable — A description of the item - `deleted_at` string, date-time, nullable — Deleted time for item in UTC - `adjustment_amount` APIV2EntitiesPrice - `amount` string — The currency value, in whole units (e.g. dollars) - `currency` string — The ISO currency code - `adjusted_at` string, date, nullable — The UTC date adjustment was made - `transaction_id` string, nullable — The ID of the transaction for this adjustment - `charge_id` integer, nullable — The ID of the charge for this adjustment - `claim_id` integer, nullable — The ID of the insurance claim for this adjustment - `adjustment_type_id` integer, nullable — The ID of the adjustment type for this adjustment - `charges` APIV20240412EntitiesLedgerChargeBasicWithDelete[] — Payment ledger charges - `id` integer — Resource id - `foreign_id` string — Unique identifier of this resource from the integrated system - `location_id` integer, nullable — The ID of the location that this item is for - `patient_id` integer, nullable — The ID of the patient that this item is for - `guarantor_id` integer, nullable — The ID of the guarantor that this item is for - `provider_id` integer, nullable — The ID of the provider that this item is for - `procedure_id` integer, nullable — The ID of the procedure associated with this charge - `procedure_code` string, nullable — The procedure code associated with this charge - `updated_at` string, date-time — Last updated time for item in UTC - `description` string, nullable — A description of the charge - `fee` APIV2EntitiesPrice - `amount` string — The currency value, in whole units (e.g. dollars) - `currency` string — The ISO currency code - `charged_at` string, date, nullable — The UTC date charge was made - `deleted_at` string, date-time, nullable — The UTC datetime the charge was deleted - `payments` APIV20240412EntitiesLedgerPayment[] — Payment ledger payments - `id` integer — Resource id - `foreign_id` string — Unique identifier of this resource from the integrated system - `location_id` integer, nullable — The ID of the location that this item is for - `patient_id` integer, nullable — The ID of the patient that this item is for - `guarantor_id` integer, nullable — The ID of the guarantor that this item is for - `provider_id` integer, nullable — The ID of the provider that this item is for - `updated_at` string, date-time — Last updated time for item in UTC - `description` string, nullable — A description of the item - `deleted_at` string, date-time, nullable — Deleted time for item in UTC - `payment_amount` APIV2EntitiesPrice - `amount` string — The currency value, in whole units (e.g. dollars) - `currency` string — The ISO currency code - `paid_at` string, date, nullable — The UTC date payment was made - `transaction_id` string, nullable — The ID of the transaction for this payment - `charge_id` integer, nullable — The ID of the charge for this payment - `claim_id` integer, nullable — The ID of the insurance claim for this payment - `payment_plan_id` integer, nullable — The ID of the payment plan associated with this payment - `insurance_plan_id` integer, nullable — The ID of the insurance plan associated with this payment - `payment_type_id` integer, nullable — The ID of the payment type for this payment - `patient_alerts` APIV2EntitiesPatientAlert[] — Patient alerts - `id` integer — Patient Alert id - `patient_id` integer — Id of the associated patient - `note` string — The note for the patient alert - `disabled_at` string, date-time — The time that the alert was disabled in UTC - `created_at` string, date-time — The time that the alert was created in UTC - `updated_at` string, date-time — The time that the alert was last updated in UTC - `appointments` APIV2EntitiesAppointmentBasic[] — Appointments for patient within date range - `id` integer — Appointment id - `provider_id` integer — Provider id - `provider_name` string — Provider name - `start_time` string, date-time — Start time of the appointment in UTC - `end_time` string, date-time — End time of the appointment in UTC - `location_id` integer — Location id - `confirmed` boolean — Is this appointment confirmed? - `location_ids` integer[] — Array of location ids associated with the user - `address` APIV2EntitiesPatientAddress - `line_1` string, nullable — Address line 1 - `line_2` string, nullable — Address line 2 - `postal_code` string, nullable — Zip code - `city` string, nullable — City - `region` string, nullable — State - `count` integer — Number of total objects, in case of collection. ## Other responses - `400` — Bad Request - `401` — Unauthorized - `403` — Forbidden - `404` — Not Found - `500` — Internal Server Error --- [API](https://skmtc.net/nexhealth/apis/nexhealth-api.md) · [All operations](https://skmtc.net/nexhealth/apis/nexhealth-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/nexhealth/nexhealth-api/revisions/a180e830b672/schema)