HL7 v2+ Specification
0.0.0 - draft

HL7 v2+ Specification, published by HL7 International. This guide is not an authorized publication; it is the continuous build for version 0.0.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/v2ig/ and changes regularly. See the Directory of published versions

Logical Model: HL7 v2 RPT Data Type

Official URL: http://hl7.org/v2/StructureDefinition/RPT Version: 0.0.0
Standards status: Informative Computable Name: RPT

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

Usage:

  • This Logical Model Profile is not used by any profiles in this Implementation Guide

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

This structure is derived from V2ComplexDataType

NameFlagsCard.TypeDescription & Constraintsdoco
.. RPT 0..* V2ComplexDataType repeat pattern
Instances of this logical model are not marked to be the target of a Reference
... 1 1..1 CWE Repeat Pattern Code
Binding: hl7VS-repeatPattern (required)
... 2 0..1 code Calendar Alignment
Binding: hl7VS-calendarAlignment (required)
... 3 0..1 decimal Phase Range Begin Value
... 5 0..1 decimal Period Quantity
... 6 0..1 CWE Period Units
... 7 0..1 code Institution Specified Time
Binding: hl7VS-yes-no-Indicator (required)
... 8 0..1 code Event
Binding: hl7VS-eventRelatedPeriod (required)
... 9 0..1 decimal Event Offset Quantity
... 10 0..1 CWE Event Offset Units
... 11 0..1 string General Timing Specification

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
RPT.1requiredHl7VSRepeatPattern
http://terminology.hl7.org/ValueSet/v2-0335
RPT.2requiredHl7VSCalendarAlignment
http://terminology.hl7.org/ValueSet/v2-0527
RPT.7requiredHl7VSYesNoIndicator
http://terminology.hl7.org/ValueSet/v2-0136
RPT.8requiredHl7VSEventRelatedPeriod
http://terminology.hl7.org/ValueSet/v2-0528
NameFlagsCard.TypeDescription & Constraintsdoco
.. RPT 0..* V2ComplexDataType repeat pattern
Instances of this logical model are not marked to be the target of a Reference
... 1 1..1 CWE Repeat Pattern Code
Binding: hl7VS-repeatPattern (required)
... 2 0..1 code Calendar Alignment
Binding: hl7VS-calendarAlignment (required)
... 3 0..1 decimal Phase Range Begin Value
... 5 0..1 decimal Period Quantity
... 6 0..1 CWE Period Units
... 7 0..1 code Institution Specified Time
Binding: hl7VS-yes-no-Indicator (required)
... 8 0..1 code Event
Binding: hl7VS-eventRelatedPeriod (required)
... 9 0..1 decimal Event Offset Quantity
... 10 0..1 CWE Event Offset Units
... 11 0..1 string General Timing Specification

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
RPT.1requiredHl7VSRepeatPattern
http://terminology.hl7.org/ValueSet/v2-0335
RPT.2requiredHl7VSCalendarAlignment
http://terminology.hl7.org/ValueSet/v2-0527
RPT.7requiredHl7VSYesNoIndicator
http://terminology.hl7.org/ValueSet/v2-0136
RPT.8requiredHl7VSEventRelatedPeriod
http://terminology.hl7.org/ValueSet/v2-0528
NameFlagsCard.TypeDescription & Constraintsdoco
.. RPT 0..* V2ComplexDataType repeat pattern
Instances of this logical model are not marked to be the target of a Reference
... 1 1..1 CWE Repeat Pattern Code
Binding: hl7VS-repeatPattern (required)
... 2 0..1 code Calendar Alignment
Binding: hl7VS-calendarAlignment (required)
... 3 0..1 decimal Phase Range Begin Value
... 5 0..1 decimal Period Quantity
... 6 0..1 CWE Period Units
... 7 0..1 code Institution Specified Time
Binding: hl7VS-yes-no-Indicator (required)
... 8 0..1 code Event
Binding: hl7VS-eventRelatedPeriod (required)
... 9 0..1 decimal Event Offset Quantity
... 10 0..1 CWE Event Offset Units
... 11 0..1 string General Timing Specification

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
RPT.1requiredHl7VSRepeatPattern
http://terminology.hl7.org/ValueSet/v2-0335
RPT.2requiredHl7VSCalendarAlignment
http://terminology.hl7.org/ValueSet/v2-0527
RPT.7requiredHl7VSYesNoIndicator
http://terminology.hl7.org/ValueSet/v2-0136
RPT.8requiredHl7VSEventRelatedPeriod
http://terminology.hl7.org/ValueSet/v2-0528

