Data Model
sparseware edited this page Mar 19, 2015
·
2 revisions
#Data Model
Please see the demo data files in the hub/main directory to see examples of data that the client handles.
The tables below describe the data model that is utilized by the client. This is the data the client expects to receive from the middleware. The data model is not intended to be comprehensive. Its goal is provide the elements that are critical and useful to the clinician.
The fields are listed in the order they are expected to be returned in, when using a CSV format. For date and times, the preferred format is:
yyyy-MM-dd'T'HH:mm:ss.SSSZZZZZ
The other supported formats are:
yyyy-MM-dd'T'HH:mm
yyyy-MM-dd'T'HH:mmzzz
| Field | Description | Linked Data |
|---|---|---|
| id | the patient’s id | |
| name | the patient’s name | |
| dob | the patients date of birth | |
| gender | the patient’s gender | |
| mrn | the patient’s medical record number | |
| provider_name | the name of patient's provider | the record id of the provider |
| encounter_date | the patient's encounter date | |
| encounter_reason | the patient's encounter reason | |
| location | the location of the patient | |
| rm_bed | the room and bed the patient is in | |
| photo | the relative path to the patient’s photo |
| Field | Description | Linked Data |
|---|---|---|
| id | the patient's id | |
| name | the patient's name | |
| dob | the patients date of birth | |
| gender | the patient’s gender | |
| mrn | the patient’s medical record number | |
| provider_id | the id of patient's provider | |
| provider_name | the name of patient's provider | |
| encounter_date | the patient's encounter date | |
| encounter_reason | the patient's encounter reason | |
| location_id | the patient's location id | |
| location | the patient's location | |
| rm_bed | the patient's room and bed | |
| attending_id | the id of patient's attending physician | |
| attending_name | the patient's attending physician name | |
| language | the patient's language | |
| photo | the relative path to the patient’s photo | |
| relationship | the patient's relationship with current user | |
| code_status | the patient's code status | |
| code_status_short | the patient's code status in short form (e.g. DNR) | |
| wt | the patient's weight | |
| ht | the patient's height | |
| io_in | the patient's input for the current time period | |
| io_out | the patient's output for the current time period | |
| allergies | allows you to send the patient's allergies when the patient is selected | |
| alerts | allows you to send the patient's clinical alerts when the patient is selected | |
| flags | allows you to send the patient flags when the patient is selected |
| Field | Description | Linked Data |
|---|---|---|
| date | the date an time of the result | the record id(can be null) |
| vital | the name of the vitals result | a unique id for the result type; the value is not significant to the client, only that all vitals of that type are identified with this value |
| result | the result; abnormal values should be marked telling the client how to display it | |
| unit | the unit of the result | |
| range | the valid range for the result | |
| sort_order | a string used to sort the results for display | |
| result_id | a system specific id for the result |
| Field | Description | Linked Data |
|---|---|---|
| date | the date an time of the result | the record (can be null) |
| lab | the name of the lab result | a unique id for the result type; the value is not significant to the client, only that all vitals of that type are identified with this value |
| result | the result; abnormal values should be marked telling the client how to display it. The value can be an embedded result document that is base64 encoded. The configuration information sent to the client at login determines if documents are in | lined or can be retrieved using the record id |
| unit | the unit of the result | |
| range | the valid range for the result | |
| id_document | true if the result is a document; false otherwise | |
| category | a category for the result used to group results | |
| panel | the panel that the result is part of | |
| sort_order | a string used to sort the results for display | |
| result_id | a system specific id for the result | |
| comment | a comment (base64 encoded) for the result |
| Field | Description | Linked Data |
|---|---|---|
| type | the type of order; the value is not significant to the client, only that all orders of that type are identified with this value | the record id for the order |
| ordered_item | the name item that was order | the record id of the item |
| infusion_rate | infusion rate if the order is an id | |
| start_date | the start date of the order | |
| stop_date | the stop date of the order | |
| refills | the number of refills | |
| tot_dose | the total dosage ordered | |
| unit_per_dose | the units per dose | |
| status | the status of the order | |
| lastfill | the last time the order was filled | |
| directions | the directions | |
| notes | any notes associated with the order | |
| prn | true if this is a PRN order; false otherwise | |
| category | the category for the order | |
| clinical_category | the clinical category for a medication | |
| provider | the ordering provider | the record id of the provider |
| signed | true if the order is signed; false otherwise | |
| flagged | true if the order is flagged; false otherwise |
| Field | Description | Linked Data |
|---|---|---|
| drug | the ordered medication | |
| status | the status of the order |
| Field | Description | Linked Data |
|---|---|---|
| date | the date an time of the result | the record id |
| title | the title of the document | |
| author | the document’s author | record id of the author |
| status | the status of the document | |
| type | the type of document | |
| has_attachments | true if the document has attachments; false otherwise | |
| parent_id | the document id of this document’s parent if it is a child document |