Conformance Profile
HL7 v2.6
Contents
Trigger Events
ADT_A01 - Admit/visit notification
Segments
AL1 - Patient Allergy Information
Data Types
ST - String Data
XPN - Extended Person Name
User Tables
0001 - Administrative Sex
Trigger Events
ADT_A01 - Admit/visit notification
MSH
[{ SFT }]
[ UAC ]
EVN
PID
[ PD1 ]
[{ ARV }]
[{ ROL }]
[{ NK1 }]
PV1
[ PV2 ]
[{ ARV }]
[{ ROL }]
[{ DB1 }]
[{ OBX }]
[{ AL1 }]
[{ DG1 }]
[ DRG ]
[{ --- PROCEDURE begin
PR1
[{ ROL }]
}] --- PROCEDURE end
[{ GT1 }]
[{ --- INSURANCE begin
IN1
[ IN2 ]
[{ IN3 }]
[{ ROL }]
}] --- INSURANCE end
[ ACC ]
[ UB1 ]
[ UB2 ]
[ PDA ]
Segments
AL1 - Patient Allergy Information
The AL1 segment contains patient allergy information of various types. Most of this information will be derived from user-defined tables. Each AL1 segment describes a single patient allergy.
SEQ / LEN / DT / OPT / RPT/# / TBL# / ELEMENT NAME1 / 4 / SI / R / Set ID - AL1
2 / 705 / CWE / O / 0127 / Allergen Type Code
3 / 705 / CWE / R / Allergen Code/Mnemonic/Description
4 / 705 / CWE / O / 0128 / Allergy Severity Code
5 / 15 / ST / O / Y / Allergy Reaction Code
6 / 8 / DT / B / Identification Date
AL1.1 - Set ID - AL1
This field contains the number that identifies this transaction. For the first occurrence of the segment, the sequence number shall be one, for the second occurrence, the sequence number shall be two, etc.
AL1.2 - Allergen Type Code
This field indicates a general allergy category (drug, food, pollen, etc.). Refer to User-defined Table 0127 - Allergen Type for suggested values.
AL1.3 - Allergen Code/Mnemonic/Description
This field uniquely identifies a particular allergen. This element may conform to some external, standard coding system (that must be identified), or it may conform to local, largely textual or mnemonic descriptions.
AL1.4 - Allergy Severity Code
This field indicates the general severity of the allergy. Refer to User-defined Table 0128 - Allergy Severity for suggested values.
AL1.5 - Allergy Reaction Code
This field identifies the specific allergic reaction that was documented. This element may conform to some external, standard coding system, or it may conform to local, largely textual or mnemonic descriptions (e.g., convulsions, sneeze, rash, etc.).
AL1.6 - Identification Date
From V2.4 onward, this field has been retained for backward compatibility only. This field contains the date that the allergy was identified.
Data Types
ST - String Data
The String data type is used for text data when the appearance of text does not bear meaning. This is true for formalized text, symbols and formal expressions, and all kinds of names intended for machine processing (e.g., sorting, querying, indexing, etc.)
XPN - Extended Person Name
SEQ / LEN / DT / OPT / TBL# / ELEMENT NAME1 / 194 / FN / O / Family Name
2 / 30 / ST / O / Given Name
3 / 30 / ST / O / Second and Further Given Names or Initials Thereof
4 / 20 / ST / O / Suffix (e.g., JR or III)
5 / 20 / ST / O / Prefix (e.g., DR)
6 / 6 / IS / B / 0360 / Degree (e.g., MD)
7 / 1 / ID / O / 0200 / Name Type Code
8 / 1 / ID / O / 0465 / Name Representation Code
9 / 705 / CWE / O / 0448 / Name Context
10 / 49 / DR / B / Name Validity Range
11 / 1 / ID / O / 0444 / Name Assembly Order
12 / 24 / DTM / O / Effective Date
13 / 24 / DTM / O / Expiration Date
14 / 199 / ST / O / Professional Suffix
XPN.1 - Family Name
This component allows full specification of the surname of a person. Where appropriate, it differentiates the person's own surname from that of the person's partner or spouse, in cases where the person's name may contain elements from either name. It also permits messages to distinguish the surname prefix (such as "van" or "de") from the surname root. See section 2.A.30, "FN - family name".
XPN.2 - Given Name
First name.
XPN.3 - Second and Further Given Names or Initials Thereof
Multiple middle names may be included by separating them with spaces.
XPN.4 - Suffix (e.g., JR or III)
Used to specify a name suffix (e.g., Jr. or III).
XPN.5 - Prefix (e.g., DR)
Used to specify a name prefix (e.g., Dr.).
XPN.6 - Degree (e.g., MD)
Retained for backward compatibility only as of v 2.5. See Professional Suffix component.
XPN.7 - Name Type Code
A code that represents the type of name. Refer to HL7 Table 0200 - Name type for valid values.
XPN.8 - Name Representation Code
Different <name/address types> and representations of the same <name/address> should be described by repeating of this field, with different values of the <name/address type> and/or <name/address representation> component.
XPN.9 - Name Context
This component is used to designate the context in which a name is used. The main use case is in Australian healthcare for indigenous patients who prefer to use different names when attending different healthcare institutions. Another use case occurs in the US where health practitioners can be licensed under slightly different names and the reporting of the correct name is vital for administrative purposes. Refer to User-defined Table 0448 – Name context for suggested values.
XPN.10 - Name Validity Range
This component cannot be fully expressed. Identified as v 2.4 erratum. Retained for backward compatibility only as of v 2.5. Refer to 2.A.88.12, "Effective Date" and 2.A.88.13, "Expiration Date" components.
XPN.11 - Name Assembly Order
A code that represents the preferred display order of the components of this person name. Refer to HL7 0444 – Name assembly order for valid values.
XPN.14 - Professional Suffix
Used to specify an abbreviation, or a string of abbreviations denoting qualifications that support the person’s profession, (e.g., licenses, certificates, degrees, affiliations with professional societies, etc.). The Professional Suffix normally follows the Family Name when the Person Name is used for display purposes. Please note that this component is an unformatted string and is used for display purposes only. Detailed information regarding the contents of Professional Suffix is obtained using appropriate segments in Chapter 15, Personnel Management.
User Tables
0001 - Administrative Sex
VALUE / DESCRIPTION / COMMENTF / Female
M / Male
O / Other
U / Unknown
A / Ambiguous
N / Not applicable
Document Title: Caristix HL7 Conformance Profile Template.Docx
Last modified: 9/14/2010 10:40 AMPage 1