Object that contains the information of a single task. More...

Public Member Functions
string	get (string field)
	Gets the value of a given field. More...

Array< string >	getStudyUIDs ()
	Gets the StudyInstanceUIDs associated with the task. More...

Array< string >	getStudyIDs ()
	Gets the iPACS StudyIDs associated with the task. More...

Array< string >	getSeriesUIDs (string filterStudy="")
	Gets the SeriesInstanceUIDs associated with the task. More...

Array< string >	getSeriesIDs (string filterStudy="")
	Gets the SeriesInstanceUIDs associated with the task. More...

string	getDBPatientID ()
	Gets the Database Patient ID associated with the task. More...

string	getPatientID ()
	Gets the Patient ID associated with the task. More...

string	getTaskID ()
	Gets the task ID. More...

string	getScanID ()
	Gets the scan ID that the task is attached to. More...

string	getPrevTaskID ()
	Gets the previous visit's task ID. More...

string	getTaskType ()
	Gets the task type. More...

string	getFormName ()
	Gets the associated form name. More...

string	getProjectID ()
	Gets the project id. More...

string	getProjectPath ()
	Gets the project path. More...

string	getPriority ()
	Gets the priority value. More...

bool	isBlocked ()
	Gets whether the task is blocked. More...

string	getStatus ()
	Gets task's status. More...

bool	isEditable ()
	Gets task's editable status. More...

string	getPatientsName ()
	Gets the patient's name. More...

string	getTimepoint ()
	Gets the task's timepoint name. More...

string	getCategory ()
	Gets the task's category. More...

string	getSiteName ()
	Gets the task's site name. More...

string	getProcessID ()
	Gets the task's process instance id. More...

string	getProcessName ()
	Gets the task's process instance name. More...

string	getCreatedDate ()
	Gets the date the task was created. More...

Variant	getProperty (string propertyName)
	Gets a property of the task. More...

Variant	getProperty (Array< string > propertyChain)
	Gets a property of the task that is a property of other properties. More...

Detailed Description

Object that contains the information of a single task.

See also WorklistTool::getList() to obtain an array of this object.

Member Function Documentation

◆ get()

string get ( string field )

Gets the value of a given field.

Parameters

field the field name

Returns: The field's value as string

Deprecated:

◆ getCategory()

string getCategory ( )

Gets the task's category.

Returns: The task's category

◆ getCreatedDate()

string getCreatedDate ( )

Gets the date the task was created.

Returns: The date the task was created

◆ getDBPatientID()

string getDBPatientID ( )

Gets the Database Patient ID associated with the task.

Returns: The Database Patient ID associated with the task

Deprecated:

◆ getFormName()

string getFormName ( )

Gets the associated form name.

Returns: The associated form name

◆ getPatientID()

string getPatientID ( )

Gets the Patient ID associated with the task.

Returns: The Patient ID associated with the task

◆ getPatientsName()

string getPatientsName ( )

Gets the patient's name.

Returns: The patient's name

◆ getPrevTaskID()

string getPrevTaskID ( )

inline

Gets the previous visit's task ID.

Note: Will return the actual task ID if the workflow tool is supported on the IPACs, otherwise it will return nothing

Deprecated:

◆ getPriority()

string getPriority ( )

Gets the priority value.

Returns: The priority value

◆ getProcessID()

string getProcessID ( )

Gets the task's process instance id.

Returns: The task's process instance id

◆ getProcessName()

string getProcessName ( )

Gets the task's process instance name.

Returns: The task's process instance name

◆ getProjectID()

string getProjectID ( )

Gets the project id.

Returns: The project id

◆ getProjectPath()

string getProjectPath ( )

Gets the project path.

Returns: The project path

◆ getProperty() [1/2]

Variant getProperty ( Array< string > propertyChain )

Gets a property of the task that is a property of other properties.

Parameters

Array<string> propertyChain the list of properties – ex. {"foo", "bar"} would yield task["foo"]["bar"]

Returns: The value associated with the given keys for the task

◆ getProperty() [2/2]

Variant getProperty ( string propertyName )

Gets a property of the task.

Parameters

propertyName The name of the property to be looked up

Returns: The value associated with propertyName for the task

◆ getScanID()

string getScanID ( )

Gets the scan ID that the task is attached to.

Returns: The scan ID that the task is attached to

◆ getSeriesIDs()

Array<string> getSeriesIDs ( string filterStudy = "" )

Gets the SeriesInstanceUIDs associated with the task.

Parameters

filterStudy The StudyInstanceUID or StudyID filter. If none is provided, all the series from all studies will be returned.

Returns: The SeriesInstanceUIDs associated with the task

◆ getSeriesUIDs()

Array<string> getSeriesUIDs ( string filterStudy = "" )

Gets the SeriesInstanceUIDs associated with the task.

Parameters

filterStudy The StudyInstanceUID or StudyID filter. If none is provided, all the series from all studies will be returned.

Returns: The SeriesInstanceUIDs associated with the task

◆ getSiteName()

string getSiteName ( )

Gets the task's site name.

Returns: The task's site name

◆ getStatus()

string getStatus ( )

Gets task's status.

Deprecated:: No longer necessary with iPACS 2021

◆ getStudyIDs()

Array<string> getStudyIDs ( )

Gets the iPACS StudyIDs associated with the task.

Returns: The StudyIDs associated with the task

◆ getStudyUIDs()

Array<string> getStudyUIDs ( )

Gets the StudyInstanceUIDs associated with the task.

Returns: The StudyInstanceUIDs associated with the task

◆ getTaskID()

string getTaskID ( )

Gets the task ID.

Returns: The task ID

◆ getTaskType()

string getTaskType ( )

Gets the task type.

Returns: The task type

◆ getTimepoint()

string getTimepoint ( )

Gets the task's timepoint name.

Returns: The task's timepoint name

◆ isBlocked()

bool isBlocked ( )

Gets whether the task is blocked.

Returns: True if the task is blocked, false otherwise

◆ isEditable()

bool isEditable ( )

inline

Gets task's editable status.

Note: An editable task but whose edition is allowed and the previous existing data will be loaded in the form

Deprecated:

Public Member Functions

Detailed Description

Member Function Documentation

◆ get()

◆ getCategory()

◆ getCreatedDate()

◆ getDBPatientID()

◆ getFormName()

◆ getPatientID()

◆ getPatientsName()

◆ getPrevTaskID()

◆ getPriority()

◆ getProcessID()

◆ getProcessName()

◆ getProjectID()

◆ getProjectPath()

◆ getProperty() [1/2]

◆ getProperty() [2/2]

◆ getScanID()

◆ getSeriesIDs()

◆ getSeriesUIDs()

◆ getSiteName()

◆ getStatus()

◆ getStudyIDs()

◆ getStudyUIDs()

◆ getTaskID()

◆ getTaskType()

◆ getTimepoint()

◆ isBlocked()

◆ isEditable()