The FHS segment is used to head a file (group of batches) as defined in Section 2.10.3, "HL7 batch protocol".
HL7 Attribute Table - FHS - File Header
Base Framework | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|
Seq# | Data Element | Description | Flags | Implement | Cardinality | Length | C.LEN | Vocabulary | Data Type | |
FHS | ||||||||||
1 | 00067 | File Field Separator | SHALL | [1..1] | [1..1] | ST String Data | ||||
2 | 00068 | File Encoding Characters | SHALL | [1..1] | [4..5] | ST String Data | ||||
3 | 00069 | File Sending Application | MAY | [0..1] | HD Hierarchic Designator | |||||
4 | 00070 | File Sending Facility | MAY | [0..1] | HD Hierarchic Designator | |||||
5 | 00071 | File Receiving Application | MAY | [0..1] | HD Hierarchic Designator | |||||
6 | 00072 | File Receiving Facility | MAY | [0..1] | HD Hierarchic Designator | |||||
7 | 00073 | File Creation Date/Time | MAY | [0..1] | DTM Date/Time | |||||
8 | 00074 | File Security | = Truncation not allowed! | MAY | [0..1] | 40 | ST String Data | |||
9 | 00075 | File Name/ID | = Truncation not allowed! | MAY | [0..1] | 20 | ST String Data | |||
10 | 00076 | File Header Comment | = Truncation allowed. | MAY | [0..1] | 80 | ST String Data | |||
11 | 00077 | File Control ID | = Truncation not allowed! | MAY | [0..1] | 20 | ST String Data | |||
12 | 00078 | Reference File Control ID | = Truncation not allowed! | MAY | [0..1] | 20 | ST String Data | |||
13 | 02269 | File Sending Network Address | MAY | [0..1] | HD Hierarchic Designator | |||||
14 | 02270 | File 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 |
The root for the expression is on the segment.
Seq. | Referenced Elements | Introduction | Invariant | Comment | proposed Optionality |
---|---|---|---|---|---|
15 | FHS-15 | Required if FHS-16 or FHS-17 is valued, or any contained MSH-26 is valued, Optional if neither FHS-16 nor FHS-17 or any contained MSH-26 is valued.." | hasValue() and (FHS[16].hasValue() or FHS[17],hasValue()) | RE | |
16 | FHS-16 | THIS FIELD DOES NOT HAVE A CONDITION STATEMENT | DEFINED IN ERROR? | O | |
17 | FHS-17 | THIS FIELD DOES NOT HAVE A CONDITION STATEMENT | DEFINED IN ERROR? | O |
Seq# | Data Element | Description | Flags | Implement | Cardinality | Length | C.LEN | Vocabulary | Data Type | |
---|---|---|---|---|---|---|---|---|---|---|
FHS | ||||||||||
1 | 00067 | File Field Separator | SHALL | [1..1] | [1..1] | ST String Data | ||||
2 | 00068 | File Encoding Characters | SHALL | [1..1] | [4..5] | ST String Data | ||||
3 | 00069 | File Sending Application | MAY | [0..1] | HD Hierarchic Designator | |||||
4 | 00070 | File Sending Facility | MAY | [0..1] | HD Hierarchic Designator | |||||
5 | 00071 | File Receiving Application | MAY | [0..1] | HD Hierarchic Designator | |||||
6 | 00072 | File Receiving Facility | MAY | [0..1] | HD Hierarchic Designator | |||||
7 | 00073 | File Creation Date/Time | MAY | [0..1] | DTM Date/Time | |||||
8 | 00074 | File Security | = Truncation not allowed! | MAY | [0..1] | 40 | ST String Data | |||
9 | 00075 | File Name/ID | = Truncation not allowed! | MAY | [0..1] | 20 | ST String Data | |||
10 | 00076 | File Header Comment | = Truncation allowed. | MAY | [0..1] | 80 | ST String Data | |||
11 | 00077 | File Control ID | = Truncation not allowed! | MAY | [0..1] | 20 | ST String Data | |||
12 | 00078 | Reference File Control ID | = Truncation not allowed! | MAY | [0..1] | 20 | ST String Data | |||
13 | 02269 | File Sending Network Address | MAY | [0..1] | HD Hierarchic Designator | |||||
14 | 02270 | File 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 | |
FHS | ||||||||||||
1 | 00067 | File Field Separator | SHALL | [1..1] | [1..1] | ST String Data | SHALL | |||||
2 | 00068 | File Encoding Characters | SHALL | [1..1] | [4..5] | ST String Data | SHALL | |||||
3 | 00069 | File Sending Application | MAY | [0..1] | HD Hierarchic Designator | MAY | ||||||
4 | 00070 | File Sending Facility | MAY | [0..1] | HD Hierarchic Designator | MAY | ||||||
5 | 00071 | File Receiving Application | MAY | [0..1] | HD Hierarchic Designator | MAY | ||||||
6 | 00072 | File Receiving Facility | MAY | [0..1] | HD Hierarchic Designator | MAY | ||||||
7 | 00073 | File Creation Date/Time | MAY | [0..1] | DTM Date/Time | MAY | ||||||
8 | 00074 | File Security | = Truncation not allowed! | MAY | [0..1] | 40 | ST String Data | MAY | ||||
9 | 00075 | File Name/ID | = Truncation not allowed! | MAY | [0..1] | 20 | ST String Data | MAY | ||||
10 | 00076 | File Header Comment | = Truncation allowed. | MAY | [0..1] | 80 | ST String Data | MAY | ||||
11 | 00077 | File Control ID | = Truncation not allowed! | MAY | [0..1] | 20 | ST String Data | MAY | ||||
12 | 00078 | Reference File Control ID | = Truncation not allowed! | MAY | [0..1] | 20 | ST String Data | MAY | ||||
13 | 02269 | File Sending Network Address | MAY | [0..1] | HD Hierarchic Designator | MAY | ||||||
14 | 02270 | File Receiving Network Address | MAY | [0..1] | HD Hierarchic Designator | MAY | ||||||
15 | 02429 | Security Classification Tag | C Condition defined for this element | MAY | [0..1] | CWE Coded with Exceptions | MAY | |||||
16 | 02430 | Security Handling Instructions | C Condition defined for this element | MAY | [0..*] | 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 | |
FHS | ||||||||||||
1 | 00067 | File Field Separator | R | [1..1] | ST String Data |
|||||||
2 | 00068 | File Encoding Characters | R | [4..5] | ST String Data |
|||||||
3 | 00069 | File Sending Application | O | HD Hierarchic Designator |
||||||||
4 | 00070 | File Sending Facility | O | HD Hierarchic Designator |
||||||||
5 | 00071 | File Receiving Application | O | HD Hierarchic Designator |
||||||||
6 | 00072 | File Receiving Facility | O | HD Hierarchic Designator |
||||||||
7 | 00073 | File Creation Date/Time | O | DTM Date/Time |
||||||||
8 | 00074 | File Security | O | 40= | ST String Data |
|||||||
9 | 00075 | File Name/ID | O | 20= | ST String Data |
|||||||
10 | 00076 | File Header Comment | O | 80# | ST String Data |
|||||||
11 | 00077 | File Control ID | O | 20= | ST String Data |
|||||||
12 | 00078 | Reference File Control ID | O | 20= | ST String Data |
|||||||
13 | 02269 | File Sending Network Address | O | HD Hierarchic Designator |
||||||||
14 | 02270 | File 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 | |
---|---|---|---|---|---|---|---|---|---|
FHS | |||||||||
1 | 00067 | File Field Separator | R | [1..1] | ST String Data |
||||
2 | 00068 | File Encoding Characters | R | [4..5] | ST String Data |
||||
3 | 00069 | File Sending Application | O | HD Hierarchic Designator |
|||||
4 | 00070 | File Sending Facility | O | HD Hierarchic Designator |
|||||
5 | 00071 | File Receiving Application | O | HD Hierarchic Designator |
|||||
6 | 00072 | File Receiving Facility | O | HD Hierarchic Designator |
|||||
7 | 00073 | File Creation Date/Time | O | DTM Date/Time |
|||||
8 | 00074 | File Security | O | 40= | ST String Data |
||||
9 | 00075 | File Name/ID | O | 20= | ST String Data |
||||
10 | 00076 | File Header Comment | O | 80# | ST String Data |
||||
11 | 00077 | File Control ID | O | 20= | ST String Data |
||||
12 | 00078 | Reference File Control ID | O | 20= | ST String Data |
||||
13 | 02269 | File Sending Network Address | O | HD Hierarchic Designator |
|||||
14 | 02270 | File 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 has the same definition as the corresponding field in the MSH segment.
Definition: This field has the same definition as the corresponding field in the MSH segment.
Definition: This field has the same definition as the corresponding field in the MSH segment.
Definition: This field has the same definition as the corresponding field in the MSH segment.
Definition: This field has the same definition as the corresponding field in the MSH segment.
Definition: This field has the same definition as the corresponding field in the MSH segment.
Definition: This field has the same definition as the corresponding field in the MSH segment.
Definition: This field has the same definition as the corresponding field in the MSH segment.
Definition: This field can be used by the application processing file. Its use is not further specified.
Definition: This field contains the free text field, the use of which is not further specified.
Definition: This field is used to identify a particular file uniquely. It can be echoed back in FHS-12-reference file control ID.
Definition: This field contains the value of FHS-11-file control ID when this file was originally transmitted. Not present if this file is being transmitted for the first time.
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".
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 SHOULD 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 MAY be used to make access control decisions. It is conditionally required when MSH-27 or MSH-28 are used.
Conditionality Predicate: Required if FHS-16 or FHS-17 is valued, or any contained MSH-26 is valued, Optional if neither FHS-16 nor FHS-17 or any contained MSH-26 is valued.."
Use of this field supports the business requirement for declaring the level of confidentiality (classification) for a given message.
Note: This field is used to declare the ‘high watermark’, meaning the most restrictive handling that needs to be applied to the message based on its content requiring a certain security classification level and SHOULD be viewed as the v2 equivalent of the document header in CDA, in v3 models, and in FHIR Security Labels on Resources and Bundles. The use of confidentiality codes to classify message content and its inclusion in the high water mark in the header of message content is -described in the Guide to the HL7 Healthcare Privacy and Security Classification System, Release 1, which is platform independent.
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 might 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 MAY be in conjunction with other fields (as elected by the system).