Database Table Descriptions

Following are description of the tables in the dcm4chee database schema.

Core DICOM Tables

patient

Column Description
pk The primary key
merge_fk Foreign key to a record in this table, pointing to a patient that this patient has been merged with.
pat_id The patient id (0010,0020).
pat_id_issuer The issuer of the patient id (0010,0021).
pat_name The patient name in DICOM format (0010,0010).
pat_i_name Ideographic representation of the patient name.
pat_p_name Phonetic representation of the patient name.
pat_birthdate The patient's birth date (0010,0030).
pat_sex The patient's gender (0010,0040).
created_time When the record was created in the database.
updated_time When the record in the database was last updated.
pat_attrs DICOM dataset containing patient attributes.
pat_custom1 Custom configurable C-FIND matching key. See DCMEE-438
pat_custom2 Custom configurable C-FIND matching key. See DCMEE-438
pat_custom3 Custom configurable C-FIND matching key. See DCMEE-438

study

Column Description
pk The primary key
patient_fk Foreign key reference to the patient.
study_iuid DICOM Study Instance UID (0020,000D).
study_id DICOM Study ID (0020,0010).
study_datetime Timestamp containing the study date (0008,0020) and time (0008,0030).
accession_no The accession number that the study was performed under (0008,0050).
ref_physician The referring physician name (0008,0090).
ref_phys_i_name Ideographic representation of the referring physician name.
ref_phys_p_name Phonetic representation of the referring physician name.
study_desc The DICOM study description (0008,1030).
study_custom1 Custom configurable C-FIND matching key. See DCMEE-438
study_custom2 Custom configurable C-FIND matching key. See DCMEE-438
study_custom3 Custom configurable C-FIND matching key. See DCMEE-438
study_status The status of the study in terms of any related GPWL items (see Study Status Service). Defined by codes in the Code table. Aside from use in the GPWL implementation it is also used as a status code in the Study Reconciliation Service. Usage in the Study Reconciliation Service is mutually exclusive to the other uses. The default is 0 (no status).
study_status_id The DICOM study status id (0032,000A).
mods_in_study The modalities which were involved in the study (0008,0061).
num_series The number of series within the study (0020,1206).
num_instances The number of instances within the study (0020,1208).
ext_retr_aet External retrieve AET. Study instances get marked externally retrievable if dcm4chee sends a StgCmt request and gets a SUCCESS response with populated retrieve AET attribute.
retrieve_aets The AE titles which may retrieve the study (0008,0054).
fileset_iuid The DICOM media storage fileset UID (0088,0130),
fileset_id The DICOM media storage fileset ID (0088,0140).
availability Instance Availability (0008,0056) which defines how rapidly all composite object instances of this study become available for transmission after a C-MOVE retrieval request.
  • ONLINE = 0
  • NEARLINE = 1
  • OFFLINE = 2
  • UNAVAILABLE = 3
checked_time The last time the study was consistency checked.
created_time When the record was created in the database.
updated_time When the record in the database was last updated.
study_attrs DICOM dataset containing study attributes.

series

Column Description
pk The primary key
study_fk Foreign key reference to the study.
mpps_fk Foreign key reference to the MPPS.
series_iuid DICOM Series Instance UID (0020,000E)
series_no DICOM Series Number (0020,0011)
modality DICOM Modality (0008,0060)
body_part DICOM Body Part Examined (0018,0015)
laterality DICOM Laterality (0018,0015)
series_desc DICOM Series Description (0008,103E)
institution DICOM Institution Name (0008,0080)
station_name DICOM Station Name (0008,1010)
department DICOM Institutional Department Name (0008,1040)
pps_date Timestamp containing the PPS start date (0040,0244) and time (0040,0245).
pps_iuid DICOM Referenced SOP Instance UID (0008,1155) from Referenced Performed Procedure Step Sequence (0008,1111)
series_custom1 Custom configurable C-FIND matching key. See DCMEE-438
series_custom2 Custom configurable C-FIND matching key. See DCMEE-438
series_custom3 Custom configurable C-FIND matching key. See DCMEE-438
num_instances DICOM Number Of Series Related Instances (0020,1209)
src_aet Calling AET which send the series into the archive
ext_retr_aet External retrieve AET. Series instances get marked externally retrievable if dcm4chee sends a StgCmt request and gets a SUCCESS response with populated retrieve AET attribute.
retrieve_aets Retrieve AET where the Series instances are stored
fileset_iuid The DICOM media storage fileset UID (0088,0130),
fileset_id The DICOM media storage fileset ID (0088,0140).
availability Instance Availability (0008,0056) which defines how rapidly all composite object instances of this series become available for transmission after a C-MOVE retrieval request.
  • ONLINE = 0
  • NEARLINE = 1
  • OFFLINE = 2
  • UNAVAILABLE = 3
series_status MISSING
created_time When the record was created in the database.
updated_time When the record in the database was last updated.
series_attrs DICOM dataset containing series attributes.