This structure is derived from V2ComplexDataType

Summary

Mandatory: 0 element(1 nested mandatory element)

Differential View

This structure is derived from V2ComplexDataType

NameFlagsCard.TypeDescription & Constraintsdoco
.. RPT 0..* V2ComplexDataType repeat pattern
Instances of this logical model are not marked to be the target of a Reference
... 1 1..1 CWE Repeat Pattern Code
Binding: hl7VS-repeatPattern (required)
... 2 0..1 code Calendar Alignment
Binding: hl7VS-calendarAlignment (required)
... 3 0..1 decimal Phase Range Begin Value
... 5 0..1 decimal Period Quantity
... 6 0..1 CWE Period Units
... 7 0..1 code Institution Specified Time
Binding: hl7VS-yes-no-Indicator (required)
... 8 0..1 code Event
Binding: hl7VS-eventRelatedPeriod (required)
... 9 0..1 decimal Event Offset Quantity
... 10 0..1 CWE Event Offset Units
... 11 0..1 string General Timing Specification

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
RPT.1requiredHl7VSRepeatPattern
http://terminology.hl7.org/ValueSet/v2-0335
RPT.2requiredHl7VSCalendarAlignment
http://terminology.hl7.org/ValueSet/v2-0527
RPT.7requiredHl7VSYesNoIndicator
http://terminology.hl7.org/ValueSet/v2-0136
RPT.8requiredHl7VSEventRelatedPeriod
http://terminology.hl7.org/ValueSet/v2-0528

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. RPT 0..* V2ComplexDataType repeat pattern
Instances of this logical model are not marked to be the target of a Reference
... 1 1..1 CWE Repeat Pattern Code
Binding: hl7VS-repeatPattern (required)
... 2 0..1 code Calendar Alignment
Binding: hl7VS-calendarAlignment (required)
... 3 0..1 decimal Phase Range Begin Value
... 5 0..1 decimal Period Quantity
... 6 0..1 CWE Period Units
... 7 0..1 code Institution Specified Time
Binding: hl7VS-yes-no-Indicator (required)
... 8 0..1 code Event
Binding: hl7VS-eventRelatedPeriod (required)
... 9 0..1 decimal Event Offset Quantity
... 10 0..1 CWE Event Offset Units
... 11 0..1 string General Timing Specification

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
RPT.1requiredHl7VSRepeatPattern
http://terminology.hl7.org/ValueSet/v2-0335
RPT.2requiredHl7VSCalendarAlignment
http://terminology.hl7.org/ValueSet/v2-0527
RPT.7requiredHl7VSYesNoIndicator
http://terminology.hl7.org/ValueSet/v2-0136
RPT.8requiredHl7VSEventRelatedPeriod
http://terminology.hl7.org/ValueSet/v2-0528

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. RPT 0..* V2ComplexDataType repeat pattern
Instances of this logical model are not marked to be the target of a Reference
... 1 1..1 CWE Repeat Pattern Code
Binding: hl7VS-repeatPattern (required)
... 2 0..1 code Calendar Alignment
Binding: hl7VS-calendarAlignment (required)
... 3 0..1 decimal Phase Range Begin Value
... 5 0..1 decimal Period Quantity
... 6 0..1 CWE Period Units
... 7 0..1 code Institution Specified Time
Binding: hl7VS-yes-no-Indicator (required)
... 8 0..1 code Event
Binding: hl7VS-eventRelatedPeriod (required)
... 9 0..1 decimal Event Offset Quantity
... 10 0..1 CWE Event Offset Units
... 11 0..1 string General Timing Specification

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
RPT.1requiredHl7VSRepeatPattern
http://terminology.hl7.org/ValueSet/v2-0335
RPT.2requiredHl7VSCalendarAlignment
http://terminology.hl7.org/ValueSet/v2-0527
RPT.7requiredHl7VSYesNoIndicator
http://terminology.hl7.org/ValueSet/v2-0136
RPT.8requiredHl7VSEventRelatedPeriod
http://terminology.hl7.org/ValueSet/v2-0528

This structure is derived from V2ComplexDataType

Summary

Mandatory: 0 element(1 nested mandatory element)

 

Other representations of profile: CSV, Excel