1cda2dcm(1)                        OFFIS DCMTK                       cda2dcm(1)
2
3
4

NAME

6       cda2dcm - Encapsulate CDA file into DICOM file format
7
8

SYNOPSIS

10       cda2dcm [options] cdafile-in dcmfile-out
11

DESCRIPTION

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

PARAMETERS

18       cdafile-in   CDA input filename to be encapsulated
19
20       dcmfile-out  DICOM output filename
21

OPTIONS

23   general options
24         -h   --help
25                print this help text and exit
26
27              --version
28                print version information and exit
29
30              --arguments
31                print expanded command line arguments
32
33         -q   --quiet
34                quiet mode, print no warnings and errors
35
36         -v   --verbose
37                verbose mode, print processing details
38
39         -d   --debug
40                debug mode, print debug information
41
42         -ll  --log-level  [l]evel: string constant
43                (fatal, error, warn, info, debug, trace)
44                use level l for the logger
45
46         -lc  --log-config  [f]ilename: string
47                use config file f for the logger
48
49   DICOM document options
50       document title:
51
52         +t   --title  [t]itle: string (default: empty)
53                document title
54
55         +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
59       patient data:
60
61         +pn  --patient-name  [n]ame: string
62                patient's name in DICOM PN syntax
63
64         +pi  --patient-id  [i]d: string
65                patient identifier
66
67         +pb  --patient-birthdate  [d]ate: string (YYYYMMDD)
68                patient's birth date
69
70         +ps  --patient-sex  [s]ex: string (M, F or O)
71                patient's sex
72
73       study and series:
74
75         +sg  --generate
76                generate new study and series UIDs (default)
77
78         +st  --study-from  [f]ilename: string
79                read patient/study data from DICOM file
80
81         +se  --series-from  [f]ilename: string
82                read patient/study/series data from DICOM file
83
84       instance number:
85
86         +i1  --instance-one
87                use instance number 1 (default, not with +se)
88
89         +ii  --instance-inc
90                increment instance number (only with +se)
91
92         +is  --instance-set [i]nstance number: integer
93                use instance number i
94
95       burned-in annotation:
96
97         +an  --annotation-yes
98                document contains patient identifying data (default)
99
100         -an  --annotation-no
101                document does not contain patient identifying data
102
103       override CDA file data:
104
105         -ov  --no-override
106                CDA patient and document data must match study,
107                series or manually entered information (default)
108
109         +ov  --override
110                data obtained from the CDA file will be overwritten
111                by study, series, or manually entered information
112
113   processing options
114       other processing options:
115
116         -k   --key  [k]ey: gggg,eeee="str", path or dictionary name="str"
117                add further attribute
118
119   output options
120       output file format:
121
122         +F   --write-file
123                write file format (default)
124
125         -F   --write-dataset
126                write data set without file meta information
127
128       group length encoding:
129
130         +g=  --group-length-recalc
131                recalculate group lengths if present (default)
132
133         +g   --group-length-create
134                always write with group length elements
135
136         -g   --group-length-remove
137                always write without group length elements
138
139       length encoding in sequences and items:
140
141         +e   --length-explicit
142                write with explicit lengths (default)
143
144         -e   --length-undefined
145                write with undefined lengths
146
147       data set trailing padding (not with --write-dataset):
148
149         -p   --padding-off
150                no padding (implicit if --write-dataset)
151
152         +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

NOTES

157   Attribute Sources
158       The  application  may  be  fed  with  some additional input for filling
159       mandatory (and optional) attributes in the new DICOM file like patient,
160       study and series information:
161
162       • The  --key  option can be used to add further attributes to the DICOM
163         output file.
164       • It is also possible to specify sequences, items and nested attributes
165         using the --key option. In these cases, a special 'path' notation has
166         to be used. Details on  this  path  notation  can  be  found  in  the
167         documentation of dcmodify.
168       • The --key option can be present more than once.
169       • The value part (after the '=') may be absent causing the attribute to
170         be set with zero length.
171       • Please be advised that the --key option is applied at the  very  end,
172         just  before  saving  the  DICOM  file, so there is no value checking
173         whatsoever.

