description: null
package_name: io.health-samurai.core.r5
derivation: specialization
name: User
type: User
elements:
  inactive: {type: boolean, short: A Boolean value indicating the User's administrative status., index: 19}
  employeeNumber: {type: string, short: Numeric or alphanumeric identifier assigned to a person., index: 54}
  department: {type: string, short: Identifies the name of a department., index: 56}
  ims:
    type: BackboneElement
    short: Instant messaging addresses for the User.
    array: true
    index: 60
    elements:
      value: {type: string, short: Instant messaging address., index: 61}
      display: {type: string, short: 'A human-readable name, primarily for display (READ-ONLY).', index: 62}
      type: {type: string, short: 'A label indicating the IM type, e.g. ''aim'', ''gtalk''.', index: 63}
      primary: {type: boolean, short: Indicates if this is the primary IM. Only one may be 'true'., index: 64}
  addresses:
    type: BackboneElement
    short: A physical mailing address for this User.
    array: true
    index: 44
    elements:
      formatted: {type: string, short: 'Full address, formatted for display or mailing label.', index: 45}
      streetAddress: {type: string, short: Street address component (may contain newlines)., index: 46}
      locality: {type: string, short: City or locality component., index: 47}
      region: {type: string, short: State or region component., index: 48}
      postalCode: {type: string, short: Zip code or postal code., index: 49}
      country: {type: string, short: Country name component., index: 50}
      type: {type: string, short: A label indicating the address type., index: 51}
  email: {type: string, short: Primary email for the user., index: 30}
  timezone: {type: string, short: The User's time zone in the 'Olson' format., index: 20}
  profileUrl: {type: uri, short: A fully qualified URL pointing to a page representing the User's online profile., index: 21}
  division: {type: string, short: Identifies the name of a division., index: 55}
  locale: {type: string, short: Indicates the User's default location for localization., index: 22}
  password: {short: 'The User''s cleartext password, used for initial or reset scenarios.', index: 13}
  displayName: {type: string, short: 'The name of the User, suitable for display to end-users.', index: 12}
  entitlements:
    type: BackboneElement
    short: A list of entitlements for the User that represent a thing the User has.
    array: true
    index: 65
    elements:
      value: {type: string, short: The value of an entitlement., index: 66}
      display: {type: string, short: 'A human-readable name, primarily used for display purposes (READ-ONLY).', index: 67}
      type: {type: string, short: A label indicating the attribute's function., index: 68}
      primary: {type: boolean, short: Indicates if this is the primary entitlement. Only one may be 'true'., index: 69}
  name:
    type: BackboneElement
    short: The components of the user's real name.
    index: 23
    elements:
      formatted: {type: string, short: 'Full name, including titles and suffixes, formatted for display.', index: 24}
      familyName: {type: string, short: Family name (last name in Western languages)., index: 25}
      givenName: {type: string, short: Given name (first name in Western languages)., index: 26}
      middleName: {type: string, short: The middle name(s) of the User., index: 27}
      honorificPrefix: {type: string, short: 'Honorific prefix (title), e.g. ''Ms.''.', index: 28}
      honorificSuffix: {type: string, short: 'Honorific suffix, e.g. ''III''.', index: 29}
  roles:
    type: BackboneElement
    short: A list of roles for the User that collectively represent who the User is (e.g. 'Student', 'Faculty').
    array: true
    index: 70
    elements:
      value: {type: string, short: The value of a role., index: 71}
      display: {type: string, short: 'A human-readable name, primarily used for display purposes (READ-ONLY).', index: 72}
      type: {type: string, short: A label indicating the attribute's function., index: 73}
      primary: {type: boolean, short: Indicates if this is the primary role. Only one may be 'true'., index: 74}
  fhirUser:
    type: Reference
    short: A reference to a related FHIR resource.
    refers: ['http://hl7.org/fhir/StructureDefinition/Patient', 'http://hl7.org/fhir/StructureDefinition/Person', 'http://hl7.org/fhir/StructureDefinition/Practitioner', 'http://hl7.org/fhir/StructureDefinition/PractitionerRole', 'http://hl7.org/fhir/StructureDefinition/RelatedPerson']
    index: 4
  phoneNumbers:
    type: BackboneElement
    short: Phone numbers for the User.
    array: true
    index: 37
    elements:
      value: {type: string, short: The user's phone number., index: 38}
      display: {type: string, short: A human-readable name for display purposes (READ-ONLY)., index: 39}
      type: {type: string, short: A label for the phone number's function., index: 40}
      primary: {type: boolean, short: Indicates if this is the primary phone number., index: 41}
  organization:
    type: Reference
    short: Identifies the name of an organization.
    refers: ['http://hl7.org/fhir/StructureDefinition/Organization']
    index: 59
  preferredLanguage: {type: string, short: The User's preferred written or spoken language., index: 43}
  costCenter: {type: string, short: Identifies the name of a cost center., index: 57}
  title: {type: string, short: 'The user''s title, e.g. ''Vice President''.', index: 53}
  x509Certificates:
    type: BackboneElement
    short: A list of certificates issued to the User.
    array: true
    index: 75
    elements:
      value: {type: base64Binary, short: The value of an X.509 certificate (base64)., index: 76}
      display: {type: string, short: 'A human-readable name, primarily used for display purposes (READ-ONLY).', index: 77}
      type: {type: string, short: A label indicating the certificate's function., index: 78}
      primary: {type: boolean, short: Indicates if this is the primary certificate. Only one may be 'true'., index: 79}
  photos:
    type: BackboneElement
    short: URLs of photos of the user.
    array: true
    index: 80
    elements:
      value: {type: uri, short: URL of a photo of the User., index: 81}
      display: {type: string, short: 'A human-readable name, primarily used for display purposes (READ-ONLY).', index: 82}
      type: {type: string, short: A label indicating 'photo' or 'thumbnail'., index: 83}
      primary: {type: boolean, short: Indicates if this is the primary photo. Only one may be 'true'., index: 84}
  manager:
    type: Reference
    short: Another User resource who is this User's manager.
    refers: ['http://health-samurai.io/fhir/core/StructureDefinition/User']
    index: 58
  photo: {type: uri, short: Primary photo for the user., index: 42}
  link:
    type: BackboneElement
    short: A collection of references or links associated with the user.
    array: true
    index: 6
    elements:
      link: {type: Reference, short: A referenced resource link., index: 7}
      type: {type: string, short: A label indicating the link's function., index: 8}
  active: {type: boolean, short: Deprecated. Use 'inactive' instead. Indicates the User's administrative status., index: 18}
  identifier: {type: Identifier, short: A list of identifiers for the user., array: true, index: 10}
  twoFactor:
    type: BackboneElement
    short: Two factor settings for user.
    index: 14
    elements:
      enabled: {type: boolean, short: Defines whether two-factor auth is currently enabled., index: 15}
      transport: {type: string, short: Transport of 2FA confirmation code (if used)., index: 16}
      secretKey: {type: string, short: TOTP Secret key., index: 17}
    required: [enabled, secretKey]
  gender: {type: string, short: The user's gender., index: 5}
  emails:
    type: BackboneElement
    short: Email addresses for the user.
    array: true
    index: 31
    elements:
      value: {type: string, short: An individual email address (canonicalized)., index: 32}
      display: {type: string, short: A human-readable name for display purposes (READ-ONLY)., index: 33}
      type: {type: string, short: 'A label indicating the attribute''s function, e.g. ''work'', ''home''.', index: 34}
      primary: {type: boolean, short: Indicates if this is the primary email., index: 35}
  _source: {type: string, short: System Property. DO NOT USE IT., index: 0}
  phoneNumber: {type: string, short: Primary phone number., index: 36}
  securityLabel:
    type: BackboneElement
    short: List of security labels associated to the user.
    array: true
    index: 1
    elements:
      system: {type: string, short: Code system., index: 2}
      code: {type: string, short: Code value., index: 3}
  userName: {type: string, short: 'Unique identifier for the User, typically used to directly authenticate.', index: 11}
  userType: {type: string, short: Identifies the relationship between the organization and the user., index: 52}
  data: {short: Arbitrary user-related data., index: 9}
package_version: 0.2601.0
class: resource
kind: resource
url: http://health-samurai.io/fhir/core/StructureDefinition/User
base: http://hl7.org/fhir/StructureDefinition/DomainResource
version: 0.2601.0