au.gov.nehta.model.clinical.diagnostic.imaging

Class ImagingExaminationResultImpl

java.lang.Object

au.gov.nehta.model.clinical.diagnostic.imaging.ImagingExaminationResultImpl

All Implemented Interfaces:

ImagingExaminationResult

public class ImagingExaminationResultImpl
extends Object
implements ImagingExaminationResult

ImagingExaminationResult

Findings and interpretation of an imaging examination, or series of examinations.

Field Summary

Fields

Modifier and Type	Field and Description
protected String	examinationProcedure
protected UniqueIdentifier	examinationProcedureID
protected UniqueIdentifier	id
protected PreciseDate	imageDateTime
protected Coded	imagingResultName
protected Coded	modality
protected UniqueIdentifier	nameId
protected Coded	overallResult
protected UniqueIdentifier	overallResultID
protected String	relatedImage
protected List<AnatomicalSite>	sites

Constructor Summary

Constructors

Constructor and Description
ImagingExaminationResultImpl() Construct an empty ImagingExaminationResult.
ImagingExaminationResultImpl(Coded overallResult, Coded imagingResultName, Coded modality, List<AnatomicalSite> sites, AnatomicalRegion anatomicalRegion, String examinationProcedure, PreciseDate imageDateTime, String relatedImage)

Method Summary

