1cda2dcm(1) OFFIS DCMTK cda2dcm(1)
2
6 cda2dcm - Encapsulate CDA file into DICOM file format
7
10 cda2dcm [options] cdafile-in dcmfile-out
11
13 The cda2dcm utility reads a CDA file (cdafile-in), converts it to a
14 DICOM Encapsulated CDA Storage SOP instance and stores the converted
15 data to an output file (dcmfile-out).
16
18 cdafile-in CDA input filename to be encapsulated
19 dcmfile-out DICOM output filename
21
23 general options
24 -h --help
25 print this help text and exit
26 --version
28 print version information and exit
29 --arguments
31 print expanded command line arguments
32 -q --quiet
34 quiet mode, print no warnings and errors
35 -v --verbose
37 verbose mode, print processing details
38 -d --debug
40 debug mode, print debug information
41 -ll --log-level [l]evel: string constant
43 (fatal, error, warn, info, debug, trace)
44 use level l for the logger
45 -lc --log-config [f]ilename: string
47 use config file f for the logger
48 DICOM document options
50 document title:
51 +t --title [t]itle: string (default: empty)
53 document title
54 +cn --concept-name [CSD] [CV] [CM]: string (default: empty)
56 coded representation of document title defined by coding
57 scheme designator CSD, code value CV and code meaning CM
58 patient data:
60 +pn --patient-name [n]ame: string
62 patient's name in DICOM PN syntax
63 +pi --patient-id [i]d: string
65 patient identifier
66 +pb --patient-birthdate [d]ate: string (YYYYMMDD)
68 patient's birth date
69 +ps --patient-sex [s]ex: string (M, F or O)
71 patient's sex
72 study and series:
74 +sg --generate
76 generate new study and series UIDs (default)
77 +st --study-from [f]ilename: string
79 read patient/study data from DICOM file
80 +se --series-from [f]ilename: string
82 read patient/study/series data from DICOM file
83 instance number:
85 +i1 --instance-one
87 use instance number 1 (default, not with +se)
88 +ii --instance-inc
90 increment instance number (only with +se)
91 +is --instance-set [i]nstance number: integer
93 use instance number i
94 burned-in annotation:
96 +an --annotation-yes
98 document contains patient identifying data (default)
99 -an --annotation-no
101 document does not contain patient identifying data
102 override CDA file data:
104 -ov --no-override
106 CDA patient and document data must match study,
107 series or manually entered information (default)
108 +ov --override
110 data obtained from the CDA file will be overwritten
111 by study, series, or manually entered information
112 processing options
114 other processing options:
115 -k --key [k]ey: gggg,eeee="str", path or dictionary name="str"
117 add further attribute
118 output options
120 output file format:
121 +F --write-file
123 write file format (default)
124 -F --write-dataset
126 write data set without file meta information
127 group length encoding:
129 +g= --group-length-recalc
131 recalculate group lengths if present (default)
132 +g --group-length-create
134 always write with group length elements
135 -g --group-length-remove
137 always write without group length elements
138 length encoding in sequences and items:
140 +e --length-explicit
142 write with explicit lengths (default)
143 -e --length-undefined
145 write with undefined lengths
146 data set trailing padding (not with --write-dataset):
148 -p --padding-off
150 no padding (implicit if --write-dataset)
151 +p --padding-create [f]ile-pad [i]tem-pad: integer
153 align file on multiple of f bytes
154 and items on multiple of i bytes
155
157 The level of logging output of the various command line tools and
158 underlying libraries can be specified by the user. By default, only
159 errors and warnings are written to the standard error stream. Using
160 option --verbose also informational messages like processing details
161 are reported. Option --debug can be used to get more details on the
162 internal activity, e.g. for debugging purposes. Other logging levels
163 can be selected using option --log-level. In --quiet mode only fatal
164 errors are reported. In such very severe error events, the application
165 will usually terminate. For more details on the different logging
166 levels, see documentation of module 'oflog'.
167 In case the logging output should be written to file (optionally with
169 logfile rotation), to syslog (Unix) or the event log (Windows) option
170 --log-config can be used. This configuration file also allows for
171 directing only certain messages to a particular output stream and for
172 filtering certain messages based on the module or application where
173 they are generated. An example configuration file is provided in
174 <etcdir>/logger.cfg.
175
177 All command line tools use the following notation for parameters:
178 square brackets enclose optional values (0-1), three trailing dots
179 indicate that multiple values are allowed (1-n), a combination of both
180 means 0 to n values.
181 Command line options are distinguished from parameters by a leading '+'
183 or '-' sign, respectively. Usually, order and position of command line
184 options are arbitrary (i.e. they can appear anywhere). However, if
185 options are mutually exclusive the rightmost appearance is used. This
186 behavior conforms to the standard evaluation rules of common Unix
187 shells.
188 In addition, one or more command files can be specified using an '@'
190 sign as a prefix to the filename (e.g. @command.txt). Such a command
191 argument is replaced by the content of the corresponding text file
192 (multiple whitespaces are treated as a single separator unless they
193 appear between two quotation marks) prior to any further evaluation.
194 Please note that a command file cannot contain another command file.
195 This simple but effective approach allows one to summarize common
196 combinations of options/parameters and avoids longish and confusing
197 command lines (an example is provided in file <datadir>/dumppat.txt).
198
200 The cda2dcm utility uses the following exit codes when terminating.
201 This enables the user to check for the reason why the application
202 terminated.
203 general
205 EXITCODE_NO_ERROR 0
206 EXITCODE_COMMANDLINE_SYNTAX_ERROR 1
207 EXITCODE_MEMORY_EXHAUSTED 4
208 input file errors
210 EXITCODE_CANNOT_READ_INPUT_FILE 20
211 EXITCODE_NO_INPUT_FILES 21
212 EXITCODE_INVALID_INPUT_FILE 22
213 output file errors
215 EXITCODE_CANNOT_WRITE_OUTPUT_FILE 40
216
218 The cda2dcm utility will attempt to load DICOM data dictionaries
219 specified in the DCMDICTPATH environment variable. By default, i.e. if
220 the DCMDICTPATH environment variable is not set, the file
221 <datadir>/dicom.dic will be loaded unless the dictionary is built into
222 the application (default for Windows).
223 The default behavior should be preferred and the DCMDICTPATH
225 environment variable only used when alternative data dictionaries are
226 required. The DCMDICTPATH environment variable has the same format as
227 the Unix shell PATH variable in that a colon (':') separates entries.
228 On Windows systems, a semicolon (';') is used as a separator. The data
229 dictionary code will attempt to load each file specified in the
230 DCMDICTPATH environment variable. It is an error if no data dictionary
231 can be loaded.
232
234 Copyright (C) 2018 by OFFIS e.V., Escherweg 2, 26121 Oldenburg,
235 Germany.
236Version 3.6.4 Thu Nov 29 2018 cda2dcm(1)