IDLffDicomExQuery Properties

IDLffDicomExQuery objects have the following properties. Properties with the word "Yes" in the "Get" column of the property table can be retrieved via IDLffDicomExQuery::GetProperty. Properties with the word "Yes" in the "Init" column of the property table can be set via IDLffDicomExQuery::Init. Properties with the word "Yes" in the "Set" column in the property table can be set via IDLffDicomExQuery::SetProperty.

Note
For a discussion of the property description tables shown below, see About Object Property Descriptions. Tables for properties of this object do not include the DICOM Attribute or Multi-value fields.

There are two categories of properties for this object: general properties and query field properties.

The IDLffDicomExQuery object has the following properties:

ACCESSION_NUMBER

This query field property represents the Accession Number attribute (0008,0050). If this property is not set, the query is issued with this property set to a null string.

This property is used by the IDLffDicomExQuery::Query method. See Query Property Interactions With Query Model/Level to determine when this property can be used in a specific query.

CALLBACK_DATA

This general property contains data that is to be passed to the function defined by the CALLBACK_FUNCTION property when a callback is initiated. If this property is not set, the integer value zero is passed to the callback function. See Using Callbacks with the IDLffDicomExQuery Object for additional details.

This property is used by the IDLffDicomExQuery::Query and IDLffDicomExQuery::Retrieve methods.

CALLBACK_FUNCTION

This general property contains the name of an IDL function to be called by the Query and Retrieve methods. If no value is defined, no callback is initiated. See Using Callbacks with the IDLffDicomExQuery Object for additional details.

This property is used by the IDLffDicomExQuery::Query and IDLffDicomExQuery::Retrieve methods.

FAMILY_NAME

This query field property represents the family name (last name) associated with a patient record.

Note
The Family_Name, Given_Name, Middle_Name, Prefix, and Suffix properties are combined to populate the DICOM Patient Name attribute (0010,0010). If the Patient_Name property is set, this property is ignored.

If a query uses the PATIENT_NAME property but no value is specified for either the Patient_Name property or this property, the query is issued with Family_Name set to a null string.

This property is used by the IDLffDicomExQuery::Query method. See Query Property Interactions With Query Model/Level to determine when this property can be used in a specific query.

GIVEN_NAME

This query field property represents the given name (first name) associated with a patient record.

Note
The Family_Name, Given_Name, Middle_Name, Prefix, and Suffix properties are combined to populate the DICOM Patient Name attribute (0010,0010). If the Patient_Name property is set, this property is ignored.

If a query uses the PATIENT_NAME property but no value is specified for either the Patient_Name property or this property, the query is issued with Given_Name set to a null string.

This property is used by the IDLffDicomExQuery::Query method. See Query Property Interactions With Query Model/Level to determine when this property can be used in a specific query.

INSTANCE_NUMBER

This query field property represents the Instance Number attribute (0020,0013). If this property is not set, the query is issued with this property set to a null string.

This property is used by the IDLffDicomExQuery::Query method. See Query Property Interactions With Query Model/Level to determine when this property can be used in a specific query.

MIDDLE_NAME

This query field property represents the middle name associated with a patient record.

Note
The Family_Name, Given_Name, Middle_Name, Prefix, and Suffix properties are combined to populate the DICOM Patient Name attribute (0010,0010). If the Patient_Name property is set, this property is ignored.

If a query uses the PATIENT_NAME property but no value is specified for either the Patient_Name property or this property, the query is issued with Middle_Name set to a null string.

This property is used by the IDLffDicomExQuery::Query method. See Query Property Interactions With Query Model/Level to determine when this property can be used in a specific query.

MODALITY

This query field property represents the Modality attribute (0008,0060). If this property is not set, the query is issued with this property set to a null string.

This property is used by the IDLffDicomExQuery::Query method. See Query Property Interactions With Query Model/Level to determine when this property can be used in a specific query.

PATIENT_ID

This query field property represents the Patient ID attribute (0010,0020). If this property is not set and the query level is "patient" or "study," the query is issued with this property set to "*". If this property is not set and the query level is "series" or "image," the query is issued with this property set to a null string.

This property is used by the IDLffDicomExQuery::Query method. See Query Property Interactions With Query Model/Level to determine when this property can be used in a specific query.

PATIENT_NAME

This query field property represents the Patient ID attribute (0010,0010).

Note
The Family_Name, Given_Name, Middle_Name, Prefix, and Suffix properties are combined to populate the DICOM Patient Name attribute (0010,0010). If the Patient_Name property is set, all the other name properties are ignored.

The Patient_Name property string comprises the five name sub-properties, separated by the "^" character:

Family Name^Given Name^Middle Name^Prefix^Suffix 

If any of the sub-properties are omitted, you must substitute an empty string in the correct location. For example, to specify a Patient_Name without a middle name:

Family Name^Given Name^^Prefix^Suffix 

See PN for details.

