Skip to main content

User

A user in the application.

type User {
id: ID!
title: String
firstName: String!
lastName: String!
gender: String
pronouns: String
email: String!
fullName: String!
isDoctor: Boolean
qualifications: String
registration: String
medicalSpecialties: [String!]
deleted: Boolean
minimumTreatmentAge: Int
metadata: [MetadataEntry!]
healthcodeIdentifier: String
createdAt: DateTime
updatedAt: DateTime
accessGroups: [UserAccessGroup]
siretNumber: String
assuranceMaladieNumber: String
annuaireSanteProfile: UserAnnuaireSanteProfile
role: String
mobileNumber: UserMobileNumber
isLocum: Boolean
locumFor: ID
locumStartDate: DateTime
locumEndDate: DateTime
positionTitle: String
position: String
automaticDocumentSigning: Boolean
integrations: UserIntegrations
settings: UserSettings
notifications: UserNotifications
bookings(
start: Date!
end: Date!
page: Int
pageSize: Int
): BookingData
letters(
page: Int
pageSize: Int
): LetterData
servicesProvided: [Product]
}

Fields​

User.id ● ID! non-null scalar​

User.title ● String scalar​

User.firstName ● String! non-null scalar​

User.lastName ● String! non-null scalar​

User.gender ● String scalar​

User.pronouns ● String scalar​

Preferred pronouns when recorded for the user. Only populated for practices outside France; French practices do not use this field (the value will be null).

User.email ● String! non-null scalar​

User.fullName ● String! non-null scalar​

User.isDoctor ● Boolean scalar​

User.qualifications ● String scalar​

User.registration ● String scalar​

User.medicalSpecialties ● [String!] list scalar​

User.deleted ● Boolean scalar​

User.minimumTreatmentAge ● Int scalar​

Valid treatment age range for the user. 0 is the minimum age, 150 is the maximum age.

User.metadata ● [MetadataEntry!] list object​

User.healthcodeIdentifier ● String scalar​

Healthcode provider identifier for billing (when Healthcode is enabled for the practice).

User.createdAt ● DateTime scalar​

User.updatedAt ● DateTime scalar​

User.accessGroups ● [UserAccessGroup] list object​

User.siretNumber ● String scalar​

French practice compliance. Populated for clinicians in France; null otherwise.

User.assuranceMaladieNumber ● String scalar​

French practice compliance. Populated for clinicians in France; null otherwise.

User.annuaireSanteProfile ● UserAnnuaireSanteProfile object​

French Annuaire Santé directory profile linked to a practice user.

User.role ● String scalar​

Practice role, only support static roles (user, manager, practitioner).

User.mobileNumber ● UserMobileNumber object​

User.isLocum ● Boolean scalar​

User.locumFor ● ID scalar​

User.locumStartDate ● DateTime scalar​

User.locumEndDate ● DateTime scalar​

User.positionTitle ● String scalar​

User.position ● String scalar​

User.automaticDocumentSigning ● Boolean scalar​

User.integrations ● UserIntegrations object​

User.settings ● UserSettings object​

User.notifications ● UserNotifications object​

User.bookings ● BookingData object​

User.bookings.start ● Date! non-null scalar​
User.bookings.end ● Date! non-null scalar​
User.bookings.page ● Int scalar​
User.bookings.pageSize ● Int scalar​

User.letters ● LetterData object​

User.letters.page ● Int scalar​
User.letters.pageSize ● Int scalar​

User.servicesProvided ● [Product] list object​

Returned By​

user query

Member Of​

AvailabilitySettings object ● AvailabilitySlot object ● Booking object ● ClinicalPathway object ● ClinicalReport object ● ClinicalReportSummary object ● Episode object ● Invoice object ● Lab object ● LabComments object ● Letter object ● OnlineBookingConfiguration object ● PatientArchivedInfo object ● Prescription object ● ResourceAvailability object ● Task object ● UserData object ● UserResponsePayload object