4.4.2.1.3.3.1. Archive HL7 Application

DICOM Archive HL7 Application related information

Table 4.86 Archive HL7 Application Attributes (LDAP Object: dcmArchiveHL7Application)

Name

Type

Description (LDAP Attribute)

AE Title

string

Archive AE Title associated with this HL7 Application.

(dicomAETitle)

Record Attribute Modification

boolean

Indicates if modifications of attributes of stored objects by this HL7 Application are recorded in Items of the Original Attributes Sequence. Overwrites value specified on Device level.

(dcmRecordAttributeModification)

MWL Worklist Label

string

Value of Worklist Label (0074,1202) of created MWL items on receive of HL7 Order messages. If absent, created MWL items are not bound to a particular MWL Worklist and are provided by all Archive AEs with MWL SCP Transfer Capability.

(dcmMWLWorklistLabel)

MWL Accession Number Generator

string

Identifies ID Generator to supplement missing Accession Numbers of Scheduled Procedures Steps created on receive of HL7 Order messages. Overwrites value specified on Device level.

(dcmMWLAccessionNumberGenerator)

MWL Requested Procedure ID Generator

string

Identifies ID Generator to supplement missing Requested Procedure IDs of Scheduled Procedures Steps created on receive of HL7 Order messages. Overwrites value specified on Device level.

(dcmMWLRequestedProcedureIDGenerator)

MWL Scheduled Procedure Step ID Generator

string

Identifies ID Generator to supplement missing Scheduled Procedure Step IDs of Scheduled Procedures Steps created on receive of HL7 Order messages. Overwrites value specified on Device level.

(dcmMWLScheduledProcedureStepIDGenerator)

Audit HL7 Message Limit

integer

Limit length of HL7 messages included in emitted Audit Records. Overwrites value specified on Device level.

(dcmAuditHL7MsgLimit)

HL7 ORU Action(s)

string

Specifies action on receive of HL7 ORU^R01 message: IMPORT_REPORT (= transcode received HL7 ORU^R01 to DICOM SR), MWL_COMPLETED (= set Status of matching MWL items to COMPLETED). Overwrites value specified on Device level.

Enumerated values:

IMPORT_REPORT

MWL_COMPLETED

(hl7ORUAction)

HL7 Patient Update Template URI

string

Specifies URI for the style sheet used by HL7v2 Patient Update Service. Overwrites value specified on Device level.

(hl7PatientUpdateTemplateURI)

HL7 Import Report Template URI

string

Specifies URI for the style sheet to transcode received HL7 ORU^R01 to DICOM SR. Overwrites value specified on Device level.

(hl7ImportReportTemplateURI)

HL7 Import Report Template Parameter(s)

string

XSLT parameters passed to style sheet specified by HL7 Import Report Template URI. Format: {name}={value}. E.g.: ‘langCodeValue=et’, ‘langCodingSchemeDesignator=RFC5646’, ‘langCodeMeaning=Estonian’. Overwrites value specified on Device level.

(hl7ImportReportTemplateParam)

HL7 Schedule Procedure Template URI

string

Specifies URI for the style sheet to transcode received HL7 ORM^O01, OMI^O23, OMG^O19 to DICOM MWL items. Overwrites value specified on Device level.

(hl7ScheduleProcedureTemplateURI)

HL7 Schedule Protocol Code in Order

string

Specifies location of Scheduled Protocol Code in received HL7 Order message. Overwrites value specified on Device level.

Enumerated values:

OBR_4_1

OBR_4_4

(hl7ScheduledProtocolCodeInOrder)

HL7 Schedule Station AET in Order

string

Specifies location of Scheduled Station AE Title in received HL7 Order message. Should not be configured for HL7 v2.5.1 OMI^O23 with IPC segment. Overwrites value specified on Device level.

Enumerated values:

ORC_18

(hl7ScheduledStationAETInOrder)

HL7 Log File Pattern

