Class FamilyMemberHistory

All Implemented Interfaces:
ca.uhn.fhir.model.api.IElement, Serializable, org.hl7.fhir.instance.model.api.IAnyResource, org.hl7.fhir.instance.model.api.IBase, org.hl7.fhir.instance.model.api.IBaseHasExtensions, org.hl7.fhir.instance.model.api.IBaseHasModifierExtensions, org.hl7.fhir.instance.model.api.IBaseResource, org.hl7.fhir.instance.model.api.IDomainResource

public class FamilyMemberHistory extends DomainResource
Significant health events and conditions for a person related to the patient relevant in the context of care for the patient.
See Also:
Serialized Form
  • Field Details

    • identifier

      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).
    • definition

      A protocol or questionnaire that was adhered to in whole or in part by this event.
    • definitionTarget

      The actual objects that are the target of the reference (A protocol or questionnaire that was adhered to in whole or in part by this event.)
    • status

      A code specifying the status of the record of the family history of a specific family member.
    • notDone

      protected BooleanType notDone
      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.
    • notDoneReason

      Describes why the family member's history is absent.
    • patient

      protected Reference patient
      The person who this history concerns.
    • patientTarget

      The actual object that is the target of the reference (The person who this history concerns.)
    • date

      protected DateTimeType date
      The date (and possibly time) when the family member history was taken.
    • name

      protected StringType name
      This will either be a name or a description; e.g. "Aunt Susan", "my cousin with the red hair".
    • relationship

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

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

      protected Type born
      The actual or approximate date of birth of the relative.
    • age

      protected Type age
      The age of the relative at the time the family member history is recorded.
    • estimatedAge

      If true, indicates that the age value specified is an estimated value.
    • deceased

      protected Type deceased
      Deceased flag or the actual or approximate age of the relative at the time of death for the family member history record.
    • reasonCode

      Describes why the family member history occurred in coded or textual form.
    • reasonReference

      Indicates a Condition, Observation, AllergyIntolerance, or QuestionnaireResponse that justifies this family member history event.
    • reasonReferenceTarget

      The actual objects that are the target of the reference (Indicates a Condition, Observation, AllergyIntolerance, or QuestionnaireResponse that justifies this family member history event.)
    • note

      protected List<Annotation> note
      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.
    • condition

      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.
    • SP_DATE

      public static final String SP_DATE
      Search parameter: date

      Description: When history was captured/updated
      Type: date
      Path: FamilyMemberHistory.date

      See Also:
      Constant Field Values
    • DATE

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

      Description: When history was captured/updated
      Type: date
      Path: FamilyMemberHistory.date

    • SP_IDENTIFIER

      public static final String SP_IDENTIFIER
      Search parameter: 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_CODE

      public static final String SP_CODE
      Search parameter: 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_GENDER

      public static final String SP_GENDER
      Search parameter: 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

    • SP_PATIENT

      public static final String SP_PATIENT
      Search parameter: 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

    • 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".
    • SP_DEFINITION

      public static final String SP_DEFINITION
      Search parameter: definition

      Description: Instantiates protocol or definition
      Type: reference
      Path: FamilyMemberHistory.definition

      See Also:
      Constant Field Values
    • DEFINITION

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

      Description: Instantiates protocol or definition
      Type: reference
      Path: FamilyMemberHistory.definition

    • INCLUDE_DEFINITION

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

      public static final String SP_RELATIONSHIP
      Search parameter: 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_STATUS

      public static final String SP_STATUS
      Search parameter: status

      Description: partial | completed | entered-in-error | health-unknown
      Type: token
      Path: FamilyMemberHistory.status

      See Also:
      Constant Field Values
    • STATUS

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

      Description: partial | completed | entered-in-error | health-unknown
      Type: token
      Path: FamilyMemberHistory.status

  • Constructor Details

  • Method Details