Skip to main content

CreateUserInput

Input for creating a practice user.

input CreateUserInput {
  firstName: String!
  lastName: String!
  email: String!
  role: String!
  title: String
  pronouns: UserPronoun
  gender: UserGender
  mobileNumber: UserMobileNumberInput
  isDoctor: Boolean
  qualifications: String
  registration: String
  medicalSpecialties: [String!]
  minimumTreatmentAge: Int
  isLocum: Boolean
  locumFor: ID
  locumStartDate: DateTime
  locumEndDate: DateTime
  positionTitle: String
  position: String
  automaticDocumentSigning: Boolean
  integrations: UserIntegrationsInput
  frenchCompliance: UserFrenchComplianceInput
  accessGroupIds: [ID!]
  enableAllPublicAccessGroup: Boolean
  services: UserServicesInput
  settings: UserSettingsInput
  notifications: UserNotificationsInput
}

Fields​

CreateUserInput.firstName ● String! non-null scalar​

CreateUserInput.lastName ● String! non-null scalar​

CreateUserInput.email ● String! non-null scalar​

CreateUserInput.role ● String! non-null scalar​

CreateUserInput.title ● String scalar​

CreateUserInput.pronouns ● UserPronoun enum​

CreateUserInput.gender ● UserGender enum​

CreateUserInput.mobileNumber ● UserMobileNumberInput input​

CreateUserInput.isDoctor ● Boolean scalar​

CreateUserInput.qualifications ● String scalar​

CreateUserInput.registration ● String scalar​

CreateUserInput.medicalSpecialties ● [String!] list scalar​

User-assigned medical specialties. Optional for GB and FR unregulated clinicians (isDoctor without frenchCompliance.annuaireSante). When provided, GB allows multiple; FR unregulated allows at most one. FR regulated clinician (RPPS / Annuaire Santé): must not be sent — use annuaireSanteProfile.specialties on read. Omit for non-clinicians on create.

CreateUserInput.minimumTreatmentAge ● Int scalar​

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

CreateUserInput.isLocum ● Boolean scalar​

CreateUserInput.locumFor ● ID scalar​

CreateUserInput.locumStartDate ● DateTime scalar​

CreateUserInput.locumEndDate ● DateTime scalar​

CreateUserInput.positionTitle ● String scalar​

CreateUserInput.position ● String scalar​

CreateUserInput.automaticDocumentSigning ● Boolean scalar​

CreateUserInput.integrations ● UserIntegrationsInput input​

CreateUserInput.frenchCompliance ● UserFrenchComplianceInput input​

French practice compliance fields. Only applicable when the practice is in France and isDoctor is true. On create, annuaireSante is required for regulated clinicians (with RPPS); omit annuaireSante for unregulated clinicians (medicalSpecialties is optional).

CreateUserInput.accessGroupIds ● [ID!] list scalar​

Omitted fields are left unchanged; null clears optional fields (scalars or nested configuration such as settings and notifications).

CreateUserInput.enableAllPublicAccessGroup ● Boolean scalar​

Adds or removes the user from the Public access group (see all patients and contacts), mirroring the Heydoc users form toggle. Omit/null: create defaults to false, update leaves it unchanged. Requires settingsEditAccessGroups when set.

CreateUserInput.services ● UserServicesInput input​

CreateUserInput.settings ● UserSettingsInput input​

CreateUserInput.notifications ● UserNotificationsInput input​

Member Of​

createUser mutation