org.openhealthtools.mdht.uml.cda.Patient Maven / Gradle / Ivy
/*******************************************************************************
* Copyright (c) 2009, 2011 IBM Corporation and others.
* All rights reserved. This program and the accompanying materials
* are made available under the terms of the Eclipse Public License v1.0
* which accompanies this distribution, and is available at
* http://www.eclipse.org/legal/epl-v10.html
*
* Contributors:
* IBM Corporation - initial API and implementation
*******************************************************************************/
package org.openhealthtools.mdht.uml.cda;
import java.util.Map;
import org.eclipse.emf.common.util.DiagnosticChain;
import org.eclipse.emf.common.util.EList;
import org.openhealthtools.mdht.uml.hl7.datatypes.CE;
import org.openhealthtools.mdht.uml.hl7.datatypes.CS;
import org.openhealthtools.mdht.uml.hl7.datatypes.II;
import org.openhealthtools.mdht.uml.hl7.datatypes.PN;
import org.openhealthtools.mdht.uml.hl7.datatypes.TS;
import org.openhealthtools.mdht.uml.hl7.rim.Entity;
import org.openhealthtools.mdht.uml.hl7.vocab.EntityClass;
import org.openhealthtools.mdht.uml.hl7.vocab.EntityDeterminer;
import org.openhealthtools.mdht.uml.hl7.vocab.NullFlavor;
/**
*
* A representation of the model object 'Patient'.
*
*
*
* The following features are supported:
*
* - {@link org.openhealthtools.mdht.uml.cda.Patient#getRealmCodes Realm Code}
* - {@link org.openhealthtools.mdht.uml.cda.Patient#getTypeId Type Id}
* - {@link org.openhealthtools.mdht.uml.cda.Patient#getTemplateIds Template Id}
* - {@link org.openhealthtools.mdht.uml.cda.Patient#getId Id}
* - {@link org.openhealthtools.mdht.uml.cda.Patient#getNames Name}
* - {@link org.openhealthtools.mdht.uml.cda.Patient#getAdministrativeGenderCode Administrative Gender Code}
* - {@link org.openhealthtools.mdht.uml.cda.Patient#getBirthTime Birth Time}
* - {@link org.openhealthtools.mdht.uml.cda.Patient#getMaritalStatusCode Marital Status Code}
* - {@link org.openhealthtools.mdht.uml.cda.Patient#getReligiousAffiliationCode Religious Affiliation Code}
* - {@link org.openhealthtools.mdht.uml.cda.Patient#getRaceCode Race Code}
* - {@link org.openhealthtools.mdht.uml.cda.Patient#getSDTCRaceCodes SDTC Race Code}
* - {@link org.openhealthtools.mdht.uml.cda.Patient#getEthnicGroupCode Ethnic Group Code}
* - {@link org.openhealthtools.mdht.uml.cda.Patient#getGuardians Guardian}
* - {@link org.openhealthtools.mdht.uml.cda.Patient#getBirthplace Birthplace}
* - {@link org.openhealthtools.mdht.uml.cda.Patient#getLanguageCommunications Language Communication}
* - {@link org.openhealthtools.mdht.uml.cda.Patient#getNullFlavor Null Flavor}
* - {@link org.openhealthtools.mdht.uml.cda.Patient#getClassCode Class Code}
* - {@link org.openhealthtools.mdht.uml.cda.Patient#getDeterminerCode Determiner Code}
*
*
*
* @see org.openhealthtools.mdht.uml.cda.CDAPackage#getPatient()
* @model
* @generated
*/
public interface Patient extends Entity {
/**
* Returns the value of the 'Realm Code' containment reference list.
* The list contents are of type {@link org.openhealthtools.mdht.uml.hl7.datatypes.CS}.
*
*
* If the meaning of the 'Realm Code' containment reference list isn't clear,
* there really should be more of a description here...
*
*
* @return the value of the 'Realm Code' containment reference list.
* @see org.openhealthtools.mdht.uml.cda.CDAPackage#getPatient_RealmCode()
* @model containment="true" ordered="false"
* extendedMetaData="name='realmCode' namespace='##targetNamespace' kind='element'"
* @generated
*/
EList getRealmCodes();
/**
* Returns the value of the 'Type Id' containment reference.
*
*
* If the meaning of the 'Type Id' containment reference isn't clear,
* there really should be more of a description here...
*
*
* @return the value of the 'Type Id' containment reference.
* @see #setTypeId(InfrastructureRootTypeId)
* @see org.openhealthtools.mdht.uml.cda.CDAPackage#getPatient_TypeId()
* @model containment="true" ordered="false"
* extendedMetaData="name='typeId' namespace='##targetNamespace' kind='element'"
* @generated
*/
InfrastructureRootTypeId getTypeId();
/**
* Sets the value of the '{@link org.openhealthtools.mdht.uml.cda.Patient#getTypeId Type Id}' containment reference.
*
*
* @param value the new value of the 'Type Id' containment reference.
* @see #getTypeId()
* @generated
*/
void setTypeId(InfrastructureRootTypeId value);
/**
* Returns the value of the 'Template Id' containment reference list.
* The list contents are of type {@link org.openhealthtools.mdht.uml.hl7.datatypes.II}.
*
*
* If the meaning of the 'Template Id' containment reference list isn't clear,
* there really should be more of a description here...
*
*
* @return the value of the 'Template Id' containment reference list.
* @see org.openhealthtools.mdht.uml.cda.CDAPackage#getPatient_TemplateId()
* @model containment="true" ordered="false"
* extendedMetaData="name='templateId' namespace='##targetNamespace' kind='element'"
* @generated
*/
EList getTemplateIds();
/**
* Returns the value of the 'Id' containment reference.
*
*
* If the meaning of the 'Id' containment reference isn't clear,
* there really should be more of a description here...
*
*
* @return the value of the 'Id' containment reference.
* @see #setId(II)
* @see org.openhealthtools.mdht.uml.cda.CDAPackage#getPatient_Id()
* @model containment="true" ordered="false"
* extendedMetaData="name='id' namespace='##targetNamespace' kind='element'"
* @generated
*/
II getId();
/**
* Sets the value of the '{@link org.openhealthtools.mdht.uml.cda.Patient#getId Id}' containment reference.
*
*
* @param value the new value of the 'Id' containment reference.
* @see #getId()
* @generated
*/
void setId(II value);
/**
* Returns the value of the 'Name' containment reference list.
* The list contents are of type {@link org.openhealthtools.mdht.uml.hl7.datatypes.PN}.
*
*
* If the meaning of the 'Name' containment reference list isn't clear,
* there really should be more of a description here...
*
*
* @return the value of the 'Name' containment reference list.
* @see org.openhealthtools.mdht.uml.cda.CDAPackage#getPatient_Name()
* @model containment="true" ordered="false"
* extendedMetaData="name='name' namespace='##targetNamespace' kind='element'"
* @generated
*/
EList getNames();
/**
* Returns the value of the 'Administrative Gender Code' containment reference.
*
*
* If the meaning of the 'Administrative Gender Code' containment reference isn't clear,
* there really should be more of a description here...
*
*
* @return the value of the 'Administrative Gender Code' containment reference.
* @see #setAdministrativeGenderCode(CE)
* @see org.openhealthtools.mdht.uml.cda.CDAPackage#getPatient_AdministrativeGenderCode()
* @model containment="true" ordered="false"
* extendedMetaData="name='administrativeGenderCode' namespace='##targetNamespace' kind='element'"
* @generated
*/
CE getAdministrativeGenderCode();
/**
* Sets the value of the '{@link org.openhealthtools.mdht.uml.cda.Patient#getAdministrativeGenderCode Administrative Gender Code}' containment reference.
*
*
* @param value the new value of the 'Administrative Gender Code' containment reference.
* @see #getAdministrativeGenderCode()
* @generated
*/
void setAdministrativeGenderCode(CE value);
/**
* Returns the value of the 'Birth Time' containment reference.
*
*
* If the meaning of the 'Birth Time' containment reference isn't clear,
* there really should be more of a description here...
*
*
* @return the value of the 'Birth Time' containment reference.
* @see #setBirthTime(TS)
* @see org.openhealthtools.mdht.uml.cda.CDAPackage#getPatient_BirthTime()
* @model containment="true" ordered="false"
* extendedMetaData="name='birthTime' namespace='##targetNamespace' kind='element'"
* @generated
*/
TS getBirthTime();
/**
* Sets the value of the '{@link org.openhealthtools.mdht.uml.cda.Patient#getBirthTime Birth Time}' containment reference.
*
*
* @param value the new value of the 'Birth Time' containment reference.
* @see #getBirthTime()
* @generated
*/
void setBirthTime(TS value);
/**
* Returns the value of the 'Marital Status Code' containment reference.
*
*
* If the meaning of the 'Marital Status Code' containment reference isn't clear,
* there really should be more of a description here...
*
*
* @return the value of the 'Marital Status Code' containment reference.
* @see #setMaritalStatusCode(CE)
* @see org.openhealthtools.mdht.uml.cda.CDAPackage#getPatient_MaritalStatusCode()
* @model containment="true" ordered="false"
* extendedMetaData="name='maritalStatusCode' namespace='##targetNamespace' kind='element'"
* @generated
*/
CE getMaritalStatusCode();
/**
* Sets the value of the '{@link org.openhealthtools.mdht.uml.cda.Patient#getMaritalStatusCode Marital Status Code}' containment reference.
*
*
* @param value the new value of the 'Marital Status Code' containment reference.
* @see #getMaritalStatusCode()
* @generated
*/
void setMaritalStatusCode(CE value);
/**
* Returns the value of the 'Religious Affiliation Code' containment reference.
*
*
* If the meaning of the 'Religious Affiliation Code' containment reference isn't clear,
* there really should be more of a description here...
*
*
* @return the value of the 'Religious Affiliation Code' containment reference.
* @see #setReligiousAffiliationCode(CE)
* @see org.openhealthtools.mdht.uml.cda.CDAPackage#getPatient_ReligiousAffiliationCode()
* @model containment="true" ordered="false"
* extendedMetaData="name='religiousAffiliationCode' namespace='##targetNamespace' kind='element'"
* @generated
*/
CE getReligiousAffiliationCode();
/**
* Sets the value of the '{@link org.openhealthtools.mdht.uml.cda.Patient#getReligiousAffiliationCode Religious Affiliation Code}' containment reference.
*
*
* @param value the new value of the 'Religious Affiliation Code' containment reference.
* @see #getReligiousAffiliationCode()
* @generated
*/
void setReligiousAffiliationCode(CE value);
/**
* Returns the value of the 'Race Code' containment reference.
*
*
* If the meaning of the 'Race Code' containment reference isn't clear,
* there really should be more of a description here...
*
*
* @return the value of the 'Race Code' containment reference.
* @see #setRaceCode(CE)
* @see org.openhealthtools.mdht.uml.cda.CDAPackage#getPatient_RaceCode()
* @model containment="true" ordered="false"
* extendedMetaData="name='raceCode' namespace='##targetNamespace' kind='element'"
* @generated
*/
CE getRaceCode();
/**
* Sets the value of the '{@link org.openhealthtools.mdht.uml.cda.Patient#getRaceCode Race Code}' containment reference.
*
*
* @param value the new value of the 'Race Code' containment reference.
* @see #getRaceCode()
* @generated
*/
void setRaceCode(CE value);
/**
* Returns the value of the 'SDTC Race Code' containment reference list.
* The list contents are of type {@link org.openhealthtools.mdht.uml.hl7.datatypes.CE}.
*
*
* If the meaning of the 'SDTC Race Code' containment reference list isn't clear,
* there really should be more of a description here...
*
*
* @return the value of the 'SDTC Race Code' containment reference list.
* @see org.openhealthtools.mdht.uml.cda.CDAPackage#getPatient_SDTCRaceCode()
* @model containment="true" ordered="false"
* extendedMetaData="name='raceCode' namespace='urn:hl7-org:sdtc' kind='element'"
* @generated
*/
EList getSDTCRaceCodes();
/**
* Returns the value of the 'Ethnic Group Code' containment reference.
*
*
* If the meaning of the 'Ethnic Group Code' containment reference isn't clear,
* there really should be more of a description here...
*
*
* @return the value of the 'Ethnic Group Code' containment reference.
* @see #setEthnicGroupCode(CE)
* @see org.openhealthtools.mdht.uml.cda.CDAPackage#getPatient_EthnicGroupCode()
* @model containment="true" ordered="false"
* extendedMetaData="name='ethnicGroupCode' namespace='##targetNamespace' kind='element'"
* @generated
*/
CE getEthnicGroupCode();
/**
* Sets the value of the '{@link org.openhealthtools.mdht.uml.cda.Patient#getEthnicGroupCode Ethnic Group Code}' containment reference.
*
*
* @param value the new value of the 'Ethnic Group Code' containment reference.
* @see #getEthnicGroupCode()
* @generated
*/
void setEthnicGroupCode(CE value);
/**
* Returns the value of the 'Guardian' containment reference list.
* The list contents are of type {@link org.openhealthtools.mdht.uml.cda.Guardian}.
*
*
* If the meaning of the 'Guardian' containment reference list isn't clear,
* there really should be more of a description here...
*
*
* @return the value of the 'Guardian' containment reference list.
* @see org.openhealthtools.mdht.uml.cda.CDAPackage#getPatient_Guardian()
* @model containment="true" ordered="false"
* extendedMetaData="name='guardian' namespace='##targetNamespace' kind='element'"
* @generated
*/
EList getGuardians();
/**
* Returns the value of the 'Birthplace' containment reference.
*
*
* If the meaning of the 'Birthplace' containment reference isn't clear,
* there really should be more of a description here...
*
*
* @return the value of the 'Birthplace' containment reference.
* @see #setBirthplace(Birthplace)
* @see org.openhealthtools.mdht.uml.cda.CDAPackage#getPatient_Birthplace()
* @model containment="true" ordered="false"
* extendedMetaData="name='birthplace' namespace='##targetNamespace' kind='element'"
* @generated
*/
Birthplace getBirthplace();
/**
* Sets the value of the '{@link org.openhealthtools.mdht.uml.cda.Patient#getBirthplace Birthplace}' containment reference.
*
*
* @param value the new value of the 'Birthplace' containment reference.
* @see #getBirthplace()
* @generated
*/
void setBirthplace(Birthplace value);
/**
* Returns the value of the 'Language Communication' containment reference list.
* The list contents are of type {@link org.openhealthtools.mdht.uml.cda.LanguageCommunication}.
*
*
* If the meaning of the 'Language Communication' containment reference list isn't clear,
* there really should be more of a description here...
*
*
* @return the value of the 'Language Communication' containment reference list.
* @see org.openhealthtools.mdht.uml.cda.CDAPackage#getPatient_LanguageCommunication()
* @model containment="true" ordered="false"
* extendedMetaData="name='languageCommunication' namespace='##targetNamespace' kind='element'"
* @generated
*/
EList getLanguageCommunications();
/**
* Returns the value of the 'Null Flavor' attribute.
* The literals are from the enumeration {@link org.openhealthtools.mdht.uml.hl7.vocab.NullFlavor}.
*
*
* If the meaning of the 'Null Flavor' attribute isn't clear,
* there really should be more of a description here...
*
*
* @return the value of the 'Null Flavor' attribute.
* @see org.openhealthtools.mdht.uml.hl7.vocab.NullFlavor
* @see #isSetNullFlavor()
* @see #unsetNullFlavor()
* @see #setNullFlavor(NullFlavor)
* @see org.openhealthtools.mdht.uml.cda.CDAPackage#getPatient_NullFlavor()
* @model unsettable="true" ordered="false"
* extendedMetaData="name='nullFlavor' kind='attribute'"
* @generated
*/
NullFlavor getNullFlavor();
/**
* Sets the value of the '{@link org.openhealthtools.mdht.uml.cda.Patient#getNullFlavor Null Flavor}' attribute.
*
*
* @param value the new value of the 'Null Flavor' attribute.
* @see org.openhealthtools.mdht.uml.hl7.vocab.NullFlavor
* @see #isSetNullFlavor()
* @see #unsetNullFlavor()
* @see #getNullFlavor()
* @generated
*/
void setNullFlavor(NullFlavor value);
/**
* Unsets the value of the '{@link org.openhealthtools.mdht.uml.cda.Patient#getNullFlavor Null Flavor}' attribute.
*
*
* @see #isSetNullFlavor()
* @see #getNullFlavor()
* @see #setNullFlavor(NullFlavor)
* @generated
*/
void unsetNullFlavor();
/**
* Returns whether the value of the '{@link org.openhealthtools.mdht.uml.cda.Patient#getNullFlavor Null Flavor}' attribute is set.
*
*
* @return whether the value of the 'Null Flavor' attribute is set.
* @see #unsetNullFlavor()
* @see #getNullFlavor()
* @see #setNullFlavor(NullFlavor)
* @generated
*/
boolean isSetNullFlavor();
/**
* Returns the value of the 'Class Code' attribute.
* The default value is "PSN".
* The literals are from the enumeration {@link org.openhealthtools.mdht.uml.hl7.vocab.EntityClass}.
*
*
* If the meaning of the 'Class Code' attribute isn't clear,
* there really should be more of a description here...
*
*
* @return the value of the 'Class Code' attribute.
* @see org.openhealthtools.mdht.uml.hl7.vocab.EntityClass
* @see #isSetClassCode()
* @see #unsetClassCode()
* @see #setClassCode(EntityClass)
* @see org.openhealthtools.mdht.uml.cda.CDAPackage#getPatient_ClassCode()
* @model default="PSN" unsettable="true" ordered="false"
* extendedMetaData="name='classCode' kind='attribute'"
* @generated
*/
EntityClass getClassCode();
/**
* Sets the value of the '{@link org.openhealthtools.mdht.uml.cda.Patient#getClassCode Class Code}' attribute.
*
*
* @param value the new value of the 'Class Code' attribute.
* @see org.openhealthtools.mdht.uml.hl7.vocab.EntityClass
* @see #isSetClassCode()
* @see #unsetClassCode()
* @see #getClassCode()
* @generated
*/
void setClassCode(EntityClass value);
/**
* Unsets the value of the '{@link org.openhealthtools.mdht.uml.cda.Patient#getClassCode Class Code}' attribute.
*
*
* @see #isSetClassCode()
* @see #getClassCode()
* @see #setClassCode(EntityClass)
* @generated
*/
void unsetClassCode();
/**
* Returns whether the value of the '{@link org.openhealthtools.mdht.uml.cda.Patient#getClassCode Class Code}' attribute is set.
*
*
* @return whether the value of the 'Class Code' attribute is set.
* @see #unsetClassCode()
* @see #getClassCode()
* @see #setClassCode(EntityClass)
* @generated
*/
boolean isSetClassCode();
/**
* Returns the value of the 'Determiner Code' attribute.
* The default value is "INSTANCE".
* The literals are from the enumeration {@link org.openhealthtools.mdht.uml.hl7.vocab.EntityDeterminer}.
*
*
* If the meaning of the 'Determiner Code' attribute isn't clear,
* there really should be more of a description here...
*
*
* @return the value of the 'Determiner Code' attribute.
* @see org.openhealthtools.mdht.uml.hl7.vocab.EntityDeterminer
* @see #isSetDeterminerCode()
* @see #unsetDeterminerCode()
* @see #setDeterminerCode(EntityDeterminer)
* @see org.openhealthtools.mdht.uml.cda.CDAPackage#getPatient_DeterminerCode()
* @model default="INSTANCE" unsettable="true" ordered="false"
* extendedMetaData="name='determinerCode' kind='attribute'"
* @generated
*/
EntityDeterminer getDeterminerCode();
/**
* Sets the value of the '{@link org.openhealthtools.mdht.uml.cda.Patient#getDeterminerCode Determiner Code}' attribute.
*
*
* @param value the new value of the 'Determiner Code' attribute.
* @see org.openhealthtools.mdht.uml.hl7.vocab.EntityDeterminer
* @see #isSetDeterminerCode()
* @see #unsetDeterminerCode()
* @see #getDeterminerCode()
* @generated
*/
void setDeterminerCode(EntityDeterminer value);
/**
* Unsets the value of the '{@link org.openhealthtools.mdht.uml.cda.Patient#getDeterminerCode Determiner Code}' attribute.
*
*
* @see #isSetDeterminerCode()
* @see #getDeterminerCode()
* @see #setDeterminerCode(EntityDeterminer)
* @generated
*/
void unsetDeterminerCode();
/**
* Returns whether the value of the '{@link org.openhealthtools.mdht.uml.cda.Patient#getDeterminerCode Determiner Code}' attribute is set.
*
*
* @return whether the value of the 'Determiner Code' attribute is set.
* @see #unsetDeterminerCode()
* @see #getDeterminerCode()
* @see #setDeterminerCode(EntityDeterminer)
* @generated
*/
boolean isSetDeterminerCode();
/**
*
*
*
* self.isClassCodeDefined() implies self.classCode=vocab::EntityClass::PSN
* @param diagnostics The chain of diagnostics to which problems are to be appended.
* @param context The cache of context-specific information.
*
* @model annotation="http://www.eclipse.org/uml2/1.1.0/GenModel body='self.isClassCodeDefined() implies self.classCode=vocab::EntityClass::PSN'"
* @generated
*/
boolean validateClassCode(DiagnosticChain diagnostics, Map context);
/**
*
*
*
* self.isDeterminerCodeDefined() implies self.determinerCode=vocab::EntityDeterminer::INSTANCE
* @param diagnostics The chain of diagnostics to which problems are to be appended.
* @param context The cache of context-specific information.
*
* @model annotation="http://www.eclipse.org/uml2/1.1.0/GenModel body='self.isDeterminerCodeDefined() implies self.determinerCode=vocab::EntityDeterminer::INSTANCE'"
* @generated
*/
boolean validateDeterminerCode(DiagnosticChain diagnostics, Map context);
/**
*
*
*
* Bag { self.id }
*
* @model kind="operation" ordered="false"
* annotation="http://www.eclipse.org/uml2/1.1.0/GenModel body='Bag { self.id }'"
* @generated
*/
EList getIds();
} // Patient