Entity: Document

Class Diagram

Document

Display

Documents appear in the Events & messages page of a patient's record.

Please see the manual for more information.

Solutions

PKB solutions related to this data type:

Mappings

 

HL7 API

FHIR API

(Customer boxes support full CRUD)

Web

Custom REST API

 

 

Facade (STU3)

Aggregated (R4)

 

 

Summary of interactions

Create

T02(document)

 

 

 

 

Read

 

/DocumentReference

 

Events & messages

/messages/after/<time>

/attachments/id

Update

T02(document)

 

 

 

 

Delete

T11

 

 

 

 

Entity: Document - Extends: Data Point

Class Enum

  • IN_PATIENT

  • OUT_PATIENT

  • AMBULATORY

  • EMERGENCY

  • HOME

  • FIELD

  • DAYTIME

  • VIRTUAL

  • OTHER

PV1-2.1 (MDM T02/document)

 

 

Shown.

 

Timestamp Timestamp

The document timestamp.

TXA-8,7,6,4

DocumentReference.created

 

Shown.

 

Document Type Enum

  • ADMISSION_TCI_LETTER

  • ALERT_NOTIFICATION

  • APPOINTMENT_LETTER

  • BIRTH_REPORT

  • CLINIC_LETTER

  • DISCHARGE_LETTER

  • DISCHARGE_SUMMARY

  • MULTI_DISCIPLINARY_TEAM_MEETING_NOTES

  • REFERRAL_LETTER

TXA-2.1 (MDM T02/document)

DocumentReference.type

 

Shown.

 

Status Enum

  • READ

  • UNREAD

 

document-status
search param: document-status

 

The colour of the conversation indicates whether or not the message has been read.

 

Planned Postal Date Timestamp

When this document would need to be posted. This field forms part of the Mail Management workflow.

ZPM-1

 

 

Not shown.

 

Delay Number

The number of days for which the content of the data point should be hidden from the patient and carers.

OBX-13 (MDM T02/document)

 

 

A placeholder is shown to the patient and carers, letting them know when the content will be displayed.