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