...
| HL7 API | FHIR API | REST API | Web (Patient) | ||
Summary of interactions | ||||||
Read |
|
| ||||
Write |
|
|
| |||
Attributes | ||||||
Class | Enum |
|
|
| Inbox page | |
Timestamp | Timestamp | The document timestamp. |
| Conversation page | ||
Document Type | Enum |
|
|
| ||
Status | Enum |
|
|
|
| |
Planned Postal Date | Timestamp | When this document would need to be posted. This field forms part of the Mail Management workflow. |
|
|
| |
Delay | Number | The number of days for which the content of the data point should be hidden from the patient and carers. | Conversation page A placeholder is shown to the patient and carers, letting them know when the content will be displayed. | |||
Encounter
Class Diagram
...
| HL7 API | FHIR API | REST API | Web (Patient) | ||
Summary of interactions | ||||||
Read |
| /v1/tests/results/forPatient/byTestIds | ||||
Write |
|
| ||||
Attributes | ||||||
Service | String | The overarching service of the lab results. |
|
| Lab result listings page | |
Test Code | String | The code of the test that was performed. This captures the raw value as provided by the input source, for example from an HL7 message. It is not populated when the user enters a result directly into the PKB web UI, which asks them to select a type from a dropdown. |
|
|
| |
Test Coding System | String | The coding system of the test that was performed. This captures the raw value as provided by the input source, for example from an HL7 message. It is not populated when the user enters a result directly into the PKB web UI, which asks them to select a type from a dropdown. |
|
|
| |
Timestamp | Timestamp | The clinically relevant timestamp of the lab result. |
| Lab result details page | ||
Value | Number | The result value. This will not always be populated. If the result does not parse as a number, or if numeric values are not valid for this test type, then Value Text will be populated instead. Alternatively, if an HL7 message contained the single textual report content pattern, then the text of that report will be populated in the Comments attribute, rather than the Value. |
|
| Lab results details page | |
Value Text | String | The textual result value. This will not always be populated. If a numeric Value has been assigned then the textual representation is not stored. |
|
| Lab results details page | |
Comments | String | Any comments associated with the lab result. |
|
| Lab result details page | |
Range Low | Number | The lowest expected value for this lab result. |
|
| Lab result details page | |
Range Low Inclusive | Boolean | Whether or not the Range Low value is inclusive. |
|
|
| |
Range High | Number | The highest expected value for this lab result. |
|
| Lab result details page | |
Range High Inclusive | Boolean | Whether or not the Range High value is inclusive. |
|
|
| |
Textual Range | String | A textual range is used to indicate the expected outcome for a non-numeric test result. |
|
| Lab results details page | |
Comparator | Enum |
|
|
| Lab results details page | |
Delay | Number | The number of days for which the content of the data point should be hidden from the patient and carers. | Lab result details page A placeholder is shown to the patient and carers, letting them know when the content will be displayed. | |||
Entity: Local Test Type
| HL7 API | FHIR API | REST API | Web (Patient) | ||
Summary of interactions | ||||||
Read |
|
|
|
| ||
Write |
|
|
| |||
Attributes | ||||||
ID | Number | An ID for this Local Test Type. |
|
|
|
|
Source Organisation | Ref : [[Organisation.Public ID]] | The organisation which sent this lab result. |
|
|
|
|
Test Code | String | The test code. |
|
|
|
|
Test Coding System | String | The coding system from which the test code was drawn. |
|
|
|
|
Units | String | The units for the test. |
|
|
|
|
Test Name | String | The display name provided for the most recently received test result of this type. |
|
|
|
|
Service Name | String | The display name provided for the service (a.k.a. panel) which contained the most recently received test result of this type. |
|
|
|
|
Expected Value Type | Enum |
|
|
|
|
|
...
| HL7 API | FHIR API | REST API | Web (Patient) | ||
Summary of interactions | ||||||
Read |
|
| ||||
Write |
|
| ||||
Attributes | ||||||
Timestamp | Timestamp | The clinically relevant timestamp of the report. |
| Radiology report listing page | ||
Title | String | A title for the report. |
|
| Radiology report listing page | |
Description | String | The report contents. |
|
| Radiology report details page | |
Enterer Location | String | A description of the location of the person who entered the request. |
|
|
| |
Delay | Number | The number of days for which the content of the data point should be hidden from the patient and carers. | Radiology report details page A placeholder is shown to the patient and carers, letting them know when the content will be displayed. | |||
Symptom
Class Diagram
...