Skip to main content

HS.FHIR.DTL.vR4.Model.Resource.FamilyMemberHistory

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

Information about patient's relatives, relevant for patient.

Property Inventory

Parameters

parameter ELEMENTQUALIFIED = 1;
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 XMLPROJECTION = ELEMENT;
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.

Properties

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

(approximate) age.

Property methods: ageAgeGet(), ageAgeGetSwizzled(), ageAgeIsValid(), ageAgeNewObject(), ageAgeSet()
property ageRange as HS.FHIR.DTL.vR4.Model.Datatype.Range (XMLNAME = "ageRange", XMLPROJECTION = "ELEMENT");
Range

(approximate) age.

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

(approximate) age.

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

(approximate) date of birth.

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

(approximate) date of birth.

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

(approximate) date of birth.

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

Condition that the related person had.

Property methods: conditionBuildValueArray(), conditionCollectionToDisplay(), conditionCollectionToOdbc(), conditionDisplayToCollection(), conditionGet(), conditionGetObject(), conditionGetObjectId(), conditionGetSwizzled(), conditionIsValid(), conditionOdbcToCollection(), conditionSet(), conditionSetObject(), conditionSetObjectId()
property dataAbsentReason as HS.FHIR.DTL.vR4.Model.Datatype.CodeableConcept (XMLNAME = "dataAbsentReason", XMLPROJECTION = "ELEMENT");
CodeableConcept

subject-unknown | withheld | unable-to-obtain | deferred

any FHIR4 code may be used; history-absent-reason shows EXAMPLE codes, but you may use codes from any ValueSet.

Property methods: dataAbsentReasonGet(), dataAbsentReasonGetSwizzled(), dataAbsentReasonIsValid(), dataAbsentReasonNewObject(), dataAbsentReasonSet()
property date as %String (MAXLEN = 1000000, XMLNAME = "date", XMLPROJECTION = "ATTRIBUTE");
dateTime

When history was recorded or last updated.

Property methods: dateDisplayToLogical(), dateGet(), dateIsValid(), dateLogicalToDisplay(), dateLogicalToOdbc(), dateNormalize(), dateSet()
property deceasedAge as HS.FHIR.DTL.vR4.Model.Datatype.Age (XMLNAME = "deceasedAge", XMLPROJECTION = "ELEMENT");
Age

Dead? How old/when?

Property methods: deceasedAgeGet(), deceasedAgeGetSwizzled(), deceasedAgeIsValid(), deceasedAgeNewObject(), deceasedAgeSet()
property deceasedBoolean as %Boolean (XMLNAME = "deceasedBoolean", XMLPROJECTION = "ATTRIBUTE");
boolean

Dead? How old/when?

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

Dead? How old/when?

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

Dead? How old/when?

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

Dead? How old/when?

Property methods: deceasedStringDisplayToLogical(), deceasedStringGet(), deceasedStringIsValid(), deceasedStringLogicalToDisplay(), deceasedStringLogicalToOdbc(), deceasedStringNormalize(), deceasedStringSet()
property estimatedAge as %Boolean (XMLNAME = "estimatedAge", XMLPROJECTION = "ATTRIBUTE");
boolean

Age is estimated?

Property methods: estimatedAgeDisplayToLogical(), estimatedAgeGet(), estimatedAgeIsValid(), estimatedAgeLogicalToDisplay(), estimatedAgeLogicalToXSD(), estimatedAgeNormalize(), estimatedAgeSet(), estimatedAgeXSDToLogical()
property identifier as list of HS.FHIR.DTL.vR4.Model.Datatype.Identifier (XMLNAME = "identifier", XMLPROJECTION = "ELEMENT");
Identifier

External Id(s) for this record.

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

Instantiates FHIR protocol or definition.

TO DO: Unrecognized value type for the FHIR4 model

Property methods: instantiatesCanonicalBuildValueArray(), instantiatesCanonicalCollectionToDisplay(), instantiatesCanonicalCollectionToOdbc(), instantiatesCanonicalDisplayToCollection(), instantiatesCanonicalDisplayToLogical(), instantiatesCanonicalGet(), instantiatesCanonicalGetObject(), instantiatesCanonicalGetObjectId(), instantiatesCanonicalGetSwizzled(), instantiatesCanonicalIsValid(), instantiatesCanonicalLogicalToDisplay(), instantiatesCanonicalLogicalToOdbc(), instantiatesCanonicalNormalize(), instantiatesCanonicalOdbcToCollection(), instantiatesCanonicalSet(), instantiatesCanonicalSetObject(), instantiatesCanonicalSetObjectId()
property instantiatesUri as list of %String (MAXLEN = 1000000, XMLNAME = "instantiatesUri", XMLPROJECTION = "ELEMENT");
uri

