Class FamilyMemberHistory

  • All Implemented Interfaces:
    ca.uhn.fhir.model.api.ICompositeElement, ca.uhn.fhir.model.api.IElement, ca.uhn.fhir.model.api.IResource, ca.uhn.fhir.model.api.ISupportsUndeclaredExtensions, Serializable, org.hl7.fhir.instance.model.api.IBase, org.hl7.fhir.instance.model.api.IBaseResource

    public class FamilyMemberHistory
    extends BaseResource
    implements ca.uhn.fhir.model.api.IResource
    HAPI/FHIR FamilyMemberHistory Resource (clinical.general)

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

    Requirements:

    Profile Definition: http://hl7.org/fhir/profiles/FamilyMemberHistory

    See Also:
    Serialized Form
    • Field Detail

      • DATE

        public static final ca.uhn.fhir.rest.gclient.DateClientParam DATE
        Fluent Client search parameter constant for date

        Description:
        Type: date
        Path: FamilyMemberHistory.date

      • SP_PATIENT

        public static final String SP_PATIENT
        Search parameter constant for patient

        Description: The identity of a subject to list family member history items for
        Type: reference
        Path: FamilyMemberHistory.patient

        See Also:
        Constant Field Values
      • PATIENT

        public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam PATIENT
        Fluent Client search parameter constant for patient

        Description: The identity of a subject to list family member history items for
        Type: reference
        Path: FamilyMemberHistory.patient

      • SP_CODE

        public static final String SP_CODE
        Search parameter constant for code

        Description: A search by a condition code
        Type: token
        Path: FamilyMemberHistory.condition.code

        See Also:
        Constant Field Values
      • CODE

        public static final ca.uhn.fhir.rest.gclient.TokenClientParam CODE
        Fluent Client search parameter constant for code

        Description: A search by a condition code
        Type: token
        Path: FamilyMemberHistory.condition.code

      • SP_IDENTIFIER

        public static final String SP_IDENTIFIER
        Search parameter constant for identifier

        Description: A search by a record identifier
        Type: token
        Path: FamilyMemberHistory.identifier

        See Also:
        Constant Field Values
      • IDENTIFIER

        public static final ca.uhn.fhir.rest.gclient.TokenClientParam IDENTIFIER
        Fluent Client search parameter constant for identifier

        Description: A search by a record identifier
        Type: token
        Path: FamilyMemberHistory.identifier

      • SP_RELATIONSHIP

        public static final String SP_RELATIONSHIP
        Search parameter constant for relationship

        Description: A search by a relationship type
        Type: token
        Path: FamilyMemberHistory.relationship

        See Also:
        Constant Field Values
      • RELATIONSHIP

        public static final ca.uhn.fhir.rest.gclient.TokenClientParam RELATIONSHIP
        Fluent Client search parameter constant for relationship

        Description: A search by a relationship type
        Type: token
        Path: FamilyMemberHistory.relationship

      • SP_GENDER

        public static final String SP_GENDER
        Search parameter constant for gender

        Description: A search by a gender code of a family member
        Type: token
        Path: FamilyMemberHistory.gender

        See Also:
        Constant Field Values
      • GENDER

        public static final ca.uhn.fhir.rest.gclient.TokenClientParam GENDER
        Fluent Client search parameter constant for gender

        Description: A search by a gender code of a family member
        Type: token
        Path: FamilyMemberHistory.gender

      • INCLUDE_PATIENT

        public static final ca.uhn.fhir.model.api.Include INCLUDE_PATIENT
        Constant for fluent queries to be used to add include statements. Specifies the path value of "FamilyMemberHistory:patient".
    • Method Detail

      • isEmpty

        public boolean isEmpty()
        Specified by:
        isEmpty in interface org.hl7.fhir.instance.model.api.IBase
      • getAllPopulatedChildElementsOfType

        public <T extends ca.uhn.fhir.model.api.IElement> List<T> getAllPopulatedChildElementsOfType​(Class<T> theType)
        Specified by:
        getAllPopulatedChildElementsOfType in interface ca.uhn.fhir.model.api.ICompositeElement
      • getIdentifier

        public List<IdentifierDtgetIdentifier()
        Gets the value(s) for identifier (id). creating it if it does not exist. Will not return null.

        Definition: 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)

      • setIdentifier

        public FamilyMemberHistory setIdentifier​(List<IdentifierDt> theValue)
        Sets the value(s) for identifier (id)

        Definition: 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)

      • addIdentifier

        public IdentifierDt addIdentifier()
        Adds and returns a new value for identifier (id)

        Definition: 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)

      • addIdentifier

        public FamilyMemberHistory addIdentifier​(IdentifierDt theValue)
        Adds a given new value for identifier (id)

        Definition: 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)

        Parameters:
        theValue - The identifier to add (must not be null)
      • getIdentifierFirstRep

        public IdentifierDt getIdentifierFirstRep()
        Gets the first repetition for identifier (id), creating it if it does not already exist.

        Definition: 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)

      • getPatient

        public ResourceReferenceDt getPatient()
        Gets the value(s) for patient (who.focus). creating it if it does not exist. Will not return null.

        Definition: The person who this history concerns

      • getDateElement

        public ca.uhn.fhir.model.primitive.DateTimeDt getDateElement()
        Gets the value(s) for date (when.recorded). creating it if it does not exist. Will not return null.

        Definition: The date (and possibly time) when the family member history was taken

      • getDate

        public Date getDate()
        Gets the value(s) for date (when.recorded). creating it if it does not exist. This method may return null.

        Definition: The date (and possibly time) when the family member history was taken

      • setDate

        public FamilyMemberHistory setDate​(ca.uhn.fhir.model.primitive.DateTimeDt theValue)
        Sets the value(s) for date (when.recorded)

        Definition: The date (and possibly time) when the family member history was taken

      • setDate

        public FamilyMemberHistory setDate​(Date theDate,
                                           ca.uhn.fhir.model.api.TemporalPrecisionEnum thePrecision)
        Sets the value for date (when.recorded)

        Definition: The date (and possibly time) when the family member history was taken

      • getStatusElement

        public ca.uhn.fhir.model.primitive.BoundCodeDt<FamilyHistoryStatusEnumgetStatusElement()
        Gets the value(s) for status (status). creating it if it does not exist. Will not return null.

        Definition: A code specifying a state of a Family Member History record.

      • getStatus

        public String getStatus()
        Gets the value(s) for status (status). creating it if it does not exist. This method may return null.

        Definition: A code specifying a state of a Family Member History record.

      • getNameElement

        public ca.uhn.fhir.model.primitive.StringDt getNameElement()
        Gets the value(s) for name (). creating it if it does not exist. Will not return null.

        Definition: This will either be a name or a description; e.g. \"Aunt Susan\", \"my cousin with the red hair\"

      • getName

        public String getName()
        Gets the value(s) for name (). creating it if it does not exist. This method may return null.

        Definition: This will either be a name or a description; e.g. \"Aunt Susan\", \"my cousin with the red hair\"

      • setName

        public FamilyMemberHistory setName​(ca.uhn.fhir.model.primitive.StringDt theValue)
        Sets the value(s) for name ()

        Definition: This will either be a name or a description; e.g. \"Aunt Susan\", \"my cousin with the red hair\"

      • setName

        public FamilyMemberHistory setName​(String theString)
        Sets the value for name ()

        Definition: This will either be a name or a description; e.g. \"Aunt Susan\", \"my cousin with the red hair\"

      • getRelationship

        public CodeableConceptDt getRelationship()
        Gets the value(s) for relationship (). creating it if it does not exist. Will not return null.

        Definition: The type of relationship this person has to the patient (father, mother, brother etc.)

      • getGenderElement

        public ca.uhn.fhir.model.primitive.BoundCodeDt<AdministrativeGenderEnumgetGenderElement()
        Gets the value(s) for gender (). creating it if it does not exist. Will not return null.

        Definition: Administrative Gender - the gender that the relative is considered to have for administration and record keeping purposes.

      • getGender

        public String getGender()
        Gets the value(s) for gender (). creating it if it does not exist. This method may return null.

        Definition: Administrative Gender - the gender that the relative is considered to have for administration and record keeping purposes.

      • setGender

        public FamilyMemberHistory setGender​(ca.uhn.fhir.model.primitive.BoundCodeDt<AdministrativeGenderEnum> theValue)
        Sets the value(s) for gender ()

        Definition: Administrative Gender - the gender that the relative is considered to have for administration and record keeping purposes.

      • getBorn

        public ca.uhn.fhir.model.api.IDatatype getBorn()
        Gets the value(s) for born[x] (). creating it if it does not exist. Will not return null.

        Definition: The actual or approximate date of birth of the relative

      • setBorn

        public FamilyMemberHistory setBorn​(ca.uhn.fhir.model.api.IDatatype theValue)
        Sets the value(s) for born[x] ()

        Definition: The actual or approximate date of birth of the relative

      • getAge

        public ca.uhn.fhir.model.api.IDatatype getAge()
        Gets the value(s) for age[x] (). creating it if it does not exist. Will not return null.

        Definition: The actual or approximate age of the relative at the time the family member history is recorded

      • setAge

        public FamilyMemberHistory setAge​(ca.uhn.fhir.model.api.IDatatype theValue)
        Sets the value(s) for age[x] ()

        Definition: The actual or approximate age of the relative at the time the family member history is recorded

      • getDeceased

        public ca.uhn.fhir.model.api.IDatatype getDeceased()
        Gets the value(s) for deceased[x] (). creating it if it does not exist. Will not return null.

        Definition: Deceased flag or the actual or approximate age of the relative at the time of death for the family member history record

      • setDeceased

        public FamilyMemberHistory setDeceased​(ca.uhn.fhir.model.api.IDatatype theValue)
        Sets the value(s) for deceased[x] ()

        Definition: Deceased flag or the actual or approximate age of the relative at the time of death for the family member history record

      • getNote

        public AnnotationDt getNote()
        Gets the value(s) for note (). creating it if it does not exist. Will not return null.

        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.

      • setNote

        public FamilyMemberHistory setNote​(AnnotationDt theValue)
        Sets the value(s) for note ()

        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.

      • getCondition

        public List<FamilyMemberHistory.ConditiongetCondition()
        Gets the value(s) for condition (). creating it if it does not exist. Will not return null.

        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.

      • setCondition

        public FamilyMemberHistory setCondition​(List<FamilyMemberHistory.Condition> theValue)
        Sets the value(s) for condition ()

        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.

      • addCondition

        public FamilyMemberHistory.Condition addCondition()
        Adds and returns a new value for condition ()

        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.

      • addCondition

        public FamilyMemberHistory addCondition​(FamilyMemberHistory.Condition theValue)
        Adds a given new value for condition ()

        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.

        Parameters:
        theValue - The condition to add (must not be null)
      • getConditionFirstRep

        public FamilyMemberHistory.Condition getConditionFirstRep()
        Gets the first repetition for condition (), creating it if it does not already exist.

        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.

      • getResourceName

        public String getResourceName()
        Specified by:
        getResourceName in interface ca.uhn.fhir.model.api.IResource
      • getStructureFhirVersionEnum

        public ca.uhn.fhir.context.FhirVersionEnum getStructureFhirVersionEnum()
        Specified by:
        getStructureFhirVersionEnum in interface org.hl7.fhir.instance.model.api.IBaseResource
        Specified by:
        getStructureFhirVersionEnum in interface ca.uhn.fhir.model.api.IResource