---
title: "Guidance and Scopes For Sending HL7 Data"
canonical: "https://wiki.patientsknowbest.com/space/api/3364946836/Guidance%20and%20Scopes%20For%20Sending%20HL7%20Data"
format: markdown
---
> Macro (toc)

# Enabled Message Types

This page summarises the messages currently supported in our production environments.

Please see the subpages for full details of each message.

**Query** (track which of your patients have active PKB accounts, and who has been added since you last polled)

- <u>[QRY A19: List patients in PKB](https://wiki.hub.patientsknowbest.com/wiki/spaces/api/pages/3365012701)</u>

**Records** (including allergies, diagnoses, and medication history)

- <u>[ADT A28: Create and update patient medical records](https://wiki.hub.patientsknowbest.com/wiki/spaces/api/pages/3365078168)</u>
- <u>[ADT A31: Create and update patient medical records](https://wiki.hub.patientsknowbest.com/wiki/spaces/api/pages/3365078195)</u>

# Encounters

- <u>[ADT A01: Admit a patient](https://wiki.hub.patientsknowbest.com/wiki/spaces/api/pages/3365077971)</u>
- <u>[ADT A02: Transfer a patient](https://wiki.hub.patientsknowbest.com/wiki/spaces/api/pages/3365012302)</u>
- <u>[ADT A03: Discharge a patient](https://wiki.hub.patientsknowbest.com/wiki/spaces/api/pages/3364848574)</u>
- <u>[ADT A05: Pre-admit a patient](https://wiki.hub.patientsknowbest.com/wiki/spaces/api/pages/3364848597)</u>
- <u>[ADT A08: Update an encounter](https://wiki.hub.patientsknowbest.com/wiki/spaces/api/pages/3364848610)</u>
- <u>[ADT A11: Cancel an admission](https://wiki.hub.patientsknowbest.com/wiki/spaces/api/pages/3364848631)</u>
- <u>[ADT A12: Cancel a transfer](https://wiki.hub.patientsknowbest.com/wiki/spaces/api/pages/3364848666)</u>
- <u>[ADT A13: Cancel a discharge](https://wiki.hub.patientsknowbest.com/wiki/spaces/api/pages/3365012428)</u>
- <u>[ADT A14: Pending admit](https://wiki.hub.patientsknowbest.com/wiki/spaces/api/pages/3365012440)</u>
- <u>[ADT A27: Cancel a pending admit](https://wiki.hub.patientsknowbest.com/wiki/spaces/api/pages/3364946987)</u>
- <u>[ADT A38: Cancel a pre-admit](https://wiki.hub.patientsknowbest.com/wiki/spaces/api/pages/3364848770)</u>

## Observations

(laboratory results and reports, radiology reports and images, vital measurements)

- <u>[ORU R01: Send observations](https://wiki.hub.patientsknowbest.com/wiki/spaces/api/pages/3364848898)</u>

## Documents 

(e.g. care plans, discharge summaries and clinic letters)

- <u>[MDM T02: Send a care plan or document](https://wiki.hub.patientsknowbest.com/wiki/spaces/api/pages/3364848787)</u>
- <u>[MDM T11: Delete a document](https://wiki.hub.patientsknowbest.com/wiki/spaces/api/pages/3364947080)</u>

## Appointments 

(currently accepts only non-recurring appointments for a single patient)

- <u>[SIU S12: Create an appointment](https://wiki.hub.patientsknowbest.com/wiki/spaces/api/pages/3364947182)</u>
- <u>[SIU S13: Update an appointment](https://wiki.hub.patientsknowbest.com/wiki/spaces/api/pages/3364947195)</u>
- <u>[SIU S14: Update an appointment](https://wiki.hub.patientsknowbest.com/wiki/spaces/api/pages/3364947206)</u>
- <u>[SIU S15: Cancel an appointment](https://wiki.hub.patientsknowbest.com/wiki/spaces/api/pages/3364849014)</u>
- <u>[SIU S26: Set DNA for an appointment](https://wiki.hub.patientsknowbest.com/wiki/spaces/api/pages/3365078416)</u>

Any type of HL7 message is parsed automatically and passed through to the PKB back end, so it's fairly quick to enable processing of other messages types; we will be expanding this in the future.

# Standard Messages and Segments

- See[ ](http://www.google.com/url?q=http%3A%2F%2Fdev.patientsknowbest.com%2Fhome%2Fhl7-api%2Fsegments&sa=D&sntz=1&usg=AOvVaw2qDr0a33k9a36nR-b6CkRa)<u>[here for the PKB specification of standard segments](https://wiki.hub.patientsknowbest.com/wiki/spaces/api/pages/3365012965)</u>, such as MSH and PID.
- <u>[Standard HL7 acknowledgement](https://wiki.hub.patientsknowbest.com/wiki/spaces/api/pages/3364848470)</u>

# Whats Included

> Macro (pagetree)