Modifier and Type	Method and Description
void	addAllAnatomicalSites(List<AnatomicalSite> sites)
void	addAnatomicalSite(AnatomicalSite site)
static ImagingExaminationResultImpl	base(Coded imagingResultName, Coded modality, Coded overallResult, PreciseDate imageDateTime, String examinationProcedure, AnatomicalRegion anatomicalRegion) Construct an image examination result with only the mandatory fields
AnatomicalRegion	getAnatomicalRegion() Region of body (e.g.
String	getExaminationProcedure() Additional details of imaging examination methodology followed.
UniqueIdentifier	getExaminationProcedureId() A UniqueIdentifier for the Examination Procedure, random guid if not explicitly defined
UniqueIdentifier	getId() A UniqueIdentifier for the test result, random guid if not explicitly defined
PreciseDate	getImageDateTime() Date, and optionally time, when an observation is clinically significant to the condition of the subject of the observation.
Coded	getImagingResultName() Identification of the imaging examination or procedure performed, typically including modality and anatomical location (including laterality).
UniqueIdentifier	getImagingResultNameId() A UniqueIdentifier for the test result name, random guid if not explicitly defined
Coded	getModality() The imaging method used to perform the examination
Coded	getOverallResultStatusCode() The status of the examination result as a whole.
UniqueIdentifier	getOverallResultStatusId() UUID This is a technical identifier that is used for system purposes such as matching.
String	getRelatedImage() A link to, or identifier of, information of interest Any URI, filename etc
UniqueIdentifier	getRelatedImageId() UUID This is a technical identifier that is used for system purposes such as matching.
List<AnatomicalSite>	getSites() Details about the anatomical locations to which this examination result refers.
void	setAnatomicalSites(List<AnatomicalSite> sites)
void	setExaminationProcedureId(UniqueIdentifier id)
void	setId(UniqueIdentifier id)
void	setImagingResultNameId(UniqueIdentifier nameId)
void	setOverallResultStatusId(UniqueIdentifier overallResultId)
void	setRelatedImage(String image)
void	setRelatedImageId(UniqueIdentifier id)
static ImagingExaminationResultImpl	withRelatedImage(Coded imagingResultName, Coded modality, Coded overallResult, PreciseDate imageDateTime, String examinationProcedure, AnatomicalRegion anatomicalRegion, String relatedImage) Construct an image examination result with optional sites.
static ImagingExaminationResultImpl	withSites(Coded imagingResultName, Coded modality, Coded overallResult, PreciseDate imageDateTime, String examinationProcedure, AnatomicalRegion anatomicalRegion, List<AnatomicalSite> sites) Construct an image examination result with optional sites.
static ImagingExaminationResultImpl	withSitesAndRelatedImage(Coded imagingResultName, Coded modality, Coded overallResult, PreciseDate imageDateTime, String examinationProcedure, AnatomicalRegion anatomicalRegion, List<AnatomicalSite> sites, String relatedImage) Construct an image examination result with optional sites and a relatedImage.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

id

protected UniqueIdentifier id

nameId

protected UniqueIdentifier nameId

examinationProcedureID

protected UniqueIdentifier examinationProcedureID

overallResultID

protected UniqueIdentifier overallResultID

overallResult

protected Coded overallResult

imagingResultName

protected Coded imagingResultName

modality

protected Coded modality

sites

protected List<AnatomicalSite> sites

examinationProcedure

protected String examinationProcedure

imageDateTime

protected PreciseDate imageDateTime

relatedImage

protected String relatedImage

Constructor Detail

ImagingExaminationResultImpl

public ImagingExaminationResultImpl(Coded overallResult,
                                    Coded imagingResultName,
                                    Coded modality,
                                    List<AnatomicalSite> sites,
                                    AnatomicalRegion anatomicalRegion,
                                    String examinationProcedure,
                                    PreciseDate imageDateTime,
                                    String relatedImage)

Parameters:

overallResult -

imagingResultName -

modality -

sites -

examinationProcedure -

imageDateTime -

relatedImage -

ImagingExaminationResultImpl

public ImagingExaminationResultImpl()

Construct an empty ImagingExaminationResult. You're responsible for correctly filling this one out.

alternately use the static constructors eg: ImagingExaminationResultImpl.withSites(..)

Method Detail

base

public static ImagingExaminationResultImpl base(Coded imagingResultName,
                                                Coded modality,
                                                Coded overallResult,
                                                PreciseDate imageDateTime,
                                                String examinationProcedure,
                                                AnatomicalRegion anatomicalRegion)

Construct an image examination result with only the mandatory fields

Parameters:

imagingResultName - Identification of the imaging examination or procedure performed, typically including modality and anatomical location (including laterality).

modality - The imaging method used to perform the examination.

overallResult - The status of the examination result as a whole.

imageDateTime - Date, and optionally time, when an observation is clinically significant to the condition of the subject of the observation.

examinationProcedure - Additional details of imaging examination methodology followed.

anatomicalRegion - Region of body (e.g. head, lower limb) that includes the anatomical locations of interest (e.g. jaw, foot).

The value of this element SHALL subsume all of the anatomical locations identified in Anatomical Site (ANATOMICAL LOCATION) (targetSiteCode and targetSiteCode/ original- Text) *

withSites

public static ImagingExaminationResultImpl withSites(Coded imagingResultName,
                                                     Coded modality,
                                                     Coded overallResult,
                                                     PreciseDate imageDateTime,
                                                     String examinationProcedure,
                                                     AnatomicalRegion anatomicalRegion,
                                                     List<AnatomicalSite> sites)

Construct an image examination result with optional sites.

Parameters:

imagingResultName - Identification of the imaging examination or procedure performed, typically including modality and anatomical location (including laterality).

modality - The imaging method used to perform the examination.

overallResult - The status of the examination result as a whole.

sites - anatomical sites

imageDateTime - Date, and optionally time, when an observation is clinically significant to the condition of the subject of the observation.

examinationProcedure - Additional details of imaging examination methodology followed.

anatomicalRegion - Region of body (e.g. head, lower limb) that includes the anatomical locations of interest (e.g. jaw, foot).

The value of this element SHALL subsume all of the anatomical locations identified in Anatomical Site (ANATOMICAL LOCATION) (targetSiteCode and targetSiteCode/ original- Text) *

withRelatedImage

public static ImagingExaminationResultImpl withRelatedImage(Coded imagingResultName,
                                                            Coded modality,
                                                            Coded overallResult,
                                                            PreciseDate imageDateTime,
                                                            String examinationProcedure,
                                                            AnatomicalRegion anatomicalRegion,
                                                            String relatedImage)

Construct an image examination result with optional sites.

Parameters:

imagingResultName - Identification of the imaging examination or procedure performed, typically including modality and anatomical location (including laterality).

modality - The imaging method used to perform the examination.

overallResult - The status of the examination result as a whole.

relatedImage - A link to, or identifier of, information of interest

imageDateTime - Date, and optionally time, when an observation is clinically significant to the condition of the subject of the observation.

examinationProcedure - Additional details of imaging examination methodology followed.

anatomicalRegion - Region of body (e.g. head, lower limb) that includes the anatomical locations of interest (e.g. jaw, foot).

The value of this element SHALL subsume all of the anatomical locations identified in Anatomical Site (ANATOMICAL LOCATION) (targetSiteCode and targetSiteCode/ original- Text)

withSitesAndRelatedImage

public static ImagingExaminationResultImpl withSitesAndRelatedImage(Coded imagingResultName,
                                                                    Coded modality,
                                                                    Coded overallResult,
                                                                    PreciseDate imageDateTime,
                                                                    String examinationProcedure,
                                                                    AnatomicalRegion anatomicalRegion,
                                                                    List<AnatomicalSite> sites,
                                                                    String relatedImage)

Construct an image examination result with optional sites and a relatedImage.

Parameters:

imagingResultName - Identification of the imaging examination or procedure performed, typically including modality and anatomical location (including laterality).

modality - The imaging method used to perform the examination.

overallResult - The status of the examination result as a whole.

sites - anatomical sites

imageDateTime - Date, and optionally time, when an observation is clinically significant to the condition of the subject of the observation.

relatedImage - A link to, or identifier of, information of interest

examinationProcedure - Additional details of imaging examination methodology followed.

anatomicalRegion - Region of body (e.g. head, lower limb) that includes the anatomical locations of interest (e.g. jaw, foot).

The value of this element SHALL subsume all of the anatomical locations identified in Anatomical Site (ANATOMICAL LOCATION) (targetSiteCode and targetSiteCode/ original- Text)

addAnatomicalSite

public void addAnatomicalSite(AnatomicalSite site)

addAllAnatomicalSites

public void addAllAnatomicalSites(List<AnatomicalSite> sites)

setAnatomicalSites

public void setAnatomicalSites(List<AnatomicalSite> sites)

getImagingResultName

public Coded getImagingResultName()

Description copied from interface: ImagingExaminationResult

Identification of the imaging examination or procedure performed, typically including modality and anatomical location (including laterality).

Specified by:

getImagingResultName in interface ImagingExaminationResult

getModality

public Coded getModality()

Description copied from interface: ImagingExaminationResult

The imaging method used to perform the examination

Specified by:

getModality in interface ImagingExaminationResult

getExaminationProcedure

public String getExaminationProcedure()

Description copied from interface: ImagingExaminationResult

Additional details of imaging examination methodology followed.

Specified by:

getExaminationProcedure in interface ImagingExaminationResult

getImageDateTime

public PreciseDate getImageDateTime()

Description copied from interface: ImagingExaminationResult

Date, and optionally time, when an observation is clinically significant to the condition of the subject of the observation.

Specified by:

getImageDateTime in interface ImagingExaminationResult

getId

public UniqueIdentifier getId()

A UniqueIdentifier for the test result, random guid if not explicitly defined

Specified by:

getId in interface ImagingExaminationResult

setId

public void setId(UniqueIdentifier id)

getImagingResultNameId

public UniqueIdentifier getImagingResultNameId()

A UniqueIdentifier for the test result name, random guid if not explicitly defined

Specified by:

getImagingResultNameId in interface ImagingExaminationResult

setImagingResultNameId

public void setImagingResultNameId(UniqueIdentifier nameId)

getExaminationProcedureId

public UniqueIdentifier getExaminationProcedureId()

A UniqueIdentifier for the Examination Procedure, random guid if not explicitly defined

Specified by:

getExaminationProcedureId in interface ImagingExaminationResult

setExaminationProcedureId

public void setExaminationProcedureId(UniqueIdentifier id)

getSites

public List<AnatomicalSite> getSites()

Description copied from interface: ImagingExaminationResult

Details about the anatomical locations to which this examination result refers.

Specified by:

getSites in interface ImagingExaminationResult

getOverallResultStatusCode

public Coded getOverallResultStatusCode()

Description copied from interface: ImagingExaminationResult

The status of the examination result as a whole.

Specified by:

getOverallResultStatusCode in interface ImagingExaminationResult

Returns:

code as HL7: Result Status

getOverallResultStatusId

public UniqueIdentifier getOverallResultStatusId()

Description copied from interface: ImagingExaminationResult

UUID This is a technical identifier that is used for system purposes such as matching. If a suitable internal key is not available, a UUID MAY be used.

Specified by:

getOverallResultStatusId in interface ImagingExaminationResult

setOverallResultStatusId

public void setOverallResultStatusId(UniqueIdentifier overallResultId)

getRelatedImage

public String getRelatedImage()

Description copied from interface: ImagingExaminationResult

A link to, or identifier of, information of interest Any URI, filename etc

Specified by:

getRelatedImage in interface ImagingExaminationResult

setRelatedImage

public void setRelatedImage(String image)

getRelatedImageId

public UniqueIdentifier getRelatedImageId()

Description copied from interface: ImagingExaminationResult

UUID This is a technical identifier that is used for system purposes such as matching. If a suitable internal key is not available, a UUID MAY be used.

Specified by:

getRelatedImageId in interface ImagingExaminationResult

setRelatedImageId

public void setRelatedImageId(UniqueIdentifier id)

getAnatomicalRegion

public AnatomicalRegion getAnatomicalRegion()

Description copied from interface: ImagingExaminationResult

Region of body (e.g. head, lower limb) that includes the anatomical locations of interest (e.g. jaw, foot).

Anatomical Region The value of this element SHALL subsume all of the anatomical locations identified in Anatomical Site (ANATOMICAL LOCATION) (targetSiteCode and targetSiteCode/ original- Text).

Specified by:

getAnatomicalRegion in interface ImagingExaminationResult