Class Patient

Represents a patient.

Inheritance

System.Object

SerializableObject

ApiDataObject

Patient

Implements

System.Xml.Serialization.IXmlSerializable

Inherited Members

ApiDataObject.ToString()

ApiDataObject.Equals(Object)

ApiDataObject.GetHashCode()

ApiDataObject.Id

ApiDataObject.Name

ApiDataObject.Comment

ApiDataObject.HistoryUserName

ApiDataObject.HistoryUserDisplayName

ApiDataObject.HistoryDateTime

SerializableObject.GetSchema()

SerializableObject.ReadXml(XmlReader)

SerializableObject.ClearSerializationHistory()

System.Object.Equals(System.Object, System.Object)

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.GetType()

System.Object.MemberwiseClone()

Namespace: VMS.TPS.Common.Model.API

Assembly: VMS.TPS.Common.Model.API.dll

Syntax

public class Patient : ApiDataObject, IXmlSerializable

Properties

Courses

A collection of the patient's courses.

Declaration

public IEnumerable<Course> Courses { get; }

Property Value

Type	Description
System.Collections.Generic.IEnumerable<Course>

CreationDateTime

The date when this object was created.

Declaration

public DateTime? CreationDateTime { get; }

Property Value

Type	Description
System.Nullable<System.DateTime>

DateOfBirth

The date of birth of the patient.

Declaration

public DateTime? DateOfBirth { get; }

Property Value

Type	Description
System.Nullable<System.DateTime>

FirstName

The first name of the patient.

Declaration

public string FirstName { get; set; }

Property Value

Type	Description
System.String

HasModifiedData

Returns true if the patient object tree has been modified.

Declaration

public bool HasModifiedData { get; }

Property Value

Type	Description
System.Boolean

Hospital

The hospital.

Declaration

public Hospital Hospital { get; }

Property Value

Type	Description
Hospital

Id2

The patient ID2.

Declaration

public string Id2 { get; }

Property Value

Type	Description
System.String

LastName

The last name of the patient.

Declaration

public string LastName { get; set; }

Property Value

Type	Description
System.String

MiddleName

The middle name of the patient.

Declaration

public string MiddleName { get; set; }

Property Value

Type	Description
System.String

PrimaryOncologistId

The identifier of the primary oncologist.

Declaration

public string PrimaryOncologistId { get; }

Property Value

Type	Description
System.String

ReferencePoints

Collection of all reference points for the patient.

Declaration

public IEnumerable<ReferencePoint> ReferencePoints { get; }

Property Value

Type	Description
System.Collections.Generic.IEnumerable<ReferencePoint>

Registrations

A collection of registrations.

Declaration

public IEnumerable<Registration> Registrations { get; }

Property Value

Type	Description
System.Collections.Generic.IEnumerable<Registration>

Sex

The gender of the patient.

Declaration

public string Sex { get; }

Property Value

Type	Description
System.String

SSN

The Social Security Account Number (SSN) of the patient.

Declaration

public string SSN { get; }

Property Value

Type	Description
System.String

StructureSets

A collection of structure sets.

Declaration

public IEnumerable<StructureSet> StructureSets { get; }

Property Value

Type	Description
System.Collections.Generic.IEnumerable<StructureSet>

Studies

A collection of studies.

Declaration

public IEnumerable<Study> Studies { get; }

Property Value

Type	Description
System.Collections.Generic.IEnumerable<Study>

Methods

AddCourse()

[Availability of this method depends on your Eclipse Scripting API license] Attaches a new course to this patient.

Declaration

public Course AddCourse()

Returns

Type	Description
Course	The new course.

AddEmptyPhantom(String, PatientOrientation, Int32, Int32, Double, Double, Int32, Double)

[Availability of this method depends on your Eclipse Scripting API license] Adds an empty phantom image to the patient. The empty image is created in a new study. A new structure set is created for the image.

Declaration

public StructureSet AddEmptyPhantom(string imageId, PatientOrientation orientation, int xSizePixel, int ySizePixel, double widthMM, double heightMM, int nrOfPlanes, double planeSepMM)

Parameters

Type	Name	Description
System.String	imageId	The identifier for the empty image to be created. The value must not be empty.
PatientOrientation	orientation	The patient orientation in the image.
System.Int32	xSizePixel	The x size of the image in pixels. The expected value is from 23 to 2048 pixels.
System.Int32	ySizePixel	The y size of the image in pixels. The expected value is from 23 to 2048 pixels.
System.Double	widthMM	The height of the image in millimeters. The expected value is from 10.0 to 2000.0 millimeters.
System.Double	heightMM	The width of the image in millimeters. The expected value is from 10.0 to 2000.0 millimeters.
System.Int32	nrOfPlanes	The number of planes in the image. The expected value is from 1 to 10000.
System.Double	planeSepMM	The distance between the planes in millimeters. The expected value is from 0.1 to 200.0 millimeters.

Returns

Type	Description
StructureSet	The structure set associated with the new empty image.

AddReferencePoint(Boolean, String)

[Availability of this method depends on your Eclipse Scripting API license] Add reference point to a patient

Declaration

public ReferencePoint AddReferencePoint(bool target, string id)

Parameters

Type	Name	Description
System.Boolean	target	True if point being added is for target volume
System.String	id	Identifier for the new reference point

Returns

Type	Description
ReferencePoint	Upon success, new reference point with 'id', failure throws ArgumentException

BeginModifications()

Enables write-access to the data model from the Scripting API. This function must be called for each patient the script modifies. If this function is not called, the data in the database cannot be modified.