If a query uses this query field but no value is specified for this property, IDL constructs the value of the Patient_Name property from the values of the Family_Name, Given_Name, Middle_Name, Prefix, and Suffix properties.

This property is used by the IDLffDicomExQuery::Query method. See Query Property Interactions With Query Model/Level to determine when this property can be used in a specific query.

PREFIX

This query field property represents the title (or honorific) associated with a patient record.

Note
The Family_Name, Given_Name, Middle_Name, Prefix, and Suffix properties are combined to populate the DICOM Patient Name attribute (0010,0010). If the Patient_Name property is set, this property is ignored.

If a query uses the PATIENT_NAME property but no value is specified for either the Patient_Name property or this property, the query is issued with Prefix set to a null string.

This property is used by the IDLffDicomExQuery::Query method. See Query Property Interactions With Query Model/Level to determine when this property can be used in a specific query.

QUERY_LEVEL

This general property sets the query level to be used in a query. Valid values are:

Warning
The default value of zero is not a valid value if the QUERY_MODEL property is set equal to one. Attempting to set QUERY_LEVEL=0 and QUERY_MODEL=1 will generate a warning message, and QUERY_LEVEL will automatically be set equal to one.

Because the default value for QUERY_LEVEL is zero, you should set the value of this property before setting the value of QUERY_MODEL to avoid receiving the error message.

This property is used by the IDLffDicomExQuery::Query and IDLffDicomExQuery::Retrieve methods.

QUERY_MODEL

This general property sets the query model to be used in a query. Valid values are:

If this property is not set, the query is issued with this property set to zero (Patient Root).

Warning
Attempting to set QUERY_LEVEL=0 and QUERY_MODEL=1 will generate a warning message, and QUERY_LEVEL will automatically be set equal to one.

This property is used by the IDLffDicomExQuery::Query and IDLffDicomExQuery::Retrieve methods.

QUERY_SCP

This general property specifies the Application Entity name of the node to be queried. The Application Entity name must be defined in the DICOM Network Services configuration file.

Note
This property must be set prior to calling the Query or Retrieve methods.

This property is used by the IDLffDicomExQuery::Query, IDLffDicomExQuery::QueryModelsSupported, and IDLffDicomExQuery::Retrieve methods.

SERIES_INSTANCE_UID

This query field property represents the Series Instance UID attribute (0020,000E). If this property is not set, the query is issued with this property set to a null string.

This property is used by the IDLffDicomExQuery::Query method. See Query Property Interactions With Query Model/Level to determine when this property can be used in a specific query.

SERIES_NUMBER

This query field property represents the Series Number attribute (0020,0011). If this property is not set, the query is issued with this property set to a null string.

This property is used by the IDLffDicomExQuery::Query method. See Query Property Interactions With Query Model/Level to determine when this property can be used in a specific query.

SOP_INSTANCE_UID

This query field property represents the SOP Instance UID attribute (0008,0018). If this property is not set, the query is issued with this property set to a null string.

This property is used by the IDLffDicomExQuery::Query method. See Query Property Interactions With Query Model/Level to determine when this property can be used in a specific query.

STORAGE_SCP

This general property specifies the Application Entity name of the Storage SCP node that receives retrieved files. The Application Entity name must be defined in the DICOM Network Services configuration file.

Note
This property must be set prior to calling the Retrieve method.

This property is used by the IDLffDicomExQuery::Retrieve method.

STUDY_DATE

This query field property represents the Study Date attribute (0008,0020). If this property is not set, the query is issued with this property set to a null string.

This property is used by the IDLffDicomExQuery::Query method. See Query Property Interactions With Query Model/Level to determine when this property can be used in a specific query.

STUDY_ID

This query field property represents the Study ID attribute (0020,0010). If this property is not set, the query is issued with this property set to a null string.

This property is used by the IDLffDicomExQuery::Query method. See Query Property Interactions With Query Model/Level to determine when this property can be used in a specific query.

STUDY_INSTANCE_UID

This query field property represents the Study Instance UID attribute (0020,000D). If this property is not set, the query is issued with this property set to a null string.

This property is used by the IDLffDicomExQuery::Query method. See Query Property Interactions With Query Model/Level to determine when this property can be used in a specific query.

STUDY_TIME

This query field property represents the Study Time attribute (0008,0030). If this property is not set, the query is issued with this property set to a null string.

This property is used by the IDLffDicomExQuery::Query method. See Query Property Interactions With Query Model/Level to determine when this property can be used in a specific query.

SUFFIX

This query field property represents the name suffix (Jr. or Sr., for example) associated with a patient record.

Note
The Family_Name, Given_Name, Middle_Name, Prefix, and Suffix properties are combined to populate the DICOM Patient Name attribute (0010,0010). If the Patient_Name property is set, this property is ignored.

If a query uses the PATIENT_NAME property but no value is specified for either the Patient_Name property or this property, the query is issued with Suffix set to a null string.

This property is used by the IDLffDicomExQuery::Query method. See Query Property Interactions With Query Model/Level to determine when this property can be used in a specific query.