Instantiates external protocol or definition.

Property methods: instantiatesUriBuildValueArray(), instantiatesUriCollectionToDisplay(), instantiatesUriCollectionToOdbc(), instantiatesUriDisplayToCollection(), instantiatesUriDisplayToLogical(), instantiatesUriGet(), instantiatesUriGetObject(), instantiatesUriGetObjectId(), instantiatesUriGetSwizzled(), instantiatesUriIsValid(), instantiatesUriLogicalToDisplay(), instantiatesUriLogicalToOdbc(), instantiatesUriNormalize(), instantiatesUriOdbcToCollection(), instantiatesUriSet(), instantiatesUriSetObject(), instantiatesUriSetObjectId()
property name as %String (MAXLEN = 1000000, XMLNAME = "name", XMLPROJECTION = "ATTRIBUTE");
string

The family member described.

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

General note about related person.

Property methods: noteBuildValueArray(), noteCollectionToDisplay(), noteCollectionToOdbc(), noteDisplayToCollection(), noteGet(), noteGetObject(), noteGetObjectId(), noteGetSwizzled(), noteIsValid(), noteOdbcToCollection(), noteSet(), noteSetObject(), noteSetObjectId()
property patient as HS.FHIR.DTL.vR4.Model.Base.Reference (XMLNAME = "patient", XMLPROJECTION = "ELEMENT") [ Required ];
Reference

Patient history is about.

Patient

Property methods: patientGet(), patientGetSwizzled(), patientIsValid(), patientNewObject(), patientSet()
property reasonCode as list of HS.FHIR.DTL.vR4.Model.Datatype.CodeableConcept (XMLNAME = "reasonCode", XMLPROJECTION = "ELEMENT");
CodeableConcept

Why was family member history performed?

any FHIR4 code may be used; clinical-findings shows EXAMPLE codes, but you may use codes from any ValueSet.

Property methods: reasonCodeBuildValueArray(), reasonCodeCollectionToDisplay(), reasonCodeCollectionToOdbc(), reasonCodeDisplayToCollection(), reasonCodeGet(), reasonCodeGetObject(), reasonCodeGetObjectId(), reasonCodeGetSwizzled(), reasonCodeIsValid(), reasonCodeOdbcToCollection(), reasonCodeSet(), reasonCodeSetObject(), reasonCodeSetObjectId()
property reasonReference as list of HS.FHIR.DTL.vR4.Model.Base.Reference (XMLNAME = "reasonReference", XMLPROJECTION = "ELEMENT");
Reference

Why was family member history performed?

Condition | Observation | AllergyIntolerance | QuestionnaireResponse | DiagnosticReport | DocumentReference

Property methods: reasonReferenceBuildValueArray(), reasonReferenceCollectionToDisplay(), reasonReferenceCollectionToOdbc(), reasonReferenceDisplayToCollection(), reasonReferenceGet(), reasonReferenceGetObject(), reasonReferenceGetObjectId(), reasonReferenceGetSwizzled(), reasonReferenceIsValid(), reasonReferenceOdbcToCollection(), reasonReferenceSet(), reasonReferenceSetObject(), reasonReferenceSetObjectId()
property relationship as HS.FHIR.DTL.vR4.Model.Datatype.CodeableConcept (XMLNAME = "relationship", XMLPROJECTION = "ELEMENT") [ Required ];
CodeableConcept

Relationship to the subject.

any FHIR4 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 sex as HS.FHIR.DTL.vR4.Model.Datatype.CodeableConcept (XMLNAME = "sex", XMLPROJECTION = "ELEMENT");
CodeableConcept

male | female | other | unknown

administrative-gender is the REQUIRED FHIR4 ValueSet for codes, but if you need to express meanings not found in administrative-gender, you may formally EXTEND administrative-gender to add codes to it.

Property methods: sexGet(), sexGetSwizzled(), sexIsValid(), sexNewObject(), sexSet()
property status as %String (MAXLEN = 1000000, XMLNAME = "status", XMLPROJECTION = "ATTRIBUTE") [ Required ];
code

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

history-status|4.0.1 is the REQUIRED FHIR4 ValueSet for codes; you may NOT extend history-status|4.0.1 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