Declaration

public void BeginModifications()

Remarks

The method CanModifyData() can be used to check if the system allows write-access to the data model.

CanAddCourse()

Checks if a new course can be added to the patient.

Declaration

public bool CanAddCourse()

Returns

Type	Description
System.Boolean	true if a new course can be added to the patient.

CanAddEmptyPhantom(out String)

Checks if an empty phantom can be added to the patient. The user should have the appropriate permissions to perform the operation.

Declaration

public bool CanAddEmptyPhantom(out string errorMessage)

Parameters

Type	Name	Description
System.String	errorMessage	If phantom adding is not permitted, contains the error message.

Returns

Type	Description
System.Boolean	true, if the phantom image can be added to the patient.

CanCopyImageFromOtherPatient(Study, String, String, String, out String)

Checks if the image can be copied from the other patient.

Declaration

public bool CanCopyImageFromOtherPatient(Study targetStudy, string otherPatientId, string otherPatientStudyId, string otherPatient3DImageId, out string errorMessage)

Parameters

Type	Name	Description
Study	targetStudy	The target study for the new image series, or null.
System.String	otherPatientId	The identifier of the other patient.
System.String	otherPatientStudyId	The identifier of the other patient's study. If null or empty, the system tries to find the image using only the 3D image identifier.
System.String	otherPatient3DImageId	The identifier of the other patient's 3D image.
System.String	errorMessage	If copying the image is not permitted, contains the error message.

Returns

Type	Description
System.Boolean	true, if the image can be copied from the other patient.

CanModifyData()

Returns true if the script can modify patient data in the database.

Declaration

public bool CanModifyData()

Returns

Type	Description
System.Boolean	true if the script can modify patient data in the database. Otherwise false.

CanRemoveCourse(Course)

Checks if the course can be removed from the patient.

Declaration

public bool CanRemoveCourse(Course course)

Parameters

Type	Name	Description
Course	course	The course to be removed.

Returns

Type	Description
System.Boolean	true if the course can be removed from the patient.

CanRemoveEmptyPhantom(StructureSet, out String)

Checks if the image can be removed. The image to be removed and the associated structure set should be empty.

Declaration

public bool CanRemoveEmptyPhantom(StructureSet structureset, out string errorMessage)

Parameters

Type	Name	Description
StructureSet	structureset	The structure set to be removed.
System.String	errorMessage	If the image and associated structure set cannot be removed, contains the error message.

Returns

Type	Description
System.Boolean	true, if the image is empty and can be removed from the patient.

CopyImageFromOtherPatient(String, String, String)

[Availability of this method depends on your Eclipse Scripting API license] Copies an image from an other patient to this patient. A new study and series is created for the image. The method CanCopyImageFromOtherPatient(Study, String, String, String, out String) can be used to check if copying the image is possible.

Declaration

public StructureSet CopyImageFromOtherPatient(string otherPatientId, string otherPatientStudyId, string otherPatient3DImageId)

Parameters

Type	Name	Description
System.String	otherPatientId	The identifier of the other patient.
System.String	otherPatientStudyId	The identifier of the other patient's study. If null or empty, the system tries to find the image using only the 3D image identifier.
System.String	otherPatient3DImageId	The identifier of the other patient's 3D image.

Returns

Type	Description
StructureSet	The structure set of the copied 3D image.

Exceptions

Type	Condition
System.ArgumentException	The exception is thrown if the patient is the current patient, or the patient is not found, or the image is not found.

CopyImageFromOtherPatient(Study, String, String, String)

[Availability of this method depends on your Eclipse Scripting API license] Copies an image from an other patient to the given study. A new series is created for the image. The method CanCopyImageFromOtherPatient(Study, String, String, String, out String) can be used to check if copying the image is possible.

Declaration

public StructureSet CopyImageFromOtherPatient(Study targetStudy, string otherPatientId, string otherPatientStudyId, string otherPatient3DImageId)

Parameters

Type	Name	Description
Study	targetStudy	The target study for the new image series.
System.String	otherPatientId	The identifier of the other patient.
System.String	otherPatientStudyId	The identifier of the other patient's study. If null or empty, the system tries to find the image using only the 3D image identifier.
System.String	otherPatient3DImageId	The identifier of the other patient's 3D image.

Returns

Type	Description
StructureSet	The structure set of the copied 3D image.

Exceptions

Type	Condition
System.ArgumentException	The exception is thrown if the patient is the current patient, or the patient is not found, or the image is not found.

RemoveCourse(Course)

[Availability of this method depends on your Eclipse Scripting API license] Removes the course from the patient and deletes it.

Declaration

public void RemoveCourse(Course course)

Parameters

Type	Name	Description
Course	course	The course that is removed.

RemoveEmptyPhantom(StructureSet)

[Availability of this method depends on your Eclipse Scripting API license] Removes an empty image from the patient. The associated structure set is also removed. The image to be removed and the associated structure set should be empty.

Declaration

public void RemoveEmptyPhantom(StructureSet structureset)

Parameters

Type	Name	Description
StructureSet	structureset	The structure set to be removed.

WriteXml(XmlWriter)

Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see System.Xml.Serialization.XmlSerializer.

Declaration

public override void WriteXml(XmlWriter writer)

Parameters

Type	Name	Description
System.Xml.XmlWriter	writer	The System.Xml.XmlWriter stream, to which the object is serialized.

Overrides

ApiDataObject.WriteXml(XmlWriter)

Implements

System.Xml.Serialization.IXmlSerializable