The BHS segment defines the start of a batch.
HL7 Attribute Table - BHS - Batch Header
| Base Framework | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|
| Seq# | Data Element | Description | Flags | Implement | Cardinality | Length | C.LEN | Vocabulary | Data Type | |
 BHS | ||||||||||
  | 1 | 00081 | Batch Field Separator | SHOULD | [1..1] | [1..1] | ST String Data | |||
| 2 | 00082 | Batch Encoding Characters | SHOULD | [1..1] | [4..5] | ST String Data | |||
| 3 | 00083 | Batch Sending Application | MAY | [0..1] | HD Hierarchic Designator | ||||
| 4 | 00084 | Batch Sending Facility | MAY | [0..1] | HD Hierarchic Designator | ||||
| 5 | 00085 | Batch Receiving Application | MAY | [0..1] | HD Hierarchic Designator | ||||
| 6 | 00086 | Batch Receiving Facility | MAY | [0..1] | HD Hierarchic Designator | ||||
| 7 | 00087 | Batch Creation Date/Time | MAY | [0..1] | DTM Date/Time | ||||
| 8 | 00088 | Batch Security | = Truncation not allowed! | MAY | [0..1] | 40 | ST String Data | ||
| 9 | 00089 | Batch Name/ID/Type | = Truncation not allowed! | MAY | [0..1] | 40 | ST String Data | ||
| 10 | 00090 | Batch Comment | = Truncation allowed. | MAY | [0..1] | 80 | ST String Data | ||
| 11 | 00091 | Batch Control ID | = Truncation not allowed! | MAY | [0..1] | 20 | ST String Data | ||
| 12 | 00092 | Reference Batch Control ID | = Truncation not allowed! | MAY | [0..1] | 20 | ST String Data | ||
| 13 | 02271 | Batch Sending Network Address | MAY | [0..1] | HD Hierarchic Designator | ||||
| 14 | 02272 | Batch Receiving Network Address | MAY | [0..1] | HD Hierarchic Designator | ||||
 | 15 | 02429 | Security Classification Tag | C Condition defined for this element | MAY | [0..1] | TODO: foreign value set!! | CWE Coded with Exceptions | ||
| 16 | 02430 | Security Handling Instructions | C Condition defined for this element | MAY | [0..*] | TODO: foreign value set!! | CWE Coded with Exceptions | ||
 | 17 | 02431 | Special Access Restriction Instructions | C Condition defined for this element | MAY | [0..*] | ST String Data | |||
