Skip to main content

HS.FHIR.vSTU3.Model.Resource.FamilyMemberHistory

deprecated class HS.FHIR.vSTU3.Model.Resource.FamilyMemberHistory extends HS.FHIR.vSTU3.Model.Base.DomainResource

THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Significant health events and conditions for a person related to the patient relevant in the context of care for the patient.
If the element is present, it must have either a @value, an @id, or extensions

Property Inventory

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

Properties

property ageAge as HS.FHIR.vSTU3.Model.Base.Age (XMLNAME = "ageAge", XMLPROJECTION = "ELEMENT");
Property methods: ageAgeGet(), ageAgeGetSwizzled(), ageAgeIsValid(), ageAgeNewObject(), ageAgeSet()
property ageRange as HS.FHIR.vSTU3.Model.Base.Range (XMLNAME = "ageRange", XMLPROJECTION = "ELEMENT");
Property methods: ageRangeGet(), ageRangeGetSwizzled(), ageRangeIsValid(), ageRangeNewObject(), ageRangeSet()
property ageString as HS.FHIR.vSTU3.Model.Datatype.String (XMLNAME = "ageString", XMLPROJECTION = "ELEMENT");
Property methods: ageStringGet(), ageStringGetSwizzled(), ageStringIsValid(), ageStringNewObject(), ageStringSet()
property bornDate as HS.FHIR.vSTU3.Model.Datatype.Date (XMLNAME = "bornDate", XMLPROJECTION = "ELEMENT");
Property methods: bornDateGet(), bornDateGetSwizzled(), bornDateIsValid(), bornDateNewObject(), bornDateSet()
property bornPeriod as HS.FHIR.vSTU3.Model.Base.Period (XMLNAME = "bornPeriod", XMLPROJECTION = "ELEMENT");
Property methods: bornPeriodGet(), bornPeriodGetSwizzled(), bornPeriodIsValid(), bornPeriodNewObject(), bornPeriodSet()
property bornString as HS.FHIR.vSTU3.Model.Datatype.String (XMLNAME = "bornString", XMLPROJECTION = "ELEMENT");
Property methods: bornStringGet(), bornStringGetSwizzled(), bornStringIsValid(), bornStringNewObject(), bornStringSet()
property condition as list of HS.FHIR.vSTU3.Model.Resource.FamilyMemberHistory.Condition (XMLNAME = "condition", XMLPROJECTION = "ELEMENT");
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.
Property methods: conditionBuildValueArray(), conditionCollectionToDisplay(), conditionCollectionToOdbc(), conditionDisplayToCollection(), conditionGet(), conditionGetObject(), conditionGetObjectId(), conditionGetSwizzled(), conditionIsValid(), conditionOdbcToCollection(), conditionSet(), conditionSetObject(), conditionSetObjectId()
property date as HS.FHIR.vSTU3.Model.Datatype.DateTime (XMLNAME = "date", XMLPROJECTION = "ELEMENT");
The date (and possibly time) when the family member history was taken.
Property methods: dateGet(), dateGetSwizzled(), dateIsValid(), dateNewObject(), dateSet()
property deceasedAge as HS.FHIR.vSTU3.Model.Base.Age (XMLNAME = "deceasedAge", XMLPROJECTION = "ELEMENT");
Property methods: deceasedAgeGet(), deceasedAgeGetSwizzled(), deceasedAgeIsValid(), deceasedAgeNewObject(), deceasedAgeSet()
property deceasedBoolean as HS.FHIR.vSTU3.Model.Datatype.Boolean (XMLNAME = "deceasedBoolean", XMLPROJECTION = "ELEMENT");
Property methods: deceasedBooleanGet(), deceasedBooleanGetSwizzled(), deceasedBooleanIsValid(), deceasedBooleanNewObject(), deceasedBooleanSet()
property deceasedDate as HS.FHIR.vSTU3.Model.Datatype.Date (XMLNAME = "deceasedDate", XMLPROJECTION = "ELEMENT");
Property methods: deceasedDateGet(), deceasedDateGetSwizzled(), deceasedDateIsValid(), deceasedDateNewObject(), deceasedDateSet()
property deceasedRange as HS.FHIR.vSTU3.Model.Base.Range (XMLNAME = "deceasedRange", XMLPROJECTION = "ELEMENT");
Property methods: deceasedRangeGet(), deceasedRangeGetSwizzled(), deceasedRangeIsValid(), deceasedRangeNewObject(), deceasedRangeSet()
property deceasedString as HS.FHIR.vSTU3.Model.Datatype.String (XMLNAME = "deceasedString", XMLPROJECTION = "ELEMENT");
Property methods: deceasedStringGet(), deceasedStringGetSwizzled(), deceasedStringIsValid(), deceasedStringNewObject(), deceasedStringSet()
property definition as list of HS.FHIR.vSTU3.Model.Base.Reference (XMLNAME = "definition", XMLPROJECTION = "ELEMENT");
A protocol or questionnaire that was adhered to in whole or in part by this event.
Property methods: definitionBuildValueArray(), definitionCollectionToDisplay(), definitionCollectionToOdbc(), definitionDisplayToCollection(), definitionGet(), definitionGetObject(), definitionGetObjectId(), definitionGetSwizzled(), definitionIsValid(), definitionOdbcToCollection(), definitionSet(), definitionSetObject(), definitionSetObjectId()
property estimatedAge as HS.FHIR.vSTU3.Model.Datatype.Boolean (XMLNAME = "estimatedAge", XMLPROJECTION = "ELEMENT");
If true, indicates that the age value specified is an estimated value.
Property methods: estimatedAgeGet(), estimatedAgeGetSwizzled(), estimatedAgeIsValid(), estimatedAgeNewObject(), estimatedAgeSet()
property gender as HS.FHIR.vSTU3.Model.Base.AdministrativeGender (XMLNAME = "gender", XMLPROJECTION = "ELEMENT");
Administrative Gender - the gender that the relative is considered to have for administration and record keeping purposes.
Property methods: genderGet(), genderGetSwizzled(), genderIsValid(), genderNewObject(), genderSet()
property identifier as list of HS.FHIR.vSTU3.Model.Base.Identifier (XMLNAME = "identifier", XMLPROJECTION = "ELEMENT");
This records identifiers associated with this family member history record that are defined by business processes and/ or used to refer to it when a direct URL reference to the resource itself is not appropriate (e.g. in CDA documents, or in written / printed documentation).
Property methods: identifierBuildValueArray(), identifierCollectionToDisplay(), identifierCollectionToOdbc(), identifierDisplayToCollection(), identifierGet(), identifierGetObject(), identifierGetObjectId(), identifierGetSwizzled(), identifierIsValid(), identifierOdbcToCollection(), identifierSet(), identifierSetObject(), identifierSetObjectId()
property name as HS.FHIR.vSTU3.Model.Datatype.String (XMLNAME = "name", XMLPROJECTION = "ELEMENT");
This will either be a name or a description; e.g. "Aunt Susan", "my cousin with the red hair".
Property methods: nameGet(), nameGetSwizzled(), nameIsValid(), nameNewObject(), nameSet()
property notDone as HS.FHIR.vSTU3.Model.Datatype.Boolean (XMLNAME = "notDone", XMLPROJECTION = "ELEMENT");
If true, indicates the taking of an individual family member's history did not occur. The notDone element should not be used to document negated conditions, such as a family member that did not have a condition.
Property methods: notDoneGet(), notDoneGetSwizzled(), notDoneIsValid(), notDoneNewObject(), notDoneReasonGet(), notDoneReasonGetSwizzled(), notDoneReasonIsValid(), notDoneReasonNewObject(), notDoneReasonSet(), notDoneSet()
property notDoneReason as HS.FHIR.vSTU3.Model.Base.CodeableConcept (XMLNAME = "notDoneReason", XMLPROJECTION = "ELEMENT");
Describes why the family member's history is absent.
Property methods: notDoneReasonGet(), notDoneReasonGetSwizzled(), notDoneReasonIsValid(), notDoneReasonNewObject(), notDoneReasonSet()
property note as list of HS.FHIR.vSTU3.Model.Base.Annotation (XMLNAME = "note", XMLPROJECTION = "ELEMENT");
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.
Property methods: noteBuildValueArray(), noteCollectionToDisplay(), noteCollectionToOdbc(), noteDisplayToCollection(), noteGet(), noteGetObject(), noteGetObjectId(), noteGetSwizzled(), noteIsValid(), noteOdbcToCollection(), noteSet(), noteSetObject(), noteSetObjectId()
property patient as HS.FHIR.vSTU3.Model.Base.Reference (XMLNAME = "patient", XMLPROJECTION = "ELEMENT") [ Required ];
The person who this history concerns.
Property methods: patientGet(), patientGetSwizzled(), patientIsValid(), patientNewObject(), patientSet()
property reasonCode as list of HS.FHIR.vSTU3.Model.Base.CodeableConcept (XMLNAME = "reasonCode", XMLPROJECTION = "ELEMENT");
Describes why the family member history occurred in coded or textual form.
Property methods: reasonCodeBuildValueArray(), reasonCodeCollectionToDisplay(), reasonCodeCollectionToOdbc(), reasonCodeDisplayToCollection(), reasonCodeGet(), reasonCodeGetObject(), reasonCodeGetObjectId(), reasonCodeGetSwizzled(), reasonCodeIsValid(), reasonCodeOdbcToCollection(), reasonCodeSet(), reasonCodeSetObject(), reasonCodeSetObjectId()
property reasonReference as list of HS.FHIR.vSTU3.Model.Base.Reference (XMLNAME = "reasonReference", XMLPROJECTION = "ELEMENT");
Indicates a Condition, Observation, AllergyIntolerance, or QuestionnaireResponse that justifies this family member history event.
Property methods: reasonReferenceBuildValueArray(), reasonReferenceCollectionToDisplay(), reasonReferenceCollectionToOdbc(), reasonReferenceDisplayToCollection(), reasonReferenceGet(), reasonReferenceGetObject(), reasonReferenceGetObjectId(), reasonReferenceGetSwizzled(), reasonReferenceIsValid(), reasonReferenceOdbcToCollection(), reasonReferenceSet(), reasonReferenceSetObject(), reasonReferenceSetObjectId()
property relationship as HS.FHIR.vSTU3.Model.Base.CodeableConcept (XMLNAME = "relationship", XMLPROJECTION = "ELEMENT") [ Required ];
The type of relationship this person has to the patient (father, mother, brother etc.).
Property methods: relationshipGet(), relationshipGetSwizzled(), relationshipIsValid(), relationshipNewObject(), relationshipSet()
property status as HS.FHIR.vSTU3.Model.Base.FamilyHistoryStatus (XMLNAME = "status", XMLPROJECTION = "ELEMENT") [ Required ];
A code specifying the status of the record of the family history of a specific family member.
Property methods: statusGet(), statusGetSwizzled(), statusIsValid(), statusNewObject(), statusSet()

