...
| HL7 API | FHIR API | REST API | Web (Patient) | ||
Summary of interactions | ||||||
Read |
|
| Various, depending on data type | |||
Write |
|
| Various, depending on data type | |||
Attributes | ||||||
Public ID | String | The ID of the attachment. |
|
|
|
|
Filename | String | The filename of the attachment. | OBX-3.2 (ORU R01/radiology) |
|
| Various, depending on data type |
Content | Binary | The content of the attachment. |
| Returned in the download stream | Various, depending on data type | |
Media Type | String | The type of media contained in the content. |
|
|
| |
...
HL7 API | FHIR API | REST API | Web (Patient) | |||
Summary of interactions | ||||||
Read | /users/self | |||||
Write | ||||||
Attributes | ||||||
Middle Names | String | Any middle names of the patient. |
| Profile page | ||
Address Line 1 | String | First line of the address. |
| Profile page | ||
Address Line 2 | String | Second line of the address. |
| Profile page | ||
City | String | The nearest city or town. |
| Profile page | ||
State | String | The state. |
| Profile page | ||
Country | String | The country. |
| Profile page | ||
Postal Code | String | The postal code. |
| Profile page | ||
Date of Birth | Local Date | Date of birth. |
| Profile page | ||
Death Timestamp | Timestamp | When the patient died. |
|
| ||
Gender | Enum | This is the administrative gender of the patient.
|
| Profile page | ||
Language | Enum | The primary language of the patient. |
|
| Language dropdown shown in the footer of every page. | |
Time Zone | Enum | The patient's current preferred time zone. This will be used to localise times within the web interface. |
|
|
| Profile page |
Skype ID | String | How to contact the patient on Skype. |
|
|
| Profile page |
Phone | String | The phone number of the patient. |
| Profile page | ||
Status | Enum | The status of the patient. |
|
|
| |
Registered | Boolean | Whether or not the patient has registered with PKB. If a patient is registered, they have the ability to log into their account. |
|
|
|
|
Sharing Disabled | Boolean | Whether or not the patient has requested Sharing Disabled. |
|
|
| |
Access Frozen | Boolean | Whether or not access to this medical record has been frozen. |
|
|
|
|
Entered Timestamp | Timestamp | Flexibly used, depending on the type of data. It is broadly intended to capture the timestamp when the information was entered into the originating system. |
|
|
| |
Persisted Timestamp | Timestamp | The timestamp when the information was persisted in PKB. |
|
|
|
|
...
| HL7 API | FHIR API | REST API | Web (Patient) | ||
Summary of interactions | ||||||
Read |
| |||||
Write |
|
| ||||
Attributes | ||||||
Public ID | String | An ID for this Consent Record. |
|
|
| |
General Health Granted | Boolean | Whether or not the patient has granted access to the general health portion of their medical record. |
|
| ||
Mental Health Granted | Boolean | Whether or not the patient has granted access to the mental health portion of their medical record. |
|
| ||
Sexual Health Granted | Boolean | Whether or not the patient has granted access to the sexual health portion of their medical record. |
|
| ||
Social Care Granted | Boolean | Whether or not the patient has granted access to the social care portion of their medical record. |
|
| ||
Reason Code | Enum |
|
|
|
|
|
Reason Text | String | A description justifying why these consent values were set. |
|
|
|
|
Discharged | Boolean | Indicates whether the actor is currently providing care to the patient. |
|
| ||
Identifiers
Class Diagram
...
| HL7 API | FHIR API | REST API | Web (Patient) | ||
Summary of interactions | ||||||
Read |
|
| ||||
Write |
|
| ||||
Attributes | ||||||
Allergen | CodeableConcept | The allergen. |
| Allergy listing page | ||
Onset Timestamp | Timestamp | When the symptoms began. |
| Allergy listing page | ||
Reactions | CodeableConcept List | The reactions to the allergen. |
| Allergy listing page | ||
Severity | CodeableConcept | How severe the reaction to the allergen is. |
| Allergy listing page | ||
...
| HL7 API | FHIR API | REST API | Web (Patient) | ||
Summary of interactions | ||||||
Read |
|
| ||||
Write |
|
| ||||
Attributes | ||||||
Type | Coding | The type of appointment. |
|
| Appointment details page | |
Start Timestamp | Timestamp | When the appointment starts. |
| Appointment listing page | ||
End Timestamp | Timestamp | When the appointment ends. |
| Appointment details page | ||
Subject | String | A brief reason for the appointment. |
| Appointment listings page | ||
Description | String | A longer explanation of the appointment. |
| Appointment details page | ||
Location | String | Where the appointment is to be held. |
| Appointment details page | ||
Status | Enum |
|
| Appointment listings page | ||
...
| HL7 API | FHIR API | REST API | Web (Patient) | ||
Summary of interactions | ||||||
Read |
|
| /v2-beta/careplans/[patientId] | |||
Write |
| |||||
Attributes | ||||||
Name | String | The name of the care plan. |
|
| Care plan listing page | |
Created Timestamp | Timestamp | The timestamp when the care plan was first created. |
|
| Care plan listing page | |
Last Edited Timestamp | Timestamp | The timestamp when the care plan was last edited. |
|
| Care plan listing page | |
Action Plan | String or Binary | The main body of the care plan. This can be plaintext, HTML or a PDF file. |
|
| Care plan details page | |
Green | String | An explanation of what to expect when the condition is under control. |
|
|
| Care plan details page |
Amber | String | An explanation of what might need attention. |
|
|
| Care plan details page |
Red | String | An explanation of what needs urgent attention. |
|
|
| Care plan details page |
...
| HL7 API | FHIR API | REST API | Web (Patient) | ||
Summary of interactions | ||||||
Read |
|
| ||||
Write |
|
| ||||
Attributes | ||||||
Diagnosis | CodeableConcept | The diagnosis. |
| Diagnosis listing page | ||
Start Timestamp | Timestamp | When the condition began. |
| Diagnosis listing page | ||
End Timestamp | Timestamp | When the condition ended. |
|
| Diagnosis listing page | |
Details | String | Additional information about this diagnosis. |
|
| Diagnosis details page | |
...
| 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. |
|
|
| |
...
| HL7 API | FHIR API | REST API | Web (Patient) | ||
Summary of interactions | ||||||
Read |
|
|
| |||
Write |
|
| ||||
Attributes | ||||||
Subject | String | What the entry is about. |
|
|
|
|
Entry | String | The content of the entry. |
|
|
|
|
...
| 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 | |
...
| 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 |
| /v1/measurements | ||||
Attributes | ||||||
Name | String | The name of the type of measurement. |
|
|
|
|
Code System | String | The code system used. |
|
|
| Measurement listing page |
Code of Whole | String | The code representing the overall measurement. |
|
|
|
|
Code | String | The code of the first value, if this is a multi-valued measurement. |
|
|
|
|
Code2 | String | The code of the second value, if this is a multi-valued measurement. |
|
|
|
|
Unit | String | The units of the value. |
|
|
| Measurement listing page |
Unit2 | String | The units of the second value. |
|
|
|
|
Timestamp | Timestamp | The timestamp when the measurement was taken. |
|
| Measurement details page | |
Value | Number | The value of the measurement. |
|
| Measurement listing page | |
Value2 | Number | The second value, if relevant. This is intended to allow two related measurements to be grouped together, e.g.diastolic and systolic blood pressure. This is not a second reading of the first value. |
|
| Measurement listing page | |
Value Non-Numeric | String | The value of the measurement if it is not numeric. |
|
|
| Measurement listing page |
...
| HL7 API | FHIR API | REST API | Web (Patient) | ||
Summary of interactions | ||||||
Read |
|
| /v1/medications | |||
Write |
| |||||
Attributes | ||||||
Status | Enum |
|
|
|
|
|
Substance | CodeableConcept | The medication. |
|
| Medication listing page | |
Start Timestamp | Timestamp | When the medication was started. |
|
| Medication listing page | |
End Timestamp | Timestamp | When the medication was finished. |
|
| Medication listing page | |
Frequency Text | String | How frequently the medication should be taken. |
|
| Medication listing page | |
Frequency Value | Number | A representation of how frequently the medication should be taken, when combined with Frequency Units. |
|
|
| |
Frequency Units | Enum |
|
|
|
|
|
Frequency Priority | Enum | Can be used to capture a frequency instruction of:
|
|
|
|
|
Dose Value | Number | How much should be taken. |
|
| Medication listing page | |
Dose Units | CodeableConcept | The units of the Dose Value. |
|
| Medication listing page | |
Instructions | String | How to take the medication. |
|
| Medication listing page | |
...
| 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. |
|
|
| |
...
| HL7 API | FHIR API | REST API | Web (Patient) | ||
Summary of interactions | ||||||
Read |
|
| /symptomReports/all | |||
Write |
|
| ||||
Attributes | ||||||
Symptom | CodeableConcept | The symptom which is being reported. |
|
|
|
|
Timestamp | Timestamp | Timestamp for the symptom report. |
|
|
|
|
Severity | Enum |
|
|
|
|
|
...