Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Please click through to the Data Model to explore the presentation of these entities in the web interface.

...

Message

Entity

Matching Criteria

Behaviour (Matched)

Behaviour (Not Matched)

A08

[[Encounter]]

[[Encounter.External Encounter ID]] as derived from PV1-19.1

The [[Encounter Event]] and any linked [[Appointment]] will be handled as indicated below.

No action.

 

[[Encounter Event]]

The most recent [[Encounter Event]] on the [[Encounter]] will be updated by default.

The default matching can be overridden by including a custom ZVN segment.  In this case [[Encounter Event.Type]] is derived from ZVN-1.1 with matching rules:

ZVN-1.1 = A01 (Type = ADMIT)
ZVN-1.1 = A02 (Type = TRANSFER)
ZVN-1.1 = A03 (Type = DISCHARGE)
ZVN-1.1 = A05 (Type = PRE_ADMIT)
ZVN-1.1 = A14 (Type = PENDING_ADMIT)

If ZVN-1.1 is A02 then the matched [[Encounter Event.Type]] is TRANSFER.  In this instance ZVN-6 will be used to match to a specific transfer on [[Encounter Event.Timestamp]].  If ZVN-6 is not provided then the most recent transfer will be updated instead.

The matched [[Encounter Event]] is updated with the information in this message if it differs from the details already held.

If there is an existing admission [[Encounter Event]] or discharge [[Encounter Event]] then these will be updated separately if PV1-44.1 and PV1-45.1 are provided in the message and they differ from the timestamps already held.

No action.

 

[[Appointment]]

PKB maintains an internal link joining the [[Encounter Event]] to the [[Appointment]]. No additional external IDs required.

If the matched [[Encounter Event.Type]] is a PRE_ADMIT or PENDING_ADMIT then the associated [[Appointment]] will be updated.

 No action.

...

Segment

Field

Component

Description

Example

Data Model

PV1

 

 

 

 

 


[ PV1-44 ]


Admit datetime. Timestamp of admission for the entire Encounter.


 


PV1-44.1

Admit timestamp

201902011200

[[Encounter Event.Timestamp]]  : Admission Event

If not provided, no update is performed.

 

[ PV1-45 ]

 

Discharge datetime. Timestamp of discharge for the entire Encounter.

 

 

 

 

PV1-45.1

Discharge timestamp

201902031200

[[Encounter Event.Timestamp]]  : Discharge Event

If not provided, no update is performed.

[ ZVN ]



Bespoke PKB segment used to match the update to a previously received encounter event.

Example usage for a ZVN:

  • Your source A08 messages track the original event and you want that association to be communicated to PKB. E.g. the source knows that the A08 is an update to the admission and the A08 should thus specifically update the admission event in PKB.  Set ZVN-1.1 to ‘A01’.


 

 

 [ZVN-1]

 

Event Type Code

 

 

 

 

 ZVN-1.1

Event code.  

This field is used to match this update to a specific event.  Options: A01, A02, A03, A05, A14

 A01

Matched to  [[Encounter Event.Type]]

 

[ ZVN-6 ]

 

Transfer Event Occurred

 

 

 

 

ZVN-6.1

Transfer Event Occurred

This field can be used to match this update to a specific transfer event. If ZVN-1.1 is 'A02' then this field will be checked to determine if there is a transfer event matching the timestamp provided.

201902011200

[[Encounter Event.Timestamp]]  : Transfer Event

If not provided or not matched this field is ignored

...

Response

PKB will respond with a standard HL7 acknowledgement.

PKB customer sites: deploy | developer | information governance | procurement | manual

...