instance

Column Description
pk The primary key
series_fk Foreign key reference to the series.
srcode_fk Foreign key reference to the code table.
media_fk Foreign key reference to the media table.
sop_iuid DICOM SOP Instance UID (0008,0018)
sop_cuid DICOM SOP Class UID (0008,0016)
inst_no DICOM Instance Number (0020,0013)
content_datetime Timestamp containing the Content date (0008,0023) and time (0008,0033).
sr_complete MISSING
sr_verified MISSING
inst_custom1 Custom configurable C-FIND matching key. See DCMEE-438
inst_custom2 Custom configurable C-FIND matching key. See DCMEE-438
inst_custom3 Custom configurable C-FIND matching key. See DCMEE-438
ext_retr_aet External retrieve AET. Instances get marked externally retrievable if dcm4chee sends a StgCmt request and gets a SUCCESS response with populated retrieve AET attribute.
retrieve_aets Retrieve AET where the instances are stored
availability Instance Availability (0008,0056) which defines how rapidly this composite object instance become available for transmission after a C-MOVE retrieval request.
  • ONLINE = 0
  • NEARLINE = 1
  • OFFLINE = 2
  • UNAVAILABLE = 3
instance_status MISSING
all_attrs MISSING
inst_attrs DICOM header dataset of the instance.
commitment indicates if storage commitment was received for this instance.
created_time When the record was created in the database.
updated_time When the record in the database was last updated.

files

Column Description
pk The primary key
instance_fk Foreign key reference to the instance.
filesystem_fk Foreign key reference to the filesystem.
filepath Path to the file including filename relativ to filesystem
file_tsuid DICOM Transfer Syntax UID (0002,0010)
file_md5 MD5 check sum of the file
file_size size of the file in bytes
file_status MISSING
md5_check_time Timestamp when the last MD5 check was performed
created_time When the record was created in the database.

filesystem

Column Description
pk The primary key
next_fk Foreign key reference to the next filesystem (filesystem.pk)
dirpath Directory path on the filesystem
fs_group_id Identifies a linked group of file sytems. Future versions will support to store received objects to different file system groups dependent on the identity of the object source (modality AET) or on DICOM attributes of the received object. It will be also possible, to define different Deleter Policies for different file system groups
retrieve_aet Retrieve AET of the filesystem
availability Availablity of the filesystem:
  • ONLINE
  • NEARLINE
  • OFFLINE
  • UNAVAILABLE
fs_status Read/Write status of the filesystem
  • RW+
  • RW
  • RO
user_info MISSING

ae

Column Description
pk The primary key
aet Application Entity Title
hostname Hostname/IP adress
port Port
cipher_suites SSL / TLS configuration
pat_id_issuer MISSING
user_id MISSING
passwd MISSING
ae_desc Description text of the AET

mpps

Column Description
pk The primary key
patient_fk Foreign key reference to the patient.
drcode_fk Foreign key reference to the code table.
mpps_iuid SOP Instance UID
pps_date Timestamp containing the PPS start date (0040,0244) and time (0040,0245).
station_name DICOM Station Name (0008,1010)
modality DICOM Modality (0008,0060)
accession_no DICOM Accession Number (0008,0050)
mpps_status MISSING
created_time When the record was created in the database.
updated_time When the record in the database was last updated.
mpps_attrs DICOM dataset containing mpps attributes.

device

Column Description
pk The primary key
station_name DICOM Scheduled Station Name (0040,1010)
station_aet DICOM Scheduled Station AET (0040,0001)
modality DICOM Modality (0008,0060)

other_pid

Column Description
pk The primary key
pat_id The patient id (0010,0020).
pat_id_issuer The issuer of the patient id (0010,0021).

rel_pat_other_pid

Column Description
patient_fk  Foreign key reference to the patient.
other_pid_fk  Foreign key reference to other_pid.

code

Column Description
pk The primary key
code_value  MISSING
code_designator   MISSING
code_version   MISSING
code_meaning   MISSING

rel_study_pcode

Column Description
study_fk Foreign key reference to the study.
pcode_fk  Foreign key reference to code.

study_permission

Column Description
pk The primary key
study_iuid DICOM Study Instance UID (0020,000D).
 action MISSING
roles MISSING

series_req

Column Description
pk The primary key
series_fk Foreign key reference to the series.
study_iuid DICOM Study Instance UID (0020,000D).
req_proc_id  DICOM Requested Procedure ID (0040,1001).
sps_id DICOM Scheduled Procedure Step ID (0040,0009).
req_service  DICOM Requesting Service (0032,1033).
req_physician  DICOM Requesting Physician (0032,1032).
ref_phys_i_name Ideographic representation of the referring physician name.
ref_phys_p_name Phonetic representation of the referring physician name.

media

Column Description
pk The primary key
fileset_iuid  MISSING
fileset_id  MISSING
media_rq_iuid  MISSING
media_status   MISSING
media_status_info   MISSING
media_usage   MISSING
created_time When the record was created in the database.
updated_time When the record in the database was last updated.

