...
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. | ||||||
TXA | We identify the [[Document.Timestamp]] value by trying the following fields in order: TXA-8, TXA-7, TXA-6, TXA-4. If none are provided, MSH-7 will be used. | ||||||
TXA-2 | R | Document type | |||||
TXA-2.1 | Document type. Allowed values for this field are defined in Code Set PKBCS05, but you must not use CP since that will cause the document to be handled as a care plan. | DS | [[Document.Document Type]] | ||||
TXA-4 | O | Activity timestamp | |||||
TXA-4.1 | Activity timestamp | 201508010900 | [[Document.Timestamp]] if neither TXA-8, TXA-7, nor TXA-6 were provided. | ||||
TXA-5 | O | Primary activity provider. | [[Document->Source.Source Text]] | ||||
TXA-5.2 | Family name | Foster | |||||
TXA-5.3 | Given name | John | |||||
TXA-5.4 | Middle names | Harry | |||||
TXA-5.6 | Title | Dr | |||||
TXA-6 | O | Origination timestamp | |||||
TXA-6.1 | Origination timestamp | 201508010910 | [[Document.Timestamp]] if neither TXA-8 nor TXA-7 were provided. | ||||
TXA-7 | O | Transcription timestamp | |||||
TXA-7.1 | Transcription timestamp | 201508010920 | [[Document.Timestamp]] if TXA-8 was not provided. | ||||
TXA-8 | O | Edit timestamp | |||||
TXA-8.1 | Edit timestamp | 201508010930 | [[Document.Timestamp]] | ||||
TXA-12 | R | Unique document number | |||||
TXA-12.1 | Unique document number | MYDOC00001 | [[Document.External Data Point ID]] | ||||
TXA-16 | O | Filename. If provided, will be used instead of the default for the name of the downloadable attachment. | |||||
TXA-16.1 | Filename | mydoc.rtf | [[Document->Attachment.Filename]] | ||||
TXA-17 | R | Document completion status. | |||||
TXA-17.1 | Document completion status. Must be "AU" for authenticated (this is not an in-progress or tentative document). | AU | |||||
OBX | Observation or result. This contains the actual document content. | ||||||
OBX-2 | R | ||||||
OBX-2.1 | Only "ED" supported. | ED | |||||
OBX-5 | R | Value | |||||
OBX-5.2 | Supported values are TEXT or APPLICATION | TEXT | |||||
OBX-5.3 | Supported values are: RTF, PDF or MSWORD. | RTF | |||||
OBX-5.4 | Must be either "Base64" or "A", to match the data supplied in OBX-5.5. | Base64 | |||||
OBX-5.5 | If encoded in "A" format, this data must be escaped using the standard HL7 escape strings. | e1xydGYxXGFkZWZ... | This value set in [[Document->Attachment.Content]] after being processed according to OBX-5.4 | ||||
OBX-13 | O | Custom access rules. Currently supported: "{patientDelay:NUMBERdays}" with any whole number in place of "NUMBER" (no spaces). The patient will see that the message has arrived, but the contents will not be revealed until the set number of days past the date/time of the message have passed. If this field is not specified the patient will be able to see the message immediately. | |||||
OBX-13.1 | Custom access rules | {patientDelay:3days} | |||||
[ PV1 ] | |||||||
PV1-2 | O | Patient class | |||||
PV1-2.1 | Patient class. Allowed values are defined in Code Set PKBCS04. | I | [[Document.Class]] | ||||
PV1-10 | O | Hospital service. See our notes on code sets for more information on our handling of coded data. | |||||
PV1-10.1 | Hospital service code | SPEC_03 | [[Document.Specialty]] | ||||
[ ZPM ] | Custom segment for a partner hybrid mail solution to provide postal metadata | ||||||
ZPM-1 | O | Postal metadata | |||||
ZPM-1.1 | Planned Postal Date | 20150815121314 | [[Document.Planned Postal Date]] |
...