The intent of this segment is to describe the information associated with the transportation of the shipment.
HL7 Attribute Table - SHP - Shipment
| Base Framework | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|
| Seq# | Data Element | Description | Flags | Implement | Cardinality | Length | C.LEN | Vocabulary | Data Type | |
 SHP | ||||||||||
  | 1 | 02317 | Shipment ID | SHOULD | [1..1] | EI Entity Identifier | ||||
| 2 | 02318 | Internal Shipment ID | MAY | [0..*] | EI Entity Identifier | ||||
| 3 | 02319 | Shipment Status | MAY | [0..1] | ex.:ShipmentStatus (CD) | CWE Coded with Exceptions | |||
| 4 | 02320 | Shipment Status Date/Time | SHOULD | [1..1] | DTM Date/Time | ||||
| 5 | 02321 | Shipment Status Reason | MAY | [0..1] | TX Text Data | ||||
| 6 | 02322 | Shipment Priority | MAY | [0..1] | repr: V2ActPriority (CD) | CWE Coded with Exceptions | |||
| 7 | 02323 | Shipment Confidentiality | MAY | [0..*] | repr: V2Confidentiality (CD) | CWE Coded with Exceptions | |||
| 8 | 02324 | Number of Packages in Shipment | = Truncation not allowed! | MAY | [0..1] | 4 | NM Numeric | ||
| 9 | 02325 | Shipment Condition | MAY | [0..*] | repr: ContainerCondition (CD) | CWE Coded with Exceptions | |||
| 10 | 02326 | Shipment Handling Code | MAY | [0..*] | repr: SpecialHandlingCode (CD) | CWE Coded with Exceptions | |||
| 11 | 02327 | Shipment Risk Code | MAY | [0..*] | RiskCodes (CD) | CWE Coded with Exceptions | |||
 | 12 | 00816 | Action Code | MAY | [0..1] | [2..2] | univ: SegmentActionCode (CD) hl7VS-segmentActionCode (VS) segmentAction (CS) | ID Coded Value for HL7 Defined Tables | ||
