Skip to main content

HS.FHIRModel.R4.FamilyMemberHistory

class HS.FHIRModel.R4.FamilyMemberHistory extends HS.FHIRModel.FHIRClassSuper

*****************************************
** FamilyMemberHistory generated class schema
*****************************************
Significant health conditions for a person related to the patient relevant in the context of care for the patient.

Property Inventory

Method Inventory

Parameters

parameter XMLTYPE = R4_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 _ageString as HS.FHIRModel.R4.Element;
Extensions for ageString
Property methods: _ageStringGet(), _ageStringGetSwizzled(), _ageStringIsValid(), _ageStringNewObject(), _ageStringSet()
property _bornDate as HS.FHIRModel.R4.Element;
Extensions for bornDate
Property methods: _bornDateGet(), _bornDateGetSwizzled(), _bornDateIsValid(), _bornDateNewObject(), _bornDateSet()
property _bornString as HS.FHIRModel.R4.Element;
Extensions for bornString
Property methods: _bornStringGet(), _bornStringGetSwizzled(), _bornStringIsValid(), _bornStringNewObject(), _bornStringSet()
property _date as HS.FHIRModel.R4.Element;
Extensions for date
Property methods: _dateGet(), _dateGetSwizzled(), _dateIsValid(), _dateNewObject(), _dateSet()
property _deceasedBoolean as HS.FHIRModel.R4.Element;
Extensions for deceasedBoolean
Property methods: _deceasedBooleanGet(), _deceasedBooleanGetSwizzled(), _deceasedBooleanIsValid(), _deceasedBooleanNewObject(), _deceasedBooleanSet()
property _deceasedDate as HS.FHIRModel.R4.Element;
Extensions for deceasedDate
Property methods: _deceasedDateGet(), _deceasedDateGetSwizzled(), _deceasedDateIsValid(), _deceasedDateNewObject(), _deceasedDateSet()
property _deceasedString as HS.FHIRModel.R4.Element;
Extensions for deceasedString
Property methods: _deceasedStringGet(), _deceasedStringGetSwizzled(), _deceasedStringIsValid(), _deceasedStringNewObject(), _deceasedStringSet()
property _estimatedAge as HS.FHIRModel.R4.Element;
Extensions for estimatedAge
Property methods: _estimatedAgeGet(), _estimatedAgeGetSwizzled(), _estimatedAgeIsValid(), _estimatedAgeNewObject(), _estimatedAgeSet()
property _implicitRules as HS.FHIRModel.R4.Element;
Extensions for implicitRules
Property methods: _implicitRulesGet(), _implicitRulesGetSwizzled(), _implicitRulesIsValid(), _implicitRulesNewObject(), _implicitRulesSet()
property _instantiatesUri as HS.FHIRModel.R4.SeqOfElement;
Extensions for instantiatesUri
Property methods: _instantiatesUriGet(), _instantiatesUriGetSwizzled(), _instantiatesUriIsValid(), _instantiatesUriNewObject(), _instantiatesUriSet()
property _language as HS.FHIRModel.R4.Element;
Extensions for language
Property methods: _languageGet(), _languageGetSwizzled(), _languageIsValid(), _languageNewObject(), _languageSet()
property _name as HS.FHIRModel.R4.Element;
Extensions for name
Property methods: _nameGet(), _nameGetSwizzled(), _nameIsValid(), _nameNewObject(), _nameSet()
property _status as HS.FHIRModel.R4.Element;
Extensions for status
Property methods: _statusGet(), _statusGetSwizzled(), _statusIsValid(), _statusNewObject(), _statusSet()
property ageAge as HS.FHIRModel.R4.Age;
The age of the relative at the time the family member history is recorded.
Property methods: ageAgeGet(), ageAgeGetSwizzled(), ageAgeIsValid(), ageAgeNewObject(), ageAgeSet()
property ageRange as HS.FHIRModel.R4.Range;
The age of the relative at the time the family member history is recorded.
Property methods: ageRangeGet(), ageRangeGetSwizzled(), ageRangeIsValid(), ageRangeNewObject(), ageRangeSet()
property ageString as %String;
The age of the relative at the time the family member history is recorded.
Property methods: ageStringDisplayToLogical(), ageStringGet(), ageStringIsValid(), ageStringLogicalToDisplay(), ageStringLogicalToOdbc(), ageStringNormalize(), ageStringSet()
property bornDate as %String;
The actual or approximate date of birth of the relative.
Property methods: bornDateDisplayToLogical(), bornDateGet(), bornDateIsValid(), bornDateLogicalToDisplay(), bornDateLogicalToOdbc(), bornDateNormalize(), bornDateSet()
property bornPeriod as HS.FHIRModel.R4.Period;
The actual or approximate date of birth of the relative.
Property methods: bornPeriodGet(), bornPeriodGetSwizzled(), bornPeriodIsValid(), bornPeriodNewObject(), bornPeriodSet()
property bornString as %String;
The actual or approximate date of birth of the relative.
Property methods: bornStringDisplayToLogical(), bornStringGet(), bornStringIsValid(), bornStringLogicalToDisplay(), bornStringLogicalToOdbc(), bornStringNormalize(), bornStringSet()
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: conditionGet(), conditionGetSwizzled(), conditionIsValid(), conditionNewObject(), conditionSet()
property contained as HS.FHIRModel.R4.SeqOfResourceList;
These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
Property methods: containedGet(), containedGetSwizzled(), containedIsValid(), containedNewObject(), containedSet()
property dataAbsentReason as HS.FHIRModel.R4.CodeableConcept;
Describes why the family member's history is not available.
Property methods: dataAbsentReasonGet(), dataAbsentReasonGetSwizzled(), dataAbsentReasonIsValid(), dataAbsentReasonNewObject(), dataAbsentReasonSet()
property date as %String;
The date (and possibly time) when the family member history was recorded or last updated.
Property methods: dateDisplayToLogical(), dateGet(), dateIsValid(), dateLogicalToDisplay(), dateLogicalToOdbc(), dateNormalize(), dateSet()
property deceasedAge as HS.FHIRModel.R4.Age;
Deceased flag or the actual or approximate age of the relative at the time of death for the family member history record.
Property methods: deceasedAgeGet(), deceasedAgeGetSwizzled(), deceasedAgeIsValid(), deceasedAgeNewObject(), deceasedAgeSet()
property deceasedBoolean as %Boolean;
Deceased flag or the actual or approximate age of the relative at the time of death for the family member history record.
Property methods: deceasedBooleanDisplayToLogical(), deceasedBooleanGet(), deceasedBooleanIsValid(), deceasedBooleanLogicalToDisplay(), deceasedBooleanLogicalToXSD(), deceasedBooleanNormalize(), deceasedBooleanSet(), deceasedBooleanXSDToLogical()
property deceasedDate as %String;
Deceased flag or the actual or approximate age of the relative at the time of death for the family member history record.
Property methods: deceasedDateDisplayToLogical(), deceasedDateGet(), deceasedDateIsValid(), deceasedDateLogicalToDisplay(), deceasedDateLogicalToOdbc(), deceasedDateNormalize(), deceasedDateSet()
property deceasedRange as HS.FHIRModel.R4.Range;
Deceased flag or the actual or approximate age of the relative at the time of death for the family member history record.
Property methods: deceasedRangeGet(), deceasedRangeGetSwizzled(), deceasedRangeIsValid(), deceasedRangeNewObject(), deceasedRangeSet()
property deceasedString as %String;
Deceased flag or the actual or approximate age of the relative at the time of death for the family member history record.
Property methods: deceasedStringDisplayToLogical(), deceasedStringGet(), deceasedStringIsValid(), deceasedStringLogicalToDisplay(), deceasedStringLogicalToOdbc(), deceasedStringNormalize(), deceasedStringSet()
property estimatedAge as %Boolean;
If true, indicates that the age value specified is an estimated value.
Property methods: estimatedAgeDisplayToLogical(), estimatedAgeGet(), estimatedAgeIsValid(), estimatedAgeLogicalToDisplay(), estimatedAgeLogicalToXSD(), estimatedAgeNormalize(), estimatedAgeSet(), estimatedAgeXSDToLogical()
property extension as HS.FHIRModel.R4.SeqOfExtension;
May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Property methods: extensionGet(), extensionGetSwizzled(), extensionIsValid(), extensionNewObject(), extensionSet()
property fhirID as %String;
The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
Property methods: fhirIDDisplayToLogical(), fhirIDGet(), fhirIDIsValid(), fhirIDLogicalToDisplay(), fhirIDLogicalToOdbc(), fhirIDNormalize(), fhirIDSet()
property identifier as HS.FHIRModel.R4.SeqOfIdentifier;
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.
Property methods: identifierGet(), identifierGetSwizzled(), identifierIsValid(), identifierNewObject(), identifierSet()
property implicitRules as %String;
A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
Property methods: implicitRulesDisplayToLogical(), implicitRulesGet(), implicitRulesIsValid(), implicitRulesLogicalToDisplay(), implicitRulesLogicalToOdbc(), implicitRulesNormalize(), implicitRulesSet()
property instantiatesCanonical as HS.FHIRModel.R4.SeqOfString;
The URL pointing to a FHIR-defined protocol, guideline, orderset or other definition that is adhered to in whole or in part by this FamilyMemberHistory.
Property methods: instantiatesCanonicalGet(), instantiatesCanonicalGetSwizzled(), instantiatesCanonicalIsValid(), instantiatesCanonicalNewObject(), instantiatesCanonicalSet()
property instantiatesUri as HS.FHIRModel.R4.SeqOfString;
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.
Property methods: instantiatesUriGet(), instantiatesUriGetSwizzled(), instantiatesUriIsValid(), instantiatesUriNewObject(), instantiatesUriSet()
property language as %String;
The base language in which the resource is written.
Property methods: languageDisplayToLogical(), languageGet(), languageIsValid(), languageLogicalToDisplay(), languageLogicalToOdbc(), languageNormalize(), languageSet()
property meta as HS.FHIRModel.R4.Meta;
The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
Property methods: metaGet(), metaGetSwizzled(), metaIsValid(), metaNewObject(), metaSet()
property modifierExtension as HS.FHIRModel.R4.SeqOfExtension;
May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Property methods: modifierExtensionGet(), modifierExtensionGetSwizzled(), modifierExtensionIsValid(), modifierExtensionNewObject(), modifierExtensionSet()
property name as %String;
This will either be a name or a description; e.g. "Aunt Susan", "my cousin with the red hair".
Property methods: nameDisplayToLogical(), nameGet(), nameIsValid(), nameLogicalToDisplay(), nameLogicalToOdbc(), nameNormalize(), nameSet()
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: noteGet(), noteGetSwizzled(), noteIsValid(), noteNewObject(), noteSet()
property patient as HS.FHIRModel.R4.Reference [ Required ];
The person who this history concerns.
Property methods: patientGet(), patientGetSwizzled(), patientIsValid(), patientNewObject(), patientSet()
property reasonCode as HS.FHIRModel.R4.SeqOfCodeableConcept;
Describes why the family member history occurred in coded or textual form.
Property methods: reasonCodeGet(), reasonCodeGetSwizzled(), reasonCodeIsValid(), reasonCodeNewObject(), reasonCodeSet()
property reasonReference as HS.FHIRModel.R4.SeqOfReference;
Indicates a Condition, Observation, AllergyIntolerance, or QuestionnaireResponse that justifies this family member history event.
Property methods: reasonReferenceGet(), reasonReferenceGetSwizzled(), reasonReferenceIsValid(), reasonReferenceNewObject(), reasonReferenceSet()
property relationship as HS.FHIRModel.R4.CodeableConcept [ Required ];
The type of relationship this person has to the patient (father, mother, brother etc.).
Property methods: relationshipGet(), relationshipGetSwizzled(), relationshipIsValid(), relationshipNewObject(), relationshipSet()
property resourceType as %String [ InitialExpression = "FamilyMemberHistory" , Required ];
This is a FamilyMemberHistory resource
Property methods: resourceTypeDisplayToLogical(), resourceTypeGet(), resourceTypeIsValid(), resourceTypeLogicalToDisplay(), resourceTypeLogicalToOdbc(), resourceTypeNormalize(), resourceTypeSet()
The birth sex of the family member.
Property methods: sexGet(), sexGetSwizzled(), sexIsValid(), sexNewObject(), sexSet()
property status as %String (VALUELIST = ",partial,completed,entered-in-error,health-unknown");
A code specifying the status of the record of the family history of a specific family member.
Property methods: statusDisplayToLogical(), statusGet(), statusIsValid(), statusLogicalToDisplay(), statusLogicalToOdbc(), statusNormalize(), statusSet()
property text as HS.FHIRModel.R4.Narrative;
A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
Property methods: textGet(), textGetSwizzled(), textIsValid(), textNewObject(), textSet()

Methods

method IncludeAgeAge()
method IncludeAgeRange()
method IncludeBornPeriod()
method IncludeCondition()
method IncludeContained()
method IncludeDataAbsentReason()
method IncludeDeceasedAge()
method IncludeDeceasedRange()
method IncludeExtension()
method IncludeIdentifier()
method IncludeInstantiatesCanonical()
method IncludeInstantiatesUri()
method IncludeMeta()
method IncludeModifierExtension()
method IncludeNote()
method IncludePatient()
method IncludeReasonCode()
method IncludeReasonReference()
method IncludeRelationship()
method IncludeSex()
method IncludeText()
method _getProperties() as %DynamicArray
Inherited description: Return an array of the defined properties of this class in the definition order that they were discovered in the the HL7FHIR JSchema document
method toDao() as %DynamicAbstractObject
Inherited description: >

The toDao() method casts the set to a DAO.

Inherited Members

Inherited Methods

FeedbackOpens in a new tab