Skip to main content

Patient

The data defining a patient.

type Patient {
  id: ID!
  title: String
  status: String
  firstName: String
  lastName: String
  fullName: String
  birthSurname: String
  birthName: String
  birthNames: String
  dob: Date
  placeOfBirth: PlaceOfBirth
  socialSecurityNumber: String
  gender: String
  sex: String
  email: String
  googleClientId: String
  paymentReference: String
  phones: [Phone]
  occupation: String
  address: Address
  membershipName: String
  membershipStartDate: String
  membershipStartDateFormatted: Date
  sharingToken: SharingToken
  numbers: [PatientNumber]
  customAttributes: [CustomAttribute]
  communicationPreferences: CommunicationPreferences
  relatedAccounts: [PatientRelationship]
  bookings(
    start: Date!
    end: Date!
    queryOptions: QueryOptions
    pagination: Pagination
  ): [Booking!]!
  bookingsWithPagination(
    start: Date!
    end: Date!
    queryOptions: QueryOptions
    pagination: Pagination
  ): PatientBookingsData!
  invoices(
    start: Date!
    end: Date!
  ): [Invoice]
  letters: [Letter]
  labs: [Lab]
  labels: [PatientLabel]
  prescriptions(
    page: Int
    pageSize: Int
  ): PrescriptionData
  consultations(
    page: Int
    pageSize: Int
  ): ConsultationData
  records(
    page: Int
    pageSize: Int
  ): RecordData
  patientDocuments(
    page: Int
    pageSize: Int
  ): PatientDocumentData
  documentsSharedWithPatient(
    page: Int
    pageSize: Int = 10
  ): PatientDocumentSharingsData!
  createdAt: DateTime
  updatedAt: DateTime
  accessGroups: [PatientAccessGroup]
  comments: String
  ins: INS
  onHold: Boolean
  archived: Boolean
  archivedInfo: PatientArchivedInfo
  deceased: Boolean
  dateOfDeath: Date
}

Fields​

Patient.id ● ID! non-null scalar​

Patient.title ● String scalar​

Patient.status ● String scalar​

Patient.firstName ● String scalar​

Patient.lastName ● String scalar​

Patient.fullName ● String scalar​

Patient.birthSurname ● String scalar​

Patient.birthName ● String scalar​

The birth name of the patient. Only applicable to practices in France which are INS certified.

Patient.birthNames ● String scalar​

The birth names of the patient. Only applicable to practices in France which are INS certified.

Patient.dob ● Date scalar​

Patient.placeOfBirth ● PlaceOfBirth object​

Patient.socialSecurityNumber ● String scalar​

Patient.gender ● String scalar​

Patient.sex ● String scalar​

Patient.email ● String scalar​

Patient.googleClientId ● String scalar​

Patient.paymentReference ● String scalar​

Patient.phones ● [Phone] list object​

Patient.occupation ● String scalar​

Patient.address ● Address object​

Patient.membershipName ● String scalar​

Patient.membershipStartDate ● String scalar​

Deprecated. Use membershipStartDateFormatted instead

Patient.membershipStartDateFormatted ● Date scalar​

Patient.sharingToken ● SharingToken object​

Patient.numbers ● [PatientNumber] list object​

Patient.customAttributes ● [CustomAttribute] list object​

Patient.communicationPreferences ● CommunicationPreferences object​

Patient.relatedAccounts ● [PatientRelationship] list object​

Patient.bookings ● [Booking!]! non-null object​

Patient.bookings.start ● Date! non-null scalar​
Patient.bookings.end ● Date! non-null scalar​
Patient.bookings.queryOptions ● QueryOptions input​
Patient.bookings.pagination ● Pagination input​

Patient.bookingsWithPagination ● PatientBookingsData! non-null object​

Enhanced bookings query that can return paginated results

Patient.bookingsWithPagination.start ● Date! non-null scalar​
Patient.bookingsWithPagination.end ● Date! non-null scalar​
Patient.bookingsWithPagination.queryOptions ● QueryOptions input​
Patient.bookingsWithPagination.pagination ● Pagination input​

Patient.invoices ● [Invoice] list object​

Patient.invoices.start ● Date! non-null scalar​
Patient.invoices.end ● Date! non-null scalar​

Patient.letters ● [Letter] list object​

BETA - limited availability

Patient.labs ● [Lab] list object​

Patient.labels ● [PatientLabel] list object​

Patient.prescriptions ● PrescriptionData object​

Patient.prescriptions.page ● Int scalar​
Patient.prescriptions.pageSize ● Int scalar​

Patient.consultations ● ConsultationData object​

Patient.consultations.page ● Int scalar​
Patient.consultations.pageSize ● Int scalar​

Patient.records ● RecordData object​

Patient.records.page ● Int scalar​
Patient.records.pageSize ● Int scalar​

Patient.patientDocuments ● PatientDocumentData object​

Documents/files uploaded by the practice to the patient's file store

Patient.patientDocuments.page ● Int scalar​
Patient.patientDocuments.pageSize ● Int scalar​

Patient.documentsSharedWithPatient ● PatientDocumentSharingsData! non-null object​

Patient.documentsSharedWithPatient.page ● Int scalar​
Patient.documentsSharedWithPatient.pageSize ● Int scalar​

Patient.createdAt ● DateTime scalar​

Patient.updatedAt ● DateTime scalar​

Patient.accessGroups ● [PatientAccessGroup] list object​

Patient.comments ● String scalar​

Patient.ins ● INS object​

Defines the INS properties of a patient. Only applicable to practices in France which are INS certified.

Patient.onHold ● Boolean scalar​

Indicates if the patient is blocked. Use the alias 'blocked: onHold' in queries if you'd like the response field to be 'blocked' instead of 'onHold'.

Patient.archived ● Boolean scalar​

Indicates if the patient is archived

Patient.archivedInfo ● PatientArchivedInfo object​

Information about the patient's archiving status

Patient.deceased ● Boolean scalar​

Indicates if the patient is marked as deceased

Patient.dateOfDeath ● Date scalar​

The patient's date of death, if recorded

Returned By​

patient query

Member Of​

Booking object ● ClinicalPathway object ● ClinicalReport object ● ClinicalReportSummary object ● Email object ● Episode object ● HospitalBookingFormData object ● Invoice object ● Lab object ● Letter object ● PatientData object ● PatientDocument object ● PatientResponsePayload object ● PaymentOnAccount object ● Prescription object ● QuestionnaireResponsePayloadData object ● SMS object ● Task object

Implemented By​

Account union