Skip to main content


class HS.FHIR.DTL.vDSTU2.Model.Resource.FamilyMemberHistory extends HS.FHIR.DTL.vDSTU2.Model.Base.DomainResource

Information about patient's relatives, relevant for patient.

Property Inventory


Inherited description: ELEMENTQUALIFIED controls the format of exported XML. The ELEMENTQUALIFIED specification should be based on the elementFormDefault attribute of the schema that defines the type. To maintain compatibility, ELEMENTQUALIFIED will default to 1 (true) for literal format export and will default to 0 (false) for encoded or encoded12 format export. These were the values always previously assumed for the elementFormDefault attribute.

NOTE: Direct use of XMLExport method does not support the ELEMENTQUALIFIED. The export must be done using %XML.Writer or SOAP support.

parameter XMLNAME = FamilyMemberHistory;
Inherited description: This parameter provides the default XMLNAME for the class. If it is empty then the class name will be used to construct a default XML name. The default XMLNAME is used as the top level tag when exporting objects and the export context did not provide an XML container name.
parameter XMLSEQUENCE = 1;
Inherited description: If the XMLSEQUENCE = 1, then the order of the XML elements must match the order of the class properties. This allows us to deal with XML where the same field appears multiple times and is distinguished by the order.
parameter XMLTYPE = FamilyMemberHistory;
Inherited description: This parameter provides the default XMLTYPE for the class. If it is empty then the class name will be used to construct a default XML type.

The default XMLTYPE is used when naming and referencing this type in a schema and the schema context did not provide an XML type name.


property ageQuantity as HS.FHIR.DTL.vDSTU2.Model.Datatype.Age (XMLNAME = "ageQuantity", XMLPROJECTION = "ELEMENT");

(approximate) age.

Property methods: ageQuantityGet(), ageQuantityGetSwizzled(), ageQuantityIsValid(), ageQuantityNewObject(), ageQuantitySet()
property ageRange as HS.FHIR.DTL.vDSTU2.Model.Datatype.Range (XMLNAME = "ageRange", XMLPROJECTION = "ELEMENT");

(approximate) age.

Property methods: ageRangeGet(), ageRangeGetSwizzled(), ageRangeIsValid(), ageRangeNewObject(), ageRangeSet()
property ageString as %String (MAXLEN = 1000000, XMLNAME = "ageString", XMLPROJECTION = "ATTRIBUTE");

(approximate) age.

Property methods: ageStringDisplayToLogical(), ageStringGet(), ageStringIsValid(), ageStringLogicalToDisplay(), ageStringLogicalToOdbc(), ageStringNormalize(), ageStringSet()
property bornDate as %String (MAXLEN = 1000000, XMLNAME = "bornDate", XMLPROJECTION = "ATTRIBUTE");

(approximate) date of birth.

Property methods: bornDateDisplayToLogical(), bornDateGet(), bornDateIsValid(), bornDateLogicalToDisplay(), bornDateLogicalToOdbc(), bornDateNormalize(), bornDateSet()
property bornPeriod as HS.FHIR.DTL.vDSTU2.Model.Datatype.Period (XMLNAME = "bornPeriod", XMLPROJECTION = "ELEMENT");

(approximate) date of birth.

Property methods: bornPeriodGet(), bornPeriodGetSwizzled(), bornPeriodIsValid(), bornPeriodNewObject(), bornPeriodSet()
property bornString as %String (MAXLEN = 1000000, XMLNAME = "bornString", XMLPROJECTION = "ATTRIBUTE");

(approximate) date of birth.

Property methods: bornStringDisplayToLogical(), bornStringGet(), bornStringIsValid(), bornStringLogicalToDisplay(), bornStringLogicalToOdbc(), bornStringNormalize(), bornStringSet()
property condition as list of HS.FHIR.DTL.vDSTU2.Model.Element.FamilyMemberHistory.condition (XMLNAME = "condition", XMLPROJECTION = "ELEMENT");

Condition that the related person had.

Property methods: conditionBuildValueArray(), conditionCollectionToDisplay(), conditionCollectionToOdbc(), conditionDisplayToCollection(), conditionGet(), conditionGetObject(), conditionGetObjectId(), conditionGetSwizzled(), conditionIsValid(), conditionOdbcToCollection(), conditionSet(), conditionSetObject(), conditionSetObjectId()
property date as %String (MAXLEN = 1000000, XMLNAME = "date", XMLPROJECTION = "ATTRIBUTE");

When history was captured/updated.

Property methods: dateDisplayToLogical(), dateGet(), dateIsValid(), dateLogicalToDisplay(), dateLogicalToOdbc(), dateNormalize(), dateSet()
property deceasedBoolean as %Boolean (XMLNAME = "deceasedBoolean", XMLPROJECTION = "ATTRIBUTE");

Dead? How old/when?

