org.hl7.rim

Interface LivingSubject

public interface LivingSubject extends RimObject, Entity

Interface for RIM class LivingSubject.

A subtype of Entity representing an organism or complex animal, alive or not.

Examples: A person, dog, microorganism or a plant of any taxonomic group.

Constraints: Instances of this class encompass mammals, birds, fishes, bacteria, parasites, fungi and viruses. Person is a specialization of this class.

Rationale: This class contains "static" or "administrative" attributes of interest to medicine that differentiate living organisms from other Entities.

Method Summary
CEgetAdministrativeGenderCode()
Gets attribute administrativeGenderCode of type CE and cardinality 0..1.
TSgetBirthTime()
Gets attribute birthTime of type TS and cardinality 0..1.
BLgetDeceasedInd()
Gets attribute deceasedInd of type BL and cardinality 0..1.
TSgetDeceasedTime()
Gets attribute deceasedTime of type TS and cardinality 0..1.
BLgetMultipleBirthInd()
Gets attribute multipleBirthInd of type BL and cardinality 0..1.
INTgetMultipleBirthOrderNumber()
Gets attribute multipleBirthOrderNumber of type INT and cardinality 0..1.
BLgetOrganDonorInd()
Gets attribute organDonorInd of type BL and cardinality 0..1.
voidsetAdministrativeGenderCode(CE value)
Sets attribute administrativeGenderCode of type CE and cardinality 0..1.
voidsetBirthTime(TS value)
Sets attribute birthTime of type TS and cardinality 0..1.
voidsetDeceasedInd(BL value)
Sets attribute deceasedInd of type BL and cardinality 0..1.
voidsetDeceasedTime(TS value)
Sets attribute deceasedTime of type TS and cardinality 0..1.
voidsetMultipleBirthInd(BL value)
Sets attribute multipleBirthInd of type BL and cardinality 0..1.
voidsetMultipleBirthOrderNumber(INT value)
Sets attribute multipleBirthOrderNumber of type INT and cardinality 0..1.
voidsetOrganDonorInd(BL value)
Sets attribute organDonorInd of type BL and cardinality 0..1.

Method Detail

getAdministrativeGenderCode

public CE getAdministrativeGenderCode()
Gets attribute administrativeGenderCode of type CE and cardinality 0..1.

A value representing the gender (sex) of a Living subject.

Examples: female, male

Discussion: This attribute does not include terms related to clinical gender. Gender is a complex physiological, genetic and sociological concept that requires multiple observations in order to be comprehensively described. The purpose of this attribute is to provide a high level classification that can additionally be used for the appropriate allocation of inpatient bed assignment.

Constraints: This code is used for administrative purposes.

Returns: the attribute value

getBirthTime

public TS getBirthTime()
Gets attribute birthTime of type TS and cardinality 0..1.

The date and time of a living subject's birth or hatching.

Returns: the attribute value

getDeceasedInd

public BL getDeceasedInd()
Gets attribute deceasedInd of type BL and cardinality 0..1.

An indication that the subject is dead.

Returns: the attribute value

getDeceasedTime

public TS getDeceasedTime()
Gets attribute deceasedTime of type TS and cardinality 0..1.

The date and time that a living subject's death occurred.

Returns: the attribute value

getMultipleBirthInd

public BL getMultipleBirthInd()
Gets attribute multipleBirthInd of type BL and cardinality 0..1.

An indication as to whether the living subject is part of a multiple birth.

Returns: the attribute value

getMultipleBirthOrderNumber

public INT getMultipleBirthOrderNumber()
Gets attribute multipleBirthOrderNumber of type INT and cardinality 0..1.

The order in which this living subject was born if part of a multiple birth.

Returns: the attribute value

getOrganDonorInd

public BL getOrganDonorInd()
Gets attribute organDonorInd of type BL and cardinality 0..1.

An indication that the living subject is a candidate to serve as an organ donor.

Discussion: This attribute specifies whether an individual living subject has donated or is willing to donate an organ.

Returns: the attribute value

setAdministrativeGenderCode

public void setAdministrativeGenderCode(CE value)
Sets attribute administrativeGenderCode of type CE and cardinality 0..1.

A value representing the gender (sex) of a Living subject.

Examples: female, male

Discussion: This attribute does not include terms related to clinical gender. Gender is a complex physiological, genetic and sociological concept that requires multiple observations in order to be comprehensively described. The purpose of this attribute is to provide a high level classification that can additionally be used for the appropriate allocation of inpatient bed assignment.

Constraints: This code is used for administrative purposes.

Parameters: value the new attribute value

setBirthTime

public void setBirthTime(TS value)
Sets attribute birthTime of type TS and cardinality 0..1.

The date and time of a living subject's birth or hatching.

Parameters: value the new attribute value

setDeceasedInd

public void setDeceasedInd(BL value)
Sets attribute deceasedInd of type BL and cardinality 0..1.

An indication that the subject is dead.

Parameters: value the new attribute value

setDeceasedTime

public void setDeceasedTime(TS value)
Sets attribute deceasedTime of type TS and cardinality 0..1.

The date and time that a living subject's death occurred.

Parameters: value the new attribute value

setMultipleBirthInd

public void setMultipleBirthInd(BL value)
Sets attribute multipleBirthInd of type BL and cardinality 0..1.

An indication as to whether the living subject is part of a multiple birth.

Parameters: value the new attribute value

setMultipleBirthOrderNumber

public void setMultipleBirthOrderNumber(INT value)
Sets attribute multipleBirthOrderNumber of type INT and cardinality 0..1.

The order in which this living subject was born if part of a multiple birth.

Parameters: value the new attribute value

setOrganDonorInd

public void setOrganDonorInd(BL value)
Sets attribute organDonorInd of type BL and cardinality 0..1.

An indication that the living subject is a candidate to serve as an organ donor.

Discussion: This attribute specifies whether an individual living subject has donated or is willing to donate an organ.

Parameters: value the new attribute value