blob: fc40c2030183b47bcc368abeaf6f3d1527a7bc03 [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>Related Person</b></em>'.
* <!-- end-user-doc -->
*
* <!-- begin-model-doc -->
* Information about a person that is involved in the care for a patient, but who is not the target of healthcare, nor has a formal responsibility in the care process.
* 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.RelatedPerson#getIdentifier <em>Identifier</em>}</li>
* <li>{@link org.hl7.fhir.RelatedPerson#getPatient <em>Patient</em>}</li>
* <li>{@link org.hl7.fhir.RelatedPerson#getRelationship <em>Relationship</em>}</li>
* <li>{@link org.hl7.fhir.RelatedPerson#getName <em>Name</em>}</li>
* <li>{@link org.hl7.fhir.RelatedPerson#getTelecom <em>Telecom</em>}</li>
* <li>{@link org.hl7.fhir.RelatedPerson#getGender <em>Gender</em>}</li>
* <li>{@link org.hl7.fhir.RelatedPerson#getBirthDate <em>Birth Date</em>}</li>
* <li>{@link org.hl7.fhir.RelatedPerson#getAddress <em>Address</em>}</li>
* <li>{@link org.hl7.fhir.RelatedPerson#getPhoto <em>Photo</em>}</li>
* <li>{@link org.hl7.fhir.RelatedPerson#getPeriod <em>Period</em>}</li>
* </ul>
*
* @see org.hl7.fhir.FhirPackage#getRelatedPerson()
* @model extendedMetaData="name='RelatedPerson' kind='elementOnly'"
* @generated
*/
public interface RelatedPerson 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 -->
* Identifier for a person within a particular scope.
* <!-- end-model-doc -->
* @return the value of the '<em>Identifier</em>' containment reference list.
* @see org.hl7.fhir.FhirPackage#getRelatedPerson_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 patient this person is related to.
* <!-- end-model-doc -->
* @return the value of the '<em>Patient</em>' containment reference.
* @see #setPatient(Reference)
* @see org.hl7.fhir.FhirPackage#getRelatedPerson_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.RelatedPerson#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>Relationship</b></em>' containment reference.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* <!-- begin-model-doc -->
* The nature of the relationship between a patient and the related person.
* <!-- end-model-doc -->
* @return the value of the '<em>Relationship</em>' containment reference.
* @see #setRelationship(CodeableConcept)
* @see org.hl7.fhir.FhirPackage#getRelatedPerson_Relationship()
* @model containment="true"
* extendedMetaData="kind='element' name='relationship' namespace='##targetNamespace'"
* @generated
*/
CodeableConcept getRelationship();
/**
* Sets the value of the '{@link org.hl7.fhir.RelatedPerson#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>Name</b></em>' containment reference.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* <!-- begin-model-doc -->
* A name associated with the person.
* <!-- end-model-doc -->
* @return the value of the '<em>Name</em>' containment reference.
* @see #setName(HumanName)
* @see org.hl7.fhir.FhirPackage#getRelatedPerson_Name()
* @model containment="true"
* extendedMetaData="kind='element' name='name' namespace='##targetNamespace'"
* @generated
*/
HumanName getName();
/**
* Sets the value of the '{@link org.hl7.fhir.RelatedPerson#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(HumanName value);
/**
* Returns the value of the '<em><b>Telecom</b></em>' containment reference list.
* The list contents are of type {@link org.hl7.fhir.ContactPoint}.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* <!-- begin-model-doc -->
* A contact detail for the person, e.g. a telephone number or an email address.
* <!-- end-model-doc -->
* @return the value of the '<em>Telecom</em>' containment reference list.
* @see org.hl7.fhir.FhirPackage#getRelatedPerson_Telecom()
* @model containment="true"
* extendedMetaData="kind='element' name='telecom' namespace='##targetNamespace'"
* @generated
*/
EList<ContactPoint> getTelecom();
/**
* 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 person 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#getRelatedPerson_Gender()
* @model containment="true"
* extendedMetaData="kind='element' name='gender' namespace='##targetNamespace'"
* @generated
*/
Code getGender();
/**
* Sets the value of the '{@link org.hl7.fhir.RelatedPerson#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>Birth Date</b></em>' containment reference.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* <!-- begin-model-doc -->
* The date on which the related person was born.
* <!-- end-model-doc -->
* @return the value of the '<em>Birth Date</em>' containment reference.
* @see #setBirthDate(Date)
* @see org.hl7.fhir.FhirPackage#getRelatedPerson_BirthDate()
* @model containment="true"
* extendedMetaData="kind='element' name='birthDate' namespace='##targetNamespace'"
* @generated
*/
Date getBirthDate();
/**
* Sets the value of the '{@link org.hl7.fhir.RelatedPerson#getBirthDate <em>Birth Date</em>}' containment reference.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* @param value the new value of the '<em>Birth Date</em>' containment reference.
* @see #getBirthDate()
* @generated
*/
void setBirthDate(Date value);
/**
* Returns the value of the '<em><b>Address</b></em>' containment reference list.
* The list contents are of type {@link org.hl7.fhir.Address}.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* <!-- begin-model-doc -->
* Address where the related person can be contacted or visited.
* <!-- end-model-doc -->
* @return the value of the '<em>Address</em>' containment reference list.
* @see org.hl7.fhir.FhirPackage#getRelatedPerson_Address()
* @model containment="true"
* extendedMetaData="kind='element' name='address' namespace='##targetNamespace'"
* @generated
*/
EList<Address> getAddress();
/**
* Returns the value of the '<em><b>Photo</b></em>' containment reference list.
* The list contents are of type {@link org.hl7.fhir.Attachment}.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* <!-- begin-model-doc -->
* Image of the person.
* <!-- end-model-doc -->
* @return the value of the '<em>Photo</em>' containment reference list.
* @see org.hl7.fhir.FhirPackage#getRelatedPerson_Photo()
* @model containment="true"
* extendedMetaData="kind='element' name='photo' namespace='##targetNamespace'"
* @generated
*/
EList<Attachment> getPhoto();
/**
* Returns the value of the '<em><b>Period</b></em>' containment reference.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* <!-- begin-model-doc -->
* The period of time that this relationship is considered to be valid. If there are no dates defined, then the interval is unknown.
* <!-- end-model-doc -->
* @return the value of the '<em>Period</em>' containment reference.
* @see #setPeriod(Period)
* @see org.hl7.fhir.FhirPackage#getRelatedPerson_Period()
* @model containment="true"
* extendedMetaData="kind='element' name='period' namespace='##targetNamespace'"
* @generated
*/
Period getPeriod();
/**
* Sets the value of the '{@link org.hl7.fhir.RelatedPerson#getPeriod <em>Period</em>}' containment reference.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* @param value the new value of the '<em>Period</em>' containment reference.
* @see #getPeriod()
* @generated
*/
void setPeriod(Period value);
} // RelatedPerson