verify_observer

Column Description
pk The primary key
instance_fk Foreign key reference to the instance.
verify_datetime  MISSING
observer_name   MISSING
 observer_i_name   MISSING
 observer_p_name MISSING

study_on_fs

Column Description
pk The primary key
study_fk  Foreign key reference to the study.
filesystem_fk  Foreign key reference to the filesystem.
access_time  MISSING 

mwl_item

Column Description
pk The primary key
patient_fk Foreign key reference to the patient.
sps_status  MISSING
sps_id DICOM Scheduled Procedure Step ID (0040,0009).
 start_datetime  MISSING
station_name DICOM Scheduled Station Name (0040,1010)
station_aet DICOM Scheduled Station AET (0040,0001)
modality DICOM Modality (0008,0060)
perf_physician   DICOM Performing Physician (0008,1050)
perf_phys_i_name Ideographic representation of the performing physician name.
perf_phys_p_name Phonetic representation of the performing physician name.
req_proc_id DICOM Requested Procedure ID (0040,1001).
accession_no DICOM Accession Number (0008,0050)
study_iuid DICOM Study Instance UID (0020,000D).
created_time When the record was created in the database.
updated_time When the record in the database was last updated.
item_attrs DICOM dataset containing mwl attributes.

gpsps

Column Description
pk The primary key
patient_fk Foreign key reference to the patient.
code_fk Foreign key reference to code.
gpsps_iuid  MISSING
gpsps_tuid   MISSING
 start_datetime   MISSING
end_datetime   MISSING
gpsps_status   DICOM General Purpose Scheduled Procedure Step Status (0040,4001)
gpsps_prior  DICOM General Purpose Scheduled Procedure Step Priority (0040,4003) 
in_availability   MISSING
item_attrs DICOM dataset containing gpsps attributes.

rel_gpsps_appcode

Column Description
gpsps_fk   Foreign key reference to the gpsps 
appcode_fk   Foreign key reference to the code

rel_gpsps_devname

Column Description
gpsps_fk Foreign key reference to the gpsps
devname_fk Foreign key reference to the code

rel_gpsps_devclass

Column Description
gpsps_fk Foreign key reference to the gpsps
devclass_fk Foreign key reference to the code

rel_gpsps_devloc

Column Description
gpsps_fk Foreign key reference to the gpsps
devloc_fk Foreign key reference to the code

gpsps_perf

Column Description
pk The primary key
gpsps_fk Foreign key reference to the gpsps
code_fk Foreign key reference to the code
human_perf_name   DICOM Human Performer's Name (0040,4037)
hum_perf_i_name Ideographic representation of the Human Performer's Name
hum_perf_p_name Phonetic representation of the Human Performer's Name

gpsps_req

Column Description
pk The primary key
gpsps_fk Foreign key reference to the gpsps
req_proc_id DICOM Requested Procedure ID (0040,1001).
accession_no DICOM Accession Number (0008,0050)

gppps

Column Description
pk The primary key
patient_fk Foreign key reference to the patient.
pps_iuid DICOM Referenced SOP Instance UID (0008,1155) from Referenced Performed Procedure Step Sequence (0008,1111)
pps_start Timestamp containing the PPS start date (0040,0244) and time (0040,0245).
pps_status  DICOM Performed Procedure Step Status (0040,0252)
created_time When the record was created in the database.
updated_time When the record in the database was last updated.
pps_attrs DICOM dataset containing gppps attributes.

rel_gpsps_gppps

Column Description
gpsps_fk Foreign key reference to the gpsps
gppps_fk Foreign key reference to the gppps

hp

Column Description
pk The primary key
user_fk Foreign key reference to the code
hp_iuid    DICOM SOP Instance UID (0008,0018)
hp_cuid DICOM SOP Class UID (0008,0016)
 hp_name  DICOM Hanging Protocol Name (0072,0002)
hp_group  DICOM Hanging Protocol User Group Name (0072,0010)
hp_level  DICOM Hanging Protocol Level (0072,0006)
num_priors   DICOM Number of Priors Referenced (0072,0014)
num_screens MISSING
hp_attrs  DICOM dataset containing hp attributes.

hpdef

Column Description
pk The primary key
hp_fk Foreign key reference to the hp
modality DICOM Modality (0008,0060)
laterality DICOM Laterality (0018,0015)

rel_hpdef_region

Column Description
hpdef_fk   Foreign key reference to the hpdef
region_fk Foreign key reference to the code

rel_hpdef_proc

Column Description
hpdef_fk Foreign key reference to the hpdef
proc_fk Foreign key reference to the code

rel_hpdef_reason

Column Description
hpdef_fk Foreign key reference to the hpdef
reason_fk Foreign key reference to the code



This page has been viewed 4716 times.

Enter labels to add to this page:
Please wait 
Looking for a label? Just start typing.