| Seq# | Data Element | Description | Flags | Implement | Cardinality | Length | C.LEN | Vocabulary | Data Type | |
|---|---|---|---|---|---|---|---|---|---|---|
| SHP | ||||||||||
| 1 | 02317 | Shipment ID | SHALL | [1..1] | EI Entity Identifier | ||||
| 2 | 02318 | Internal Shipment ID | MAY | [0..*] | EI Entity Identifier | ||||
| 3 | 02319 | Shipment Status | MAY | [0..1] | ex.:ShipmentStatus (CD) hl7VS-shipmentStatus (VS) shipmentStatus (CS) | CWE Coded with Exceptions | |||
| 4 | 02320 | Shipment Status Date/Time | SHALL | [1..1] | DTM Date/Time | ||||
| 5 | 02321 | Shipment Status Reason | MAY | [0..1] | TX Text Data | ||||
| 6 | 02322 | Shipment Priority | MAY | [0..1] | repr: V2ActPriority (CD) hl7VS-actpriority (VS) actpriority (CS) | CWE Coded with Exceptions | |||
| 7 | 02323 | Shipment Confidentiality | MAY | [0..*] | repr: V2Confidentiality (CD) hl7VS-confidentiality (VS) confidentiality (CS) | CWE Coded with Exceptions | |||
| 8 | 02324 | Number of Packages in Shipment | = Truncation not allowed! | MAY | [0..1] | 4 | NM Numeric | ||
| 9 | 02325 | Shipment Condition | MAY | [0..*] | repr: ContainerCondition (CD) hl7VS-containerCondition (VS) containerCondition (CS) | CWE Coded with Exceptions | |||
| 10 | 02326 | Shipment Handling Code | MAY | [0..*] | repr: SpecialHandlingCode (CD) hl7VS-specialHandlingConsiderations (VS) specialHandling (CS) | CWE Coded with Exceptions | |||
| 11 | 02327 | Shipment Risk Code | MAY | [0..*] | RiskCodes (CD) hl7VS-riskCodes (VS) risks (CS) | CWE Coded with Exceptions | |||
| 12 | 00816 | Action Code | MAY | [0..1] | [2..2] | univ: SegmentActionCode (CD) hl7VS-segmentActionCode (VS) segmentAction (CS) | ID Coded Value for HL7 Defined Tables | ||
| Base Framework | Base Standard Profile | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Seq# | Data Element | Description | Flags | Implement | Cardinality | Length | C.LEN | Vocabulary | Data Type | Implement | Vocabulary | |
| SHP | ||||||||||||
| 1 | 02317 | Shipment ID | SHOULD | [1..1] | EI Entity Identifier | SHALL | |||||
| 2 | 02318 | Internal Shipment ID | MAY | [0..*] | EI Entity Identifier | MAY | |||||
| 3 | 02319 | Shipment Status | MAY | [0..1] | ex.:ShipmentStatus (CD) | CWE Coded with Exceptions | MAY | hl7VS-shipmentStatus (VS) shipmentStatus (CS) | |||
| 4 | 02320 | Shipment Status Date/Time | SHOULD | [1..1] | DTM Date/Time | SHALL | |||||
| 5 | 02321 | Shipment Status Reason | MAY | [0..1] | TX Text Data | MAY | |||||
| 6 | 02322 | Shipment Priority | MAY | [0..1] | repr: V2ActPriority (CD) | CWE Coded with Exceptions | MAY | hl7VS-actpriority (VS) actpriority (CS) | |||
| 7 | 02323 | Shipment Confidentiality | MAY | [0..*] | repr: V2Confidentiality (CD) | CWE Coded with Exceptions | MAY | hl7VS-confidentiality (VS) confidentiality (CS) | |||
| 8 | 02324 | Number of Packages in Shipment | = Truncation not allowed! | MAY | [0..1] | 4 | NM Numeric | MAY | |||
| 9 | 02325 | Shipment Condition | MAY | [0..*] | repr: ContainerCondition (CD) | CWE Coded with Exceptions | MAY | hl7VS-containerCondition (VS) containerCondition (CS) | |||
| 10 | 02326 | Shipment Handling Code | MAY | [0..*] | repr: SpecialHandlingCode (CD) | CWE Coded with Exceptions | MAY | hl7VS-specialHandlingConsiderations (VS) specialHandling (CS) | |||
| 11 | 02327 | Shipment Risk Code | MAY | [0..*] | RiskCodes (CD) | CWE Coded with Exceptions | MAY | hl7VS-riskCodes (VS) risks (CS) | |||
| 12 | 00816 | Action Code | MAY | [0..1] | [2..2] | univ: SegmentActionCode (CD) hl7VS-segmentActionCode (VS) segmentAction (CS) | ID Coded Value for HL7 Defined Tables | MAY | |||
| Base Framework | Base Standard Profile | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Seq# | Data Element | Description | Flags | Optionality | Repetition | Length | C.LEN | Table | Data Type | Optionality | Table | |
| SHP |
||||||||||||
|
1 | 02317 | Shipment ID | O | EI Entity Identifier |
R | ||||||
|
2 | 02318 | Internal Shipment ID | O | Y | EI Entity Identifier |
||||||
|
3 | 02319 | Shipment Status | O | CWE Coded with Exceptions |
(0905) | ||||||
|
4 | 02320 | Shipment Status Date/Time | O | DTM Date/Time |
R | ||||||
|
5 | 02321 | Shipment Status Reason | O | TX Text Data |
|||||||
|
6 | 02322 | Shipment Priority | O | CWE Coded with Exceptions |
(0906) | ||||||
|
7 | 02323 | Shipment Confidentiality | O | Y | CWE Coded with Exceptions |
(0907) | |||||
|
8 | 02324 | Number of Packages in Shipment | O | 4= | NM Numeric |
||||||
|
9 | 02325 | Shipment Condition | O | Y | CWE Coded with Exceptions |
(0544) | |||||
|
10 | 02326 | Shipment Handling Code | O | Y | CWE Coded with Exceptions |
(0376) | |||||
|
11 | 02327 | Shipment Risk Code | O | Y | CWE Coded with Exceptions |
(0489) | |||||
|
12 | 00816 | Action Code | O | [2..2] | ID Coded Value for HL7 Defined Tables |
(0206) | |||||
| Seq# | Data Element | Description | Optionality | Repetition | Length | C.LEN | Table | Data Type | |
|---|---|---|---|---|---|---|---|---|---|
| SHP |
|||||||||
|
1 | 02317 | Shipment ID | R | EI Entity Identifier |
||||
|
2 | 02318 | Internal Shipment ID | O | Y | EI Entity Identifier |
|||
|
3 | 02319 | Shipment Status | O | (0905) | CWE Coded with Exceptions |
|||
|
4 | 02320 | Shipment Status Date/Time | R | DTM Date/Time |
||||
|
5 | 02321 | Shipment Status Reason | O | TX Text Data |
||||
|
6 | 02322 | Shipment Priority | O | (0906) | CWE Coded with Exceptions |
|||
|
7 | 02323 | Shipment Confidentiality | O | Y | (0907) | CWE Coded with Exceptions |
||
|
8 | 02324 | Number of Packages in Shipment | O | 4= | NM Numeric |
|||
|
9 | 02325 | Shipment Condition | O | Y | (0544) | CWE Coded with Exceptions |
||
|
10 | 02326 | Shipment Handling Code | O | Y | (0376) | CWE Coded with Exceptions |
||
|
11 | 02327 | Shipment Risk Code | O | Y | (0489) | CWE Coded with Exceptions |
||
|
12 | 00816 | Action Code | O | [2..2] | (0206) | ID Coded Value for HL7 Defined Tables |
||
Definition: The shipment id is the identifier assigned by the shipment transportation provider that uniquely identifies this shipment from all other shipments by the same provider. The addressee for the shipment should be able to use this identifier to match a physical shipment with the electronic manifest for the shipment.
Definition: The internal shipment id is an identifier assigned to the shipment by the sender or addressee of the shipment. The field repeats allowing multiple identifiers to be transmitted.
Definition: The shipment status specifies where in the shipment process the package is at the time of messaging. Refer to HL7 Table 0905 - Shipment Status for specific values:
Definition: The shipment status date/time carries the date and time the status in SHP-3 Shipment Status occurred.
Definition: The shipment status reason is used to document the reason for the status in SHP-3 Shipment Status. This reason field is of particular importance when a shipment is rejected.
Definition: The shipment priority documents the priority the shipment has been given by the sender. Refer to HL7 Table 0906 - ActPriority for specific values.
Definition: The shipment confidentiality documents any confidentiality that may be associated with this particular shipment. Refer to HL7 Table 0907 - Confidentiality for specific values.
Definition: The number of packages in shipment field documents the total number of separate packages that are contained in the shipment. This total should not include packages that are nested inside of one another. For instance if a shipment consisted of 3 separate boxes, this field would contain the value
"…|3|…".
Definition: The shipment condition field allows the receiver of the shipment to document the condition of the shipment when it was received. Refer to HL7 Table 0544 - Container Condition for suggested values. Many of the values found in Table 0544 are associated with values found in Table 0376 (Special Handling Codes). Values from Table 0376 have had an X placed in front of them, and the meaning of the code has been changed to indicate that the type of handling has failed during shipment. For instance if a handling code indicated that the shipment was to be kept at body temperature (C37), and the shipment arrived at some other temperature, the XC37 condition code would be used to indicate the shipment arrived with a temperature outside the range indicated by the handling code.
Definition: This describes how the shipment needs to be handled during transport. Refer to User-defined Table 0376 - Special Handling Code for suggested values.
Definition: This field contains any known or suspected hazards associated with this shipment, e.g., exceptionally infectious agent or blood from a hepatitis patient. Refer to User-defined Table 0489 - Risk Codes for suggested values.
Definition: This field reveals the intent of the message. Refer to HL7 Table 0206 - Segment Action Code for valid values.
The action code can only be used when SHP-1 is valued in accordance with the guidance in Chapter 2, Section 2.10.4.2.
The Demo site for our new HL7 Version 2+ (plus) Standard
