Introduction
Purpose
Audience
Organization of this guide
Referenced profiles - antecedents
Scope
In Scope
Out of Scope
Key technical decisions [conventions]
Use Cases
Actors
General Assumptions
Assumptions
Pre-conditions
Post-conditions
Use Case
User Story
Specific Assumptions
Assumptions
Pre-conditions
Post-conditions
Scenario
Context
Interaction Model
Functional Requirements
Message Infrastructure
Conformance Profiles
ADT^A01^ADT_A01 - Inpatient admission message - HealthLink
HL7 Version |
2.4 |
Conformance Profile Definition
Segment | Flavor | Element name | Usage | Cardinality |
---|---|---|---|---|
MSH | MSH_HL_Admit | Message Header | R | [1..1] |
EVN | EVN | Event Type | R | [1..1] |
PID | PID_HL | Patient identification | R | [1..1] |
PD1 | PD1 | patient additional demographic | O | [0..1] |
ROL | ROL | Role | O | [0..*] |
NK1 | NK1 | Next of kin / associated parties | O | [0..*] |
PV1 | PV1_HL_inPatientAdmission | Patient visit | R | [1..1] |
PV2 | PV2_HL_inPatientAdmission | Patient visit - additional information | O | [0..1] |
ROL | ROL | Role | O | [0..*] |
DB1 | DB1 | Disability | O | [0..*] |
OBX | OBX | Observation/Result | O | [0..*] |
AL1 | AL1 | Patient allergy information | O | [0..*] |
DG1 | DG1 | Diagnosis | O | [0..*] |
DRG | DRG | Diagnosis Related Group | O | [0..1] |
[ | BEGIN PROCEDURE GROUP | O | [0..*] | |
PR1 | PR1 | Procedures | R | [1..1] |
ROL | ROL | Role | O | [0..*] |
GT1 | GT1 | Guarantor | O | [0..*] |
[ | BEGIN INSURANCE GROUP | O | [0..*] | |
IN1 | IN1 | Insurance | R | [1..1] |
IN2 | IN2 | Insurance Additional Information | O | [0..1] |
IN3 | IN3 | Insurance Additional Information, Certification | O | [0..*] |
ROL | ROL | Role | O | [0..*] |
ACC | ACC | Accident | O | [0..1] |
UB1 | UB1 | UB82 | O | [0..1] |
UB2 | UB2 | UB92 Data | O | [0..1] |
PDA | PDA | Patient death and autopsy | O | [0..1] |
] | END INSURANCE GROUP | |||
] | END PROCEDURE GROUP |
ADT^A03^ADT_A03 - Discharge notification message - Healthlink
HL7 Version |
2.4 |
Conformance Profile Definition
Segment | Flavor | Element name | Usage | Cardinality |
---|---|---|---|---|
MSH | MSH_HL_Discharge | Message Header | R | [1..1] |
EVN | EVN_HL | Event Type | R | [1..1] |
PID | PID_HL | Patient identification | R | [1..1] |
PD1 | PD1 | patient additional demographic | O | [0..1] |
ROL | ROL | Role | O | [0..*] |
PV1 | PV1_HL_Discharge | Patient visit | R | [1..1] |
PV2 | PV2 | Patient visit - additional information | O | [0..1] |
ROL | ROL | Role | O | [0..*] |
DB1 | DB1 | Disability | O | [0..*] |
DG1 | DG1 | Diagnosis | O | [0..*] |
DRG | DRG | Diagnosis Related Group | O | [0..1] |
[ | BEGIN PROCEDURE GROUP | O | [0..*] | |
PR1 | PR1 | Procedures | R | [1..1] |
ROL | ROL | Role | O | [0..*] |
OBX | OBX | Observation/Result | O | [0..*] |
PDA | PDA | Patient death and autopsy | O | [0..1] |
] | END PROCEDURE GROUP |
Segments and Field Descriptions
ACC - Accident
Segment DefinitionSeq | Element name | Data type | Usage | Cardinality | Value Set |
---|---|---|---|---|---|
1 | Accident Date/Time | TS | O | [0..1] | |
2 | Accident Code | CE | O | [0..1] | 0050 |
3 | Accident Location | ST | O | [0..1] | |
4 | Auto Accident State | CE | O | [0..1] | 0347 |
5 | Accident Job Related Indicator | ID | O | [0..1] | 0136 |
6 | Accident Death Indicator | ID | O | [0..1] | 0136 |
7 | Entered By | XCN | O | [0..1] | |
8 | Accident Description | ST | O | [0..1] | |
9 | Brought In By | ST | O | [0..1] | |
10 | Police Notified Indicator | ID | O | [0..1] | 0136 |
Value Set Bindings
Location | Value Set ID | Value Set Name | Single Code Value |
---|---|---|---|
ACC-2 | 0050 | Accident code | |
ACC-4 | 0347 | Auto accident state | |
ACC-5 | 0136 | Yes/no indicator | |
ACC-6 | 0136 | Yes/no indicator | |
ACC-10 | 0136 | Yes/no indicator |
AL1 - Patient allergy information
Segment DefinitionSeq | Element name | Data type | Usage | Cardinality | Value Set |
---|---|---|---|---|---|
1 | Set ID - AL1 | CE | R | [1..1] | |
2 | Allergen Type Code | CE | O | [0..1] | 0127 |
3 | Allergen Code/Mnemonic/Description | CE | R | [1..1] | |
4 | Allergy Severity Code | CE | O | [0..1] | 0128 |
5 | Allergy Reaction Code | ST | O | [0..*] | |
6 | Identification Date | DT | O | [0..1] |
Value Set Bindings
Location | Value Set ID | Value Set Name | Single Code Value |
---|---|---|---|
AL1-2 | 0127 | Allergen type | |
AL1-4 | 0128 | Allergy severity |
DB1 - Disability
Segment DefinitionSeq | Element name | Data type | Usage | Cardinality | Value Set |
---|---|---|---|---|---|
1 | Set ID - DB1 | SI | R | [1..1] | |
2 | Disabled Person Code | IS | O | [0..1] | 0334 |
3 | Disabled Person Identifier | CX | O | [0..*] | |
4 | Disability Indicator | ID | O | [0..1] | 0136 |
5 | Disability Start Date | DT | O | [0..1] | |
6 | Disability End Date | DT | O | [0..1] | |
7 | Disability Return to Work Date | DT | O | [0..1] | |
8 | Disability Unable to Work Date | DT | O | [0..1] |
Value Set Bindings
Location | Value Set ID | Value Set Name | Single Code Value |
---|---|---|---|
DB1-2 | 0334 | Disabled person | |
DB1-4 | 0136 | Yes/no indicator |
DG1 - Diagnosis
Segment DefinitionSeq | Element name | Data type | Usage | Cardinality | Value Set |
---|---|---|---|---|---|
1 | Set ID - DG1 | SI | R | [1..1] | |
2 | Diagnosis Coding Method | ID | R | [1..1] | 0053 |
3 | Diagnosis Code - DG1 | CE | O | [0..1] | 0051 |
4 | Diagnosis Description | ST | O | [0..1] | |
5 | Diagnosis Date/Time | TS | O | [0..1] | |
6 | Diagnosis Type | IS | R | [1..1] | 0052 |
7 | Major Diagnostic Category | CE | O | [0..1] | 0118 |
8 | Diagnostic Related Group | CE | O | [0..1] | 0055 |
9 | DRG Approval Indicator | ID | O | [0..1] | 0136 |
10 | DRG Grouper Review Code | IS | O | [0..1] | 0056 |
11 | Outlier Type | CE | O | [0..1] | 0083 |
12 | Outlier Days | NM | O | [0..1] | |
13 | Outlier Cost | CP | O | [0..1] | |
14 | Grouper Version And Type | ST | O | [0..1] | |
15 | Diagnosis Priority | ID | O | [0..1] | 0359 |
16 | Diagnosing Clinician | XCN | O | [0..*] | |
17 | Diagnosis Classification | IS | O | [0..1] | 0228 |
18 | Confidential Indicator | ID | O | [0..1] | 0136 |
19 | Attestation Date/Time | TS | O | [0..1] |
Value Set Bindings
Location | Value Set ID | Value Set Name | Single Code Value |
---|---|---|---|
DG1-2 | 0053 | Diagnosis coding method | |
DG1-3 | 0051 | Diagnosis code | |
DG1-6 | 0052 | Diagnosis type | |
DG1-7 | 0118 | Major diagnostic category | |
DG1-8 | 0055 | Diagnosis related group | |
DG1-9 | 0136 | Yes/no indicator | |
DG1-10 | 0056 | DRG grouper review code | |
DG1-11 | 0083 | Outlier type | |
DG1-15 | 0359 | Diagnosis priority | |
DG1-17 | 0228 | Diagnosis classification | |
DG1-18 | 0136 | Yes/no indicator |
DRG - Diagnosis Related Group
Segment DefinitionSeq | Element name | Data type | Usage | Cardinality | Value Set |
---|---|---|---|---|---|
1 | Diagnostic Related Group | CE | O | [0..1] | 0055 |
2 | DRG Assigned Date/Time | TS | O | [0..1] | |
3 | DRG Approval Indicator | ID | O | [0..1] | 0136 |
4 | DRG Grouper Review Code | IS | O | [0..1] | 0056 |
5 | Outlier Type | CE | O | [0..1] | 0083 |
6 | Outlier Days | NM | O | [0..1] | |
7 | Outlier Cost | CP | O | [0..1] | |
8 | DRG Payor | IS | O | [0..1] | 0229 |
9 | Outlier Reimbursement | CP | O | [0..1] | |
10 | Confidential Indicator | ID | O | [0..1] | 0136 |
11 | DRG Transfer Type | IS | O | [0..1] | 0415 |
Value Set Bindings
Location | Value Set ID | Value Set Name | Single Code Value |
---|---|---|---|
DRG-1 | 0055 | Diagnosis related group | |
DRG-3 | 0136 | Yes/no indicator | |
DRG-4 | 0056 | DRG grouper review code | |
DRG-5 | 0083 | Outlier type | |
DRG-8 | 0229 | DRG payor | |
DRG-10 | 0136 | Yes/no indicator | |
DRG-11 | 0415 | DRG transfer type |
EVN - Event Type
Segment DefinitionSeq | Element name | Data type | Usage | Cardinality | Value Set |
---|---|---|---|---|---|
1 | Event Type Code | ID | O | [0..1] | 0003 |
2 | Recorded Date/Time | TS | R | [1..1] | |
3 | Date/Time Planned Event | TS | O | [0..1] | |
4 | Event Reason Code | IS | O | [0..1] | 0062 |
5 | Operator ID | XCN | O | [0..*] | 0188 |
6 | Event Occurred | TS | O | [0..1] | |
7 | Event Facility | HD | O | [0..1] |
Value Set Bindings
Location | Value Set ID | Value Set Name | Single Code Value |
---|---|---|---|
EVN-1 | 0003 | Event type | |
EVN-4 | 0062 | Event reason | |
EVN-5 | 0188 | Operator ID |
EVN_HL - Event Type
Segment DefinitionSeq | Element name | Data type | Usage | Cardinality | Value Set |
---|---|---|---|---|---|
1 | Event Type Code | ID | O | [0..1] | 0003 |
2 | Recorded Date/Time | TS_HL-TimeRequired | R | [1..1] | |
3 | Date/Time Planned Event | TS | O | [0..1] | |
4 | Event Reason Code | IS | O | [0..1] | 0062 |
5 | Operator ID | XCN | O | [0..*] | 0188 |
6 | Event Occurred | TS | O | [0..1] | |
7 | Event Facility | HD | O | [0..1] |
Value Set Bindings
Location | Value Set ID | Value Set Name | Single Code Value |
---|---|---|---|
EVN_HL-1 | 0003 | Event type | |
EVN_HL-4 | 0062 | Event reason | |
EVN_HL-5 | 0188 | Operator ID |
GT1 - Guarantor
Segment DefinitionSeq | Element name | Data type | Usage | Cardinality | Value Set |
---|---|---|---|---|---|
1 | Set ID - GT1 | SI | R | [1..1] | |
2 | Guarantor Number | CX | O | [0..*] | |
3 | Guarantor Name | XPN | R | [1..*] | |
4 | Guarantor Spouse Name | XPN | O | [0..*] | |
5 | Guarantor Address | XAD | O | [0..*] | |
6 | Guarantor Ph Num - Home | XTN | O | [0..*] | |
7 | Guarantor Ph Num - Business | XTN | O | [0..*] | |
8 | Guarantor Date/Time Of Birth | TS | O | [0..1] | |
9 | Guarantor Administrative Sex | IS | O | [0..1] | 0001 |
10 | Guarantor Type | IS | O | [0..1] | 0068 |
11 | Guarantor Relationship | CE | O | [0..1] | 0063 |
12 | Guarantor SSN | ST | O | [0..1] | |
13 | Guarantor Date - Begin | DT | O | [0..1] | |
14 | Guarantor Date - End | DT | O | [0..1] | |
15 | Guarantor Priority | NM | O | [0..1] | |
16 | Guarantor Employer Name | XPN | O | [0..*] | |
17 | Guarantor Employer Address | XAD | O | [0..*] | |
18 | Guarantor Employer Phone Number | XTN | O | [0..*] | |
19 | Guarantor Employee ID Number | CX | O | [0..*] | |
20 | Guarantor Employment Status | IS | O | [0..1] | 0066 |
21 | Guarantor Organization Name | XON | O | [0..*] | |
22 | Guarantor Billing Hold Flag | ID | O | [0..1] | 0136 |
23 | Guarantor Credit Rating Code | CE | O | [0..1] | 0341 |
24 | Guarantor Death Date And Time | TS | O | [0..1] | |
25 | Guarantor Death Flag | ID | O | [0..1] | 0136 |
26 | Guarantor Charge Adjustment Code | CE | O | [0..1] | 0218 |
27 | Guarantor Household Annual Income | CP | O | [0..1] | |
28 | Guarantor Household Size | NM | O | [0..1] | |
29 | Guarantor Employer ID Number | CX | O | [0..*] | |
30 | Guarantor Marital Status Code | CE | O | [0..1] | 0002 |
31 | Guarantor Hire Effective Date | DT | O | [0..1] | |
32 | Employment Stop Date | DT | O | [0..1] | |
33 | Living Dependency | IS | O | [0..1] | 0223 |
34 | Ambulatory Status | IS | O | [0..*] | 0009 |
35 | Citizenship | CE | O | [0..*] | 0171 |
36 | Primary Language | CE | O | [0..1] | 0296 |
37 | Living Arrangement | IS | O | [0..1] | 0220 |
38 | Publicity Code | CE | O | [0..1] | 0215 |
39 | Protection Indicator | ID | O | [0..1] | 0136 |
40 | Student Indicator | IS | O | [0..1] | 0231 |
41 | Religion | CE | O | [0..1] | 0006 |
42 | Mother's Maiden Name | XPN | O | [0..*] | |
43 | Nationality | CE | O | [0..1] | 0212 |
44 | Ethnic Group | CE | O | [0..*] | 0189 |
45 | Contact Person's Name | XPN | O | [0..*] | |
46 | Contact Person's Telephone Number | XTN | O | [0..*] | |
47 | Contact Reason | CE | O | [0..1] | 0222 |
48 | Contact Relationship | IS | O | [0..1] | 0063 |
49 | Job Title | ST | O | [0..1] | |
50 | Job Code/Class | JCC | O | [0..1] | 0327 |
51 | Guarantor Employer's Organization Name | XON | O | [0..*] | |
52 | Handicap | IS | O | [0..1] | 0295 |
53 | Job Status | IS | O | [0..1] | 0311 |
54 | Guarantor Financial Class | FC | O | [0..1] | 0064 |
55 | Guarantor Race | CE | O | [0..*] | 0005 |
Value Set Bindings
Location | Value Set ID | Value Set Name | Single Code Value |
---|---|---|---|
GT1-9 | 0001 | Administrative sex | |
GT1-10 | 0068 | Guarantor type | |
GT1-11 | 0063 | Relationship | |
GT1-20 | 0066 | Employment status | |
GT1-22 | 0136 | Yes/no indicator | |
GT1-23 | 0341 | Guarantor credit rating code | |
GT1-25 | 0136 | Yes/no indicator | |
GT1-26 | 0218 | Patient charge adjustment | |
GT1-30 | 0002 | Marital status | |
GT1-33 | 0223 | Living dependency | |
GT1-34 | 0009 | Ambulatory status | |
GT1-35 | 0171 | Citizenship | |
GT1-36 | 0296 | Primary language | |
GT1-37 | 0220 | Living arrangement | |
GT1-38 | 0215 | Publicity code | |
GT1-39 | 0136 | Yes/no indicator | |
GT1-40 | 0231 | Student status | |
GT1-41 | 0006 | Religion | |
GT1-43 | 0212 | Nationality | |
GT1-44 | 0189 | Ethnic group | |
GT1-47 | 0222 | Contact reason | |
GT1-48 | 0063 | Relationship | |
GT1-50 | 0327 | Job code/class | |
GT1-52 | 0295 | Handicap | |
GT1-53 | 0311 | Job status | |
GT1-54 | 0064 | Financial class | |
GT1-55 | 0005 | Race |
IN1 - Insurance
Segment DefinitionSeq | Element name | Data type | Usage | Cardinality | Value Set |
---|---|---|---|---|---|
1 | Set ID - IN1 | SI | R | [1..1] | |
2 | Insurance Plan ID | CE | R | [1..1] | 0072 |
3 | Insurance Company ID | CX | R | [1..*] | |
4 | Insurance Company Name | XON | O | [0..*] | |
5 | Insurance Company Address | XAD | O | [0..*] | |
6 | Insurance Co Contact Person | XPN | O | [0..*] | |
7 | Insurance Co Phone Number | XTN | O | [0..*] | |
8 | Group Number | ST | O | [0..1] | |
9 | Group Name | XON | O | [0..*] | |
10 | Insured's Group Emp ID | CX | O | [0..*] | |
11 | Insured's Group Emp Name | XON | O | [0..*] | |
12 | Plan Effective Date | DT | O | [0..1] | |
13 | Plan Expiration Date | DT | O | [0..1] | |
14 | Authorization Information | AUI | O | [0..1] | |
15 | Plan Type | IS | O | [0..1] | 0086 |
16 | Name Of Insured | XPN | O | [0..*] | |
17 | Insured's Relationship To Patient | CE | O | [0..1] | 0063 |
18 | Insured's Date Of Birth | TS | O | [0..1] | |
19 | Insured's Address | XAD | O | [0..*] | |
20 | Assignment Of Benefits | IS | O | [0..1] | 0135 |
21 | Coordination Of Benefits | IS | O | [0..1] | 0173 |
22 | Coord Of Ben. Priority | ST | O | [0..1] | |
23 | Notice Of Admission Flag | ID | O | [0..1] | 0136 |
24 | Notice Of Admission Date | DT | O | [0..1] | |
25 | Report Of Eligibility Flag | ID | O | [0..1] | 0136 |
26 | Report Of Eligibility Date | DT | O | [0..1] | |
27 | Release Information Code | IS | O | [0..1] | 0093 |
28 | Pre-Admit Cert (PAC) | ST | O | [0..1] | |
29 | Verification Date/Time | TS | O | [0..1] | |
30 | Verification By | XCN | O | [0..*] | |
31 | Type Of Agreement Code | IS | O | [0..1] | 0098 |
32 | Billing Status | IS | O | [0..1] | 0022 |
33 | Lifetime Reserve Days | NM | O | [0..1] | |
34 | Delay Before L.R. Day | NM | O | [0..1] | |
35 | Company Plan Code | IS | O | [0..1] | 0042 |
36 | Policy Number | ST | O | [0..1] | |
37 | Policy Deductible | CP | O | [0..1] | |
38 | Policy Limit - Amount | CP | O | [0..1] | |
39 | Policy Limit - Days | NM | O | [0..1] | |
40 | Room Rate - Semi-Private | CP | O | [0..1] | |
41 | Room Rate - Private | CP | O | [0..1] | |
42 | Insured's Employment Status | CE | O | [0..1] | 0066 |
43 | Insured's Administrative Sex | IS | O | [0..1] | 0001 |
44 | Insured's Employer's Address | XAD | O | [0..*] | |
45 | Verification Status | ST | O | [0..1] | |
46 | Prior Insurance Plan ID | IS | O | [0..1] | 0072 |
47 | Coverage Type | IS | O | [0..1] | 0309 |
48 | Handicap | IS | O | [0..1] | 0295 |
49 | Insured's ID Number | CX | O | [0..*] |
Value Set Bindings
Location | Value Set ID | Value Set Name | Single Code Value |
---|---|---|---|
IN1-2 | 0072 | Insurance plan ID | |
IN1-15 | 0086 | Plan ID | |
IN1-17 | 0063 | Relationship | |
IN1-20 | 0135 | Assignment of benefits | |
IN1-21 | 0173 | Coordination of benefits | |
IN1-23 | 0136 | Yes/no indicator | |
IN1-25 | 0136 | Yes/no indicator | |
IN1-27 | 0093 | Release information | |
IN1-31 | 0098 | Type of agreement | |
IN1-32 | 0022 | Billing status | |
IN1-35 | 0042 | Company plan code | |
IN1-42 | 0066 | Employment status | |
IN1-43 | 0001 | Administrative sex | |
IN1-46 | 0072 | Insurance plan ID | |
IN1-47 | 0309 | Coverage type | |
IN1-48 | 0295 | Handicap |
IN2 - Insurance Additional Information
Segment DefinitionSeq | Element name | Data type | Usage | Cardinality | Value Set |
---|---|---|---|---|---|
1 | Insured's Employee ID | CX | O | [0..*] | |
2 | Insured's Social Security Number | ST | O | [0..1] | |
3 | Insured's Employer's Name and ID | XCN | O | [0..*] | |
4 | Employer Information Data | IS | O | [0..1] | 0139 |
5 | Mail Claim Party | IS | O | [0..*] | 0137 |
6 | Medicare Health Ins Card Number | ST | O | [0..1] | |
7 | Medicaid Case Name | XPN | O | [0..*] | |
8 | Medicaid Case Number | ST | O | [0..1] | |
9 | Military Sponsor Name | XPN | O | [0..*] | |
10 | Military ID Number | ST | O | [0..1] | |
11 | Dependent Of Military Recipient | CE | O | [0..1] | 0342 |
12 | Military Organization | ST | O | [0..1] | |
13 | Military Station | ST | O | [0..1] | |
14 | Military Service | IS | O | [0..1] | 0140 |
15 | Military Rank/Grade | IS | O | [0..1] | 0141 |
16 | Military Status | IS | O | [0..1] | 0142 |
17 | Military Retire Date | DT | O | [0..1] | |
18 | Military Non-Avail Cert On File | ID | O | [0..1] | 0136 |
19 | Baby Coverage | ID | O | [0..1] | 0136 |
20 | Combine Baby Bill | ID | O | [0..1] | 0136 |
21 | Blood Deductible | ST | O | [0..1] | |
22 | Special Coverage Approval Name | XPN | O | [0..*] | |
23 | Special Coverage Approval Title | ST | O | [0..1] | |
24 | Non-Covered Insurance Code | IS | O | [0..*] | 0143 |
25 | Payor ID | CX | O | [0..*] | |
26 | Payor Subscriber ID | CX | O | [0..*] | |
27 | Eligibility Source | IS | O | [0..1] | 0144 |
28 | Room Coverage Type/Amount | RMC | O | [0..*] | 0145 |
29 | Policy Type/Amount | PTA | O | [0..*] | 0147 |
30 | Daily Deductible | DDI | O | [0..1] | |
31 | Living Dependency | IS | O | [0..1] | 0223 |
32 | Ambulatory Status | IS | O | [0..*] | 0009 |
33 | Citizenship | CE | O | [0..*] | 0171 |
34 | Primary Language | CE | O | [0..1] | 0296 |
35 | Living Arrangement | IS | O | [0..1] | 0220 |
36 | Publicity Code | CE | O | [0..1] | 0215 |
37 | Protection Indicator | ID | O | [0..1] | 0136 |
38 | Student Indicator | IS | O | [0..1] | 0231 |
39 | Religion | CE | O | [0..1] | 0006 |
40 | Mother's Maiden Name | XPN | O | [0..*] | |
41 | Nationality | CE | O | [0..1] | 0212 |
42 | Ethnic Group | CE | O | [0..*] | 0189 |
43 | Marital Status | CE | O | [0..*] | 0002 |
44 | Insured's Employment Start Date | DT | O | [0..1] | |
45 | Employment Stop Date | DT | O | [0..1] | |
46 | Job Title | ST | O | [0..1] | |
47 | Job Code/Class | JCC | O | [0..1] | 0327 |
48 | Job Status | IS | O | [0..1] | 0311 |
49 | Employer Contact Person Name | XPN | O | [0..*] | |
50 | Employer Contact Person Phone Number | XTN | O | [0..*] | |
51 | Employer Contact Reason | IS | O | [0..1] | 0222 |
52 | Insured's Contact Person's Name | XPN | O | [0..*] | |
53 | Insured's Contact Person Phone Number | XTN | O | [0..*] | |
54 | Insured's Contact Person Reason | IS | O | [0..*] | 0222 |
55 | Relationship To The Patient Start Date | DT | O | [0..1] | |
56 | Relationship To The Patient Stop Date | DT | O | [0..*] | |
57 | Insurance Co. Contact Reason | IS | O | [0..1] | 0232 |
58 | Insurance Co Contact Phone Number | XTN | O | [0..1] | |
59 | Policy Scope | IS | O | [0..1] | 0312 |
60 | Policy Source | IS | O | [0..1] | 0313 |
61 | Patient Member Number | CX | O | [0..1] | |
62 | Guarantor's Relationship To Insured | CE | O | [0..1] | 0063 |
63 | Insured's Phone Number - Home | XTN | O | [0..*] | |
64 | Insured's Employer Phone Number | XTN | O | [0..*] | |
65 | Military Handicapped Program | CE | O | [0..1] | 0343 |
66 | Suspend Flag | ID | O | [0..1] | 0136 |
67 | Copay Limit Flag | ID | O | [0..1] | 0136 |
68 | Stoploss Limit Flag | ID | O | [0..1] | 0136 |
69 | Insured Organization Name And ID | XON | O | [0..*] | |
70 | Insured Employer Organization Name And ID | XON | O | [0..*] | |
71 | Race | CE | O | [0..*] | 0005 |
72 | HCFA Patient's Relationship to Insured | CE | O | [0..1] | 0344 |
Value Set Bindings
Location | Value Set ID | Value Set Name | Single Code Value |
---|---|---|---|
IN2-4 | 0139 | Employer information data | |
IN2-5 | 0137 | Mail claim party | |
IN2-11 | 0342 | Military recipient | |
IN2-14 | 0140 | Military service | |
IN2-15 | 0141 | Military rank/grade | |
IN2-16 | 0142 | Military status | |
IN2-18 | 0136 | Yes/no indicator | |
IN2-19 | 0136 | Yes/no indicator | |
IN2-20 | 0136 | Yes/no indicator | |
IN2-24 | 0143 | Non-covered insurance code | |
IN2-27 | 0144 | Eligibility source | |
IN2-28 | 0145 | Room type | |
IN2-29 | 0147 | Policy type | |
IN2-31 | 0223 | Living dependency | |
IN2-32 | 0009 | Ambulatory status | |
IN2-33 | 0171 | Citizenship | |
IN2-34 | 0296 | Primary language | |
IN2-35 | 0220 | Living arrangement | |
IN2-36 | 0215 | Publicity code | |
IN2-37 | 0136 | Yes/no indicator | |
IN2-38 | 0231 | Student status | |
IN2-39 | 0006 | Religion | |
IN2-41 | 0212 | Nationality | |
IN2-42 | 0189 | Ethnic group | |
IN2-43 | 0002 | Marital status | |
IN2-47 | 0327 | Job code/class | |
IN2-48 | 0311 | Job status | |
IN2-51 | 0222 | Contact reason | |
IN2-54 | 0222 | Contact reason | |
IN2-57 | 0232 | Insurance company contact reason | |
IN2-59 | 0312 | Policy scope | |
IN2-60 | 0313 | Policy source | |
IN2-62 | 0063 | Relationship | |
IN2-65 | 0343 | Military handicapped program code | |
IN2-66 | 0136 | Yes/no indicator | |
IN2-67 | 0136 | Yes/no indicator | |
IN2-68 | 0136 | Yes/no indicator | |
IN2-71 | 0005 | Race | |
IN2-72 | 0344 | Patient's relationship to insured |
IN3 - Insurance Additional Information, Certification
Segment DefinitionSeq | Element name | Data type | Usage | Cardinality | Value Set |
---|---|---|---|---|---|
1 | Set ID - IN3 | SI | R | [1..1] | |
2 | Certification Number | CX | O | [0..1] | |
3 | Certified By | XCN | O | [0..*] | |
4 | Certification Required | ID | O | [0..1] | 0136 |
5 | Penalty | MOP | O | [0..1] | 0148 |
6 | Certification Date/Time | TS | O | [0..1] | |
7 | Certification Modify Date/Time | TS | O | [0..1] | |
8 | Operator | XCN | O | [0..*] | |
9 | Certification Begin Date | DT | O | [0..1] | |
10 | Certification End Date | DT | O | [0..1] | |
11 | Days | DTN | O | [0..1] | 0149 |
12 | Non-Concur Code/Description | CE | O | [0..1] | 0233 |
13 | Non-Concur Effective Date/Time | TS | O | [0..1] | |
14 | Physician Reviewer | XCN | O | [0..*] | 0010 |
15 | Certification Contact | ST | O | [0..1] | |
16 | Certification Contact Phone Number | XTN | O | [0..*] | |
17 | Appeal Reason | CE | O | [0..1] | 0345 |
18 | Certification Agency | CE | O | [0..1] | 0346 |
19 | Certification Agency Phone Number | XTN | O | [0..*] | |
20 | Pre-Certification Req/Window | PCF | O | [0..*] | 0150 |
21 | Case Manager | ST | O | [0..1] | |
22 | Second Opinion Date | DT | O | [0..1] | |
23 | Second Opinion Status | IS | O | [0..1] | 0151 |
24 | Second Opinion Documentation Received | IS | O | [0..*] | 0152 |
25 | Second Opinion Physician | XCN | O | [0..*] | 0010 |
Value Set Bindings
Location | Value Set ID | Value Set Name | Single Code Value |
---|---|---|---|
IN3-4 | 0136 | Yes/no indicator | |
IN3-5 | 0148 | Penalty type | |
IN3-11 | 0149 | Day type | |
IN3-12 | 0233 | Non-concur code/description | |
IN3-14 | 0010 | Physician ID | |
IN3-17 | 0345 | Appeal reason | |
IN3-18 | 0346 | Certification agency | |
IN3-20 | 0150 | Pre-certification patient type | |
IN3-23 | 0151 | Second opinion status | |
IN3-24 | 0152 | Second opinion documentation received | |
IN3-25 | 0010 | Physician ID |
MSH_HL_Admit - Message Header
Segment DefinitionSeq | Element name | Data type | Usage | Cardinality | Value Set |
---|---|---|---|---|---|
1 | Field Separator | ST | R | [1..1] | |
2 | Encoding Characters | ST | R | [1..1] | |
3 | Sending Application | HD_HL-sendingAppFac | R | [1..1] | |
4 | Sending Facility | HD_HL-sendingAppFac | R | [1..1] | 0362 |
5 | Receiving Application | HD_HL-Lengh50 | O | [0..1] | 0361 |
6 | Receiving Facility | HD_HL-sendingAppFac | R | [1..1] | |
7 | Date/Time Of Message | TS_HL-TimeRequired | R | [1..1] | |
8 | Security | ST | O | [0..1] | |
9 | Message Type | MSG_HL_Admit | R | [1..1] | 0076 |
10 | Message Control ID | ST | R | [1..1] | |
11 | Processing ID | PT | R | [1..1] | |
12 | Version ID | VID_HL | R | [1..1] | 0104,0104 |
13 | Sequence Number | NM | O | [0..1] | |
14 | Continuation Pointer | ST | O | [0..1] | |
15 | Accept Acknowledgment Type | ID | O | [0..1] | 0155 |
16 | Application Acknowledgment Type | ID | O | [0..1] | |
17 | Country Code | ID | O | [0..1] | 0399 |
18 | Character Set | ID | O | [0..*] | 0211 |
19 | Principal Language Of Message | CE_HL | O | [0..1] | |
20 | Alternate Character Set Handling Scheme | ID | O | [0..1] | 0356 |
21 | Conformance Statement ID | ID | O | [0..*] | 0449 |
Conformance Statements
ID | Description |
---|---|
MSH_HL_Admit-12.1 | MSH-12.1 SHALL contain the constant value '2.4' drawn from the code system 'HL70104'. |
Value Set Bindings
Location | Value Set ID | Value Set Name | Single Code Value |
---|---|---|---|
MSH_HL_Admit-4 | 0362 | Sending/receiving facility | |
MSH_HL_Admit-5 | 0361 | Sending/receiving application | |
MSH_HL_Admit-9 | 0076 | Message type | |
MSH_HL_Admit-12 | 0104 | Version ID | |
MSH_HL_Admit-12.1 | 2.4 | ||
MSH_HL_Admit-15 | 0155 | Accept/application acknowledgment conditions | |
MSH_HL_Admit-17 | 0399 | Country code | |
MSH_HL_Admit-18 | 0211 | Alternate character sets | |
MSH_HL_Admit-20 | 0356 | Alternate character set handling scheme | |
MSH_HL_Admit-21 | 0449 | Conformance statements |
MSH-3: Sending Application (HD_HL-sendingAppFac)
For Ihboundmessage types (LabOrders and Referral) thiswill contain a value of"HealthlinkOnline" asthese messages aregenerated on theHealthlink application.
MSH_HL_Discharge - Message Header
Segment DefinitionSeq | Element name | Data type | Usage | Cardinality | Value Set |
---|---|---|---|---|---|
1 | Field Separator | ST | R | [1..1] | |
2 | Encoding Characters | ST | R | [1..1] | |
3 | Sending Application | HD_HL-sendingAppFac | R | [1..1] | |
4 | Sending Facility | HD_HL-sendingAppFac | R | [1..1] | 0362 |
5 | Receiving Application | HD_HL-Lengh50 | O | [0..1] | 0361 |
6 | Receiving Facility | HD_HL-sendingAppFac | R | [1..1] | |
7 | Date/Time Of Message | TS_HL-TimeRequired | R | [1..1] | |
8 | Security | ST | O | [0..1] | |
9 | Message Type | MSG_HL_Discharge | R | [1..1] | 0076 |
10 | Message Control ID | ST | R | [1..1] | |
11 | Processing ID | PT | R | [1..1] | |
12 | Version ID | VID_HL | R | [1..1] | 0104,0104 |
13 | Sequence Number | NM | O | [0..1] | |
14 | Continuation Pointer | ST | O | [0..1] | |
15 | Accept Acknowledgment Type | ID | O | [0..1] | 0155 |
16 | Application Acknowledgment Type | ID | O | [0..1] | |
17 | Country Code | ID | O | [0..1] | 0399 |
18 | Character Set | ID | O | [0..*] | 0211 |
19 | Principal Language Of Message | CE_HL | O | [0..1] | |
20 | Alternate Character Set Handling Scheme | ID | O | [0..1] | 0356 |
21 | Conformance Statement ID | ID | O | [0..*] | 0449 |
Conformance Statements
ID | Description |
---|---|
MSH_HL_Discharge-12.1 | MSH-12.1 SHALL contain the constant value '2.4' drawn from the code system 'HL70104'. |
Value Set Bindings
Location | Value Set ID | Value Set Name | Single Code Value |
---|---|---|---|
MSH_HL_Discharge-4 | 0362 | Sending/receiving facility | |
MSH_HL_Discharge-5 | 0361 | Sending/receiving application | |
MSH_HL_Discharge-9 | 0076 | Message type | |
MSH_HL_Discharge-12 | 0104 | Version ID | |
MSH_HL_Discharge-12.1 | 2.4 | ||
MSH_HL_Discharge-15 | 0155 | Accept/application acknowledgment conditions | |
MSH_HL_Discharge-17 | 0399 | Country code | |
MSH_HL_Discharge-18 | 0211 | Alternate character sets | |
MSH_HL_Discharge-20 | 0356 | Alternate character set handling scheme | |
MSH_HL_Discharge-21 | 0449 | Conformance statements |
MSH-3: Sending Application (HD_HL-sendingAppFac)
For Ihboundmessage types (LabOrders and Referral) thiswill contain a value of"HealthlinkOnline" asthese messages aregenerated on theHealthlink application.
NK1 - Next of kin / associated parties
Segment DefinitionSeq | Element name | Data type | Usage | Cardinality | Value Set |
---|---|---|---|---|---|
1 | Set ID - NK1 | SI | R | [1..1] | |
2 | Name | XPN | O | [0..*] | |
3 | Relationship | CE | O | [0..1] | 0063 |
4 | Address | XAD | O | [0..*] | |
5 | Phone Number | XTN | O | [0..*] | |
6 | Business Phone Number | XTN | O | [0..*] | |
7 | Contact Role | CE | O | [0..1] | 0131 |
8 | Start Date | DT | O | [0..1] | |
9 | End Date | DT | O | [0..1] | |
10 | Next of Kin / Associated Parties Job Title | ST | O | [0..1] | |
11 | Next of Kin / Associated Parties Job Code/Class | JCC | O | [0..1] | 0327 |
12 | Next of Kin / Associated Parties Employee Number | CX | O | [0..1] | |
13 | Organization Name - NK1 | XON | O | [0..*] | |
14 | Marital Status | CE | O | [0..1] | 0002 |
15 | Administrative Sex | IS | O | [0..1] | 0001 |
16 | Date/Time Of Birth | TS | O | [0..1] | |
17 | Living Dependency | IS | O | [0..*] | 0223 |
18 | Ambulatory Status | IS | O | [0..*] | 0009 |
19 | Citizenship | CE | O | [0..*] | 0171 |
20 | Primary Language | CE | O | [0..1] | 0296 |
21 | Living Arrangement | IS | O | [0..1] | 0220 |
22 | Publicity Code | CE | O | [0..1] | 0215 |
23 | Protection Indicator | ID | O | [0..1] | 0136 |
24 | Student Indicator | IS | O | [0..1] | 0231 |
25 | Religion | CE | O | [0..1] | 0006 |
26 | Mother's Maiden Name | XPN | O | [0..*] | |
27 | Nationality | CE | O | [0..1] | 0212 |
28 | Ethnic Group | CE | O | [0..*] | 0189 |
29 | Contact Reason | CE | O | [0..*] | 0222 |
30 | Contact Person's Name | XPN | O | [0..*] | |
31 | Contact Person's Telephone Number | XTN | O | [0..*] | |
32 | Contact Person's Address | XAD | O | [0..*] | |
33 | Next of Kin/Associated Party's Identifiers | CX | O | [0..*] | |
34 | Job Status | IS | O | [0..1] | 0311 |
35 | Race | CE | O | [0..*] | 0005 |
36 | Handicap | IS | O | [0..1] | 0295 |
37 | Contact Person Social Security Number | ST | O | [0..1] |
Value Set Bindings
Location | Value Set ID | Value Set Name | Single Code Value |
---|---|---|---|
NK1-3 | 0063 | Relationship | |
NK1-7 | 0131 | Contact Role | |
NK1-11 | 0327 | Job code/class | |
NK1-14 | 0002 | Marital status | |
NK1-15 | 0001 | Administrative sex | |
NK1-17 | 0223 | Living dependency | |
NK1-18 | 0009 | Ambulatory status | |
NK1-19 | 0171 | Citizenship | |
NK1-20 | 0296 | Primary language | |
NK1-21 | 0220 | Living arrangement | |
NK1-22 | 0215 | Publicity code | |
NK1-23 | 0136 | Yes/no indicator | |
NK1-24 | 0231 | Student status | |
NK1-25 | 0006 | Religion | |
NK1-27 | 0212 | Nationality | |
NK1-28 | 0189 | Ethnic group | |
NK1-29 | 0222 | Contact reason | |
NK1-34 | 0311 | Job status | |
NK1-35 | 0005 | Race | |
NK1-36 | 0295 | Handicap |
OBX - Observation/Result
Segment DefinitionSeq | Element name | Data type | Usage | Cardinality | Value Set |
---|---|---|---|---|---|
1 | Set ID - OBX | SI | O | [0..1] | |
2 | Value Type | ID | C | [0..1] | 0125 |
3 | Observation Identifier | CE | R | [1..1] | |
4 | Observation Sub-Id | ST | C | [0..1] | |
5 | Observation Value | VARIES | C | [0..*] | |
6 | Units | CE | O | [0..1] | |
7 | References Range | ST | O | [0..1] | |
8 | Abnormal Flags | IS | O | [0..1] | 0078 |
9 | Probability | NM | O | [0..5] | |
10 | Nature of Abnormal Test | ID | O | [0..1] | 0080 |
11 | Observation Result Status | ID | R | [1..1] | 0085 |
12 | Date Last Observation Normal Value | TS | O | [0..1] | |
13 | User Defined Access Checks | ST | O | [0..1] | |
14 | Date/Time of the Observation | TS | O | [0..1] | |
15 | Producer's ID | CE | O | [0..1] | |
16 | Responsible Observer | XCN | O | [0..1] | |
17 | Observation Method | CE | O | [0..*] | |
18 | Equipment Instance Identifier | EI | O | [0..*] | |
19 | Date/Time of the Analysis | TS | O | [0..1] |
Value Set Bindings
Location | Value Set ID | Value Set Name | Single Code Value |
---|---|---|---|
OBX-2 | 0125 | Value type | |
OBX-8 | 0078 | Abnormal flags | |
OBX-10 | 0080 | Nature of abnormal testing | |
OBX-11 | 0085 | Observation result status codes interpretation |
PD1 - patient additional demographic
Segment DefinitionSeq | Element name | Data type | Usage | Cardinality | Value Set |
---|---|---|---|---|---|
1 | Living Dependency | IS | O | [0..*] | 0223 |
2 | Living Arrangement | IS | O | [0..1] | 0220 |
3 | Patient Primary Facility | XON | O | [0..*] | |
4 | Patient Primary Care Provider Name & ID No. | XCN | O | [0..*] | |
5 | Student Indicator | IS | O | [0..1] | 0231 |
6 | Handicap | IS | O | [0..1] | 0295 |
7 | Living Will Code | IS | O | [0..1] | 0315 |
8 | Organ Donor Code | IS | O | [0..1] | 0316 |
9 | Separate Bill | ID | O | [0..1] | 0136 |
10 | Duplicate Patient | CX | O | [0..*] | |
11 | Publicity Code | CE | O | [0..1] | 0215 |
12 | Protection Indicator | ID | O | [0..1] | 0136 |
13 | Protection Indicator Effective Date | DT | O | [0..1] | |
14 | Place of Worship | XON | O | [0..*] | |
15 | Advance Directive Code | CE | O | [0..*] | 0435 |
16 | Immunization Registry Status | IS | O | [0..1] | 0441 |
17 | Immunization Registry Status Effective Date | DT | O | [0..1] | |
18 | Publicity Code Effective Date | DT | O | [0..1] | |
19 | Military Branch | IS | O | [0..1] | 0140 |
20 | Military Rank/Grade | IS | O | [0..1] | 0141 |
21 | Military Status | IS | O | [0..1] | 0142 |
Value Set Bindings
Location | Value Set ID | Value Set Name | Single Code Value |
---|---|---|---|
PD1-1 | 0223 | Living dependency | |
PD1-2 | 0220 | Living arrangement | |
PD1-5 | 0231 | Student status | |
PD1-6 | 0295 | Handicap | |
PD1-7 | 0315 | Living will code | |
PD1-8 | 0316 | Organ donor code | |
PD1-9 | 0136 | Yes/no indicator | |
PD1-11 | 0215 | Publicity code | |
PD1-12 | 0136 | Yes/no indicator | |
PD1-15 | 0435 | Advance directive code | |
PD1-16 | 0441 | Immunization registry status | |
PD1-19 | 0140 | Military service | |
PD1-20 | 0141 | Military rank/grade | |
PD1-21 | 0142 | Military status |
PDA - Patient death and autopsy
Segment DefinitionSeq | Element name | Data type | Usage | Cardinality | Value Set |
---|---|---|---|---|---|
1 | Death Cause Code | CE | O | [0..*] | |
2 | Death Location | PL | O | [0..1] | |
3 | Death Certified Indicator | ID | O | [0..1] | 0136 |
4 | Death Certificate Signed Date/Time | TS | O | [0..1] | |
5 | Death Certified By | XCN | O | [0..1] | |
6 | Autopsy Indicator | ID | O | [0..1] | 0136 |
7 | Autopsy Start and End Date/Time | DR | O | [0..1] | |
8 | Autopsy Performed By | XCN | O | [0..1] | |
9 | Coroner Indicator | ID | O | [0..1] | 0136 |
Value Set Bindings
Location | Value Set ID | Value Set Name | Single Code Value |
---|---|---|---|
PDA-3 | 0136 | Yes/no indicator | |
PDA-6 | 0136 | Yes/no indicator | |
PDA-9 | 0136 | Yes/no indicator |
PID_HL - Patient identification
Segment DefinitionSeq | Element name | Data type | Usage | Cardinality | Value Set |
---|---|---|---|---|---|
1 | Set ID - PID | SI | O | [0..1] | |
2 | Patient ID | CX | O | [0..1] | |
3 | Patient Identifier List | CX_HL_PID | R | [1..*] | |
4 | Alternate Patient ID - PID | CX | O | [0..*] | |
5 | Patient Name | XPN_HL_PatientName | R | [1..*] | |
6 | Mother's Maiden Name | XPN | O | [0..*] | |
7 | Date/Time Of Birth | TS_HL-TimeRequired | R | [1..1] | |
8 | Administrative Sex | IS | R | [1..1] | 0001 |
9 | Patient Alias | XPN | O | [0..*] | |
10 | Race | CE | O | [0..*] | 0005 |
11 | Patient Address | XAD_HL_Patient | R | [1..*] | |
12 | County Code | IS | O | [0..1] | 0289 |
13 | Phone Number - Home | XTN_HL | O | [0..*] | |
14 | Phone Number - Business | XTN | O | [0..*] | |
15 | Primary Language | CE_HL_Language | O | [0..1] | 0296 |
16 | Marital Status | CE | O | [0..1] | 0002 |
17 | Religion | CE | O | [0..1] | 0006 |
18 | Patient Account Number | CX | O | [0..1] | |
19 | SSN Number - Patient | ST | O | [0..1] | |
20 | Driver's License Number - Patient | DLN | O | [0..1] | |
21 | Mother's Identifier | CX | O | [0..*] | |
22 | Ethnic Group | CE | O | [0..*] | 0189 |
23 | Birth Place | ST | O | [0..1] | |
24 | Multiple Birth Indicator | ID | O | [0..1] | |
25 | Birth Order | NM | O | [0..1] | |
26 | Citizenship | CE | O | [0..*] | 0171 |
27 | Veterans Military Status | CE | O | [0..1] | 0172 |
28 | Nationality | CE | O | [0..1] | 0212 |
29 | Patient Death Date and Time | TS_HL_TimeOptional | C(X/O) | [0..1] | |
30 | Patient Death Indicator | ID | O | [0..1] | 0136 |
31 | Identity Unknown Indicator | ID | O | [0..1] | 0136 |
32 | Identity Reliability Code | IS | O | [0..*] | 0445 |
33 | Last Update Date/Time | TS | O | [0..1] | |
34 | Last Update Facility | HD | O | [0..1] | |
35 | Species Code | CE | C | [0..1] | 0446 |
36 | Breed Code | CE | C | [0..1] | 0447 |
37 | Strain | ST | O | [0..1] | |
38 | Production Class Code | CE | O | [0..1] | 0429 |
Conditional Predicates
Location | Usage | Description |
---|---|---|
PID-29 | C(X/O) | If the value of PID-30 is 'N'. |
Value Set Bindings
Location | Value Set ID | Value Set Name | Single Code Value |
---|---|---|---|
PID_HL-8 | 0001 | Administrative sex | |
PID_HL-10 | 0005 | Race | |
PID_HL-12 | 0289 | County/parish | |
PID_HL-15 | 0296 | Primary language | |
PID_HL-16 | 0002 | Marital status | |
PID_HL-17 | 0006 | Religion | |
PID_HL-22 | 0189 | Ethnic group | |
PID_HL-26 | 0171 | Citizenship | |
PID_HL-27 | 0172 | Veterans military status | |
PID_HL-28 | 0212 | Nationality | |
PID_HL-30 | 0136 | Yes/no indicator | |
PID_HL-31 | 0136 | Yes/no indicator | |
PID_HL-32 | 0445 | Identity Reliability Code | |
PID_HL-35 | 0446 | Species Code | |
PID_HL-36 | 0447 | Breed Code | |
PID_HL-38 | 0429 | Production class Code |
PR1 - Procedures
Segment DefinitionSeq | Element name | Data type | Usage | Cardinality | Value Set |
---|---|---|---|---|---|
1 | Set ID - PR1 | SI | R | [1..1] | |
2 | Procedure Coding Method | IS | R | [1..1] | 0089 |
3 | Procedure Code | CE | R | [1..1] | 0088 |
4 | Procedure Description | ST | O | [0..1] | |
5 | Procedure Date/Time | TS | R | [1..1] | |
6 | Procedure Functional Type | IS | O | [0..1] | 0230 |
7 | Procedure Minutes | NM | O | [0..1] | |
8 | Anesthesiologist | XCN | O | [0..*] | 0010 |
9 | Anesthesia Code | IS | O | [0..1] | 0019 |
10 | Anesthesia Minutes | NM | O | [0..1] | |
11 | Surgeon | XCN | O | [0..*] | 0010 |
12 | Procedure Practitioner | XCN | O | [0..*] | 0010 |
13 | Consent Code | CE | O | [0..1] | 0059 |
14 | Procedure Priority | ID | O | [0..1] | 0418 |
15 | Associated Diagnosis Code | CE | O | [0..1] | 0051 |
16 | Procedure Code Modifier | CE | O | [0..*] | 0340 |
17 | Procedure DRG Type | IS | O | [0..1] | 0416 |
18 | Tissue Type Code | CE | O | [0..*] | 0417 |
Value Set Bindings
Location | Value Set ID | Value Set Name | Single Code Value |
---|---|---|---|
PR1-2 | 0089 | Procedure coding method | |
PR1-3 | 0088 | Procedure Code | |
PR1-6 | 0230 | Procedure functional type | |
PR1-8 | 0010 | Physician ID | |
PR1-9 | 0019 | Anesthesia code | |
PR1-11 | 0010 | Physician ID | |
PR1-12 | 0010 | Physician ID | |
PR1-13 | 0059 | Consent code | |
PR1-14 | 0418 | Procedure priority | |
PR1-15 | 0051 | Diagnosis code | |
PR1-16 | 0340 | Procedure Code modifier | |
PR1-17 | 0416 | Procedure DRG type | |
PR1-18 | 0417 | Tissue type code |
PV1_HL_Discharge - Patient visit
Segment DefinitionSeq | Element name | Data type | Usage | Cardinality | Value Set |
---|---|---|---|---|---|
1 | Set ID - PV1 | SI | O | [0..1] | |
2 | Patient Class | IS | R | [1..1] | 0004 |
3 | Assigned Patient Location | PL_HL | RE | [0..1] | |
4 | Admission Type | IS | O | [0..1] | 0007 |
5 | Preadmit Number | CX | O | [0..1] | |
6 | Prior Patient Location | PL_HL | O | [0..1] | |
7 | Attending Doctor | XCN | RE | [0..*] | |
8 | Referring Doctor | XCN | O | [0..*] | 0010 |
9 | Consulting Doctor | XCN | O | [0..*] | |
10 | Hospital Service | IS | O | [0..1] | 0069 |
11 | Temporary Location | PL | O | [0..1] | |
12 | Preadmit Test Indicator | IS | O | [0..1] | 0087 |
13 | Re-admission Indicator | IS | O | [0..1] | 0092 |
14 | Admit Source | IS | O | [0..1] | 0023 |
15 | Ambulatory Status | IS | O | [0..*] | 0009 |
16 | VIP Indicator | IS | O | [0..1] | 0099 |
17 | Admitting Doctor | XCN | O | [0..*] | |
18 | Patient Type | IS | O | [0..1] | 0018 |
19 | Visit Number | CX | O | [0..1] | |
20 | Financial Class | FC | O | [0..*] | 0064 |
21 | Charge Price Indicator | IS | O | [0..1] | 0032 |
22 | Courtesy Code | IS | O | [0..1] | 0045 |
23 | Credit Rating | IS | O | [0..1] | 0046 |
24 | Contract Code | IS | O | [0..*] | 0044 |
25 | Contract Effective Date | DT | O | [0..*] | |
26 | Contract Amount | NM | O | [0..*] | |
27 | Contract Period | NM | O | [0..*] | |
28 | Interest Code | IS | O | [0..1] | 0073 |
29 | Transfer to Bad Debt Code | IS | O | [0..1] | 0110 |
30 | Transfer to Bad Debt Date | DT | O | [0..1] | |
31 | Bad Debt Agency Code | IS | O | [0..1] | 0021 |
32 | Bad Debt Transfer Amount | NM | O | [0..1] | |
33 | Bad Debt Recovery Amount | NM | O | [0..1] | |
34 | Delete Account Indicator | IS | O | [0..1] | 0111 |
35 | Delete Account Date | DT | O | [0..1] | |
36 | Discharge Disposition | IS | R | [1..1] | 0112 |
37 | Discharged to Location | DLD | RE | [0..1] | 0113 |
38 | Diet Type | CE | O | [0..1] | 0114 |
39 | Servicing Facility | IS | O | [0..1] | 0115 |
40 | Bed Status | IS | O | [0..1] | 0116 |
41 | Account Status | IS | O | [0..1] | 0117 |
42 | Pending Location | PL | O | [0..1] | |
43 | Prior Temporary Location | PL | O | [0..1] | |
44 | Admit Date/Time | TS | O | [0..1] | |
45 | Discharge Date/Time | TS_HL-TimeRequired | R | [1..*] | |
46 | Current Patient Balance | NM | O | [0..1] | |
47 | Total Charges | NM | O | [0..1] | |
48 | Total Adjustments | NM | O | [0..1] | |
49 | Total Payments | NM | O | [0..1] | |
50 | Alternate Visit ID | CX | O | [0..1] | 0203 |
51 | Visit Indicator | IS | O | [0..1] | 0326 |
52 | Other Healthcare Provider | XCN | O | [0..*] |
Value Set Bindings
Location | Value Set ID | Value Set Name | Single Code Value |
---|---|---|---|
PV1_HL_Discharge-2 | 0004 | Patient class | |
PV1_HL_Discharge-4 | 0007 | Admission type | |
PV1_HL_Discharge-8 | 0010 | Physician ID | |
PV1_HL_Discharge-10 | 0069 | Hospital service | |
PV1_HL_Discharge-12 | 0087 | Pre-admit test indicator | |
PV1_HL_Discharge-13 | 0092 | Re-admission indicator | |
PV1_HL_Discharge-14 | 0023 | Admit source | |
PV1_HL_Discharge-15 | 0009 | Ambulatory status | |
PV1_HL_Discharge-16 | 0099 | VIP indicator | |
PV1_HL_Discharge-18 | 0018 | Patient type | |
PV1_HL_Discharge-20 | 0064 | Financial class | |
PV1_HL_Discharge-21 | 0032 | Charge/price indicator | |
PV1_HL_Discharge-22 | 0045 | Courtesy code | |
PV1_HL_Discharge-23 | 0046 | Credit rating | |
PV1_HL_Discharge-24 | 0044 | Contract code | |
PV1_HL_Discharge-28 | 0073 | Interest rate code | |
PV1_HL_Discharge-29 | 0110 | Transfer to bad debt code | |
PV1_HL_Discharge-31 | 0021 | Bad debt agency code | |
PV1_HL_Discharge-34 | 0111 | Delete account code | |
PV1_HL_Discharge-36 | 0112 | Discharge disposition | |
PV1_HL_Discharge-37 | 0113 | Discharged to location | |
PV1_HL_Discharge-38 | 0114 | Diet type | |
PV1_HL_Discharge-39 | 0115 | Servicing facility | |
PV1_HL_Discharge-40 | 0116 | Bed status | |
PV1_HL_Discharge-41 | 0117 | Account status | |
PV1_HL_Discharge-50 | 0203 | Identifier type | |
PV1_HL_Discharge-51 | 0326 | Visit indicator |
PV1_HL_inPatientAdmission - Patient visit
Segment DefinitionSeq | Element name | Data type | Usage | Cardinality | Value Set |
---|---|---|---|---|---|
1 | Set ID - PV1 | SI | O | [0..1] | |
2 | Patient Class | IS | R | [1..1] | 0004 |
3 | Assigned Patient Location | PL_HL | RE | [0..1] | |
4 | Admission Type | IS | O | [0..1] | 0007 |
5 | Preadmit Number | CX | O | [0..1] | |
6 | Prior Patient Location | PL_HL | O | [0..1] | |
7 | Attending Doctor | XCN | O | [0..*] | |
8 | Referring Doctor | XCN | O | [0..*] | 0010 |
9 | Consulting Doctor | XCN | O | [0..*] | |
10 | Hospital Service | IS | O | [0..1] | 0069 |
11 | Temporary Location | PL | O | [0..1] | |
12 | Preadmit Test Indicator | IS | O | [0..1] | 0087 |
13 | Re-admission Indicator | IS | O | [0..1] | 0092 |
14 | Admit Source | IS | O | [0..1] | 0023 |
15 | Ambulatory Status | IS | O | [0..*] | 0009 |
16 | VIP Indicator | IS | O | [0..1] | 0099 |
17 | Admitting Doctor | XCN | O | [0..*] | |
18 | Patient Type | IS | O | [0..1] | 0018 |
19 | Visit Number | CX | O | [0..1] | |
20 | Financial Class | FC | O | [0..*] | 0064 |
21 | Charge Price Indicator | IS | O | [0..1] | 0032 |
22 | Courtesy Code | IS | O | [0..1] | 0045 |
23 | Credit Rating | IS | O | [0..1] | 0046 |
24 | Contract Code | IS | O | [0..*] | 0044 |
25 | Contract Effective Date | DT | O | [0..*] | |
26 | Contract Amount | NM | O | [0..*] | |
27 | Contract Period | NM | O | [0..*] | |
28 | Interest Code | IS | O | [0..1] | 0073 |
29 | Transfer to Bad Debt Code | IS | O | [0..1] | 0110 |
30 | Transfer to Bad Debt Date | DT | O | [0..1] | |
31 | Bad Debt Agency Code | IS | O | [0..1] | 0021 |
32 | Bad Debt Transfer Amount | NM | O | [0..1] | |
33 | Bad Debt Recovery Amount | NM | O | [0..1] | |
34 | Delete Account Indicator | IS | O | [0..1] | 0111 |
35 | Delete Account Date | DT | O | [0..1] | |
36 | Discharge Disposition | IS | O | [0..1] | 0112 |
37 | Discharged to Location | DLD | O | [0..1] | 0113 |
38 | Diet Type | CE | O | [0..1] | 0114 |
39 | Servicing Facility | IS | O | [0..1] | 0115 |
40 | Bed Status | IS | O | [0..1] | 0116 |
41 | Account Status | IS | O | [0..1] | 0117 |
42 | Pending Location | PL | O | [0..1] | |
43 | Prior Temporary Location | PL | O | [0..1] | |
44 | Admit Date/Time | TS | R | [1..1] | |
45 | Discharge Date/Time | TS | O | [0..*] | |
46 | Current Patient Balance | NM | O | [0..1] | |
47 | Total Charges | NM | O | [0..1] | |
48 | Total Adjustments | NM | O | [0..1] | |
49 | Total Payments | NM | O | [0..1] | |
50 | Alternate Visit ID | CX | O | [0..1] | 0203 |
51 | Visit Indicator | IS | O | [0..1] | 0326 |
52 | Other Healthcare Provider | XCN | O | [0..*] |
Value Set Bindings
Location | Value Set ID | Value Set Name | Single Code Value |
---|---|---|---|
PV1_HL_inPatientAdmission-2 | 0004 | Patient class | |
PV1_HL_inPatientAdmission-4 | 0007 | Admission type | |
PV1_HL_inPatientAdmission-8 | 0010 | Physician ID | |
PV1_HL_inPatientAdmission-10 | 0069 | Hospital service | |
PV1_HL_inPatientAdmission-12 | 0087 | Pre-admit test indicator | |
PV1_HL_inPatientAdmission-13 | 0092 | Re-admission indicator | |
PV1_HL_inPatientAdmission-14 | 0023 | Admit source | |
PV1_HL_inPatientAdmission-15 | 0009 | Ambulatory status | |
PV1_HL_inPatientAdmission-16 | 0099 | VIP indicator | |
PV1_HL_inPatientAdmission-18 | 0018 | Patient type | |
PV1_HL_inPatientAdmission-20 | 0064 | Financial class | |
PV1_HL_inPatientAdmission-21 | 0032 | Charge/price indicator | |
PV1_HL_inPatientAdmission-22 | 0045 | Courtesy code | |
PV1_HL_inPatientAdmission-23 | 0046 | Credit rating | |
PV1_HL_inPatientAdmission-24 | 0044 | Contract code | |
PV1_HL_inPatientAdmission-28 | 0073 | Interest rate code | |
PV1_HL_inPatientAdmission-29 | 0110 | Transfer to bad debt code | |
PV1_HL_inPatientAdmission-31 | 0021 | Bad debt agency code | |
PV1_HL_inPatientAdmission-34 | 0111 | Delete account code | |
PV1_HL_inPatientAdmission-36 | 0112 | Discharge disposition | |
PV1_HL_inPatientAdmission-37 | 0113 | Discharged to location | |
PV1_HL_inPatientAdmission-38 | 0114 | Diet type | |
PV1_HL_inPatientAdmission-39 | 0115 | Servicing facility | |
PV1_HL_inPatientAdmission-40 | 0116 | Bed status | |
PV1_HL_inPatientAdmission-41 | 0117 | Account status | |
PV1_HL_inPatientAdmission-50 | 0203 | Identifier type | |
PV1_HL_inPatientAdmission-51 | 0326 | Visit indicator |
PV2 - Patient visit - additional information
Segment DefinitionSeq | Element name | Data type | Usage | Cardinality | Value Set |
---|---|---|---|---|---|
1 | Prior Pending Location | PL | C | [0..1] | |
2 | Accommodation Code | CE | O | [0..1] | 0129 |
3 | Admit Reason | CE | O | [0..1] | |
4 | Transfer Reason | CE | O | [0..1] | |
5 | Patient Valuables | ST | O | [0..*] | |
6 | Patient Valuables Location | ST | O | [0..1] | |
7 | Visit User Code | IS | O | [0..*] | 0130 |
8 | Expected Admit Date/Time | TS | O | [0..1] | |
9 | Expected Discharge Date/Time | TS | O | [0..1] | |
10 | Estimated Length of Inpatient Stay | NM | O | [0..1] | |
11 | Actual Length of Inpatient Stay | NM | O | [0..1] | |
12 | Visit Description | ST | O | [0..1] | |
13 | Referral Source Code | XCN | O | [0..*] | |
14 | Previous Service Date | DT | O | [0..1] | |
15 | Employment Illness Related Indicator | ID | O | [0..1] | 0136 |
16 | Purge Status Code | IS | O | [0..1] | 0213 |
17 | Purge Status Date | DT | O | [0..1] | |
18 | Special Program Code | IS | O | [0..1] | 0214 |
19 | Retention Indicator | ID | O | [0..1] | 0136 |
20 | Expected Number of Insurance Plans | NM | O | [0..1] | |
21 | Visit Publicity Code | IS | O | [0..1] | 0215 |
22 | Visit Protection Indicator | ID | O | [0..1] | 0136 |
23 | Clinic Organization Name | XON | O | [0..*] | |
24 | Patient Status Code | IS | O | [0..1] | 0216 |
25 | Visit Priority Code | IS | O | [0..1] | 0217 |
26 | Previous Treatment Date | DT | O | [0..1] | |
27 | Expected Discharge Disposition | IS | O | [0..1] | 0112 |
28 | Signature on File Date | DT | O | [0..1] | |
29 | First Similar Illness Date | DT | O | [0..1] | |
30 | Patient Charge Adjustment Code | CE | O | [0..1] | 0218 |
31 | Recurring Service Code | IS | O | [0..1] | 0219 |
32 | Billing Media Code | ID | O | [0..1] | 0136 |
33 | Expected Surgery Date and Time | TS | O | [0..1] | |
34 | Military Partnership Code | ID | O | [0..1] | 0136 |
35 | Military Non-Availability Code | ID | O | [0..1] | 0136 |
36 | Newborn Baby Indicator | ID | O | [0..1] | 0136 |
37 | Baby Detained Indicator | ID | O | [0..1] | 0136 |
38 | Mode of Arrival Code | CE | O | [0..1] | 0430 |
39 | Recreational Drug Use Code | CE | O | [0..*] | 0431 |
40 | Admission Level of Care Code | CE | O | [0..1] | 0432 |
41 | Precaution Code | CE | O | [0..*] | 0433 |
42 | Patient Condition Code | CE | O | [0..1] | 0434 |
43 | Living Will Code | IS | O | [0..1] | 0315 |
44 | Organ Donor Code | IS | O | [0..1] | 0316 |
45 | Advance Directive Code | CE | O | [0..*] | 0435 |
46 | Patient Status Effective Date | DT | O | [0..1] | |
47 | Expected LOA Return Date/Time | TS | C | [0..1] |
Value Set Bindings
Location | Value Set ID | Value Set Name | Single Code Value |
---|---|---|---|
PV2-2 | 0129 | Accommodation code | |
PV2-7 | 0130 | Visit user code | |
PV2-15 | 0136 | Yes/no indicator | |
PV2-16 | 0213 | Purge status code | |
PV2-18 | 0214 | Special Program Codes | |
PV2-19 | 0136 | Yes/no indicator | |
PV2-21 | 0215 | Publicity code | |
PV2-22 | 0136 | Yes/no indicator | |
PV2-24 | 0216 | Patient Status | |
PV2-25 | 0217 | Visit priority code | |
PV2-27 | 0112 | Discharge disposition | |
PV2-30 | 0218 | Patient charge adjustment | |
PV2-31 | 0219 | Recurring Service | |
PV2-32 | 0136 | Yes/no indicator | |
PV2-34 | 0136 | Yes/no indicator | |
PV2-35 | 0136 | Yes/no indicator | |
PV2-36 | 0136 | Yes/no indicator | |
PV2-37 | 0136 | Yes/no indicator | |
PV2-38 | 0430 | Mode of arrival code | |
PV2-39 | 0431 | Recreational drug use code | |
PV2-40 | 0432 | Admission level of care code | |
PV2-41 | 0433 | Precaution code | |
PV2-42 | 0434 | Patient condition code | |
PV2-43 | 0315 | Living will code | |
PV2-44 | 0316 | Organ donor code | |
PV2-45 | 0435 | Advance directive code |
PV2_HL_inPatientAdmission - Patient visit - additional information
Segment DefinitionSeq | Element name | Data type | Usage | Cardinality | Value Set |
---|---|---|---|---|---|
1 | Prior Pending Location | PL_HL | O | [0..1] | |
2 | Accommodation Code | CE | O | [0..1] | 0129 |
3 | Admit Reason | CE | RE | [0..1] | |
4 | Transfer Reason | CE | O | [0..1] | |
5 | Patient Valuables | ST | O | [0..*] | |
6 | Patient Valuables Location | ST | O | [0..1] | |
7 | Visit User Code | IS | O | [0..*] | 0130 |
8 | Expected Admit Date/Time | TS | O | [0..1] | |
9 | Expected Discharge Date/Time | TS | O | [0..1] | |
10 | Estimated Length of Inpatient Stay | NM | O | [0..1] | |
11 | Actual Length of Inpatient Stay | NM | O | [0..1] | |
12 | Visit Description | ST | O | [0..1] | |
13 | Referral Source Code | XCN | O | [0..*] | |
14 | Previous Service Date | DT | O | [0..1] | |
15 | Employment Illness Related Indicator | ID | O | [0..1] | |
16 | Purge Status Code | IS | O | [0..1] | 0213 |
17 | Purge Status Date | DT | O | [0..1] | |
18 | Special Program Code | IS | O | [0..1] | 0214 |
19 | Retention Indicator | ID | O | [0..1] | |
20 | Expected Number of Insurance Plans | NM | O | [0..1] | |
21 | Visit Publicity Code | IS | O | [0..1] | 0215 |
22 | Visit Protection Indicator | ID | O | [0..1] | |
23 | Clinic Organization Name | XON | O | [0..*] | |
24 | Patient Status Code | IS | O | [0..1] | 0216 |
25 | Visit Priority Code | IS | O | [0..1] | 0217 |
26 | Previous Treatment Date | DT | O | [0..1] | |
27 | Expected Discharge Disposition | IS | O | [0..1] | 0112 |
28 | Signature on File Date | DT | O | [0..1] | |
29 | First Similar Illness Date | DT | O | [0..1] | |
30 | Patient Charge Adjustment Code | CE | O | [0..1] | 0218 |
31 | Recurring Service Code | IS | O | [0..1] | 0219 |
32 | Billing Media Code | ID | O | [0..1] | |
33 | Expected Surgery Date and Time | TS | O | [0..1] | |
34 | Military Partnership Code | ID | O | [0..1] | |
35 | Military Non-Availability Code | ID | O | [0..1] | |
36 | Newborn Baby Indicator | ID | O | [0..1] | 0136 |
37 | Baby Detained Indicator | ID | O | [0..1] | |
38 | Mode of Arrival Code | CE | O | [0..1] | 0430 |
39 | Recreational Drug Use Code | CE | O | [0..*] | 0431 |
40 | Admission Level of Care Code | CE | O | [0..1] | 0432 |
41 | Precaution Code | CE | O | [0..*] | 0433 |
42 | Patient Condition Code | CE | O | [0..1] | 0434 |
43 | Living Will Code | IS | O | [0..1] | 0315 |
44 | Organ Donor Code | IS | O | [0..1] | 0316 |
45 | Advance Directive Code | CE | O | [0..*] | 0435 |
46 | Patient Status Effective Date | DT | O | [0..1] | |
47 | Expected LOA Return Date/Time | TS | O | [0..1] |
Value Set Bindings
Location | Value Set ID | Value Set Name | Single Code Value |
---|---|---|---|
PV2_HL_inPatientAdmission-2 | 0129 | Accommodation code | |
PV2_HL_inPatientAdmission-7 | 0130 | Visit user code | |
PV2_HL_inPatientAdmission-16 | 0213 | Purge status code | |
PV2_HL_inPatientAdmission-18 | 0214 | Special Program Codes | |
PV2_HL_inPatientAdmission-21 | 0215 | Publicity code | |
PV2_HL_inPatientAdmission-24 | 0216 | Patient Status | |
PV2_HL_inPatientAdmission-25 | 0217 | Visit priority code | |
PV2_HL_inPatientAdmission-27 | 0112 | Discharge disposition | |
PV2_HL_inPatientAdmission-30 | 0218 | Patient charge adjustment | |
PV2_HL_inPatientAdmission-31 | 0219 | Recurring Service | |
PV2_HL_inPatientAdmission-36 | 0136 | Yes/no indicator | |
PV2_HL_inPatientAdmission-38 | 0430 | Mode of arrival code | |
PV2_HL_inPatientAdmission-39 | 0431 | Recreational drug use code | |
PV2_HL_inPatientAdmission-40 | 0432 | Admission level of care code | |
PV2_HL_inPatientAdmission-41 | 0433 | Precaution code | |
PV2_HL_inPatientAdmission-42 | 0434 | Patient condition code | |
PV2_HL_inPatientAdmission-43 | 0315 | Living will code | |
PV2_HL_inPatientAdmission-44 | 0316 | Organ donor code | |
PV2_HL_inPatientAdmission-45 | 0435 | Advance directive code |
ROL - Role
Segment DefinitionSeq | Element name | Data type | Usage | Cardinality | Value Set |
---|---|---|---|---|---|
1 | Role Instance ID | EI | C | [0..1] | |
2 | Action Code | ID | R | [1..1] | 0287 |
3 | Role-ROL | CE | R | [1..1] | 0443 |
4 | Role Person | XCN | R | [1..*] | |
5 | Role Begin Date/Time | TS | O | [0..1] | |
6 | Role End Date/Time | TS | O | [0..1] | |
7 | Role Duration | CE | O | [0..1] | |
8 | Role Action Reason | CE | O | [0..1] | |
9 | Provider Type | CE | O | [0..*] | |
10 | Organization Unit Type - ROL | CE | O | [0..1] | 0406 |
11 | Office/Home Address | XAD | O | [0..*] | |
12 | Phone | XTN | O | [0..*] |
Value Set Bindings
Location | Value Set ID | Value Set Name | Single Code Value |
---|---|---|---|
ROL-2 | 0287 | Problem/goal action code | |
ROL-3 | 0443 | Provider role | |
ROL-10 | 0406 | Organization unit type |
UB1 - UB82
Segment DefinitionSeq | Element name | Data type | Usage | Cardinality | Value Set |
---|---|---|---|---|---|
1 | Set ID - UB1 | SI | O | [0..1] | |
2 | Blood Deductible (43) | NM | O | [0..1] | |
3 | Blood Furnished-Pints Of (40) | NM | O | [0..1] | |
4 | Blood Replaced-Pints (41) | NM | O | [0..1] | |
5 | Blood Not Replaced-Pints(42) | NM | O | [0..1] | |
6 | Co-Insurance Days (25) | NM | O | [0..1] | |
7 | Condition Code (35-39) | IS | O | [0..5] | 0043 |
8 | Covered Days - (23) | NM | O | [0..1] | |
9 | Non Covered Days - (24) | NM | O | [0..1] | |
10 | Value Amount & Code (46-49) | UVC | O | [0..8] | 0153 |
11 | Number Of Grace Days (90) | NM | O | [0..1] | |
12 | Special Program Indicator (44) | CE | O | [0..1] | 0348 |
13 | PSRO/UR Approval Indicator (87) | CE | O | [0..1] | 0349 |
14 | PSRO/UR Approved Stay-Fm (88) | DT | O | [0..1] | |
15 | PSRO/UR Approved Stay-To (89) | DT | O | [0..1] | |
16 | Occurrence (28-32) | OCD | O | [0..5] | 0350 |
17 | Occurrence Span (33) | CE | O | [0..1] | 0351 |
18 | Occur Span Start Date(33) | DT | O | [0..1] | |
19 | Occur Span End Date (33) | DT | O | [0..1] | |
20 | UB-82 Locator 2 | ST | O | [0..1] | |
21 | UB-82 Locator 9 | ST | O | [0..1] | |
22 | UB-82 Locator 27 | ST | O | [0..1] | |
23 | UB-82 Locator 45 | ST | O | [0..1] |
Value Set Bindings
Location | Value Set ID | Value Set Name | Single Code Value |
---|---|---|---|
UB1-7 | 0043 | Condition code | |
UB1-10 | 0153 | Value code | |
UB1-12 | 0348 | Special program indicator | |
UB1-13 | 0349 | PSRO/UR approval indicator | |
UB1-16 | 0350 | Occurrence code | |
UB1-17 | 0351 | Occurrence span |
UB2 - UB92 Data
Segment DefinitionSeq | Element name | Data type | Usage | Cardinality | Value Set |
---|---|---|---|---|---|
1 | Set ID - UB2 | SI | O | [0..1] | |
2 | Co-Insurance Days (9) | ST | O | [0..1] | |
3 | Condition Code (24-30) | IS | O | [0..7] | 0043 |
4 | Covered Days (7) | ST | O | [0..1] | |
5 | Non-Covered Days (8) | ST | O | [0..1] | |
6 | Value Amount & Code | UVC | O | [0..12] | 0153 |
7 | Occurrence Code & Date (32-35) | OCD | O | [0..8] | 0350 |
8 | Occurrence Span Code/Dates (36) | OSP | O | [0..2] | 0351 |
9 | UB92 Locator 2 (State) | ST | O | [0..2] | |
10 | UB92 Locator 11 (State) | ST | O | [0..2] | |
11 | UB92 Locator 31 (National) | ST | O | [0..1] | |
12 | Document Control Number | ST | O | [0..3] | |
13 | UB92 Locator 49 (National) | ST | O | [0..23] | |
14 | UB92 Locator 56 (State) | ST | O | [0..5] | |
15 | UB92 Locator 57 (National) | ST | O | [0..1] | |
16 | UB92 Locator 78 (State) | ST | O | [0..2] | |
17 | Special Visit Count | NM | O | [0..1] |
Value Set Bindings
Location | Value Set ID | Value Set Name | Single Code Value |
---|---|---|---|
UB2-3 | 0043 | Condition code | |
UB2-6 | 0153 | Value code | |
UB2-7 | 0350 | Occurrence code | |
UB2-8 | 0351 | Occurrence span |
Datatypes
CE - coded element
Data Type DefinitionSeq | Element name | Data type | Usage | Value Set |
---|---|---|---|---|
1 | identifier (ST) | ST | C | |
2 | text | ST | C | |
3 | name of coding system | IS | C | 0396 |
4 | alternate identifier (ST) | ST | C | |
5 | alternate text | ST | C | |
6 | name of alternate coding system | IS | C |
Value Set Bindings
Location | Value Set ID | Value Set Name | Single Code Value |
---|---|---|---|
CE-3 | 0396 | Coding System |
CX - extended composite ID with check digit
Data Type DefinitionSeq | Element name | Data type | Usage | Value Set |
---|---|---|---|---|
1 | ID | ST | C | |
2 | check digit (ST) | ST | C | |
3 | code identifying the check digit scheme employed | ID | C | 0061 |
4 | assigning authority | HD | C | |
5 | identifier type code (ID) | ID | C | 0203 |
6 | assigning facility | HD | C | |
7 | effective date (DT) | DT | C | |
8 | expiration date | DT | C |
Value Set Bindings
Location | Value Set ID | Value Set Name | Single Code Value |
---|---|---|---|
CX-3 | 0061 | Check digit scheme | |
CX-5 | 0203 | Identifier type |
CX_HL_PID - extended composite ID with check digit
Data Type DefinitionSeq | Element name | Data type | Usage | Value Set |
---|---|---|---|---|
1 | ID | ST | R | |
2 | check digit (ST) | ST | O | |
3 | code identifying the check digit scheme employed | ID | O | 0061 |
4 | assigning authority | HD_HL_PID | R | |
5 | identifier type code (ID) | ID | R | 0203 |
6 | assigning facility | HD | O | |
7 | effective date (DT) | DT | O | |
8 | expiration date | DT | O |
Value Set Bindings
Location | Value Set ID | Value Set Name | Single Code Value |
---|---|---|---|
CX_HL_PID-3 | 0061 | Check digit scheme | |
CX_HL_PID-5 | 0203 | Identifier type |
DLD - discharge location
Data Type DefinitionSeq | Element name | Data type | Usage | Value Set |
---|---|---|---|---|
1 | discharge location | ID | C | |
2 | effective date | TS | C |
DR_NIST - date/time range
Data Type DefinitionSeq | Element name | Data type | Usage | Value Set |
---|---|---|---|---|
1 | range start date/time | ST | C | |
2 | range end date/time | ST | C |
DT - date
EI - entity identifier
Data Type DefinitionSeq | Element name | Data type | Usage | Value Set |
---|---|---|---|---|
1 | entity identifier | ST | C | |
2 | namespace ID | IS | C | 0363 |
3 | universal ID | ST | C | |
4 | universal ID type | ID | C | 0301 |
Value Set Bindings
Location | Value Set ID | Value Set Name | Single Code Value |
---|---|---|---|
EI-2 | 0363 | Assigning authority | |
EI-4 | 0301 | Universal ID type |
FN - familiy name
Data Type DefinitionSeq | Element name | Data type | Usage | Value Set |
---|---|---|---|---|
1 | surname | ST | C | |
2 | own surname prefix | ST | C | |
3 | own surname | ST | C | |
4 | surname prefix from partner/spouse | ST | C | |
5 | surname from partner/spouse | ST | C |
FN_HL_Surname - familiy name
Data Type DefinitionSeq | Element name | Data type | Usage | Value Set |
---|---|---|---|---|
1 | surname | ST | R | |
2 | own surname prefix | ST | O | |
3 | own surname | ST | O | |
4 | surname prefix from partner/spouse | ST | O | |
5 | surname from partner/spouse | ST | O |
HD - hierarchic designator
Data Type DefinitionSeq | Element name | Data type | Usage | Value Set |
---|---|---|---|---|
1 | namespace ID | IS | C | 0363 |
2 | universal ID | ST | C | |
3 | universal ID type | ID | C | 0301 |
Value Set Bindings
Location | Value Set ID | Value Set Name | Single Code Value |
---|---|---|---|
HD-1 | 0363 | Assigning authority | |
HD-3 | 0301 | Universal ID type |
HD_HL-sendingAppFac - hierarchic designator
Data Type DefinitionSeq | Element name | Data type | Usage | Value Set |
---|---|---|---|---|
1 | namespace ID | IS | R | |
2 | universal ID | ST | R | |
3 | universal ID type | ID | R | 0301_HL |
Value Set Bindings
Location | Value Set ID | Value Set Name | Single Code Value |
---|---|---|---|
HD_HL-sendingAppFac-3 | 0301_HL | Universal ID type |
HD_HL_PID - hierarchic designator
Data Type DefinitionSeq | Element name | Data type | Usage | Value Set |
---|---|---|---|---|
1 | namespace ID | IS | R | |
2 | universal ID | ST | O | |
3 | universal ID type | ID | O | 0301_HL |
Value Set Bindings
Location | Value Set ID | Value Set Name | Single Code Value |
---|---|---|---|
HD_HL_PID-3 | 0301_HL | Universal ID type |
ID - coded value for HL7 defined tables
IS - coded value for user-defined tables
MSG_HL_Admit - Message Type
Data Type DefinitionSeq | Element name | Data type | Usage | Value Set |
---|---|---|---|---|
1 | message type | ID | R | 0076 |
2 | trigger event | ID | R | 0003 |
3 | message structure | ID | R | 0354 |
Conformance Statements
ID | Description |
---|---|
MSG_HL_Admit.1 | MSG.1 SHALL contain the constant value 'ADT' drawn from the code system 'HL70076'. |
MSG_HL_Admit.2 | MSG.2 SHALL contain the constant value 'A01' drawn from the code system 'HL70003'. |
MSG_HL_Admit.3 | MSG.3 SHALL contain the constant value 'ADT_A01' drawn from the code system 'HL70354'. |
Value Set Bindings
Location | Value Set ID | Value Set Name | Single Code Value |
---|---|---|---|
MSG_HL_Admit-1 | ADT | ||
MSG_HL_Admit-2 | A01 | ||
MSG_HL_Admit-3 | ADT_A01 |
MSG_HL_Discharge - Message Type
Data Type DefinitionSeq | Element name | Data type | Usage | Value Set |
---|---|---|---|---|
1 | message type | ID | R | 0076 |
2 | trigger event | ID | R | 0003 |
3 | message structure | ID | R | 0354 |
Conformance Statements
ID | Description |
---|---|
MSG_HL_Discharge.1 | MSG.1 SHALL contain the constant value 'ADT' drawn from the code system 'HL70076'. |
MSG_HL_Discharge.2 | MSG.2 SHALL contain the constant value 'A03' drawn from the code system 'HL70003'. |
MSG_HL_Discharge.3 | MSG.3 SHALL contain the constant value 'ADT_A03' drawn from the code system 'HL70354'. |
Value Set Bindings
Location | Value Set ID | Value Set Name | Single Code Value |
---|---|---|---|
MSG_HL_Discharge-1 | ADT | ||
MSG_HL_Discharge-2 | A03 | ||
MSG_HL_Discharge-3 | ADT_A03 |
PL - person location
Data Type DefinitionSeq | Element name | Data type | Usage | Value Set |
---|---|---|---|---|
1 | point of care | IS | C | 0302 |
2 | room | IS | C | 0303 |
3 | bed | IS | C | 0304 |
4 | facility (HD) | HD | C | |
5 | location status | IS | C | 0306 |
6 | person location type | IS | C | 0305 |
7 | building | IS | C | 0307 |
8 | floor | IS | C | 0308 |
9 | Location description | ST | C |
Value Set Bindings
Location | Value Set ID | Value Set Name | Single Code Value |
---|---|---|---|
PL-1 | 0302 | Point of care | |
PL-2 | 0303 | Room | |
PL-3 | 0304 | Bed | |
PL-5 | 0306 | Location status | |
PL-6 | 0305 | Person location type | |
PL-7 | 0307 | Building | |
PL-8 | 0308 | Floor |
PL_HL - person location
Data Type DefinitionSeq | Element name | Data type | Usage | Value Set |
---|---|---|---|---|
1 | point of care | IS | O | 0302 |
2 | room | IS | O | 0303 |
3 | bed | IS | O | 0304 |
4 | facility (HD) | HD_HL_PID | O | |
5 | location status | IS | O | 0306 |
6 | person location type | IS | O | 0305 |
7 | building | IS | O | 0307 |
8 | floor | IS | O | 0308 |
9 | Location description | ST | O |
Value Set Bindings
Location | Value Set ID | Value Set Name | Single Code Value |
---|---|---|---|
PL_HL-1 | 0302 | Point of care | |
PL_HL-2 | 0303 | Room | |
PL_HL-3 | 0304 | Bed | |
PL_HL-5 | 0306 | Location status | |
PL_HL-6 | 0305 | Person location type | |
PL_HL-7 | 0307 | Building | |
PL_HL-8 | 0308 | Floor |
PT - processing type
Data Type DefinitionSeq | Element name | Data type | Usage | Value Set |
---|---|---|---|---|
1 | processing ID | ID | C | 0103 |
2 | processing mode | ID | C | 0207 |
Value Set Bindings
Location | Value Set ID | Value Set Name | Single Code Value |
---|---|---|---|
PT-1 | 0103 | Processing ID | |
PT-2 | 0207 | Processing mode |
SAD_HL_StreetAddress - street address
Data Type DefinitionSeq | Element name | Data type | Usage | Value Set |
---|---|---|---|---|
1 | street or mailing address | ST | R | |
2 | street name | ST | X | |
3 | dwelling number | ST | X |
SI - sequence ID
ST - string data
TS - time stamp
Data Type DefinitionSeq | Element name | Data type | Usage | Value Set |
---|---|---|---|---|
1 | time of an event | ST | C | |
2 | degree of precision | ST | C |
TS_HL-TimeRequired - time stamp
Data Type DefinitionSeq | Element name | Data type | Usage | Value Set |
---|---|---|---|---|
1 | time of an event | ST | R | |
2 | degree of precision | ST | O |
TS_HL_TimeOptional - time stamp
Data Type DefinitionSeq | Element name | Data type | Usage | Value Set |
---|---|---|---|---|
1 | time of an event | ST | O | |
2 | degree of precision | ST | O |
VID_HL - version identifier
Data Type DefinitionSeq | Element name | Data type | Usage | Value Set |
---|---|---|---|---|
1 | version ID | ID | R | 0104 |
2 | internationalization code | CE | X | 0399 |
3 | international version ID | CE | X |
Value Set Bindings
Location | Value Set ID | Value Set Name | Single Code Value |
---|---|---|---|
VID_HL-1 | 0104 | Version ID | |
VID_HL-2 | 0399 | Country code |
XAD_HL_Patient - extended address
Data Type DefinitionSeq | Element name | Data type | Usage | Value Set |
---|---|---|---|---|
1 | street address (SAD) | SAD_HL_StreetAddress | R | |
2 | other designation | ST | RE | |
3 | city | ST | RE | |
4 | state or province | ST | RE | |
5 | zip or postal code | ST | O | |
6 | country | ID | C | 0399 |
7 | address type | ID | C | 0190 |
8 | other geographic designation | ST | C | |
9 | county/parish code | IS | C | 0289 |
10 | census tract | IS | C | 0288 |
11 | address representation code | ID | C | 0465 |
12 | address validity range | DR_NIST | C |
Value Set Bindings
Location | Value Set ID | Value Set Name | Single Code Value |
---|---|---|---|
XAD_HL_Patient-6 | 0399 | Country code | |
XAD_HL_Patient-7 | 0190 | Address type | |
XAD_HL_Patient-9 | 0289 | County/parish | |
XAD_HL_Patient-10 | 0288 | Census tract | |
XAD_HL_Patient-11 | 0465 | Name/address representation |
XCN - extended composite ID number and name for persons
Data Type DefinitionSeq | Element name | Data type | Usage | Value Set |
---|---|---|---|---|
1 | ID number (ST) | ST | C | |
2 | family name | FN | C | |
3 | given name | ST | C | |
4 | second and further given names or initials thereof | ST | C | |
5 | suffix (e.g., JR or III) | ST | C | |
6 | prefix (e.g., DR) | ST | C | |
7 | degree (e.g., MD) | IS | C | 0360 |
8 | source table | IS | C | 0297 |
9 | assigning authority | HD | C | |
10 | name type code | ID | C | 0200 |
11 | identifier check digit | ST | C | |
12 | code identifying the check digit scheme employed | ID | C | 0061 |
13 | identifier type code (IS) | IS | C | |
14 | assigning facility | HD | C | |
15 | Name Representation code | ID | C | 0465 |
16 | name context | CE | C | 0448 |
17 | name validity range | DR_NIST | C | |
18 | name assembly order | ID | C | 0444 |
Value Set Bindings
Location | Value Set ID | Value Set Name | Single Code Value |
---|---|---|---|
XCN-7 | 0360 | Degree | |
XCN-8 | 0297 | CN ID source | |
XCN-10 | 0200 | Name type | |
XCN-12 | 0061 | Check digit scheme | |
XCN-15 | 0465 | Name/address representation | |
XCN-16 | 0448 | Name context | |
XCN-18 | 0444 | Name assembly order |
XPN - extended person name
Data Type DefinitionSeq | Element name | Data type | Usage | Value Set |
---|---|---|---|---|
1 | family name | FN | C | |
2 | given name | ST | C | |
3 | second and further given names or initials thereof | ST | C | |
4 | suffix (e.g., JR or III) | ST | C | |
5 | prefix (e.g., DR) | ST | C | |
6 | degree (e.g., MD) | IS | C | 0360 |
7 | name type code | ID | C | 0200 |
8 | Name Representation code | ID | C | 0465 |
9 | name context | CE | C | 0448 |
10 | name validity range | DR_NIST | C | |
11 | name assembly order | ID | C | 0444 |
Value Set Bindings
Location | Value Set ID | Value Set Name | Single Code Value |
---|---|---|---|
XPN-6 | 0360 | Degree | |
XPN-7 | 0200 | Name type | |
XPN-8 | 0465 | Name/address representation | |
XPN-9 | 0448 | Name context | |
XPN-11 | 0444 | Name assembly order |
XPN_HL_PatientName - extended person name
Data Type DefinitionSeq | Element name | Data type | Usage | Value Set |
---|---|---|---|---|
1 | family name | FN_HL_Surname | R | |
2 | given name | ST | R | |
3 | second and further given names or initials thereof | ST | O | |
4 | suffix (e.g., JR or III) | ST | O | |
5 | prefix (e.g., DR) | ST | O | |
6 | degree (e.g., MD) | IS | O | 0360 |
7 | name type code | ID | O | 0200 |
8 | Name Representation code | ID | C | 0465 |
9 | name context | CE | C | 0448 |
10 | name validity range | DR_NIST | C | |
11 | name assembly order | ID | C | 0444 |
Value Set Bindings
Location | Value Set ID | Value Set Name | Single Code Value |
---|---|---|---|
XPN_HL_PatientName-6 | 0360 | Degree | |
XPN_HL_PatientName-7 | 0200 | Name type | |
XPN_HL_PatientName-8 | 0465 | Name/address representation | |
XPN_HL_PatientName-9 | 0448 | Name context | |
XPN_HL_PatientName-11 | 0444 | Name assembly order |
Value Sets
0001 - Administrative sex
MetadataType: Internally managed
AttributesStability | Extensibility | Content Definition |
---|---|---|
Not defined | Not defined | Not defined |
Codes
Value | Code System | Description |
---|---|---|
U | HL70001 | Unknown |
A | HL70001 | Ambiguous |
N | HL70001 | Not applicable |
F | HL70001 | Female |
O | HL70001 | Other |
M | HL70001 | Male |
0004 - Patient class
MetadataType: Internally managed
AttributesStability | Extensibility | Content Definition |
---|---|---|
Not defined | Not defined | Not defined |
Codes
Value | Code System | Description |
---|---|---|
P | HL70004 | Preadmit |
C | HL70004 | Commercial Account |
N | HL70004 | Not Applicable |
R | HL70004 | Recurring patient |
E | HL70004 | Emergency |
O | HL70004 | Outpatient |
B | HL70004 | Obstetrics |
U | HL70004 | Unknown |
I | HL70004 | Inpatient |
0052 - Diagnosis type
MetadataType: Internally managed
AttributesStability | Extensibility | Content Definition |
---|---|---|
Not defined | Not defined | Not defined |
Codes
Value | Code System | Description |
---|---|---|
F | HL70052 | Final |
W | HL70052 | Working |
A | HL70052 | Admitting |
0053 - Diagnosis coding method
MetadataType: Internally managed
AttributesStability | Extensibility | Content Definition |
---|---|---|
Not defined | Not defined | Not defined |
0061 - Check digit scheme
MetadataType: Internally managed
AttributesStability | Extensibility | Content Definition |
---|---|---|
Not defined | Not defined | Not defined |
Codes
Value | Code System | Description |
---|---|---|
ISO | HL70061 | ISO 7064: 1983 |
NPI | HL70061 | Check digit algorithm in the US National Provider Identifier |
M10 | HL70061 | Mod 10 algorithm |
M11 | HL70061 | Mod 11 algorithm |
0072 - Insurance plan ID
MetadataType: Internally managed
AttributesStability | Extensibility | Content Definition |
---|---|---|
Not defined | Not defined | Not defined |
0076 - Message type
MetadataType: Internally managed
AttributesStability | Extensibility | Content Definition |
---|---|---|
Not defined | Not defined | Not defined |
Codes
Value | Code System | Description |
---|---|---|
MFQ | HL70076 | Master files query |
TBR | HL70076 | Tabular data response |
OMN | HL70076 | Non-stock requisition order message |
VXX | HL70076 | Response for vaccination query with multiple PID matches |
ORN | HL70076 | Non-stock requisition - General order acknowledgment message |
PEX | HL70076 | Product experience message |
PPV | HL70076 | Patient goal response |
QSX | HL70076 | Cancel subscription/acknowledge message |
RDS | HL70076 | Pharmacy/treatment dispense message |
ADT | HL70076 | ADT message |
RPI | HL70076 | Return patient information |
EAN | HL70076 | Automated equipment notification message |
RRA | HL70076 | Pharmacy/treatment administration acknowledgement message |
INU | HL70076 | Automated equipment inventory update message |
SPQ | HL70076 | Stored procedure request |
SRM | HL70076 | Schedule request message |
NMQ | HL70076 | Application management query message |
UDM | HL70076 | Unsolicited display update message |
ORD | HL70076 | Dietary order - General order acknowledgment message |
ORS | HL70076 | Stock requisition - General order acknowledgment message |
PMU | HL70076 | Add personnel record |
QBP | HL70076 | Query by parameter |
RAS | HL70076 | Pharmacy/treatment administration message |
RER | HL70076 | Pharmacy/treatment encoded order information |
CSU | HL70076 | Unsolicited study data message |
RQA | HL70076 | Request patient authorization |
EQQ | HL70076 | Embedded query language query |
RRG | HL70076 | Pharmacy/treatment give acknowledgment message |
MCF | HL70076 | Delayed Acknowledgement (Retained for backward compatibility only) |
SSU | HL70076 | Specimen status update message |
OMG | HL70076 | General clinical order message |
VXR | HL70076 | Vaccination record response |
ORL | HL70076 | Laboratory acknowledgement message (unsolicited) |
OSR | HL70076 | Query response for order status |
PPR | HL70076 | Patient problem message |
QRY | HL70076 | Query, original mode |
RDE | HL70076 | Pharmacy/treatment encoded order message |
ACK | HL70076 | General acknowledgment message |
ROR | HL70076 | Pharmacy/treatment order response |
DSR | HL70076 | Display response |
RQP | HL70076 | Request patient demographics |
ESU | HL70076 | Automated equipment status update message |
RTB | HL70076 | Tabular response |
MFK | HL70076 | Master files application acknowledgment |
MFR | HL70076 | Master files response |
TCR | HL70076 | Automated equipment test code settings request message |
OMP | HL70076 | Pharmacy/treatment order message |
ORP | HL70076 | Pharmacy/treatment order acknowledgement message |
PGL | HL70076 | Patient goal message |
PRR | HL70076 | Patient problem response |
QVR | HL70076 | Query for previous events |
RDY | HL70076 | Display based response |
BAR | HL70076 | Add/change billing account |
RPL | HL70076 | Return patient display list |
EAR | HL70076 | Automated equipment response message |
RRD | HL70076 | Pharmacy/treatment dispense acknowledgment message |
LSR | HL70076 | Automated equipment log/service request message |
SQM | HL70076 | Schedule query message |
SRR | HL70076 | Scheduled request response |
NMR | HL70076 | Application management response message |
VQQ | HL70076 | Virtual table query |
ORF | HL70076 | Query for results of observation |
ORU | HL70076 | Unsolicited transmission of an observation message |
PPG | HL70076 | Patient pathway message (goal-oriented) |
QCK | HL70076 | Deferred query |
RCI | HL70076 | Return clinical information |
RGR | HL70076 | Pharmacy/treatment dose information |
DFT | HL70076 | Detail financial transactions |
RQC | HL70076 | Request clinical information |
ERP | HL70076 | Event replay response |
RRI | HL70076 | Return referral information |
MDM | HL70076 | Medical document management |
MFN | HL70076 | Master files notification |
SUR | HL70076 | Summary product experience report |
OML | HL70076 | Laboratory order message |
VXU | HL70076 | Unsolicited vaccination record update |
ORM | HL70076 | Pharmacy/treatment order message |
OUL | HL70076 | Unsolicited laboratory observation message |
PPT | HL70076 | Patient pathway goal-oriented response |
QSB | HL70076 | Create subscription |
RDR | HL70076 | Pharmacy/treatment dispense information |
ADR | HL70076 | ADT response |
RPA | HL70076 | Return patient authorization |
EAC | HL70076 | Automated equipment command message |
RQQ | HL70076 | Event replay query |
INR | HL70076 | Automated equipment inventory request message |
SIU | HL70076 | Schedule information unsolicited |
NMD | HL70076 | Application management data message |
TCU | HL70076 | Automated equipment test code settings update message |
OMS | HL70076 | Stock requisition order message |
ORR | HL70076 | General order response message response to any ORM |
PIN | HL70076 | Patient insurance information |
PTR | HL70076 | Patient pathway problem-oriented response |
RAR | HL70076 | Pharmacy/treatment administration information |
REF | HL70076 | Patient referral |
CRM | HL70076 | Clinical study registration message |
RPR | HL70076 | Return patient list |
EDR | HL70076 | Enhanced display response |
RRE | HL70076 | Pharmacy/treatment encoded order acknowledgment message |
LSU | HL70076 | Automated equipment log/service update message |
SQR | HL70076 | Schedule query response |
SSR | HL70076 | Specimen status request message |
OMD | HL70076 | Dietary order |
VXQ | HL70076 | Query for vaccination record |
ORG | HL70076 | General clinical order acknowledgement message |
OSQ | HL70076 | Query response for order status |
PPP | HL70076 | Patient pathway message (problem-oriented) |
QCN | HL70076 | Cancel query |
RCL | HL70076 | Return clinical list |
RGV | HL70076 | Pharmacy/treatment give message |
DOC | HL70076 | Document response |
RQI | HL70076 | Request patient information |
ESR | HL70076 | Automated equipment status update acknowledgement message |
RSP | HL70076 | Segment pattern response |
MFD | HL70076 | Master files delayed application acknowledgment |
0085 - Observation result status codes interpretation
MetadataType: Internally managed
AttributesStability | Extensibility | Content Definition |
---|---|---|
Not defined | Not defined | Not defined |
Codes
Value | Code System | Description |
---|---|---|
D | HL70085 | Deletes the OBX record |
U | HL70085 | Results status change to final without retransmitting results already sent as 'preliminary.' E.g., radiology changes status from preliminary to final |
N | HL70085 | Not asked; used to affirmatively document that the observation identified in the OBX was not sought when the universal service ID in OBR-4 implies that it would be sought. |
R | HL70085 | Results entered -- not verified |
F | HL70085 | Final results; Can only be changed with a corrected result. |
W | HL70085 | Post original as wrong, e.g., transmitted for wrong patient |
O | HL70085 | Order detail description only (no result) |
C | HL70085 | Record coming over is a correction and thus replaces a final result |
S | HL70085 | Partial results |
I | HL70085 | Specimen in lab; results pending |
X | HL70085 | Results cannot be obtained for this observation |
P | HL70085 | Preliminary results |
0088 - Procedure Code
MetadataType: Internally managed
AttributesStability | Extensibility | Content Definition |
---|---|---|
Not defined | Not defined | Not defined |
0089 - Procedure coding method
MetadataType: Internally managed
AttributesStability | Extensibility | Content Definition |
---|---|---|
Not defined | Not defined | Not defined |
0103 - Processing ID
MetadataType: Internally managed
AttributesStability | Extensibility | Content Definition |
---|---|---|
Not defined | Not defined | Not defined |
Codes
Value | Code System | Description |
---|---|---|
D | HL70103 | Debugging |
P | HL70103 | Production |
T | HL70103 | Training |
0104 - Version ID
MetadataType: Internally managed
AttributesStability | Extensibility | Content Definition |
---|---|---|
Not defined | Not defined | Not defined |
Codes
Value | Code System | Description |
---|---|---|
2.3.1 | HL70104 | Release 2.3.1 |
2.0D | HL70104 | Demo 2.0 |
2.0 | HL70104 | Release 2.0 |
2.1 | HL70104 | Release 2. 1 |
2.2 | HL70104 | Release 2.2 |
2.3 | HL70104 | Release 2.3 |
2.4 | HL70104 | Release 2.4 |
0112 - Discharge disposition
MetadataType: Internally managed
AttributesStability | Extensibility | Content Definition |
---|---|---|
Not defined | Not defined | Not defined |
Codes
Value | Code System | Description |
---|---|---|
31 ... 39 | HL70112 | Still patient to be defined at state level, if necessary (i.e. still a patient) |
21 ... 29 | HL70112 | Expired to be defined at state level, if necessary |
10 ...19 | HL70112 | Discharge to be defined at state level, if necessary |
01 | HL70112 | Discharged to home or self care (routine discharge) |
02 | HL70112 | Discharged/transferred to another short term general hospital for inpatient care |
03 | HL70112 | Discharged/transferred to skilled nursing facility (SNF) |
04 | HL70112 | Discharged/transferred to an intermediate care facility (ICF) |
05 | HL70112 | Discharged/transferred to another type of institution for inpatient care or referred for outpatient services to another institution |
06 | HL70112 | Discharged/transferred to home under care of organized home health service organization |
07 | HL70112 | Left against medical advice or discontinued care |
08 | HL70112 | Discharged/transferred to home under care of Home IV provider |
09 | HL70112 | Admitted as an inpatient to this hospital |
20 | HL70112 | Expired (i.e. dead) |
30 | HL70112 | Still patient or expected to return for outpatient services (i.e. still a patient) |
40 | HL70112 | Expired (i.e. died) at home |
41 | HL70112 | Expired (i.e. died) in a medical facility; e.g., hospital, SNF, ICF, or free standing hospice |
42 | HL70112 | Expired (i.e. died) - place unknown |
0113 - Discharged to location
MetadataType: Internally managed
AttributesStability | Extensibility | Content Definition |
---|---|---|
Not defined | Not defined | Not defined |
0125 - Value type
MetadataType: Internally managed
AttributesStability | Extensibility | Content Definition |
---|---|---|
Not defined | Not defined | Not defined |
Codes
Value | Code System | Description |
---|---|---|
CP | HL70125 | Composite Price |
RP | HL70125 | Reference Pointer |
XCN | HL70125 | Extended Composite Name And Number For Persons |
AD | HL70125 | Address |
ED | HL70125 | Encapsulated Data |
TM | HL70125 | Time |
XTN | HL70125 | Extended Telecommunications Number |
CK | HL70125 | Composite ID With Check Digit |
NM | HL70125 | Numeric |
TX | HL70125 | Text Data (Display) |
CX | HL70125 | Extended Composite ID With Check Digit |
SN | HL70125 | Structured Numeric |
XON | HL70125 | Extended Composite Name And Number For Organizations |
CE | HL70125 | Coded Entry |
FT | HL70125 | Formatted Text (Display) |
TN | HL70125 | Telephone Number |
CN | HL70125 | Composite ID And Name |
PN | HL70125 | Person Name |
XAD | HL70125 | Extended Address |
DT | HL70125 | Date |
ST | HL70125 | String Data. |
XPN | HL70125 | Extended Person Name |
CF | HL70125 | Coded Element With Formatted Values |
MO | HL70125 | Money |
TS | HL70125 | Time Stamp (Date & Time) |
0190 - Address type
MetadataType: Internally managed
AttributesStability | Extensibility | Content Definition |
---|---|---|
Not defined | Not defined | Not defined |
Codes
Value | Code System | Description |
---|---|---|
M | HL70190 | Mailing |
B | HL70190 | Firm/Business |
BR | HL70190 | Residence at birth (home address at time of birth) |
P | HL70190 | Permanent |
H | HL70190 | Home |
N | HL70190 | Birth (nee) (birth address, not otherwise specified) |
BA | HL70190 | Bad address |
C | HL70190 | Current Or Temporary |
RH | HL70190 | Registry home. Refers to the information system, typically managed by a public health agency, that stores patient information such as immunization histories or cancer data, regardless of where the patient obtains services. |
L | HL70190 | Legal Address |
O | HL70190 | Office |
BDL | HL70190 | Birth delivery location (address where birth occurred) |
F | HL70190 | Country Of Origin |
0200 - Name type
MetadataType: Internally managed
AttributesStability | Extensibility | Content Definition |
---|---|---|
Not defined | Not defined | Not defined |
Codes
Value | Code System | Description |
---|---|---|
L | HL70200 | Legal Name |
A | HL70200 | Alias Name |
P | HL70200 | Name of Partner/Spouse (retained for backward compatibility only) |
D | HL70200 | Display Name |
T | HL70200 | Indigenous/Tribal/Community Name |
M | HL70200 | Maiden Name |
B | HL70200 | Name at Birth |
R | HL70200 | Registered Name (animals only) |
I | HL70200 | Licensing Name |
U | HL70200 | Unspecified |
N | HL70200 | Nickname /"Call me" Name/Street Name |
C | HL70200 | Adopted Name |
S | HL70200 | Coded Pseudo-Name to ensure anonymity |
0203 - Identifier type
MetadataType: Internally managed
AttributesStability | Extensibility | Content Definition |
---|---|---|
Not defined | Not defined | Not defined |
Codes
Value | Code System | Description |
---|---|---|
LN | HL70203 | License number |
NH | HL70203 | National Health Plan Identifier |
PT | HL70203 | Patient external identifier |
VN | HL70203 | Visit number |
AN | HL70203 | Account number |
DS | HL70203 | Discover Card |
MC | HL70203 | Medicare number |
NPI | HL70203 | National provider identifier |
SL | HL70203 | State license |
WCN | HL70203 | Workers' Comp Number |
BRN | HL70203 | Breed Registry Number |
FI | HL70203 | Facility ID |
HC | HL70203 | Health Card Number |
MS | HL70203 | MasterCard |
PN | HL70203 | Person number |
U | HL70203 | Unspecified |
DN | HL70203 | Doctor number |
LR | HL70203 | Local Registry ID |
NI | HL70203 | National unique individual identifier |
RR | HL70203 | Railroad Retirement number |
VS | HL70203 | VISA |
BA | HL70203 | Bank Account Number |
EI | HL70203 | Employee number |
MCN | HL70203 | Microchip Number |
PEN | HL70203 | Pension Number |
SR | HL70203 | State registry ID |
XX | HL70203 | Organization identifier |
DI | HL70203 | Diner's Club card |
GI | HL70203 | Guarantor internal identifier |
JHN | HL70203 | Jurisdictional health number (Canada) |
NE | HL70203 | National employer identifier |
PRN | HL70203 | Provider number |
UPIN | HL70203 | Medicare/HCFA's Universal Physician Identification numbers |
AM | HL70203 | American Express |
DR | HL70203 | Donor Registration Number |
MA | HL70203 | Medicaid number |
NNxxx | HL70203 | National Person Identifier where the xxx is the ISO table 3166 3-character (alphabetic) country code |
RRI | HL70203 | Regional registry ID |
WC | HL70203 | WIC identifier |
BR | HL70203 | Birth registry number |
EN | HL70203 | Employer number |
MR | HL70203 | Medical record number |
PI | HL70203 | Patient internal identifier |
SS | HL70203 | Social Security number |
DL | HL70203 | Driver's license number |
GN | HL70203 | Guarantor external identifier |
0207 - Processing mode
MetadataType: Internally managed
AttributesStability | Extensibility | Content Definition |
---|---|---|
Not defined | Not defined | Not defined |
Codes
Value | Code System | Description |
---|---|---|
A | HL70207 | Archive |
R | HL70207 | Restore from archive |
I | HL70207 | Initial load |
T | HL70207 | Current processing, transmitted at intervals (scheduled or on demand) |
Not present | HL70207 | Not present (the default, meaning current processing) |
0287 - Problem/goal action code
MetadataType: Internally managed
AttributesStability | Extensibility | Content Definition |
---|---|---|
Not defined | Not defined | Not defined |
Codes
Value | Code System | Description |
---|---|---|
UN | HL70287 | UNLINK |
AD | HL70287 | ADD |
LI | HL70287 | LINK |
UP | HL70287 | UPDATE |
CO | HL70287 | CORRECT |
UC | HL70287 | UNCHANGED |
DE | HL70287 | DELETE |
0288 - Census tract
MetadataType: Internally managed
AttributesStability | Extensibility | Content Definition |
---|---|---|
Not defined | Not defined | Not defined |
0289 - County/parish
MetadataType: Internally managed
AttributesStability | Extensibility | Content Definition |
---|---|---|
Not defined | Not defined | Not defined |
0297 - CN ID source
MetadataType: Internally managed
AttributesStability | Extensibility | Content Definition |
---|---|---|
Not defined | Not defined | Not defined |
0301 - Universal ID type
MetadataType: Internally managed
AttributesStability | Extensibility | Content Definition |
---|---|---|
Not defined | Not defined | Not defined |
Codes
Value | Code System | Description |
---|---|---|
DNS | HL70301 | An Internet dotted name. Either in ASCII or as integers |
N | HL70301 | |
HL7 | HL70301 | Reserved for future HL7 registration schemes |
x400 | HL70301 | An X.400 MHS format identifier |
L,M,N | HL70301 | These are reserved for locally defined coding schemes. |
GUID | HL70301 | Same as UUID. |
Random | HL70301 | 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 con |
ISO | HL70301 | An International Standards Organization Object Identifier |
x500 | HL70301 | An X.500 directory name |
M | HL70301 | |
HCD | HL70301 | The CEN Healthcare Coding Scheme Designator. (Identifiers used in DICOM follow this assignment scheme.) |
UUID | HL70301 | The DCE Universal Unique Identifier |
L | HL70301 |
0301_HL - Universal ID type
MetadataType: Internally managed
AttributesStability | Extensibility | Content Definition |
---|---|---|
Not defined | Not defined | Not defined |
Codes
Value | Code System | Description |
---|---|---|
DOH | HL70301 | Departement of Health |
DNS | HL70301 | An Internet dotted name. Either in ASCII or as integers |
N | HL70301 | |
HL7 | HL70301 | Reserved for future HL7 registration schemes |
x400 | HL70301 | An X.400 MHS format identifier |
L,M,N | HL70301 | These are reserved for locally defined coding schemes. |
GUID | HL70301 | Same as UUID. |
Random | HL70301 | 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 con |
ISO | HL70301 | An International Standards Organization Object Identifier |
x500 | HL70301 | An X.500 directory name |
M | HL70301 | |
HCD | HL70301 | The CEN Healthcare Coding Scheme Designator. (Identifiers used in DICOM follow this assignment scheme.) |
UUID | HL70301 | The DCE Universal Unique Identifier |
L | HL70301 |
0302 - Point of care
MetadataType: Internally managed
AttributesStability | Extensibility | Content Definition |
---|---|---|
Not defined | Not defined | Not defined |
0303 - Room
MetadataType: Internally managed
AttributesStability | Extensibility | Content Definition |
---|---|---|
Not defined | Not defined | Not defined |
0304 - Bed
MetadataType: Internally managed
AttributesStability | Extensibility | Content Definition |
---|---|---|
Not defined | Not defined | Not defined |
0305 - Person location type
MetadataType: Internally managed
AttributesStability | Extensibility | Content Definition |
---|---|---|
Not defined | Not defined | Not defined |
Codes
Value | Code System | Description |
---|---|---|
N | HL70305 | Nursing Unit |
S | HL70305 | SNF |
D | HL70305 | Department |
O | HL70305 | Provider's Office |
H | HL70305 | Home |
P | HL70305 | Phone |
C | HL70305 | Clinic |
0306 - Location status
MetadataType: Internally managed
AttributesStability | Extensibility | Content Definition |
---|---|---|
Not defined | Not defined | Not defined |
0307 - Building
MetadataType: Internally managed
AttributesStability | Extensibility | Content Definition |
---|---|---|
Not defined | Not defined | Not defined |
0308 - Floor
MetadataType: Internally managed
AttributesStability | Extensibility | Content Definition |
---|---|---|
Not defined | Not defined | Not defined |
0360 - Degree
MetadataType: Internally managed
AttributesStability | Extensibility | Content Definition |
---|---|---|
Not defined | Not defined | Not defined |
Codes
Value | Code System | Description |
---|---|---|
AA | HL70360 | Associate of Arts |
BFA | HL70360 | Bachelor of Fine Arts |
DIP | HL70360 | Diploma |
MDI | HL70360 | Master of Divinity |
MT | HL70360 | Master of Theology |
AE | HL70360 | Associate of Engineering |
BSL | HL70360 | Bachelor of Science - Law |
JD | HL70360 | Juris Doctor |
MEE | HL70360 | Master of Electrical Engineering |
PHD | HL70360 | Doctor of Philosophy |
BBA | HL70360 | Bachelor of Business Administration |
DBA | HL70360 | Doctor of Business Administration |
MCE | HL70360 | Master of Civil Engineering |
MS | HL70360 | Master of Science |
SEC | HL70360 | Secretarial Certificate |
AAS | HL70360 | Associate of Applied Science |
BN | HL70360 | Bachelor of Nursing |
DO | HL70360 | Doctor of Osteopathy |
ME | HL70360 | Master of Engineering |
NG | HL70360 | Non-Graduate |
AS | HL70360 | Associate of Science |
BT | HL70360 | Bachelor of Theology |
MA | HL70360 | Master of Arts |
MFA | HL70360 | Master of Fine Arts |
PHE | HL70360 | Doctor of Engineering |
BE | HL70360 | Bachelor or Engineering |
DED | HL70360 | Doctor of Education |
MD | HL70360 | Doctor of Medicine |
MSL | HL70360 | Master of Science - Law |
TS | HL70360 | Trade School Graduate |
ABA | HL70360 | Associate of Business Administration |
BS | HL70360 | Bachelor of Science |
HS | HL70360 | High School Graduate |
MED | HL70360 | Master of Education |
PharmD | HL70360 | Doctor of Pharmacy |
BA | HL70360 | Bachelor of Arts |
CER | HL70360 | Certificate |
MBA | HL70360 | Master of Business Administration |
MME | HL70360 | Master of Mechanical Engineering |
PHS | HL70360 | Doctor of Science |
0362 - Sending/receiving facility
MetadataType: Internally managed
AttributesStability | Extensibility | Content Definition |
---|---|---|
Not defined | Not defined | Not defined |
0363 - Assigning authority
MetadataType: Internally managed
AttributesStability | Extensibility | Content Definition |
---|---|---|
Not defined | Not defined | Not defined |
Codes
Value | Code System | Description |
---|---|---|
AUSDVA | HL70363 | Australia - Dept. of Veterans Affairs |
CANNT | HL70363 | Canada - Northwest Territories |
USCDC | HL70363 | US Center for Disease Control |
CANBC | HL70363 | Canada - British Columbia |
CANPE | HL70363 | Canada - Prince Edward Island |
CANNF | HL70363 | Canada - Newfoundland |
CANYT | HL70363 | Canada - Yukon Territories |
AUSHIC | HL70363 | Australia - Health Insurance Commission |
CANNU | HL70363 | Canada - Nanavut |
USHCFA | HL70363 | US Healthcare Finance Authority |
CANMB | HL70363 | Canada - Manitoba |
CANQC | HL70363 | Canada - Quebec |
CANNS | HL70363 | Canada - Nova Scotia |
NLVWS | HL70363 | NL - Ministerie van Volksgezondheid, Welzijn en Sport |
CANAB | HL70363 | Canada - Alberta |
CANON | HL70363 | Canada - Ontario |
USSSA | HL70363 | US Social Security Administration |
CANNB | HL70363 | Canada - New Brunswick |
CANSK | HL70363 | Canada - Saskatchewan |
0396 - Coding System
MetadataType: Internally managed
AttributesStability | Extensibility | Content Definition |
---|---|---|
Not defined | Not defined | Not defined |
Codes
Value | Code System | Description |
---|---|---|
CVX | HL70396 | CDC Vaccine Codes |
ENZC | HL70396 | Enzyme Codes |
HL7nnnn | HL70396 | HL7 Defined Codes where nnnn is the HL7 table number |
ICDO | HL70396 | International Classification of Diseases for Oncology |
LN | HL70396 | Logical Observation Identifier Names and Codes (LOINC(r)) |
MVX | HL70396 | CDC Vaccine Manufacturer Codes |
SNT | HL70396 | SNOMED topology codes (anatomic sites) |
ACR | HL70396 | American College of Radiology finding codes |
W4 | HL70396 | WHO record # code with ASTM extension |
CD2 | HL70396 | CDT-2 Codes |
CDS | HL70396 | CDC Surveillance |
DQL | HL70396 | DICOM Query Label |
FDK | HL70396 | FDA K10 |
I10P | HL70396 | ICD-10 Procedure Codes |
ISOnnnn | HL70396 | ISO Defined Codes where nnnn is the ISO table number |
MDDX | HL70396 | Medispan Diagnostic Codes |
NIC | HL70396 | Nursing Interventions Classification |
POS | HL70396 | POS Codes |
UML | HL70396 | Unified Medical Language |
AS4E | HL70396 | AS4 Neurophysiology Codes |
CPTM | HL70396 | CPT Modifier Code |
E6 | HL70396 | Euclides Lab method codes |
HHC | HL70396 | Home Health Care |
IBT | HL70396 | ISBT |
JC8 | HL70396 | Japanese Chemistry |
MEDX | HL70396 | Medical Economics Diagnostic Codes |
SNM | HL70396 | Systemized Nomenclature of Medicine (SNOMED) |
W1 | HL70396 | WHO record # drug codes (6 digit) |
C5 | HL70396 | CPT-5 |
CDCA | HL70396 | CDC Analyte Codes |
DCL | HL70396 | DICOM Class Label |
FDDC | HL70396 | First DataBank Drug Codes |
HPC | HL70396 | HCFA Procedure Codes (HCPCS) |
ICS | HL70396 | ICCS |
MCD | HL70396 | Medicaid |
NDA | HL70396 | NANDA |
UC | HL70396 | UCDS |
ART | HL70396 | WHO Adverse Reaction Terms |
WC | HL70396 | WHO ATC |
CE | HL70396 | CEN ECG diagnostic codes |
E | HL70396 | EUCLIDES |
HB | HL70396 | HIBCC |
I9 | HL70396 | ICD9 |
IUPC | HL70396 | IUPAC/IFCC Component Codes |
MEDC | HL70396 | Medical Economics Drug Codes |
NPI | HL70396 | National Provider Identifier |
RC | HL70396 | Read Classification |
UPC | HL70396 | Universal Product Code |
ATC | HL70396 | American Type Culture Collection |
CST | HL70396 | COSTART |
E7 | HL70396 | Euclides Lab equipment codes |
HI | HL70396 | Health Outcomes |
IC2 | HL70396 | ICHPPC-2 |
LB | HL70396 | Local billing code |
MGPI | HL70396 | Medispan GPI |
SNM3 | HL70396 | SNOMED International |
99zzz or L | HL70396 | Local general code (where z is an alphanumeric character) |
W2 | HL70396 | WHO record # drug codes (8 digit) |
CAS | HL70396 | Chemical abstract codes |
CDCM | HL70396 | CDC Methods/Instruments Codes |
DCM | HL70396 | DICOM modality codes |
FDDX | HL70396 | First DataBank Diagnostic Codes |
I10 | HL70396 | ICD-10 |
ICSD | HL70396 | International Classification of Sleep Disorders |
MCR | HL70396 | Medicare |
NDC | HL70396 | National drug codes |
UMD | HL70396 | MDNS |
AS4 | HL70396 | ASTM E1238/ E1467 Universal |
CLP | HL70396 | CLIP |
E5 | HL70396 | Euclides quantity codes |
HCPCS | HL70396 | HCFA Common Procedure Coding System |
I9C | HL70396 | ICD-9CM |
IUPP | HL70396 | IUPAC/IFCC Property Codes |
MEDR | HL70396 | Medical Dictionary for Drug Regulatory Affairs (MEDDRA) |
OHA | HL70396 | Omaha System |
SDM | HL70396 | SNOMED- DICOM Microglossary |
UPIN | HL70396 | UPIN |
C4 | HL70396 | CPT-4 |
0399 - Country code
MetadataType: Internally managed
AttributesStability | Extensibility | Content Definition |
---|---|---|
Not defined | Not defined | Not defined |
Codes
Value | Code System | Description |
---|---|---|
VEN | HL70399 | VENEZUELA |
GIB | HL70399 | GIBRALTAR |
NFK | HL70399 | NORFOLK ISLAND |
ANT | HL70399 | NETHERLANDS ANTILLES |
YUG | HL70399 | YUGOSLAVIA |
GRL | HL70399 | GREENLAND |
NZL | HL70399 | NEW ZEALAND |
AUT | HL70399 | AUSTRIA |
HRV | HL70399 | CROATIA |
PNG | HL70399 | PAPUA NEW GUINEA |
BHR | HL70399 | BAHRAIN |
IRQ | HL70399 | IRAQ |
REU | HL70399 | REUNION |
BRB | HL70399 | BARBADOS |
KEN | HL70399 | KENYA |
SGS | HL70399 | SOUTH GEORGIA AND THE SOUTH SANDWICH ISLANDS |
CHE | HL70399 | SWITZERLAND |
LBN | HL70399 | LEBANNON |
SPM | HL70399 | SAINT PIERRE AND MIQUELON |
COL | HL70399 | COLOMBIA |
SYR | HL70399 | SYRIAN ARAB REPUBLIC |
CZE | HL70399 | CZECH REPUBLIC |
MAR | HL70399 | MOROCCO |
TMP | HL70399 | EAST TIMOR |
EGY | HL70399 | EGYPT |
MLI | HL70399 | MALI |
UGA | HL70399 | UGANDA |
FLK | HL70399 | FALKLAND ISLANDS (MALVINAS) |
MTQ | HL70399 | MARTINIQUE |
MYS | HL70399 | MALAYSIA |
AFT | HL70399 | FRENCH SOUTHERN TERRITORIES |
VNM | HL70399 | VIET NAM |
GMB | HL70399 | GAMBIA |
NIU | HL70399 | NIUE |
ARM | HL70399 | ARMENIA |
ZWE | HL70399 | ZIMBABWE |
GUM | HL70399 | GUAM |
PAN | HL70399 | PANAMA |
BEL | HL70399 | BELGIUM |
IDN | HL70399 | INDONESIA |
PRK | HL70399 | KOREA, DEMOCRATIC PEOPLE'S REPUBLIC OF |
BLR | HL70399 | BELARUS |
ITA | HL70399 | ITALY |
RWA | HL70399 | RWANDA |
BVT | HL70399 | BOUVET ISLAND |
KIR | HL70399 | KIRIBATI |
SLB | HL70399 | SOLOMON ISLANDS |
CIV | HL70399 | COTE D'VOIRE |
LCA | HL70399 | SAINT LUCIA |
SVK | HL70399 | SLOVAKIA |
CRI | HL70399 | COSTA RICA |
LSO | HL70399 | LESOTHO |
TGO | HL70399 | TOGO |
DMA | HL70399 | DOMINICA |
MDG | HL70399 | MADAGASCAR |
TUN | HL70399 | TUNISIA |
ESP | HL70399 | SPAIN |
MNG | HL70399 | MONGOLIA |
URY | HL70399 | URUGUAY |
FSM | HL70399 | MICRONESIA, FEDERATED STATES OF |
GEO | HL70399 | GEORGIA |
NCL | HL70399 | NEW CALEDONIA |
ALB | HL70399 | ALBANIA |
WSM | HL70399 | SAMOA |
GRC | HL70399 | GREECE |
NPL | HL70399 | NEPAL |
ATG | HL70399 | ANTIGUA AND BARBUDA |
HMD | HL70399 | HEARD ISLAND AND MCDONALD ISLANDS |
PHL | HL70399 | PHILIPPINES |
BGD | HL70399 | BANGLADESH |
IRL | HL70399 | IRELAND |
PYF | HL70399 | FRENCH POLYNESIA |
BOL | HL70399 | BOLIVIA |
JPN | HL70399 | JAPAN |
SEN | HL70399 | SENEGAL |
CAN | HL70399 | CANADA |
KWT | HL70399 | KUWAIT |
SMR | HL70399 | SAN MARINO |
COG | HL70399 | CONGO |
SWZ | HL70399 | SWAZILAND |
CYM | HL70399 | CAYMAN ISLANDS |
LVA | HL70399 | LATIVA |
TKL | HL70399 | TOKELAU |
DZA | HL70399 | ALGERIA |
MHL | HL70399 | MARSHALL ISLANDS |
TWN | HL70399 | TAIWAN, PROVINCE OF CHINA |
FIN | HL70399 | FINLAND |
MRT | HL70399 | MAURITANIA |
VAT | HL70399 | HOLY SEE (VATICAN CITY STATE) |
ABW | HL70399 | ARUBA |
VGB | HL70399 | VIRGIN ISLANDS, BRITISH |
GIN | HL70399 | GUINEA |
NGA | HL70399 | NIGERIA |
ARE | HL70399 | UNITED ARAB EMIRATES |
ZAF | HL70399 | SOUTH AFRICA |
GTM | HL70399 | GUATEMALA |
OMN | HL70399 | OMAN |
AZE | HL70399 | AZERBAIJAN |
HTI | HL70399 | HAITI |
POL | HL70399 | POLAND |
BHS | HL70399 | BAHAMAS |
ISL | HL70399 | ICELAND |
ROM | HL70399 | ROMANIA |
BRN | HL70399 | BRUNEI DARUSSALAM |
KGZ | HL70399 | KYRGYZSTAN |
SHN | HL70399 | SAINT HELENA |
CHL | HL70399 | CHILE |
LBR | HL70399 | LIBERIA |
STP | HL70399 | SAO TOME AND PRINCIPE |
COM | HL70399 | COMOROS |
TCA | HL70399 | TURKS AND CAICOS ISLANDS |
DEU | HL70399 | GERMANY |
MCO | HL70399 | MONACO |
TON | HL70399 | TONGA |
ERI | HL70399 | ERITREA |
MLT | HL70399 | MALTA |
UKR | HL70399 | UKRAINE |
FRA | HL70399 | FRANCE |
MUS | HL70399 | MAURITUS |
GAB | HL70399 | GABON |
MYT | HL70399 | MAYOTTE |
AGO | HL70399 | ANGOLA |
VUT | HL70399 | VANUATU |
GNB | HL70399 | GUINEA-BISSAU |
NLD | HL70399 | NETHERLANDS |
ASM | HL70399 | AMERICAN SAMOA |
GUY | HL70399 | GUYANA |
PCN | HL70399 | PITCAIRN |
BEN | HL70399 | BENIN |
IND | HL70399 | INDIA |
PRT | HL70399 | PORTUGAL |
BLZ | HL70399 | BELIZE |
JAM | HL70399 | JAMAICA |
SAU | HL70399 | SAUDI ARABIA |
BWA | HL70399 | BOTSWANA |
KNA | HL70399 | SAINT KITTS AND NEVIS |
SLE | HL70399 | SIERRA LEONE |
CMR | HL70399 | CAMEROON |
LIE | HL70399 | LIECHTENSTEIN |
SVN | HL70399 | SLOVENIA |
CUB | HL70399 | CUBA |
LTU | HL70399 | LITHUANIA |
THA | HL70399 | THAILAND |
DNK | HL70399 | DENMARK |
MDV | HL70399 | MALDIVES |
TUR | HL70399 | TURKEY |
EST | HL70399 | ESTONIA |
MNP | HL70399 | NORTHERN MARIANA ISLANDS |
USA | HL70399 | UNITED STATES |
VCT | HL70399 | SAINT VINCENT AND THE GRENADINES |
GHA | HL70399 | GHANA |
NER | HL70399 | NIGER |
AND | HL70399 | ANDORRA |
YEM | HL70399 | YEMEN |
GRD | HL70399 | GRENADA |
NRU | HL70399 | NAURU |
AUS | HL70399 | AUSTRALIA |
HND | HL70399 | HONDURAS |
PLW | HL70399 | PALAU |
BGR | HL70399 | BULGARIA |
IRN | HL70399 | IRAN, ISLAMIC REPUBLIC OF |
QAT | HL70399 | QATAR |
BRA | HL70399 | BRAZIL |
KAZ | HL70399 | KAZAKSTAN |
SGP | HL70399 | SINGAPORE |
CCK | HL70399 | COCOS (KEELING) ISLANDS |
LAO | HL70399 | LAO PEOPLE'S DEMOCRATIC REPUBLIC |
SOM | HL70399 | SOMALIA |
COK | HL70399 | COOK ISLAND |
SYC | HL70399 | SEYCHELLES |
CYP | HL70399 | CYPRUS |
MAC | HL70399 | MACAU |
TKM | HL70399 | TURKMENISTAN |
ECU | HL70399 | ECUADOR |
MKD | HL70399 | MACEDONIA, THE FORMER YUGOSLAV REPUBLIC OF |
TZA | HL70399 | TANZANIA, UNITED REPUBLIC OF |
FJI | HL70399 | FIJI |
MSR | HL70399 | MONTSERRAT |
AFG | HL70399 | AFGHANISTAN |
VIR | HL70399 | VIRGIN ISLANDS, U.S. |
GLP | HL70399 | GUADELOUPE |
NIC | HL70399 | NICARAGUA |
ARG | HL70399 | ARGENTINA |
ZMB | HL70399 | ZAMBIA |
GUF | HL70399 | FRENCH GUIANA |
PAK | HL70399 | PAKISTAN |
BDI | HL70399 | BURUNDI |
HUN | HL70399 | HUNGARY |
PRI | HL70399 | PUERTO RICO |
BIH | HL70399 | BOSNIA AND HERZEGOVINA |
ISR | HL70399 | ISRAEL |
RUS | HL70399 | RUSSIAN FEDERATION |
BTN | HL70399 | BHUTAN |
KHM | HL70399 | CAMBODIA |
SJM | HL70399 | SVALBARD AND JAN MAYEN |
CHN | HL70399 | CHINA |
LBY | HL70399 | LIBYAN ARAB JAMAHIRIYA |
SUR | HL70399 | SURINAME |
CPV | HL70399 | CAPE VERDE |
TCD | HL70399 | CHAD |
DJI | HL70399 | DJIBOUTI |
MDA | HL70399 | MOLDOVA, REPUBLIC OF |
TTO | HL70399 | TRINIDAD AND TOBAGO |
ESH | HL70399 | WESTERN SAHARA |
MMR | HL70399 | MYANMAR |
UMI | HL70399 | UNITED STATES MINOR OUTLYING ISLANDS |
FRO | HL70399 | FAROE ISLANDS |
MWI | HL70399 | MALAWI |
GBR | HL70399 | UNITED KINGDOM |
NAM | HL70399 | NAMIBIA |
AIA | HL70399 | ANGUILLA |
WLF | HL70399 | WALLIS AND FUTUNA |
GNQ | HL70399 | EQUATORIAL GUINEA |
NOR | HL70399 | NORWAY |
ATA | HL70399 | ANTARCTICA |
HKG | HL70399 | HONG KONG |
PER | HL70399 | PERU |
BFA | HL70399 | BURKINA FASO |
IOT | HL70399 | BRITISH INDIAN OCEAN TERRITORY |
PRY | HL70399 | PARAGUAY |
BMU | HL70399 | BERMUDA |
JOR | HL70399 | JORDAN |
SDN | HL70399 | SUDAN |
CAF | HL70399 | CENTRAL AFRICAN REPUBLIC |
KOR | HL70399 | KOREA, REPUBLIC OF |
SLV | HL70399 | EL SALVADOR |
COD | HL70399 | CONGO, THE DEMOCRATIC REPUBLIC OF THE |
LKA | HL70399 | SRI LANKA |
SWE | HL70399 | SWEDEN |
CXR | HL70399 | CHRISTMAS ISLAND |
LUX | HL70399 | LUXEMBOURG |
TJK | HL70399 | TAJIKISTAN |
DOM | HL70399 | DOMINICAN REPUBLIC |
MEX | HL70399 | MEXICO |
TUV | HL70399 | TUVALU |
ETH | HL70399 | ETHIOPIA |
MOZ | HL70399 | MOZAMBIQUE |
UZB | HL70399 | UZBEKISTAN |
0443 - Provider role
MetadataType: Internally managed
AttributesStability | Extensibility | Content Definition |
---|---|---|
Not defined | Not defined | Not defined |
Codes
Value | Code System | Description |
---|---|---|
CP | HL70443 | Consulting Provider |
RP | HL70443 | Referring Provider |
AD | HL70443 | Admitting |
FHCP | HL70443 | Family Health Care Professional |
RT | HL70443 | Referred to Provider |
AT | HL70443 | Attending |
PP | HL70443 | Primary Care Provider |
0444 - Name assembly order
MetadataType: Internally managed
AttributesStability | Extensibility | Content Definition |
---|---|---|
Not defined | Not defined | Not defined |
Codes
Value | Code System | Description |
---|---|---|
F | HL70444 | Prefix Family Middle Given Suffix |
G | HL70444 | Prefix Given Middle Family Suffix |
0446 - Species Code
MetadataType: Internally managed
AttributesStability | Extensibility | Content Definition |
---|---|---|
Not defined | Not defined | Not defined |
0447 - Breed Code
MetadataType: Internally managed
AttributesStability | Extensibility | Content Definition |
---|---|---|
Not defined | Not defined | Not defined |
0448 - Name context
MetadataType: Internally managed
AttributesStability | Extensibility | Content Definition |
---|---|---|
Not defined | Not defined | Not defined |
0465 - Name/address representation
MetadataType: Internally managed
AttributesStability | Extensibility | Content Definition |
---|---|---|
Not defined | Not defined | Not defined |
Codes
Value | Code System | Description |
---|---|---|
I | HL70465 | Ideographic (i.e., Kanji) |
P | HL70465 | Phonetic (i.e., ASCII, Katakana, Hiragana, etc.) |
A | HL70465 | Alphabetic (i.e., Default or some single-byte) |
Conformance information
Conformance statements
Segment level
MSH_HL_Admit - Message Header
ID | Description |
---|---|
MSH_HL_Admit-12.1 | MSH-12.1 SHALL contain the constant value '2.4' drawn from the code system 'HL70104'. |
MSH_HL_Discharge - Message Header
ID | Description |
---|---|
MSH_HL_Discharge-12.1 | MSH-12.1 SHALL contain the constant value '2.4' drawn from the code system 'HL70104'. |
Datatype level
MSG - Message Type
ID | Description |
---|---|
MSG_HL_Discharge.1 | MSG.1 SHALL contain the constant value 'ADT' drawn from the code system 'HL70076'. |
MSG_HL_Discharge.2 | MSG.2 SHALL contain the constant value 'A03' drawn from the code system 'HL70003'. |
MSG_HL_Discharge.3 | MSG.3 SHALL contain the constant value 'ADT_A03' drawn from the code system 'HL70354'. |
MSG - Message Type
ID | Description |
---|---|
MSG_HL_Admit.1 | MSG.1 SHALL contain the constant value 'ADT' drawn from the code system 'HL70076'. |
MSG_HL_Admit.2 | MSG.2 SHALL contain the constant value 'A01' drawn from the code system 'HL70003'. |
MSG_HL_Admit.3 | MSG.3 SHALL contain the constant value 'ADT_A01' drawn from the code system 'HL70354'. |
Conditional predicates
Segment level
PID_HL - Patient identification
Location | Usage | Description |
---|---|---|
PID-29 | C(X/O) | If the value of PID-30 is 'N'. |