| Table of Content Zone | ||||||||
|---|---|---|---|---|---|---|---|---|
| ||||||||
|
...
Datatypes can occur at several levels in a message. When a datatype is used in a field it will use the component separator (^), but when the datatype is embedded in another datatype a sub-component separator (&) may be used. Some datatypes are conceptually a combination of other datatypes eg e.g. an EI data type is a combination of a string (ST) identifier and a Hierarchical Designator (HD). This allows for an organization to provide a unique identifier within their namespace. In messages the HD component of an EI datatype will appear in other places in the message as a HD data type to identify the organization uniquely. If binary or non ASCII data is used it will be encoded, usually using base64 encoding.
...
The following data types are those used in the Australian context.
| Anchor | ||||
|---|---|---|---|---|
|
Figure 3-1 HL7 data types by category
Data Type Category / Data type | Data Type Name | LEN | Notes / Format | Examples |
Alphanumeric |
|
|
| |
String | 199 |
| Text: |almost any data at all| | |
|
|
| TX SHALL NOT be used for a standalone field value. Use ST or FT instead. TX may be used in a component of a more complex datatype where the standard specifies, e.g. TQ | |
Formatted text | 65536 | May contain formatting commands enclosed in escape characters. | |\.sp\(skip one vertical line)| | |
Numerical |
|
|
| |
| Numeric array | 65536 | For waveform data only This data type is used to represent a series (array) of numeric values, each one having a data type of NM. A field of this type may contain a one-dimensional array (vector or row) of numbers. | |125^34^-22^-234^569^442^-212^6| |1.2^-3.5^5.2~2.0^3.1^-6.2~3.5^7.8^-1.3| |^2^3^4~5^^^8~9^10~~17^18^19^20| | |
Numeric |
|
| |999| |-123.792| | |
Sequence ID |
| A non-negative integer in the form of a NM field. | Used to number OBX segments in a report. OBX|9|CE|11475-1^Culture^LN|1|3092008^Staphylococcus aureus^SCT|||A|||F | |
Structured numeric |
| <comparator (ST)> ^ <num1 (NM)> ^ <separator/suffix (ST)> ^ <num2 (NM)> | |>^100| (greater than 100) |^100^-^200| (equal to range of 100 through 200) |^1^:^128| (ratio of 1 to 128, e.g., the results of a serological test) |^2^+| (categorical response, e.g., occult blood positivity) | |
Identifier |
|
|
| |
Coded values for HL7 tables |
| The value of such a field follows the formatting rules for an ST field except that it is drawn from a table of legal values. There shall be an HL7 table number associated with ID data types. | ID field is OBR-25-result status (HL7 table 0123): |F|. | |
Coded value for user-defined tables |
| The value of such a field follows the formatting rules for a ST field except that it is drawn from a site-defined (or user-defined) table of legal values. | PID-8 Administrative sex: |M| | |
Version identifier |
| <version ID (ID)> ^ <internationalization code (CE)> ^ <international version ID (CE). Used to identify the HL7 version. | MSH-12 : |2.4^AUS| | |
Hierarchic designator |
| <namespace ID (IS)> ^ <universal ID (ST)> ^ <universal ID type (ID)> The HD is designed to be used either as a local identifier (with only the <namespace ID> valued) or a publicly-assigned identifier, a UID (<universal ID> and <universal ID type> both valued). | MSH-4 : |LAB^3456^AUSNATA| ISO example with only the 2nd and 3rd components valued: |^2.16.840.1.113883.19^ISO| A UUID example : |^478A0114-EBF0-7701-A023-6841FF05731A^UUID| A DNS example : |^falcon.iupui.edu^DNS| Local use only: a HD that looks like an IS data type :
| |
Entity identifier |
| <entity identifier (ST)> ^ <namespace ID (IS)> ^ <universal ID (ST)> ^ <universal ID type (ID)> The entity identifier defines a given entity within a specified series of identifiers. | ORC-2: |L12345^LOCAL GP SURGERY^RX123456789^L| | |
Reference pointer |
| <pointer (ST) > ^ < application ID (HD)> ^ <type of data (ID)> ^ <subtype (ID)> This data type transmits information about data stored on another system. | An image on a web server at: |?path=/All%20Studies/AccessionNumber=2016F0001100-1^ http://testsite/neurologicalstudy.asp&URI^IMAGE^JPEG| | |
Person location |
| <point of care (IS )> ^ <room (IS )> ^ <bed (IS)> ^ <facility (HD)> ^ < location status (IS )> ^ <person location type (IS)> ^ <building (IS )> ^ <floor (IS )> ^ <location description (ST)> This data type is used to specify a patient location within a healthcare institution. | A nursing unit at Community Hospital: 4 East, room 136, bed B :
A clinic at University Hospitals: Internal Medicine Clinic located in the Briones building, 3rd floor : | |
Date/Time |
|
|
| |
| DR | Date/Time range | YYYY[MM[DD[HHMM[SS[.S[S[S[S]]]]]]]][+/-ZZZZ]
| ||
Date |
| YYYY[MM[DD]] By site-specific agreement, YYYYMMDD may be used where backward compatibility must be maintained. | PV1-25: |20150808| Month only: |201503| | |
Time |
| HH[MM[SS[.S[S[S[S]]]]]][+/-ZZZZ] Generally not used in the Australian context. TS is used instead. | |0800| = Eight AM, local time of the sender. |0000| = midnight |13| = 1pm (with a precision of hours), local time of sender. |093544.2312| = 44.2312 seconds after Nine thirty-five AM, local time of sender. |235959+1100| = 1 second before midnight in a time zone eleven hours ahead of Universal Coordinated Time (i.e., East of Greenwich). | |
Time stamp |
| YYYY[MM[DD[HHMM[SS[.S[S[S[S]]]]]]]][+/-ZZZZ] | ORC-7: |20160704010159+1000| | |
Code Values |
|
|
| |
Coded element | 250 | <identifier (ST)> ^ <text (ST)> ^ <name of coding system (IS)> ^ <alternate identifier (ST)> ^ <alternate text (ST)> ^ <name of alternate coding system (IS)> This data type transmits codes and the text associated with the code. | OBX-3: |22664-7^UREA^LN^Cr^UREA^NATA3456-008|. | |
Coded with no exceptions | 250 | <identifier (ST)> ^ <text (ST)> ^ <name of coding system (IS)> ^ <alternate identifier (ST)> ^ <alternate text (ST)> ^ <name of alternate coding system (IS)> ^ <coding system version ID (ST)> ^ alternate coding system version ID (ST)> ^ <original text (ST) > | IAM-6 | |
Coded with exceptions | 250 | <identifier (ST)> ^ <text (ST)> ^ <name of coding system (IS)> ^ <alternate identifier (ST)> ^ <alternate text (ST)> ^ <name of alternate coding system (IS)> ^ <coding system version ID (ST)> ^ alternate coding system version ID (ST)> ^ <original text (ST) > | OBR-25 | |
Extended composite ID with check digit | 250 | <ID (ST)> ^ <check digit (ST)> ^ <code identifying the check digit scheme employed (ID)> ^ < assigning authority (HD)> ^ <identifier type code (ID)> ^ < assigning facility (HD) ^ <effective date (DT)> ^ <expiration date (DT)> This data type is used for specifying an identifier with its associated administrative detail. | PID-3:
| |
Extended composite ID number and name | 250 | Replaces CN data type as of v 2.3. <ID number (ST)> ^ <family name (FN)> ^ <given name (ST)> ^ <second and further given names or initials thereof (ST)> ^ <suffix (e.g., JR or III) (ST)> ^ <prefix (e.g., DR) (ST)> ^ <degree (e.g., MD) (IS)> ^ <source table (IS)> ^ <assigning authority (HD)> ^ <name type code (ID)> ^ <identifier check digit (ST)> ^ <code identifying the check digit scheme employed (ID)> ^ <identifier type code (IS)> ^ <assigning facility (HD)> ^ <name representation code (ID)> ^ <name context (CE)> ^ <name validity range (DR)> ^ < name assembly order (ID)> This data type is used extensively appearing in the PV1, ORC, RXO, RXE, OBR and SCH segments , as well as others, where there is a need to specify the ID number and name of a person. | PV1-7:
| |
Generic |
|
|
| |
Composite |
| A field that is a combination of other meaningful data fields. Each portion is called a component. No new CM’s are allowed after HL7 Version 2.2. The CM data type is maintained strictly for backward compatibility and may not be used for the definition of new fields. | PRD-7: |8003619900015717^NPI^AUSHIC| | |
Demographics |
|
|
| |
Extended address | 250 | Replaces the AD data type as of v 2.3. <street address (SAD)> ^ <other designation (ST)> ^ <city (ST)> ^ <state or province (ST)> ^ <zip or postal code (ST)> ^ <country (ID)> ^ < address type (ID)>^ <other geographic designation (ST)> ^<county/parish code (IS)> ^ <census tract (IS)> ^ <address representation code (ID)> ^ <address validity range (DR)> Countries typically have a standard method of formatting addresses. This data type does not specify the formatting usages, only the components of a postal address. | PID-11: |14th Floor^50 Paterson St^Coorparoo^QLD^4151| | |
Extended person name | 250 | Replaces PN data type as of v 2.3. <family name (FN)> ^ <given name (ST)> ^ <second and further given names or initials thereof (ST)> ^ <suffix (e.g., JR or III) (ST)> ^ <prefix (e.g., DR) (ST)> ^ <degree (e.g., MD) (IS)> ^<name type code (ID) > ^ <name representation code (ID)> ^ <name context (CE)> ^ <name validity range (DR)> ^ <name assembly order (ID)> | |Smith^John^J^III^DR^PHD^L| | |
Extended composite name and ID number for organizations | 250 | <organization name (ST)> ^ <organization name type code (IS)> ^ <ID number (NM)> ^ <check digit (NM)> ^ <code identifying the check digit scheme employed (ID)> ^ <assigning authority (HD)> ^ <identifier type code (IS)> ^ <assigning facility ID (HD)> ^ <name representation code (ID)> | ORC-21: |ABC Medical Group^^1234567| HPI-O: |ABCD Organisation^L^8003621566684455^^^AUSHIC^NOI| | |
Extended telecommunications number | 250 | Replaces TN data type as of v 2.3 [NNN] [(999)]999-9999 [X99999] [B99999] [C any text] ^ <telecommunication use code (ID)> ^ <telecommunication equipment type (ID)> ^ <email address (ST)> ^ <country code (NM)> ^ <area/city code (NM)> ^ <phone number (NM)> ^ <extension (NM)> ^ <any text (ST)> Note: Components five through nine reiterate the basic function of the first component in a delimited form that allows the expression of both local and international telephone numbers. As of 2.3, the recommended form for the telephone number is to use the delimited form rather than the unstructured form supported by the first component (which is left in for backward compatibility only). | International phone number: |^WPN^PH^^61^7^32615492| Interstate/intrastate phone number: |^WPN^PH^^^07^32615492| Local area’ phone number: |^WPN^PH^^^^32615492| Mobile phone number: |^WPN^CP^^^^0412545585| Email address: |^NET^Internet^J.Smith@work.com| | |
Specialty/Chapter Specific |
|
|
| |
Waveform |
|
|
| |
Channel definition |
| For waveform data only e.g. graphs, echo cardiographs. | ||
| MA | Multiplexed array | Multiplexed array | ||
Numeric array |
| For waveform data only <value1 (NM)> ^ <value2 (NM)> ^ <value3 (NM)> ^ <value4 (NM)> ^ ... |
| |
Encapsulated data |
| Supports ASCII MIME-encoding of binary data. <source application (HD) > ^ <type of data (ID)> ^ <data subtype (ID)> ^ <encoding (ID)> ^ <data (ST)> This data type transmits encapsulated data from a source system to a destination system. | OBX|16|ED|HTML^Display Segment as HTML^AUSPDI||^text^HTML^A^<?xml version="1.0" encoding="utf-8"?><!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd" ><html xmlns="http://www.w3.org/1999/xhtml"> <head> <title> Content .......| | |
Patient Administration /Financial Information |
|
|
| |
Financial class
|
| <financial class (IS)> ^ <effective date (TS)> This component contains the financial class assigned to a person. | PV1-20 | |
Time Series: |
|
|
| |
Timing/quantity |
| For timing/quantity specifications for orders, see HL7 International Standard Chapter 4, Section 4.3. <quantity (CQ)> ^ <interval (*)> ^ <duration (*)> ^ <start date/time (TS)> ^ <end date/time (TS)> ^ <priority (ST)> ^ <condition (ST)> ^ <text (TX)> ^ <conjunction (ID)> ^ <order sequencing (*)> ^ <occurrence duration (CE)> ^ <total occurrences (NM)> Note: only components 4 and 6 used. | Urgent : |^^^199710230915^^S| Routine :|^^^199711071020|
|
...
3.1.1 USE OF ESCAPE SEQUENCES IN TEXT FIELDS
3.1.1.1 Formatting codes
When a field of type TX, FT, or CF is being encoded, the escape character may be used to signal certain special characteristics of portions of the text field. The character \ will be used to represent the character so designated in a message. An escape sequence consists of the escape character followed by an escape code ID of one character, zero (0) or more data characters, and another occurrence of the escape character. The following escape sequences are defined:
...
The escape sequences for field separator, component separator, subcomponent separator, repetition separator, and escape character are also valid within an ST data field.
No escape sequence may contain a nested escape sequence.
3.1.1.3 Highlighting
In designating highlighting, the sending application is indicating that the characters that follow somehow should be made to stand out, but leaving the method of doing so to the receiving application. Depending on device characteristics and application style considerations, the receiving application may choose reverse video, boldface, underlining, blink, an alternate colour or another means of highlighting the displayed data.
For example the message fragment:
DSP| TOTAL CHOLESTEROL \H\240*\N\ [90 - 200]
might cause the following data to appear on a screen or report:
TOTAL CHOLESTEROL 240* [90 - 200]
whereas another system may choose to show the 240* in red.
3.1.1.4 Special character
The special character escape sequences (\F\, \S\, \R\, \T\, and \E\) allow the corresponding characters to be included in the data in a text field, though the actual characters are reserved.
For example, the message fragment
DSP| TOTAL CHOLESTEROL 180 \F\90 - 200\F\
DSP| \S\----------------\S\
would cause the following information to be displayed, given suitable assignment of separators:
TOTAL CHOLESTEROL 180 |90 - 200|
^----------------^
3.1.1.5 Hexadecimal
Variance to HL7 International. The hexadecimal escape sequence (\Xdddd...\) must not be used.
3.1.1.6 Escape sequences supporting multiple character sets for FT, ST, and TX data types
Variance to HL7 International. The single-byte character escape sequence \Cxxyy\ and multi-byte character escape sequence \Mxxyyzz\ must not be used.
3.2 CD - channel definition
...
Definition: The channel name is a text string used as a label in waveform data displays. If this name isnot is not present, the channel label displayed is <source1>-<source2>, where <source1> and <source2> are the names of the two waveform sources connected to this channel, or, if only one waveform sources <source1> is specified, the channel label displayed when the channel name is not given is <source1>.
...
Each coding system is assigned a unique identifier. This component will serve to identify the coding scheme being used in the identifier component. The combination of the identifier and name of coding system components will be a unique code for a data item. Each system has a unique identifier. User-defined Table 0396 – Coding system contains the allowable values.
User defined Table 0396 - Coding System
| Anchor | ||||
|---|---|---|---|---|
|
...
| Value | Description | Comment/Source | Category | Status |
|---|---|---|---|---|
| DCM | DICOM Controlled | Codes defined in DICOM Content Mapping Resource. Digital Imaging and Communications in | Specific Non-Drug | Active |
| I10 | ICD-10 | World Health Publications, Albany, NY. | Specific Non-Drug | Active |
| ICD10AM | ICD-10 Australian | Active | ||
| ISO3166_1 | ISO 3166-1 Country Codes | International Standards Organization standard 3166 contains 3 parts. Part 1 contains three tables for codes for countries of the world. These are 2-character alphabetic, 3-character alphabetic, and numeric codes. | Demographics | Active |
| ISO3166_2 | ISO 3166-2 Country subdivisions | International Standards Organization standard 3166 contains 3 parts. Part 2 contains a complete breakdown into a relevant level of administrative subdivisions of all countries listed in ISO 3166-1. The code elements used consist of the alpha-2 code elem | Demographics | Active |
| ISO+ | ISO 2955.83 | See chapter 7 (V2.6), Section 7.4.2.6 | Active | |
| IUPP | IUPAC/IFCC Property | International Union of Pure and Applied Chemistry/International Federation of Clinical Chemistry. | Specific Non-Drug | Active |
| LN | Logical Observation | Regenstrief Institute, c/o LOINC, 1050 Wishard Blvd., 5th floor, Indianapolis, IN 46202. 317/630- | Specific Non-Drug | Active |
| SCT | SNOMED Clinical | SNOMED-CT concept identifier codes. | Specific Non-Drug | Active |
| UCUM | UCUM UCUM code set for | Added by motion of VOCABULARY T.C. 20060308 14-0-3 | Active | |
| AUSPDI | Australian Pathology Display Interface (Display Segment) | Used in AS4700.2-2012 | Active | |
| HL7AU | HL7 Australia | Required for defining CEs eg. MSH-12 <internal version ID (CE)> | Specific Non-Drug Code | |
| ROLECODE | Participation Mode | For use in v2.x systems interoperating with V3 systems. Identical to the code system 2.16.840.1.113883.5.111 RoleCode in the Version 3 vocabulary. For Code system content see : https://www.hl7.org/fhir/v3/RoleCode/cs.html | General Codes | Active |
| PHENX | PhenX ID | The PhenX (consensus measures for Phenotypes and eXposures) Toolkit https://www.phenxtoolkit.org/index.php | Specific Non-Drug Code | |
| DOCLE | Doctor Command Language | DOCLE (Doctor Command Language), is a non-numeric health coding and medical classification system. The DOCLE system is used in the electronic medical record and patient management software package, Medical Director. | Specific Non-Drug Code | |
| EN13606 | CEN 13606 | The EN 13606 class instance hierarchy. Refer to 6.2.2.2 of ISO 136006-2. | Class instance identifer | Active |
| 99ZZZ or L | Local Coding system | Locally defined codes for purpose of sender or receiver. If multiple local codes exist, the format should be 99zzz, where z is an alphanumeric character Local general code for a site-defined code system used for a specific set of trading partners. The 'zzz' SHALL be any printable ASCII string. Length of the name SHALL not exceed field width, and is subject to local implementation. | Active | |
| L | Local Coding system | Locally defined codes for purpose of sender or receiver. | Active | |
| AMT | Australian Medicines Terminology | AMT Codes (contains therapeutic goods concepts) | Drug Code | Active |
EAN | GTIN product code | |||
TGA | Therapeutic Good Authority codes | |||
mims-codes | Refer to MIMS integrated http://www.hl7.org/oid/index.cfm?Comp_OID=1.2.36.1.2001.1005.11.1 | |||
MIMS-UNITS | MIMS Units of measurement | Refer to MIMS integrated | ||
MIMS-FORM | MIMS Drug Form code | Refer to MIMS integrated | ||
MIMS-GENCODE | MIMS Generic code | Refer to MIMS integrated | ||
| PBS | PBS Medicines Item Codes | http://www.pbs.gov.au/ | ||
| FHIR-ResourceType | FHIR Resource Type codes | Refer to https://www.hl7.org/fhir/valueset-resource-types.html for codes. |
...
Note: The presence of two sets of equivalent codes in this data type is semantically different from a repetition of a CE type field. With repetition, several distinct codes (with distinct meanings) may be transmitted.
Refer to User-defined Table 0396 - Coding system for valid values. When an HL7 table is used for a CE data type, the name of coding system component is defined as HL7nnnn where nnnn is the HL7 table number.
...
Wherever a component of an HL7 field is itself an HL7 data type which contains components, its delimiters are demoted by one. Thus a component designated as a CE data type should be encoded as <identifier & text & name of coding system> (see CE - coded element). Note that since HL7 delimiters are not recursive, an HL7 data type containing components cannot be a subcomponent. When this level of detail is needed, each component of the HL7 data type can be encoded as a separate subcomponent. For an example of this, see the encoding of the filler order number in the order sequencing component of the Timing/Quantity data type.
...
Each coding system is assigned a unique identifier. This component will serve to identify the coding scheme being used in the identifier component. The combination of the identifier and name of coding system components will be a unique code for a data item. Each system has a unique identifier.
User-defined Table 0396 - Coding system contains the allowable values. The table includes ASTM E1238-94, Diagnostic, procedure, observation, drug ID, and health outcomes coding systems as identified in the tables in Appendix 4 Others may be added as needed.
...
Components 1-3 and 7: The identifier is required and must be a valid code. Coding system must either be present and have a value from the set of allowed coding systems or if not present it will be interpreted to have the same meaning as if it had been valued with the code meaning “HL7 coding system.” User-defined Table 0396 - Coding system contains the allowable values. If the coding system is any system other than “HL7 coding system,” version ID must be valued with an actual version ID. If the coding system is “HL7 coding system,” version ID may have an actual value or it may be absent. If version ID is absent, it will be interpreted to have the same value as the HL7 version number in the message header. Text description of code is optional but its use should be encouraged since it makes messages easier to review for accuracy, especially during interface testing and debugging.
...
CNE usage note: The CNE data type should be used when a required or mandatory coded field is needed.
User-defined Table 0396 - Coding system contains the allowable values. The table includes ASTM E1238-94, diagnostic, procedure, observation, drug and health outcomes coding systems. When an HL7 table is used for a CE data type, the name of coding system component is defined as HL7nnnn where nnnn is the HL7 table number.
...
Each coding system is assigned a unique identifier. This component will serve to identify the coding scheme being used in the identifier component. The combination of the identifier and name of coding system components will be a unique code for a data item. Each system has a unique identifier.
User-defined Table 0396 - Coding system contains the allowable values. The table includes ASTM E1238-94, Diagnostic, procedure, observation, drug ID, and health outcomes coding systems as identified in the tables in Appendix 4 Others may be added as needed.
...
1) Coded: The identifier contains a valid code from a coding system. The coding system must either be present and have a value from the set of allowed coding systems, or if not present, it will be interpreted to have the same meaning as if it had been valued with the code meaning “HL7 coding system.”
User-defined Table 0396 - Coding system contains the allowable values. The table includes ASTM E1238-94, Diagnostic, procedure, observation, drug ID, and health outcomes coding systems as identified in the table in Appendix 4. If the coding system is any system other than “HL7 coding system”, version ID must be valued with an actual version ID. If the coding system is “HL7 coding system,” version ID may have an actual value or it may be absent. If version ID is absent, it will be interpreted to have the same value as the HL7 version number in the message header. Text description is optional, but its use should be encouraged to aid in readability of the message during testing and debugging.
...
The CWE data type should be used for coded fields that are optional or where it is permissible to send text for items that are not yet a part of the approved value set. In the normal situation, the identifier is valued with the code from the value set. If the value of the field is known, but is not part of the value set, then the value is sent as text, and the identifier has no value. If the field has an unknown status, then third form of the field is used (see Data missing above), and the appropriate status for the field is selected from the table of allowed statuses. When no code exists, use values from HL7 Table 0353 - CWE statuses.
| Anchor | ||||
|---|---|---|---|---|
|
HL7 Table 0353 - CWE statuses
| Code | Description |
|---|---|
| U | Unknown |
| UASK | Asked but Unknown |
| NAV | Not available |
| NA | Not applicable |
| NASK | Not asked |
...
The check digit in this data type is not an add-on produced by the message processor. It is the check digit that is part of the identifying number used in the sending application. If the sending application does not include a self-generated check digit in the identifying number, this component should be valued null. Many identifiers (eg e.g. Australian provider numbers) have check digits built into the identifier and this field is not used in that case.
...
The assigning authority is a unique name of the system (or organization or agency or department) that creates the data. It is a HD data type. User-defined Table 0363 - Assigning authority is used as the HL7 identifier for the user-defined table of values for the first sub-component of the HD component, <namespace ID>.
Note: When the HD data type is used in a given segment as a component of a field of another data type, User-defined Table 0300 - Namespace ID (referenced by the first sub-component of the HD component) may be re-defined (given a different user-defined table number and name) by the technical committee responsible for that segment.
By site agreement, implementors may continue to use User-defined Table 0300 - Namespace ID for the first sub-component.
...
A code corresponding to the type of identifier. In some cases, this code may be used as a qualifier to the “Assigning authority” component. Refer to HL7 Table 0203 - Identifier typefor suggested values.
| Anchor | ||||
|---|---|---|---|---|
|
...
Note: When the HD data type is used in a given segment as a component of a field of another data type, User-defined Table 0300 - Namespace ID (referenced by the first sub-component of the HD component), may be re-defined (given a different user-defined table number and name) by the technical committee responsible for that segment.
...
Anchor DR DR
3.8 DR - date/time range
Components: <range start date/time (TS)> ^ <range end date/time (TS)>
Subcomponents of range start date/time and range stop date/time: YYYY[MM[DD[HHMM[SS[.S[S[S[S]]]]]]]][+/-ZZZZ]
3.8.1 Range start date/time (TS)
Definition: The first component contains the earliest date/time (time stamp) in the specified range.
3.8.2 Range end date/time (TS)
The second component contains the latest date/time in the specified range. Note that the TS (time stamp) data type allows the specification of precision.
| Anchor | ||||
|---|---|---|---|---|
|
3.9 DT - date
Format: YYYY[MM[DD]]
...
This data type transmits encapsulated data from a source system to a destination system. It contains the identity of the source system, the type of data, the encoding method of the data, and the data itself. This data type is similar to the RP (reference pointer) data type of RP - reference pointer, except that instead of pointing to the data on another system, it contains the data which is to be sent to that system (refer to the RP - reference pointer section for discussion of MIME types).
...
A unique name that identifies the system which was the source of the data. Identical format and restrictions as in reference pointer (see Section 3.20.2, “Application ID (HD)”).
3.10.2 Type of data (ID)
Identical to “type of data” component in the reference pointer (RP) data type. (See Section 3.20.3, “Type of data (ID)”). Refer to HL7 Table 0191 - Type of referenced data for valid values.
Note that when MIME type is used in Type of data that readers must treat the values case insensitively as per RFC 2045.
...
Identical to “subtype” component in the reference pointer (RP) data type. (See Section 3.20.4, “Subtype (ID)”).
Refer to HL7 Table 0291 - Subtype of referenced data for valid values.
When this component is valued with a MIME <Subtype (ID)> value, then the corresponding MIME type must be used in the <Type of data (ID)> component.
...
The type of encoding, if present, used to represent successive octets of binary data as displayable ASCII characters. Refer to HL7 Table 0299 - Encodingfor valid values.
| Anchor | ||||
|---|---|---|---|---|
|
HL7 Table 0299 - Encoding
| Value | Description |
|---|---|
| A | No encoding - data are displayable ASCII characters. |
| Hex | Hexadecimal encoding - consecutive pairs of hexadecimal digits represent consecutive single octets. |
| Base64 | Encoding as defined by MIME (Multipurpose Internet Mail Extensions) standard RFC 1521. Four consecutive ASCII characters represent three consecutive octets of binary data. Base64 utilizes a 65-character subset of US-ASCII, consisting of both the upper and lower case alphabetic characters, digits "0" through “9,” “+,” “/,” and “=.”. |
Base64 is defined as follows (adapted from MIME Internet standard RFC 1521, which has precedence over this description). Proceeding from left to right across a 24-bit input group (three octets), each 6-bit group is used as an index into an array of 64 printable characters. The character referenced by the index is placed in the encoded string. These characters are shown in HL7 Table 0290 - MIME base64 encoding characters ,and are selected so as to be universally representable.
...
Receivers must evaluate this field in a case insensitive manner.
| Anchor | ||||
|---|---|---|---|---|
|
HL7 Table 0290 - MIME base64 encoding characters
| Value | Code | Value | Code | Value | Code | Value | Code |
|---|---|---|---|---|---|---|---|
| 0 | A | 17 | R | 34 | l | 51 | 52 z |
| 1 | B | 18 | S | 35 | j | 52 | 52 0 |
| 2 | C | 19 | T | 36 | k | 53 | 53 1 |
| 3 | D | 20 | U | 37 | l | 54 | 54 2 |
| 4 | E | 21 | V | 38 | m | 55 | 55 3 |
| 5 | F | 22 | W | 39 | n | 56 | 56 4 |
| 6 | G | 23 | X | 40 | o | 57 | 57 5 |
| 7 | H | 24 | Y | 41 | p | 58 | 58 6 |
| 8 | I | 25 | Z | 42 | q | 59 | 59 7 |
| 9 | J | 26 | a | 43 | r | 60 | 60 8 |
| 10 | K | 27 | b | 44 | s | 61 | 61 9 |
| 11 | L | 28 | c | 45 | t | 62 | 62 + |
| 12 | M | 29 | d | 46 | u | 63 | 63 / |
| 13 | N | 30 | e | 47 | v | ||
| 14 | O | 31 | f | 48 | w | (pad) | = |
| 15 | P | 32 | g | 49 | x | ||
| 16 | Q | 33 | h | 50 | y |
...
Displayable ASCII characters which constitute the data to be sent from source application to destination application. The characters are limited to the legal characters of the ST data type, as defined in ST - string data and, if encoded binary, are encoded according to the method of Section 3.10.2, “Type of data (ID).”
If the encoding component (see Section 3.10.4, “Encoding (ID)”) = ‘A’ (none), then the data component must be scanned before transmission for HL7 delimiter characters, and any found must be escaped by using the HL7 escape sequences defined in HL7 International v2.4 section 2.10, “Use of escape sequences in text fields.” On the receiving application, the data field must be de-escaped after being parsed.
If the encoding component (see Section 3.10.4, “Encoding (ID)”) does not equal ‘A,’ then, after encoding, the (encoded) data must be scanned for HL7 delimiter characters, and any found must be escaped by using the HL7 escape sequences. Only then can the component be added to the HL7 segment/message. On the receiving application, the data field must be de-escaped after being parsed out of the message before being decoded. This can be expressed as ‘encode’, ‘escape’, parse, ‘de-escape’, ‘decode’.
...
The specified series, the assigning authority , is defined by components 2 through 4. The assigning authority is of the hierarchic designator (HD) data type, but it is defined as three separate components in the EI data type, rather than as a single component as would normally be the case. This is in order to maintain backward compatibility with the EI’s use as a component in several existing data fields. Otherwise, the components 2 through 4 are as defined in HD - hierarchic designator. Hierarchic designators (HD) are unique across a given HL7 implementation.
...
The first component, <entity identifier>, is usually defined to be unique within the series of identifiers created by the <assigning authority>, defined by a hierarchic designator, represented by components 2 through 4. (See HD - hierarchic designator.)
3.11.2 Namespace ID (IS)
See Section 3.13.1, “Namespace ID (IS)” for definition.
The assigning authority is a unique identifier of the system (or organization or agency or department) that creates the data. User-defined Table 0363 - Assigning authority is used as the HL7 identifier for the user defined table of values for this component.
...
By site agreement, implementers may continue to use User-defined Table 0300 - Namespace ID for the first component.
3.11.3 Universal ID (ST)
See Section 3.14.2, “Universal ID (ST)” for definition.
3.11.4 Universal ID type (ID)
Refer to HL7 Table 0301 - Universal ID type for valid values. See Section 3.14.3, “Universal ID type (ID)”, for definition.
| Anchor | ||||
|---|---|---|---|---|
|
...
This component contains the financial class assigned to a person. User-defined Table 0064 - Financial class is used as the HL7 identifier for the user-defined table of values for this component.
...
The FT field is of arbitrary length (up to 64k) and may contain formatting commands enclosed in escape characters.
Note: In the Australian context text results other than short phrases, on a single line, of less than 50 characters(which can use data type of ST) should be transmitted using OBX-2 data type of FT.
Many systems do not escape the HL7 delimiters when building messages and fail to unescape them when data is extracted. The HL7 delimiters iei.e.: “|^~\&” need to be escaped in every field and in Free Text fields the Free text formatting characters also need to be handled. Failure to do this correctly makes transmitting data unreliable and breaks the interoperability of systems. Text data containing a ‘|” character could cause serious truncation of reports. Rich Text Format (RTF) contains many “\” characters and can be escaped but is better base 64 encoded as RTF can contain binary data and HL7V2 is generally restricted to the printable characters.
...
This means that if all three components of the HD are valued, the entity identified by the first component is the same as the entity identified by components two and three taken together. However, implementers may choose, by site agreement, to specify that if all three components of the HD are valued, the first component defines a member in the set defined by the second and third components.
3.14.1 Namespace ID (IS)
User-defined Table 0300 - Namespace ID is used as the HL7 identifier for the user-defined table of values for this component.
| Anchor | ||||
|---|---|---|---|---|
|
User-defined Table 0300 – Namespace ID
| Value | Description | Comment |
|---|---|---|
| AUSHICPR | Medicare Australia provider number | To support use of Medicare Australia provider numbers, for example in PV1-9 Consulting Doctor, OBR-28 Copy doctors |
Additional suggested values are user defined |
...
The third component governs the interpretation of the second component of the HD. If the third component is a known UID refer to HL7 Table 0301 - Universal ID type for valid values, then the second component is a universal ID of that type.
| Anchor | ||||
|---|---|---|---|---|
|
HL7 Table 0301 - Universal ID type
| Value | Description |
|---|---|
| AUSHICPR † | Australian HIC Provider Number |
| AUSHIC † | Medicare Australia |
| AUSDVA † | Australia - Dept. of Veterans Affairs |
| AUSNATA † | National Association of Testing Authorities, Australia |
| AUSLSPN † | Australian location specific practice number for Diagnostic Imaging |
| DNS | An Internet dotted name. Either in ASCII or as integers |
| GUID | Same as UUID |
| HCD | The CEN Healthcare Coding Scheme Designator. (Identifiers used in DICOM follow this assignment scheme.) |
| HL7 | Reserved for future HL7 registration schemes |
| ISO | An International Standards Organization Object Identifier |
| L | Reserved for locally defined coding scheme |
| M | Reserved for locally defined coding scheme |
| N | Reserved for locally defined coding scheme |
| Random | Usually a base64 encoded string of random bits. The uniqueness depends on the length of the bits. Mail systems often generate ASCII string "unique names," from a combination of random bits and system names. Obviously, such identifiers will not be constrained to the base64 character set. |
| URI | Uniform Resource Identifier |
| UUID | The DCE Universal Unique Identifier |
| x400 | An X.400 MHS format identifier |
| x500 | An X.500 directory name |
...
Conditional on person location type (e.g., nursing unit or department or clinic). After floor, most general patient location designation. User-defined Table 0302 - Point of care is used as the HL7 identifier for the user-defined table of values for this component.
| Anchor | ||||
|---|---|---|---|---|
|
User-defined Table 0302 – Point of care
| Value | Description |
|---|---|
| No suggested values defined |
...
Patient room. After point of care, most general person location designation. User-defined Table 0303 - Room is used as the HL7 identifier for the user-defined table of values for this component.
| Anchor | ||||
|---|---|---|---|---|
|
User-defined Table 0303 – Room
| Value | Description |
|---|---|
| No suggested values defined |
...
Patient bed. After room, most general person location designation. User-defined Table 0304 - Bed is used as the HL7 identifier for the user-defined table of values for this component.
| Anchor | ||||
|---|---|---|---|---|
|
User-defined Table 0304 – Bed
| Value | Description |
|---|---|
| No suggested values defined |
...
Subject to site interpretation but generally describes the highest level physical designation of an institution, medical centre or enterprise. Most general person location designation. (See HD - hierarchic designator) for discussion of data type.
...
Location (e.g., Bed) status. User-defined Table 0306 - Location status is used as the HL7 identifier for the user-defined table of values for this component.
| Anchor | ||||
|---|---|---|---|---|
|
User-defined Table 0306 – Location status
| Value | Description |
|---|---|
| No suggested values defined |
...
Person location type is the categorization of the person’s location defined by facility, building, floor, point of care, room or bed. Although not a required field, when used, it may be the only populated field. Usually includes values such as nursing unit, department, clinic, SNF, physician’s office. User-defined Table 0305 - Person location type is used as the HL7 identifier for the user-defined table of values for this component.
| Anchor | ||||
|---|---|---|---|---|
|
User-defined Table 0305 – Person location type
| Value | Description |
|---|---|
| C | Clinic |
| D | Department |
| H | Home |
| N | Nursing Unit |
| O | Provider’s Office |
| P | Phone |
| S | SNF |
...
After facility, most general person location designation. User-defined Table 0307 - Building is used as the HL7 identifier for the user-defined table of values for this component.
| Anchor | ||||
|---|---|---|---|---|
|
User-defined Table 0307 – Building
| Value | Description |
|---|---|
| No suggested values defined |
...
After building, most general person location designation. User-defined Table 0308 - Floor is used as the HL7 identifier for the user-defined table of values for this component.
| Anchor | ||||
|---|---|---|---|---|
|
User-defined Table 0308 – Floor
| Value | Description |
|---|---|
| No suggested values defined. |
...
A unique designator of the system that stores the data. It is a HD data type (See HD - hierarchic designator). Application ID’s must be unique across a given HL7 implementation.
...
An ID data type that declares the general type of data. Refer to HL7 Table 0191 - Type of referenced data for valid values.
| Anchor | ||||
|---|---|---|---|---|
|
Example field: OBX-5.3 Observation Value => Type of Data
...
An ID data type declaring the format for the data of subcomponent <main type>. Refer to HL7 Table 0291- Subtype of referenced data for valid values.
3.20.4 Subtype (ID)
| Anchor | ||||
|---|---|---|---|---|
|
HL7 Table 0291—Subtype of Referenced Data
Example field: OBX-5.4 Observation Value => Type of Data
Value | Description |
|---|---|
BASIC | ISDN PCM audio data |
DICOM | Digital Imaging and Communications in Medicine |
FAX | Facsimile data |
GIF | Graphics Interchange Format |
HTML | Hypertext Markup Language |
JOT | Electronic ink data (Jot 1.0 standard) |
JPEG | Joint Photographic Experts Group |
Octet-stream | Uninterpreted binary data |
PICT | PICT format image data |
PostScript | PostScript program |
RTF | Rich Text Format |
SGML | Standard Generalized Markup Language (HL7 V2.3.1 and later) |
TIFF | TIFF image data |
| x-hl7-cda-level-one | HL7 Clinical Document Architecture Level One document |
XML | Extensible Markup Language (HL7 V2.3.1 and later) |
| Portable Document Format MIME type: application/pdf [RFC3778] | |
| png | Portable Network Graphics MIME type: image/png [RFC2083] |
| xml | text/xml [RFC7303] or application/xml [RFC7303] |
| emf | image/emf [RFC-seantek-windows-image-03] |
Other MIME subtypes types can be imported from:
http://www.iana.org/assignments/media-types/media-types.xhtml
When this component is valued with a MIME <Subtype (ID)> value, then the corresponding MIME type must be used in the <Type of data (ID)> component.
When this component is valued with a HL7 2.4 defined <Subtype (ID)> (HL7 Table 0291- Subtype of referenced data ) value, then the corresponding HL7 2.4 type of data (HL7 Table 0191 - Type of referenced data) must be used in the <Type of data (ID)> component.
...
This subtype is for binary data which has none of the other standard formats as given by Section 3.20.3, “Type of data (ID)”. Its interpretation by the system utilizing the data must be mutually agreed upon by sending and receiving parties.
...
Usage note: The ST data type is intended for short strings (e.g., less than 50 characters). For longer strings the FT data types should be used.
The ST data should use the same character set as specified in the message header and not use alternative character sets.
...
Definition: The repeating frequency with which the treatment is to be administered. It is similar to the frequency and SIG code tables used in order entry systems. The following is preferred syntax for repeat patterns:
Anchor table0335 table0335
User-defined Table 0335 - Repeat pattern
Value | Description |
|---|---|
Q<integer>S | every <integer> seconds |
Q<integer>M | every <integer> minutes |
Q<integer>H | every <integer> hours |
Q<integer>D | every <integer> days |
Q<integer>W | every <integer> weeks |
Q<integer>L | every <integer> months (Lunar cycle) |
Q<integer>J<day#> | repeats on a particular day of the week, from the French jour (day). If <integer> is missing, the repeat rate is assumed to be 1. Day numbers are counted from 1=Monday to 7=Sunday. So Q2J2 means every second Tuesday; Q1J6 means every Saturday. |
BID | twice a day at institution-specified times (e.g., 9AM-4PM) |
TID | three times a day at institution-specified times (e.g., 9AM-4PM-9PM) |
QID | four times a day at institution-specified times (e.g., 9AM-11AM-4PM-9PM) |
xID | “X” times per day at institution-specified times, where X is a numeral 5 or greater. E.g., 5ID=five times per day; 8ID=8 times per day |
QAM | in the morning at institution-specified time |
QSHIFT | during each of three eight-hour shifts at institution-specified times |
QOD | every other day (same as Q2D) |
QHS | every day before the hour of sleep |
QPM | in the evening at institution-specified time |
C | service is provided continuously between start time and stop time |
U <spec> | for future use, where <spec> is an interval specification as defined by the UNIX cron specification. |
PRN | given as needed |
PRNxxx | where xxx is some frequency code (e.g., PRNQ6H); given as needed over the frequency period. |
Once | one time only. This is also the default when this component is null. |
Meal Related Timings | <timing>C (“cum”)<meal> |
A | Ante (before) |
P | Post (after) |
I | Inter (e.g., between this meal and the next, between dinner and sleep |
M | Cibus Matutinus (breakfast) |
D | Cibus Diurnus (lunch) |
V | Cibus Vespertinus (dinner) |
...
Definition: This non-null component indicates that a second timing specification is to follow using the repeat delimiter. This field can take three values as shown in HL7 table 0472 - TQ Conjunction ID.
Anchor table0472 table0472
HL7 table 0472 - TQ Conjunction ID
Value | Description |
|---|---|
| S | Synchronous. Do the next specification after this one (unless otherwise constrained by the following components: ORC-7^4-start date/time and ORC-7^5-end date/time ). An “S” specification implies that the second timing sequence follows the first, e.g., when an order is written to measure blood pressure Q15 minutes for the 1st hour, then every 2 hours for the next day. |
| A | Asynchronous Do the next specification in parallel with this one (unless otherwise constrained by the following components: ORC-7^4- start date/time and ORC-7^5-end date/time ). The conjunction of “A” specifies two parallel instructions, as are sometimes used in medication, e.g., prednisone given at 1 tab on Monday, Wednesday, Friday, and at 1/2 tab on Tuesday, Thursday, Saturday, Sunday. |
| C | This is an actuation time It will be followed by a completion time for the service. This code allows one to distinguish between the time and priority at which a service should be actuated (e.g., blood should be drawn) and the time and priority at which a service should be completed (e.g., results should be reported). For continuous or periodic services, the point at which the service is actually stopped is determined by the components ORC-7^5-end date/time and ORC-7^3-duration , whichever indicates an earlier stopping time. Ordinarily, only one of these components would be present, but if one requested an EKG with the specification ^1^QAM^X3^D10 then the EKG would be done for only three days since the number of repeats (3) defined the earlier stopping time. |
...
To define a sequence condition, the 10th component of the quantity/timing field component is divided into the subcomponents described in Figure 3-2.
| Anchor | ||||
|---|---|---|---|---|
|
Figure 3-2. Subcomponents of order sequences
Subcomponent | Contains | Notes |
|---|---|---|
1 | Sequence/Results Flag | S for sequence conditions; C for cyclical; R is reserved for possible future use. The C will be used for indicating a repeating cycle of orders; for example, individual intravenous solutions used in a cyclical sequence (a.k.a. “Alternating IVs”). This value would be compatible with linking separate orders or with having all cyclical order components in a single order. Likewise, the value would be compatible with either Parent-Child messages or a single order message to communicate the orders’ sequencing. |
2, 3 | Placer Order Number, first two components | Required/Optional: Contains the first two components of the placer order number: entity identifier (ST) and namespace ID (IS) (respectively). Uses two subcomponents since the placer order number is an EI data type. We have not defined sub-subcomponents in HL7. |
4, 5 | Filler Order Number, first two components | Required/Optional: Contains the first two components of the filler order number: entity identifier (ST) and namespace ID (IS) (respectively). Uses two subcomponents since the filler order number is an EI data type. We have not defined sub-subcomponents in HL7. |
6 | Sequence Condition Value | The acceptable condition values have the form commonly used in project planning methodologies: <one of “SS”, “EE”, “SE”, or “ES”> +/- <time> The first letter stands for start (S) or end (E) of predecessor order, where the predecessor is defined by the placer or filler order number in subcomponents 1,2 or subcomponents 3,4. The second letter stands for the start (S) or end (E) of the successor order, where the successor order is the order containing this quantity/timing specification. The time specifies the interval between the predecessor and successor starts or ends (see following examples). Where <time> is defined as: S<integer> do for <integer> seconds M<integer> do for <integer> minutes H<integer> do for <integer> hours D<integer> do for <integer> days W<integer> do for <integer> weeks L<integer> do for <integer> months |
7 | Maximum Number of Repeats | The maximum number of repeats to be used only on cyclic groups. The total number of repeats is constrained by the end date/time of the last repeat or the end date/time of the parent, whichever is first. |
8, 9 | Placer Order Number, last two components | Required/Optional: Contains the last two components of the placer order number: universal ID (ST) and universal ID type (ID) (respectively). Uses two subcomponents since the placer order number is an EI data type. We have not defined sub-subcomponents in HL7. |
10, 11 | Filler Order Number, last two components | Required/Optional: Contains the last two components of the filler order number: universal ID (ST) and universal ID type (ID) (respectively). Uses two subcomponents since the filler order number is an EI data type. We have not defined sub-subcomponents in HL7. |
...
Its second execution follows the completion of the fourth order. See example in HL7 International v2.4 Section 4.15.2, “RXO segment field examples
...
In the current and future versions of HL7, the precision is indicated by limiting the number of digits used, unless the optional second component is present. Thus, YYYY is used to specify a precision of “year,” YYYYMM specifies a precision of “month,” YYYYMMDD specifies a precision of “day,” YYYYMMDDHH is used to specify a precision of “hour,” YYYYMMDDHHMM is used to specify a precision of “minute,” YYYYMMDDHHMMSS is used to specify a precision of seconds, and YYYYMMDDHHMMSS.SSSS is used to specify a precision of ten thousandths of a second. In each of these cases, the time zone is an optional component. Note that if the time zone is not included, the timezone time zone defaults to that of the local time zone of the sender. Also note that a TS valued field with the HHMM part set to "0000" represents midnight of the night extending from the previous day to the day given by the YYYYMMDD part (see example below). Maximum length of the time stamp is 26.
If a precision of Hour or greater is used a timezone time zone should be specified.
Examples:
...
Used to identify the HL7 version. Refer to HL7 Table 0104 - Version ID for valid values.
3.27.2 Internationalization code (CE)
Used to identify the international affiliate country code. The values to be used are those of ISO 3166 - 1:1977. The ISO 3166 table has three separate forms of the country code: HL7 specifies that the 3-character (alphabetic) form be used for the country code.
Refer to HL7 Table 0399 - Country code for the 3-character codes as defined by ISO 3166 table.
...
Defines the country of the address. ISO 3166 provides a list of country codes that may be used. The ISO 3166 table has three separate forms of the country code: HL7 specifies that the 3-character (alphabetic)form be used for the country code. HL7 Table 0399 - Country code is defined to contain these 3-character codes.
...
Address type is optional and defined by HL7 Table 0190 - Address type.
3.28.8 Other geographic designation (ST)
...
A code that represents the county in which the specified address resides. User-defined Table 0289 - County/parish is used as the HL7 identifier for the user-defined table of values for this component. When this component is used to represent the county (or parish), component 8 <other geographic designation> should not duplicate it (i.e., the use of <other geographic designation> to represent the county is allowed only for the purpose of backward compatibility, and should be discouraged in this and future versions of HL7).
Allowable values: codes defined by government.
| Anchor | ||||
|---|---|---|---|---|
|
User-defined Table 0289 – County/parish
| Value | Description |
|---|---|
| No suggested values defined |
...
A code that represents the census tract in which the specified address resides. User-defined Table 0288 - Census tract is used as the HL7 identifier for the user-defined table of values for this component.
Allowable Values: codes defined by government.
| Anchor | ||||
|---|---|---|---|---|
|
User-defined Table 0288 – Census tract
| Value | Description |
|---|---|
| No suggested values defined |
...
Note: Also note that this new component remains in "alphabetic" representation with each repetition of the fields using these data types. I.e. even though the address may be represented in an ideographic character set, this component will remain represented in an alphabetic character set.
Refer to HL7 table 0465 - Name/address representation for valid values.
In general this component provides an indication of the representation provided by the data item. It does not necessarily specify the character sets used. Thus, even though the representation might provide an indication of what to expect, the sender is still free to encode the contents using whatever character set is desired.
...
Used to specify an educational degree (e.g., MD). Refer to User-defined Table 0360 - Degree for suggested values.
3.29.8 Source table (IS)
User-defined Table 0297 – CN ID source is used as the HL7 identifier for the user-defined table of values for this component. Used to delineate the first component.
Anchor table0297 table0297
User-defined Table 0297 – CN ID source
| Value | Description |
|---|---|
| No suggested values defined |
...
The assigning authority is a unique identifier of the system (or organization or agency of department) that creates the data.
User-defined Table 0363 - Assigning authority is used as the HL7 identifier for the userdefined user-defined table of values for the first sub-component of the HD component, <namespace ID>.
...
3.29.12 Code identifying the check digit scheme employed (ID)
Refer to HL7 Table 0061 - Check digit scheme for valid values.
Anchor table0061 table0061
HL7 Table 0061 - Check digit scheme
| Value | Description |
|---|---|
| NPI | Check digit algorithm in the US National Provider Identifier |
| ISO | ISO 7064: 1983 |
| M10 | Mod 10 algorithm |
| M11 | Mod 11 algorithm |
...
A code corresponding to the type of identifier. In some cases, this code may be used as a qualifier to the <assigning authority> component. Refer to HL7 Table 0203 - Identifier type for suggested values.
3.29.14 Assigning facility (HD)
...
Note: When the HD data type is used in a given segment as a component of a field of another data type, User-defined Table 0300 - Namespace ID (referenced by the first sub-component of the HD component) may be re-defined (given a different user-defined table number and name) by the technical committee responsible for that segment.
...
Note: This new component remains in “alphabetic” representation with each repetition of the field using these data types. I.e.. even though the name may be represented in an ideographic character set, this component will remain represented in an alphabetic character set.
Refer to HL7 Table 0465 – Name/address representation for valid values.
Anchor table0465 table0465
HL7 Table 0465 - Name/address representation
| Value | Description |
|---|---|
| I | Ideographic (i.e., Kanji) |
| A | Alphabetic (i.e., Default or some single-byte) |
| P | Phonetic (i.e., ASCII, Katakana, Hiragana, etc.) |
...
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 is for hinting that a XCN may represent a healthcare service or practitioner role to support Australian Profile for Provider Directory Services reverse lookups. 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.
| Anchor | ||||
|---|---|---|---|---|
|
User-defined Table 0448 – Name context
| Value | Description |
|---|---|
| HealthcareService^Healthcare Service^FHIR-ResourceType | Indicates that this XCN may have been derived from a FHIR HealthcareService resource. (It may be possible to search a FHIR Directory HealthService resources for the XCN's ID.) |
| PractitionerRole^Practitioner Role^FHIR-ResourceType | Indicates that this XCN may have been derived from a FHIR PractitionerRole resource. (It may be possible to search a FHIR Directory PractitionerRole resources for the XCN's ID.) Note that it is not necessary to specify this as it is implied if HealthcareService above is not specified. It is not required, so to not interfere with the potential to indicate indigenous name use for providers/patients. |
...
A code that represents the preferred display order of the components of this person name.
Refer to HL7 Table 0444 – Name assembly order for valid values.
Anchor table0444 table0444
HL7 Table 0444 – Name assembly order
| Value | Description |
|---|---|
| G | Prefix Given Middle Family Suffix |
| F | Prefix Family Middle Given Suffix |
...
A code that represents the type of name i.e., legal name, display name. Refer to User-defined Table 0204 - Organizational name type for suggested values.
| Anchor | ||||
|---|---|---|---|---|
|
User-defined Table 0204 - Organizational name type
| Value | Description |
|---|---|
| A | Alias name |
| L | Legal name |
| D | Display name |
| SL | Stock exchange listing name |
...
The check digit scheme codes are defined in HL7 Table 0061 - Check digit scheme.
3.30.6 Assigning authority (HD)
The assigning authority is a unique identifier of the system (or organization or agency or department) that creates the data. Assigning authorities are unique across a given HL7 implementation. User-defined Table 0363 - Assigning authority is used as the HL7 identifier for the user-defined table of values for the first sub-component of the HD component <namespace ID>.
Note: When the HD data type is used in a given segment as a component of a field of another data type, User-defined Table 0300 - Namespace ID (referenced by the first sub-component of the HD component) may be re-defined (given a different user-defined table number and name) by the technical committee responsible for that segment.
By site agreement, implementers may continue to use User-defined Table 0300 - Namespace ID for the first sub-component.
...
A code corresponding to the type of identifier. In some cases, this code may be used as a qualifier to the “Assigning authority” component. Refer to HL7 Table 0203 -Identifier type for suggested values.
3.30.8 Assigning facility ID (HD)
...
Note: When the HD data type is used in a given segment as a component of a field of another data type, User-defined Table 0300 - Namespace ID (referenced by the first sub-component of the HD component) may be re-defined (given a different user-defined table number and name) by the technical committee responsible for that segment.
...
Note: This new component remains in “alphabetic” representation with each repetition of the field using these data types, i.e. even though the name may be represented in an ideographic character set, this component will remain represented in an alphabetic character set.
Refer to HL7 Table 0465 - Name/address representation code for valid values.
In general this component provides an indication of the representation provided by the data item. It does not necessarily specify the character sets used. Thus, even though the representation might provide an indication of what to expect, the sender is still free to encode the contents using whatever character set is desired.
...
Used to specify an educational degree (e.g., MD). Refer to User-defined Table 0360 – Degree for suggested values.
| Anchor | ||||
|---|---|---|---|---|
|
User-defined Table 0360 - Degree
| Value | Description |
|---|---|
| AAS | Associate of Applied Science |
| AA | Associate of Arts |
| ABA | Associate of Business Administration |
| AE | Associate of Engineering |
| AS | Associate of Science |
| BA | Bachelor of Arts |
| BBA | Bachelor of Business Administration |
| BE | Bachelor or Engineering |
| BFA | Bachelor of Fine Arts |
| BN | Bachelor of Nursing |
| BS | Bachelor of Science |
| BSL | Bachelor of Science – Law |
| BT | Bachelor of Theology |
| CER | Certificate |
| DIP | Diploma |
| DBA | Doctor of Business Administration |
| DED | Doctor of Education |
| PharmD | Doctor of Pharmacy |
| PHE | Doctor of Engineering |
| PHD | Doctor of Philosophy |
| PHS | Doctor of Science |
| MD | Doctor of Medicine |
| DO | Doctor of Osteopathy |
| HS | High School Graduate |
| JD | Juris Doctor |
| MA | Master of Arts |
| MBA | Master of Business Administration |
| MCE | Master of Civil Engineering |
| MDI | Master of Divinity |
| MED | Master of Education |
| MEE | Master of Electrical Engineering |
| ME | Master of Engineering |
| MFA | Master of Fine Arts |
| MME | Master of Mechanical Engineering |
| MS | Master of Science |
| MSL | Master of Science – Law |
| MT | Master of Theology |
| NG | Non-Graduate |
| SEC | Secretarial Certificate |
| TS | Trade School Graduate |
...
A code that represents the type of name. Refer to HL7 Table 0200 - Name type for valid values.
Note: The content of Legal Name is country specific. In the US the legal name is the same as the current married name.
...
Note: This new component remains in "alphabetic" representation with each repetition of the field using these data types. I.e. even though the name may be represented in an ideographic character set, this component will remain represented in an alphabetic character set.
Refer to HL7 Table 0465 - Name/address representation for valid values.
In general this component provides an indication of the representation provided by the data item. It does not necessarily specify the character sets used. Thus, even though the representation might provide an indication of what to expect, the sender is still free to encode the contents using whatever character set is desired.
...
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.
Anchor table0448 table0448
User-defined Table 0448 – Name context
| Value | Description |
|---|---|
| No suggested values defined |
...
A code that represents the preferred display order of the components of this person name. Refer to HL7 Table 0444 - Name assembly order for valid values.
| Anchor | ||||
|---|---|---|---|---|
|
...
Defined as the TN data type (see HL7 International v2.4 Section 2.9.45, “TN - telephone number”), except that the length of the country access code has been increased to three.
...
A code that represents a specific use of a telecommunication number. Refer to HL7 Table 0201 - Telecommunication use code for valid values.
| Anchor | ||||
|---|---|---|---|---|
|
HL7 Table 0201 - Telecommunication use code
| Value | Description |
|---|---|
| PRN | Primary Residence Number |
| ORN | Other Residence Number |
| WPN | Work Number |
| VHN | Vacation Home Number |
| ASN | Answering Service Number |
| EMR | Emergency Number |
| NET | Network (email) Address |
| BPN | Beeper Number |
...
A code that represents the type of telecommunication equipment. Refer to HL7 Table 0202 - Telecommunication equipment type for valid values.
| Anchor | ||||
|---|---|---|---|---|
|
HL7 Table 0202 - Telecommunication equipment type
| Value | Description |
|---|---|
| PH | Telephone |
| FX | Fax |
| MD | Modem |
| CP | Cellular Phone |
| BP | Beeper |
| Internet | Internet Address: Use Only If Telecommunication Use Code Is NET |
| X.400 | X.400 email address: Use Only If Telecommunication Use Code Is NET |
...
Internationalization note: To make this data type interoperate with CEN’s Telecommunication data attribute group, we allow use of the second component for email addresses. The presence of an email address is specified by the addition of the value NET to the Phone Use Code table, and the type of Internet address is specified with the values Internet and X.400 to the Phone Equipment Type table. When used for an Internet address, the first component of the XTN data type will be null. If the @-sign is being used as a subcomponent delimiter, the HL7 subcomponent escape sequence may be used when encoding an Internet address (see HL7 International v2.4 Section 2.10.1, “Formatting codes”).
Note: Components five through nine reiterate the basic function of the first component in a delimited form that allows the expression of both local and international telephone numbers. In Version 2.3, the recommended form for the telephone number is to use the delimited form rather than the unstructured form supported by the first component (which is left in for backward compatibility only).
...