/******************************************************************************* | |
* 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.eclipse.mdht.uml.cda; | |
import java.util.Map; | |
import org.eclipse.emf.common.util.DiagnosticChain; | |
import org.eclipse.emf.common.util.EList; | |
import org.eclipse.mdht.uml.hl7.datatypes.CS; | |
import org.eclipse.mdht.uml.hl7.datatypes.ED; | |
import org.eclipse.mdht.uml.hl7.datatypes.II; | |
import org.eclipse.mdht.uml.hl7.datatypes.PN; | |
import org.eclipse.mdht.uml.hl7.datatypes.TS; | |
import org.eclipse.mdht.uml.hl7.rim.Entity; | |
import org.eclipse.mdht.uml.hl7.vocab.EntityClass; | |
import org.eclipse.mdht.uml.hl7.vocab.EntityDeterminer; | |
import org.eclipse.mdht.uml.hl7.vocab.NullFlavor; | |
/** | |
* <!-- begin-user-doc --> | |
* A representation of the model object '<em><b>Person</b></em>'. | |
* <!-- end-user-doc --> | |
* | |
* <p> | |
* The following features are supported: | |
* </p> | |
* <ul> | |
* <li>{@link org.eclipse.mdht.uml.cda.Person#getRealmCodes <em>Realm Code</em>}</li> | |
* <li>{@link org.eclipse.mdht.uml.cda.Person#getTypeId <em>Type Id</em>}</li> | |
* <li>{@link org.eclipse.mdht.uml.cda.Person#getTemplateIds <em>Template Id</em>}</li> | |
* <li>{@link org.eclipse.mdht.uml.cda.Person#getNames <em>Name</em>}</li> | |
* <li>{@link org.eclipse.mdht.uml.cda.Person#getSDTCDesc <em>SDTC Desc</em>}</li> | |
* <li>{@link org.eclipse.mdht.uml.cda.Person#getSDTCAsPatientRelationship <em>SDTC As Patient Relationship</em>}</li> | |
* <li>{@link org.eclipse.mdht.uml.cda.Person#getSDTCBirthTime <em>SDTC Birth Time</em>}</li> | |
* <li>{@link org.eclipse.mdht.uml.cda.Person#getNullFlavor <em>Null Flavor</em>}</li> | |
* <li>{@link org.eclipse.mdht.uml.cda.Person#getClassCode <em>Class Code</em>}</li> | |
* <li>{@link org.eclipse.mdht.uml.cda.Person#getDeterminerCode <em>Determiner Code</em>}</li> | |
* </ul> | |
* | |
* @see org.eclipse.mdht.uml.cda.CDAPackage#getPerson() | |
* @model | |
* @generated | |
*/ | |
public interface Person extends Entity { | |
/** | |
* Returns the value of the '<em><b>Realm Code</b></em>' containment reference list. | |
* The list contents are of type {@link org.eclipse.mdht.uml.hl7.datatypes.CS}. | |
* <!-- begin-user-doc --> | |
* <p> | |
* If the meaning of the '<em>Realm Code</em>' containment reference list isn't clear, | |
* there really should be more of a description here... | |
* </p> | |
* <!-- end-user-doc --> | |
* @return the value of the '<em>Realm Code</em>' containment reference list. | |
* @see org.eclipse.mdht.uml.cda.CDAPackage#getPerson_RealmCode() | |
* @model containment="true" ordered="false" | |
* extendedMetaData="name='realmCode' namespace='##targetNamespace' kind='element'" | |
* @generated | |
*/ | |
EList<CS> getRealmCodes(); | |
/** | |
* Returns the value of the '<em><b>Type Id</b></em>' containment reference. | |
* <!-- begin-user-doc --> | |
* <p> | |
* If the meaning of the '<em>Type Id</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>Type Id</em>' containment reference. | |
* @see #setTypeId(InfrastructureRootTypeId) | |
* @see org.eclipse.mdht.uml.cda.CDAPackage#getPerson_TypeId() | |
* @model containment="true" ordered="false" | |
* extendedMetaData="name='typeId' namespace='##targetNamespace' kind='element'" | |
* @generated | |
*/ | |
InfrastructureRootTypeId getTypeId(); | |
/** | |
* Sets the value of the '{@link org.eclipse.mdht.uml.cda.Person#getTypeId <em>Type Id</em>}' containment reference. | |
* <!-- begin-user-doc --> | |
* <!-- end-user-doc --> | |
* @param value the new value of the '<em>Type Id</em>' containment reference. | |
* @see #getTypeId() | |
* @generated | |
*/ | |
void setTypeId(InfrastructureRootTypeId value); | |
/** | |
* Returns the value of the '<em><b>Template Id</b></em>' containment reference list. | |
* The list contents are of type {@link org.eclipse.mdht.uml.hl7.datatypes.II}. | |
* <!-- begin-user-doc --> | |
* <p> | |
* If the meaning of the '<em>Template Id</em>' containment reference list isn't clear, | |
* there really should be more of a description here... | |
* </p> | |
* <!-- end-user-doc --> | |
* @return the value of the '<em>Template Id</em>' containment reference list. | |
* @see org.eclipse.mdht.uml.cda.CDAPackage#getPerson_TemplateId() | |
* @model containment="true" ordered="false" | |
* extendedMetaData="name='templateId' namespace='##targetNamespace' kind='element'" | |
* @generated | |
*/ | |
EList<II> getTemplateIds(); | |
/** | |
* Returns the value of the '<em><b>Name</b></em>' containment reference list. | |
* The list contents are of type {@link org.eclipse.mdht.uml.hl7.datatypes.PN}. | |
* <!-- begin-user-doc --> | |
* <p> | |
* If the meaning of the '<em>Name</em>' containment reference list isn't clear, | |
* there really should be more of a description here... | |
* </p> | |
* <!-- end-user-doc --> | |
* @return the value of the '<em>Name</em>' containment reference list. | |
* @see org.eclipse.mdht.uml.cda.CDAPackage#getPerson_Name() | |
* @model containment="true" ordered="false" | |
* extendedMetaData="name='name' namespace='##targetNamespace' kind='element'" | |
* @generated | |
*/ | |
EList<PN> getNames(); | |
/** | |
* Returns the value of the '<em><b>SDTC Desc</b></em>' containment reference. | |
* <!-- begin-user-doc --> | |
* <!-- end-user-doc --> | |
* @return the value of the '<em>SDTC Desc</em>' containment reference. | |
* @see #setSDTCDesc(ED) | |
* @see org.eclipse.mdht.uml.cda.CDAPackage#getPerson_SDTCDesc() | |
* @model containment="true" ordered="false" | |
* extendedMetaData="name='desc' namespace='urn:hl7-org:sdtc' kind='element'" | |
* @generated | |
*/ | |
ED getSDTCDesc(); | |
/** | |
* Sets the value of the '{@link org.eclipse.mdht.uml.cda.Person#getSDTCDesc <em>SDTC Desc</em>}' containment reference. | |
* <!-- begin-user-doc --> | |
* <!-- end-user-doc --> | |
* @param value the new value of the '<em>SDTC Desc</em>' containment reference. | |
* @see #getSDTCDesc() | |
* @generated | |
*/ | |
void setSDTCDesc(ED value); | |
/** | |
* Returns the value of the '<em><b>SDTC As Patient Relationship</b></em>' containment reference. | |
* <!-- begin-user-doc --> | |
* <!-- end-user-doc --> | |
* @return the value of the '<em>SDTC As Patient Relationship</em>' containment reference. | |
* @see #setSDTCAsPatientRelationship(ED) | |
* @see org.eclipse.mdht.uml.cda.CDAPackage#getPerson_SDTCAsPatientRelationship() | |
* @model containment="true" ordered="false" | |
* extendedMetaData="name='asPatientRelationship' namespace='urn:hl7-org:sdtc' kind='element'" | |
* @generated | |
*/ | |
ED getSDTCAsPatientRelationship(); | |
/** | |
* Sets the value of the '{@link org.eclipse.mdht.uml.cda.Person#getSDTCAsPatientRelationship <em>SDTC As Patient Relationship</em>}' containment reference. | |
* <!-- begin-user-doc --> | |
* <!-- end-user-doc --> | |
* @param value the new value of the '<em>SDTC As Patient Relationship</em>' containment reference. | |
* @see #getSDTCAsPatientRelationship() | |
* @generated | |
*/ | |
void setSDTCAsPatientRelationship(ED value); | |
/** | |
* Returns the value of the '<em><b>SDTC Birth Time</b></em>' containment reference. | |
* <!-- begin-user-doc --> | |
* <p> | |
* If the meaning of the '<em>SDTC Birth Time</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>SDTC Birth Time</em>' containment reference. | |
* @see #setSDTCBirthTime(TS) | |
* @see org.eclipse.mdht.uml.cda.CDAPackage#getPerson_SDTCBirthTime() | |
* @model containment="true" ordered="false" | |
* extendedMetaData="name='birthTime' namespace='urn:hl7-org:sdtc' kind='element'" | |
* @generated | |
*/ | |
TS getSDTCBirthTime(); | |
/** | |
* Sets the value of the '{@link org.eclipse.mdht.uml.cda.Person#getSDTCBirthTime <em>SDTC Birth Time</em>}' containment reference. | |
* <!-- begin-user-doc --> | |
* <!-- end-user-doc --> | |
* @param value the new value of the '<em>SDTC Birth Time</em>' containment reference. | |
* @see #getSDTCBirthTime() | |
* @generated | |
*/ | |
void setSDTCBirthTime(TS value); | |
/** | |
* Returns the value of the '<em><b>Null Flavor</b></em>' attribute. | |
* The literals are from the enumeration {@link org.eclipse.mdht.uml.hl7.vocab.NullFlavor}. | |
* <!-- begin-user-doc --> | |
* <p> | |
* If the meaning of the '<em>Null Flavor</em>' attribute isn't clear, | |
* there really should be more of a description here... | |
* </p> | |
* <!-- end-user-doc --> | |
* @return the value of the '<em>Null Flavor</em>' attribute. | |
* @see org.eclipse.mdht.uml.hl7.vocab.NullFlavor | |
* @see #isSetNullFlavor() | |
* @see #unsetNullFlavor() | |
* @see #setNullFlavor(NullFlavor) | |
* @see org.eclipse.mdht.uml.cda.CDAPackage#getPerson_NullFlavor() | |
* @model unsettable="true" ordered="false" | |
* extendedMetaData="name='nullFlavor' kind='attribute'" | |
* @generated | |
*/ | |
NullFlavor getNullFlavor(); | |
/** | |
* Sets the value of the '{@link org.eclipse.mdht.uml.cda.Person#getNullFlavor <em>Null Flavor</em>}' attribute. | |
* <!-- begin-user-doc --> | |
* <!-- end-user-doc --> | |
* @param value the new value of the '<em>Null Flavor</em>' attribute. | |
* @see org.eclipse.mdht.uml.hl7.vocab.NullFlavor | |
* @see #isSetNullFlavor() | |
* @see #unsetNullFlavor() | |
* @see #getNullFlavor() | |
* @generated | |
*/ | |
void setNullFlavor(NullFlavor value); | |
/** | |
* Unsets the value of the '{@link org.eclipse.mdht.uml.cda.Person#getNullFlavor <em>Null Flavor</em>}' attribute. | |
* <!-- begin-user-doc --> | |
* <!-- end-user-doc --> | |
* @see #isSetNullFlavor() | |
* @see #getNullFlavor() | |
* @see #setNullFlavor(NullFlavor) | |
* @generated | |
*/ | |
void unsetNullFlavor(); | |
/** | |
* Returns whether the value of the '{@link org.eclipse.mdht.uml.cda.Person#getNullFlavor <em>Null Flavor</em>}' attribute is set. | |
* <!-- begin-user-doc --> | |
* <!-- end-user-doc --> | |
* @return whether the value of the '<em>Null Flavor</em>' attribute is set. | |
* @see #unsetNullFlavor() | |
* @see #getNullFlavor() | |
* @see #setNullFlavor(NullFlavor) | |
* @generated | |
*/ | |
boolean isSetNullFlavor(); | |
/** | |
* Returns the value of the '<em><b>Class Code</b></em>' attribute. | |
* The default value is <code>"PSN"</code>. | |
* The literals are from the enumeration {@link org.eclipse.mdht.uml.hl7.vocab.EntityClass}. | |
* <!-- begin-user-doc --> | |
* <p> | |
* If the meaning of the '<em>Class Code</em>' attribute isn't clear, | |
* there really should be more of a description here... | |
* </p> | |
* <!-- end-user-doc --> | |
* @return the value of the '<em>Class Code</em>' attribute. | |
* @see org.eclipse.mdht.uml.hl7.vocab.EntityClass | |
* @see #isSetClassCode() | |
* @see #unsetClassCode() | |
* @see #setClassCode(EntityClass) | |
* @see org.eclipse.mdht.uml.cda.CDAPackage#getPerson_ClassCode() | |
* @model default="PSN" unsettable="true" ordered="false" | |
* extendedMetaData="name='classCode' kind='attribute'" | |
* @generated | |
*/ | |
EntityClass getClassCode(); | |
/** | |
* Sets the value of the '{@link org.eclipse.mdht.uml.cda.Person#getClassCode <em>Class Code</em>}' attribute. | |
* <!-- begin-user-doc --> | |
* <!-- end-user-doc --> | |
* @param value the new value of the '<em>Class Code</em>' attribute. | |
* @see org.eclipse.mdht.uml.hl7.vocab.EntityClass | |
* @see #isSetClassCode() | |
* @see #unsetClassCode() | |
* @see #getClassCode() | |
* @generated | |
*/ | |
void setClassCode(EntityClass value); | |
/** | |
* Unsets the value of the '{@link org.eclipse.mdht.uml.cda.Person#getClassCode <em>Class Code</em>}' attribute. | |
* <!-- begin-user-doc --> | |
* <!-- end-user-doc --> | |
* @see #isSetClassCode() | |
* @see #getClassCode() | |
* @see #setClassCode(EntityClass) | |
* @generated | |
*/ | |
void unsetClassCode(); | |
/** | |
* Returns whether the value of the '{@link org.eclipse.mdht.uml.cda.Person#getClassCode <em>Class Code</em>}' attribute is set. | |
* <!-- begin-user-doc --> | |
* <!-- end-user-doc --> | |
* @return whether the value of the '<em>Class Code</em>' attribute is set. | |
* @see #unsetClassCode() | |
* @see #getClassCode() | |
* @see #setClassCode(EntityClass) | |
* @generated | |
*/ | |
boolean isSetClassCode(); | |
/** | |
* Returns the value of the '<em><b>Determiner Code</b></em>' attribute. | |
* The default value is <code>"INSTANCE"</code>. | |
* The literals are from the enumeration {@link org.eclipse.mdht.uml.hl7.vocab.EntityDeterminer}. | |
* <!-- begin-user-doc --> | |
* <p> | |
* If the meaning of the '<em>Determiner Code</em>' attribute isn't clear, | |
* there really should be more of a description here... | |
* </p> | |
* <!-- end-user-doc --> | |
* @return the value of the '<em>Determiner Code</em>' attribute. | |
* @see org.eclipse.mdht.uml.hl7.vocab.EntityDeterminer | |
* @see #isSetDeterminerCode() | |
* @see #unsetDeterminerCode() | |
* @see #setDeterminerCode(EntityDeterminer) | |
* @see org.eclipse.mdht.uml.cda.CDAPackage#getPerson_DeterminerCode() | |
* @model default="INSTANCE" unsettable="true" ordered="false" | |
* extendedMetaData="name='determinerCode' kind='attribute'" | |
* @generated | |
*/ | |
EntityDeterminer getDeterminerCode(); | |
/** | |
* Sets the value of the '{@link org.eclipse.mdht.uml.cda.Person#getDeterminerCode <em>Determiner Code</em>}' attribute. | |
* <!-- begin-user-doc --> | |
* <!-- end-user-doc --> | |
* @param value the new value of the '<em>Determiner Code</em>' attribute. | |
* @see org.eclipse.mdht.uml.hl7.vocab.EntityDeterminer | |
* @see #isSetDeterminerCode() | |
* @see #unsetDeterminerCode() | |
* @see #getDeterminerCode() | |
* @generated | |
*/ | |
void setDeterminerCode(EntityDeterminer value); | |
/** | |
* Unsets the value of the '{@link org.eclipse.mdht.uml.cda.Person#getDeterminerCode <em>Determiner Code</em>}' attribute. | |
* <!-- begin-user-doc --> | |
* <!-- end-user-doc --> | |
* @see #isSetDeterminerCode() | |
* @see #getDeterminerCode() | |
* @see #setDeterminerCode(EntityDeterminer) | |
* @generated | |
*/ | |
void unsetDeterminerCode(); | |
/** | |
* Returns whether the value of the '{@link org.eclipse.mdht.uml.cda.Person#getDeterminerCode <em>Determiner Code</em>}' attribute is set. | |
* <!-- begin-user-doc --> | |
* <!-- end-user-doc --> | |
* @return whether the value of the '<em>Determiner Code</em>' attribute is set. | |
* @see #unsetDeterminerCode() | |
* @see #getDeterminerCode() | |
* @see #setDeterminerCode(EntityDeterminer) | |
* @generated | |
*/ | |
boolean isSetDeterminerCode(); | |
/** | |
* <!-- begin-user-doc --> | |
* <!-- end-user-doc --> | |
* <!-- begin-model-doc --> | |
* @param diagnostics The chain of diagnostics to which problems are to be appended. | |
* @param context The cache of context-specific information. | |
* <!-- end-model-doc --> | |
* @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<Object, Object> context); | |
/** | |
* <!-- begin-user-doc --> | |
* <!-- end-user-doc --> | |
* <!-- begin-model-doc --> | |
* @param diagnostics The chain of diagnostics to which problems are to be appended. | |
* @param context The cache of context-specific information. | |
* <!-- end-model-doc --> | |
* @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<Object, Object> context); | |
} // Person |