The root for the expression is on the segment.
| Seq. | Referenced Elements | Introduction | Invariant | Comment | proposed Optionality |
|---|---|---|---|---|---|
| 1 | BHS-15 | Required if BHS-16 or BHS-17 or any contained FSH-16 or FSH-17 or MSH-26 or MSH-27 is valued, Optional if neither BHS-16 nor BHS-17 , nor any contained FSH-16 or FSH-17, nor MSH-26 nor MSH-27is valued." | BHS[16].hasValue() or BHS[19{.hasValue() | perhaps a more complext invariant is necessary to fully express the condition | RE |
| 2 | BHS-16 | THIS FIELD DOES NOT HAVE A CONDITION STATEMENT | n/a | DEFINED IN ERROR? | O |
| 3 | BHS-17 | THIS FIELD DOES NOT HAVE A CONDITION STATEMENT | n/a | DEFINED IN ERROR? | O |
| Seq# | Data Element | Description | Flags | Implement | Cardinality | Length | C.LEN | Vocabulary | Data Type | |
|---|---|---|---|---|---|---|---|---|---|---|
| BHS | ||||||||||
| 1 | 00081 | Batch Field Separator | SHALL | [1..1] | [1..1] | ST String Data | |||
| 2 | 00082 | Batch Encoding Characters | SHALL | [1..1] | [4..5] | ST String Data | |||
| 3 | 00083 | Batch Sending Application | MAY | [0..1] | HD Hierarchic Designator | ||||
| 4 | 00084 | Batch Sending Facility | MAY | [0..1] | HD Hierarchic Designator | ||||
| 5 | 00085 | Batch Receiving Application | MAY | [0..1] | HD Hierarchic Designator | ||||
| 6 | 00086 | Batch Receiving Facility | MAY | [0..1] | HD Hierarchic Designator | ||||
| 7 | 00087 | Batch Creation Date/Time | MAY | [0..1] | DTM Date/Time | ||||
| 8 | 00088 | Batch Security | = Truncation not allowed! | MAY | [0..1] | 40 | ST String Data | ||
| 9 | 00089 | Batch Name/ID/Type | = Truncation not allowed! | MAY | [0..1] | 40 | ST String Data | ||
| 10 | 00090 | Batch Comment | = Truncation allowed. | MAY | [0..1] | 80 | ST String Data | ||
| 11 | 00091 | Batch Control ID | = Truncation not allowed! | MAY | [0..1] | 20 | ST String Data | ||
| 12 | 00092 | Reference Batch Control ID | = Truncation not allowed! | MAY | [0..1] | 20 | ST String Data | ||
| 13 | 02271 | Batch Sending Network Address | MAY | [0..1] | HD Hierarchic Designator | ||||
| 14 | 02272 | Batch Receiving Network Address | MAY | [0..1] | HD Hierarchic Designator | ||||
| 15 | 02429 | Security Classification Tag | C Condition defined for this element | MAY | [0..1] | CWE Coded with Exceptions | |||
| 16 | 02430 | Security Handling Instructions | C Condition defined for this element | MAY | [0..*] | CWE Coded with Exceptions | |||
| 17 | 02431 | Special Access Restriction Instructions | C Condition defined for this element | MAY | [0..*] | ST String Data | |||
| Base Framework | Base Standard Profile | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Seq# | Data Element | Description | Flags | Implement | Cardinality | Length | C.LEN | Vocabulary | Data Type | Implement | Vocabulary | |
| BHS | ||||||||||||
| 1 | 00081 | Batch Field Separator | SHOULD | [1..1] | [1..1] | ST String Data | SHALL | ||||
| 2 | 00082 | Batch Encoding Characters | SHOULD | [1..1] | [4..5] | ST String Data | SHALL | ||||
| 3 | 00083 | Batch Sending Application | MAY | [0..1] | HD Hierarchic Designator | MAY | |||||
| 4 | 00084 | Batch Sending Facility | MAY | [0..1] | HD Hierarchic Designator | MAY | |||||
| 5 | 00085 | Batch Receiving Application | MAY | [0..1] | HD Hierarchic Designator | MAY | |||||
| 6 | 00086 | Batch Receiving Facility | MAY | [0..1] | HD Hierarchic Designator | MAY | |||||
| 7 | 00087 | Batch Creation Date/Time | MAY | [0..1] | DTM Date/Time | MAY | |||||
| 8 | 00088 | Batch Security | = Truncation not allowed! | MAY | [0..1] | 40 | ST String Data | MAY | |||
| 9 | 00089 | Batch Name/ID/Type | = Truncation not allowed! | MAY | [0..1] | 40 | ST String Data | MAY | |||
| 10 | 00090 | Batch Comment | = Truncation allowed. | MAY | [0..1] | 80 | ST String Data | MAY | |||
| 11 | 00091 | Batch Control ID | = Truncation not allowed! | MAY | [0..1] | 20 | ST String Data | MAY | |||
| 12 | 00092 | Reference Batch Control ID | = Truncation not allowed! | MAY | [0..1] | 20 | ST String Data | MAY | |||
| 13 | 02271 | Batch Sending Network Address | MAY | [0..1] | HD Hierarchic Designator | MAY | |||||
| 14 | 02272 | Batch Receiving Network Address | MAY | [0..1] | HD Hierarchic Designator | MAY | |||||
| 15 | 02429 | Security Classification Tag | C Condition defined for this element | MAY | [0..1] | TODO: foreign value set!! | CWE Coded with Exceptions | MAY | |||
| 16 | 02430 | Security Handling Instructions | C Condition defined for this element | MAY | [0..*] | TODO: foreign value set!! | CWE Coded with Exceptions | MAY | |||
| 17 | 02431 | Special Access Restriction Instructions | C Condition defined for this element | MAY | [0..*] | ST String Data | MAY | ||||
| Base Framework | Base Standard Profile | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Seq# | Data Element | Description | Flags | Optionality | Repetition | Length | C.LEN | Table | Data Type | Optionality | Table | |
| BHS |
||||||||||||
|
1 | 00081 | Batch Field Separator | O | [1..1] | ST String Data |
R | |||||
|
2 | 00082 | Batch Encoding Characters | O | [4..5] | ST String Data |
R | |||||
|
3 | 00083 | Batch Sending Application | O | HD Hierarchic Designator |
|||||||
|
4 | 00084 | Batch Sending Facility | O | HD Hierarchic Designator |
|||||||
|
5 | 00085 | Batch Receiving Application | O | HD Hierarchic Designator |
|||||||
|
6 | 00086 | Batch Receiving Facility | O | HD Hierarchic Designator |
|||||||
|
7 | 00087 | Batch Creation Date/Time | O | DTM Date/Time |
|||||||
|
8 | 00088 | Batch Security | O | 40= | ST String Data |
||||||
|
9 | 00089 | Batch Name/ID/Type | O | 40= | ST String Data |
||||||
|
10 | 00090 | Batch Comment | O | 80# | ST String Data |
||||||
|
11 | 00091 | Batch Control ID | O | 20= | ST String Data |
||||||
|
12 | 00092 | Reference Batch Control ID | O | 20= | ST String Data |
||||||
|
13 | 02271 | Batch Sending Network Address | O | HD Hierarchic Designator |
|||||||
|
14 | 02272 | Batch Receiving Network Address | O | HD Hierarchic Designator |
|||||||
|
15 | 02429 | Security Classification Tag | C Condition defined for this element |
O | CWE Coded with Exceptions |
(0952) | |||||
|
16 | 02430 | Security Handling Instructions | C Condition defined for this element |
O | Y | CWE Coded with Exceptions |
(0953) | ||||
|
17 | 02431 | Special Access Restriction Instructions | C Condition defined for this element |
O | Y | ST String Data |
|||||
| Seq# | Data Element | Description | Optionality | Repetition | Length | C.LEN | Table | Data Type | |
|---|---|---|---|---|---|---|---|---|---|
| BHS |
|||||||||
|
1 | 00081 | Batch Field Separator | R | [1..1] | ST String Data |
|||
|
2 | 00082 | Batch Encoding Characters | R | [4..5] | ST String Data |
|||
|
3 | 00083 | Batch Sending Application | O | HD Hierarchic Designator |
||||
|
4 | 00084 | Batch Sending Facility | O | HD Hierarchic Designator |
||||
|
5 | 00085 | Batch Receiving Application | O | HD Hierarchic Designator |
||||
|
6 | 00086 | Batch Receiving Facility | O | HD Hierarchic Designator |
||||
|
7 | 00087 | Batch Creation Date/Time | O | DTM Date/Time |
||||
|
8 | 00088 | Batch Security | O | 40= | ST String Data |
|||
|
9 | 00089 | Batch Name/ID/Type | O | 40= | ST String Data |
|||
|
10 | 00090 | Batch Comment | O | 80# | ST String Data |
|||
|
11 | 00091 | Batch Control ID | O | 20= | ST String Data |
|||
|
12 | 00092 | Reference Batch Control ID | O | 20= | ST String Data |
|||
|
13 | 02271 | Batch Sending Network Address | O | HD Hierarchic Designator |
||||
|
14 | 02272 | Batch Receiving Network Address | O | HD Hierarchic Designator |
||||
|
15 | 02429 | Security Classification Tag | C | (0952) | CWE Coded with Exceptions |
|||
|
16 | 02430 | Security Handling Instructions | C | Y | (0953) | CWE Coded with Exceptions |
||
|
17 | 02431 | Special Access Restriction Instructions | C | Y | ST String Data |
|||
Definition: This field contains the separator between the segment ID and the first real field, BHS-2 Batch Encoding Characters. As such it serves as the separator and defines the character to be used as a separator for the rest of the message. Recommended value is | (ASCII 124).
Definition: This field contains the five characters in the following order: the component separator, repetition separator, escape characters, subcomponent separator, and truncation character. Recommended values are ^~\&# (ASCII 94, 126, 92, 38,and 35, respectively). See Section 2.5.4, "Message delimiters."
Definition: This field uniquely identifies the sending application among all other applications within the network enterprise. The network enterprise consists of all those applications that participate in the exchange of HL7 messages within the enterprise. Entirely site-defined.
Definition: This field contains the address of one of several occurrences of the same application within the sending system. Absent other considerations, the Medicare Provider ID might be used with an appropriate sub-identifier in the second component. Entirely site-defined.
Definition: This field uniquely identifies the receiving applications among all other applications within the network enterprise. The network enterprise consists of all those applications that participate in the exchange of HL7 messages within the enterprise. Entirely site-defined.
Definition: This field identifies the receiving application among multiple identical instances of the application running on behalf of different organizations. See comments 2.14.2.4, "BHS-4 Batch Sending Facility (HD) 00084." Entirely site-defined.
Definition: This field contains the date/time that the sending system created the message. If the time zone is specified, it will be used throughout the message as the default time zone.
Definition: In some applications of HL7, this field is used to implement security features. For codified expression of security tags using BHS-15 through BHS-17.
Definition: This field can be used by the application processing the batch. It can have extra components if needed.
Definition: This field is a comment field that is not further defined in the HL7 protocol.
Definition: This field is used to uniquely identify a particular batch. It can be echoed back in BHS-12 Reference Batch Control ID if an answering batch is needed.
Definition: This field contains the value of BHS-11 Batch Control ID when this batch was originally transmitted. Not present if this batch is being sent for the first time. See definition for BHS-11 Batch Control ID.
Definition: Identifier of the network location the message was transmitted from. Identified by an OID or text string (e.g., URI). The reader is referred to the "Report from the Joint W3C/IETF URI Planning Interest Group: Uniform Resource Identifiers (URIs), URLs, and Uniform Resource Names (URNs): Clarifications and Recommendations".
As with the Sending/Receiving Responsible Organization, the Sending Network Address provides a more detailed picture of the source of the message. This information is lower than the application layer, but is often useful/necessary for routing and identification purposes. This field SHALL only be populated when the underlying communication protocol does not support identification of sending network locations.
The specific values and usage must be site negotiated
Definition: Identifier of the network location the message was transmitted to. Identified by an OID or text string. (e.g., URL).
This is analogous with the Sending Network Address, however in the receiving role.
This field SHALL only be populated when the underlying communication protocol does not support identification receiving network locations.
Definition: This field defines the security classification (as defined by ISO/IEC 2382-8:1998(E/F)/ T-REC-X.812-1995) of an IT resource, in this case the message, which might be used to make access control decisions. It is conditionally required when MSH-27 or MSH-28 are used.
Conditionality Predicate: Required if BHS-16 or BHS-17 or any contained FSH-16 or FSH-17 or MSH-26 or MSH-27 is valued, Optional if neither BHS-16 nor BHS-17 , nor any contained FSH-16 or FSH-17, nor MSH-26 nor MSH-27is valued."
Use of this field supports the business requirement for declaring the level of confidentiality (classification) for a given message.
Refer to Externally-defined HL7 Table 0952 - HL7 Confidentiality Code in Chapter 2C, Code Tables, for suggested values. Use of this table is recommended. The codes in this table are comprehensive, non-overlapping hierarchical codes: Very Restricted > Restricted > Normal > Moderate > Low > Unrestricted. Restrictions to a comprehensive, non-overlapping set of codes is required for purposes of access control system algorithms such as Bell-LaPadula Mode, which isl used to adjudicate access requests against privacy policies.
Definition: This field is repeatable and conveys instructions to users and receivers for secure distribution, transmission, and storage; dictate obligations or mandated actions; specify any action prohibited by refrain policy such as dissemination controls; and stipulate the permissible purpose of use of an IT resource.
Refer to HL7 Table 0953 - Security Control in Chapter 2C, Code Tables, for suggested values. -
Definition: Used to convey specific instructions about the protection of the patient's data , which must be rendered to end users in accordance with patient consent directive, organizational policy, or jurisdictional law. For example, in US law 42 CFR Part 2, disclosed information made with patient consent must include a renderable “Prohibition on re-disclosure” warning (§ 2.32) In addition, organizational policy MAY require that some or all of the ARV field privacy tag values be rendered to end users, e.g., marking a consult note with “Restricted Confidentiality” or with sensitivity tags such as “VIP” or “EMP” for employee of the organization.
This field MAY also be used to specify instructions about the release of information to family and friends (e.g., "Do not release information to patient's brother, Adam Everyman"). These instructions could be in conjunction with other fields (as elected by the system).
The Demo site for our new HL7 Version 2+ (plus) Standard
