ORU R01 - (Send Measurements)
ORU R01: Send Test Measurements To PKB
Overview
This message can be used to send measurements, pathology results and radiology reports to PKB, but the below will focus on the requirements for measurement data.
Measurements
The ORU R01 can be used to send measurements into PKB, such that they appear in the "Measurements" tab in the PKB web interface.
Please speak to us if you would like to do this, as you'll need to send pre-agreed SNOMED code values in OBX-3.1.
Any OBX-3.3 that specifies SNOMED CT (see table for exact values we match on) will be treated as a measurement, not a lab result, providing that one of our predefined measurement types matches on both:
the ID in OBX-3.1
the unit in OBX-6.2 (or else OBX-6.1 if OBX-6.2 was not provided)
Relevant Entities
Measurement information is used to populate [[Measurement]] entities
Please click through to the Data Model to explore the presentation of these entities in the web interface.
Definition
Segment | Field | Opt | RP/# | Component | Description | Example | Data Model |
---|---|---|---|---|---|---|---|
MSH |
|
|
|
| Message header. This conforms to PKB's standard definition. |
|
|
PID |
|
|
|
| Patient identification. This conforms to PKB's standard definition. |
|
|
OBR |
|
|
|
| Observation request |
|
|
| OBR-3 | C |
|
| Filler order number. OBR-3.1 must be provided if providing multiple measurements. |
|
|
|
|
|
| OBR-3.1 | Filler order number | MYORDER0001 | [[Measurement Report.External ID]] |
| OBR-16 | O |
|
| Ordered by. If present, at least the family name must be given. |
| [[Measurement->Source.Source Text]] |
|
|
|
| OBR-16.2 | Family name | Foster |
|
|
|
|
| OBR-16.3 | Given name | John |
|
|
|
|
| OBR-16.4 | Middle names | Harry |
|
|
|
|
| OBR-16.6 | Title | Dr |
|
| OBR-25 | O |
|
| Result status. If a value of R is provided: any measurements received previously for this report ID will be marked as deleted. OBX segments are not required and will be ignored. |
|
|
|
|
|
| OBR-25.1 | Result status | F |
|
{ |
|
|
|
| Observation or result |
|
|
| OBX-2 | R |
|
| Value type. OBX segments that contain a value type other than NM are silently ignored: |
|
|
|
|
|
| OBX-2.1 | Value type | NM |
|
| OBX-3 | R |
|
| Observation identifier. See our notes on code sets for more information on our handling of coded data. |
|
|
|
|
|
| OBX-3.1 | Test ID. This ID must match one of the predefined values which PKB can accept. | 107647005 |
|
|
|
|
| OBX-3.3 | Test coding system PKB will only accept a measurement if this value is one of the following: ( sct, snomed-ct, snomed ct, http://snomed.info/sct, 2.16.840.1.113883.6.96 ) | sct |
|
| OBX-5 | C |
|
| Observation value. |
|
|
|
|
|
| OBX-5.1 | Value | 200 | [[Measurement.Value]] If a multi-valued measurement is being supplied, then the next OBX segment will contain the value for [[Measurement.Value2]] |
| OBX-6 | O |
|
| Units. See our notes on code sets for more information on our handling of coded data. |
|
|
|
|
|
| OBX-6.1 | Unit ID | X10TO9L | Used instead of OBX-6.2 if OBX-6.2 was not provided. |
|
|
|
| OBX-6.2 | Unit name. | 10 to 9 per L | This must match the corresponding PKB permitted value. |
| OBX-11 | R |
|
| Result status. Only values of F and C will be processed. Values of I, O, P or X (which indicate pending or no results) are silently ignored, whilst any other values will cause an error. |
|
|
|
|
|
| OBX-11.1 | Result status | F |
|
| OBX-14 | C |
|
| Observation timestamp. If this is not present, OBR-7 is used instead. It is an error for neither to be provided. |
|
|
|
|
|
| OBX-14.1 | Observation timestamp | 201505191657 | [[Measurement.Timestamp]] |
Examples
Two examples of a single measurement message.
MSH|^~\&|Corepoint|TDL|HL7API|PKB|201303080949||ORU^R01|ABC0000000001|P|2.4
PID|||9999999999^^^NHS^NH||Smith^John^Joe^^Mr||19700101|M|||Flat name^1, The Road^London^London^SW1A 1AA^GBR||01234567890^PRN~07123456789^PRS|^NET^^john.smith@company.com~01234098765^WPN||||||||||||||||N|
OBR|1||||||||||||||||||||||||F
OBX|1|NM|107647005^^sct||75|^kg^|||||F|||20200625103943+0100
MSH|^~\&|Corepoint|TDL|HL7API|PKB|201303080949||ORU^R01|ABC0000000001|P|2.4
PID|||9999999999^^^NHS^NH||Smith^John^Joe^^Mr||19700101|M|||Flat name^1, The Road^London^London^SW1A 1AA^GBR||01234567890^PRN~07123456789^PRS|^NET^^john.smith@company.com~01234098765^WPN||||||||||||||||N|
OBR||||||||||||||||^Ward^Olivia^Elsie^^Ms|||||||||F
OBX||NM|162986007^^sct||7|^bpm|||||F|||20200401140103+0100
An example of a multi measurement message.
MSH|^~\&|Corepoint|TDL|HL7API|PKB|201303080949||ORU^R01|ABC0000000001|P|2.4
PID|||9999999999^^^NHS^NH||Smith^John^Joe^^Mr||19700101|M|||Flat name^1, The Road^London^London^SW1A 1AA^GBR||01234567890^PRN~07123456789^PRS|^NET^^john.smith@company.com~01234098765^WPN||||||||||||||||N|
OBR|||MYORDER0001|||||||||||||^Ward^Olivia^Elsie^^Ms|||||||||F
OBX||NM|75367002^^sct|||-|||||F|||20191106091410+0000
OBX||NM|163030003^^sct||190|^mmHg (systolic)|||||F|||20191106091410+0000
OBX||NM|163031004^^sct||59|^mmHg (diastolic)|||||F|||20191106091410+0000
Response
PKB will respond with a standard HL7 acknowledgement.
Supported Single Measurements
Snomed code | Label | Units |
366162006 | Central venous pressure (CVP) | cmH20 |
107647005 | Weight | kg |
162755006 | Height | cm |
276361009 | Waist size | cm |
301338002 | Head circumference | cm |
301898006 | Body surface area | square metres |
301331008 | Body mass index (BMI) | kg/m^2 |
170804003 | Ideal body weight | kg |
162986007 | Pulse | bpm |
162913005 | Respiration | rpm |
105723007 | Temperature | degrees Celsius |
1036631000000109 | Musculoskeletal Health Questionnaire (MSK-HQ) score |
|
431314004 | Oxygen saturation (SPO2) | % |
257733005 | Activity (Rating Scale: 0-10) |
|
415882003 | Axillary (under arm) temperature | degrees Celsius |
15527001 | Capillary filling | Seconds |
251843005 | Fluid output from drain | ml |
366156001 | Peak expiratory flow (PEF) | l/min |
313222007 | Forced expiratory volume in one second/Forced vital capacity percent (FEV1/FVC) |
|
59328004 | Forced expiratory volume in 1 second (FEV1) | Litres |
366151006 | Forced vital capacity (FVC) | Litres |
873921000000106 | Forced expired volume in 6 seconds (FEV6) | Litres |
251932003 | Forced expiratory flow rate between 25 and 75% of vital capacity (FEF 25-75) | l/min |
273648008 | Nine hole peg test | Seconds |
414059009 | Number of missed medications today |
|
786441000000107 | Grip strength - left hand | kg |
786451000000105 | Grip strength - right hand | kg |
78564009 | Heart rate measured at systemic artery | beat/min |
1091811000000102 | Diastolic arterial pressure | mmHg |
72313002 | Systolic arterial pressure | mmHg |
810931000000108 | QRISK2 calculated heart age | year |
718087004 | QRISK2 cardiovascular disease 10 year risk score | % |
1325531000000102 | QRISK3 healthy heart age | years |
1085871000000105 | QRISK3 10 year cardiovascular disease risk score | % |
1082641000000106 | Alcohol units consumed per week | u/week |
230085005 | Beer intake | u/week |
230086006 | Wine intake | u/week |
230088007 | Spirits intake | u/week |
442547005 | Alcohol units heaviest day | /day |
230056004 | Cigarette consumption | /day |
230057008 | Cigar consumption | /day |
230058003 | Pipe tobacco consumption | g/week |
413173009 | Minutes from waking to first tobacco consumption | min |
836001000000109 | Waterpipe tobacco consumption | times/week |
401070008 | Number portions fruit/veg daily | /day |
129006008 | Steps |
|
1155968006 | Mood |
|
Patients Know Best Wiki Hub | Deploy | Developer | Trust Centre | Manual | Research | Education | Release Notes
© Patients Know Best, Ltd. Registered in England and Wales Number: 6517382. VAT Number: GB 944 9739 67.
This API specification and design is licensed under a Creative Commons Attribution 4.0 International License.