HL7 to JSON
A simple library to convert HL7 message version 2 to json with human readable description
https://pypi.org/project/hl7tojson/
Installation
Simple
pip install hl7tojson
Example
from hl7tojson import parser
message = '\r'.join([
'MSH|^~\&|MegaReg|XYZHospC|SuperOE|XYZImgCtr|20060529090131-0500||ADT^A01^ADT_A01|01052901|P|2.5',
'EVN||200605290901||||200605290900',
'PID|||56782445^^^UAReg^PI||KLEINSAMPLE^BARRY^Q^JR||19620910|M||2028-9^^HL70005^RA99113^^XYZ|260 GOODWIN CREST '
'DRIVE^^BIRMINGHAM^AL^35209^^M~NICKELL’S PICKLES^10000 W 100TH '
'AVE^BIRMINGHAM^AL^35200^^O|||||||0105I30001^^^99DEF^AN',
'PV1||I|W^389^1^UABH^^^^3||||12345^MORGAN^REX^J^^^MD^0010^UAMC^L||67890^GRAINGER^LUCY^X^^^MD^0010^UAMC^L|MED'
'|||||A0||13579^POTTER^SHERMAN^T^^^MD^0010^UAMC^L|||||||||||||||||||||||||||200605290900',
'OBX|1|NM|^Body Height||1.80|m^Meter^ISO+|||||F',
'OBX|2|NM|^Body Weight||79|kg^Kilogram^ISO+|||||F',
'AL1|1||^ASPIRIN',
'DG1|1||786.50^CHEST PAIN, UNSPECIFIED^I9|||A'
])
parser.parse(message)
{
"info": {
"message_version": "27",
"message_type": "ADT_A01",
"message_description": "Admit/Visit Notification"
},
"segments": [
{
"fields": [
{
"repetitions": [],
"data": "|",
"id": 1,
"description": "Field Separator"
},
{
"repetitions": [],
"data": "^~\\&",
"id": 2,
"description": "Encoding Characters"
},
{
"repetitions": [],
"data": "MegaReg",
"id": 3,
"description": "Sending Application"
},
{
"repetitions": [],
"data": "XYZHospC",
"id": 4,
"description": "Sending Facility"
},
{
"repetitions": [],
"data": "SuperOE",
"id": 5,
"description": "Receiving Application"
},
{
"repetitions": [],
"data": "XYZImgCtr",
"id": 6,
"description": "Receiving Facility"
},
{
"repetitions": [],
"data": "20060529090131-0500",
"id": 7,
"description": "Date/Time of Message"
},
{
"repetitions": [
{
"data": "ADT^A01^ADT_A01",
"description": "Message Type",
"components": [
{
"data": "ADT",
"id": 1,
"description": "Message Code"
},
{
"data": "A01",
"id": 2,
"description": "Trigger Event"
},
{
"data": "ADT_A01",
"id": 3,
"description": "Message Structure"
}
]
}
],
"data": "ADT^A01^ADT_A01",
"id": 9,
"description": "Message Type"
},
{
"repetitions": [],
"data": "01052901",
"id": 10,
"description": "Message Control ID"
},
{
"repetitions": [],
"data": "P",
"id": 11,
"description": "Processing ID"
},
{
"repetitions": [],
"data": "2.5",
"id": 12,
"description": "Version ID"
}
],
"type": "MSH",
"description": "Message Header"
},
{
"fields": [
{
"repetitions": [],
"data": "200605290901",
"id": 2,
"description": "Recorded Date/Time "
},
{
"repetitions": [],
"data": "200605290900",
"id": 6,
"description": "Event Occurred"
}
],
"type": "EVN",
"description": "Event Type"
},
{
"fields": [
{
"repetitions": [
{
"data": "56782445^^^UAReg^PI",
"description": "Patient Identifier List",
"components": [
{
"data": "56782445",
"id": 1,
"description": "ID Number"
},
{
"data": "UAReg",
"id": 4,
"description": "Assigning Authority"
},
{
"data": "PI",
"id": 5,
"description": "Identifier Type Code"
}
]
}
],
"data": "56782445^^^UAReg^PI",
"id": 3,
"description": "Patient Identifier List"
},
{
"repetitions": [
{
"data": "KLEINSAMPLE^BARRY^Q^JR",
"description": "Patient Name",
"components": [
{
"data": "KLEINSAMPLE",
"id": 1,
"description": "Family Name"
},
{
"data": "BARRY",
"id": 2,
"description": "Given Name"
},
{
"data": "Q",
"id": 3,
"description": "Second and Further Given Names or Initials Thereof"
},
{
"data": "JR",
"id": 4,
"description": "Suffix (e.g., JR or III)"
}
]
}
],
"data": "KLEINSAMPLE^BARRY^Q^JR",
"id": 5,
"description": "Patient Name"
},
{
"repetitions": [],
"data": "19620910",
"id": 7,
"description": "Date/Time of Birth"
},
{
"repetitions": [],
"data": "M",
"id": 8,
"description": "Administrative Sex"
},
{
"repetitions": [
{
"data": "2028-9^^HL70005^RA99113^^XYZ",
"description": "Race",
"components": [
{
"data": "2028-9",
"id": 1,
"description": "Identifier"
},
{
"data": "HL70005",
"id": 3,
"description": "Name of Coding System"
},
{
"data": "RA99113",
"id": 4,
"description": "Alternate Identifier"
},
{
"data": "XYZ",
"id": 6,
"description": "Name of Alternate Coding System"
}
]
}
],
"data": "2028-9^^HL70005^RA99113^^XYZ",
"id": 10,
"description": "Race"
},
{
"repetitions": [
{
"data": "260 GOODWIN CREST DRIVE^^BIRMINGHAM^AL^35209^^M",
"description": "Patient Address",
"components": [
{
"data": "260 GOODWIN CREST DRIVE",
"id": 1,
"description": "Street Address"
},
{
"data": "BIRMINGHAM",
"id": 3,
"description": "City"
},
{
"data": "AL",
"id": 4,
"description": "State or Province"
},
{
"data": "35209",
"id": 5,
"description": "Zip or Postal Code"
},
{
"data": "M",
"id": 7,
"description": "Address Type"
}
]
},
{
"data": "NICKELL\u2019S PICKLES^10000 W 100TH AVE^BIRMINGHAM^AL^35200^^O",
"description": "Patient Address",
"components": [
{
"data": "NICKELL\u2019S PICKLES",
"id": 1,
"description": "Street Address"
},
{
"data": "10000 W 100TH AVE",
"id": 2,
"description": "Other Designation"
},
{
"data": "BIRMINGHAM",
"id": 3,
"description": "City"
},
{
"data": "AL",
"id": 4,
"description": "State or Province"
},
{
"data": "35200",
"id": 5,
"description": "Zip or Postal Code"
},
{
"data": "O",
"id": 7,
"description": "Address Type"
}
]
}
],
"data": "260 GOODWIN CREST DRIVE^^BIRMINGHAM^AL^35209^^M~NICKELL\u2019S PICKLES^10000 W 100TH AVE^BIRMINGHAM^AL^35200^^O",
"id": 11,
"description": "Patient Address"
},
{
"repetitions": [
{
"data": "0105I30001^^^99DEF^AN",
"description": "Patient Account Number",
"components": [
{
"data": "0105I30001",
"id": 1,
"description": "ID Number"
},
{
"data": "99DEF",
"id": 4,
"description": "Assigning Authority"
},
{
"data": "AN",
"id": 5,
"description": "Identifier Type Code"
}
]
}
],
"data": "0105I30001^^^99DEF^AN",
"id": 18,
"description": "Patient Account Number"
}
],
"type": "PID",
"description": "Patient Identification"
},
{
"fields": [
{
"repetitions": [],
"data": "I",
"id": 2,
"description": "Patient Class"
},
{
"repetitions": [
{
"data": "W^389^1^UABH^^^^3",
"description": "Assigned Patient Location",
"components": [
{
"data": "W",
"id": 1,
"description": "Point of Care"
},
{
"data": "389",
"id": 2,
"description": "Room"
},
{
"data": "1",
"id": 3,
"description": "Bed"
},
{
"data": "UABH",
"id": 4,
"description": "Facility"
},
{
"data": "3",
"id": 8,
"description": "Floor"
}
]
}
],
"data": "W^389^1^UABH^^^^3",
"id": 3,
"description": "Assigned Patient Location"
},
{
"repetitions": [
{
"data": "12345^MORGAN^REX^J^^^MD^0010^UAMC^L",
"description": "Attending Doctor",
"components": [
{
"data": "12345",
"id": 1,
"description": "Person Identifier"
},
{
"data": "MORGAN",
"id": 2,
"description": "Family Name"
},
{
"data": "REX",
"id": 3,
"description": "Given Name"
},
{
"data": "J",
"id": 4,
"description": "Second and Further Given Names or Initials Thereof"
},
{
"data": "MD",
"id": 7,
"description": "Degree (e.g., MD)"
},
{
"data": "0010",
"id": 8,
"description": "Source Table"
},
{
"data": "UAMC",
"id": 9,
"description": "Assigning Authority"
},
{
"data": "L",
"id": 10,
"description": "Name Type Code"
}
]
}
],
"data": "12345^MORGAN^REX^J^^^MD^0010^UAMC^L",
"id": 7,
"description": "Attending Doctor"
},
{
"repetitions": [
{
"data": "67890^GRAINGER^LUCY^X^^^MD^0010^UAMC^L",
"description": "Consulting Doctor",
"components": [
{
"data": "67890",
"id": 1,
"description": "Person Identifier"
},
{
"data": "GRAINGER",
"id": 2,
"description": "Family Name"
},
{
"data": "LUCY",
"id": 3,
"description": "Given Name"
},
{
"data": "X",
"id": 4,
"description": "Second and Further Given Names or Initials Thereof"
},
{
"data": "MD",
"id": 7,
"description": "Degree (e.g., MD)"
},
{
"data": "0010",
"id": 8,
"description": "Source Table"
},
{
"data": "UAMC",
"id": 9,
"description": "Assigning Authority"
},
{
"data": "L",
"id": 10,
"description": "Name Type Code"
}
]
}
],
"data": "67890^GRAINGER^LUCY^X^^^MD^0010^UAMC^L",
"id": 9,
"description": "Consulting Doctor"
},
{
"repetitions": [],
"data": "MED",
"id": 10,
"description": "Hospital Service"
},
{
"repetitions": [],
"data": "A0",
"id": 15,
"description": "Ambulatory Status"
},
{
"repetitions": [
{
"data": "13579^POTTER^SHERMAN^T^^^MD^0010^UAMC^L",
"description": "Admitting Doctor",
"components": [
{
"data": "13579",
"id": 1,
"description": "Person Identifier"
},
{
"data": "POTTER",
"id": 2,
"description": "Family Name"
},
{
"data": "SHERMAN",
"id": 3,
"description": "Given Name"
},
{
"data": "T",
"id": 4,
"description": "Second and Further Given Names or Initials Thereof"
},
{
"data": "MD",
"id": 7,
"description": "Degree (e.g., MD)"
},
{
"data": "0010",
"id": 8,
"description": "Source Table"
},
{
"data": "UAMC",
"id": 9,
"description": "Assigning Authority"
},
{
"data": "L",
"id": 10,
"description": "Name Type Code"
}
]
}
],
"data": "13579^POTTER^SHERMAN^T^^^MD^0010^UAMC^L",
"id": 17,
"description": "Admitting Doctor"
},
{
"repetitions": [],
"data": "200605290900",
"id": 44,
"description": "Admit Date/Time"
}
],
"type": "PV1",
"description": "Patient Visit"
},
{
"fields": [
{
"repetitions": [],
"data": "1",
"id": 1,
"description": "Set ID - OBX"
},
{
"repetitions": [],
"data": "NM",
"id": 2,
"description": "Value Type"
},
{
"repetitions": [
{
"data": "^Body Height",
"description": "Observation Identifier",
"components": [
{
"data": "Body Height",
"id": 2,
"description": "Text"
}
]
}
],
"data": "^Body Height",
"id": 3,
"description": "Observation Identifier"
},
{
"repetitions": [],
"data": "1.80",
"id": 5,
"description": "Observation Value"
},
{
"repetitions": [
{
"data": "m^Meter^ISO+",
"description": "Units",
"components": [
{
"data": "m",
"id": 1,
"description": "Identifier"
},
{
"data": "Meter",
"id": 2,
"description": "Text"
},
{
"data": "ISO+",
"id": 3,
"description": "Name of Coding System"
}
]
}
],
"data": "m^Meter^ISO+",
"id": 6,
"description": "Units"
},
{
"repetitions": [],
"data": "F",
"id": 11,
"description": "Observation Result Status"
}
],
"type": "OBX",
"description": "Observation/Result"
},
{
"fields": [
{
"repetitions": [],
"data": "2",
"id": 1,
"description": "Set ID - OBX"
},
{
"repetitions": [],
"data": "NM",
"id": 2,
"description": "Value Type"
},
{
"repetitions": [
{
"data": "^Body Weight",
"description": "Observation Identifier",
"components": [
{
"data": "Body Weight",
"id": 2,
"description": "Text"
}
]
}
],
"data": "^Body Weight",
"id": 3,
"description": "Observation Identifier"
},
{
"repetitions": [],
"data": "79",
"id": 5,
"description": "Observation Value"
},
{
"repetitions": [
{
"data": "kg^Kilogram^ISO+",
"description": "Units",
"components": [
{
"data": "kg",
"id": 1,
"description": "Identifier"
},
{
"data": "Kilogram",
"id": 2,
"description": "Text"
},
{
"data": "ISO+",
"id": 3,
"description": "Name of Coding System"
}
]
}
],
"data": "kg^Kilogram^ISO+",
"id": 6,
"description": "Units"
},
{
"repetitions": [],
"data": "F",
"id": 11,
"description": "Observation Result Status"
}
],
"type": "OBX",
"description": "Observation/Result"
},
{
"fields": [
{
"repetitions": [],
"data": "1",
"id": 1,
"description": "Set ID - AL1"
},
{
"repetitions": [
{
"data": "^ASPIRIN",
"description": "Allergen Code/Mnemonic/Description",
"components": [
{
"data": "ASPIRIN",
"id": 2,
"description": "Text"
}
]
}
],
"data": "^ASPIRIN",
"id": 3,
"description": "Allergen Code/Mnemonic/Description"
}
],
"type": "AL1",
"description": "Patient Allergy Information"
},
{
"fields": [
{
"repetitions": [],
"data": "1",
"id": 1,
"description": "Set ID - DG1"
},
{
"repetitions": [
{
"data": "786.50^CHEST PAIN, UNSPECIFIED^I9",
"description": "Diagnosis Code - DG1 ",
"components": [
{
"data": "786.50",
"id": 1,
"description": "Identifier"
},
{
"data": "CHEST PAIN, UNSPECIFIED",
"id": 2,
"description": "Text"
},
{
"data": "I9",
"id": 3,
"description": "Name of Coding System"
}
]
}
],
"data": "786.50^CHEST PAIN, UNSPECIFIED^I9",
"id": 3,
"description": "Diagnosis Code - DG1 "
},
{
"repetitions": [],
"data": "A",
"id": 6,
"description": "Diagnosis Type"
}
],
"type": "DG1",
"description": "Diagnosis"
}
]
}
TODO
- Support all versions of HL7 version 2
- Support data description in multiple languages
- Add CI
1 maintainer
Metadata
1 maintainer
Release files for hl7tojson 0.0.2
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| hl7tojson-0.0.2.tar.gz | 11.7 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| hl7tojson-0.0.2-py2-none-any.whl | Python 2 | none | any | Details |
Total release size: 795.5 kB
Release files / hl7tojson-0.0.2.tar.gz
| Download URL | hl7tojson-0.0.2.tar.gz |
|---|---|
| Size | 11.7 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
8d6a05c5455f7e9b18398e6923c7169a03a6906d86906c17729b119efc00164a
|
|
BLAKE2b-256 checksum How to use checksums |
626584565e5825e1be5dd7b7279c2f3d1d90d509e589a36bb61777653a4e1874
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/1.12.1 pkginfo/1.4.2 requests/2.20.0 setuptools/40.4.3 requests-toolbelt/0.8.0 tqdm/4.28.1 CPython/2.7.15
|
Release files / hl7tojson-0.0.2-py2-none-any.whl
| Download URL | hl7tojson-0.0.2-py2-none-any.whl |
|---|---|
| Size | 783.8 kB |
| Tags | Python 2 |
|
SHA-256 checksum How to use checksums |
e79b373ff8cf3e98d552b05c678e1f500781992d827d076d60dc0cc48bda8bb2
|
|
BLAKE2b-256 checksum How to use checksums |
0f489071e87fd485c67740b8cc6a0bd562a0c37c67651148a1c564c4bc47f400
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/1.12.1 pkginfo/1.4.2 requests/2.20.0 setuptools/40.4.3 requests-toolbelt/0.8.0 tqdm/4.28.1 CPython/2.7.15
|
