blob: 9c3689340e0f28f1eeff9640c27fc01ac85d4ab5 [file] [log] [blame]
/**
*/
package org.hl7.fhir;
import org.eclipse.emf.common.util.EList;
/**
* <!-- begin-user-doc -->
* A representation of the model object '<em><b>Family Member History</b></em>'.
* <!-- end-user-doc -->
*
* <!-- begin-model-doc -->
* 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
* <!-- end-model-doc -->
*
* <p>
* The following features are supported:
* </p>
* <ul>
* <li>{@link org.hl7.fhir.FamilyMemberHistory#getIdentifier <em>Identifier</em>}</li>
* <li>{@link org.hl7.fhir.FamilyMemberHistory#getPatient <em>Patient</em>}</li>
* <li>{@link org.hl7.fhir.FamilyMemberHistory#getDate <em>Date</em>}</li>
* <li>{@link org.hl7.fhir.FamilyMemberHistory#getStatus <em>Status</em>}</li>
* <li>{@link org.hl7.fhir.FamilyMemberHistory#getName <em>Name</em>}</li>
* <li>{@link org.hl7.fhir.FamilyMemberHistory#getRelationship <em>Relationship</em>}</li>
* <li>{@link org.hl7.fhir.FamilyMemberHistory#getGender <em>Gender</em>}</li>
* <li>{@link org.hl7.fhir.FamilyMemberHistory#getBornPeriod <em>Born Period</em>}</li>
* <li>{@link org.hl7.fhir.FamilyMemberHistory#getBornDate <em>Born Date</em>}</li>
* <li>{@link org.hl7.fhir.FamilyMemberHistory#getBornString <em>Born String</em>}</li>
* <li>{@link org.hl7.fhir.FamilyMemberHistory#getAgeQuantity <em>Age Quantity</em>}</li>
* <li>{@link org.hl7.fhir.FamilyMemberHistory#getAgeRange <em>Age Range</em>}</li>
* <li>{@link org.hl7.fhir.FamilyMemberHistory#getAgeString <em>Age String</em>}</li>
* <li>{@link org.hl7.fhir.FamilyMemberHistory#getDeceasedBoolean <em>Deceased Boolean</em>}</li>
* <li>{@link org.hl7.fhir.FamilyMemberHistory#getDeceasedQuantity <em>Deceased Quantity</em>}</li>
* <li>{@link org.hl7.fhir.FamilyMemberHistory#getDeceasedRange <em>Deceased Range</em>}</li>
* <li>{@link org.hl7.fhir.FamilyMemberHistory#getDeceasedDate <em>Deceased Date</em>}</li>
* <li>{@link org.hl7.fhir.FamilyMemberHistory#getDeceasedString <em>Deceased String</em>}</li>
* <li>{@link org.hl7.fhir.FamilyMemberHistory#getNote <em>Note</em>}</li>
* <li>{@link org.hl7.fhir.FamilyMemberHistory#getCondition <em>Condition</em>}</li>
* </ul>
*
* @see org.hl7.fhir.FhirPackage#getFamilyMemberHistory()
* @model extendedMetaData="name='FamilyMemberHistory' kind='elementOnly'"
* @generated
*/
public interface FamilyMemberHistory extends DomainResource {
/**
* Returns the value of the '<em><b>Identifier</b></em>' containment reference list.
* The list contents are of type {@link org.hl7.fhir.Identifier}.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* <!-- begin-model-doc -->
* 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).
* <!-- end-model-doc -->
* @return the value of the '<em>Identifier</em>' containment reference list.
* @see org.hl7.fhir.FhirPackage#getFamilyMemberHistory_Identifier()
* @model containment="true"
* extendedMetaData="kind='element' name='identifier' namespace='##targetNamespace'"
* @generated
*/
EList<Identifier> getIdentifier();
/**
* Returns the value of the '<em><b>Patient</b></em>' containment reference.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* <!-- begin-model-doc -->
* The person who this history concerns.
* <!-- end-model-doc -->
* @return the value of the '<em>Patient</em>' containment reference.
* @see #setPatient(Reference)
* @see org.hl7.fhir.FhirPackage#getFamilyMemberHistory_Patient()
* @model containment="true" required="true"
* extendedMetaData="kind='element' name='patient' namespace='##targetNamespace'"
* @generated
*/
Reference getPatient();
/**
* Sets the value of the '{@link org.hl7.fhir.FamilyMemberHistory#getPatient <em>Patient</em>}' containment reference.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* @param value the new value of the '<em>Patient</em>' containment reference.
* @see #getPatient()
* @generated
*/
void setPatient(Reference value);
/**
* Returns the value of the '<em><b>Date</b></em>' containment reference.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* <!-- begin-model-doc -->
* The date (and possibly time) when the family member history was taken.
* <!-- end-model-doc -->
* @return the value of the '<em>Date</em>' containment reference.
* @see #setDate(DateTime)
* @see org.hl7.fhir.FhirPackage#getFamilyMemberHistory_Date()
* @model containment="true"
* extendedMetaData="kind='element' name='date' namespace='##targetNamespace'"
* @generated
*/
DateTime getDate();
/**
* Sets the value of the '{@link org.hl7.fhir.FamilyMemberHistory#getDate <em>Date</em>}' containment reference.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* @param value the new value of the '<em>Date</em>' containment reference.
* @see #getDate()
* @generated
*/
void setDate(DateTime value);
/**
* Returns the value of the '<em><b>Status</b></em>' containment reference.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* <!-- begin-model-doc -->
* A code specifying a state of a Family Member History record.
* <!-- end-model-doc -->
* @return the value of the '<em>Status</em>' containment reference.
* @see #setStatus(FamilyHistoryStatus)
* @see org.hl7.fhir.FhirPackage#getFamilyMemberHistory_Status()
* @model containment="true" required="true"
* extendedMetaData="kind='element' name='status' namespace='##targetNamespace'"
* @generated
*/
FamilyHistoryStatus getStatus();
/**
* Sets the value of the '{@link org.hl7.fhir.FamilyMemberHistory#getStatus <em>Status</em>}' containment reference.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* @param value the new value of the '<em>Status</em>' containment reference.
* @see #getStatus()
* @generated
*/
void setStatus(FamilyHistoryStatus value);
/**
* Returns the value of the '<em><b>Name</b></em>' containment reference.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* <!-- begin-model-doc -->
* This will either be a name or a description; e.g. "Aunt Susan", "my cousin with the red hair".
* <!-- end-model-doc -->
* @return the value of the '<em>Name</em>' containment reference.
* @see #setName(org.hl7.fhir.String)
* @see org.hl7.fhir.FhirPackage#getFamilyMemberHistory_Name()
* @model containment="true"
* extendedMetaData="kind='element' name='name' namespace='##targetNamespace'"
* @generated
*/
org.hl7.fhir.String getName();
/**
* Sets the value of the '{@link org.hl7.fhir.FamilyMemberHistory#getName <em>Name</em>}' containment reference.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* @param value the new value of the '<em>Name</em>' containment reference.
* @see #getName()
* @generated
*/
void setName(org.hl7.fhir.String value);
/**
* Returns the value of the '<em><b>Relationship</b></em>' containment reference.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* <!-- begin-model-doc -->
* The type of relationship this person has to the patient (father, mother, brother etc.).
* <!-- end-model-doc -->
* @return the value of the '<em>Relationship</em>' containment reference.
* @see #setRelationship(CodeableConcept)
* @see org.hl7.fhir.FhirPackage#getFamilyMemberHistory_Relationship()
* @model containment="true" required="true"
* extendedMetaData="kind='element' name='relationship' namespace='##targetNamespace'"
* @generated
*/
CodeableConcept getRelationship();
/**
* Sets the value of the '{@link org.hl7.fhir.FamilyMemberHistory#getRelationship <em>Relationship</em>}' containment reference.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* @param value the new value of the '<em>Relationship</em>' containment reference.
* @see #getRelationship()
* @generated
*/
void setRelationship(CodeableConcept value);
/**
* Returns the value of the '<em><b>Gender</b></em>' containment reference.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* <!-- begin-model-doc -->
* Administrative Gender - the gender that the relative is considered to have for administration and record keeping purposes.
* <!-- end-model-doc -->
* @return the value of the '<em>Gender</em>' containment reference.
* @see #setGender(Code)
* @see org.hl7.fhir.FhirPackage#getFamilyMemberHistory_Gender()
* @model containment="true"
* extendedMetaData="kind='element' name='gender' namespace='##targetNamespace'"
* @generated
*/
Code getGender();
/**
* Sets the value of the '{@link org.hl7.fhir.FamilyMemberHistory#getGender <em>Gender</em>}' containment reference.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* @param value the new value of the '<em>Gender</em>' containment reference.
* @see #getGender()
* @generated
*/
void setGender(Code value);
/**
* Returns the value of the '<em><b>Born Period</b></em>' containment reference.
* <!-- begin-user-doc -->
* <p>
* If the meaning of the '<em>Born Period</em>' containment reference isn't clear,
* there really should be more of a description here...
* </p>
* <!-- end-user-doc -->
* @return the value of the '<em>Born Period</em>' containment reference.
* @see #setBornPeriod(Period)
* @see org.hl7.fhir.FhirPackage#getFamilyMemberHistory_BornPeriod()
* @model containment="true"
* extendedMetaData="kind='element' name='bornPeriod' namespace='##targetNamespace'"
* @generated
*/
Period getBornPeriod();
/**
* Sets the value of the '{@link org.hl7.fhir.FamilyMemberHistory#getBornPeriod <em>Born Period</em>}' containment reference.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* @param value the new value of the '<em>Born Period</em>' containment reference.
* @see #getBornPeriod()
* @generated
*/
void setBornPeriod(Period value);
/**
* Returns the value of the '<em><b>Born Date</b></em>' containment reference.
* <!-- begin-user-doc -->
* <p>
* If the meaning of the '<em>Born Date</em>' containment reference isn't clear,
* there really should be more of a description here...
* </p>
* <!-- end-user-doc -->
* @return the value of the '<em>Born Date</em>' containment reference.
* @see #setBornDate(Date)
* @see org.hl7.fhir.FhirPackage#getFamilyMemberHistory_BornDate()
* @model containment="true"
* extendedMetaData="kind='element' name='bornDate' namespace='##targetNamespace'"
* @generated
*/
Date getBornDate();
/**
* Sets the value of the '{@link org.hl7.fhir.FamilyMemberHistory#getBornDate <em>Born Date</em>}' containment reference.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* @param value the new value of the '<em>Born Date</em>' containment reference.
* @see #getBornDate()
* @generated
*/
void setBornDate(Date value);
/**
* Returns the value of the '<em><b>Born String</b></em>' containment reference.
* <!-- begin-user-doc -->
* <p>
* If the meaning of the '<em>Born String</em>' containment reference isn't clear,
* there really should be more of a description here...
* </p>
* <!-- end-user-doc -->
* @return the value of the '<em>Born String</em>' containment reference.
* @see #setBornString(org.hl7.fhir.String)
* @see org.hl7.fhir.FhirPackage#getFamilyMemberHistory_BornString()
* @model containment="true"
* extendedMetaData="kind='element' name='bornString' namespace='##targetNamespace'"
* @generated
*/
org.hl7.fhir.String getBornString();
/**
* Sets the value of the '{@link org.hl7.fhir.FamilyMemberHistory#getBornString <em>Born String</em>}' containment reference.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* @param value the new value of the '<em>Born String</em>' containment reference.
* @see #getBornString()
* @generated
*/
void setBornString(org.hl7.fhir.String value);
/**
* Returns the value of the '<em><b>Age Quantity</b></em>' containment reference.
* <!-- begin-user-doc -->
* <p>
* If the meaning of the '<em>Age Quantity</em>' containment reference isn't clear,
* there really should be more of a description here...
* </p>
* <!-- end-user-doc -->
* @return the value of the '<em>Age Quantity</em>' containment reference.
* @see #setAgeQuantity(Age)
* @see org.hl7.fhir.FhirPackage#getFamilyMemberHistory_AgeQuantity()
* @model containment="true"
* extendedMetaData="kind='element' name='ageQuantity' namespace='##targetNamespace'"
* @generated
*/
Age getAgeQuantity();
/**
* Sets the value of the '{@link org.hl7.fhir.FamilyMemberHistory#getAgeQuantity <em>Age Quantity</em>}' containment reference.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* @param value the new value of the '<em>Age Quantity</em>' containment reference.
* @see #getAgeQuantity()
* @generated
*/
void setAgeQuantity(Age value);
/**
* Returns the value of the '<em><b>Age Range</b></em>' containment reference.
* <!-- begin-user-doc -->
* <p>
* If the meaning of the '<em>Age Range</em>' containment reference isn't clear,
* there really should be more of a description here...
* </p>
* <!-- end-user-doc -->
* @return the value of the '<em>Age Range</em>' containment reference.
* @see #setAgeRange(Range)
* @see org.hl7.fhir.FhirPackage#getFamilyMemberHistory_AgeRange()
* @model containment="true"
* extendedMetaData="kind='element' name='ageRange' namespace='##targetNamespace'"
* @generated
*/
Range getAgeRange();
/**
* Sets the value of the '{@link org.hl7.fhir.FamilyMemberHistory#getAgeRange <em>Age Range</em>}' containment reference.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* @param value the new value of the '<em>Age Range</em>' containment reference.
* @see #getAgeRange()
* @generated
*/
void setAgeRange(Range value);
/**
* Returns the value of the '<em><b>Age String</b></em>' containment reference.
* <!-- begin-user-doc -->
* <p>
* If the meaning of the '<em>Age String</em>' containment reference isn't clear,
* there really should be more of a description here...
* </p>
* <!-- end-user-doc -->
* @return the value of the '<em>Age String</em>' containment reference.
* @see #setAgeString(org.hl7.fhir.String)
* @see org.hl7.fhir.FhirPackage#getFamilyMemberHistory_AgeString()
* @model containment="true"
* extendedMetaData="kind='element' name='ageString' namespace='##targetNamespace'"
* @generated
*/
org.hl7.fhir.String getAgeString();
/**
* Sets the value of the '{@link org.hl7.fhir.FamilyMemberHistory#getAgeString <em>Age String</em>}' containment reference.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* @param value the new value of the '<em>Age String</em>' containment reference.
* @see #getAgeString()
* @generated
*/
void setAgeString(org.hl7.fhir.String value);
/**
* Returns the value of the '<em><b>Deceased Boolean</b></em>' containment reference.
* <!-- begin-user-doc -->
* <p>
* If the meaning of the '<em>Deceased Boolean</em>' containment reference isn't clear,
* there really should be more of a description here...
* </p>
* <!-- end-user-doc -->
* @return the value of the '<em>Deceased Boolean</em>' containment reference.
* @see #setDeceasedBoolean(org.hl7.fhir.Boolean)
* @see org.hl7.fhir.FhirPackage#getFamilyMemberHistory_DeceasedBoolean()
* @model containment="true"
* extendedMetaData="kind='element' name='deceasedBoolean' namespace='##targetNamespace'"
* @generated
*/
org.hl7.fhir.Boolean getDeceasedBoolean();
/**
* Sets the value of the '{@link org.hl7.fhir.FamilyMemberHistory#getDeceasedBoolean <em>Deceased Boolean</em>}' containment reference.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* @param value the new value of the '<em>Deceased Boolean</em>' containment reference.
* @see #getDeceasedBoolean()
* @generated
*/
void setDeceasedBoolean(org.hl7.fhir.Boolean value);
/**
* Returns the value of the '<em><b>Deceased Quantity</b></em>' containment reference.
* <!-- begin-user-doc -->
* <p>
* If the meaning of the '<em>Deceased Quantity</em>' containment reference isn't clear,
* there really should be more of a description here...
* </p>
* <!-- end-user-doc -->
* @return the value of the '<em>Deceased Quantity</em>' containment reference.
* @see #setDeceasedQuantity(Age)
* @see org.hl7.fhir.FhirPackage#getFamilyMemberHistory_DeceasedQuantity()
* @model containment="true"
* extendedMetaData="kind='element' name='deceasedQuantity' namespace='##targetNamespace'"
* @generated
*/
Age getDeceasedQuantity();
/**
* Sets the value of the '{@link org.hl7.fhir.FamilyMemberHistory#getDeceasedQuantity <em>Deceased Quantity</em>}' containment reference.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* @param value the new value of the '<em>Deceased Quantity</em>' containment reference.
* @see #getDeceasedQuantity()
* @generated
*/
void setDeceasedQuantity(Age value);
/**
* Returns the value of the '<em><b>Deceased Range</b></em>' containment reference.
* <!-- begin-user-doc -->
* <p>
* If the meaning of the '<em>Deceased Range</em>' containment reference isn't clear,
* there really should be more of a description here...
* </p>
* <!-- end-user-doc -->
* @return the value of the '<em>Deceased Range</em>' containment reference.
* @see #setDeceasedRange(Range)
* @see org.hl7.fhir.FhirPackage#getFamilyMemberHistory_DeceasedRange()
* @model containment="true"
* extendedMetaData="kind='element' name='deceasedRange' namespace='##targetNamespace'"
* @generated
*/
Range getDeceasedRange();
/**
* Sets the value of the '{@link org.hl7.fhir.FamilyMemberHistory#getDeceasedRange <em>Deceased Range</em>}' containment reference.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* @param value the new value of the '<em>Deceased Range</em>' containment reference.
* @see #getDeceasedRange()
* @generated
*/
void setDeceasedRange(Range value);
/**
* Returns the value of the '<em><b>Deceased Date</b></em>' containment reference.
* <!-- begin-user-doc -->
* <p>
* If the meaning of the '<em>Deceased Date</em>' containment reference isn't clear,
* there really should be more of a description here...
* </p>
* <!-- end-user-doc -->
* @return the value of the '<em>Deceased Date</em>' containment reference.
* @see #setDeceasedDate(Date)
* @see org.hl7.fhir.FhirPackage#getFamilyMemberHistory_DeceasedDate()
* @model containment="true"
* extendedMetaData="kind='element' name='deceasedDate' namespace='##targetNamespace'"
* @generated
*/
Date getDeceasedDate();
/**
* Sets the value of the '{@link org.hl7.fhir.FamilyMemberHistory#getDeceasedDate <em>Deceased Date</em>}' containment reference.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* @param value the new value of the '<em>Deceased Date</em>' containment reference.
* @see #getDeceasedDate()
* @generated
*/
void setDeceasedDate(Date value);
/**
* Returns the value of the '<em><b>Deceased String</b></em>' containment reference.
* <!-- begin-user-doc -->
* <p>
* If the meaning of the '<em>Deceased String</em>' containment reference isn't clear,
* there really should be more of a description here...
* </p>
* <!-- end-user-doc -->
* @return the value of the '<em>Deceased String</em>' containment reference.
* @see #setDeceasedString(org.hl7.fhir.String)
* @see org.hl7.fhir.FhirPackage#getFamilyMemberHistory_DeceasedString()
* @model containment="true"
* extendedMetaData="kind='element' name='deceasedString' namespace='##targetNamespace'"
* @generated
*/
org.hl7.fhir.String getDeceasedString();
/**
* Sets the value of the '{@link org.hl7.fhir.FamilyMemberHistory#getDeceasedString <em>Deceased String</em>}' containment reference.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* @param value the new value of the '<em>Deceased String</em>' containment reference.
* @see #getDeceasedString()
* @generated
*/
void setDeceasedString(org.hl7.fhir.String value);
/**
* Returns the value of the '<em><b>Note</b></em>' containment reference.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* <!-- begin-model-doc -->
* 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.
* <!-- end-model-doc -->
* @return the value of the '<em>Note</em>' containment reference.
* @see #setNote(Annotation)
* @see org.hl7.fhir.FhirPackage#getFamilyMemberHistory_Note()
* @model containment="true"
* extendedMetaData="kind='element' name='note' namespace='##targetNamespace'"
* @generated
*/
Annotation getNote();
/**
* Sets the value of the '{@link org.hl7.fhir.FamilyMemberHistory#getNote <em>Note</em>}' containment reference.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* @param value the new value of the '<em>Note</em>' containment reference.
* @see #getNote()
* @generated
*/
void setNote(Annotation value);
/**
* Returns the value of the '<em><b>Condition</b></em>' containment reference list.
* The list contents are of type {@link org.hl7.fhir.FamilyMemberHistoryCondition}.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* <!-- begin-model-doc -->
* 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.
* <!-- end-model-doc -->
* @return the value of the '<em>Condition</em>' containment reference list.
* @see org.hl7.fhir.FhirPackage#getFamilyMemberHistory_Condition()
* @model containment="true"
* extendedMetaData="kind='element' name='condition' namespace='##targetNamespace'"
* @generated
*/
EList<FamilyMemberHistoryCondition> getCondition();
} // FamilyMemberHistory