org.openhealthtools.mdht.uml.cda.SubjectPerson 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.BL;
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 'Subject Person'.
*
*
*
* The following features are supported:
*
* - {@link org.openhealthtools.mdht.uml.cda.SubjectPerson#getRealmCodes Realm Code}
* - {@link org.openhealthtools.mdht.uml.cda.SubjectPerson#getTypeId Type Id}
* - {@link org.openhealthtools.mdht.uml.cda.SubjectPerson#getTemplateIds Template Id}
* - {@link org.openhealthtools.mdht.uml.cda.SubjectPerson#getSDTCIds SDTC Id}
* - {@link org.openhealthtools.mdht.uml.cda.SubjectPerson#getNames Name}
* - {@link org.openhealthtools.mdht.uml.cda.SubjectPerson#getAdministrativeGenderCode Administrative Gender Code}
* - {@link org.openhealthtools.mdht.uml.cda.SubjectPerson#getBirthTime Birth Time}
* - {@link org.openhealthtools.mdht.uml.cda.SubjectPerson#getSDTCDeceasedInd SDTC Deceased Ind}
* - {@link org.openhealthtools.mdht.uml.cda.SubjectPerson#getSDTCDeceasedTime SDTC Deceased Time}
* - {@link org.openhealthtools.mdht.uml.cda.SubjectPerson#getNullFlavor Null Flavor}
* - {@link org.openhealthtools.mdht.uml.cda.SubjectPerson#getClassCode Class Code}
* - {@link org.openhealthtools.mdht.uml.cda.SubjectPerson#getDeterminerCode Determiner Code}
*
*
*
* @see org.openhealthtools.mdht.uml.cda.CDAPackage#getSubjectPerson()
* @model
* @generated
*/
public interface SubjectPerson 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#getSubjectPerson_RealmCode()
* @model containment="true" ordered="false"
* extendedMetaData="namespace='##targetNamespace'"
* @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#getSubjectPerson_TypeId()
* @model containment="true" ordered="false"
* extendedMetaData="namespace='##targetNamespace'"
* @generated
*/
InfrastructureRootTypeId getTypeId();
/**
* Sets the value of the '{@link org.openhealthtools.mdht.uml.cda.SubjectPerson#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#getSubjectPerson_TemplateId()
* @model containment="true" ordered="false"
* extendedMetaData="namespace='##targetNamespace'"
* @generated
*/
EList getTemplateIds();
/**
* Returns the value of the 'SDTC Id' containment reference list.
* The list contents are of type {@link org.openhealthtools.mdht.uml.hl7.datatypes.II}.
*
*
* If the meaning of the 'SDTC Id' containment reference list isn't clear,
* there really should be more of a description here...
*
*
* @return the value of the 'SDTC Id' containment reference list.
* @see org.openhealthtools.mdht.uml.cda.CDAPackage#getSubjectPerson_SDTCId()
* @model containment="true" ordered="false"
* extendedMetaData="name='id' namespace='urn:hl7-org:sdtc' kind='element'"
* @generated
*/
EList getSDTCIds();
/**
* 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#getSubjectPerson_Name()
* @model containment="true" ordered="false"
* extendedMetaData="namespace='##targetNamespace'"
* @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#getSubjectPerson_AdministrativeGenderCode()
* @model containment="true" ordered="false"
* extendedMetaData="namespace='##targetNamespace'"
* @generated
*/
CE getAdministrativeGenderCode();
/**
* Sets the value of the '{@link org.openhealthtools.mdht.uml.cda.SubjectPerson#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#getSubjectPerson_BirthTime()
* @model containment="true" ordered="false"
* extendedMetaData="namespace='##targetNamespace'"
* @generated
*/
TS getBirthTime();
/**
* Sets the value of the '{@link org.openhealthtools.mdht.uml.cda.SubjectPerson#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 'SDTC Deceased Ind' containment reference.
*
*
* If the meaning of the 'SDTC Deceased Ind' containment reference isn't clear,
* there really should be more of a description here...
*
*
* @return the value of the 'SDTC Deceased Ind' containment reference.
* @see #setSDTCDeceasedInd(BL)
* @see org.openhealthtools.mdht.uml.cda.CDAPackage#getSubjectPerson_SDTCDeceasedInd()
* @model containment="true" ordered="false"
* extendedMetaData="name='deceasedInd' namespace='urn:hl7-org:sdtc' kind='element'"
* @generated
*/
BL getSDTCDeceasedInd();
/**
* Sets the value of the '{@link org.openhealthtools.mdht.uml.cda.SubjectPerson#getSDTCDeceasedInd SDTC Deceased Ind}' containment reference.
*
*
* @param value the new value of the 'SDTC Deceased Ind' containment reference.
* @see #getSDTCDeceasedInd()
* @generated
*/
void setSDTCDeceasedInd(BL value);
/**
* Returns the value of the 'SDTC Deceased Time' containment reference.
*
*
* If the meaning of the 'SDTC Deceased Time' containment reference isn't clear,
* there really should be more of a description here...
*
*
* @return the value of the 'SDTC Deceased Time' containment reference.
* @see #setSDTCDeceasedTime(TS)
* @see org.openhealthtools.mdht.uml.cda.CDAPackage#getSubjectPerson_SDTCDeceasedTime()
* @model containment="true" ordered="false"
* extendedMetaData="name='deceasedTime' namespace='urn:hl7-org:sdtc' kind='element'"
* @generated
*/
TS getSDTCDeceasedTime();
/**
* Sets the value of the '{@link org.openhealthtools.mdht.uml.cda.SubjectPerson#getSDTCDeceasedTime SDTC Deceased Time}' containment reference.
*
*
* @param value the new value of the 'SDTC Deceased Time' containment reference.
* @see #getSDTCDeceasedTime()
* @generated
*/
void setSDTCDeceasedTime(TS value);
/**
* 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#getSubjectPerson_NullFlavor()
* @model unsettable="true" ordered="false"
* @generated
*/
NullFlavor getNullFlavor();
/**
* Sets the value of the '{@link org.openhealthtools.mdht.uml.cda.SubjectPerson#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.SubjectPerson#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.SubjectPerson#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#getSubjectPerson_ClassCode()
* @model default="PSN" unsettable="true" ordered="false"
* @generated
*/
EntityClass getClassCode();
/**
* Sets the value of the '{@link org.openhealthtools.mdht.uml.cda.SubjectPerson#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.SubjectPerson#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.SubjectPerson#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#getSubjectPerson_DeterminerCode()
* @model default="INSTANCE" unsettable="true" ordered="false"
* @generated
*/
EntityDeterminer getDeterminerCode();
/**
* Sets the value of the '{@link org.openhealthtools.mdht.uml.cda.SubjectPerson#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.SubjectPerson#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.SubjectPerson#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);
} // SubjectPerson