{
"description": null,
"_filename": "StructureDefinition-User.json",
"package_name": "io.health-samurai.core.r4",
"date": null,
"derivation": "specialization",
"publisher": null,
"fhirVersion": "4.0.1",
"name": "User",
"abstract": false,
"type": "User",
"experimental": null,
"resourceType": "StructureDefinition",
"title": null,
"package_version": "0.2601.0",
"status": "active",
"id": "e5b4e188-02c1-4e84-a697-d4115d436560",
"kind": "resource",
"url": "http://health-samurai.io/fhir/core/StructureDefinition/User",
"version": "0.2601.0",
"differential": {
"element": [ {
"id": "User",
"max": "*",
"min": 0,
"path": "User"
}, {
"id": "User._source",
"max": "1",
"min": 0,
"path": "User._source",
"type": [ {
"code": "string"
} ],
"short": "System Property. DO NOT USE IT."
}, {
"id": "User.securityLabel",
"max": "*",
"min": 0,
"path": "User.securityLabel",
"type": [ {
"code": "BackboneElement"
} ],
"short": "List of security labels associated to the user."
}, {
"id": "User.securityLabel.system",
"max": "1",
"min": 0,
"path": "User.securityLabel.system",
"type": [ {
"code": "string"
} ],
"short": "Code system."
}, {
"id": "User.securityLabel.code",
"max": "1",
"min": 0,
"path": "User.securityLabel.code",
"type": [ {
"code": "string"
} ],
"short": "Code value."
}, {
"id": "User.fhirUser",
"max": "1",
"min": 0,
"path": "User.fhirUser",
"type": [ {
"code": "Reference",
"targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Patient", "http://hl7.org/fhir/StructureDefinition/Practitioner", "http://hl7.org/fhir/StructureDefinition/PractitionerRole", "http://hl7.org/fhir/StructureDefinition/Person", "http://hl7.org/fhir/StructureDefinition/RelatedPerson" ]
} ],
"short": "A reference to a related FHIR resource."
}, {
"id": "User.gender",
"max": "1",
"min": 0,
"path": "User.gender",
"type": [ {
"code": "string"
} ],
"short": "The user's gender."
}, {
"id": "User.link",
"max": "*",
"min": 0,
"path": "User.link",
"type": [ {
"code": "BackboneElement"
} ],
"short": "A collection of references or links associated with the user."
}, {
"id": "User.link.link",
"max": "1",
"min": 0,
"path": "User.link.link",
"type": [ {
"code": "Reference"
} ],
"short": "A referenced resource link."
}, {
"id": "User.link.type",
"max": "1",
"min": 0,
"path": "User.link.type",
"type": [ {
"code": "string"
} ],
"short": "A label indicating the link's function."
}, {
"id": "User.data",
"max": "1",
"min": 0,
"path": "User.data",
"short": "Arbitrary user-related data.",
"extension": [ {
"url": "http://health-samurai.io/fhir/core/StructureDefinition/additional-properties-custom-type",
"valueCode": "any"
} ]
}, {
"id": "User.identifier",
"max": "*",
"min": 0,
"path": "User.identifier",
"type": [ {
"code": "Identifier"
} ],
"short": "A list of identifiers for the user."
}, {
"id": "User.userName",
"max": "1",
"min": 0,
"path": "User.userName",
"type": [ {
"code": "string"
} ],
"short": "Unique identifier for the User, typically used to directly authenticate."
}, {
"id": "User.displayName",
"max": "1",
"min": 0,
"path": "User.displayName",
"type": [ {
"code": "string"
} ],
"short": "The name of the User, suitable for display to end-users."
}, {
"id": "User.password",
"max": "1",
"min": 0,
"path": "User.password",
"short": "The User's cleartext password, used for initial or reset scenarios.",
"extension": [ {
"url": "http://health-samurai.io/fhir/core/StructureDefinition/custom-type",
"valueCode": "password"
} ]
}, {
"id": "User.twoFactor",
"max": "1",
"min": 0,
"path": "User.twoFactor",
"type": [ {
"code": "BackboneElement"
} ],
"short": "Two factor settings for user."
}, {
"id": "User.twoFactor.enabled",
"max": "1",
"min": 1,
"path": "User.twoFactor.enabled",
"type": [ {
"code": "boolean"
} ],
"short": "Defines whether two-factor auth is currently enabled."
}, {
"id": "User.twoFactor.transport",
"max": "1",
"min": 0,
"path": "User.twoFactor.transport",
"type": [ {
"code": "string"
} ],
"short": "Transport of 2FA confirmation code (if used)."
}, {
"id": "User.twoFactor.secretKey",
"max": "1",
"min": 1,
"path": "User.twoFactor.secretKey",
"type": [ {
"code": "string"
} ],
"short": "TOTP Secret key."
}, {
"id": "User.active",
"max": "1",
"min": 0,
"path": "User.active",
"type": [ {
"code": "boolean"
} ],
"short": "Deprecated. Use 'inactive' instead. Indicates the User's administrative status."
}, {
"id": "User.inactive",
"max": "1",
"min": 0,
"path": "User.inactive",
"type": [ {
"code": "boolean"
} ],
"short": "A Boolean value indicating the User's administrative status."
}, {
"id": "User.timezone",
"max": "1",
"min": 0,
"path": "User.timezone",
"type": [ {
"code": "string"
} ],
"short": "The User's time zone in the 'Olson' format."
}, {
"id": "User.profileUrl",
"max": "1",
"min": 0,
"path": "User.profileUrl",
"type": [ {
"code": "uri"
} ],
"short": "A fully qualified URL pointing to a page representing the User's online profile."
}, {
"id": "User.locale",
"max": "1",
"min": 0,
"path": "User.locale",
"type": [ {
"code": "string"
} ],
"short": "Indicates the User's default location for localization."
}, {
"id": "User.name",
"max": "1",
"min": 0,
"path": "User.name",
"type": [ {
"code": "BackboneElement"
} ],
"short": "The components of the user's real name."
}, {
"id": "User.name.formatted",
"max": "1",
"min": 0,
"path": "User.name.formatted",
"type": [ {
"code": "string"
} ],
"short": "Full name, including titles and suffixes, formatted for display."
}, {
"id": "User.name.familyName",
"max": "1",
"min": 0,
"path": "User.name.familyName",
"type": [ {
"code": "string"
} ],
"short": "Family name (last name in Western languages)."
}, {
"id": "User.name.givenName",
"max": "1",
"min": 0,
"path": "User.name.givenName",
"type": [ {
"code": "string"
} ],
"short": "Given name (first name in Western languages)."
}, {
"id": "User.name.middleName",
"max": "1",
"min": 0,
"path": "User.name.middleName",
"type": [ {
"code": "string"
} ],
"short": "The middle name(s) of the User."
}, {
"id": "User.name.honorificPrefix",
"max": "1",
"min": 0,
"path": "User.name.honorificPrefix",
"type": [ {
"code": "string"
} ],
"short": "Honorific prefix (title), e.g. 'Ms.'."
}, {
"id": "User.name.honorificSuffix",
"max": "1",
"min": 0,
"path": "User.name.honorificSuffix",
"type": [ {
"code": "string"
} ],
"short": "Honorific suffix, e.g. 'III'."
}, {
"id": "User.email",
"max": "1",
"min": 0,
"path": "User.email",
"type": [ {
"code": "string"
} ],
"short": "Primary email for the user."
}, {
"id": "User.emails",
"max": "*",
"min": 0,
"path": "User.emails",
"type": [ {
"code": "BackboneElement"
} ],
"short": "Email addresses for the user."
}, {
"id": "User.emails.value",
"max": "1",
"min": 0,
"path": "User.emails.value",
"type": [ {
"code": "string"
} ],
"short": "An individual email address (canonicalized)."
}, {
"id": "User.emails.display",
"max": "1",
"min": 0,
"path": "User.emails.display",
"type": [ {
"code": "string"
} ],
"short": "A human-readable name for display purposes (READ-ONLY)."
}, {
"id": "User.emails.type",
"max": "1",
"min": 0,
"path": "User.emails.type",
"type": [ {
"code": "string"
} ],
"short": "A label indicating the attribute's function, e.g. 'work', 'home'."
}, {
"id": "User.emails.primary",
"max": "1",
"min": 0,
"path": "User.emails.primary",
"type": [ {
"code": "boolean"
} ],
"short": "Indicates if this is the primary email."
}, {
"id": "User.phoneNumber",
"max": "1",
"min": 0,
"path": "User.phoneNumber",
"type": [ {
"code": "string"
} ],
"short": "Primary phone number."
}, {
"id": "User.phoneNumbers",
"max": "*",
"min": 0,
"path": "User.phoneNumbers",
"type": [ {
"code": "BackboneElement"
} ],
"short": "Phone numbers for the User."
}, {
"id": "User.phoneNumbers.value",
"max": "1",
"min": 0,
"path": "User.phoneNumbers.value",
"type": [ {
"code": "string"
} ],
"short": "The user's phone number."
}, {
"id": "User.phoneNumbers.display",
"max": "1",
"min": 0,
"path": "User.phoneNumbers.display",
"type": [ {
"code": "string"
} ],
"short": "A human-readable name for display purposes (READ-ONLY)."
}, {
"id": "User.phoneNumbers.type",
"max": "1",
"min": 0,
"path": "User.phoneNumbers.type",
"type": [ {
"code": "string"
} ],
"short": "A label for the phone number's function."
}, {
"id": "User.phoneNumbers.primary",
"max": "1",
"min": 0,
"path": "User.phoneNumbers.primary",
"type": [ {
"code": "boolean"
} ],
"short": "Indicates if this is the primary phone number."
}, {
"id": "User.photo",
"max": "1",
"min": 0,
"path": "User.photo",
"type": [ {
"code": "uri"
} ],
"short": "Primary photo for the user."
}, {
"id": "User.preferredLanguage",
"max": "1",
"min": 0,
"path": "User.preferredLanguage",
"type": [ {
"code": "string"
} ],
"short": "The User's preferred written or spoken language."
}, {
"id": "User.addresses",
"max": "*",
"min": 0,
"path": "User.addresses",
"type": [ {
"code": "BackboneElement"
} ],
"short": "A physical mailing address for this User."
}, {
"id": "User.addresses.formatted",
"max": "1",
"min": 0,
"path": "User.addresses.formatted",
"type": [ {
"code": "string"
} ],
"short": "Full address, formatted for display or mailing label."
}, {
"id": "User.addresses.streetAddress",
"max": "1",
"min": 0,
"path": "User.addresses.streetAddress",
"type": [ {
"code": "string"
} ],
"short": "Street address component (may contain newlines)."
}, {
"id": "User.addresses.locality",
"max": "1",
"min": 0,
"path": "User.addresses.locality",
"type": [ {
"code": "string"
} ],
"short": "City or locality component."
}, {
"id": "User.addresses.region",
"max": "1",
"min": 0,
"path": "User.addresses.region",
"type": [ {
"code": "string"
} ],
"short": "State or region component."
}, {
"id": "User.addresses.postalCode",
"max": "1",
"min": 0,
"path": "User.addresses.postalCode",
"type": [ {
"code": "string"
} ],
"short": "Zip code or postal code."
}, {
"id": "User.addresses.country",
"max": "1",
"min": 0,
"path": "User.addresses.country",
"type": [ {
"code": "string"
} ],
"short": "Country name component."
}, {
"id": "User.addresses.type",
"max": "1",
"min": 0,
"path": "User.addresses.type",
"type": [ {
"code": "string"
} ],
"short": "A label indicating the address type."
}, {
"id": "User.userType",
"max": "1",
"min": 0,
"path": "User.userType",
"type": [ {
"code": "string"
} ],
"short": "Identifies the relationship between the organization and the user."
}, {
"id": "User.title",
"max": "1",
"min": 0,
"path": "User.title",
"type": [ {
"code": "string"
} ],
"short": "The user's title, e.g. 'Vice President'."
}, {
"id": "User.employeeNumber",
"max": "1",
"min": 0,
"path": "User.employeeNumber",
"type": [ {
"code": "string"
} ],
"short": "Numeric or alphanumeric identifier assigned to a person."
}, {
"id": "User.division",
"max": "1",
"min": 0,
"path": "User.division",
"type": [ {
"code": "string"
} ],
"short": "Identifies the name of a division."
}, {
"id": "User.department",
"max": "1",
"min": 0,
"path": "User.department",
"type": [ {
"code": "string"
} ],
"short": "Identifies the name of a department."
}, {
"id": "User.costCenter",
"max": "1",
"min": 0,
"path": "User.costCenter",
"type": [ {
"code": "string"
} ],
"short": "Identifies the name of a cost center."
}, {
"id": "User.manager",
"max": "1",
"min": 0,
"path": "User.manager",
"type": [ {
"code": "Reference",
"targetProfile": [ "http://health-samurai.io/fhir/core/StructureDefinition/User" ]
} ],
"short": "Another User resource who is this User's manager."
}, {
"id": "User.organization",
"max": "1",
"min": 0,
"path": "User.organization",
"type": [ {
"code": "Reference",
"targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Organization" ]
} ],
"short": "Identifies the name of an organization."
}, {
"id": "User.ims",
"max": "*",
"min": 0,
"path": "User.ims",
"type": [ {
"code": "BackboneElement"
} ],
"short": "Instant messaging addresses for the User."
}, {
"id": "User.ims.value",
"max": "1",
"min": 0,
"path": "User.ims.value",
"type": [ {
"code": "string"
} ],
"short": "Instant messaging address."
}, {
"id": "User.ims.display",
"max": "1",
"min": 0,
"path": "User.ims.display",
"type": [ {
"code": "string"
} ],
"short": "A human-readable name, primarily for display (READ-ONLY)."
}, {
"id": "User.ims.type",
"max": "1",
"min": 0,
"path": "User.ims.type",
"type": [ {
"code": "string"
} ],
"short": "A label indicating the IM type, e.g. 'aim', 'gtalk'."
}, {
"id": "User.ims.primary",
"max": "1",
"min": 0,
"path": "User.ims.primary",
"type": [ {
"code": "boolean"
} ],
"short": "Indicates if this is the primary IM. Only one may be 'true'."
}, {
"id": "User.entitlements",
"max": "*",
"min": 0,
"path": "User.entitlements",
"type": [ {
"code": "BackboneElement"
} ],
"short": "A list of entitlements for the User that represent a thing the User has."
}, {
"id": "User.entitlements.value",
"max": "1",
"min": 0,
"path": "User.entitlements.value",
"type": [ {
"code": "string"
} ],
"short": "The value of an entitlement."
}, {
"id": "User.entitlements.display",
"max": "1",
"min": 0,
"path": "User.entitlements.display",
"type": [ {
"code": "string"
} ],
"short": "A human-readable name, primarily used for display purposes (READ-ONLY)."
}, {
"id": "User.entitlements.type",
"max": "1",
"min": 0,
"path": "User.entitlements.type",
"type": [ {
"code": "string"
} ],
"short": "A label indicating the attribute's function."
}, {
"id": "User.entitlements.primary",
"max": "1",
"min": 0,
"path": "User.entitlements.primary",
"type": [ {
"code": "boolean"
} ],
"short": "Indicates if this is the primary entitlement. Only one may be 'true'."
}, {
"id": "User.roles",
"max": "*",
"min": 0,
"path": "User.roles",
"type": [ {
"code": "BackboneElement"
} ],
"short": "A list of roles for the User that collectively represent who the User is (e.g. 'Student', 'Faculty')."
}, {
"id": "User.roles.value",
"max": "1",
"min": 0,
"path": "User.roles.value",
"type": [ {
"code": "string"
} ],
"short": "The value of a role."
}, {
"id": "User.roles.display",
"max": "1",
"min": 0,
"path": "User.roles.display",
"type": [ {
"code": "string"
} ],
"short": "A human-readable name, primarily used for display purposes (READ-ONLY)."
}, {
"id": "User.roles.type",
"max": "1",
"min": 0,
"path": "User.roles.type",
"type": [ {
"code": "string"
} ],
"short": "A label indicating the attribute's function."
}, {
"id": "User.roles.primary",
"max": "1",
"min": 0,
"path": "User.roles.primary",
"type": [ {
"code": "boolean"
} ],
"short": "Indicates if this is the primary role. Only one may be 'true'."
}, {
"id": "User.x509Certificates",
"max": "*",
"min": 0,
"path": "User.x509Certificates",
"type": [ {
"code": "BackboneElement"
} ],
"short": "A list of certificates issued to the User."
}, {
"id": "User.x509Certificates.value",
"max": "1",
"min": 0,
"path": "User.x509Certificates.value",
"type": [ {
"code": "base64Binary"
} ],
"short": "The value of an X.509 certificate (base64)."
}, {
"id": "User.x509Certificates.display",
"max": "1",
"min": 0,
"path": "User.x509Certificates.display",
"type": [ {
"code": "string"
} ],
"short": "A human-readable name, primarily used for display purposes (READ-ONLY)."
}, {
"id": "User.x509Certificates.type",
"max": "1",
"min": 0,
"path": "User.x509Certificates.type",
"type": [ {
"code": "string"
} ],
"short": "A label indicating the certificate's function."
}, {
"id": "User.x509Certificates.primary",
"max": "1",
"min": 0,
"path": "User.x509Certificates.primary",
"type": [ {
"code": "boolean"
} ],
"short": "Indicates if this is the primary certificate. Only one may be 'true'."
}, {
"id": "User.photos",
"max": "*",
"min": 0,
"path": "User.photos",
"type": [ {
"code": "BackboneElement"
} ],
"short": "URLs of photos of the user."
}, {
"id": "User.photos.value",
"max": "1",
"min": 0,
"path": "User.photos.value",
"type": [ {
"code": "uri"
} ],
"short": "URL of a photo of the User."
}, {
"id": "User.photos.display",
"max": "1",
"min": 0,
"path": "User.photos.display",
"type": [ {
"code": "string"
} ],
"short": "A human-readable name, primarily used for display purposes (READ-ONLY)."
}, {
"id": "User.photos.type",
"max": "1",
"min": 0,
"path": "User.photos.type",
"type": [ {
"code": "string"
} ],
"short": "A label indicating 'photo' or 'thumbnail'."
}, {
"id": "User.photos.primary",
"max": "1",
"min": 0,
"path": "User.photos.primary",
"type": [ {
"code": "boolean"
} ],
"short": "Indicates if this is the primary photo. Only one may be 'true'."
} ]
},
"baseDefinition": "http://hl7.org/fhir/StructureDefinition/DomainResource"
}