XDS-I Service. Cross-enterprise Document Sharing for Imaging. (Imaging Document Source actor)
org.dcm4chex.archive.xdsi.XDSIService
The default constructor
XDSIService
Source ID - unique identifier of this Document Source.
SourceID
java.lang.String
List of Source (Modality) AE titles separated by \(backslash),
from which studies shall be automatically published to the configured
XDS-I Repository. NONE = do not publish studies received from any source
automatically.
AutoPublishSourceAETitles
java.lang.String
Document Repository URI.
DocRepositoryURI
java.lang.String
AET of Document Repository (for Audit Log only).
DocRepositoryAET
java.lang.String
Metadata Property File.
A relative path name is resolved relative to dcm4chee_home/server/default/.
MetadataPropertyFile
java.lang.String
Metadata Property File for AutoPublish.
A relative path name is resolved relative to dcm4chee_home/server/default/.
AutoPublishPropertyFile
java.lang.String
XSL File for AutoPublish to get metadata from manifest info (Dataset with patient, study and series attributes).
Use NONE to disable this XSLT processing.
A relative path name is resolved relative to dcm4chee_home/server/default/.
AutoPublishXSLFile
java.lang.String
A relative path name is resolved relative to dcm4chee_home/server/default/.
With TEXT a simple text/plain document will be registered for a deleted study.
Content: Study has been removed from Source PACS System!
]]>
AutoPublishStudyDeletedPDFFile
java.lang.String
Use NEVER to disable this feature.
Note: This feature requires XdsQueryServiceName]]>
AutoPublishInterval
java.lang.String
Current state if a AutoPublish task is running. Used to avoid concurrency!
isRunning
boolean
Format: Each line can contain a complete SQL Statement or a comment (Line starts with '*')
The statement must return only one column with study.pk!
- Following named parameter can be used:
- :AfterDate
- :BeforeDate
- :OlderThan
- :NotOlderThan
- Example:
- *
- * All studies with updated_time between configured AfterDate and BeforeDate:
- SELECT pk FROM study WHERE updated_time > :AfterDate AND updated_time < :BeforeDate
- *
- * All studies that are created before n days:
- SELECT pk FROM study WHERE created_time < :OlderThan
Note: the configured queries are used as subquery of a query which exclude studies that are already published (via table published_study)
This behaviour can be disabled by using '@' as first character in SQL statement. In this case
the first culumns must be study.pk, published_study.pk and published_study.docentry_uid!
If the SQL statement starts with '[<startHour>-<endHour>]' this query will be only performed between start and end hour (0-23).
e.g.: '[23-4]SELECT pk from study' check all (unpublished) studies between 23:00:00 and 4:59:59.
]]>
AutoPublishSQL
java.lang.String
Should be only disabled if a similar query is defined in AutoPublishSQL!
(@SELECT study_fk, pk, docentry_uid from published_study where study_fk IS NULL)
]]>
DisableStudyDeleteSQL
boolean
Usage: ':AfterDate' in WHERE clause. e.g WHERE study.updated_time > :AfterDate
Format:yyyy[-MM[-dd[ HH[:mm[:ss]]]]] or NONE
Note: Missing parts are set to corresponding minimum. eg. '2013-03' -> '2013-03-01 00:00:00'
]]>
AfterDate
java.lang.String
Usage: ':BeforeDate' in WHERE clause. e.g WHERE study.updated_time < :BeforeDate
Format:yyyy[-MM[-dd[ HH[:mm[:ss]]]]] or NONE
Note: Missing parts are set to corresponding maximun. eg. '2012-02' -> '2012-02-29 23:55:55' (and 999 milliseconds)
]]>
BeforeDate
java.lang.String
Usage: ':OlderThan' in WHERE clause. e.g WHERE study.updated_time < :OlderThan
Format: days(#d), weeks (#w), hours (#h), minutes (#m) or seconds (#s)
Note: the SQL parameter value is a timestamp calculated as currentDate - olderThan.]]>
OlderThan
java.lang.String
Usage: ':NotOlderThan' in WHERE clause. e.g WHERE study.updated_time > :NotOlderThan
Format: days(#d), weeks (#w), hours (#h), minutes (#m) or seconds (#s)
Note: the SQL parameter value is a timestamp calculated as currentDate - NotOlderThan.]]>
NotOlderThan
java.lang.String
]]>
MaxNumberOfStudiesByOneTask
int
]]>
AddStudyInstanceUIDSlot
boolean
JDBC Fetch size. (-1 means: use Limit)
FetchSize
int
Format:<CodeValue>^<CodeMeaning>[^<CodeDesignator>] ]]>
AutoPublishDocTitle
java.lang.String
RID URL to get PDF Document for exportPDF.
RidURL
java.lang.String
Name of the patient ID authorithy of this Document Source.
This is normally the 'Issuer of patient ID' (issuer) DICOM attribute.
We can overwrite this default behaviour with:
'<Domain>' : use <Domain> if issuer is missing.
'=<Domain>' : use always <Domain> as local authority.
'NONE' : default behaviour: use always issuer as local authority.
]]>
LocalDomain
java.lang.String
This name is used in PIX Query Service to get patient id of affinity domain.
You can disable PIX Query by setting this value with '=' as first character.
'=' : use the source patient ID and issuer.
'=?<Domain>' : use patientID from source and <Domain> as issuer.
'=?[<issuer>]<Domain>' : Dedicated issuer replacement: Only patientID's with given
<issuer> will be exported as <patId>^^^<domain>.
'=<patient>' : use <patient> for patientID and issuer (patid^^^issuer).
]]>
AffinityDomain
java.lang.String
Patient ID's are in HL7 CX format but since revision 7 this is restricted by:
...this specification restricts them to the use of two components, the ID Number, and the Assigning Authority (AA).
No other values/modifications in other components or subcomponents are allowed.
Specifically, components 2 and 3 shall be empty as listed above.
see Table 4.1-3 Data Types
in
IT Infrastructure Technical Framework Volume 3 (ITI TF-3) revision 7.0
]]>
RemoveNamespaceID
boolean
Enable logging of SOAP message.
LogSOAPMessage
boolean
Enable/disable indention of logged SOAP message.
IndentSOAPLog
boolean
If enabled an XDS audit message will be sent in addition to the Dicom export audit log message.
Note: ITI-15 logging requires XdsbSourceServiceName!
]]>
LogITI15
boolean
Used internally. Do NOT modify.
PixQueryServiceName
javax.management.ObjectName
Used internally. Do not modify.
IANScuServiceName
javax.management.ObjectName
Used internally. Do not modify.
KeyObjectServiceName
javax.management.ObjectName
This service is part of dcm4chee-xds and you have to set proxy and ssl configuration in
start script when it is not installed!
]]>
XdsHttpCfgServiceName
java.lang.String
Note: XDS.b requires XdsbSourceServiceName]]>
UseXDSb
boolean
Note: Requires installed dcm4chee.xds services!]]>
XdsbSourceServiceName
java.lang.String
Used internally. Used if AutoPublishSQL is configured! Do not modify (dcm4chee.xds:service=XDSQueryService).
XdsQueryServiceName
java.lang.String
Used internally. Do NOT modify.
TimerIDAutoPublish
java.lang.String
Used internally. Do NOT modify.
SchedulerServiceName
javax.management.ObjectName
Used internally. Do NOT modify.
TemplatesServiceName
javax.management.ObjectName
File containing Codes for Document Title for web2 XDS-I export(for KOS object and therefore xds metadata 'title').
Format: [designator^]codevalue^meaning
A relative path name is resolved relative to dcm4chee_home/server/default/.
DocTitleCodeListFile
java.lang.String
File containing Codes for eventCodeList for web2 XDS-I export.
Format: [designator^]codevalue^meaning
A relative path name is resolved relative to dcm4chee_home/server/default/.
EventCodeListFile
java.lang.String
File containing Codes for ClassCode for web2 XDS-I export.
Format: [designator^]codevalue^meaning
A relative path name is resolved relative to dcm4chee_home/server/default/.
ClassCodeListFile
java.lang.String
File containing codes for Content Type Codes for web2 XDS-I export.
Format: [designator^]codevalue^meaning
A relative path name is resolved relative to dcm4chee_home/server/default/.
ContentTypeCodes
java.lang.String
File containing codes for Healthcare Facility Type Codes for web2 XDS-I export.
Format: [designator^]codevalue^meaning
A relative path name is resolved relative to dcm4chee_home/server/default/.
HealthCareFacilityTypeCode
java.lang.String
Code list for confidentialityCode for web2 XDS-I export.
Format: [designator^]codevalue^meaning
Use either newline or semicolon to seperate codes
ConfidentialityCodes
java.lang.String
Mapping format: <user>=<authorPerson>
Use either newline or semicolon to seperate mappings.
If '=' is ommited, a fix (global) authorPerson is set]]>
AuthorPersonMapping
java.lang.String
Format: <role>^<displayName>
Use either newline or semicolon to seperate codes.
]]>
AuthorRoles
java.lang.String
&defaultAttributes;
Performs a NIST test.
nistTest
TestID
testID
java.lang.String
boolean
Performs a simple soap test.
sendSOAP
SOP Instance UID of Key Object
kosIuid
java.lang.String
Metadata properties
mdProps
java.util.Properties
boolean
Performs a simple soap test.
sendSOAP
SOP Instance UID of Key Object
kosIuid
java.lang.String
boolean
Performs a simple soap test.
exportPDF
SOP Instance UID of PDF RID document
iuid
java.lang.String
Metadata properties
mdProps
java.util.Properties
boolean
Performs a simple soap test.
exportPDF
SOP Instance UID of PDF RID document
iuid
java.lang.String
boolean
Send a SOAP message to DocRepositoryURI.
sendSOAP
Filename of metadata file
metadataFilename
java.lang.String
List of documents (Format:filename|mimiType|docUID[,filename|mimeType|docUID[,..]])
docNames
java.lang.String
boolean
Send a SOAP message to DocRepositoryURI.
sendSOAP
Key Object Selection Dataset to submit.
kos
org.dcm4che.data.Dataset
Metadata Properties
mdProps
java.util.Properties
boolean
Create a new XDS Folder.
createFolder
Metadata properties
mdProps
java.util.Properties
boolean
Get the authorPerson for a user.
getAuthorPerson
user
user
java.lang.String
java.lang.String
Join Metadata Properties with properties from Metadata Property File.
joinMetadataProperties
Additional Metadata properties
props
java.util.Properties
java.util.Properties
get list of roles used by web2 XDS-I export.
listAuthorRoles
java.util.List
get list of document titles used by web2 XDS-I export.
listDocTitleCodes
java.util.List
get list of Event Type Codes used by web2 XDS-I export.
listEventCodes
java.util.List
get list of Class Codes used by web2 XDS-I export.
listClassCodes
java.util.List
get list of Content Type Codes used by web2 XDS-I export.
listContentTypeCodes
java.util.List
get list of Healthcare Facility Type Codes used by web2 XDS-I export.
listHealthCareFacilityTypeCodes
java.util.List
get list of Confidentiality Codes used by web2 XDS-I export.
listConfidentialityCodes
java.util.List
clear CodeFileCache (only used by web2 XDS-I export).
clearCodeFileCache
void
Read the configured Metadata Property File
readPropertyFile
void
Obtain Affinity Domain patient ID for given patient information
getAffinityDomainPatientID
Dataset containing local patient id and issuer of id
kos
org.dcm4che.data.Dataset
java.lang.String
&defaultOperations;