Data Model Libraries
    Preparing search index...

    Class FamilyMemberHistory

    FamilyMemberHistory Class

    Significant health conditions for a person related to the patient relevant in the context of care for the patient.

    FHIR Specification

    • Short: Information about patient's relatives, relevant for patient
    • Definition: Significant health conditions for a person related to the patient relevant in the context of care for the patient.
    • FHIR Version: 5.0.0

    FHIR FamilyMemberHistory

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    constructor

    Properties

    identifier? instantiatesCanonical? instantiatesUri? historyStatusEnum status dataAbsentReason? patient date? participant? name? relationship sex? born? age? estimatedAge? deceased? reason? note? condition? procedure?

    Methods

    parse getIdentifier setIdentifier addIdentifier hasIdentifier getInstantiatesCanonicalElement setInstantiatesCanonicalElement addInstantiatesCanonicalElement hasInstantiatesCanonicalElement getInstantiatesCanonical setInstantiatesCanonical addInstantiatesCanonical hasInstantiatesCanonical getInstantiatesUriElement setInstantiatesUriElement addInstantiatesUriElement hasInstantiatesUriElement getInstantiatesUri setInstantiatesUri addInstantiatesUri hasInstantiatesUri getStatusEnumType setStatusEnumType hasStatusEnumType getStatusElement setStatusElement hasStatusElement getStatus setStatus hasStatus getDataAbsentReason setDataAbsentReason hasDataAbsentReason getPatient setPatient hasPatient getDateElement setDateElement hasDateElement getDate setDate hasDate getParticipant setParticipant addParticipant hasParticipant getNameElement setNameElement hasNameElement getName setName hasName getRelationship setRelationship hasRelationship getSex setSex hasSex getBorn setBorn hasBorn getBornPeriod hasBornPeriod getBornDateType hasBornDateType getBornStringType hasBornStringType getAge setAge hasAge getAgeAge hasAgeAge getAgeRange hasAgeRange getAgeStringType hasAgeStringType getEstimatedAgeElement setEstimatedAgeElement hasEstimatedAgeElement getEstimatedAge setEstimatedAge hasEstimatedAge getDeceased setDeceased hasDeceased getDeceasedBooleanType hasDeceasedBooleanType getDeceasedAge hasDeceasedAge getDeceasedRange hasDeceasedRange getDeceasedDateType hasDeceasedDateType getDeceasedStringType hasDeceasedStringType getReason setReason addReason hasReason getNote setNote addNote hasNote getCondition setCondition addCondition hasCondition getProcedure setProcedure addProcedure hasProcedure 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 initInstantiatesCanonical initInstantiatesUri initParticipant initReason initNote initCondition initProcedure

    Constructors

    Properties

    identifier?: Identifier[]

    FamilyMemberHistory.identifier Element

    FHIR Specification

    • Short: External Id(s) for this record
    • Definition: Business identifiers assigned to this family member history by the performer or other systems which remain constant as the resource is updated and propagates from server to server.
    • Comment: This is a business identifier, not a resource identifier (see discussion). It is best practice for the identifier to only appear on a single resource instance, however business practices may occasionally dictate that multiple resource instances with the same identifier can exist - possibly even with different resource types. For example, multiple Patient and a Person resource instance might share the same social insurance number.
    • Requirements: Allows identification of the family member history as it is known by various participating systems and in a way that remains consistent across servers.
    • FHIR Type: Identifier
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true
    instantiatesCanonical?: CanonicalType[]

    FamilyMemberHistory.instantiatesCanonical Element

    FHIR Specification

    instantiatesUri?: UriType[]

    FamilyMemberHistory.instantiatesUri Element

    FHIR Specification

    • Short: Instantiates external protocol or definition
    • Definition: The URL pointing to an externally maintained protocol, guideline, orderset or other definition that is adhered to in whole or in part by this FamilyMemberHistory.
    • Comment: This might be an HTML page, PDF, etc. or could just be a non-resolvable URI identifier.
    • FHIR Type: uri
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true
    historyStatusEnum: HistoryStatusEnum

    FHIR CodeSystem: HistoryStatus

    HistoryStatusEnum

    status: null | EnumCodeType

    FamilyMemberHistory.status Element

    FHIR Specification

    • Short: partial | completed | entered-in-error | health-unknown
    • Definition: A code specifying the status of the record of the family history of a specific family member.
    • Comment: This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid.
    • FHIR Type: code
    • Cardinality: 1..1
    • isModifier: true
    • isModifierReason: This element is labelled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid
    • isSummary: true

    CodeSystem Enumeration: HistoryStatusEnum

    dataAbsentReason?: CodeableConcept

    FamilyMemberHistory.dataAbsentReason Element

    FHIR Specification

    • Short: subject-unknown | withheld | unable-to-obtain | deferred
    • Definition: Describes why the family member's history is not available.
    • Requirements: This is a separate element to allow it to have a distinct binding from reasonCode.
    • FHIR Type: CodeableConcept
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    patient: null | Reference

    FamilyMemberHistory.patient Element

    FHIR Specification

    • Short: Patient history is about
    • Definition: The person who this history concerns.
    • Comment: This is not the family member.
    • FHIR Type: Reference
    • Cardinality: 1..1
    • isModifier: false
    • isSummary: true
    date?: DateTimeType

    FamilyMemberHistory.date Element

    FHIR Specification

    • Short: When history was recorded or last updated
    • Definition: The date (and possibly time) when the family member history was recorded or last updated.
    • Comment: This should be captured even if the same as the date on the List aggregating the full family history.
    • Requirements: Allows determination of how current the summary is.
    • FHIR Type: dateTime
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    participant?: FamilyMemberHistoryParticipantComponent[]

    FamilyMemberHistory.participant Element

    FHIR Specification

    • Short: Who or what participated in the activities related to the family member history and how they were involved
    • Definition: Indicates who or what participated in the activities related to the family member history and how they were involved.
    • FHIR Type: BackboneElement
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true
    name?: StringType

    FamilyMemberHistory.name Element

    FHIR Specification

    • Short: The family member described
    • Definition: This will either be a name or a description; e.g. "Aunt Susan", "my cousin with the red hair".
    • Requirements: Allows greater ease in ensuring the same person is being talked about.
    • FHIR Type: string
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    relationship: null | CodeableConcept

    FamilyMemberHistory.relationship Element

    FHIR Specification

    • Short: Relationship to the subject
    • Definition: The type of relationship this person has to the patient (father, mother, brother etc.).
    • FHIR Type: CodeableConcept
    • Cardinality: 1..1
    • isModifier: false
    • isSummary: true
    sex?: CodeableConcept

    FamilyMemberHistory.sex Element

    FHIR Specification

    • Short: male | female | other | unknown
    • Definition: The birth sex of the family member.
    • Comment: This element should ideally reflect whether the individual is genetically male or female. However, as reported information based on the knowledge of the patient or reporting friend/relative, there may be situations where the reported sex might not be totally accurate. E.g. 'Aunt Sue' might be XY rather than XX. Questions soliciting this information should be phrased to encourage capture of genetic sex where known. However, systems performing analysis should also allow for the possibility of imprecision with this element.
    • Requirements: Not all relationship codes imply sex and the relative's sex can be relevant for risk assessments.
    • FHIR Type: CodeableConcept
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    born?: IDataType

    FamilyMemberHistory.born[x] Element

    @ChoiceDataTypesMeta('FamilyMemberHistory.born[x]', ['Period','date','string',]

    FHIR Specification

    • Short: (approximate) date of birth
    • Definition: The actual or approximate date of birth of the relative.
    • Requirements: Allows calculation of the relative's age.
    • FHIR Types: 'Period', 'date', 'string',
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    age?: IDataType

    FamilyMemberHistory.age[x] Element

    @ChoiceDataTypesMeta('FamilyMemberHistory.age[x]', ['Age','Range','string',]

    FHIR Specification

    • Short: (approximate) age
    • Definition: The age of the relative at the time the family member history is recorded.
    • Comment: use estimatedAge to indicate whether the age is actual or not.
    • Requirements: While age can be calculated from date of birth, sometimes recording age directly is more natural for clinicians.
    • FHIR Types: 'Age', 'Range', 'string',
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    estimatedAge?: BooleanType

    FamilyMemberHistory.estimatedAge Element

    FHIR Specification

    • Short: Age is estimated?
    • Definition: If true, indicates that the age value specified is an estimated value.
    • Comment: This element is labeled as a modifier because the fact that age is estimated can/should change the results of any algorithm that calculates based on the specified age.
    • Requirements: Clinicians often prefer to specify an estimaged age rather than an age range.
    • FHIR Type: boolean
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    deceased?: IDataType

    FamilyMemberHistory.deceased[x] Element

    @ChoiceDataTypesMeta('FamilyMemberHistory.deceased[x]', ['boolean','Age','Range','date','string',]

    FHIR Specification

    • Short: Dead? How old/when?
    • Definition: Deceased flag or the actual or approximate age of the relative at the time of death for the family member history record.
    • FHIR Types: 'boolean', 'Age', 'Range', 'date', 'string',
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    reason?: CodeableReference[]

    FamilyMemberHistory.reason Element

    FHIR Specification

    note?: Annotation[]

    FamilyMemberHistory.note Element

    FHIR Specification

    • Short: General note about related person
    • Definition: This property allows a non condition-specific note to the made about the related person. Ideally, the note would be in the condition property, but this is not always possible.
    • FHIR Type: Annotation
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    condition?: FamilyMemberHistoryConditionComponent[]

    FamilyMemberHistory.condition Element

    FHIR Specification

    • Short: Condition that the related person had
    • Definition: The significant Conditions (or condition) that the family member had. This is a repeating section to allow a system to represent more than one condition per resource, though there is nothing stopping multiple resources - one per condition.
    • FHIR Type: BackboneElement
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    procedure?: FamilyMemberHistoryProcedureComponent[]

    FamilyMemberHistory.procedure Element

    FHIR Specification

    • Short: Procedures that the related person had
    • Definition: The significant Procedures (or procedure) that the family member had. This is a repeating section to allow a system to represent more than one procedure per resource, though there is nothing stopping multiple resources - one per procedure.
    • FHIR Type: BackboneElement
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false

    Methods

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

      Parameters

      • sourceJson: Value

        JSON representing FHIR FamilyMemberHistory

      • OptionaloptSourceField: string

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

      Returns undefined | FamilyMemberHistory

      FamilyMemberHistory data model or undefined for FamilyMemberHistory

      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
    parsegetIdentifiersetIdentifieraddIdentifierhasIdentifiergetInstantiatesCanonicalElementsetInstantiatesCanonicalElementaddInstantiatesCanonicalElementhasInstantiatesCanonicalElementgetInstantiatesCanonicalsetInstantiatesCanonicaladdInstantiatesCanonicalhasInstantiatesCanonicalgetInstantiatesUriElementsetInstantiatesUriElementaddInstantiatesUriElementhasInstantiatesUriElementgetInstantiatesUrisetInstantiatesUriaddInstantiatesUrihasInstantiatesUrigetStatusEnumTypesetStatusEnumTypehasStatusEnumTypegetStatusElementsetStatusElementhasStatusElementgetStatussetStatushasStatusgetDataAbsentReasonsetDataAbsentReasonhasDataAbsentReasongetPatientsetPatienthasPatientgetDateElementsetDateElementhasDateElementgetDatesetDatehasDategetParticipantsetParticipantaddParticipanthasParticipantgetNameElementsetNameElementhasNameElementgetNamesetNamehasNamegetRelationshipsetRelationshiphasRelationshipgetSexsetSexhasSexgetBornsetBornhasBorngetBornPeriodhasBornPeriodgetBornDateTypehasBornDateTypegetBornStringTypehasBornStringTypegetAgesetAgehasAgegetAgeAgehasAgeAgegetAgeRangehasAgeRangegetAgeStringTypehasAgeStringTypegetEstimatedAgeElementsetEstimatedAgeElementhasEstimatedAgeElementgetEstimatedAgesetEstimatedAgehasEstimatedAgegetDeceasedsetDeceasedhasDeceasedgetDeceasedBooleanTypehasDeceasedBooleanTypegetDeceasedAgehasDeceasedAgegetDeceasedRangehasDeceasedRangegetDeceasedDateTypehasDeceasedDateTypegetDeceasedStringTypehasDeceasedStringTypegetReasonsetReasonaddReasonhasReasongetNotesetNoteaddNotehasNotegetConditionsetConditionaddConditionhasConditiongetProceduresetProcedureaddProcedurehasProcedurefhirTypeisEmptyisRequiredFieldsEmptycopytoJSONgetTextsetTexthasTextgetContainedsetContainedaddContainedhasContainedgetExtensionsetExtensionhasExtensiongetExtensionByUrladdExtensionremoveExtensiongetModifierExtensionsetModifierExtensionhasModifierExtensiongetModifierExtensionByUrladdModifierExtensionremoveModifierExtensionresourceTypegetIdElementsetIdElementhasIdElementgetIdsetIdhasIdgetMetasetMetahasMetagetImplicitRulesElementsetImplicitRulesElementhasImplicitRulesElementgetImplicitRulessetImplicitRuleshasImplicitRulesgetLanguageElementsetLanguageElementhasLanguageElementgetLanguagesetLanguagehasLanguageisResourceisDataTypeisComplexDataTypeisPrimitiveisBooleanPrimitiveisStringPrimitiveisNumberPrimitiveisBigIntPrimitiveisDateTimePrimitivecopyValuesinitIdentifierinitInstantiatesCanonicalinitInstantiatesUriinitParticipantinitReasoninitNoteinitConditioninitProcedure