Data Model Libraries
    Preparing search index...

    Class HumanName

    HumanName Class

    Base StructureDefinition for HumanName Type: A human's name with the ability to identify parts and usage.

    Need to be able to record names, along with notes about their use.

    FHIR Specification

    • Short: Name of a human - parts and usage
    • Definition: A human's name with the ability to identify parts and usage.
    • Comment: Names may be changed, or repudiated, or people may have different names in different contexts. Names may be divided into parts of different type that have variable significance depending on context, though the division into parts does not always matter. With personal names, the different parts might or might not be imbued with some implicit meaning; various cultures associate different importance with the name parts and the degree to which systems must care about name parts around the world varies widely.
    • FHIR Version: 4.0.1

    FHIR HumanName

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    constructor

    Properties

    nameUseEnum use? text? family? given? prefix? suffix? period?

    Methods

    parse getUseEnumType setUseEnumType hasUseEnumType getUseElement setUseElement hasUseElement getUse setUse hasUse getTextElement setTextElement hasTextElement getText setText hasText getFamilyElement setFamilyElement hasFamilyElement getFamily setFamily hasFamily getGivenElement setGivenElement addGivenElement hasGivenElement getGiven setGiven addGiven hasGiven getPrefixElement setPrefixElement addPrefixElement hasPrefixElement getPrefix setPrefix addPrefix hasPrefix getSuffixElement setSuffixElement addSuffixElement hasSuffixElement getSuffix setSuffix addSuffix hasSuffix getPeriod setPeriod hasPeriod fhirType isEmpty copy isComplexDataType dataTypeName toJSON isDataType getId setId hasId getExtension setExtension hasExtension getExtensionByUrl addExtension removeExtension isRequiredFieldsEmpty isResource isPrimitive isBooleanPrimitive isStringPrimitive isNumberPrimitive isBigIntPrimitive isDateTimePrimitive copyValues initGiven initPrefix initSuffix

    Constructors

    Properties

    nameUseEnum: NameUseEnum

    FHIR CodeSystem: NameUse

    NameUseEnum

    use?: EnumCodeType

    HumanName.use Element

    FHIR Specification

    • Short: usual | official | temp | nickname | anonymous | old | maiden
    • Definition: Identifies the purpose for this name.
    • Comment: Applications can assume that a name is current unless it explicitly says that it is temporary or old.
    • Requirements: Allows the appropriate name for a particular context of use to be selected from among a set of names.
    • FHIR Type: code
    • Cardinality: 0..1
    • isModifier: true
    • isModifierReason: This is labeled as "Is Modifier" because applications should not mistake a temporary or old name etc.for a current/permanent one
    • isSummary: true

    CodeSystem Enumeration: NameUseEnum

    Private Optionaltext

    text?: StringType

    HumanName.text Element

    FHIR Specification

    • Short: Text representation of the full name
    • Definition: Specifies the entire name as it should be displayed e.g. on an application UI. This may be provided instead of or as well as the specific parts.
    • Comment: Can provide both a text representation and parts. Applications updating a name SHALL ensure that when both text and parts are present, no content is included in the text that isn't found in a part.
    • Requirements: A renderable, unencoded form.
    • FHIR Type: string
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    family?: StringType

    HumanName.family Element

    FHIR Specification

    • Short: Family name (often called 'Surname')
    • Definition: The part of a name that links to the genealogy. In some cultures (e.g. Eritrea) the family name of a son is the first name of his father.
    • Comment: Family Name may be decomposed into specific parts using extensions (de, nl, es related cultures).
    • FHIR Type: string
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    given?: StringType[]

    HumanName.given Element

    FHIR Specification

    • Short: Given names (not always 'first'). Includes middle names
    • Definition: Given name.
    • Comment: If only initials are recorded, they may be used in place of the full name parts. Initials may be separated into multiple given names but often aren't due to paractical limitations. This element is not called "first name" since given names do not always come first.
    • FHIR Type: string
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true
    prefix?: StringType[]

    HumanName.prefix Element

    FHIR Specification

    • Short: Parts that come before the name
    • Definition: Part of the name that is acquired as a title due to academic, legal, employment or nobility status, etc. and that appears at the start of the name.
    • FHIR Type: string
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true
    suffix?: StringType[]

    HumanName.suffix Element

    FHIR Specification

    • Short: Parts that come after the name
    • Definition: Part of the name that is acquired as a title due to academic, legal, employment or nobility status, etc. and that appears at the end of the name.
    • FHIR Type: string
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true
    period?: Period

    HumanName.period Element

    FHIR Specification

    • Short: Time period when name was/is in use
    • Definition: Indicates the period of time when this name was valid for the named person.
    • Requirements: Allows names to be placed in historical context.
    • FHIR Type: Period
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true

    Methods

    • Parse the provided HumanName JSON to instantiate the HumanName data model.

      Parameters

      • sourceJson: Value

        JSON representing FHIR HumanName

      • OptionaloptSourceField: string

        Optional data source field (e.g. <complexTypeName>.<complexTypeFieldName>); defaults to HumanName

      Returns undefined | HumanName

      HumanName data model or undefined for HumanName

      JsonError if the provided JSON is not a valid JSON object

    • Returns boolean

      true if the instance is a FHIR complex or primitive datatype; false otherwise

    • Returns undefined | string

      the id property value

    • Assigns the provided value to the id property.

      Parameters

      • value: undefined | string

        the id value

      Returns this

      this

      PrimitiveTypeError for invalid value

    • Returns boolean

      true if id exists and has a value; false otherwise

    • Assigns the provided array of Extension values to the extension property.

      Parameters

      • extension: undefined | IExtension[]

        array of Extensions

      Returns this

      this

    • Determines if the extension property exists.

      Parameters

      • Optionalurl: string

        the url that identifies a specific Extension

      Returns boolean

      true if an Extension has the provided url; false otherwise

      If the url is provided, determines if an Extension having the provided url exists. If the url is not provided, determines if the extension property exists and has any values.

      AssertionError for invalid url

    • Determines if the extension property exists.

      Parameters

      • url: string

        the url that identifies a specific Extension

      Returns undefined | IExtension

      an Extension having the provided url

      If the url is provided, determines if an Extension having the provided url exists. If the url is not provided, determines if the extension property exists and has any values.

      AssertionError for invalid url

    • Adds the provided Extension to the extension property array.

      Parameters

      • extension: undefined | IExtension

        the Extension value to add to the extension property array

      Returns this

      this

    • Removes the Extension having the provided url from the extension property array.

      Parameters

      • url: string

        the url that identifies a specific Extension to remove

      Returns void

      AssertionError for invalid url

    • Returns boolean

      true if and only if the data model has required fields (min cardinality > 0) and at least one of those required fields in the instance is empty; false otherwise

    • Returns boolean

      true if the instance is a FHIR resource; false otherwise

    • Returns boolean

      true if the instance is a FHIR primitive datatype; false otherwise

    • Returns boolean

      true if the instance is a FHIR primitive boolean datatype; false otherwise

    • Returns boolean

      true if the instance is a FHIR primitive string-based datatype; false otherwise

    • Returns boolean

      true if the instance is a FHIR primitive number-based datatype; false otherwise

    • Returns boolean

      true if the instance is a FHIR primitive bigint-based datatype; false otherwise

    • Returns boolean

      true if the instance is a FHIR primitive datetime-based datatype; false otherwise

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    parsegetUseEnumTypesetUseEnumTypehasUseEnumTypegetUseElementsetUseElementhasUseElementgetUsesetUsehasUsegetTextElementsetTextElementhasTextElementgetTextsetTexthasTextgetFamilyElementsetFamilyElementhasFamilyElementgetFamilysetFamilyhasFamilygetGivenElementsetGivenElementaddGivenElementhasGivenElementgetGivensetGivenaddGivenhasGivengetPrefixElementsetPrefixElementaddPrefixElementhasPrefixElementgetPrefixsetPrefixaddPrefixhasPrefixgetSuffixElementsetSuffixElementaddSuffixElementhasSuffixElementgetSuffixsetSuffixaddSuffixhasSuffixgetPeriodsetPeriodhasPeriodfhirTypeisEmptycopyisComplexDataTypedataTypeNametoJSONisDataTypegetIdsetIdhasIdgetExtensionsetExtensionhasExtensiongetExtensionByUrladdExtensionremoveExtensionisRequiredFieldsEmptyisResourceisPrimitiveisBooleanPrimitiveisStringPrimitiveisNumberPrimitiveisBigIntPrimitiveisDateTimePrimitivecopyValuesinitGiveninitPrefixinitSuffix