LOGGING

175       The level of logging output of  the  various  command  line  tools  and
176       underlying  libraries  can  be  specified by the user. By default, only
177       errors and warnings are written to the  standard  error  stream.  Using
178       option  --verbose  also  informational messages like processing details
179       are reported. Option --debug can be used to get  more  details  on  the
180       internal  activity,  e.g.  for debugging purposes. Other logging levels
181       can be selected using option --log-level. In --quiet  mode  only  fatal
182       errors  are reported. In such very severe error events, the application
183       will usually terminate. For  more  details  on  the  different  logging
184       levels, see documentation of module 'oflog'.
185       In  case  the logging output should be written to file (optionally with
186       logfile rotation), to syslog (Unix) or the event log  (Windows)  option
187       --log-config  can  be  used.  This  configuration  file also allows for
188       directing only certain messages to a particular output stream  and  for
189       filtering  certain  messages  based  on the module or application where
190       they are generated.  An  example  configuration  file  is  provided  in
191       <etcdir>/logger.cfg.

COMMAND LINE

193       All  command  line  tools  use  the  following notation for parameters:
194       square brackets enclose optional  values  (0-1),  three  trailing  dots
195       indicate  that multiple values are allowed (1-n), a combination of both
196       means 0 to n values.
197       Command line options are distinguished from parameters by a leading '+'
198       or  '-' sign, respectively. Usually, order and position of command line
199       options are arbitrary (i.e. they  can  appear  anywhere).  However,  if
200       options  are  mutually exclusive the rightmost appearance is used. This
201       behavior conforms to the  standard  evaluation  rules  of  common  Unix
202       shells.
203       In  addition,  one  or more command files can be specified using an '@'
204       sign as a prefix to the filename (e.g. @command.txt).  Such  a  command
205       argument  is  replaced  by  the  content of the corresponding text file
206       (multiple whitespaces are treated as a  single  separator  unless  they
207       appear  between  two  quotation marks) prior to any further evaluation.
208       Please note that a command file cannot contain  another  command  file.
209       This  simple  but  effective  approach  allows  one to summarize common
210       combinations of options/parameters and  avoids  longish  and  confusing
211       command lines (an example is provided in file <datadir>/dumppat.txt).

EXIT CODES

213       The  cda2dcm  utility  uses  the following exit codes when terminating.
214       This enables the user to check  for  the  reason  why  the  application
215       terminated.
216   general
217       EXITCODE_NO_ERROR                 0
218       EXITCODE_COMMANDLINE_SYNTAX_ERROR 1
219       EXITCODE_MEMORY_EXHAUSTED         4
220   input file errors
221       EXITCODE_CANNOT_READ_INPUT_FILE   20
222       EXITCODE_NO_INPUT_FILES           21
223       EXITCODE_INVALID_INPUT_FILE       22
224   output file errors
225       EXITCODE_CANNOT_WRITE_OUTPUT_FILE 40

ENVIRONMENT

227       The  cda2dcm  utility  will  attempt  to  load  DICOM data dictionaries
228       specified in the DCMDICTPATH environment variable. By default, i.e.  if
229       the   DCMDICTPATH   environment   variable   is   not   set,  the  file
230       <datadir>/dicom.dic will be loaded unless the dictionary is built  into
231       the application (default for Windows).
232       The   default   behavior   should  be  preferred  and  the  DCMDICTPATH
233       environment variable only used when alternative data  dictionaries  are
234       required.  The  DCMDICTPATH environment variable has the same format as
235       the Unix shell PATH variable in that a colon (':')  separates  entries.
236       On  Windows systems, a semicolon (';') is used as a separator. The data
237       dictionary code will  attempt  to  load  each  file  specified  in  the
238       DCMDICTPATH  environment variable. It is an error if no data dictionary
239       can be loaded.
241       Copyright (C) 2018-2021 e.V., Escherweg 2, 26121 Oldenburg, Germany.
242
243
244
245Version 3.6.6                   Thu Jan 14 2021                     cda2dcm(1)
Impressum