Difference between revisions of "The CTP XmlObject"
| Line 1: | Line 1: | ||
The CTP XmlObject is an XML file in any XML schema. To be useful, such an object must contain certain identifiers which allow it to be related to other objects obtained in a trial. The XmlObject provides some flexibility in the placement of those identifiers. This article describes the order in which the XmlObject searches for the identifiers. In all cases, the value of an identifier is defined to be the first value found. | The CTP XmlObject is an XML file in any XML schema. To be useful, such an object must contain certain identifiers which allow it to be related to other objects obtained in a trial. The XmlObject provides some flexibility in the placement of those identifiers. This article describes the order in which the XmlObject searches for the identifiers. In all cases, the value of an identifier is defined to be the first value found. | ||
| − | + | <b>UID</b> | |
#the <b>uid</b> attribute of the root element | #the <b>uid</b> attribute of the root element | ||
This attribute is required. The DICOM UID format is strongly suggested, but there is no technical requirement imposed by the the XmlObject on the format. | This attribute is required. The DICOM UID format is strongly suggested, but there is no technical requirement imposed by the the XmlObject on the format. | ||
| − | + | <b>Date</b> | |
#the <b>date</b> attribute of the root element | #the <b>date</b> attribute of the root element | ||
#the <b>study-date</b> attribute of the root element | #the <b>study-date</b> attribute of the root element | ||
| Line 11: | Line 11: | ||
This value is technically not required, but since the object automatically supplies its last-modified-date when the date is requested, a date is always available. | This value is technically not required, but since the object automatically supplies its last-modified-date when the date is requested, a date is always available. | ||
| − | + | <b>Description</b> | |
#the <b>description</b> child element of the root element | #the <b>description</b> child element of the root element | ||
#the <b>description</b> child of the first child of the root element | #the <b>description</b> child of the first child of the root element | ||
This value is not required. | This value is not required. | ||
| − | + | <b>Patient Name</b> | |
#the <b>pt-name</b> attribute of the root element | #the <b>pt-name</b> attribute of the root element | ||
#the <b>pt-name</b> child element of the root element | #the <b>pt-name</b> child element of the root element | ||
| Line 22: | Line 22: | ||
This value is not required. | This value is not required. | ||
| − | + | <b>Patient ID</b> | |
#the <b>pt-id</b> attribute of the root element | #the <b>pt-id</b> attribute of the root element | ||
#the <b>pt-id</b> child element of the root element | #the <b>pt-id</b> child element of the root element | ||
| Line 28: | Line 28: | ||
This value is technically not required, but it is required if the intent is to relate the object to other objects for the same patient. | This value is technically not required, but it is required if the intent is to relate the object to other objects for the same patient. | ||
| − | + | <b>Study UID</b> | |
#the <b>study-uid</b> attribute of the root element | #the <b>study-uid</b> attribute of the root element | ||
#the <b>StudyInstanceUID</b> attribute of the root element | #the <b>StudyInstanceUID</b> attribute of the root element | ||
Revision as of 15:27, 4 September 2008
The CTP XmlObject is an XML file in any XML schema. To be useful, such an object must contain certain identifiers which allow it to be related to other objects obtained in a trial. The XmlObject provides some flexibility in the placement of those identifiers. This article describes the order in which the XmlObject searches for the identifiers. In all cases, the value of an identifier is defined to be the first value found.
UID
- the uid attribute of the root element
This attribute is required. The DICOM UID format is strongly suggested, but there is no technical requirement imposed by the the XmlObject on the format.
Date
- the date attribute of the root element
- the study-date attribute of the root element
- the last-modified-date of the file
This value is technically not required, but since the object automatically supplies its last-modified-date when the date is requested, a date is always available.
Description
- the description child element of the root element
- the description child of the first child of the root element
This value is not required.
Patient Name
- the pt-name attribute of the root element
- the pt-name child element of the root element
- the pt-name child of the first child of the root element
This value is not required.
Patient ID
- the pt-id attribute of the root element
- the pt-id child element of the root element
- the pt-id child of the first child of the root element
This value is technically not required, but it is required if the intent is to relate the object to other objects for the same patient.
Study UID
- the study-uid attribute of the root element
- the StudyInstanceUID attribute of the root element
- the study-uid child element of the root element
- the StudyInstanceUID child element of the root element
- the study-uid child of the first child of the root element
- the StudyInstanceUID child of the first child of the root element
This value is technically not required, but it is required if the intent is to relate the object to other objects of the same study. The DICOM UID format is strongly suggested, but there is no technical requirement imposed by the the XmlObject on the format. Note that the DICOM UID format is required if the object is to be related to DicomObjects for the same study.