| Package | hl7.v2plus |
| Type | StructureDefinition |
| Id | RPT |
| FHIR Version | R5 |
| Source | http://somewhere.org/fhir/uv/v2plus/https://build.fhir.org/ig/HL7/v2ig/StructureDefinition-RPT.html |
| URL | http://hl7.org/v2/StructureDefinition/RPT |
| Version | 0.0.0 |
| Status | active |
| Date | 2025-07-11T16:45:01+00:00 |
| Name | RPT |
| Title | HL7 v2 RPT Data Type |
| Authority | hl7 |
| Description | 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| |
| Type | http://hl7.org/v2/StructureDefinition/RPT |
| Kind | logical |
No resources found
| StructureDefinition | |
| CWE | HL7 v2 CWE Data Type |
| GTS | HL7 v2 GTS Data Type |
| ID | HL7 v2 ID Data Type |
| NM | HL7 v2 Numeric Primitive Type |
| complex-data-type | HL7 v2 Complex Data Type |
| ValueSet | |
| v2-0136 | hl7VS-yes-no-Indicator |
| v2-0335 | hl7VS-repeatPattern |
| v2-0527 | hl7VS-calendarAlignment |
| v2-0528 | hl7VS-eventRelatedPeriod |
| v2-0136 | hl7VS-yes-no-Indicator |
| v2-0335 | hl7VS-repeatPattern |
| v2-0527 | hl7VS-calendarAlignment |
| v2-0528 | hl7VS-eventRelatedPeriod |
Note: links and images are rebased to the (stated) source
Generated Narrative: StructureDefinition RPT
Profile: HL7 v2 Complex Data Type Profile
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  RPT | 0..* | V2ComplexDataType | repeat pattern | |
  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 | |