string

Path to HL7 messages which will be captured exactly as received. If absent, there is no logging. Overwrites value specified on Device level. eg. ${jboss.server.data.dir}/hl7/${date,yyyy/MM/dd}/${SerialNo}-${MSH-9}.hl7

(hl7LogFilePattern)

HL7 Error Log File Pattern

string

Path to HL7 messages which will be captured exactly as received, when processing of HL7 messages fails. If absent, there is no logging. Overwrites value specified on Device level. eg. ${jboss.server.data.dir}/hl7-error/${date,yyyy/MM/dd}/${SerialNo}-${MSH-9}.hl7

(hl7ErrorLogFilePattern)

HL7 Outgoing Log File Pattern

string

Path to HL7 messages which will be captured exactly as sent. If absent, there is no logging. May be overwritten by configured values for particular Archive HL7 Application. eg. ${jboss.server.data.dir}/hl7-out/${date,yyyy/MM/dd}/${SerialNo}-${MSH-9}.hl7

(hl7OutgoingLogFilePattern)

HL7 Outgoing Error Log File Pattern

string

Path to HL7 messages which will be captured exactly as sent, when processing of sent HL7 messages fails. If absent, there is no logging. May be overwritten by configured values for particular Archive HL7 Application. eg. ${jboss.server.data.dir}/hl7-out-error/${date,yyyy/MM/dd}/${SerialNo}-${MSH-9}.hl7

(hl7OutgoingErrorLogFilePattern)

HL7 No Patient Create Message Type(s)

string

Message Type(s) (MessageType^TriggerEvent) of HL7 messages which are only processed, if there is already a Patient record in the database, which Patient ID matches the Patient ID in the PID or MRG segment of the message. Thus no new Patient record will be created by messages of the specified types. Overwrites value specified on Device level.

(hl7NoPatientCreateMessageType)

HL7 Patient Arrival Message Type

string

Message Type of HL7 messages which triggers the change the status of Scheduled Procedure Steps associated with the Patient from SCHEDULED to ARRIVED. Overwrite value specified on Device level.

Enumerated values:

ADT^A10

(hl7PatientArrivalMessageType)

Use HL7 Null Value

boolean

Specifies if HL7 v2 null values (specified in segment field as |””|) are used in sent HL7 messages for not present or empty entity attributes. Required to unset entity attributes at the remote HL7 Application. Overwrites value specified on Device level.

(hl7UseNullValue)

HL7 Veterinary use Patient Name

boolean

Indicates to force veterinary use of Patient Names on mapping HL7 PID fields to DICOM attributes: only use the first two components of PID.5 as DICOM Patient Name; if PID.5 only contains one component, use that value as given name, and the first component of PID.9 as family name of the DICOM Patient Name. Overwrites value specified on Device level.

(hl7VeterinaryUsePatientName)

HL7 Primary Assigning Authority of Patient ID

string

Assigning Authority of Patient ID in received HL7 message used to search primary qualified patient identifier in the list of identifiers in PID-3 / MRG.1. This qualified patient identifier shall be used on the root dataset. If absent, by default the first patient identifier pair in PID-3 / MRG.1 shall be used as primary patient identifier on root dataset. If none of the qualified patient identifiers in the list match with the configured issuer, archive server log shall contain a log INFO message and by default the first qualified patient identifier in PID-3 / MRG.1 shall be used. Format: {Issuer of Patient ID}[&{UniversalEntityID}&{UniversalEntityIDType}]. Overwrites value specified on Device level.

(hl7PrimaryAssigningAuthorityOfPatientID)

HL7 Other Patient IDs

string

Specifies inclusion policy for patient identifiers in PID-3 / MRG-1 of HL7 message in Other Patient IDs Sequence (0010,1002). Overwrites value specified on Device level.

Enumerated values:

ALL

NONE

OTHER

(hl7OtherPatientIDs)