Property methods: deceasedBooleanDisplayToLogical(), deceasedBooleanGet(), deceasedBooleanIsValid(), deceasedBooleanLogicalToDisplay(), deceasedBooleanLogicalToXSD(), deceasedBooleanNormalize(), deceasedBooleanSet(), deceasedBooleanXSDToLogical()
property deceasedDate as %String (MAXLEN = 1000000, XMLNAME = "deceasedDate", XMLPROJECTION = "ATTRIBUTE");

Dead? How old/when?

Property methods: deceasedDateDisplayToLogical(), deceasedDateGet(), deceasedDateIsValid(), deceasedDateLogicalToDisplay(), deceasedDateLogicalToOdbc(), deceasedDateNormalize(), deceasedDateSet()
property deceasedQuantity as HS.FHIR.DTL.vDSTU2.Model.Datatype.Age (XMLNAME = "deceasedQuantity", XMLPROJECTION = "ELEMENT");

Dead? How old/when?

Property methods: deceasedQuantityGet(), deceasedQuantityGetSwizzled(), deceasedQuantityIsValid(), deceasedQuantityNewObject(), deceasedQuantitySet()
property deceasedRange as HS.FHIR.DTL.vDSTU2.Model.Datatype.Range (XMLNAME = "deceasedRange", XMLPROJECTION = "ELEMENT");

Dead? How old/when?

Property methods: deceasedRangeGet(), deceasedRangeGetSwizzled(), deceasedRangeIsValid(), deceasedRangeNewObject(), deceasedRangeSet()
property deceasedString as %String (MAXLEN = 1000000, XMLNAME = "deceasedString", XMLPROJECTION = "ATTRIBUTE");

Dead? How old/when?

Property methods: deceasedStringDisplayToLogical(), deceasedStringGet(), deceasedStringIsValid(), deceasedStringLogicalToDisplay(), deceasedStringLogicalToOdbc(), deceasedStringNormalize(), deceasedStringSet()
property gender as %String (MAXLEN = 1000000, XMLNAME = "gender", XMLPROJECTION = "ATTRIBUTE");

male | female | other | unknown

administrative-gender is the REQUIRED FHIR2 ValueSet for codes; you may NOT extend administrative-gender and you may NOT use codes from other ValueSets.

Property methods: genderDisplayToLogical(), genderGet(), genderIsValid(), genderLogicalToDisplay(), genderLogicalToOdbc(), genderNormalize(), genderSet()
property identifier as list of HS.FHIR.DTL.vDSTU2.Model.Datatype.Identifier (XMLNAME = "identifier", XMLPROJECTION = "ELEMENT");

External Id(s) for this record.

Property methods: identifierBuildValueArray(), identifierCollectionToDisplay(), identifierCollectionToOdbc(), identifierDisplayToCollection(), identifierGet(), identifierGetObject(), identifierGetObjectId(), identifierGetSwizzled(), identifierIsValid(), identifierOdbcToCollection(), identifierSet(), identifierSetObject(), identifierSetObjectId()
property name as %String (MAXLEN = 1000000, XMLNAME = "name", XMLPROJECTION = "ATTRIBUTE");

The family member described.

Property methods: nameDisplayToLogical(), nameGet(), nameIsValid(), nameLogicalToDisplay(), nameLogicalToOdbc(), nameNormalize(), nameSet()
property note as HS.FHIR.DTL.vDSTU2.Model.Datatype.Annotation (XMLNAME = "note", XMLPROJECTION = "ELEMENT");

General note about related person.

Property methods: noteGet(), noteGetSwizzled(), noteIsValid(), noteNewObject(), noteSet()
property patient as HS.FHIR.DTL.vDSTU2.Model.Base.Reference (XMLNAME = "patient", XMLPROJECTION = "ELEMENT") [ Required ];

Patient history is about.


Property methods: patientGet(), patientGetSwizzled(), patientIsValid(), patientNewObject(), patientSet()
property relationship as HS.FHIR.DTL.vDSTU2.Model.Datatype.CodeableConcept (XMLNAME = "relationship", XMLPROJECTION = "ELEMENT") [ Required ];

Relationship to the subject.

any FHIR2 code may be used; v3-FamilyMember shows EXAMPLE codes, but you may use codes from any ValueSet.

Property methods: relationshipGet(), relationshipGetSwizzled(), relationshipIsValid(), relationshipNewObject(), relationshipSet()
property status as %String (MAXLEN = 1000000, XMLNAME = "status", XMLPROJECTION = "ATTRIBUTE") [ Required ];

partial | completed | entered-in-error | health-unknown

history-status is the REQUIRED FHIR2 ValueSet for codes; you may NOT extend history-status and you may NOT use codes from other ValueSets.

Property methods: statusDisplayToLogical(), statusGet(), statusIsValid(), statusLogicalToDisplay(), statusLogicalToOdbc(), statusNormalize(), statusSet()

Inherited Members

Inherited Properties

Inherited Methods

FeedbackOpens in a new tab