| 4 | 0..1 | decimal | Phase Range End 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 | |
| Documentation for this format | ||||
FHIR{
"resourceType": "StructureDefinition",
"id": "RPT",
"meta": {
"profile": [
"http://hl7.org/v2/StructureDefinition/complex-data-type-profile"
]
},
"text": {
"status": "extensions",
"div": "<!-- snip (see above) -->"
},
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "informative",
"_valueCode": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom",
"valueCanonical": "http://somewhere.org/fhir/uv/v2plus/ImplementationGuide/hl7.other.uv.v2plus"
}
]
}
}
],
"url": "http://hl7.org/v2/StructureDefinition/RPT",
"version": "0.0.0",
"name": "RPT",
"title": "HL7 v2 RPT Data Type",
"status": "active",
"date": "2025-07-11T16:45:01+00:00",
"publisher": "HL7 International",
"contact": [
{
"telecom": [
{
"system": "url",
"value": "http://hl7.org/Special/committees/v2mgmt"
}
]
}
],
"description": "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.\n\n*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.\n\nExamples:\n\n|Q1H&Every 1 Hour&HL7xxx^^^^1^h|\n\n|Q2J2&Every second Tuesday&HL7xxx^DW^2^^2^wk|\n\n|BID&Twice a day at institution specified times&HL7xxx^^^^12^h^Y|\n\n|QAM&Every morning at the institution specified time&HL7xxx^HD^00^11^1^d^Y|\n\n|QHS&Every day before the hours of sleep&HL7xxx^^^^1^d^^AHS|\n\n|ACM&Before Breakfast&HL7xxx^^^^^^^ACM|",
"fhirVersion": "5.0.0",
"mapping": [
{
"identity": "rim",
"uri": "http://hl7.org/v3",
"name": "RIM Mapping"
}
],
"kind": "logical",
"abstract": false,
"type": "http://hl7.org/v2/StructureDefinition/RPT",
"baseDefinition": "http://hl7.org/v2/StructureDefinition/complex-data-type",
"derivation": "specialization",
"snapshot": {
"extension": [
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/snapshot-base-version",
"valueString": "0.0.0"
}
],
"element": [
{
"id": "RPT",
"path": "RPT",
"short": "repeat pattern",
"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.",
"min": 0,
"max": "*",
"base": {
"path": "Base",
"min": 0,
"max": "*"
},
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "RPT.1",
"extension": [
{
"url": "http://hl7.org/v2/StructureDefinition/optionality",
"valueCode": "R"
}
],
"path": "RPT.1",
"short": "Repeat Pattern Code",
"min": 1,
"max": "1",
"base": {
"path": "RPT.1",
"min": 1,
"max": "1"
},
"type": [
{
"code": "http://hl7.org/v2/StructureDefinition/CWE"
}
],
"binding": {
"strength": "required",
"valueSet": "http://terminology.hl7.org/ValueSet/v2-0335"
}
},
{
"id": "RPT.2",
"extension": [
{
"url": "http://hl7.org/v2/StructureDefinition/optionality",
"valueCode": "O"
},
{
"extension": [
{
"url": "min",
"valueInteger": 2
},
{
"url": "max",
"valueInteger": 2
}
],
"url": "http://hl7.org/v2/StructureDefinition/length"
}
],
"path": "RPT.2",
"short": "Calendar Alignment",
"min": 0,
"max": "1",
"base": {
"path": "RPT.2",
"min": 0,
"max": "1"
},
"type": [
{
"code": "http://hl7.org/v2/StructureDefinition/ID"
}
],
"binding": {
"strength": "required",
"valueSet": "http://terminology.hl7.org/ValueSet/v2-0527"
}
},
{
"id": "RPT.3",
"extension": [
{
"url": "http://hl7.org/v2/StructureDefinition/optionality",
"valueCode": "O"
},
{
"extension": [
{
"url": "length",
"valueInteger": 10
},
{
"url": "noTruncate",
"valueBoolean": true
}
],
"url": "http://hl7.org/v2/StructureDefinition/conformance-length"
}
],
"path": "RPT.3",
"short": "Phase Range Begin Value",
"min": 0,
"max": "1",
"base": {
"path": "RPT.3",
"min": 0,
"max": "1"
},
"type": [
{
"code": "http://hl7.org/v2/StructureDefinition/NM"
}
]
},
{
"id": "RPT.4",
"extension": [
{
"url": "http://hl7.org/v2/StructureDefinition/optionality",
"valueCode": "O"
},
{
"extension": [
{
"url": "length",
"valueInteger": 10
},
{
"url": "noTruncate",
"valueBoolean": true
}
],
"url": "http://hl7.org/v2/StructureDefinition/conformance-length"
}
],
"path": "RPT.4",
"short": "Phase Range End Value",
"min": 0,
"max": "1",
"base": {
"path": "RPT.4",
"min": 0,
"max": "1"
},
"type": [
{
"code": "http://hl7.org/v2/StructureDefinition/NM"
}
]
},
{
"id": "RPT.5",
"extension": [
{
"url": "http://hl7.org/v2/StructureDefinition/optionality",
"valueCode": "O"
},
{
"extension": [
{
"url": "length",
"valueInteger": 10
},
{
"url": "noTruncate",
"valueBoolean": true
}
],
"url": "http://hl7.org/v2/StructureDefinition/conformance-length"
}
],
"path": "RPT.5",
"short": "Period Quantity",
"min": 0,
"max": "1",
"base": {
"path": "RPT.5",
"min": 0,
"max": "1"
},
"type": [
{
"code": "http://hl7.org/v2/StructureDefinition/NM"
}
]
},
{
"id": "RPT.6",
"extension": [
{
"url": "http://hl7.org/v2/StructureDefinition/optionality",
"valueCode": "C"
}
],
"path": "RPT.6",
"short": "Period Units",
"min": 0,
"max": "1",
"base": {
"path": "RPT.6",
"min": 0,
"max": "1"
},
"type": [
{
"code": "http://hl7.org/v2/StructureDefinition/CWE"
}
]
},
{
"id": "RPT.7",
"extension": [
{
"url": "http://hl7.org/v2/StructureDefinition/optionality",
"valueCode": "O"
},
{
"extension": [
{
"url": "min",
"valueInteger": 1
},
{
"url": "max",
"valueInteger": 1
}
],
"url": "http://hl7.org/v2/StructureDefinition/length"
}
],
"path": "RPT.7",
"short": "Institution Specified Time",
"min": 0,
"max": "1",
"base": {
"path": "RPT.7",
"min": 0,
"max": "1"
},
"type": [
{
"code": "http://hl7.org/v2/StructureDefinition/ID"
}
],
"binding": {
"strength": "required",
"valueSet": "http://terminology.hl7.org/ValueSet/v2-0136"
}
},
{
"id": "RPT.8",
"extension": [
{
"url": "http://hl7.org/v2/StructureDefinition/optionality",
"valueCode": "O"
},
{
"extension": [
{
"url": "min",
"valueInteger": 2
},
{
"url": "max",
"valueInteger": 3
}
],
"url": "http://hl7.org/v2/StructureDefinition/length"
}
],
"path": "RPT.8",
"short": "Event",
"min": 0,
"max": "1",
"base": {
"path": "RPT.8",
"min": 0,
"max": "1"
},
"type": [
{
"code": "http://hl7.org/v2/StructureDefinition/ID"
}
],
"binding": {
"strength": "required",
"valueSet": "http://terminology.hl7.org/ValueSet/v2-0528"
}
},
{
"id": "RPT.9",
"extension": [
{
"url": "http://hl7.org/v2/StructureDefinition/optionality",
"valueCode": "O"
},
{
"extension": [
{
"url": "length",
"valueInteger": 10
},
{
"url": "noTruncate",
"valueBoolean": true
}
],
"url": "http://hl7.org/v2/StructureDefinition/conformance-length"
}
],
"path": "RPT.9",
"short": "Event Offset Quantity",
"min": 0,
"max": "1",
"base": {
"path": "RPT.9",
"min": 0,
"max": "1"
},
"type": [
{
"code": "http://hl7.org/v2/StructureDefinition/NM"
}
]
},
{
"id": "RPT.10",
"extension": [
{
"url": "http://hl7.org/v2/StructureDefinition/optionality",
"valueCode": "C"
}
],
"path": "RPT.10",
"short": "Event Offset Units",
"min": 0,
"max": "1",
"base": {
"path": "RPT.10",
"min": 0,
"max": "1"
},
"type": [
{
"code": "http://hl7.org/v2/StructureDefinition/CWE"
}
]
},
{
"id": "RPT.11",
"extension": [
{
"url": "http://hl7.org/v2/StructureDefinition/optionality",
"valueCode": "O"
}
],
"path": "RPT.11",
"short": "General Timing Specification",
"min": 0,
"max": "1",
"base": {
"path": "RPT.11",
"min": 0,
"max": "1"
},
"type": [
{
"code": "http://hl7.org/v2/StructureDefinition/GTS"
}
]
}
]
},
"differential": {
"element": [
{
"id": "RPT",
"path": "RPT",
"short": "repeat pattern",
"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.",
"min": 0,
"max": "*"
},
{
"id": "RPT.1",
"extension": [
{
"url": "http://hl7.org/v2/StructureDefinition/optionality",
"valueCode": "R"
}
],
"path": "RPT.1",
"short": "Repeat Pattern Code",
"min": 1,
"max": "1",
"type": [
{
"code": "http://hl7.org/v2/StructureDefinition/CWE"
}
],
"binding": {
"strength": "required",
"valueSet": "http://terminology.hl7.org/ValueSet/v2-0335"
}
},
{
"id": "RPT.2",
"extension": [
{
"url": "http://hl7.org/v2/StructureDefinition/optionality",
"valueCode": "O"
},
{
"extension": [
{
"url": "min",
"valueInteger": 2
},
{
"url": "max",
"valueInteger": 2
}
],
"url": "http://hl7.org/v2/StructureDefinition/length"
}
],
"path": "RPT.2",
"short": "Calendar Alignment",
"min": 0,
"max": "1",
"type": [
{
"code": "http://hl7.org/v2/StructureDefinition/ID"
}
],
"binding": {
"strength": "required",
"valueSet": "http://terminology.hl7.org/ValueSet/v2-0527"
}
},
{
"id": "RPT.3",
"extension": [
{
"url": "http://hl7.org/v2/StructureDefinition/optionality",
"valueCode": "O"
},
{
"extension": [
{
"url": "length",
"valueInteger": 10
},
{
"url": "noTruncate",
"valueBoolean": true
}
],
"url": "http://hl7.org/v2/StructureDefinition/conformance-length"
}
],
"path": "RPT.3",
"short": "Phase Range Begin Value",
"min": 0,
"max": "1",
"type": [
{
"code": "http://hl7.org/v2/StructureDefinition/NM"
}
]
},
{
"id": "RPT.4",
"extension": [
{
"url": "http://hl7.org/v2/StructureDefinition/optionality",
"valueCode": "O"
},
{
"extension": [
{
"url": "length",
"valueInteger": 10
},
{
"url": "noTruncate",
"valueBoolean": true
}
],
"url": "http://hl7.org/v2/StructureDefinition/conformance-length"
}
],
"path": "RPT.4",
"short": "Phase Range End Value",
"min": 0,
"max": "1",
"type": [
{
"code": "http://hl7.org/v2/StructureDefinition/NM"
}
]
},
{
"id": "RPT.5",
"extension": [
{
"url": "http://hl7.org/v2/StructureDefinition/optionality",
"valueCode": "O"
},
{
"extension": [
{
"url": "length",
"valueInteger": 10
},
{
"url": "noTruncate",
"valueBoolean": true
}
],
"url": "http://hl7.org/v2/StructureDefinition/conformance-length"
}
],
"path": "RPT.5",
"short": "Period Quantity",
"min": 0,
"max": "1",
"type": [
{
"code": "http://hl7.org/v2/StructureDefinition/NM"
}
]
},
{
"id": "RPT.6",
"extension": [
{
"url": "http://hl7.org/v2/StructureDefinition/optionality",
"valueCode": "C"
}
],
"path": "RPT.6",
"short": "Period Units",
"min": 0,
"max": "1",
"type": [
{
"code": "http://hl7.org/v2/StructureDefinition/CWE"
}
]
},
{
"id": "RPT.7",
"extension": [
{
"url": "http://hl7.org/v2/StructureDefinition/optionality",
"valueCode": "O"
},
{
"extension": [
{
"url": "min",
"valueInteger": 1
},
{
"url": "max",
"valueInteger": 1
}
],
"url": "http://hl7.org/v2/StructureDefinition/length"
}
],
"path": "RPT.7",
"short": "Institution Specified Time",
"min": 0,
"max": "1",
"type": [
{
"code": "http://hl7.org/v2/StructureDefinition/ID"
}
],
"binding": {
"strength": "required",
"valueSet": "http://terminology.hl7.org/ValueSet/v2-0136"
}
},
{
"id": "RPT.8",
"extension": [
{
"url": "http://hl7.org/v2/StructureDefinition/optionality",
"valueCode": "O"
},
{
"extension": [
{
"url": "min",
"valueInteger": 2
},
{
"url": "max",
"valueInteger": 3
}
],
"url": "http://hl7.org/v2/StructureDefinition/length"
}
],
"path": "RPT.8",
"short": "Event",
"min": 0,
"max": "1",
"type": [
{
"code": "http://hl7.org/v2/StructureDefinition/ID"
}
],
"binding": {
"strength": "required",
"valueSet": "http://terminology.hl7.org/ValueSet/v2-0528"
}
},
{
"id": "RPT.9",
"extension": [
{
"url": "http://hl7.org/v2/StructureDefinition/optionality",
"valueCode": "O"
},
{
"extension": [
{
"url": "length",
"valueInteger": 10
},
{
"url": "noTruncate",
"valueBoolean": true
}
],
"url": "http://hl7.org/v2/StructureDefinition/conformance-length"
}
],
"path": "RPT.9",
"short": "Event Offset Quantity",
"min": 0,
"max": "1",
"type": [
{
"code": "http://hl7.org/v2/StructureDefinition/NM"
}
]
},
{
"id": "RPT.10",
"extension": [
{
"url": "http://hl7.org/v2/StructureDefinition/optionality",
"valueCode": "C"
}
],
"path": "RPT.10",
"short": "Event Offset Units",
"min": 0,
"max": "1",
"type": [
{
"code": "http://hl7.org/v2/StructureDefinition/CWE"
}
]
},
{
"id": "RPT.11",
"extension": [
{
"url": "http://hl7.org/v2/StructureDefinition/optionality",
"valueCode": "O"
}
],
"path": "RPT.11",
"short": "General Timing Specification",
"min": 0,
"max": "1",
"type": [
{
"code": "http://hl7.org/v2/StructureDefinition/GTS"
}
]
}
]
}
}