Appendix 9 HL7v2 Virtual Medical Record (Normative)
- 1 A9.1 Introduction
- 2 A9.2 Implementing the HL7v2 Virtual Medical Record with OBX segments
- 2.1 A9.2.1 Specifying the HL7v2 VMR is in use.
- 2.2 A9.2.2 Implementing each element of the HL7v2 VMR
- 3 A9.3 Value Domain Tables
A9.1 Introduction
The HL7v2 Virtual Medical Record (VMR) is a way to implement a structured information atomically in a series of HL7 OBX segments following a template methodology.
It is based upon the HL7 Publication "HL7 Version 2 Implementation Guide: Implementing the Virtual Medical Record for Clinical Decision Support (vMR-CDS), Release 1 " (you may need an account with HL7 International to download). Refer to that document for a deeper understanding and discussion of the methodology. This appendix will simply provide a prescription for its implementation in a simple way.
The HL7v2 Virtual Medical Record is also defined by the LOINC as "Virtual Medical Record for Clinical Decision Support panel HL7.VMR-CDS" (74028-2). The panel definition can be viewed at the following URL: https://s.details.loinc.org/LOINC/74028-2.html?sections=Comprehensive
A9.2 Implementing the HL7v2 Virtual Medical Record with OBX segments
A9.2.1 Specifying the HL7v2 VMR is in use.
When using the HL7v2 VMR a header OBX must be present which indicates that a report template is in use. In the header, OBX-3 field must have the value "74028-2^Report template ID^LN", and the template that is in use OBX-5 must, and also specify an OBX-4 sub-ID which must be a dotted decimal value (for simplicity "1" has been specified as the root sub ID). This header OBX must have a OBX-2 Datatype field value of "RP" (See 3.20 RP - Reference Pointer). OBX-5 must be valued as "HL7V2-VMR.v1^HL7V2 VMR&99A-9AAC5A649D18B6F2&L^TX^Octet-stream".
Subsequently all other OBX segments present that form part of the HL7.VMR must have dotted sub id based on this OBX-4 sub-ID this header OBX.
Therefore as an example, the first OBX is static and must be as follows:
OBX|1|RP|74028-2^Report template ID^LN|1|HL7V2-VMR.v1^HL7V2 VMR&99A-9AAC5A649D18B6F2&L^TX^Octet-stream||||||FA9.2.2 Implementing each element of the HL7v2 VMR
The HL7v2 VMR OBX implementation table below defines the elements of the VMR and provides values that must be used in various OBX fields as indicated by the column headings.
Each VMR element must be implemented as an OBX, the values of which will be discussed following the table.
When the row in the table has a VMR Datatype column of ENTRY, SECTION, STRUCTURAL, COLLECTION then the prescribed values in the table must be used.
Technically, OBX for VMR Data SECTIOHTTPAccessControlAllowOriginManagerN, STRUCTURAL and COLLECTION are optional as the structure is implied by the dotted decimal structured OBX-4 Observation sub-ID. However, including these OBX segments can be useful to viewers of the atomic data but non-essential for computed interpretation of the actual content.
A9.2.2.1 HL7v2 VMR OBX implementation table
Refer to the legend table that follows after this table which explains the colours used. The colours are redundant and are indicative of certain values in the VMR Datatype column.
A9.T.1 HL7v2 VMR OBX implementation table
Section Heading or Element | OBX-2 DataType | OBX-3 Value | OBX-4 Observation sub-ID | Suggested OBX-5 Observation value or Value Set or Constraint | OBX-14 Date/time of the observation is valued (Y=Yes, N=No) | OCCURENCES | VMR DATATYPE |
|---|---|---|---|---|---|---|---|
Report template ID | RP |
| 1 | HL7V2-VMR.v1^HL7V2 VMR&99A-9AAC5A649D18B6F2&L^TX^Octet-stream |
| 1 | ENTRY |
History of Presenting Complaint | CWE | 73983-9^^LN | 1.1 | 34046-3^History of Presenting Complaint^LN |
| 0..1 | SECTION |
Chief Complaint | CWE | 10154-3^Chief Complaint^LN | 1.1.1 | Constraint (Child of Snomed-CT term 404684003 | Clinical finding (finding)) |
| 0..1 | CODEDVALUE |
Date of Onset | TS | 11368-8^Date of Onset^LN | 1.1.2 |
|
| 0..1 | DATETIME |
Notes | FT | 8251-1^Notes^LN | 1.1.3 |
|
| 0..1 | STRING |
History of Past Illness | CWE | 73983-9^^LN | 1.2 | 11348-0^History of Past Illness^LN^417662000^History of Past Illness^SCT |
| 0..1 | SECTION |
Past Illness † | - |
| 1.2.1.RepeatOf[CLUSTER -- Past Illness] |
|
| 0..* | STRUCTURAL |
Past Illness | CWE | 11349-8^Past Illness^LN | 1.2.1.RepeatOf[CLUSTER -- Past Illness].1 | Constraint (Child of Snomed-CT term 404684003 | Clinical finding (finding)) |
| 0..1 | CODEDVALUE |
Temporal Context | CWE | 408731000^Temporal Context^SCT | 1.2.1.RepeatOf[CLUSTER -- Past Illness].2 | Value Set ( 15240007^Current^SCT 410511007^Current or past^SCT 410587003^Past - specified^SCT 410588008^Past - unspecified^SCT 410589000^All times past^SCT 6493001^Recent^SCT )
If the temporal context is unspecified, then 410511007^Current or past^SCT is the assumed value. |
| 0..1 | CODEDVALUE |
Illness Dates | DR | 11368-8^Illness Dates^LN | 1.2.1.RepeatOf[CLUSTER -- Past Illness].3 |
|
| 0..1 | DATERANGE |
Notes on Illness | FT | 8251-1^Notes on Illness^LN | 1.2.1.RepeatOf[CLUSTER -- Past Illness].4 |
|
| 0..1 | STRING |
Procedures | CWE | 73983-9^^LN | 1.3 | 47519-4^^LN^416940007 |
| 0..1 | SECTION |
Procedure † | - | 71388002^Procedure^SCT | 1.3.1.RepeatOf[CLUSTER -- Procedure] |
|
| 0..* | STRUCTURAL |
Procedure Performed | CWE | 29300-1^Procedure Performed^LN | 1.3.1.RepeatOf[CLUSTER -- Procedure].1 | Constraint (Child of Snomed-CT term 71388002 | Procedure (procedure) |) | Y | 0..1 | CODEDVALUE |
Notes on Procedure | FT | 8251-1^Notes on Procedure^LN | 1.3.1.RepeatOf[CLUSTER -- Procedure].2 |
|
| 0..1 | STRING |
Family History | CWE | 73983-9^^LN | 1.4 | 10157-6^Family History^LN |
| 0..1 | SECTION |
Patients Family Tree ID | ST | 74027-4^Patients Family Tree ID^LN | 1.4.1 |
|
| 0..1 | STRING |
Natural Father ID | ST | 74026-6^Natural Father ID^LN | 1.4.2 |
|
| 0..1 | STRING |
Natural Mother ID | ST | 74025-8^Natural Mother ID^LN | 1.4.3 |
|
| 0..1 | STRING |
Relatives | CWE | 73983-9^^LN | 1.4.4 | 224086007^Relatives^SCT |
| 0..1 | SECTION |
Relative † | - |
| 1.4.4.1.RepeatOf[CLUSTER -- Relative] |
|
| 0..* | STRUCTURAL |
Relative Name | ST | 54138-3^Relative Name^LN | 1.4.4.1.RepeatOf[CLUSTER -- Relative].1 |
|
| 0..1 | STRING |
Relationship | CWE | 44767-2^Relationship^LN | 1.4.4.1.RepeatOf[CLUSTER -- Relative].2 | Constraint (HL7 v3 FamilyMember Value set = Child of Role Code _PersonalRelationshipRoleType FAMMEMB) Use "ROLECODE" for Name of Coding System component of CWE See Table HL7 v3 FamilyMember Value set below |
| 0..1 | CODEDVALUE |
Relative ID | ST | 74024-1^Relative ID^LN | 1.4.4.1.RepeatOf[CLUSTER -- Relative].3 |
|
| 0..1 | STRING |
Natural Father ID | ST | 74026-6^Natural Father ID^LN | 1.4.4.1.RepeatOf[CLUSTER -- Relative].4 |
|
| 0..1 | STRING |
Natural Mother ID | ST | 74025-8^Natural Mother ID^LN | 1.4.4.1.RepeatOf[CLUSTER -- Relative].5 |
|
| 0..1 | STRING |
deceasedEstimatedAge | ST | 39016-1^Deceased Estimated Age^LN | 1.4.4.1.RepeatOf[CLUSTER -- Relative].6 |
|
| 0..1 | REAL |
LivingEstimatedAge | ST | 21612-7^Living Estimated Age^LN | 1.4.4.1.RepeatOf[CLUSTER -- Relative].7 |
|
| 0..1 | REAL |
Clinical Genomic Choice | CWE | 73983-9^^LN | 1.4.4.1.RepeatOf[CLUSTER -- Relative].8.RepeatOf[CLUSTER -- Clinical Genomic Choice] |
|
| 0..* | COLLECTION |
Clinical Observation | CWE | 74023-3^Clinical Observation^LN | 1.4.4.1.RepeatOf[CLUSTER -- Relative].8.RepeatOf[CLUSTER -- Clinical Genomic Choice].1 |
|
| 1..1 | CODEDVALUE |
Negation Indicator | CWE | 74022-5^Negation Indicator^LN | 1.4.4.1.RepeatOf[CLUSTER -- Relative].8.RepeatOf[CLUSTER -- Clinical Genomic Choice].2 | Value Set ( 31874001^True^SCT 64100000^False^SCT 64957009^Uncertain^SCT ) |
| 0..1 | BOOLEAN |
Cause of Death | CWE | 74044-9^Cause of Death^LN | 1.4.4.1.RepeatOf[CLUSTER -- Relative].8.RepeatOf[CLUSTER -- Clinical Genomic Choice].3 | Value Set ( 31874001^True^SCT 64100000^False^SCT 64957009^Uncertain^SCT ) |
| 0..1 | BOOLEAN |
DataEstimatedAge | ST | 21611-9^Data Estimated Age^LN | 1.4.4.1.RepeatOf[CLUSTER -- Relative].8.RepeatOf[CLUSTER -- Clinical Genomic Choice].4 |
|
| 0..1 | REAL |