Data Model Libraries
    Preparing search index...

    Class Person

    Person Class

    Demographics and administrative information about a person independent of a specific health-related context.

    Need to track persons potentially across multiple roles.

    FHIR Specification

    • Short: A generic person record
    • Definition: Demographics and administrative information about a person independent of a specific health-related context.
    • Comment: The Person resource does justice to person registries that keep track of persons regardless of their role. The Person resource is also a primary resource to point to for people acting in a particular role such as SubjectofCare, Practitioner, and Agent. Very few attributes are specific to any role and so Person is kept lean. Most attributes are expected to be tied to the role the Person plays rather than the Person himself. Examples of that are Guardian (SubjectofCare), ContactParty (SubjectOfCare, Practitioner), and multipleBirthInd (SubjectofCare).
    • FHIR Version: 4.0.1

    FHIR Person

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    constructor

    Properties

    identifier? name? telecom? administrativeGenderEnum gender? birthDate? address? photo? managingOrganization? active? link?

    Methods

    parse getIdentifier setIdentifier addIdentifier hasIdentifier getName setName addName hasName getTelecom setTelecom addTelecom hasTelecom getGenderEnumType setGenderEnumType hasGenderEnumType getGenderElement setGenderElement hasGenderElement getGender setGender hasGender getBirthDateElement setBirthDateElement hasBirthDateElement getBirthDate setBirthDate hasBirthDate getAddress setAddress addAddress hasAddress getPhoto setPhoto hasPhoto getManagingOrganization setManagingOrganization hasManagingOrganization getActiveElement setActiveElement hasActiveElement getActive setActive hasActive getLink setLink addLink hasLink fhirType isEmpty copy toJSON getText setText hasText getContained setContained addContained hasContained getExtension setExtension hasExtension getExtensionByUrl addExtension removeExtension getModifierExtension setModifierExtension hasModifierExtension getModifierExtensionByUrl addModifierExtension removeModifierExtension resourceType getIdElement setIdElement hasIdElement getId setId hasId getMeta setMeta hasMeta getImplicitRulesElement setImplicitRulesElement hasImplicitRulesElement getImplicitRules setImplicitRules hasImplicitRules getLanguageElement setLanguageElement hasLanguageElement getLanguage setLanguage hasLanguage isResource isRequiredFieldsEmpty isDataType isComplexDataType isPrimitive isBooleanPrimitive isStringPrimitive isNumberPrimitive isBigIntPrimitive isDateTimePrimitive copyValues initIdentifier initName initTelecom initAddress initLink

    Constructors

    Properties

    identifier?: Identifier[]

    Person.identifier Element

    FHIR Specification

    • Short: A human identifier for this person
    • Definition: Identifier for a person within a particular scope.
    • Requirements: People are known by a variety of ids. Some institutions maintain several, and most collect identifiers for exchange with other organizations concerning the person. Examples are national person identifier and local identifier.
    • FHIR Type: Identifier
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    name?: HumanName[]

    Person.name Element

    FHIR Specification

    • Short: A name associated with the person
    • Definition: A name associated with the person.
    • Comment: Person may have multiple names with different uses or applicable periods.
    • Requirements: Need to be able to track the person by multiple names. Examples are your official name and a partner name.
    • FHIR Type: HumanName
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true
    telecom?: ContactPoint[]

    Person.telecom Element

    FHIR Specification

    • Short: A contact detail for the person
    • Definition: A contact detail for the person, e.g. a telephone number or an email address.
    • Comment: Person may have multiple ways to be contacted with different uses or applicable periods. May need to have options for contacting the person urgently and also to help with identification.
    • Requirements: People have (primary) ways to contact them in some way such as phone, email.
    • FHIR Type: ContactPoint
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true
    administrativeGenderEnum: AdministrativeGenderEnum

    FHIR CodeSystem: AdministrativeGender

    AdministrativeGenderEnum

    gender?: EnumCodeType

    Person.gender Element

    FHIR Specification

    • Short: male | female | other | unknown
    • Definition: Administrative Gender.
    • Comment: The gender might not match the biological sex as determined by genetics, or the individual's preferred identification. Note that for both humans and particularly animals, there are other legitimate possibilities than M and F, though a clear majority of systems and contexts only support M and F.
    • Requirements: Needed for identification of the person, in combination with (at least) name and birth date. Gender of person drives many clinical processes.
    • FHIR Type: code
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true

    CodeSystem Enumeration: AdministrativeGenderEnum

    birthDate?: DateType

    Person.birthDate Element

    FHIR Specification

    • Short: The date on which the person was born
    • Definition: The birth date for the person.
    • Comment: At least an estimated year should be provided as a guess if the real DOB is unknown.
    • Requirements: Age of person drives many clinical processes, and is often used in performing identification of the person. Times are not included so as to not confuse things with potential timezone issues.
    • FHIR Type: date
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    address?: Address[]

    Person.address Element

    FHIR Specification

    • Short: One or more addresses for the person
    • Definition: One or more addresses for the person.
    • Comment: Person may have multiple addresses with different uses or applicable periods.
    • Requirements: May need to keep track of person's addresses for contacting, billing or reporting requirements and also to help with identification.
    • FHIR Type: Address
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    photo?: Attachment

    Person.photo Element

    FHIR Specification

    • Short: Image of the person
    • Definition: An image that can be displayed as a thumbnail of the person to enhance the identification of the individual.
    • FHIR Type: Attachment
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    managingOrganization?: Reference

    Person.managingOrganization Element

    FHIR Specification

    • Short: The organization that is the custodian of the person record
    • Definition: The organization that is the custodian of the person record.
    • Requirements: Need to know who recognizes this person record, manages and updates it.
    • FHIR Type: Reference
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    active?: BooleanType

    Person.active Element

    FHIR Specification

    • Short: This person's record is in active use
    • Definition: Whether this person's record is in active use.
    • Requirements: Need to be able to mark a person record as not to be used because it was created in error.
    • FHIR Type: boolean
    • Cardinality: 0..1
    • isModifier: true
    • isModifierReason: This element is labelled as a modifier because it is a status element that can indicate that a record should not be treated as valid
    • isSummary: true
    link?: PersonLinkComponent[]

    Person.link Element

    FHIR Specification

    • Short: Link to a resource that concerns the same actual person
    • Definition: Link to a resource that concerns the same actual person.
    • FHIR Type: BackboneElement
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false

    Methods

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

      Parameters

      • sourceJson: Value

        JSON representing FHIR Person

      • OptionaloptSourceField: string

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

      Returns undefined | Person

      Person data model or undefined for Person

      JsonError if the provided JSON is not a valid JSON object

    • Assigns the provided ManagingOrganization object value to the managingOrganization property.

      Parameters

      • value: undefined | Reference

        the managingOrganization object value

      Returns this

      this

      @ReferenceTargets('Person.managingOrganization', ['Organization',])

      InvalidTypeError for invalid data type or reference value

    • Assigns the provided value to the text property.

      Parameters

      Returns this

      this

    • Returns boolean

      true if the text property exists and has a value; false otherwise

    • Assigns the provided Resource array value to the contained property.

      Parameters

      • value: undefined | IResource[]

        the contained array value

      Returns this

      this

    • Returns boolean

      true if the contained property 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

    • 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

    • Determines if the modifierExtension property exists.

      Parameters

      • Optionalurl: string

        the url that identifies a specific Extension

      Returns boolean

      true if an Extension has 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 modifierExtension property exists and has any values.

      AssertionError for invalid url

    • Assigns the provided PrimitiveType value to the id property.

      Parameters

      • element: undefined | IdType

        the id value

      Returns this

      this

    • Returns undefined | string

      the id property value as a primitive value

    • Assigns the provided primitive value to the id property.

      Parameters

      • value: undefined | string

        the id value

      Returns this

      this

      PrimitiveTypeError for invalid primitive types

    • Returns boolean

      true if the id property exists and has a value; false otherwise

    • Assigns the provided value to the meta property.

      Parameters

      • value: undefined | Meta

        the meta value

      Returns this

      this

    • Returns boolean

      true if the meta property exists and has a value; false otherwise

    • Assigns the provided primitive value to the implicitRules property.

      Parameters

      • value: undefined | string

        the implicitRules value

      Returns this

      this

      PrimitiveTypeError for invalid primitive types

    • Returns undefined | string

      the language property value as a primitive value

    • Assigns the provided primitive value to the language property.

      Parameters

      • value: undefined | string

        the language value

      Returns this

      this

      PrimitiveTypeError for invalid primitive types

    • Returns boolean

      true if the language property exists and has a value; false otherwise

    • 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 complex or primitive datatype; false otherwise

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    parsegetIdentifiersetIdentifieraddIdentifierhasIdentifiergetNamesetNameaddNamehasNamegetTelecomsetTelecomaddTelecomhasTelecomgetGenderEnumTypesetGenderEnumTypehasGenderEnumTypegetGenderElementsetGenderElementhasGenderElementgetGendersetGenderhasGendergetBirthDateElementsetBirthDateElementhasBirthDateElementgetBirthDatesetBirthDatehasBirthDategetAddresssetAddressaddAddresshasAddressgetPhotosetPhotohasPhotogetManagingOrganizationsetManagingOrganizationhasManagingOrganizationgetActiveElementsetActiveElementhasActiveElementgetActivesetActivehasActivegetLinksetLinkaddLinkhasLinkfhirTypeisEmptycopytoJSONgetTextsetTexthasTextgetContainedsetContainedaddContainedhasContainedgetExtensionsetExtensionhasExtensiongetExtensionByUrladdExtensionremoveExtensiongetModifierExtensionsetModifierExtensionhasModifierExtensiongetModifierExtensionByUrladdModifierExtensionremoveModifierExtensionresourceTypegetIdElementsetIdElementhasIdElementgetIdsetIdhasIdgetMetasetMetahasMetagetImplicitRulesElementsetImplicitRulesElementhasImplicitRulesElementgetImplicitRulessetImplicitRuleshasImplicitRulesgetLanguageElementsetLanguageElementhasLanguageElementgetLanguagesetLanguagehasLanguageisResourceisRequiredFieldsEmptyisDataTypeisComplexDataTypeisPrimitiveisBooleanPrimitiveisStringPrimitiveisNumberPrimitiveisBigIntPrimitiveisDateTimePrimitivecopyValuesinitIdentifierinitNameinitTelecominitAddressinitLink