HL7 Order Missing Study Instance UID Policy

string

Specifies policy for missing Study Instance UID in incoming HL7 Order messages. Overwrites value specified on Device level.

Enumerated values:

REJECT

GENERATE

ACCESSION_BASED

(hl7OrderMissingStudyIUIDPolicy)

HL7 Order Missing Admission ID Policy

string

Specifies policy on incoming HL7 Order messages without a value for PID-18 Patient Account Number nor field PV1-19 Visit Number. Overwrites value specified on Device level.

Enumerated values:

ACCEPT

REJECT

ACCESSION_AS_ADMISSION

(hl7OrderMissingAdmissionIDPolicy)

HL7 Import Report Missing Study Instance UID Policy

string

Specifies policy for missing Study Instance UID in incoming HL7 Import Report (ORU) messages. Overwrites value specified on Device level.

Enumerated values:

REJECT

GENERATE

ACCESSION_BASED

(hl7ImportReportMissingStudyIUIDPolicy)

HL7 Import Report Missing Admission ID Policy

string

Specifies policy on incoming HL7 ImportReport (ORU) messages without a value for PID-18 Patient Account Number nor field PV1-19 Visit Number. Overwrites value specified on Device level.

Enumerated values:

ACCEPT

REJECT

ACCESSION_AS_ADMISSION

(hl7ImportReportMissingAdmissionIDPolicy)

HL7 Import Report Missing Study Instance UID C-FIND SCP

string

AE Title of external C-FIND SCP to query for missing Study Instance UID in incoming HL7 Import Report (ORU) messages by given Accession Number. Overwrites value specified on Device level.

(hl7ImportReportMissingStudyIUIDCFindSCP)

HL7 Import Report Adjust Instance UID

string

Specifies adjustment of Series and SOP Instances UIDs returned by XSLT on incoming HL7 Import Report (ORU) messages. Overwrites value specified on Device level.

Enumerated values:

NONE

APPEND_HASH_OF_STUDY_INSTANCE_UID

(hl7ImportReportAdjustIUID)

HL7 Referred Merged Patient Policy

string

Specifies policy on incoming HL7 messages referring an already merged Patient. REJECT: reject any such HL7 message, IGNORE: ignore any such HL7 message, IGNORE_DUPLICATE_MERGE: Ignore only duplicate HL7 Merge messages, Reject any other such Message. Overwrites value specified on Device level.

Enumerated values:

REJECT

IGNORE

IGNORE_DUPLICATE_MERGE

(hl7ReferredMergedPatientPolicy)

HL7 Dicom Character Set

string

Indicates to use specified Value of Specific Character Set (0008,0005) in Data Sets transcoded from received HL7 messages. Use Value corresponding to Character Set of the HL7 message specified by MSH-18 if absent.

(hl7DicomCharacterSet)

HL7 Forward Rule (s)

object

HL7 Forward Rule. Supplements values specified on Device level.

HL7 Export Rule (s)

object

Export Rules applied to HL7 messages received by this HL7 Application. Supplements HL7 Export Rules specified on Device level.

UPS on HL7 (s)

object

UPS on HL7 Rules applied to HL7 messages received by any HL7 Application. Supplements UPS on HL7 Rules specified on Device level.

HL7 Prefetch Rule (s)

object

Prefetch Rules applied to HL7 messages received by this HL7 Application. Supplements HL7 Prefetch Rules specified on Device level.

HL7 Study Retention Policy (s)

object

HL7 Study Retention Policies triggered by HL7 messages received by this HL7 Application. Supplements values specified on Device level.

Scheduled Station for HL7 Order (s)

object

Scheduled Station selected on MWL HL7 Order Feed. Supplements values specified on Device level.

SPS Status for HL7 Order (s)

object

Specifies SPS Status of DICOM MWL items created/updated on received HL7 ORM^O01, OMI^O23, OMG^O19 messages. Overwrites values specified on Device level.