The Demo site for our new HL7 Version 2+ (plus) Standard
visit the hl7 website

Draft Website - For Review Purposes Only

RPT - repeat pattern

HL7 Component Table - RPT - repeat pattern
Seq# Description Data Type Usage Vocabulary Length C.LEN Flags
RPT
1 Repeat Pattern Code CWE R
0335(S) Repeat Pattern(Suggested)
   
2 Calendar Alignment ID O
0527(R) Calendar Alignment(Required)
[2..2]    
3 Phase Range Begin Value NM O
 10
4 Phase Range End Value NM O
 10
5 Period Quantity NM O
 10
6 Period Units CWE C
   
7 Institution Specified Time ID O
0136(R) Yes/no Indicator(Required)
[1..1]    
8 Event ID O
0528(R) Event Related Period(Required)
[2..3]    
9 Event Offset Quantity NM O
 10
10 Event Offset Units CWE C
   
11 General Timing Specification GTS O
   

Components: <Repeat Pattern Code (CWE)> & <Calendar Alignment (ID)> & <Phase Range Begin Value (NM)> & <Phase Range End Value (NM)> & <Period Quantity (NM)> & <Period Units (CWE)> & <Institution Specified Time (ID)> & <Event (ID)> & <Event Offset Quantity (NM)> & <Event Offset Units (CWE)> & <General Timing Specification (GTS)>

Subcomponents for Repeat Pattern Code (CWE): <Identifier (ST)> ^ <Text (ST)> ^ <Name of Coding System (ID)> ^ <Alternate Identifier (ST)> ^ <Alternate Text (ST)> ^ <Name of Alternate Coding System (ID)> ^ <Coding System Version ID (ST)> ^ <Alternate Coding System Version ID (ST)> ^ <Original Text (ST)> ^ <Second Alternate Identifier (ST)> ^ <Second Alternate Text (ST)> ^ <Name of Second Alternate Coding System (ID)> ^ <Second Alternate Coding System Version ID (ST)> ^ <Coding System OID (ST)> ^ <Value Set OID (ST)> ^ <Value Set Version ID (DTM)> ^ <Alternate Coding System OID (ST)> ^ <Alternate Value Set OID (ST)> ^ <Alternate Value Set Version ID (DTM)> ^ <Second Alternate Coding System OID (ST)> ^ <Second Alternate Value Set OID (ST)> ^ <Second Alternate Value Set Version ID (DTM)>

Subcomponents for Period Units (CWE): <Identifier (ST)> ^ <Text (ST)> ^ <Name of Coding System (ID)> ^ <Alternate Identifier (ST)> ^ <Alternate Text (ST)> ^ <Name of Alternate Coding System (ID)> ^ <Coding System Version ID (ST)> ^ <Alternate Coding System Version ID (ST)> ^ <Original Text (ST)> ^ <Second Alternate Identifier (ST)> ^ <Second Alternate Text (ST)> ^ <Name of Second Alternate Coding System (ID)> ^ <Second Alternate Coding System Version ID (ST)> ^ <Coding System OID (ST)> ^ <Value Set OID (ST)> ^ <Value Set Version ID (DTM)> ^ <Alternate Coding System OID (ST)> ^ <Alternate Value Set OID (ST)> ^ <Alternate Value Set Version ID (DTM)> ^ <Second Alternate Coding System OID (ST)> ^ <Second Alternate Value Set OID (ST)> ^ <Second Alternate Value Set Version ID (DTM)>

Subcomponents for Event Offset Units (CWE): <Identifier (ST)> ^ <Text (ST)> ^ <Name of Coding System (ID)> ^ <Alternate Identifier (ST)> ^ <Alternate Text (ST)> ^ <Name of Alternate Coding System (ID)> ^ <Coding System Version ID (ST)> ^ <Alternate Coding System Version ID (ST)> ^ <Original Text (ST)> ^ <Second Alternate Identifier (ST)> ^ <Second Alternate Text (ST)> ^ <Name of Second Alternate Coding System (ID)> ^ <Second Alternate Coding System Version ID (ST)> ^ <Coding System OID (ST)> ^ <Value Set OID (ST)> ^ <Value Set Version ID (DTM)> ^ <Alternate Coding System OID (ST)> ^ <Alternate Value Set OID (ST)> ^ <Alternate Value Set Version ID (DTM)> ^ <Second Alternate Coding System OID (ST)> ^ <Second Alternate Value Set OID (ST)> ^ <Second Alternate Value Set Version ID (DTM)>

Definition: The repeat pattern data type should be used where it is necessary to define the frequency at which an event is to take place. This data type provides a way to define repeat pattern codes "on the fly". The repeat pattern code is equivalent to the TQ data type, component 2, sub-component 1 (repeat pattern). The additional components define the meaning of the repeat pattern code. Components 2 - 10 are used to define relatively simple repeat patterns. Component 11 is provided to define complex repeat patterns. This data type forms a bridge between the 2.x Repeat Pattern concept from Quantity/Timing, and the Version 3.0 GTS General Timing Specification. Component 1 is the 2.x concept of repeat pattern. Components 2-7 are derived from the version 3.0 data type PIVL. Components 8-10 are derived from the version 3.0 EIVL data type. If a repeat pattern cannot be defined using components 2-10, then component 11, General Timing Specification is provided. This allows the full literal form of the version 3.0 GTS to be specified.

