4.4.2.1.3.8.29. HL7 Prefetch Rule

HL7 Prefetch Rule

Table 4.121 HL7 Prefetch Rule Attributes (LDAP Object: hl7PrefetchRule)

Name	Type	Description (LDAP Attribute)
Name	string	Arbitrary/Meaningful name of the Prefetch Rule (cn)
Queue Name	string	Name of Task Queue used for scheduling retrieve tasks triggered by this Prefetch Rule (dcmQueueName)
Archive AE title	string	AE Title of Archive Application Entity used for retrieving selected Studies from Prefetch C-Move SCP. (dicomAETitle)
Prefetch C-Find SCP	string	AE Title of C-FIND SCP which is queried for Studies matching the specified Entity Selector. (dcmPrefetchCFindSCP)
Prefetch C-Move SCP	string	AE Title of C-MOVE SCP from which selected Studies are retrieved. (dcmPrefetchCMoveSCP)
Prefetch C-Store SCP(s)	string	AE Title of C-STORE SCP to which selected Studies are retrieved. (dcmPrefetchCStoreSCP)
Destination C-FIND SCP	string	Suppress retrieve of selected Studies from Prefetch C-Move SCP which are (already) available at specified Destination C-FIND SCP with equal or more Number of Study Related Instances as returned by Prefetch C-FIND SCP. Retrieve all selected Studies if absent. (dcmDestinationCFindSCP)
Prefetch Device Name	string	Specifies Device on which the Retrieve Task(s) shall be scheduled. If not specified, the Retrieve Task(s) is/are scheduled on the Device which received the HL7 messages. (dicomDeviceName)
Conditions(s)	string	Conditions in format {SEG}-{Seq#}[.{Comp#}[.{SubComp#}]][!]={regEx}. Example: MSH-4=FORWARD or MSH-9=ORM^O01 or PID-3[.3]=PIDIssuer or PID-3[.3[.2]]=PIDIssuerUniversalEntityIDType (dcmProperty)
Entity Selector(s)	string	Specifies matching keys used to select Studies to prefetch. Format: {key}={value}[&{key}={value)]…, with {key} = ‘priors’ | ‘StudyAge’ | {attributeID}. {value} in the format ‘$’{SEG}-{Seq#}[.{Comp#}[.{SubComp#}]] are replaced by the value of the specified HL7 field from the received HL7 message which triggered the prefetch. If no Entity Selector is specified, all Studies for the Patient will be pre-fetched. Example: ‘priors=2&StudyAge=-5Y&ModalitiesInStudy=$OBR-24’ => select at most 2 prior Studies not older than 5 years containing at least one Series with Modality from OBR-24. (dcmEntitySelector)
Ignore Assigning Authority of Patient ID	string	Conditionally ignore Assigning Authority of Patient ID (PID-3.4) in received HL7 message which triggered the prefetch for selecting Studies of the Patient. Enumerated values: ALWAYS MATCHING NOT_MATCHING (dcmNullifyIssuerOfPatientID)
Assigning Authority of Patient ID(s)	string	Assigning Authority of Patient ID against values in received HL7 message are matched, if Assigning Authority of Patient ID is set to MATCHING or NOT_MATCHING. Format: <Issuer of Patient ID> [& <Universal Entity ID> & <Universal Entity ID Type>]. (dcmIssuerOfPatientID)
Prefetch for Assigning Authority of Patient ID	string	Assigning Authority of Patient ID in received HL7 message used to search qualified patient identifier in list of identifiers in PID-3. Studies matching the specified Entity Selector of this qualified patient identifier shall be queried. If absent, by default the first qualified patient identifier in PID-3 shall be used. Format: <Issuer of Patient ID> [& <Universal Entity ID> & <Universal Entity ID Type>]. (dcmPrefetchForIssuerOfPatientID)
Suppress Duplicate Retrieve Interval	string	Suppress Retrieve of Studies already retrieved not earlier than the specified interval to avoid duplicate retrieves. (dcmDuration)
Suppress Duplicate History Size	integer	Maximum number of HL7 messages with distinct PID-3 triggering this rule to remember on the history list. (dcmHistorySize)
Prefetch Date Time Field	string	Delay retrieve of selected Studies to time from referred HL7 TS field in format {SEG}-{Seq#}[.{Comp#}]. Example: TQ1-7 or SCH-11.4. Schedule retrieve of selected Studies immediate if absent. (dcmPrefetchDateTimeField)
Prefetch In Advance	string	Schedule retrieve of selected Studies in advance to the time from configured dcmPrefetchDateTimeField with given time span in ISO-8601 duration format PnDTnHnMn.nS. Not effective, if dcmPrefetchDateTimeField is absent. (dcmPrefetchInAdvance)
Prefetch Schedule(s)	string	Delay prefetch to specified time periods in addition to configured Prefetch Date Time field. If no Prefetch Schedule is specified, queue a Prefetch Task for the selected Studies of the Patient based on configured Prefetch Date Time field. Format: ‘hour=[0-23] dayOfWeek=[0-6]’ (0=Sunday) (dcmSchedule)