...
Please click through to theData Model to explore the presentation of these entities in the web interface.
| Expand | ||
|---|---|---|
| ||
[[Encounter]] Matched on: [[Encounter.External Encounter ID]] as derived from PV1-19.1 When matched: The [[Encounter Event]] will be handled as indicated below. When not matched: A new [[Encounter]] will be created with this message. [[Encounter Event]] Matched on: An Encounter can contain zero or one admission [[Encounter Event]]. If the [[Encounter]] has been matched, then there will be at most one admission [[Encounter Event]], so no other IDs are required for matching. When matched: The admission [[Encounter Event]] is replaced with the information in this message. When not matched: The admission [[Encounter Event]] is added to the [[Encounter]]. |
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. | ||||||
PV1 | Patient visit information. | ||||||
PV1-2 | O | Patient class | |||||
PV1-2.1 | Patient class. Allowed values are defined in Code Set PKBCS04. If a blank or unknown value is provided the class will default to OTHER. | I | [[Encounter Event.Class]] | ||||
PV1-3 | O | ||||||
PV1-3.9 | Free text description of the location. | My Ward | [[Encounter Event->Location.Description]] | ||||
PV1-7 | O | Attending doctor. | [[Encounter Event->External Participant.Name]] [[Encounter Event->External Participant.Role]] will be set to ATTENDER. | ||||
PV1-7.2 | Family name | Jones | |||||
PV1-7.3 | Given name | Stuart | |||||
PV1-7.4 | Middle names | James | |||||
PV1-7.6 | Prefix | Dr | |||||
PV1-8 | O | Referring doctor. | [[Encounter Event->External Participant.Name]] [[Encounter Event->External Participant.Role]] will be set to REFERRER. | ||||
PV1-8.2 | Family name | Smith | |||||
PV1-8.3 | Given name | William | |||||
PV1-8.4 | Middle names | ||||||
PV1-8.6 | Prefix | Dr | |||||
PV1-9 | O | Consulting doctor. | [[Encounter Event->External Participant.Name]] [[Encounter Event->External Participant.Role]] will be set to CONSULTANT. | ||||
PV1-9.2 | Family name | Foster | |||||
PV1-9.3 | Given name | Terry | |||||
PV1-9.4 | Middle names | ||||||
PV1-9.6 | Prefix | Mr | |||||
PV1-10 | O | Hospital service. See our information on code sets for more details. | [[Encounter Event.Specialty]] | ||||
PV1-10.1 | Hospital service code | ||||||
PV1-19 | R | Visit ID. This is used by PKB to uniquely identify an Encounter. | [[Encounter.External Encounter ID]] | ||||
PV1-19.1 | Visit ID | V00001 | |||||
PV1-44 | O | Admit datetime. Timestamp of admission for the entire Encounter. | [[Encounter Event.Timestamp]] If not provided, MSH-7 will be used. | ||||
PV1-44.1 | Admit timestamp | 201508011200 | |||||
PV1-45 | Discharge datetime. Timestamp of discharge for the entire Encounter. | Ignored by an A01 |
Examples
MSH|^~\&|SendingApp|SendingFacility|HL7API|PKB|20160102101112||ADT^A01|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|
PV1|1|I|^^^^^^^^My Ward||||^Jones^Stuart^James^^Dr^|^Smith^William^^^Dr^|^Foster^Terry^^^Mr^||||||||||V00001|||||||||||||||||||||||||201508011000|201508011200
...