When using the RPT, if an application doesn't recognize the code in component 1, then it may attempt to determine the appropriate frequency using the remaining components. If the application does recognize the code in component 1, the application is not required to determine the frequency from the remaining components.

Use Case: The use case supporting this proposal is the need to define repeat patterns on the fly while placing an order. The TQ data type did not have the capability to define the meaning of a repeat pattern on the fly. To get around this problem, vendors have implemented a variety of solutions to solve this issue. One way was to add Z-components to the TQ data type to transmit information about the repeat pattern. Another solution was to attempt to parse the repeat pattern code in an attempt to decipher what the code meant.

Examples:

|Q1H&Every 1 Hour&HL7xxx^^^^1^h|

|Q2J2&Every second Tuesday&HL7xxx^DW^2^^2^wk|

|BID&Twice a day at institution specified times&HL7xxx^^^^12^h^Y|

|QAM&Every morning at the institution specified time&HL7xxx^HD^00^11^1^d^Y|

|QHS&Every day before the hours of sleep&HL7xxx^^^^1^d^^AHS|

|ACM&Before Breakfast&HL7xxx^^^^^^^ACM|

RPT-1: Repeat Pattern Code (CWE)

Definition: A code representing the repeat pattern defined by the other components of this data type. Refer to User-defined Table 0335 – Repeat Pattern for suggested values.

RPT-2: Calendar Alignment (ID)

Definition: Specifies an alignment of the repetition to a calendar (e.g., to distinguish every 30 days from “the 5th of every month”). Refer to HL7 Table 0527 - Calendar Alignment for valid values.

RPT-3: Phase Range Begin Value (NM)

Definition: Used for Calendar aligned repeat patterns to determine the amount of time from the beginning of particular RPT.2 - Calendar Alignment to the beginning of the phase. If Calendar Alignment is DW (days of week), then this would be the offset from the beginning of the week.

If Phase Range Begin Value is populated, but Phase Range End Value is not populated, then this component defines when the period (RPT.5, 6) begins.

If both Phase Range Begin Value and Phase Range End Value are populated, then this component defines the earliest point in time at which the period (RPT.5, 6) will begin.

The units of measure for this component are derived from the Calendar Alignment value in RPT.2. See HL7 Table 0527 - Calendar Alignment for the units of measure associated with a particular calendar alignment.

RPT-4: Phase Range End Value (NM)

Definition: Used for Calendar aligned repeat patterns to determine the amount of time from the beginning of particular RPT.2 - Calendar Alignment to the end of the phase.

If Phase Range End Value is populated, but Phase Range Begin Value is not populated, then this component defines when the timing period (RPT.5, 6) begins.

If both Phase Range Begin Value and Phase Range End Value are populated, then this component defines the latest point in time at which the period (RPT.5, 6) will begin.

The units of measure for this component are derived from the Calendar Alignment value in RPT.2. See HL7 Table 0527 - Calendar Alignment for the units of measure associated with a particular calendar alignment.

RPT-5: Period Quantity (NM)

Definition: A time duration specifying the frequency at which the periodic interval repeats. RPT.6 - Period Units defines the units of time for this component.

RPT-6: Period Units (CWE)

Definition: Defines the units used for RPT.5 - Period Quantity. Constrained to units of time. Best practice is to use UCUM. Refer to External table the Unified Code for Units of Measure (UCUM) [http://aurora.rg.iupui.edu/UCUM] for valid values.

Condition Rule: This component is required if RPT.5 - Period Quantity is populated.

RPT-7: Institution Specified Time (ID)

Definition: A code that indicates whether the exact timing is up to the party executing the schedule (e.g., to distinguish “every 8 hours” from “3 times a day”). Refer to HL7 Table 0136 - Yes/No Indicator for valid values.

RPT-8: Event (ID)

Definition: A code for a common (periodical) activity of daily living. Refer to HL7 Table 0528 - Event-Related Period for valid values.

RPT-9: Event Offset Quantity (NM)

Definition: An interval that marks the offsets for the beginning, width and end of the event-related periodic interval measured from the time each such event actually occurred. A positive numeric value indicates the amount of time after the event in RPT.8. A negative numeric value indicates the amount of time prior to the event in RPT.8. RPT.10 - Event Offset Units defines the units of time for this component.

Usage Note: This component should not be valued unless there is a value in RPT-8 (Event).

RPT-10: Event Offset Units (CWE)

Definition: Defines the units used for RPT-9 (Event Offset Quantity). Constrained to units of time. The codes for unit of measure are specified in the Unified Code for Units of Measure (UCUM) [http://aurora.rg.iupui.edu/UCUM].

Condition Rule: This component is required if RPT.9 - Event Offset Quantity is populated.

RPT-11: General Timing Specification (GTS)

Definition: The General Timing Specification as defined by the Version 3 Data Types document.