Methods

deprecated method SetAgeString(pValue As %String = "", pExtension As %RegisteredObject = "", pId As %String = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "ageString" property.
deprecated method SetBornDate(pValue As %String = "", pExtension As %RegisteredObject = "", pId As %String = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "bornDate" property.
deprecated method SetBornPeriod(pStart As %String = "", pEnd As %String = "", pExtension As %RegisteredObject = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "bornPeriod" property.
deprecated method SetBornString(pValue As %String = "", pExtension As %RegisteredObject = "", pId As %String = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "bornString" property.
deprecated method SetDate(pValue As %String = "", pExtension As %RegisteredObject = "", pId As %String = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "date" property.
deprecated method SetDeceasedBoolean(pValue As %String = "", pExtension As %RegisteredObject = "", pId As %String = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "deceasedBoolean" property.
deprecated method SetDeceasedDate(pValue As %String = "", pExtension As %RegisteredObject = "", pId As %String = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "deceasedDate" property.
deprecated method SetDeceasedString(pValue As %String = "", pExtension As %RegisteredObject = "", pId As %String = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "deceasedString" property.
deprecated method SetDefinition(pReference As %String = "", pDisplay As %String = "", pExtension As %RegisteredObject = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Insert method for the "definition" property.
deprecated method SetEstimatedAge(pValue As %String = "", pExtension As %RegisteredObject = "", pId As %String = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "estimatedAge" property.
deprecated method SetGender(pValue As %String = "", pExtension As %RegisteredObject = "", pId As %String = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "gender" property.
deprecated method SetIdentifier(pValue As %String = "", pSystem As %String = "", pUse As %String = "", pTypeCode As %String = "", pTypeSystem As %String = "", pTypeDisplay As %String = "", pTypeText As %String = "", pId As %String = "", pStart As %String = "", pEnd As %String = "", pAssignerReference As %String = "", pAssignerDisplay As %String = "", pExtension As %RegisteredObject = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Insert method for the "identifier" property.
deprecated method SetName(pValue As %String = "", pExtension As %RegisteredObject = "", pId As %String = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "name" property.
deprecated method SetNotDone(pValue As %String = "", pExtension As %RegisteredObject = "", pId As %String = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "notDone" property.
deprecated method SetNotDoneReason(pCode As %String = "", pDisplay As %String = "", pSystem As %String = "", pText As %String = "", pVersion As %String = "", pUserSelected As %String = "", pId As %String = "", pExtension As %RegisteredObject = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "notDoneReason" property.
deprecated method SetPatient(pReference As %String = "", pDisplay As %String = "", pExtension As %RegisteredObject = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "patient" property.
deprecated method SetReasonCode(pCode As %String = "", pDisplay As %String = "", pSystem As %String = "", pText As %String = "", pVersion As %String = "", pUserSelected As %String = "", pId As %String = "", pExtension As %RegisteredObject = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Insert method for the "reasonCode" property.
deprecated method SetReasonReference(pReference As %String = "", pDisplay As %String = "", pExtension As %RegisteredObject = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Insert method for the "reasonReference" property.
deprecated method SetRelationship(pCode As %String = "", pDisplay As %String = "", pSystem As %String = "", pText As %String = "", pVersion As %String = "", pUserSelected As %String = "", pId As %String = "", pExtension As %RegisteredObject = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "relationship" property.
deprecated method SetStatus(pValue As %String = "", pExtension As %RegisteredObject = "", pId As %String = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "status" property.

Inherited Members

Inherited Properties

Inherited Methods

FeedbackOpens in a new tab