Data Model Libraries
    Preparing search index...

    Class RelatedPerson

    RelatedPerson Class

    Information about a person that is involved in the care for a patient, but who is not the target of healthcare, nor has a formal responsibility in the care process.

    Need to track persons related to the patient or the healthcare process.

    FHIR Specification

    • Short: A person that is related to a patient, but who is not a direct target of care
    • Definition: Information about a person that is involved in the care for a patient, but who is not the target of healthcare, nor has a formal responsibility in the care process.
    • FHIR Version: 4.0.1

    FHIR RelatedPerson

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    constructor

    Properties

    identifier? active? patient relationship? name? telecom? administrativeGenderEnum gender? birthDate? address? photo? period? communication?

    Methods

    parse getIdentifier setIdentifier addIdentifier hasIdentifier getActiveElement setActiveElement hasActiveElement getActive setActive hasActive getPatient setPatient hasPatient getRelationship setRelationship addRelationship hasRelationship 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 addPhoto hasPhoto getPeriod setPeriod hasPeriod getCommunication setCommunication addCommunication hasCommunication fhirType isEmpty isRequiredFieldsEmpty 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 isDataType isComplexDataType isPrimitive isBooleanPrimitive isStringPrimitive isNumberPrimitive isBigIntPrimitive isDateTimePrimitive copyValues initIdentifier initRelationship initName initTelecom initAddress initPhoto initCommunication

    Constructors

    Properties

    identifier?: Identifier[]

    RelatedPerson.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 patient. Examples are national person identifier and local identifier.
    • FHIR Type: Identifier
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true
    active?: BooleanType

    RelatedPerson.active Element

    FHIR Specification

    • Short: Whether this related person's record is in active use
    • Definition: Whether this related person record is in active use.
    • Comment: This element is labeled as a modifier because it may be used to mark that the resource was created in error.
    • Requirements: Need to be able to mark a related person record as not to be used, such as if 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
    patient: null | Reference

    RelatedPerson.patient Element

    FHIR Specification

    • Short: The patient this person is related to
    • Definition: The patient this person is related to.
    • Requirements: We need to know which patient this RelatedPerson is related to.
    • FHIR Type: Reference
    • Cardinality: 1..1
    • isModifier: false
    • isSummary: true
    relationship?: CodeableConcept[]

    RelatedPerson.relationship Element

    FHIR Specification

    • Short: The nature of the relationship
    • Definition: The nature of the relationship between a patient and the related person.
    • Requirements: We need to know the relationship with the patient since it influences the interpretation of the information attributed to this person.
    • FHIR Type: CodeableConcept
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true
    name?: HumanName[]

    RelatedPerson.name Element

    FHIR Specification

    • Short: A name associated with the person
    • Definition: A name associated with the person.
    • Requirements: Related persons need to be identified by name, but it is uncommon to need details about multiple other names for that person.
    • FHIR Type: HumanName
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true
    telecom?: ContactPoint[]

    RelatedPerson.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

    RelatedPerson.gender Element

    FHIR Specification

    • Short: male | female | other | unknown
    • Definition: Administrative Gender - the gender that the person is considered to have for administration and record keeping purposes.
    • Requirements: Needed for identification of the person, in combination with (at least) name and birth date.
    • FHIR Type: code
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true

    CodeSystem Enumeration: AdministrativeGenderEnum

    birthDate?: DateType

    RelatedPerson.birthDate Element

    FHIR Specification

    • Short: The date on which the related person was born
    • Definition: The date on which the related person was born.
    • FHIR Type: date
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    address?: Address[]

    RelatedPerson.address Element

    FHIR Specification

    • Short: Address where the related person can be contacted or visited
    • Definition: Address where the related person can be contacted or visited.
    • Requirements: Need to keep track where the related person can be contacted per postal mail or visited.
    • FHIR Type: Address
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true
    photo?: Attachment[]

    RelatedPerson.photo Element

    FHIR Specification

    • Short: Image of the person
    • Definition: Image of the person.
    • Requirements: Many EHR systems have the capability to capture an image of persons. Fits with newer social media usage too.
    • FHIR Type: Attachment
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    period?: Period

    RelatedPerson.period Element

    FHIR Specification

    • Short: Period of time that this relationship is considered valid
    • Definition: The period of time during which this relationship is or was active. If there are no dates defined, then the interval is unknown.
    • FHIR Type: Period
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    communication?: RelatedPersonCommunicationComponent[]

    RelatedPerson.communication Element

    FHIR Specification

    • Short: A language which may be used to communicate with about the patient's health
    • Definition: A language which may be used to communicate with about the patient's health.
    • Comment: If no language is specified, this implies that the default local language is spoken. If you need to convey proficiency for multiple modes, then you need multiple RelatedPerson.Communication associations. If the RelatedPerson does not speak the default local language, then the Interpreter Required Standard can be used to explicitly declare that an interpreter is required.
    • Requirements: If a related person does not speak the local language, interpreters may be required, so languages spoken and proficiency is an important things to keep track of both for patient and other persons of interest.
    • FHIR Type: BackboneElement
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false

    Methods

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

      Parameters

      • sourceJson: Value

        JSON representing FHIR RelatedPerson

      • OptionaloptSourceField: string

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

      Returns undefined | RelatedPerson

      RelatedPerson data model or undefined for RelatedPerson

      JsonError if the provided JSON is not a valid JSON object

    • 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 the instance is a FHIR complex or primitive datatype; false otherwise

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    parsegetIdentifiersetIdentifieraddIdentifierhasIdentifiergetActiveElementsetActiveElementhasActiveElementgetActivesetActivehasActivegetPatientsetPatienthasPatientgetRelationshipsetRelationshipaddRelationshiphasRelationshipgetNamesetNameaddNamehasNamegetTelecomsetTelecomaddTelecomhasTelecomgetGenderEnumTypesetGenderEnumTypehasGenderEnumTypegetGenderElementsetGenderElementhasGenderElementgetGendersetGenderhasGendergetBirthDateElementsetBirthDateElementhasBirthDateElementgetBirthDatesetBirthDatehasBirthDategetAddresssetAddressaddAddresshasAddressgetPhotosetPhotoaddPhotohasPhotogetPeriodsetPeriodhasPeriodgetCommunicationsetCommunicationaddCommunicationhasCommunicationfhirTypeisEmptyisRequiredFieldsEmptycopytoJSONgetTextsetTexthasTextgetContainedsetContainedaddContainedhasContainedgetExtensionsetExtensionhasExtensiongetExtensionByUrladdExtensionremoveExtensiongetModifierExtensionsetModifierExtensionhasModifierExtensiongetModifierExtensionByUrladdModifierExtensionremoveModifierExtensionresourceTypegetIdElementsetIdElementhasIdElementgetIdsetIdhasIdgetMetasetMetahasMetagetImplicitRulesElementsetImplicitRulesElementhasImplicitRulesElementgetImplicitRulessetImplicitRuleshasImplicitRulesgetLanguageElementsetLanguageElementhasLanguageElementgetLanguagesetLanguagehasLanguageisResourceisDataTypeisComplexDataTypeisPrimitiveisBooleanPrimitiveisStringPrimitiveisNumberPrimitiveisBigIntPrimitiveisDateTimePrimitivecopyValuesinitIdentifierinitRelationshipinitNameinitTelecominitAddressinitPhotoinitCommunication