4.4.2.1.3.8.20. UPS on HL7

Create/Update Workitem in unified Worklist on receive of HL7v2 message

Table 4.108 UPS on HL7 Attributes (LDAP Object: dcmUpsOnHL7)
Name Type Description (LDAP Attribute)

UPS on HL7 ID

string

ID of UPS on HL7 Rule

(hl7UPSOnHL7ID)

Conditions(s)

string

Conditions in format <SEG>-<Seq#>[.<Comp#>[.<SubComp#>]][!]=<regEx>. Example: MSH-9=ORM^O01

(dcmProperty)

Time Conditions(s)

string

Apply this rule only within specified time ranges.

(dcmSchedule)

Procedure Step Label

string

Value of Procedure Step Label (0074,1204) in created UPS. {<SEG>-<Seq#>[.<Comp#>[.<SubComp#>]]} will be replaced by the value of that field in the received HL7 message.

(dcmUPSLabel)

Worklist Label

string

Value of Worklist Label (0074,1202) in created UPS. {<SEG>-<Seq#>[.<Comp#>[.<SubComp#>]]} will be replaced by the value of that field in the received HL7 message. If absent or if value could not be found in HL7 Message, HL7 Application Name of the receiving HL7 Application will be used.

(dcmUPSWorklistLabel)

Priority

string

Value of Scheduled Procedure Step Priority (0074,1200) in created UPS. Enumerated Values: HIGH, MEDIUM, LOW. If absent, MEDIUM will be applied. Enumerated values: HIGH, MEDIUM or LOW.

(dcmUPSPriority)

Input Readiness State

string

Value of Input Readiness State (0040,4041) in created UPS Enumerated values: INCOMPLETE, UNAVAILABLE or READY.

(dcmUPSInputReadinessState)

Scheduled Procedure Step Start DateTime Delay

string

Delay of Scheduled Procedure Step Start DateTime (0040,4005) in created UPS from receive time in format PnDTnHnMn.nS. Only effective, if no Scheduled Procedure Step Start DateTime is found in HL7 Message.

(dcmUPSStartDateTimeDelay)

Expected Completion DateTime Delay

string

Delay of Expected Completion DateTime (0040,4011) in created UPS from receive time in format PnDTnHnMn.nS. If absent, no Expected Completion Date and Time will be set.

(dcmUPSCompletionDateTimeDelay)

UPS Instance UID based on name

string

Value used to generate name based SOP Instance UID (0008,0018) in created UPS. {<SEG>-<Seq#>[.<Comp#>[.<SubComp#>]]} will be replaced by the value of that field in the received HL7 message. If absent, a random generated SOP Instance UID (0008,0018) will be used.

(dcmUPSInstanceUIDBasedOnName)

Destination AE

string

Title of a DICOM Application Entity to which Instances will be stored.

(dcmDestinationAE)

Scheduled Workitem Code

string

Item of Scheduled Workitem Code Sequence (0040,4018) in created UPS in format (CV, CSD, “CM”).

(dcmUPSScheduledWorkitemCode)

Scheduled Station Name Code

string

Item of Scheduled Station Name Code Sequence (0040,4025) in created UPS in format (CV, CSD, “CM”).

(dcmUPSScheduledStationNameCode)

Scheduled Station Class Code

string

Item of Scheduled Station Class Code Sequence (0040,4026) in created UPS in format (CV, CSD, “CM”).

(dcmUPSScheduledStationClassCode)

Scheduled Station Geographic Location Code

string

Item of Scheduled Station Geographic Location Code Sequence (0040,4027) in created UPS in format (CV, CSD, “CM”).

(dcmUPSScheduledStationLocationCode)

Scheduled Human Performer Code

string

Item of Human Performer Code Sequence (0040,4009) in Item of Scheduled Human Performers Sequence (0040,4034) in created UPS in format (CV, CSD, “CM”).

(dcmUPSScheduledHumanPerformerCode)

Scheduled Human Performer Name

string

Value of Human Performer’s Name (0040,4037) in Item of Scheduled Human Performers Sequence (0040,4034) in created UPS. {<SEG>-<Seq#>[.<Comp#>[.<SubComp#>]]} will be replaced by the value of that field in the received HL7 message.

(dcmUPSScheduledHumanPerformerName)

Scheduled Human Performer Organization

string

Value of Human Performer’s Organization (0040,4036) in Item of Scheduled Human Performers Sequence (0040,4034) in created UPS. {<SEG>-<Seq#>[.<Comp#>[.<SubComp#>]]} will be replaced by the value of that field in the received HL7 message.

(dcmUPSScheduledHumanPerformerOrganization)

Include Study Instance UID

boolean

Indicates if Study Instance UID (0020,000D) in the received HL7 message shall be included in the created UPS

(dcmUPSIncludeStudyInstanceUID)

Include Referenced Request

boolean

Indicates if the Study Instance UID (0020,000D) in the received HL7 message and the specified Accession Number (0008,0050), Requested Procedure ID (0040,1001) and Requesting Service (0032,1033) shall be included in the item of the Referenced Request Sequence (0040,A370) in the created UPS. Otherwise an empty Referenced Request Sequence (0040,A370) is included.

(dcmUPSIncludeReferencedRequest)

Study Instance UID

string

Value of Study Instance UID (0020,000D) in Item of Referenced Request Sequence (0040,A370) in created UPS. {<SEG>-<Seq#>[.<Comp#>[.<SubComp#>]]} will be replaced by the value of that field in the received HL7 message.

(dcmStudyInstanceUID)

Admission Number

string

Value of Admission ID (0038,0010) in created UPS. {<SEG>-<Seq#>[.<Comp#>[.<SubComp#>]]} will be replaced by the value of that field in the received HL7 message.

(dcmAdmissionID)

Issuer of Admission ID

string

Value of Local Namespace Entity ID (0040,0031), Universal Entity ID (0040,0032) and Universal Entity ID Type (0040,0033) of the Item of the Issuer of Admission ID Sequence (0038,0014) in created UPS. Format: <Local Namespace Entity ID>[‘&’<Universal Entity ID>’&’<Universal Entity ID Type>]

(dicomIssuerOfAdmissionID)

Accession Number

string

Value of Accession Number (0008,0050) in Item of Referenced Request Sequence (0040,A370) in created UPS. {<SEG>-<Seq#>[.<Comp#>[.<SubComp#>]]} will be replaced by the value of that field in the received HL7 message.

(dcmAccessionNumber)

Issuer of Accession Number

string

Value of Local Namespace Entity ID (0040,0031), Universal Entity ID (0040,0032) and Universal Entity ID Type (0040,0033) in Item of Issuer of Accession Number Sequence (0008,0051) in Item of Referenced Request Sequence (0040,A370) in created UPS. Format: <Local Namespace Entity ID>[‘&’<Universal Entity ID>’&’<Universal Entity ID Type>]

(dicomIssuerOfAccessionNumber)

Requested Procedure ID

string

Value of Requested Procedure ID (0040,1001) in Item of Referenced Request Sequence (0040,A370) in created UPS. {<SEG>-<Seq#>[.<Comp#>[.<SubComp#>]]} will be replaced by the value of that field in the received HL7 message.

(dcmRequestedProcedureID)

Requested Procedure Description

string

Value of Requested Procedure Description (0032,1060) in Item of Referenced Request Sequence (0040,A370) in created UPS. {<SEG>-<Seq#>[.<Comp#>[.<SubComp#>]]} will be replaced by the value of that field in the received HL7 message.

(dcmRequestedProcedureDescription)

Requesting Physician

string

Value of Requesting Physician (0032,1032) in Item of Referenced Request Sequence (0040,A370) in created UPS. {<SEG>-<Seq#>[.<Comp#>[.<SubComp#>]]} will be replaced by the value of that field in the received HL7 message.

(dcmRequestingPhysician)

Requesting Service

string

Value of Requesting Service (0032,1033) in Item of Referenced Request Sequence (0040,A370) in created UPS. {<SEG>-<Seq#>[.<Comp#>[.<SubComp#>]]} will be replaced by the value of that field in the received HL7 message.

(dcmRequestingService)

XSL Stylesheet URI

string

Specifies URI of the XSL style sheet to to transcode received HL7 message to include attributes in created UPS.

(dcmURI)