HL7 v2 RPT Data Type - Definitions - HL7 v2+ Specification v0.0.0

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: RPT - Detailed Descriptions

Page standards status: Informative

Definitions for the RPT logical model.

Differential Elements Table
Key Elements Table
Snapshot Elements Table

Guidance on how to interpret the contents of this table can be found here

0. RPT
Definition	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.
Short	repeat pattern
Control	0..*
Logical Model	Instances of this logical model are not marked to be the target of a Reference
2. RPT.1
Short	Repeat Pattern Code
Control	1..1
Binding	The codes SHALL be taken from hl7VS-repeatPattern (required to `http://terminology.hl7.org/ValueSet/v2-0335`)
Type	http://hl7.org/v2/StructureDefinition/CWE
4. RPT.2
Short	Calendar Alignment
Control	0..1
Binding	The codes SHALL be taken from hl7VS-calendarAlignment (required to `http://terminology.hl7.org/ValueSet/v2-0527`)
Type	http://hl7.org/v2/StructureDefinition/ID
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
6. RPT.3
Short	Phase Range Begin Value
Control	0..1
Type	http://hl7.org/v2/StructureDefinition/NM
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
8. RPT.4
Short	Phase Range End Value
Control	0..1
Type	http://hl7.org/v2/StructureDefinition/NM
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
10. RPT.5
Short	Period Quantity
Control	0..1
Type	http://hl7.org/v2/StructureDefinition/NM
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
12. RPT.6
Short	Period Units
Control	0..1
Type	http://hl7.org/v2/StructureDefinition/CWE
14. RPT.7
Short	Institution Specified Time
Control	0..1
Binding	The codes SHALL be taken from hl7VS-yes-no-Indicator (required to `http://terminology.hl7.org/ValueSet/v2-0136`)
Type	http://hl7.org/v2/StructureDefinition/ID
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
16. RPT.8
Short	Event
Control	0..1
Binding	The codes SHALL be taken from hl7VS-eventRelatedPeriod (required to `http://terminology.hl7.org/ValueSet/v2-0528`)
Type	http://hl7.org/v2/StructureDefinition/ID
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
18. RPT.9
Short	Event Offset Quantity
Control	0..1
Type	http://hl7.org/v2/StructureDefinition/NM
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
20. RPT.10
Short	Event Offset Units
Control	0..1
Type	http://hl7.org/v2/StructureDefinition/CWE
22. RPT.11
Short	General Timing Specification
Control	0..1
Type	http://hl7.org/v2/StructureDefinition/GTS
Primitive Value	This primitive element may be present, or absent, or replaced by an extension

Guidance on how to interpret the contents of this table can be found here

0. RPT
Definition	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. Base definition for all types defined in FHIR type system.
Short	repeat patternBase for all types and resources
Control	0..*
Is Modifier	false
Logical Model	Instances of this logical model are not marked to be the target of a Reference
2. RPT.1
Short	Repeat Pattern Code
Control	1..1
Binding	The codes SHALL be taken from hl7VS-repeatPattern (required to `http://terminology.hl7.org/ValueSet/v2-0335`)
Type	http://hl7.org/v2/StructureDefinition/CWE
4. RPT.2
Short	Calendar Alignment
Control	0..1
Binding	The codes SHALL be taken from hl7VS-calendarAlignment (required to `http://terminology.hl7.org/ValueSet/v2-0527`)
Type	http://hl7.org/v2/StructureDefinition/ID
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
6. RPT.3
Short	Phase Range Begin Value
Control	0..1
Type	http://hl7.org/v2/StructureDefinition/NM
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
8. RPT.4
Short	Phase Range End Value
Control	0..1
Type	http://hl7.org/v2/StructureDefinition/NM
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
10. RPT.5
Short	Period Quantity
Control	0..1
Type	http://hl7.org/v2/StructureDefinition/NM
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
12. RPT.6
Short	Period Units
Control	0..1
Type	http://hl7.org/v2/StructureDefinition/CWE
14. RPT.7
Short	Institution Specified Time
Control	0..1
Binding	The codes SHALL be taken from hl7VS-yes-no-Indicator (required to `http://terminology.hl7.org/ValueSet/v2-0136`)
Type	http://hl7.org/v2/StructureDefinition/ID
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
16. RPT.8
Short	Event
Control	0..1
Binding	The codes SHALL be taken from hl7VS-eventRelatedPeriod (required to `http://terminology.hl7.org/ValueSet/v2-0528`)
Type	http://hl7.org/v2/StructureDefinition/ID
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
18. RPT.9
Short	Event Offset Quantity
Control	0..1
Type	http://hl7.org/v2/StructureDefinition/NM
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
20. RPT.10
Short	Event Offset Units
Control	0..1
Type	http://hl7.org/v2/StructureDefinition/CWE
22. RPT.11
Short	General Timing Specification
Control	0..1
Type	http://hl7.org/v2/StructureDefinition/GTS
Primitive Value	This primitive element may be present, or absent, or replaced by an extension

Guidance on how to interpret the contents of this table can be found here

0. RPT
Definition	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.
Short	repeat pattern
Control	0..*
Is Modifier	false
Logical Model	Instances of this logical model are not marked to be the target of a Reference
2. RPT.1
Short	Repeat Pattern Code
Control	1..1
Binding	The codes SHALL be taken from hl7VS-repeatPattern (required to `http://terminology.hl7.org/ValueSet/v2-0335`)
Type	http://hl7.org/v2/StructureDefinition/CWE
4. RPT.2
Short	Calendar Alignment
Control	0..1
Binding	The codes SHALL be taken from hl7VS-calendarAlignment (required to `http://terminology.hl7.org/ValueSet/v2-0527`)
Type	http://hl7.org/v2/StructureDefinition/ID
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
6. RPT.3
Short	Phase Range Begin Value
Control	0..1
Type	http://hl7.org/v2/StructureDefinition/NM
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
8. RPT.4
Short	Phase Range End Value
Control	0..1
Type	http://hl7.org/v2/StructureDefinition/NM
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
10. RPT.5
Short	Period Quantity
Control	0..1
Type	http://hl7.org/v2/StructureDefinition/NM
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
12. RPT.6
Short	Period Units
Control	0..1
Type	http://hl7.org/v2/StructureDefinition/CWE
14. RPT.7
Short	Institution Specified Time
Control	0..1
Binding	The codes SHALL be taken from hl7VS-yes-no-Indicator (required to `http://terminology.hl7.org/ValueSet/v2-0136`)
Type	http://hl7.org/v2/StructureDefinition/ID
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
16. RPT.8
Short	Event
Control	0..1
Binding	The codes SHALL be taken from hl7VS-eventRelatedPeriod (required to `http://terminology.hl7.org/ValueSet/v2-0528`)
Type	http://hl7.org/v2/StructureDefinition/ID
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
18. RPT.9
Short	Event Offset Quantity
Control	0..1
Type	http://hl7.org/v2/StructureDefinition/NM
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
20. RPT.10
Short	Event Offset Units
Control	0..1
Type	http://hl7.org/v2/StructureDefinition/CWE
22. RPT.11
Short	General Timing Specification
Control	0..1
Type	http://hl7.org/v2/StructureDefinition/GTS
Primitive Value	This primitive element may be present, or absent, or replaced by an extension

IG © HL7 International. Package hl7.v2plus#0.0.0 based on FHIR 5.0.0. Generated 2024-10-31
Links: Table of Contents | QA Report