FHIR Relational Schema Data Dictionary
allergy_intolerance
AllergyIntolerance describes risk of harmful or undesirable, physiological response which is unique to an individual and associated with exposure to a substance.
Column Name | Data Type | Nullable | References | Description |
---|---|---|---|---|
id | varchar | No | Resource ID (UUID) of the AllergyIntolerance | |
version | varchar | No | Current version of this resource. This indicates whether the resource has been updated. | |
last_updated | timestamp | No | Timestamp this resource was last updated, formatted as ISO 8601 timestamp | |
clinical_status | varchar | The clinical status code value of the allergy or intolerance. Possible values: active | inactive | resolved | ||
verification_status | varchar | Assertion about certainty associated with the propensity, or potential risk, of a reaction to the identified substance. Possible values: unconfirmed | confirmed | refuted | entered-in-error | ||
type | varchar | Underlying mechanism (if known). Possible values: allergy | intolerance | ||
category | varchar | Category of the identified substance. Possible values: food | medication | environment | biologic | ||
criticality | varchar | Estimate of the potential clinical harm, or seriousness, of the reaction to the identified substance. Possible values: low | high | unable-to-assess | ||
allergy_intolerance_code_id | varchar | allergy_intolerance_code | ID of the allergy intolerance code | |
patient_id | varchar | patient | ID of the Patient who the sensitivity is for | |
onset | varchar | When allergy or intolerance was identified | ||
recorded_date | timestamp | Date first version of the resource instance was recorded | ||
last_occurrence | timestamp | Date(/time) of last known occurrence of a reaction | ||
builder_id | varchar | ID of the Builder account that provided this data | ||
upid | varchar | Unique Patient Identifier (UPID) of the patient that this resource is associated with | ||
created_at | timestamp | Timestamp when this resource was first recorded in this system | ||
resource_json | varchar | No | Original JSON document for this resource | |
data_source | varchar | Name of the data partner network that provided this data |
allergy_intolerance_code
This table holds the primary keys of all unique AllergyIntolerance code groups. A code group captures the set of codes representing a particular allergy or intolerance. Individual codings within each group are in the allergy_intolerance_code_coding table.
Column Name | Data Type | Nullable | References | Description |
---|---|---|---|---|
id | varchar | No | ID of code | |
display | varchar | Plain text representation of the allergy intolerance code. This field comes from the "text" field in the codeable concept group |
allergy_intolerance_code_coding
This table contains individual coding values for each AllergyIntolerance code group.
Column Name | Data Type | Nullable | References | Description |
---|---|---|---|---|
allergy_intolerance_code_id | varchar | allergy_intolerance_code | ID of the AllergyIntolerance Code | |
system | varchar | URI of the terminology system, for example http://snomed.info/sct | ||
code | varchar | Code symbol defined by the terminology system | ||
display | varchar | Human-readable string representing the code |
allergy_intolerance_identifier
This is a bridge table that joins the allergy_intolerance table to the identifier table.
Column Name | Data Type | Nullable | References | Description |
---|---|---|---|---|
allergy_intolerance_id | varchar | No | allergy_intolerance | ID of the AllergyIntolerance that this identifier belongs to |
identifier_id | varchar | identifier | ID of the Identifier |
allergy_intolerance_note
This table contains freeform text notes with extra information about the AllergyIntolerance that is not captured in other attributes.
Column Name | Data Type | Nullable | References | Description |
---|---|---|---|---|
allergy_intolerance_id | varchar | No | allergy_intolerance | ID of the AllergyIntolerance that this note belongs to |
text_markdown | varchar | The annotation - text content (as markdown) |
allergy_intolerance_reaction
Details about each adverse reaction event linked to exposure to the identified substance.
Column Name | Data Type | Nullable | References | Description |
---|---|---|---|---|
allergy_intolerance_id | varchar | No | allergy_intolerance | ID of the AllergyIntolerance that this reaction belongs to |
allergy_intolerance_reaction_manifestation_id | varchar | allergy_intolerance_reaction_manifestation | ID of the AllergyIntolerance reaction manifestation | |
onset | timestamp | Date(/time) when manifestations showed | ||
severity | varchar | Severity of the allergy or intolerance as a whole. Possible values: mild | moderate | severe |
allergy_intolerance_reaction_manifestation
This table captures concept groups thta represent the clinical symptoms and/or signs that are observed or associated with the adverse reaction event. Individual codings within each group are in the allergy_intolerance_reaction_manifestation_coding table.
Column Name | Data Type | Nullable | References | Description |
---|---|---|---|---|
id | varchar | No | ID of reaction manifestation | |
display | varchar | Plain text representation of the allergy intolerance reaction manifestation. This field comes from the "text" field in the codeable concept group |
allergy_intolerance_reaction_manifestation_coding
This table contains individual coding values for each reaction manifestation group.
Column Name | Data Type | Nullable | References | Description |
---|---|---|---|---|
allergy_intolerance_reaction_manifestation_id | varchar | allergy_intolerance_reaction_manifestation | ID of the AllergyIntolerance reaction manifestation | |
system | varchar | URI of the terminology system | ||
code | varchar | Code symbol defined by the terminology system | ||
display | varchar | Human-readable string representing the code |
appointment
A FHIR Appointment represents a booking of a healthcare event among patient(s), practitioner(s), related person(s) and/or device(s) for a specific date/time. This may result in one or more Encounter(s).
Column Name | Data Type | Nullable | References | Description |
---|---|---|---|---|
id | varchar | No | Resource ID (UUID) of the Appointment | |
version | varchar | No | Current version of this resource. This indicates whether the resource has been updated. | |
last_updated | timestamp | No | Timestamp this resource was last updated, formatted as ISO 8601 timestamp | |
status | varchar | Overall status of the appointment. Each of the participants separately has their own participation status. Possible values: proposed | pending | booked | arrived | fulfilled | cancelled | noshow | entered-in-error | checked-in | waitlist | ||
appointment_type_id | varchar | appointment_type | Id of the Appointment Type encoding the style of appointment or patient that has been booked in the slot (not service type). | |
reason_reference_condition_id | varchar | condition | ID of a Condition that is the reason the appointment is to take place | |
reason_reference_display | varchar | Display of a reason reference the appointment is to take place | ||
description | varchar | The brief description of the appointment as would be shown on a subject line in a meeting request, or appointment list. Detailed or expanded information should be put in the comment field. | ||
start_time | timestamp | When appointment is to take place | ||
end_time | timestamp | When appointment is to conclude | ||
minutes_duration | int | Number of minutes that the appointment is to take. This can be less than the duration between the start and end times. For example, where the actual time of appointment is only an estimate or if a 30 minute appointment is being requested, but any time would work. Also, if there is, for example, a planned 15 minute break in the middle of a long appointment, the duration may be 15 minutes less than the difference between the start and end. | ||
created | timestamp | The date that this appointment was initially created. This could be different to the meta.lastModified value on the initial entry, as this could have been before the resource was created on the FHIR server, and should remain unchanged over the lifespan of the appointment. | ||
comment | varchar | Additional comments about the appointment | ||
participant_patient_id | varchar | patient | ID of a Patient that is the participant involved in this appointment. If multiple patients are involved, only the first is shown in this column. | |
participant_patient_status | varchar | Participation status of the patient. Possible values: accepted | declined | tentative | needs-action | ||
participant_patient_required | varchar | Whether this patient is required to be present at the meeting. This covers a use-case where two doctors need to meet to discuss the results for a specific patient, and the patient is not required to be present. Possible values: required | optional | information-only | ||
builder_id | varchar | ID of the Builder account that provided this data | ||
upid | varchar | Unique Patient Identifier (UPID) of the patient that this resource is associated with | ||
created_at | timestamp | Timestamp when this resource was first recorded in this system | ||
resource_json | varchar | No | Original JSON document for this resource | |
data_source | varchar | Name of the data partner network that provided this data |
appointment_identifier
This is a bridge table that joins the appointment table to the identifier table
Column Name | Data Type | Nullable | References | Description |
---|---|---|---|---|
appointment_id | varchar | No | appointment | ID of the Appointment that this identifier belongs to |
identifier_id | varchar | identifier | ID of the Identifier |
appointment_participant_location
This table contains a list of locations involved in each appointment. These entries come from the Appointment.participant array in the FHIR resource, filtered down to the entries that are locations.
Column Name | Data Type | Nullable | References | Description |
---|---|---|---|---|
appointment_id | varchar | No | appointment | ID of the Appointment to |
location_id | varchar | location | Location that is involved in the appointment | |
status | varchar | Possible values: accepted | declined | tentative | needs-action |
appointment_participant_practitioner
This table contains a list of practitioners involved in each appointment. These entries come from the Appointment.participant array in the FHIR resource, filtered down to the entries that are practitioners.
Column Name | Data Type | Nullable | References | Description |
---|---|---|---|---|
appointment_id | varchar | No | appointment | ID of the Appointment that this participant practitioner belongs to |
appointment_participant_practitioner_type_id | varchar | patient | ID of the practitioner type | |
practitioner_id | varchar | practitioner | Practitioner that is involved in the appointment | |
required | varchar | Possible values: required | optional | information-only | ||
status | varchar | Possible values: accepted | declined | tentative | needs-action |
appointment_participant_practitioner_type
This table contains the primary keys of all unique concepts representing roles of practitioners involved in an appoinment. Individual codings within each group are in the appointment_participant_practitioner_type_coding table,
Column Name | Data Type | Nullable | References | Description |
---|---|---|---|---|
id | varchar | No | ID of the concept encoding the type of the participant | |
display | varchar | Plain text representation of the appointment participant practitioner type. This field comes from the "text" field in the codeable concept group |
appointment_participant_practitioner_type_coding
This relation contains the individual coding values for each practitioner type
Column Name | Data Type | Nullable | References | Description |
---|---|---|---|---|
appointment_participant_practitioner_type_id | varchar | appointment_participant_practitioner_type | ID of the practitioner type | |
system | varchar | URI of the terminology system, usually http://terminology.hl7.org/CodeSystem/v3-ParticipationType | ||
code | varchar | Code symbol defined by the terminology system | ||
display | varchar | Human-readable string representing the code |
appointment_type
This table contains the primary keys of all unique concept groups that represnet the style of appointment or patient that has been booked in the slot. This is distinct from the service type. Individual codings within each group are in the appointment_type_coding table.
Column Name | Data Type | Nullable | References | Description |
---|---|---|---|---|
id | varchar | No | ID of the appointment type | |
display | varchar | Plain text representation of the appointment type. This field comes from the "text" field in the codeable concept group |
appointment_type_coding
This relation contains the individual coding values for each appointment type.
Column Name | Data Type | Nullable | References | Description |
---|---|---|---|---|
appointment_type_id | varchar | appointment_type | ID of the Appointment Type | |
system | varchar | URI of the terminology system, usually http://terminology.hl7.org/CodeSystem/v2-0276 | ||
code | varchar | Code symbol defined by the terminology system | ||
display | varchar | Human-readable string representing the code |
care_plan
A FHIR CarePlan describes the intention of how one or more practitioners intend to deliver care for a particular patient, group or community for a period of time, possibly limited to care for a specific condition or set of conditions.
Column Name | Data Type | Nullable | References | Description |
---|---|---|---|---|
id | varchar | No | Resource ID (UUID) of the CarePlan | |
version | varchar | No | Current version of this resource. This indicates whether the resource has been updated. | |
last_updated | varchar | No | Timestamp this resource was last updated, formatted as ISO 8601 timestamp | |
status | varchar | A code specifying the state of the CarePlan. Possible values: draft | active | on-hold | revoked | completed | entered-in-error | unknown | ||
intent | varchar | A code specifying the intent of the CarePlan. Possible values: proposal | plan | order | option | ||
title | varchar | Human-friendly name for the care plan | ||
description | varchar | A description of the scope and nature of the plan | ||
subject_patient_id | varchar | patient | ID of a Patient that is a subject to that CarePlan | |
builder_id | varchar | ID of the Builder account that provided this data | ||
upid | varchar | Unique Patient Identifier (UPID) of the patient that this resource is associated with | ||
created_at | timestamp | Timestamp when this resource was first recorded in this system | ||
resource_json | varchar | No | Original JSON document for this resource | |
data_source | varchar | Name of the data partner network that provided this data |
care_plan_activity
Identifies a planned action to occur as part of the plan. For example, a medication to be used, lab tests to perform, self-monitoring, education, etc.
Column Name | Data Type | Nullable | References | Description |
---|---|---|---|---|
care_plan_id | varchar | No | care_plan | ID of the CarePlan that this activity belongs to |
kind | varchar | A code specifying the state of the Activity. Possible values: Appointment | CommunicationRequest | DeviceRequest | MedicationRequest | NutritionOrder | Task | ServiceRequest | VisionPrescription | ||
care_plan_activity_code_id | varchar | care_plan_activity_code | ID of the code that encodes the type of planned activity | |
status | varchar | A code specifying the state of the Activity. Possible values: not-started | scheduled | in-progress | on-hold | completed | cancelled | stopped | unknown | entered-in-error | ||
scheduled_start | timestamp | The start date(/time) when activity is to begin | ||
scheduled_end | timestamp | The start date(/time) when activity is to end | ||
scheduled_string | varchar | A string describing when the activity is to occur, when not represented as a date/time | ||
location_id | varchar | location | ID of the Location where it should happen | |
performer_practitioner_id | varchar | practitioner | ID of the Practitioner that should perform that Activity | |
care_plan_activity_product_id | varchar | care_plan_activity_product | ID of the product that identifies the food, drug or other product to be consumed or supplied in the activity | |
daily_amount_value | decimal | Quantity expected to be consumed in a given day. Also known as daily dose. | ||
quantity_unit | varchar | Unit for the quantity expected to be supplied, administered or consumed by the subject | ||
quantity_value | decimal | Quantity expected to be supplied, administered or consumed by the subject | ||
description | varchar | Textual description of constraints on the intended activity occurrence, including relation to other activities. It may also include objectives, pre-conditions and end-conditions. Finally, it may convey specifics about the activity such as body site, method, route, etc. |
care_plan_activity_code
The activity code represents a detailed description of the type of planned activity; e.g. what lab test, what procedure, what kind of encounter. This table comtains the primary keys of all unique activity codes. Individual codings within each group are in the care_plan_activity_code_coding table.
Column Name | Data Type | Nullable | References | Description |
---|---|---|---|---|
id | varchar | No | ID of the activity code | |
display | varchar | Plain text representation of the care plan activity code. This field comes from the "text" field in the codeable concept group |
care_plan_activity_code_coding
This relation contains the individual coding values for each CarePlan activity code. These are codes for different types of procedures.
Column Name | Data Type | Nullable | References | Description |
---|---|---|---|---|
care_plan_activity_code_id | varchar | care_plan_activity_code | ID of the Care Plan Activity Code | |
system | varchar | URI of the terminology system, for example http://snomed.info/sct | ||
code | varchar | Code symbol defined by the terminology system | ||
display | varchar | Human-readable string representing the code |
care_plan_activity_product
Care plan activity products identify the food, drug or other product to be consumed or supplied in the activity. This table contains the primary keys of all unique activity products. Individual codings within each group are in the care_plan_activity_product_coding table.
Column Name | Data Type | Nullable | References | Description |
---|---|---|---|---|
id | varchar | No | ID of code | |
display | varchar | Plain text representation of the care plan activity product. This field comes from the "text" field in the codeable concept group |
care_plan_activity_product_coding
This relation contains the individual coding values for each product administered/supplied for the CarePlan activity. These are most commonly RxNorm codes.
Column Name | Data Type | Nullable | References | Description |
---|---|---|---|---|
care_plan_activity_product_id | varchar | care_plan_activity_product | ID of the Care Plan Activity Product Code | |
system | varchar | URI of the terminology system, for example http://www.nlm.nih.gov/research/umls/rxnorm | ||
code | varchar | Code symbol defined by the terminology system | ||
display | varchar | Human-readable string representing the code |
care_plan_goal
This table contains references to the goal resources that represent the goals that the care plan is intended to contribute towards meeting
Column Name | Data Type | Nullable | References | Description |
---|---|---|---|---|
care_plan_id | varchar | No | care_plan | ID of the CarePlan that this goal belongs to |
goal_id | varchar | goal | ID of the Goal |
care_plan_identifier
This is a bridge table that joins the care_plan table to the identifier table
Column Name | Data Type | Nullable | References | Description |
---|---|---|---|---|
care_plan_id | varchar | No | care_plan | ID of the CarePlan that this identifier belongs to |
identifier_id | varchar | identifier | ID of the Identifier |
care_plan_note
This table contains freeform text notes with extra information about the CarePlan that is not captured in other attributes
Column Name | Data Type | Nullable | References | Description |
---|---|---|---|---|
care_plan_id | varchar | No | care_plan | ID of the CarePlan that this note belongs to |
text_markdown | varchar | The annotation - text content (as markdown) |
care_team
A FHIR CareTeam includes all the people and organizations who plan to participate in the coordination and delivery of care for a patient.
Column Name | Data Type | Nullable | References | Description |
---|---|---|---|---|
id | varchar | No | Resource ID (UUID) of the CareTeam | |
version | varchar | No | Current version of this resource. This indicates whether the resource has been updated. | |
last_updated | timestamp | No | Timestamp this resource was last updated, formatted as ISO 8601 timestamp | |
status | varchar | Current status of the care team. Possible values: proposed | active | suspended | inactive | entered-in-error | ||
name | varchar | Name of the team, such as crisis assessment team | ||
subject_patient_id | varchar | patient | Who care team is for | |
encounter_id | varchar | encounter | The encounter during which this care team was created or to which the creation of this record is tightly associated. | |
period_start | timestamp | Start of the time period the team covers | ||
period_end | timestamp | End of the time period the team covers | ||
builder_id | varchar | ID of the Builder account that provided this data | ||
upid | varchar | Unique Patient Identifier (UPID) of the patient that this resource is associated with | ||
created_at | timestamp | Timestamp when this resource was first recorded in this system | ||
resource_json | varchar | No | Original JSON document for this resource | |
data_source | varchar | Name of the data partner network that provided this data |
care_team_identifier
This is a bridge table that joins the care_team table to the identifier table
Column Name | Data Type | Nullable | References | Description |
---|---|---|---|---|
care_team_id | varchar | No | care_team | ID of the CareTeam that this identifier belongs to |
identifier_id | varchar | identifier | ID of the Identifier |
care_team_participant
Identifies all people and organizations who are expected to be involved in the care team.
Column Name | Data Type | Nullable | References | Description |
---|---|---|---|---|
care_team_id | varchar | No | care_team | ID of the CareTeam that this participant belongs to |
care_team_participant_role_id | varchar | care_team_participant_role | ID of the role of participant | |
member_practitioner_id | varchar | practitioner | Who is involved | |
on_behalf_of_organization_id | varchar | organization | Organization of the practitioner | |
period_start | timestamp | Start of the time period of participant | ||
period_end | timestamp | End of the time period of participant |
care_team_participant_role
The care team participant role indicates specific responsibility of an individual within the care team, such as "Primary care physician", "Trained social worker counselor", "Caregiver", etc. This table contains the primary keys of all unique concepts representing roles of care team participant roles. Individual codings within each group are in the care_team_participant_role_coding table.
Column Name | Data Type | Nullable | References | Description |
---|---|---|---|---|
id | varchar | No | ID of role | |
display | varchar | Plain text representation of the care team participant role. This field comes from the "text" field in the codeable concept group |
care_team_participant_role_coding
This relation contains the individual coding values for each care team participant role.
Column Name | Data Type | Nullable | References | Description |
---|---|---|---|---|
care_team_participant_role_id | varchar | care_team_participant_role | ID of the care team participant role | |
system | varchar | URI of the terminology system, for example http://snomed.info/sct | ||
code | varchar | Code symbol defined by the terminology system | ||
display | varchar | Human-readable string representing the code |
care_team_telecom
This is a bridge table between care teams and contact details. These represent central contact details for the care team (that applies to all members).
Column Name | Data Type | Nullable | References | Description |
---|---|---|---|---|
care_team_id | varchar | No | care_team | ID of the CareTeam that this telecom belongs to |
contact_point_id | varchar | contact_point | ID of the contact point entry |
condition
A FHIR Condition represents a clinical condition, problem, diagnosis, or other event, situation, issue, or clinical concept that has risen to a level of concern.
Column Name | Data Type | Nullable | References | Description |
---|---|---|---|---|
id | varchar | No | Resource ID (UUID) of the Condition | |
version | varchar | No | Current version of this resource. This indicates whether the resource has been updated. | |
last_updated | timestamp | No | Timestamp this resource was last updated, formatted as ISO 8601 timestamp | |
clinical_status | varchar | The clinical status code value of the allergy or intolerance. These codes belong to the system http://terminology.hl7.org/CodeSystem/allergyintolerance-clinical. Possible values: active | inactive | resolved | ||
verification_status | varchar | Verification status of the Condition. Possible values: unconfirmed | provisional | differential | confirmed | refuted | entered-in-error | ||
condition_category_id | varchar | condition_category | ID of the Condition Category. FHIR allows Condition resources to be associated with multiple categories, but the conditions in our data currently have only one category. | |
condition_code_id | varchar | condition_code | ID of the Condition Code | |
code_cci | varchar | CCI code of Condition | ||
code_ccs | varchar | Condition's CCS category based on the Clinical Classifications Software Refined (CCSR) aggregation of ICD-10-CM/PCS codes into clinically meaningful categories, as derived by Zus. | ||
code_hcc | varchar | HCC code of Condition | ||
code_icd10cm | varchar | ICD-10-CM code of Condition | ||
code_snomed | varchar | SNOMED code of Condition | ||
code_display | varchar | Display value of Condition Code, taken from the text field of the codeable concept | ||
category_loinc | varchar | LOINC code for the category of the condition | ||
subject_patient_id | varchar | patient | ID of the Patient who has the Condition | |
encounter_id | varchar | encounter | ID of the Encounter created as part of the Condition | |
onset | timestamp | Onset of the Condition | ||
abatement | timestamp | When the Condition was abated | ||
recorded_date | timestamp | Date Condition was first recorded | ||
recorder_practitioner_id | varchar | practitioner | ID of the Practitioner who recorded the condition | |
asserter_practitioner_id | varchar | practitioner | ID of the Practitioner who asserted the condition | |
builder_id | varchar | ID of the Builder account that provided this data | ||
upid | varchar | Unique Patient Identifier (UPID) of the patient that this resource is associated with | ||
created_at | timestamp | Timestamp when this resource was first recorded in this system | ||
resource_json | varchar | No | Original JSON document for this resource | |
data_source | varchar | Name of the data partner network that provided this data |
condition_category
The condition category describes whether a condition comes from a problem list or was diagnosed in a specific context. This table contains the primary keys of all unique concept groups that represent the condition categories. Individual codings within each group are in the condition_category_coding table.
Column Name | Data Type | Nullable | References | Description |
---|---|---|---|---|
id | varchar | No | ID of the Condition Category | |
display | varchar | Plain text representation of the condition category. This field comes from the "text" field in the codeable concept group |
condition_category_coding
This relation contains the individual coding values for each condition category.
Column Name | Data Type | Nullable | References | Description |
---|---|---|---|---|
condition_category_id | varchar | condition_category | ID of the Condition Category | |
system | varchar | URI of the terminology system, usually http://terminology.hl7.org/CodeSystem/condition-category | ||
code | varchar | Code symbol defined by the terminology system | ||
display | varchar | Human-readable string representing the code |
condition_code
The condition code represents a detailed description of the type of condition; e.g. what this, what diagnosis, what kind of problem. This table contains the primary keys of all unique concepts representing condition codes. Individual codings within each group are in the condition_code_coding table.
Column Name | Data Type | Nullable | References | Description |
---|---|---|---|---|
id | varchar | No | ID of the Condition Code | |
display | varchar | Plain text representation of the condition code. This field comes from the "text" field in the codeable concept group |
condition_code_coding
This relation contains the individual coding values for each condition code.
Column Name | Data Type | Nullable | References | Description |
---|---|---|---|---|
condition_code_id | varchar | condition_code | ID of the Condition Code | |
system | varchar | URI of the terminology system, for example http://snomed.info/sct | ||
code | varchar | Code symbol defined by the terminology system | ||
display | varchar | Human-readable string representing the code |
condition_identifier
This is a bridge table that joins the condition table to the identifier table
Column Name | Data Type | Nullable | References | Description |
---|---|---|---|---|
condition_id | varchar | No | condition | ID of the Condition that this identifier belongs to |
identifier_id | varchar | identifier | ID of the Identifier |
condition_note
This table contains freeform text notes with extra information about the Condition that is not captured in other attributes
Column Name | Data Type | Nullable | References | Description |
---|---|---|---|---|
condition_id | varchar | No | condition | ID of the Condition that this note belongs to |
time | timestamp | When the annotation was made | ||
text_markdown | varchar | The annotation - text content (as markdown) |
consent
A FHIR Consent is a record of a healthcare consumer's choices, which permits or denies identified recipient(s) or recipient role(s) to perform one or more actions within a given policy context, for specific purposes and periods of time.
Column Name | Data Type | Nullable | References | Description |
---|---|---|---|---|
id | varchar | No | Resource ID (UUID) of the Consent | |
version | varchar | No | Current version of this resource. This indicates whether the resource has been updated. | |
last_updated | timestamp | No | Timestamp this resource was last updated, formatted as ISO 8601 timestamp | |
status | varchar | draft | proposed | active | rejected | inactive | entered-in-error | ||
consent_category_id | varchar | ID of the category encoding the category that this consent belongs to. FHIR allows Consent resources to belong to multiple categories, but currently all consents in our data only have one category. | ||
patient_id | varchar | patient | ID of the Patient who the consent is for | |
consent_policy_rule_id | varchar | ID of the policy rule encoding the policy that this consent is based on | ||
verified | tinyint | Whether consent is verified. The FHIR Consent resource allows multiple verification elements representing different persons who verified the consent. Currently, this column only captures the status of the first verification element, as our data does not yet include Consent resources in our with multiple verification elements. | ||
builder_id | varchar | ID of the Builder account that provided this data | ||
upid | varchar | Unique Patient Identifier (UPID) of the patient that this resource is associated with | ||
created_at | timestamp | Timestamp when this resource was first recorded in this system | ||
resource_json | varchar | No | Original JSON document for this resource | |
data_source | varchar | Name of the data partner network that provided this data |
consent_category
The consent category classfies the type of consents foundd in the statement, such as Advance Directive, Do Not Resuscitate, etc. This table contains the primary keys of all unique concept groups that represent the consent categories. Individual codings within each group are in the consent_category_coding table.
Column Name | Data Type | Nullable | References | Description |
---|---|---|---|---|
id | varchar | No | ID of code | |
display | varchar | Plain text representation of the consent category. This field comes from the "text" field in the codeable concept group |
consent_category_coding
This relation contains the individual coding values for each consent category.
Column Name | Data Type | Nullable | References | Description |
---|---|---|---|---|
consent_category_id | varchar | consent_category | ID of the Consent category | |
system | varchar | URI of the terminology system, for example http://terminology.hl7.org/CodeSystem/consentcategorycodes | ||
code | varchar | Code symbol defined by the terminology system | ||
display | varchar | Human-readable string representing the code |
consent_identifier
This is a bridge table that joins the consent table to the identifier table
Column Name | Data Type | Nullable | References | Description |
---|---|---|---|---|
consent_id | varchar | No | consent | ID of the Consent that this identifier belongs to |
identifier_id | varchar | identifier | ID of the Identifier |
consent_policy_rule
The consent policy rule represents specific base computable regulation or policy. This table contains the primary keys of all unique concept groups that represent the consent policy rules. Individual codings within each group are in the consent_policy_rule_coding table.
Column Name | Data Type | Nullable | References | Description |
---|---|---|---|---|
id | varchar | No | ID of code | |
display | varchar | Plain text representation of the consent policy rule. This field comes from the "text" field in the codeable concept group |
consent_policy_rule_coding
This relation contains the individual coding values for each consent policy rule.
Column Name | Data Type | Nullable | References | Description |
---|---|---|---|---|
consent_policy_rule_id | varchar | consent_policy_rule | ID of the Consent Policy Rule | |
system | varchar | URI of the terminology system, for example http://terminology.hl7.org/CodeSystem/consentpolicycodes | ||
code | varchar | Code symbol defined by the terminology system | ||
display | varchar | Human-readable string representing the code |
consent_provision_actor
The consent provision actor describes who or what is controlled by this rule. Use group to identify a set of actors by some property they share (e.g. 'admitting officers').
Column Name | Data Type | Nullable | References | Description |
---|---|---|---|---|
consent_id | varchar | No | consent | ID of the Consent that this provision actor belongs to |
consent_provision_actor_role_id | varchar | consent_provision_actor_role | ID of the role encoding the role of the actor | |
reference_practitioner_id | varchar | practitioner | ID of the Practitioner who is the actor |
consent_provision_actor_role
The consent provision actor role describes ow the individual is involved in the consent provision. This table contains the primary keys of all unique concept groups that represent the consent provision actor roles. Individual codings within each group are in the consent_provision_actor_role_coding table.
Column Name | Data Type | Nullable | References | Description |
---|---|---|---|---|
id | varchar | No | ID of code | |
display | varchar | Plain text representation of the consent provision actor role. This field comes from the "text" field in the codeable concept group |
consent_provision_actor_role_coding
This relation contains the individual coding values for each consent provision actor role.
Column Name | Data Type | Nullable | References | Description |
---|---|---|---|---|
consent_provision_actor_role_id | varchar | consent_provision_actor_role | ID of the Consent provision actor role | |
system | varchar | URI of the terminology system, for example http://terminology.hl7.org/CodeSystem/contractsignertypecodes | ||
code | varchar | Code symbol defined by the terminology system | ||
display | varchar | Human-readable string representing the code |
coverage
A FHIR Coverage represents a financial instrument which may be used to reimburse or pay for health care products and services. Includes both insurance and self-payment.
Column Name | Data Type | Nullable | References | Description |
---|---|---|---|---|
id | varchar | No | Resource ID (UUID) of the Coverage | |
version | varchar | No | Current version of this resource. This indicates whether the resource has been updated. | |
last_updated | timestamp | No | Timestamp this resource was last updated, formatted as ISO 8601 timestamp | |
status | varchar | A code specifying the state of the Coverage. Possible values: active | cancelled | draft | entered-in-error | ||
coverage_type_id | varchar | coverage_type | ID of the type expressing the specific Coverage category such as medical or accident | |
policy_holder_patient_id | varchar | patient | ID of the Patient that is an owner of the policy | |
policy_holder_related_person_id | varchar | related_person | ID of the RelatedPerson that is an owner of the policy | |
subscriber_patient_id | varchar | patient | ID of the Patient that is a subscriber to the policy | |
subscriber_id | varchar | ID assigned to the subscriber | ||
beneficiary_patient_id | varchar | patient | Plan beneficiary | |
dependent | varchar | Dependent number | ||
period_start | timestamp | Coverage start date | ||
period_end | timestamp | Coverage end date | ||
rank_order | int | Relative order of the coverage | ||
builder_id | varchar | ID of the Builder account that provided this data | ||
upid | varchar | Unique Patient Identifier (UPID) of the patient that this resource is associated with | ||
created_at | timestamp | Timestamp when this resource was first recorded in this system | ||
resource_json | varchar | No | Original JSON document for this resource | |
data_source | varchar | Name of the data partner network that provided this data |
coverage_identifier
This is a bridge table that joins the coverage table to the identifier table
Column Name | Data Type | Nullable | References | Description |
---|---|---|---|---|
coverage_id | varchar | No | coverage | ID of the Coverage that this identifier belongs to |
identifier_id | varchar | identifier | ID of the Identifier |
coverage_payor
Issuer of the policy
Column Name | Data Type | Nullable | References | Description |
---|---|---|---|---|
coverage_id | varchar | No | coverage | ID of the Coverage that this payor belongs to |
organization_id | varchar | organization | ID of the Organization |
coverage_type
The type of coverage may be a social program, medical plan, accident coverage (workers compensation, auto), group health or payment by an individual or organization. This table contains the primary keys of all unique concept groups that represent the coverage types. Individual codings within each group are in the coverage_type_coding table.
Column Name | Data Type | Nullable | References | Description |
---|---|---|---|---|
id | varchar | No | ID of code | |
display | varchar | Plain text representation of the coverage type. This field comes from the "text" field in the codeable concept group |
coverage_type_coding
This relation contains the individual coding values for each coverage type.
Column Name | Data Type | Nullable | References | Description |
---|---|---|---|---|
coverage_type_id | varchar | coverage_type | ID of the Coverage type | |
system | varchar | URI of the terminology system, for example http://terminology.hl7.org/CodeSystem/coverage-selfpay | ||
code | varchar | Code symbol defined by the terminology system | ||
display | varchar | Human-readable string representing the code |
device
Item used in healthcare.
Column Name | Data Type | Nullable | References | Description |
---|---|---|---|---|
id | varchar | No | Resource ID (UUID) of the Device | |
version | varchar | No | Current version of this resource. This indicates whether the resource has been updated. | |
last_updated | timestamp | No | Timestamp this resource was last updated, formatted as ISO 8601 timestamp | |
status | varchar | Status of the Device active | inactive | entered-in-error | unknown | ||
patient_id | varchar | patient | ID of the Patient to whom Device is affixed | |
builder_id | varchar | ID of the Builder account that provided this data | ||
upid | varchar | Unique Patient Identifier (UPID) of the patient that this resource is associated with | ||
created_at | timestamp | Timestamp when this resource was first recorded in this system | ||
resource_json | varchar | No | Original JSON document for this resource | |
data_source | varchar | Name of the data partner network that provided this data |
device_identifier
This is a bridge table that joins the device table to the identifier table
Column Name | Data Type | Nullable | References | Description |
---|---|---|---|---|
device_id | varchar | No | device | ID of the Device that this identifier belongs to |
identifier_id | varchar | identifier | ID of the Identifier |
device_name
This represents the manufacturer's name of the device as provided by the device, from a UDI label, or by a person describing the Device. This typically would be used when a person provides the name(s) or when the device represents one of the names available from DeviceDefinition.
Column Name | Data Type | Nullable | References | Description |
---|---|---|---|---|
device_id | varchar | No | device | ID of the Device that this name belongs to |
name | varchar | The name of the device | ||
type | varchar | The type of the device name. Possible values: udi-label-name | user-friendly-name | patient-reported-name | manufacturer-name | model-name | other |
device_note
This table contains freeform text notes with extra information about the Device that is not captured in other attributes
Column Name | Data Type | Nullable | References | Description |
---|---|---|---|---|
device_id | varchar | No | device | ID of the Device that this note belongs to |
text_markdown | varchar | The annotation - text content (as markdown) |
device_specialization_system_type_bridge
The device specialization system type expresses the standard that is used to operate and communicate the device. This is a bridge table that joins Device resources to device specialization system type codeable concepts. Individual codings within each group are in the
Column Name | Data Type | Nullable | References | Description |
---|---|---|---|---|
device_specialization_system_type_id | varchar | No | ID of the device specialization system type | |
device_id | varchar | No | device | ID of the Device that this specialization system type belongs to |
display | varchar | Plain text representation of the device specialization system type. This field comes from the "text" field in the codeable concept group |
device_specialization_system_type_coding
This relation contains the individual coding values for each device specialization system type.
Column Name | Data Type | Nullable | References | Description |
---|---|---|---|---|
device_specialization_system_type_id | varchar | device_specialization_system_type | ID of the Device Specialization System Type | |
system | varchar | URI of the terminology system, for example http://snomed.info/sct | ||
code | varchar | Code symbol defined by the terminology system | ||
display | varchar | Human-readable string representing the code |
device_udi_carrier
Unique device identifier (UDI) assigned to device label or package. Note that the Device may include multiple udiCarriers as it either may include just the udiCarrier for the jurisdiction it is sold, or for multiple jurisdictions it could have been sold.
Column Name | Data Type | Nullable | References | Description |
---|---|---|---|---|
device_id | varchar | No | device | ID of the Device that this udi carrier belongs to |
device_identifier | varchar | Mandatory fixed portion of UDI |
device_use_statement
A FHIR DeviceUseStatement represents a record of a device being used by a patient where the record is the result of a report from the patient or another clinician.
Column Name | Data Type | Nullable | References | Description |
---|---|---|---|---|
id | varchar | No | Resource ID (UUID) of the DeviceUseStatement | |
version | varchar | No | Current version of this resource. This indicates whether the resource has been updated. | |
last_updated | timestamp | No | Timestamp this resource was last updated, formatted as ISO 8601 timestamp | |
status | varchar | A code representing the patient or other source's judgment about the state of the device used that this statement is about. Generally this will be active or completed. Possible values: active | completed | entered-in-error | intended | stopped | on-hold | ||
subject_patient_id | varchar | patient | Patient using device | |
timing_start | timestamp | Start of the period for how often the device was used | ||
timing_end | timestamp | End of the period for how often the device was used | ||
recorded_on | timestamp | When statement was recorded | ||
source_practitioner_id | varchar | practitioner | Who made the statement | |
device_id | varchar | No | device | ID of the Device that this use statement belongs to |
body_site_concept_id | varchar | body_site_concept | Target body site | |
builder_id | varchar | ID of the Builder account that provided this data | ||
upid | varchar | Unique Patient Identifier (UPID) of the patient that this resource is associated with | ||
created_at | timestamp | Timestamp when this resource was first recorded in this system | ||
resource_json | varchar | No | Original JSON document for this resource | |
data_source | varchar | Name of the data partner network that provided this data |
device_use_statement_derived_from
Allows linking the DeviceUseStatement to the underlying Request, or to other information that supports or is used to derive the DeviceUseStatement.
Column Name | Data Type | Nullable | References | Description |
---|---|---|---|---|
device_use_statement_id | varchar | No | device_use_statement | ID of the DeviceUseStatement that this derived from belongs to |
procedure_id | varchar | procedure | Procedure that holds supporting information for the DeviceUseStatement. |
device_use_statement_identifier
This is a bridge table that joins the device_use_statement table to the identifier table
Column Name | Data Type | Nullable | References | Description |
---|---|---|---|---|
device_use_statement_id | varchar | No | device_use_statement | ID of the DeviceUseStatement that this identifier belongs to |
identifier_id | varchar | identifier | ID of the Identifier |
diagnostic_report
A FHIR DiagnosticReport represents the findings and interpretation of diagnostic tests performed on patients, groups of patients, devices, and locations, and/or specimens derived from these.
Column Name | Data Type | Nullable | References | Description |
---|---|---|---|---|
id | varchar | No | Resource ID (UUID) of the DiagnosticReport | |
version | varchar | No | Current version of this resource. This indicates whether the resource has been updated. | |
last_updated | timestamp | No | Timestamp this resource was last updated, formatted as ISO 8601 timestamp | |
status | varchar | A code specifying the state of the DiagnosticReport. Possible values: registered | partial | preliminary | final | ||
diagnostic_report_code_id | varchar | diagnostic_report_code | Name/Code for this diagnostic report. | |
subject_patient_id | varchar | patient | The subject of the report. | |
encounter_id | varchar | encounter | Health care event when test ordered | |
effective_start | timestamp | Start time (inclusive) of the clinically relevant time-period for report. | ||
effective_end | timestamp | End time (inclusive) of the clinically relevant time-period for report. | ||
issued | timestamp | DateTime this version was made | ||
builder_id | varchar | ID of the Builder account that provided this data | ||
upid | varchar | Unique Patient Identifier (UPID) of the patient that this resource is associated with | ||
created_at | timestamp | Timestamp when this resource was first recorded in this system | ||
resource_json | varchar | No | Original JSON document for this resource | |
data_source | varchar | Name of the data partner network that provided this data |
diagnostic_report_code
The diagnostic report code represents the name or code for the diagnostic report. This table contains the primary keys of all unique concept groups that represent the diagnostic report codes. Individual codings within each group are in the diagnostic_report_code_coding table.
Column Name | Data Type | Nullable | References | Description |
---|---|---|---|---|
id | varchar | No | ID of code | |
display | varchar | Plain text representation of the diagnostic report code. This field comes from the "text" field in the codeable concept group |
diagnostic_report_code_coding
This relation contains the individual coding values for each diagnostic report code.
Column Name | Data Type | Nullable | References | Description |
---|---|---|---|---|
diagnostic_report_code_id | varchar | diagnostic_report_code | ID of the Diagnostic Report Code | |
system | varchar | URI of the terminology system | ||
code | varchar | Code symbol defined by the terminology system | ||
display | varchar | Human-readable string representing the code | ||
user_selected | boolean | True if user selected code directly |
diagnostic_report_identifier
This is a bridge table that joins the diagnostic_report table to the identifier table
Column Name | Data Type | Nullable | References | Description |
---|---|---|---|---|
diagnostic_report_id | varchar | No | diagnostic_report | ID of the DiagnosticReport that this identifier belongs to |
identifier_id | varchar | identifier | ID of the Identifier |
diagnostic_report_performer
The diagnostic report performer represents the diagnostic service that is responsible for issuing the report.
Column Name | Data Type | Nullable | References | Description |
---|---|---|---|---|
diagnostic_report_id | varchar | No | diagnostic_report | ID of the DiagnosticReport that this performer belongs to |
practitioner_id | varchar | practitioner | ID of the Practitioner |
diagnostic_report_result
This table contains references to Observation resources that are part of this diagnostic report.
Column Name | Data Type | Nullable | References | Description |
---|---|---|---|---|
diagnostic_report_id | varchar | No | diagnostic_report | ID of the DiagnosticReport that this result belongs to |
observation_id | varchar | observation | ID of the Observation |
document_reference
A FHIR DocumentReference represents a reference to a document of any kind for any purpose. Provides metadata about the document so that the document can be discovered and managed. The scope of a document is any seralized object with a mime-type, so includes formal patient centric documents (CDA), cliical notes, scanned paper, and non-patient specific documents like policy text.
Column Name | Data Type | Nullable | References | Description |
---|---|---|---|---|
id | varchar | No | Resource ID (UUID) of the DocumentReference | |
version | varchar | No | Current version of this resource. This indicates whether the resource has been updated. | |
last_updated | varchar | No | Timestamp this resource was last updated, formatted as ISO 8601 timestamp | |
narrative | varchar | Clinical narrative of the DocumentReference | ||
master_identifier_id | varchar | identifier | ID of the Master Version Specific Identifier | |
status | varchar | current | superseded | entered-in-error | ||
doc_status | varchar | preliminary | final | amended | entered-in-error | ||
document_reference_type_id | varchar | document_reference_type | ID of the type encoding the kind of document (LOINC if possible) | |
type_loinc | varchar | LOINC type of document | ||
subject_patient_id | varchar | patient | ID of the Patient that is the subject of the document | |
document_date | timestamp | When this document was created. This typically comes from the source document from the data network partner. | ||
author_practitioner_id | varchar | practitioner | ID of the Practitioner that is author of given document | |
author_organization_id | varchar | organization | ID of the Organization that is author of given document | |
author_device_id | varchar | device | ID of the Device that is author of given document | |
custodian_organization_id | varchar | organization | Organization which maintains the document | |
description | varchar | Human-readable description | ||
attachment_file_type | varchar | MIME type of the binary attachment. FHIR DocumentReference resources allow multiple attachments, but this column only refers to the first attachment. Currently, all the DocumentReference resources in our data have only one attachment. | ||
confidentiality | varchar | Code indicating the confidentiality level of the document. Thie value is taken from the securityLabel FHIR field. The code is extracted when the system matches the HL7 code system for confidentiality, or urn:oid:2.16.840.1.113883.5.25. | ||
confidentiality_display | varchar | Plain text description of the confidentiality code shown in the confidentiality field | ||
encounter_id | varchar | encounter | ID of the Dncounter that this document is associated with. If there are multiple encounters associated, only the first is shown in the column. | |
encounter_display | varchar | Display text of the encounter associated with this document. The absence of a display string does not indicate absence of an associated encounter. This field is meant to help with browsing. | ||
period_start | timestamp | Start of the time of service that is being documented | ||
period_end | timestamp | End of the time of service that is being documented | ||
facility_type | varchar | Kind of facility where patient was seen | ||
builder_id | varchar | ID of the Builder account that provided this data | ||
upid | varchar | Unique Patient Identifier (UPID) of the patient that this resource is associated with | ||
created_at | timestamp | Timestamp when this resource was first recorded in this system | ||
resource_json | varchar | No | Original JSON document for this resource | |
data_source | varchar | Name of the data partner network that provided this data |
document_reference_category_bridge
The document reference category helps for indexing and searching. This may be implied by or derived from the code specified in the DocumentReference.type. This is a bridge table that joins DocumentReference resources to DocumentReference category codeable concepts. Individual codings within each group are in the document_reference_category_coding table.
Column Name | Data Type | Nullable | References | Description |
---|---|---|---|---|
document_reference_category_id | varchar | No | ID of the document reference category | |
document_reference_id | varchar | No | document_reference | ID of the DocumentReference that this category belongs to |
display | varchar | Plain text representation of the document reference category. This field comes from the "text" field in the codeable concept group | ||
code_loinc | varchar | LOINC code of category |
document_reference_category_coding
This relation contains the individual coding values for each document reference category.
Column Name | Data Type | Nullable | References | Description |
---|---|---|---|---|
document_reference_category_id | varchar | document_reference_category | ID of the DocumentReference Category | |
system | varchar | URI of the terminology system | ||
code | varchar | Code symbol defined by the terminology system | ||
display | varchar | Human-readable string representing the code |
document_reference_identifier
This is a bridge table that joins the document_reference table to the identifier table
Column Name | Data Type | Nullable | References | Description |
---|---|---|---|---|
document_reference_id | varchar | No | document_reference | ID of the DocumentReference that this identifier belongs to |
identifier_id | varchar | identifier | ID of the Identifier |
document_reference_relates_to
Relationships that this document has with other document references that already exist.
Column Name | Data Type | Nullable | References | Description |
---|---|---|---|---|
document_reference_id | varchar | No | document_reference | ID of the DocumentReference that this relates to belongs to |
relationship_type | varchar | How the referenced document relates to this document. This field comes from the FHIR field DocumentRefererence.relatesTo.code. Possible values: replaces | transforms | signs | appends | ||
parent_document_reference_id | varchar | document_reference | ID of the DocumentReference that is the target of the relationship | |
parent_display | varchar | Display text of the parent document reference |
document_reference_type
Specifies the particular kind of document referenced (e.g. History and Physical, Discharge Summary, Progress Note). This usually equates to the purpose of making the document referenced. This table contains the primary keys of all unique concept groups that represent the document reference types. Individual codings within each group are in the document_reference_type_coding table.
Column Name | Data Type | Nullable | References | Description |
---|---|---|---|---|
id | varchar | No | ID of code | |
display | varchar | Plain text representation of the document reference type. This field comes from the "text" field in the codeable concept group |
document_reference_type_coding
This relation contains the individual coding values for each document reference type.
Column Name | Data Type | Nullable | References | Description |
---|---|---|---|---|
document_reference_type_id | varchar | document_reference_type | ID of the DocumentReference type | |
system | varchar | URI of the terminology system | ||
code | varchar | Code symbol defined by the terminology system | ||
display | varchar | Human-readable string representing the code |
encounter
A FHIR Encounter represents an interaction between a patient and healthcare provider(s) for the purpose of providing healthcare service(s) or assessing the health status of a patient.
Column Name | Data Type | Nullable | References | Description |
---|---|---|---|---|
id | varchar | No | Resource ID (UUID) of the Encounter | |
version | varchar | No | Current version of this resource. This indicates whether the resource has been updated. | |
last_updated | timestamp | No | Timestamp this resource was last updated, formatted as ISO 8601 timestamp | |
status | varchar | A code specifying the state of the Encounter. Possible values: planned | arrived | triaged | in-progress | onleave | finished | cancelled | ||
class_code | varchar | Code that classifies the patient encounter such as ambulatory (outpatient), inpatient, emergency, home health or others due to local variations. Values for this field come from the HL7 v3 ActEncounterCode value set. The values chosen for this column prioritize values written by the Zus Data Enrichment service, and may not always match the value of the "class" field in the raw JSON document. | ||
class_display | varchar | Display text of the encounter class, taken from the enriched code. | ||
encounter_type_id | varchar | encounter_type | ID of the concept expressing the type of the Encounter. This column encodes first the encounter type in the FHIR Encounter resource. Although a small number of encounters have multiple entries in the type element, the information related to the encounter class is currently always in the first type entry. | |
subject_patient_id | varchar | patient | ID of the Patient present at the Encounter | |
period_start | timestamp | Start time (inclusive) of the Encounter | ||
period_end | timestamp | End time (inclusive) of the Encounter | ||
length_minutes | int | Length of time (in minutes) that the Encounter lasted | ||
encounter_hospitalization_discharge_disposition_id | varchar | encounter_hospitalization_discharge_disposition | ID of the concept encoding the category or kind of location after discharge | |
location_id | varchar | location | ID of the Location where the Encounter took place. If multiple locations are associated with the Encounter, only the first is shown in the column. | |
service_provider_organization_id | varchar | organization | ID of the Organization (facility) responsible for this Encounter | |
builder_id | varchar | ID of the Builder account that provided this data | ||
upid | varchar | Unique Patient Identifier (UPID) of the patient that this resource is associated with | ||
created_at | timestamp | Timestamp when this resource was first recorded in this system | ||
resource_json | varchar | No | Original JSON document for this resource | |
data_source | varchar | Name of the data partner network that provided this data |
encounter_diagnosis
The list of diagnosis relevant to Encounters
Column Name | Data Type | Nullable | References | Description |
---|---|---|---|---|
encounter_id | varchar | No | encounter | ID of the Encounter that this diagnosis belongs to |
condition_id | varchar | condition | ID of the Condition relevant to the encounter | |
rank | int | Ranking of the diagnosis (for each role type) | ||
use_code | varchar | role that this diagnosis has within the encounter (e.g. admission, billing, discharge ...) |
encounter_hospitalization_discharge_disposition
The discharge disposition represents the category or kind of location after discharge. This table contains the primary keys of all unique concept groups that represent the discharge dispositions. Individual codings within each group are in the encounter_hospitalization_discharge_disposition_coding table.
Column Name | Data Type | Nullable | References | Description |
---|---|---|---|---|
id | varchar | No | ID of the Encounter Hospitalization Discharge Disposition | |
display | varchar | Plain text representation of the encounter hospitalization discharge disposition. This field comes from the "text" field in the codeable concept group |
encounter_hospitalization_discharge_disposition_coding
This relation contains the individual coding values for each encounter hospitalization discharge disposition.
Column Name | Data Type | Nullable | References | Description |
---|---|---|---|---|
encounter_hospitalization_discharge_disposition_id | varchar | encounter_hospitalization_discharge_disposition | ID of the Encounter Hospitalization Discharge Disposition | |
system | varchar | URI of the terminology system | ||
code | varchar | Code symbol defined by the terminology system | ||
display | varchar | Human-readable string representing the code |
encounter_identifier
This is a bridge table that joins the encounter table to the identifier table
Column Name | Data Type | Nullable | References | Description |
---|---|---|---|---|
encounter_id | varchar | No | encounter | ID of the Encounter that this identifier belongs to |
identifier_id | varchar | identifier | ID of the Identifier |
encounter_participant
An Encounter Participant represents the list of people involved in the Encounter.
Column Name | Data Type | Nullable | References | Description |
---|---|---|---|---|
encounter_id | varchar | No | encounter | ID of the Encounter that this participant belongs to |
encounter_participant_type_id | varchar | encounter_participant_type | ID of the Encounter Participant Type | |
period_start | timestamp | Start time (inclusive) of the participant being involved in the Encounter. | ||
period_end | timestamp | End time (inclusive) of the participant being involved in the Encounter. | ||
individual_practitioner_id | varchar | practitioner | ID of the Participant who was involved in the Encounter |
encounter_participant_type
The encounter participant type represents the role of the participant in the encounter. This table contains the primary keys of all unique concept groups that represent the encounter participant types. Individual codings within each group are in the encounter_participant_type_coding table.
Column Name | Data Type | Nullable | References | Description |
---|---|---|---|---|
id | varchar | No | ID of the Encounter Participant | |
display | varchar | Plain text representation of the encounter participant type. This field comes from the "text" field in the codeable concept group |
encounter_participant_type_coding
This relation contains the individual coding values for each encounter participant type.
Column Name | Data Type | Nullable | References | Description |
---|---|---|---|---|
encounter_participant_type_id | varchar | encounter_participant_type | ID of the Encounter Participant Type | |
system | varchar | URI of the terminology system | ||
code | varchar | Code symbol defined by the terminology system | ||
display | varchar | Human-readable string representing the code |
encounter_reason_code
The encounter reason code encodes the reason the encounter takes place. For admissions, this can be used for a coded admission diagnosis. This table contains the primary keys of all unique concept groups that represent the encounter reason codes. This table contains the extracted SNOMED, ICD-10-CM, and ICD-9-CM codes of the encounter reason.
Column Name | Data Type | Nullable | References | Description |
---|---|---|---|---|
encounter_id | varchar | No | encounter | ID of the Encounter that this reason code belongs to |
snomed | varchar | SNOMED code of Encounter reason | ||
icd10cm | varchar | ICD-10-CM code of Encounter reason | ||
icd9cm | varchar | ICD-9-CM code of Encounter reason | ||
display | varchar | Plain text representation of the encounter reason code. This field comes from the "text" field in the codeable concept group |
encounter_type
The encounter type specifies the type of encounter (e.g. e-mail consultation, surgical day-care, skilled nursing, rehabilitation). This table contains the primary keys of all unique concept groups that represent the encounter types. Individual codings within each group are in the encounter_type_coding table.
Column Name | Data Type | Nullable | References | Description |
---|---|---|---|---|
id | varchar | No | ID of the Encounter Type | |
display | varchar | Plain text representation of the encounter type. This field comes from the "text" field in the codeable concept group |
encounter_type_coding
This relation contains the individual coding values for each encounter type.
Column Name | Data Type | Nullable | References | Description |
---|---|---|---|---|
encounter_type_id | varchar | encounter_type | ID of the Encounter type | |
system | varchar | URI of the terminology system | ||
code | varchar | Code symbol defined by the terminology system | ||
display | varchar | Human-readable string representing the code | ||
user_selected | tinyint | If this coding was chosen directly by the user |
family_member_history
Information about patients relatives, relevant for patient.
Column Name | Data Type | Nullable | References | Description |
---|---|---|---|---|
id | varchar | No | Resource ID (UUID) of the FamilyMemberHistory | |
version | varchar | No | Current version of this resource. This indicates whether the resource has been updated. | |
last_updated | timestamp | No | Timestamp this resource was last updated, formatted as ISO 8601 timestamp | |
status | varchar | partial | completed | entered-in-error | health-unknown | ||
patient_id | varchar | patient | ID of the Patient who history is about | |
date | timestamp | When history was recorded or last updated | ||
family_member_history_relationship_id | varchar | family_member_history_relationship | ID of the relationship of the relative to the patient | |
sex | varchar | The birth sex of the family member. Possible values: male | female | other | unknown | ||
born_date | timestamp | (approximate) date of birth | ||
deceased | tinyint | Whether the subject is dead or not | ||
builder_id | varchar | ID of the Builder account that provided this data | ||
upid | varchar | Unique Patient Identifier (UPID) of the patient that this resource is associated with | ||
created_at | timestamp | Timestamp when this resource was first recorded in this system | ||
resource_json | varchar | No | Original JSON document for this resource | |
data_source | varchar | Name of the data partner network that provided this data |
family_member_history_condition
This table contains a list of significant Conditions (or condition) that the family member had.
Column Name | Data Type | Nullable | References | Description |
---|---|---|---|---|
family_member_history_id | varchar | No | family_member_history | ID of the FamilyMemberHistory that this condition belongs to |
family_member_history_condition_code_id | varchar | family_member_history_condition_code | ID of the FamilyMemberHistory Condition Code | |
contributed_to_death | tinyint | Whether the condition contributed to the cause of death | ||
onset_age | decimal | When condition first manifested |
family_member_history_condition_code
The family member history condition code encodes the actual condition that the family member had. This table contains the primary keys of all unique concept groups that represent the family member history condition codes. Individual codings within each group are in the family_member_history_condition_code_coding table.
Column Name | Data Type | Nullable | References | Description |
---|---|---|---|---|
id | varchar | No | ID of code | |
display | varchar | Plain text representation of the family member history condition code. This field comes from the "text" field in the codeable concept group |
family_member_history_condition_code_coding
This relation contains the individual coding values for each family member history condition code.
Column Name | Data Type | Nullable | References | Description |
---|---|---|---|---|
family_member_history_condition_code_id | varchar | family_member_history_condition_code | ID of the FamilyMemberHistory Condition Code | |
system | varchar | URI of the terminology system | ||
code | varchar | Code symbol defined by the terminology system | ||
display | varchar | Human-readable string representing the code |
family_member_history_identifier
This is a bridge table that joins the family_member_history table to the identifier table
Column Name | Data Type | Nullable | References | Description |
---|---|---|---|---|
family_member_history_id | varchar | No | family_member_history | ID of the FamilyMemberHistory that this identifier belongs to |
identifier_id | varchar | identifier | ID of the Identifier |
family_member_history_note
This table contains freeform text notes with extra information about the FamilyMemberHistory that is not captured in other attributes
Column Name | Data Type | Nullable | References | Description |
---|---|---|---|---|
family_member_history_id | varchar | No | family_member_history | ID of the FamilyMemberHistory that this note belongs to |
text_markdown | varchar | The annotation - text content (as markdown) |
family_member_history_relationship
The family member history relationship code encodes thetype of relationship this person has to the patient (father, mother, brother etc.). This table contains the primary keys of all unique concept groups that represent the family member history relationship codes. Individual codings within each group are in the family_member_history_relationship_coding table.
Column Name | Data Type | Nullable | References | Description |
---|---|---|---|---|
id | varchar | No | ID of code | |
display | varchar | Plain text representation of the family member history relationship. This field comes from the "text" field in the codeable concept group |
family_member_history_relationship_coding
This relation contains the individual coding values for each family member history relationship.
Column Name | Data Type | Nullable | References | Description |
---|---|---|---|---|
family_member_history_relationship_id | varchar | family_member_history_relationship | ID of the FamilyMemberHistory Code | |
system | varchar | URI of the terminology system | ||
code | varchar | Code symbol defined by the terminology system | ||
display | varchar | Human-readable string representing the code |
goal
Describes the intended objective(s) for a patient, group or organization
Column Name | Data Type | Nullable | References | Description |
---|---|---|---|---|
id | varchar | No | Resource ID (UUID) of the Goal | |
version | varchar | No | Current version of this resource. This indicates whether the resource has been updated. | |
last_updated | timestamp | No | Timestamp this resource was last updated, formatted as ISO 8601 timestamp | |
goal_description_id | varchar | goal_description | ID of the Description encoding the code or text describing goal | |
subject_patient_id | varchar | patient | ID of the Patient who the goal is intended for | |
start_date | timestamp | When goal pursuit begins | ||
expressed_by_practitioner_id | varchar | practitioner | ID of the Practitioner who the goal is intended for | |
builder_id | varchar | ID of the Builder account that provided this data | ||
upid | varchar | Unique Patient Identifier (UPID) of the patient that this resource is associated with | ||
created_at | timestamp | Timestamp when this resource was first recorded in this system | ||
resource_json | varchar | No | Original JSON document for this resource | |
data_source | varchar | Name of the data partner network that provided this data |
goal_description
The goal description encodes a specific desired objective of care, such as "control blood pressure" or "negotiate an obstacle course" or "dance with child at wedding". This table contains the primary keys of all unique concept groups that represent the goal descriptions. Individual codings within each group are in the goal_description_coding table.
Column Name | Data Type | Nullable | References | Description |
---|---|---|---|---|
id | varchar | No | ID of code | |
display | varchar | Plain text representation of the goal description. This field comes from the "text" field in the codeable concept group |
goal_description_coding
This relation contains the individual coding values for each goal description.
Column Name | Data Type | Nullable | References | Description |
---|---|---|---|---|
goal_description_id | varchar | goal_description | ID of the goal Description | |
system | varchar | URI of the terminology system | ||
code | varchar | Code symbol defined by the terminology system | ||
display | varchar | Human-readable string representing the code |
goal_identifier
This is a bridge table that joins the goal table to the identifier table
Column Name | Data Type | Nullable | References | Description |
---|---|---|---|---|
goal_id | varchar | No | goal | ID of the Goal that this identifier belongs to |
identifier_id | varchar | identifier | ID of the Identifier |
goal_target
The goal target indicates what should be done by when.
Column Name | Data Type | Nullable | References | Description |
---|---|---|---|---|
goal_id | varchar | No | goal | ID of the Goal that this target belongs to |
goal_target_measure_id | varchar | goal_target_measure | ID of the Measure encoding the parameter whose value is being tracked | |
detail_string | varchar | The target value of the parameter | ||
due_date | timestamp | When target is to be achieved |
goal_target_measure
The target measure expresses the parameter whose value is being tracked, e.g. body weight, blood pressure, or hemoglobin A1c level. This table contains the primary keys of all unique concept groups that represent the goal target measures. Individual codings within each group are in the goal_target_measure_coding table.
Column Name | Data Type | Nullable | References | Description |
---|---|---|---|---|
id | varchar | No | ID of code | |
display | varchar | Plain text representation of the goal target measure. This field comes from the "text" field in the codeable concept group |
goal_target_measure_coding
This relation contains the individual coding values for each goal target measure.
Column Name | Data Type | Nullable | References | Description |
---|---|---|---|---|
goal_target_measure_id | varchar | goal_target_measure | ID of the goal target Measure | |
system | varchar | URI of the terminology system | ||
code | varchar | Code symbol defined by the terminology system | ||
display | varchar | Human-readable string representing the code |
immunization
A FHIR Immunization represents the event of a patient being administered a vaccine or a record of an immunization as reported by a patient, a clinician or another party.
Column Name | Data Type | Nullable | References | Description |
---|---|---|---|---|
id | varchar | No | Resource ID (UUID) of the Immunization | |
version | varchar | No | Current version of this resource. This indicates whether the resource has been updated. | |
last_updated | timestamp | No | Timestamp this resource was last updated, formatted as ISO 8601 timestamp | |
status | varchar | A code specifying the state of the Immunization. Possible values: completed | entered-in-error | not-done | ||
immunization_status_reason_id | varchar | immunization_status_reason | ID of the concept of the reason not done | |
immunization_vaccine_code_id | varchar | immunization_vaccine_code | ID of the concept of the vaccine product administered | |
vaccine_name | varchar | Plain text name of vaccine | ||
patient_id | varchar | patient | ID of the Patient who was immunized | |
encounter_id | varchar | encounter | ID of the Encounter immunization was part of | |
occurrence | timestamp | Vaccine administration date | ||
manufacturer_organization_id | varchar | organization | Vaccine manufacturer | |
lot_number | varchar | Vaccine lot number | ||
body_site_concept_id | varchar | body_site_concept | ID of the concept of the body site vaccine was administered | |
route_concept_id | varchar | route_concept | ID of the concept of how vaccine entered body | |
dose_quantity_unit | varchar | Unit of amount of vaccine administered. | ||
dose_quantity_value | decimal | Value of amount of vaccine administered. | ||
dose_number | int | Dose number within series. This column comes from the first value of the protocolApplied element in the Immunization FHIR resource. When there are multiple protocolApplied entries, only the first is shown. | ||
performer_actor_organization_id | varchar | organization | ID of the Organization who was performing the event | |
builder_id | varchar | ID of the Builder account that provided this data | ||
upid | varchar | Unique Patient Identifier (UPID) of the patient that this resource is associated with | ||
created_at | timestamp | Timestamp when this resource was first recorded in this system | ||
resource_json | varchar | No | Original JSON document for this resource | |
data_source | varchar | Name of the data partner network that provided this data |
immunization_identifier
This is a bridge table that joins the immunization table to the identifier table
Column Name | Data Type | Nullable | References | Description |
---|---|---|---|---|
immunization_id | varchar | No | immunization | ID of the Immunization that this identifier belongs to |
identifier_id | varchar | identifier | ID of the Identifier |
immunization_note
This table contains freeform text notes with extra information about the Immunization that is not captured in other attributes
Column Name | Data Type | Nullable | References | Description |
---|---|---|---|---|
immunization_id | varchar | No | immunization | ID of the Immunization that this note belongs to |
text_markdown | varchar | The annotation - text content (as markdown) |
immunization_status_reason
The immunization status reason indicates the reason the immunization event was not performed. This table contains the primary keys of all unique concept groups that represent the immunization status reasons. Individual codings within each group are in the immunization_status_reason_coding table.
Column Name | Data Type | Nullable | References | Description |
---|---|---|---|---|
id | varchar | No | ID of status season | |
display | varchar | Plain text representation of the immunization status reason. This field comes from the "text" field in the codeable concept group |
immunization_status_reason_coding
This relation contains the individual coding values for each immunization status reason.
Column Name | Data Type | Nullable | References | Description |
---|---|---|---|---|
immunization_status_reason_id | varchar | immunization_status_reason | ID of the Immunization statusReason | |
system | varchar | URI of the terminology system | ||
code | varchar | Code symbol defined by the terminology system | ||
display | varchar | Human-readable string representing the code |
immunization_vaccine_code
The immunization vaccine code encodes the vaccine that was administered or was to be administered. This table contains the primary keys of all unique concept groups that represent the immunization vaccine codes. Individual codings within each group are in the immunization_vaccine_code_coding table.
Column Name | Data Type | Nullable | References | Description |
---|---|---|---|---|
id | varchar | No | ID of code | |
display | varchar | Plain text representation of the immunization vaccine code. This field comes from the "text" field in the codeable concept group |
immunization_vaccine_code_coding
This relation contains the individual coding values for each immunization vaccine code.
Column Name | Data Type | Nullable | References | Description |
---|---|---|---|---|
immunization_vaccine_code_id | varchar | immunization_vaccine_code | ID of the Immunization vaccineCode | |
system | varchar | URI of the terminology system | ||
code | varchar | Code symbol defined by the terminology system | ||
display | varchar | Human-readable string representing the code |
lens_encounter
A summarized Encounter deduplicated by ActEncounter code
Column Name | Data Type | Nullable | References | Description |
---|---|---|---|---|
id | varchar | No | Logical ID (UUID) of the Encounter. This value is globally unique | |
version | varchar | No | Current version of this Encounter. This indicates whether this Encounter has been updated. | |
last_updated | varchar | No | Timestamp this record was last updated, formatted as ISO 8601 timestamp | |
status | varchar | A code specifying the state of the Encounter. Possible values: planned | arrived | triaged | in-progress | onleave | finished | cancelled | ||
class_code | varchar | Code that classifies the patient encounter such as ambulatory (outpatient), inpatient, emergency, home health or others due to local variations. Values for this field come from the HL7 v3 ActEncounterCode value set. The values chosen for this column prioritize values written by the Zus Data Enrichment service, and may not always match the value of the "class" field in the raw JSON document. | ||
class_display | varchar | Display text of the encounter class, taken from the enriched code. | ||
lens_encounter_type_id | varchar | lens_encounter_type | ID of the concept expressing the ActEncounter Code (AMB, IMP, EMER, etc.) of the Encounter This column encodes first the encounter type in the FHIR Encounter resource. Although a small number of encounters have multiple entries in the type element, the information related to the encounter class is currently always in the first type entry. | |
period_start | timestamp | Start time (inclusive) of the Encounter | ||
period_end | timestamp | End time (inclusive) of the Encounter | ||
lens_encounter_hospitalization_discharge_disposition_id | varchar | lens_encounter_hospitalization_discharge_disposition | ID of the concept encoding the category or kind of location after discharge | |
location_id | varchar | location | ID of the Location where the Encounter took place. If multiple locations are associated with the Encounter, only the first is shown in the column. | |
builder_id | varchar | ID of the Builder account that provided this data | ||
upid | varchar | Unique Patient Identifier (UPID) of the patient that this resource is associated with | ||
created_at | timestamp | Timestamp when this resource was first recorded in this system | ||
resource_json | varchar | No | Original JSON document for this resource |
lens_encounter_aggregated_from
This relation joins Lens Encounter resources to Zus aggregatedFrom extensions. The Zus aggregated from extension lists the Encounter resources that were used to generate this output resource.
Column Name | Data Type | Nullable | References | Description |
---|---|---|---|---|
lens_encounter_id | varchar | No | lens_encounter | ID of the Lens Encounter that this record belongs to |
encounter_id | varchar | encounter | ID of the encounter this lens encounter is aggregated from |
lens_encounter_diagnosis
The list of diagnosis relevant to Lens Encounters
Column Name | Data Type | Nullable | References | Description |
---|---|---|---|---|
lens_encounter_id | varchar | No | lens_encounter | ID of the Lens Encounter that this diagnosis belongs to |
lens_snomed_condition_id | varchar | lens_snomed_condition | ID of the condition relevant to the lens encounter |
lens_encounter_hospitalization_discharge_disposition
The discharge disposition represents the category or kind of location after discharge. This table contains the primary keys of all unique concept groups that represent the discharge dispositions. Individual codings within each group are in the encounter_hospitalization_discharge_disposition_coding table.
Column Name | Data Type | Nullable | References | Description |
---|---|---|---|---|
id | varchar | No | ID of the Lens Encounter Hospitalization Discharge Disposition | |
display | varchar | Plain text representation of the encounter hospitalization discharge disposition. This field comes from the "text" field in the codeable concept group |
lens_encounter_hospitalization_discharge_disposition_coding
This relation contains the individual coding values for each encounter hospitalization discharge disposition.
Column Name | Data Type | Nullable | References | Description |
---|---|---|---|---|
lens_encounter_hospitalization_discharge_disposition_id | varchar | lens_encounter_hospitalization_discharge_disposition | ID of the Lens Encounter Hospitalization Discharge Disposition | |
system | varchar | URI of the terminology system | ||
code | varchar | Code symbol defined by the terminology system | ||
display | varchar | Human-readable string representing the code |
lens_encounter_identifier
This is a bridge table that joins the lens encounter table to the identifier table
Column Name | Data Type | Nullable | References | Description |
---|---|---|---|---|
lens_encounter_id | varchar | No | lens_encounter | ID of the Encounter that this identifier belongs to |
identifier_id | varchar | identifier | ID of the Identifier |
lens_encounter_participant
A Lens Encounter Participant represents the list of people involved in the Lens Encounter.
Column Name | Data Type | Nullable | References | Description |
---|---|---|---|---|
lens_encounter_id | varchar | No | lens_encounter | ID of the Lens Encounter that this participant belongs to |
individual_practitioner_id | varchar | practitioner | ID of the Participant who was involved in the encounter |
lens_encounter_related_binaries
Zus derives Lens Encounter resources from encounter resources sourced from CDA documents, which are stored in Zus as binary resources. This table lists the binary resource IDs from which a Lens Encounter resource was derived. The logic by which Lens Encounter resources are derived is described here https://docs.zushealth.com/docs/viewing-zus-data-with-a-lens#encounter-lens.
Column Name | Data Type | Nullable | References | Description |
---|---|---|---|---|
lens_encounter_id | varchar | No | lens_encounter | ID of the Lens Encounter that this belongs to |
binary_id | varchar | ID of the Binary this encounter is related to |
lens_encounter_type
The encounter type specifies the type of encounter (e.g. e-mail consultation, surgical day-care, skilled nursing, rehabilitation). This table contains the primary keys of all unique concept groups that represent the encounter types. Individual codings within each group are in the encounter_type_coding table.
Column Name | Data Type | Nullable | References | Description |
---|---|---|---|---|
id | varchar | No | ID of the Encounter Type | |
display | varchar | Plain text representation of the encounter type. This field comes from the "text" field in the codeable concept group |
lens_encounter_type_coding
This relation contains the individual coding values for each encounter type.
Column Name | Data Type | Nullable | References | Description |
---|---|---|---|---|
lens_encounter_type_id | varchar | lens_encounter_type | ID of the Encounter type | |
system | varchar | URI of the terminology system | ||
code | varchar | Code symbol defined by the terminology system | ||
display | varchar | Human-readable string representing the code | ||
user_selected | tinyint | If this coding was chosen directly by the user |
lens_rxnorm_medication_statement
A summarized MedicationStatement deduplicated by RxNorm code, aggregated from other medication statements, medication requests, dispenses, and administrations.
Column Name | Data Type | Nullable | References | Description |
---|---|---|---|---|
id | varchar | No | Logical ID (UUID) of the MedicationStatement. This value is globally unique | |
version | varchar | No | Current version of this MedicationStatement. This indicates whether this Observation has been updated. | |
last_updated | varchar | No | Timestamp this record was last updated, formatted as ISO 8601 timestamp | |
status | varchar | The status of the result value | ||
medication_concept_id | varchar | codeable_concept_coding | ID of the medication concept that identifies the medication | |
code_rxnorm | varchar | RxNorm code of the associated medication, extracted from the FHIR medicationCodeableConcept field where the system matches http://www.nlm.nih.gov/research/umls/rxnorm. These codes have been normalized with the Zus Data Enrichment service. | ||
code_ndc | varchar | NDC code of the associated medication, extracted from the FHIR medicationCodeableConcept field where the system matches http://hl7.org/fhir/sid/ndc | ||
code_display | varchar | Display text of the associated medication, extracted from the FHIR medicationCodeableConcept.text field | ||
subject_patient_id | varchar | ID of the Patient who is/was taking the medication | ||
date_asserted | timestamp | The date when the medication statement was asserted by the information source | ||
refills | int | Number of medication refills for this. This field is added as an extension to the MedicationStatement resource by the Zus Data Summarization service. | ||
last_fill_date | timestamp | Date(/time) that this medication was last filled. This field is added as an extension to the MedicationStatement resource by the Zus Data Summarization service. | ||
prescribed_date | timestamp | date that this medication was last prescribed. This field is added as an extension to the MedicationStatement resource by the Zus Data Summarization service. | ||
days_supply | timestamp | Days supply of the medication. This field is added as an extension to the MedicationStatement resource by the Zus Data Summarization service. | ||
quantity | timestamp | Quantity of the medication. This field is added as an extension to the MedicationStatement resource by the Zus Data Summarization service. | ||
quantity_unit | timestamp | Unit of the quantity of the medication. This field is added as an extension to the MedicationStatement resource by the Zus Data Summarization service. | ||
last_prescriber_practitioner_id | varchar | practitioner | ID of the Practitioner that prescribed the medication. This field is added as an extension to the MedicationStatement resource by the Zus Data Summarization service. | |
last_prescriber_medication_request_id | varchar | medication_request | ID of the MedicationRequest associated with the last prescription of this medication. This field is added as an extension to the MedicationStatement resource by the Zus Data Summarization service. from lens output | |
builder_id | varchar | ID of the Builder that provided this data | ||
upid | varchar | Universal Patient Identifier of the Patient this Observation is part of | ||
created_at | timestamp | Timestamp when this Observation was first recorded in this system | ||
resource_json | varchar | No | Original JSON document for this Observation |
lens_snomed_condition
A Lens SNOMED Condition represents a clinical condition, problem, diagnosis, or other event, situation, issue, or clinical concept that has risen to a level of concern.
Column Name | Data Type | Nullable | References | Description |
---|---|---|---|---|
id | varchar | No | Resource ID (UUID) of the Condition | |
version | varchar | No | Current version of this resource. This indicates whether the resource has been updated. | |
last_updated | timestamp | No | Timestamp this resource was last updated, formatted as ISO 8601 timestamp | |
clinical_status | varchar | The status of the Lens SNOMED Condition (active | recurrence | relapse | inactive | remission | resolved) | ||
lens_snomed_condition_code_id | varchar | lens_snomed_condition_code | ID of the Lens SNOMED Condition Code | |
code_snomed | varchar | SNOMED code of Lens SNOMED Condition | ||
code_icd10cm | varchar | ICD-10-CM code of Lens SNOMED Condition | ||
code_cci | varchar | CCI code of Lens SNOMED Condition | ||
code_ccs | varchar | Lens SNOMED Condition's CCS category based on the Clinical Classifications Software Refined (CCSR) aggregation of ICD-10-CM/PCS codes into clinically meaningful categories, as derived by Zus. | ||
code_hcc | varchar | HCC code of Lens SNOMED Condition | ||
code_display | varchar | Display value of Lens SNOMED Condition Code | ||
subject_patient_id | varchar | ID of the Patient who has the Lens SNOMED Condition | ||
onset | timestamp | Onset of the Lens SNOMED Condition | ||
recorded_date | timestamp | Date Lens SNOMED Condition was first recorded | ||
builder_id | varchar | ID of the Builder account that provided this data | ||
upid | varchar | Unique Patient Identifier (UPID) of the patient that this resource is associated with | ||
created_at | timestamp | Timestamp when this resource was first recorded in this system | ||
resource_json | varchar | No | Original JSON document for this resource |
lens_snomed_condition_code
The condition code represents a detailed description of the type of condition; e.g. what this, what diagnosis, what kind of problem. This table contains the primary keys of all unique concepts representing condition codes. Individual codings within each group are in the lens_snomed_condition_code_coding table.
Column Name | Data Type | Nullable | References | Description |
---|---|---|---|---|
id | varchar | No | ID of Lens SNOMED Condition Code | |
display | varchar | Plain text representation of the lens snomed condition code. This field comes from the "text" field in the codeable concept group |
lens_snomed_condition_code_coding
This relation contains the individual coding values for each lens snomed condition code.
Column Name | Data Type | Nullable | References | Description |
---|---|---|---|---|
lens_snomed_condition_code_id | varchar | lens_snomed_condition_code | ID of the Lens SNOMED Condition Code | |
system | varchar | URI of the terminology system | ||
code | varchar | Code symbol defined by the terminology system | ||
display | varchar | Human-readable string representing the code | ||
user_selected | tinyint | If this coding was chosen directly by the user | ||
enrichment_type | varchar | Type of enrichment |
lens_transition_of_care
A FHIR LensTransitionOfCare describes the association between a patient and an organization / healthcare provider(s) during which time encounters may occur. The managing organization assumes a level of responsibility for the patient during this time.
Column Name | Data Type | Nullable | References | Description |
---|---|---|---|---|
id | varchar | No | Resource ID (UUID) of the EpisodeOfCare | |
version | varchar | No | Current version of this resource. This indicates whether the resource has been updated. | |
last_updated | timestamp | No | Timestamp this resource was last updated, formatted as ISO 8601 timestamp | |
status | varchar | A code specifying the state of the LensTransitionOfCare. Possible values: planned | waitlist | active | onhold | finished | cancelled | entered-in-error | ||
patient_id | varchar | patient | ID of the Patient who is the focus of this lens transition of care. | |
period_start | timestamp | Start of the interval during responsibility is assumed | ||
period_end | timestamp | End of the interval during responsibility is assumed | ||
admitting_location_id | varchar | location | The Zus admitting location extension denotes the location of the most recent emergency encounter in the transition. | |
encounter_class_code | varchar | The Zus encounter class extension denotes the most recent "encounter class" in the transition (e.g. EMER, IMP) | ||
encounter_class_display | varchar | Display text of the most recent encounter class in the transition | ||
discharge_location_id | varchar | location | The Zus discharge location extension denotes the location of the most recent inpatient encounter in the transition. | |
lens_transition_of_care_discharge_disposition_id | varchar | lens_transition_of_care_discharge_disposition | The Zus discharge disposition extension denotes the most recent discharge disposition for the transition. | |
builder_id | varchar | ID of the Builder account that provided this data | ||
upid | varchar | Unique Patient Identifier (UPID) of the patient that this resource is associated with | ||
created_at | timestamp | Timestamp when this resource was first recorded in this system | ||
resource_json | varchar | No | Original JSON document for this resource | |
data_source | varchar | Name of the data partner network that provided this data |
lens_transition_of_care_adt_message
ADT message details associated with each LensTransitionOfCare
Column Name | Data Type | Nullable | References | Description |
---|---|---|---|---|
lens_transition_of_care_id | varchar | No | lens_transition_of_care | ID of the EpisodeOfCare that this aggregated from belongs to |
message_type | varchar | HL7 ADT message type | ||
document_reference_id | varchar | document_reference | ID of the DocumentReference for the ADT message | |
message_effective_time | varchar | Date or time of the ADT message |
lens_transition_of_care_aggregated_from
This relation joins LensTransitionOfCare resources to Zus aggregatedFrom extensions. The Zus aggregated from extension lists the Encounter resources that were used to generate this output resource.
Column Name | Data Type | Nullable | References | Description |
---|---|---|---|---|
lens_transition_of_care_id | varchar | No | lens_transition_of_care | ID of the EpisodeOfCare that this aggregated from belongs to |
encounter_id | varchar | encounter | ID of the Encounter this lens transition of care is aggregated from |
lens_transition_of_care_diagnosis
The list of diagnosis relevant to this LensTransitionOfCare
Column Name | Data Type | Nullable | References | Description |
---|---|---|---|---|
lens_transition_of_care_id | varchar | No | lens_transition_of_care | ID of the EpisodeOfCare that this diagnosis belongs to |
condition_id | varchar | condition | ID of the Conditions/problems/diagnoses this lens transition of care is for | |
role_code | varchar | Code that describes role that this diagnosis has within the LensTransitionOfCare (e.g. admission, billing, discharge ...) | ||
role_display | varchar | Display that describes role that this diagnosis has within the LensTransitionOfCare (e.g. admission, billing, discharge ...) |
lens_transition_of_care_discharge_disposition
This table represents the discharge disposition of the patient at the end of the transition of care. This table contains the primary keys of all unique concept groups that represent the discharge dispositions. Individual codings within each group are in the lens_transition_of_care_discharge_disposition_coding table.
Column Name | Data Type | Nullable | References | Description |
---|---|---|---|---|
id | varchar | No | ID of discharge disposition | |
display | varchar | Plain text representation of the lens transition of care discharge disposition. This field comes from the "text" field in the codeable concept group |
lens_transition_of_care_discharge_disposition_coding
This relation contains the individual coding values for each lens transition of care discharge disposition.
Column Name | Data Type | Nullable | References | Description |
---|---|---|---|---|
lens_transition_of_care_discharge_disposition_id | varchar | lens_transition_of_care_discharge_disposition | ID of the LensTransitionOfCare Discharge Disposition | |
system | varchar | URI of the terminology system | ||
code | varchar | Code symbol defined by the terminology system | ||
display | varchar | Human-readable string representing the code |
lens_transition_of_care_identifier
This is a bridge table that joins the lens_transition_of_care table to the identifier table
Column Name | Data Type | Nullable | References | Description |
---|---|---|---|---|
lens_transition_of_care_id | varchar | No | lens_transition_of_care | ID of the EpisodeOfCare that this identifier belongs to |
identifier_id | varchar | identifier | ID of the Identifier |
location
Details and position information for a physical place where services are provided and resources and participants may be stored, found, contained, or accommodated.
Column Name | Data Type | Nullable | References | Description |
---|---|---|---|---|
id | varchar | No | Resource ID (UUID) of the Location | |
version | varchar | No | Current version of this resource. This indicates whether the resource has been updated. | |
last_updated | timestamp | No | Timestamp this resource was last updated, formatted as ISO 8601 timestamp | |
name | varchar | Name of the location as used by humans | ||
mode | varchar | instance | kind | ||
location_type_id | varchar | location_type | ID of the concept encoding the type of function performed | |
address_line_1 | varchar | First line of the address | ||
address_line_2 | varchar | Second line of the address | ||
address_city | varchar | City name in address | ||
address_state | varchar | State name in address | ||
address_postal_code | varchar | Postal code in address | ||
location_physical_type_id | varchar | location_physical_type | ID of the concept encoding the physical form of this location: https://www.hl7.org/fhir/r4/valueset-location-physical-type.html | |
builder_id | varchar | ID of the Builder account that provided this data | ||
created_at | timestamp | Timestamp when this resource was first recorded in this system | ||
resource_json | varchar | No | Original JSON document for this resource | |
data_source | varchar | Name of the data partner network that provided this data |
location_identifier
This is a bridge table that joins the location table to the identifier table
Column Name | Data Type | Nullable | References | Description |
---|---|---|---|---|
location_id | varchar | No | location | ID of the Location that this identifier belongs to |
identifier_id | varchar | identifier | ID of the Identifier |
location_physical_type
The location physical type represents the physical form of a location, e.g. building, room, vehicle, road. This table contains the primary keys of all unique concept groups that represent the location physical types. Individual codings within each group are in the location_physical_type_coding table.
Column Name | Data Type | Nullable | References | Description |
---|---|---|---|---|
id | varchar | No | ID of Location physicalType | |
display | varchar | Plain text representation of the location physical type. This field comes from the "text" field in the codeable concept group |
location_physical_type_coding
This relation contains the individual coding values for each location physical type.
Column Name | Data Type | Nullable | References | Description |
---|---|---|---|---|
location_physical_type_id | varchar | location_physical_type | ID of the Location physicalType | |
system | varchar | URI of the terminology system | ||
code | varchar | Code symbol defined by the terminology system | ||
display | varchar | Human-readable string representing the code |
location_telecom
Contact details of the Location
Column Name | Data Type | Nullable | References | Description |
---|---|---|---|---|
location_id | varchar | No | location | ID of the Location that this telecom belongs to |
contact_point_id | varchar | contact_point | ID of the contact details |
location_type
The location type indicates the type of function performed at a location. This table contains the primary keys of all unique concept groups that represent the location types. Individual codings within each group are in the location_type_coding table.
Column Name | Data Type | Nullable | References | Description |
---|---|---|---|---|
id | varchar | No | ID of Location type | |
display | varchar | Plain text representation of the location type. This field comes from the "text" field in the codeable concept group |
location_type_coding
This relation contains the individual coding values for each location type.
Column Name | Data Type | Nullable | References | Description |
---|---|---|---|---|
location_type_id | varchar | location_type | ID of the Location type | |
system | varchar | URI of the terminology system | ||
code | varchar | Code symbol defined by the terminology system | ||
display | varchar | Human-readable string representing the code |
medication
The FHIR Medication resource is used for the identification and definition of a medication for the purposes of prescribing, dispensing, and administering a medication as well as for making statements about medication use.
Column Name | Data Type | Nullable | References | Description |
---|---|---|---|---|
id | varchar | No | Resource ID (UUID) of the Medication | |
version | varchar | No | Current version of this resource. This indicates whether the resource has been updated. | |
last_updated | timestamp | No | Timestamp this resource was last updated, formatted as ISO 8601 timestamp | |
medication_concept_id | varchar | medication_concept | ID of the concept group ientifiying this Medication. THis column comes from the Medication.code field in FHIR. | |
medication_form_id | varchar | medication_form | ID of the Form encoding the form of the medication - powder | tablets | capsule + | |
builder_id | varchar | ID of the Builder account that provided this data | ||
created_at | timestamp | Timestamp when this resource was first recorded in this system | ||
resource_json | varchar | No | Original JSON document for this resource | |
data_source | varchar | Name of the data partner network that provided this data |
medication_administration
FHIR MedicationAdministration describes the event of a patient consuming or otherwise being administered a medication. This may be as simple as swallowing a tablet or it may be a long running infusion. Related resources tie this event to the authorizing prescription, and the specific encounter between patient and health care practitioner.
Column Name | Data Type | Nullable | References | Description |
---|---|---|---|---|
id | varchar | No | Resource ID (UUID) of the MedicationAdministration | |
version | varchar | No | Current version of this resource. This indicates whether the resource has been updated. | |
last_updated | timestamp | No | Timestamp this resource was last updated, formatted as ISO 8601 timestamp | |
status | varchar | A code specifying the state of the MedicationAdministration. Possible values: in-progress | not-done | on-hold | completed | entered-in-error | stopped | unknown | ||
medication_concept_id | varchar | medication_concept | ID of the medication concept that identifies the medication being administered | |
subject_patient_id | varchar | patient | ID of the Patient who the procedure was performed on | |
effective_start | timestamp | Start time (inclusive) of the administered Medication being effective. | ||
effective_end | timestamp | End time (inclusive) of the administered Medication being effective. | ||
dosage_route_concept_id | varchar | route_concept | ID of the concept of the path of substance into body. | |
dosage_dose_unit | varchar | Unit of dosage of Medication. | ||
dosage_dose_value | int | Value of dosage of Medication. | ||
builder_id | varchar | ID of the Builder account that provided this data | ||
upid | varchar | Unique Patient Identifier (UPID) of the patient that this resource is associated with | ||
created_at | timestamp | Timestamp when this resource was first recorded in this system | ||
resource_json | varchar | No | Original JSON document for this resource | |
data_source | varchar | Name of the data partner network that provided this data |
medication_administration_identifier
This is a bridge table that joins the medication_administration table to the identifier table
Column Name | Data Type | Nullable | References | Description |
---|---|---|---|---|
medication_administration_id | varchar | No | medication_administration | ID of the MedicationAdministration that this identifier belongs to |
identifier_id | varchar | identifier | ID of the Identifier |
medication_administration_reason_code
The reason code indicates why the medication was given. This table contains the extracted SNOMED codes of the medication administration reason codes.
Column Name | Data Type | Nullable | References | Description |
---|---|---|---|---|
medication_administration_id | varchar | No | medication_administration | ID of the MedicationAdministration that this reason code belongs to |
snomed | varchar | SNOMED code of the reason for the MedicationAdministration |
medication_administration_reason_reference
Condition that supports why the medication was administered
Column Name | Data Type | Nullable | References | Description |
---|---|---|---|---|
medication_administration_id | varchar | No | medication_administration | ID of the MedicationAdministration that this reason reference belongs to |
condition_id | varchar | condition | ID of the Condition expressing the specific Reason for MedicationAdministration. |
medication_dispense
This resource covers the supply of medications to a patient. Examples include dispensing and pick-up from an outpatient or community pharmacy, dispensing patient-specific medications from inpatient pharmacy to ward, as well as issuing a single dose from ward stock to a patient for consumption. The medication dispense is the result of a pharmacy system responding to a medication order.
Column Name | Data Type | Nullable | References | Description |
---|---|---|---|---|
id | varchar | No | Resource ID (UUID) of the MedicationDispense | |
version | varchar | No | Current version of this resource. This indicates whether the resource has been updated. | |
last_updated | timestamp | No | Timestamp this resource was last updated, formatted as ISO 8601 timestamp | |
status | varchar | Medication dispense status. Possible values: preparation | in-progress | cancelled | on-hold | completed | entered-in-error | stopped | declined | unknown | ||
medication_id | varchar | No | medication | ID of the Medication that is being dispensed |
medication_concept_id | varchar | medication_concept | ID of the medication concept that identifies the medication being dispensed | |
code_ndc | varchar | NDC code of the medication, extracted from the FHIR medicationCodeableConcept field where the system matches http://hl7.org/fhir/sid/ndc | ||
display_ndc | varchar | Plain text representation of the medication dispensed | ||
code_rxnorm | varchar | RxNorm code of the medication, extracted from the FHIR medicationCodeableConcept field where the system matches http://www.nlm.nih.gov/research/umls/rxnorm. When there are multiple RxNorm codes on the resource, we prioritize the code written by the Zus Data Enrichment service. | ||
refill_number | int | Refill number of this medication. This value is written as an extension on the FHIR resource, and is only supplied for data coming from Surescripts. | ||
subject_patient_id | varchar | patient | ID of the patient who the dispense is for | |
performer_actor_organization_id | varchar | organization | ID of the Organization that performed the dispense | |
location_id | varchar | location | ID of the location where the dispense occurred | |
authorizing_prescription_medication_request_id | varchar | medication_request | ID of the MedicationRequest that is being dispensed against | |
type_code | varchar | Type of medication dispense | ||
type_display | varchar | Display text for the type of medication dispense | ||
quantity_unit | varchar | Unit of the amount dispensed | ||
quantity_value | decimal | Amount dispensed | ||
days_supply | int | Amount of medication expressed as a timing amount | ||
when_prepared | timestamp | When product was packaged and reviewed | ||
when_handed_over | timestamp | When the medication was sent | ||
dosage_instruction | varchar | How the medication is to be used by the patient or administered by the caregiver | ||
builder_id | varchar | ID of the Builder account that provided this data | ||
upid | varchar | Unique Patient Identifier (UPID) of the patient that this resource is associated with | ||
created_at | timestamp | Timestamp when this resource was first recorded in this system | ||
resource_json | varchar | No | Original JSON document for this resource | |
data_source | varchar | Name of the data partner network that provided this data |
medication_dispense_identifier
This is a bridge table that joins the medication_dispense table to the identifier table
Column Name | Data Type | Nullable | References | Description |
---|---|---|---|---|
medication_dispense_id | varchar | No | medication_dispense | ID of the MedicationDispense that this identifier belongs to |
identifier_id | varchar | identifier | ID of the Identifier |
medication_form
The medication form describes the form of the medication, e.g. tablet, capsule, powder, etc. This table contains the primary keys of all unique concept groups that represent the medication forms. Individual codings within each group are in the medication_form_coding table.
Column Name | Data Type | Nullable | References | Description |
---|---|---|---|---|
id | varchar | No | ID of code | |
display | varchar | Plain text representation of the medication form. This field comes from the "text" field in the codeable concept group |
medication_form_coding
This relation contains the individual coding values for each medication form.
Column Name | Data Type | Nullable | References | Description |
---|---|---|---|---|
medication_form_id | varchar | medication_form | ID of the Medication Form | |
system | varchar | URI of the terminology system | ||
code | varchar | Code symbol defined by the terminology system | ||
display | varchar | Human-readable string representing the code |
medication_ingredient
The medication ingredient identifies a particular constituent of interest in the product.
Column Name | Data Type | Nullable | References | Description |
---|---|---|---|---|
medication_id | varchar | No | medication | ID of the Medication that this ingredient belongs to |
medication_ingredient_item_code_id | varchar | medication_ingredient_item_code | ID of the item code encoding the actual ingredient or content |
medication_ingredient_item_code
The medicaiton ingredient item code represents the actual ingredient - either a substance (simple ingredient) or another medicationof a medication. This table contains the primary keys of all unique concept groups that represent the medication ingredient item codes. Individual codings within each group are in the medication_ingredient_item_code_coding table.
Column Name | Data Type | Nullable | References | Description |
---|---|---|---|---|
id | varchar | No | ID of code | |
display | varchar | Plain text representation of the medication ingredient item code. This field comes from the "text" field in the codeable concept group |
medication_ingredient_item_code_coding
This relation contains the individual coding values for each medication ingredient item code.
Column Name | Data Type | Nullable | References | Description |
---|---|---|---|---|
medication_ingredient_item_code_id | varchar | medication_ingredient_item_code | ID of the Medication Ingredient Item Code | |
system | varchar | URI of the terminology system | ||
code | varchar | Code symbol defined by the terminology system | ||
display | varchar | Human-readable string representing the code |
medication_request
A FHIR MedicationRequest resource represents nn order or request for both supply of the medication and the instructions for administration of the medication to a patient.
Column Name | Data Type | Nullable | References | Description |
---|---|---|---|---|
id | varchar | No | Resource ID (UUID) of the MedicationRequest | |
version | varchar | No | Current version of this resource. This indicates whether the resource has been updated. | |
last_updated | timestamp | No | Timestamp this resource was last updated, formatted as ISO 8601 timestamp | |
status | varchar | Current state of the order. Generally, this will be active or completed state. Possible values: active | on-hold | cancelled | completed | entered-in-error | stopped | draft | unknown | ||
intent | varchar | Whether the request is a proposal, plan, or an original order. Possible values: proposal | plan | order | original-order | reflex-order | filler-order | instance-order | option | ||
medication_request_category_id | varchar | medication_request_category | ID of the medication request category, which indicates the type of medication request (for example, where the medication is expected to be consumed or administered (i.e. inpatient or outpatient)). The FHIR MedicationRequest resource allows multiple values for the category, but all MedicationRequest resoruces in our data are currently limtied to one category. | |
medication_id | varchar | No | medication | ID of the Medication that this request belongs to |
medication_concept_id | varchar | medication_concept | ID of the medication concept that identifies the medication being requested | |
code_rxnorm | varchar | RxNorm code of the associated medication, extracted from the FHIR medicationCodeableConcept field where the system matches http://www.nlm.nih.gov/research/umls/rxnorm. These codes have been normalized with the Zus Data Enrichment service. | ||
code_ndc | varchar | NDC code of this medication, extracted from the FHIR medicationCodeableConcept field where the system matches http://hl7.org/fhir/sid/ndc | ||
code_display | varchar | Display text of the medication code, extracted from the FHIR medicationCodeableConcept.text field | ||
subject_patient_id | varchar | patient | ID of the Patient who or group MedicationRequest is for | |
encounter_id | varchar | encounter | ID of the Encounter created as part of encounter/admission/stay | |
authored_on | timestamp | When request was initially authored | ||
requester_practitioner_id | varchar | practitioner | ID of the Practitioner who requested the Request | |
dosage_id | varchar | dosage | ID of Dosage to be applied | |
initial_fill_quantity | decimal | Medication supply authorization, first fill details - value | ||
number_of_repeats_allowed | decimal | Number of refills authorized | ||
quantity | decimal | Amount of medication to supply per dispense | ||
performer_organization_id | varchar | organization | The ID of the Organization intended dispenser | |
substitution_allowed | tinyint | True if any restrictions on medication substitution | ||
builder_id | varchar | ID of the Builder account that provided this data | ||
upid | varchar | Unique Patient Identifier (UPID) of the patient that this resource is associated with | ||
created_at | timestamp | Timestamp when this resource was first recorded in this system | ||
resource_json | varchar | No | Original JSON document for this resource | |
data_source | varchar | Name of the data partner network that provided this data |
medication_request_category
The medication request category indicates the type of medication request (for example, where the medication is expected to be consumed or administered (i.e. inpatient or outpatient)). This table contains the primary keys of all unique concept groups that represent the medication request categories. Individual codings within each group are in the medication_request_category_coding table.
Column Name | Data Type | Nullable | References | Description |
---|---|---|---|---|
id | varchar | No | ID of category | |
display | varchar | Plain text representation of the medication request category. This field comes from the "text" field in the codeable concept group |
medication_request_category_coding
This relation contains the individual coding values for each medication request category.
Column Name | Data Type | Nullable | References | Description |
---|---|---|---|---|
medication_request_category_id | varchar | medication_request_category | ID of the Medication Request Category | |
system | varchar | URI of the terminology system | ||
code | varchar | Code symbol defined by the terminology system | ||
display | varchar | Human-readable string representing the code |
medication_request_identifier
This is a bridge table that joins the medication_request table to the identifier table
Column Name | Data Type | Nullable | References | Description |
---|---|---|---|---|
medication_request_id | varchar | No | medication_request | ID of the MedicationRequest that this identifier belongs to |
identifier_id | varchar | identifier | ID of the Identifier |
medication_request_note
This table contains freeform text notes with extra information about the MedicationRequest that is not captured in other attributes
Column Name | Data Type | Nullable | References | Description |
---|---|---|---|---|
medication_request_id | varchar | No | medication_request | ID of the MedicationRequest that this note belongs to |
text_markdown | varchar | The annotation - text content (as markdown) |
medication_request_reason_code_bridge
The medication request reason code encodes the reason for ordering or not ordering a medication. This is a bridge table that joins MedicationRequest resources to the reason code concept. Individual codings within each group are in the medication_request_reason_code_coding table.
Column Name | Data Type | Nullable | References | Description |
---|---|---|---|---|
medication_request_reason_code_id | varchar | No | ID of the medication request reason code | |
display | varchar | Plain text representation of the medication request reason code. This field comes from the "text" field in the codeable concept group |
medication_request_reason_reference
This relation joins MedicationRequest to the Condition that supports why the prescription is being written.
Column Name | Data Type | Nullable | References | Description |
---|---|---|---|---|
medication_request_id | varchar | No | medication_request | ID of the MedicationRequest that this reason reference belongs to |
condition_id | varchar | condition | ID of the Condition that supports why the prescription is being written |
medication_request_reason_code_coding
This relation contains the individual coding values for each medication request reason code.
Column Name | Data Type | Nullable | References | Description |
---|---|---|---|---|
medication_request_reason_code_id | varchar | medication_request_reason_code | ID of the Medication Request Reason Code | |
system | varchar | URI of the terminology system | ||
code | varchar | Code symbol defined by the terminology system | ||
display | varchar | Human-readable string representing the code |
medication_statement
A FHIR MedicationStatement represents a record of a medication that is being consumed by a patient. A MedicationStatement may indicate that the patient may be taking the medication now or has taken the medication in the past or will be taking the medication in the future
Column Name | Data Type | Nullable | References | Description |
---|---|---|---|---|
id | varchar | No | Resource ID (UUID) of the MedicationStatement | |
version | varchar | No | Current version of this resource. This indicates whether the resource has been updated. | |
last_updated | varchar | No | Timestamp this resource was last updated, formatted as ISO 8601 timestamp | |
status | varchar | The status of the result value | ||
medication_concept_id | varchar | codeable_concept_coding | ID of the medication concept that identifies the medication | |
code_rxnorm | varchar | RxNorm code of this MedicationStatement, extracted from the FHIR medicationCodeableConcept field where the system matches http://www.nlm.nih.gov/research/umls/rxnorm. While multiple RxNorm codes can be provided in the resource, we prioritize the code written by the Zus Enrichment service. | ||
code_ndc | varchar | NDC code of this MedicationStatement, extracted from the FHIR medicationCodeableConcept field where the system matches http://hl7.org/fhir/sid/ndc. | ||
code_display | varchar | Display text for the medication code, extracted from the FHIR medicationCodeableConcept.text field. | ||
subject_patient_id | varchar | patient | ID of the Patient who is/was taking the medication | |
context_encounter_id | varchar | ID of the Encounter associated with the MedicationStatement | ||
effective_start | timestamp | The start of the interval of time during which it is being asserted that the patient is/was/will be taking the medication (or was not taking, when the MedicationStatement.taken element is No) | ||
effective_end | timestamp | The end of the interval of time during which it is being asserted that the patient is/was/will be taking the medication (or was not taking, when the MedicationStatement.taken element is No) | ||
date_asserted | timestamp | The date when the medication statement was asserted by the information source | ||
builder_id | varchar | ID of the Builder account that provided this data | ||
upid | varchar | Unique Patient Identifier (UPID) of the patient that this resource is associated with | ||
created_at | timestamp | Timestamp when this resource was first recorded in this system | ||
resource_json | varchar | No | Original JSON document for this resource | |
data_source | varchar | Name of the data partner network that provided this data |
medication_statement_dosage
This is a bridge table that joins the medication_statement table to the dosage table.
Column Name | Data Type | Nullable | References | Description |
---|---|---|---|---|
medication_statement_id | varchar | No | medication_statement | ID of the MedicationStatement that this dosage belongs to |
dosage_id | varchar | dosage | ID of the Dosage |
medication_statement_identifier
This is a bridge table that joins the medication_statement table to the identifier table
Column Name | Data Type | Nullable | References | Description |
---|---|---|---|---|
medication_statement_id | varchar | No | medication_statement | ID of the MedicationStatement that this identifier belongs to |
identifier_id | varchar | identifier | ID of the Identifier |
medication_statement_note
This table contains freeform text notes with extra information about the MedicationStatement that is not captured in other attributes
Column Name | Data Type | Nullable | References | Description |
---|---|---|---|---|
medication_statement_id | varchar | No | medication_statement | ID of the MedicationStatement that this note belongs to |
text_markdown | varchar | The annotation - text content (as markdown) |
medication_statement_reason_code_bridge
The medication statement reason code encodes the reason for why the medication is being or was taken. This is a bridge table that joins MedicationStatement resources to the reason code concepts. Individual codings within each group are in the medication_statement_reason_code_coding table.
Column Name | Data Type | Nullable | References | Description |
---|---|---|---|---|
medication_statement_reason_code_id | varchar | No | ID of the medication statement reason code | |
medication_statement_id | varchar | No | medication_statement | ID of the MedicationStatement that this reason code belongs to |
display | varchar | Plain text representation of the medication statement reason code. This field comes from the "text" field in the codeable concept group |
medication_statement_reason_code_coding
This relation contains the individual coding values for each medication statement reason code.
Column Name | Data Type | Nullable | References | Description |
---|---|---|---|---|
medication_statement_reason_code_id | varchar | medication_statement_reason_code | ID of the MedicationStatement reason code | |
system | varchar | URI of the terminology system | ||
code | varchar | Code symbol defined by the terminology system | ||
display | varchar | Human-readable string representing the code |
observation
A FHIR Observation represents measurements and simple assertions made about a patient, device or other subject.
Column Name | Data Type | Nullable | References | Description |
---|---|---|---|---|
id | varchar | No | Resource ID (UUID) of the Observation | |
version | varchar | No | Current version of this resource. This indicates whether the resource has been updated. | |
last_updated | timestamp | No | Timestamp this resource was last updated, formatted as ISO 8601 timestamp | |
status | varchar | A code specifying the state of the observation. Generally, this will be the in-progress or completed state. | ||
category | varchar | Classification of type of observation. | ||
observation_code_id | varchar | observation_code | ID of the concept expressing the specific Observation that is performed | |
code_act | varchar | ACT code of this Observation, extracted from the FHIR "code" field where the system matches urn:oid:2.16.840.1.113883.5.4 | ||
code_cpt | varchar | CPT code of this Observation, extracted from the FHIR "code" field where the system matches http://www.ama-assn.org/go/cpt | ||
code_loinc | varchar | LOINC code of this Observation, extracted from the FHIR "code" field where the system matches http://loinc.org | ||
code_snomed | varchar | SNOMED code of this Observation, extracted from the FHIR "code" field where the system matches http://snomed.info/sct | ||
code_display | varchar | Plain text description of the code for this Observation | ||
subject_patient_id | varchar | patient | ID of the Patient who was the subject of the Observation | |
encounter_id | varchar | encounter | ID of the Encounter in which this Observation took place | |
effective_start | timestamp | Start date/time of when this Observation is clinically relevant | ||
effective_end | timestamp | End date/time of when this Observation is clinically relevant | ||
issued | timestamp | Date/Time this Observation version was made available | ||
value_range_low | int | The value of the lower range as a result of making the observation | ||
value_range_high | int | The value of the high range as a result of making the observation | ||
value_period_start | timestamp | The start datetime determined as a result of making the observation | ||
value_period_end | timestamp | The end datetime determined as a result of making the observation | ||
value_integer | int | The integer determined as a result of making the observation | ||
value_string | varchar | The string determined as a result of making the observation | ||
value_quantity_value | int | The value of the quantity determined as a result of making the observation | ||
value_quantity_unit | varchar | The unit of the quantity determined as a result of making the observation | ||
observation_value_concept_id | varchar | observation_value_concept | ID of the concept expressing the value of the Observation that is performed | |
data_absent_reason | varchar | ID of the concept expressing why specific Observation result is missing | ||
observation_interpretation_id | varchar | observation_interpretation | ID of the concept expressing a categorical assessment of an observation value. For example, high, low, normal. | |
body_site_concept_id | varchar | body_site_concept | ID of the concept expressing the body part observed in this Observation | |
observation_method_id | varchar | observation_method | ID of the concept expressing this Observation was taken | |
reference_range_low | int | The value of the lower range that represents guidance on how to interpret the value by comparison to a normal or recommended range. If there are multiple reference ranges for the observation, this column contains the low value of the first range. | ||
reference_range_high | int | The value of the high range that represents guidance on how to interpret the value by comparison to a normal or recommended range. If there are multiple reference ranges for the observation, this column contains the high value of the first range. | ||
reference_range_unit | varchar | The unit of the value of the lower range that was obtained that represents guidance on how to interpret the value by comparison to a normal or recommended range. If there are multiple reference ranges for the observation, this column contains the unit of the first range. | ||
reference_range_display | varchar | The text of the value that was obtained that represents guidance on how to interpret the value by comparison to a normal or recommended range. | ||
builder_id | varchar | ID of the Builder account that provided this data | ||
upid | varchar | Unique Patient Identifier (UPID) of the patient that this resource is associated with | ||
created_at | timestamp | Timestamp when this resource was first recorded in this system | ||
resource_json | varchar | No | Original JSON document for this resource | |
data_source | varchar | Name of the data partner network that provided this data |
observation_code
The observation code describes what was observed. Seomtimes this is called the observation "name". THis table contains the primary keys of all unique concept groups that represent the observation codes. Individual codings within each group are in the observation_code_coding table.
Column Name | Data Type | Nullable | References | Description |
---|---|---|---|---|
id | varchar | No | ID of code | |
display | varchar | Plain text representation of the observation code. This field comes from the "text" field in the codeable concept group |
observation_code_coding
This relation contains the individual coding values for each observation code.
Column Name | Data Type | Nullable | References | Description |
---|---|---|---|---|
observation_code_id | varchar | observation_code | ID of the Observation code | |
system | varchar | URI of the terminology system | ||
code | varchar | Code symbol defined by the terminology system | ||
display | varchar | Human-readable string representing the code | ||
user_selected | tinyint | If this coding was chosen directly by the user | ||
enrichment_type | varchar | Type of enrichment |
observation_identifier
This is a bridge table that joins the observation table to the identifier table
Column Name | Data Type | Nullable | References | Description |
---|---|---|---|---|
observation_id | varchar | No | observation | ID of the Observation that this identifier belongs to |
identifier_id | varchar | identifier | ID of the Identifier |
observation_interpretation
The observation interpretation is a categorical assessment of an observation value. For example, high, low, normal. This table contains the primary keys of all unique concept groups that represent the observation interpretations. Individual codings within each group are in the observation_interpretation_coding table.
Column Name | Data Type | Nullable | References | Description |
---|---|---|---|---|
id | varchar | No | ID of interpretation | |
display | varchar | Plain text representation of the observation interpretation. This field comes from the "text" field in the codeable concept group |
observation_interpretation_coding
This relation contains the individual coding values for each observation interpretation.
Column Name | Data Type | Nullable | References | Description |
---|---|---|---|---|
observation_interpretation_id | varchar | observation_interpretation | ID of the Observation interpretation | |
system | varchar | URI of the terminology system | ||
code | varchar | Code symbol defined by the terminology system | ||
display | varchar | Human-readable string representing the code |
observation_method
The observation method indicates the mechanism used to perform the observation. This table contains the primary keys of all unique concept groups that represent the observation methods. Individual codings within each group are in the observation_method_coding table.
Column Name | Data Type | Nullable | References | Description |
---|---|---|---|---|
id | varchar | No | ID of method | |
display | varchar | Plain text representation of the observation method. This field comes from the "text" field in the codeable concept group |
observation_method_coding
This relation contains the individual coding values for each observation method.
Column Name | Data Type | Nullable | References | Description |
---|---|---|---|---|
observation_method_id | varchar | observation_method | ID of the Observation method | |
system | varchar | URI of the terminology system | ||
code | varchar | Code symbol defined by the terminology system | ||
display | varchar | Human-readable string representing the code |
observation_note
This table contains freeform text notes with extra information about the Observation that is not captured in other attributes
Column Name | Data Type | Nullable | References | Description |
---|---|---|---|---|
observation_id | varchar | No | observation | ID of the Observation that this note belongs to |
text_markdown | varchar | The annotation - text content (as markdown) |
observation_performer
Who is responsible for the observation. Each Observation may have multiple categories. This relation joins Observations to the reference that encode the performers for the observation.
Column Name | Data Type | Nullable | References | Description |
---|---|---|---|---|
observation_id | varchar | No | observation | ID of the Observation that this performer belongs to |
practitioner_id | varchar | practitioner | ID of the Practitioner |
observation_value_concept
The observation value, encoded as a codeable concept. This table contains the primary keys of all unique concept groups that represent the observation value concepts. Individual codings within each group are in the observation_value_concept_coding table.
Column Name | Data Type | Nullable | References | Description |
---|---|---|---|---|
id | varchar | No | ID of valueCodeableConcept | |
display | varchar | Plain text representation of the observation value concept. This field comes from the "text" field in the codeable concept group |
observation_value_concept_coding
This relation contains the individual coding values for each observation value concept.
Column Name | Data Type | Nullable | References | Description |
---|---|---|---|---|
observation_value_concept_id | varchar | observation_value_concept | ID of the Observation valueCodeableConcept | |
system | varchar | URI of the terminology system | ||
code | varchar | Code symbol defined by the terminology system | ||
display | varchar | Human-readable string representing the code |
organization
A formally or informally recognized grouping of people or organizations formed for the purpose of achieving some form of collective action. Includes companies, institutions, corporations, departments, community groups, healthcare practice groups, payer/insurer, etc.
Column Name | Data Type | Nullable | References | Description |
---|---|---|---|---|
id | varchar | No | Resource ID (UUID) of the Organization | |
version | varchar | No | Current version of this resource. This indicates whether the resource has been updated. | |
last_updated | timestamp | No | Timestamp this resource was last updated, formatted as ISO 8601 timestamp | |
organization_type_id | varchar | organization_type | ID of the concept encoding the kinf of the organization | |
name | varchar | Name used for the organization | ||
address_line_1 | varchar | First line of address for the organization, street name, number, direction & P.O. Box etc. | ||
address_line_2 | varchar | Second line of address for the organization, street name, number, direction & P.O. Box etc. | ||
address_city | varchar | Name of city, town etc. | ||
address_state | varchar | Sub-unit of country (abbreviations ok) | ||
address_postal_code | varchar | Postal code for area | ||
builder_id | varchar | ID of the Builder account that provided this data | ||
created_at | timestamp | Timestamp when this resource was first recorded in this system | ||
resource_json | varchar | No | Original JSON document for this resource | |
data_source | varchar | Name of the data partner network that provided this data |
organization_identifier
This is a bridge table that joins the organization table to the identifier table
Column Name | Data Type | Nullable | References | Description |
---|---|---|---|---|
organization_id | varchar | No | organization | ID of the Organization that this identifier belongs to |
identifier_id | varchar | identifier | ID of the Identifier |
organization_telecom
Contact detail for the organization
Column Name | Data Type | Nullable | References | Description |
---|---|---|---|---|
organization_id | varchar | No | organization | ID of the Organization that this telecom belongs to |
contact_point_id | varchar | contact_point | ID of the contact details |
organization_type
The kind of organization that this resource represents. This table contains the primary keys of all unique concept groups that represent the organization types. Individual codings within each group are in the organization_type_coding table.
Column Name | Data Type | Nullable | References | Description |
---|---|---|---|---|
id | varchar | No | ID of type | |
display | varchar | Plain text representation of the organization type. This field comes from the "text" field in the codeable concept group |
organization_type_coding
This relation contains the individual coding values for each organization type.
Column Name | Data Type | Nullable | References | Description |
---|---|---|---|---|
organization_type_id | varchar | organization_type | ID of the Organization type | |
system | varchar | URI of the terminology system | ||
code | varchar | Code symbol defined by the terminology system | ||
display | varchar | Human-readable string representing the code |
patient
Demographics and other administrative information about an individual or animal receiving care or other health-related services.
Column Name | Data Type | Nullable | References | Description |
---|---|---|---|---|
id | varchar | No | Resource ID (UUID) of the Patient | |
version | varchar | No | Current version of this resource. This indicates whether the resource has been updated. | |
last_updated | timestamp | No | Timestamp this resource was last updated, formatted as ISO 8601 timestamp | |
active | tinyint | Whether this patient's record is in active use | ||
gender | varchar | male | female | other | unknown | ||
birth_date | date | The date of birth for the individual | ||
ethnicity | varchar | Ethnicity of Patient, categorized using the US Core Ethnicity Extension (https://build.fhir.org/ig/HL7/US-Core/StructureDefinition-us-core-ethnicity.html) | ||
race | varchar | Race of the Patient, categorized using the US Core Race Extension (http://hl7.org/fhir/us/core/StructureDefinition/us-core-race) | ||
deceased | tinyint | Indicates if the individual is deceased or not | ||
deceased_datetime | timestamp | Date when the individual was deceased | ||
marital_status | varchar | Marital (civil) status of the patient. This value is the code from the code system http://terminology.hl7.org/CodeSystem/v3-MaritalStatus | ||
marital_status_display | varchar | Display string of the marital status code | ||
managing_organization_id | varchar | organization | Organization that is the custodian of the patient record | |
name_family | varchar | Family name of the Patient | ||
name_given_1 | varchar | First given name of the Patient | ||
name_given_2 | varchar | Second given name of the Patient | ||
builder_id | varchar | ID of the Builder account that provided this data | ||
upid | varchar | Unique Patient Identifier (UPID) of the patient that this resource is associated with | ||
created_at | timestamp | Timestamp when this resource was first recorded in this system | ||
resource_json | varchar | No | Original JSON document for this resource | |
data_source | varchar | Name of the data partner network that provided this data |
patient_address
This relation joins patients to their addresses
Column Name | Data Type | Nullable | References | Description |
---|---|---|---|---|
patient_id | varchar | No | patient | ID of the Patient that this address belongs to |
line_1 | varchar | First line of the address | ||
line_2 | varchar | Second line of the address | ||
city | varchar | City of the address | ||
state | varchar | State of the address | ||
postal_code | varchar | Postal code of the address |
patient_communication
A language which may be used to communicate with the patient about his or her health
Column Name | Data Type | Nullable | References | Description |
---|---|---|---|---|
patient_id | varchar | No | patient | ID of the Patient that this communication belongs to |
patient_communication_language_id | varchar | patient_communication_language | ID of the concept encoding the language | |
preferred | tinyint | Language preference indicator | ||
preferred_type | varchar | Language preference type | ||
language_ability | varchar | Language ability | ||
language_ability_display | varchar | The display of language ability |
patient_communication_language
The ISO-639-1 alpha 2 code in lower case for the language, optionally followed by a hyphen and the ISO-3166-1 alpha 2 code for the region in upper case; e.g. "en" for English, or "en-US" for American English versus "en-EN" for England English. This table contains the primary keys of all unique concept groups that represent the patient communication languages. Individual codings within each group are in the patient_communication_language_coding table.
Column Name | Data Type | Nullable | References | Description |
---|---|---|---|---|
id | varchar | No | ID of language | |
display | varchar | Plain text representation of the patient communication language. This field comes from the "text" field in the codeable concept group |
patient_communication_language_coding
This relation contains the individual coding values for each patient communication language.
Column Name | Data Type | Nullable | References | Description |
---|---|---|---|---|
patient_communication_language_id | varchar | patient_communication_language | ID of the Patient Communication language | |
system | varchar | URI of the terminology system | ||
code | varchar | Code symbol defined by the terminology system | ||
display | varchar | Human-readable string representing the code |
patient_contact
A contact party (e.g. guardian, partner, friend) for the patient
Column Name | Data Type | Nullable | References | Description |
---|---|---|---|---|
id | varchar | No | ID of this patient contact | |
patient_id | varchar | No | patient | ID of the Patient that this contact belongs to |
name_family | varchar | Family name of the contact person | ||
name_given_1 | varchar | First given name of the contact person | ||
name_given_2 | varchar | Second given name of the contact person | ||
address_line_1 | varchar | First line of the address of the contact person | ||
address_line_2 | varchar | Second line of the address of the contact person | ||
address_city | varchar | City of the address of the contact person | ||
address_state | varchar | State of the address of the contact person | ||
address_postal_code | varchar | Postal code of the address of the contact person | ||
relationship | varchar | The nature of the relationship between the patient and the contact person | ||
relationship_display | varchar | The display of the relationship |
patient_contact_telecom
This relation joins patient contacts to the contact details
Column Name | Data Type | Nullable | References | Description |
---|---|---|---|---|
patient_contact_id | varchar | patient_contact | ID of the patient contact | |
contact_point_id | varchar | contact_point | ID of the contact details |
patient_general_practitioner
This table includes a list of nominated care providers for the patient.
Column Name | Data Type | Nullable | References | Description |
---|---|---|---|---|
patient_id | varchar | No | patient | ID of the Patient that this general practitioner belongs to |
practitioner_id | varchar | practitioner | ID of the Practitioner |
patient_identifier
This is a bridge table that joins the patient table to the identifier table
Column Name | Data Type | Nullable | References | Description |
---|---|---|---|---|
patient_id | varchar | No | patient | ID of the Patient that this identifier belongs to |
identifier_id | varchar | identifier | ID of the Identifier |
patient_name
This is a bridge table that joins the patient table to the human name table.
Column Name | Data Type | Nullable | References | Description |
---|---|---|---|---|
patient_id | varchar | No | patient | ID of the Patient that this name belongs to |
human_name_id | varchar | human_name | ID of the HumanName |
patient_telecom
This relation joins patients to their contact details
Column Name | Data Type | Nullable | References | Description |
---|---|---|---|---|
patient_id | varchar | No | patient | ID of the Patient that this telecom belongs to |
contact_point_id | varchar | contact_point | ID of the contact details |
practitioner
A person who is directly or indirectly involved in the provisioning of healthcare.
Column Name | Data Type | Nullable | References | Description |
---|---|---|---|---|
id | varchar | No | Resource ID (UUID) of the Practitioner | |
version | varchar | No | Current version of this resource. This indicates whether the resource has been updated. | |
last_updated | varchar | No | Timestamp this resource was last updated, formatted as ISO 8601 timestamp | |
name_family | varchar | Family name of the Pracititoner | ||
name_given_1 | varchar | First given name of the Pracititoner | ||
name_given_2 | varchar | Second given name of the Pracititoner | ||
address_line_1 | varchar | First line of address of the practitioner that are not role specific (typically home address) | ||
address_line_2 | varchar | Second line of address of the practitioner that are not role specific (typically home address) | ||
address_city | varchar | City of the practitioner that are not role specific (typically home address) | ||
address_state | varchar | State of the practitioner that are not role specific (typically home address) | ||
address_postal_code | varchar | Postal code of the practitioner that are not role specific (typically home address) | ||
practitioner_qualification_id | varchar | practitioner_qualification | ID of an identifier for this qualification for the practitioners. If the practitioner has multiple qualifications, only the first one is presented in this column. | |
builder_id | varchar | ID of the Builder account that provided this data | ||
created_at | timestamp | Timestamp when this resource was first recorded in this system | ||
resource_json | varchar | No | Original JSON document for this resource | |
data_source | varchar | Name of the data partner network that provided this data |
practitioner_identifier
This is a bridge table that joins the practitioner table to the identifier table
Column Name | Data Type | Nullable | References | Description |
---|---|---|---|---|
practitioner_id | varchar | No | practitioner | ID of the Practitioner that this identifier belongs to |
identifier_id | varchar | identifier | ID of the Identifier |
practitioner_qualification
Certification, licenses, or training pertaining to the provision of care
Column Name | Data Type | Nullable | References | Description |
---|---|---|---|---|
id | varchar | No | Unique ID of the practitioner qualification | |
display | varchar | Plain text representation of the practitioner qualification. This field comes from the "text" field in the codeable concept group |
practitioner_qualification_coding
Representation of a defined practitioner qualification concept using a symbol from a defined terminology system
Column Name | Data Type | Nullable | References | Description |
---|---|---|---|---|
practitioner_qualification_id | varchar | practitioner_qualification | ID of the Practitioner | |
system | varchar | URI of the terminology system | ||
code | varchar | Code symbol defined by the terminology system | ||
display | varchar | Human-readable string representing the code |
practitioner_telecom
A contact detail for the practitioner (that apply to all roles)
Column Name | Data Type | Nullable | References | Description |
---|---|---|---|---|
practitioner_id | varchar | No | practitioner | ID of the Practitioner that this telecom belongs to |
contact_point_id | varchar | contact_point | ID of the contact details |
procedure
A FHIR Procedure represents an action that is or was performed on or for a patient. This can be a physical intervention like an operation, or less invasive like long term services, counseling, or hypnotherapy.
Column Name | Data Type | Nullable | References | Description |
---|---|---|---|---|
id | varchar | No | Resource ID (UUID) of the Procedure | |
version | varchar | No | Current version of this resource. This indicates whether the resource has been updated. | |
last_updated | timestamp | No | Timestamp this resource was last updated, formatted as ISO 8601 timestamp | |
status | varchar | A code specifying the state of the procedure. Generally, this will be the in-progress or completed state. | ||
procedure_code_id | varchar | procedure_code | ID of the Procedure Code expressing the specific Procedure that is performed. | |
code_cpt | varchar | CPT code of this Procedure. This is extracted from the "code" field on the FHIR Procedure by selecting the code where the system matches http://www.ama-assn.org/go/cpt | ||
code_loinc | varchar | LOINC code of this Procedure. This is extracted from the "code" field on the FHIR Procedure by selecting the code where the system matches http://loinc.org | ||
code_hcpcs | varchar | HCPCS code of this Procedure. This is extracted from the "code" field on the FHIR Procedure by selecting the code where the system matches urn:oid:2.16.840.1.113883.6.14 | ||
code_snomed | varchar | SNOMED code of this Procedure. This is extracted from the "code" field on the FHIR Procedure by selecting the code where the system matches http://snomed.info/sct | ||
code_display | varchar | Display text of the Procedure code, extracted from the "text" field on the FHIR Procedure. | ||
subject_patient_id | varchar | patient | ID of the Patient who was the subject of the Procedure | |
encounter_id | varchar | encounter | ID of the Encounter in which this Procedure took place | |
performed_start | timestamp | Start date/time of this Procedure | ||
performed_end | timestamp | End date/time of this Procedure | ||
location_id | varchar | location | ID of the Location where this Procedure happened | |
body_site_concept_id | varchar | body_site_concept | ID of the concept expressing the body site where the Procedure was performed | |
builder_id | varchar | ID of the Builder account that provided this data | ||
upid | varchar | Unique Patient Identifier (UPID) of the patient that this resource is associated with | ||
created_at | timestamp | Timestamp when this resource was first recorded in this system | ||
resource_json | varchar | No | Original JSON document for this resource | |
data_source | varchar | Name of the data partner network that provided this data |
procedure_code
The procedure code expresses the specific Procedure that is performed. This table contains the primary keys of all unique concept groups that represent the procedure codes. Individual codings within each group are in the procedure_code_coding table.
Column Name | Data Type | Nullable | References | Description |
---|---|---|---|---|
id | varchar | No | ID of code | |
display | varchar | Plain text representation of the procedure code. This field comes from the "text" field in the codeable concept group |
procedure_code_coding
This relation contains the individual coding values for each procedure code.
Column Name | Data Type | Nullable | References | Description |
---|---|---|---|---|
procedure_code_id | varchar | procedure_code | ID of the Procedure code | |
system | varchar | URI of the terminology system | ||
code | varchar | Code symbol defined by the terminology system | ||
display | varchar | Human-readable string representing the code |
procedure_identifier
This is a bridge table that joins the procedure table to the identifier table
Column Name | Data Type | Nullable | References | Description |
---|---|---|---|---|
procedure_id | varchar | No | procedure | ID of the Procedure that this identifier belongs to |
identifier_id | varchar | identifier | ID of the Identifier |
procedure_note
This table contains freeform text notes with extra information about the Procedure that is not captured in other attributes
Column Name | Data Type | Nullable | References | Description |
---|---|---|---|---|
procedure_id | varchar | No | procedure | ID of the Procedure that this note belongs to |
text_markdown | varchar | The annotation - text content (as markdown) |
related_person
A FHIR RelatedPerson represents information about a person that is involved in the care for a patient, but who is not the target of healthcare, nor has a formal responsibility in the care process
Column Name | Data Type | Nullable | References | Description |
---|---|---|---|---|
id | varchar | No | Resource ID (UUID) of the RelatedPerson | |
version | varchar | No | Current version of this resource. This indicates whether the resource has been updated. | |
last_updated | timestamp | No | Timestamp this resource was last updated, formatted as ISO 8601 timestamp | |
patient_id | varchar | patient | ID of the Patient this person is related to | |
related_person_relationship_id | varchar | related_person_relationship | ID of the concept encoding the relationship between the patient and the related person | |
name_family | varchar | Family name of the RelaredPerson | ||
name_given_1 | varchar | First given name of the RelaredPerson | ||
name_given_2 | varchar | Second given name of the RelaredPerson | ||
address_line_1 | varchar | First line of the address | ||
address_line_2 | varchar | Second line of the address | ||
address_city | varchar | City name in address | ||
address_state | varchar | State name in address | ||
address_postal_code | varchar | Postal code in address | ||
builder_id | varchar | ID of the Builder account that provided this data | ||
upid | varchar | Unique Patient Identifier (UPID) of the patient that this resource is associated with | ||
created_at | timestamp | Timestamp when this resource was first recorded in this system | ||
resource_json | varchar | No | Original JSON document for this resource | |
data_source | varchar | Name of the data partner network that provided this data |
related_person_identifier
This is a bridge table that joins the related_person table to the identifier table
Column Name | Data Type | Nullable | References | Description |
---|---|---|---|---|
related_person_id | varchar | No | related_person | ID of the RelatedPerson that this identifier belongs to |
identifier_id | varchar | identifier | ID of the Identifier |
related_person_relationship
The nature of the relationship between a patient and the related person. This table contains the primary keys of all unique concept groups that represent the related person relationships. Individual codings within each group are in the related_person_relationship_coding table.
Column Name | Data Type | Nullable | References | Description |
---|---|---|---|---|
id | varchar | No | ID of relationship | |
display | varchar | Plain text representation of the related person relationship. This field comes from the "text" field in the codeable concept group |
related_person_relationship_coding
This relation contains the individual coding values for each related person relationship.
Column Name | Data Type | Nullable | References | Description |
---|---|---|---|---|
related_person_relationship_id | varchar | related_person_relationship | ID of the RelatedPerson relationship | |
system | varchar | URI of the terminology system, for example http://snomed.info/sct | ||
code | varchar | Code symbol defined by the terminology system | ||
display | varchar | Human-readable string representing the code |
related_person_telecom
A contact detail for the person, e.g. a telephone number or an email address.
Column Name | Data Type | Nullable | References | Description |
---|---|---|---|---|
related_person_id | varchar | No | related_person | ID of the RelatedPerson that this telecom belongs to |
contact_point_id | varchar | contact_point | ID of the ContactPoint describing contact details for the person |
body_site_concept
Representation of the body site where a procedure, immunization, etc. took place
Column Name | Data Type | Nullable | References | Description |
---|---|---|---|---|
id | varchar | No | Unique ID of the body site | |
display | varchar | Plain text representation of the body site concept. This field comes from the "text" field in the codeable concept group |
body_site_concept_coding
Representation of a defined body site concept using a symbol from a defined terminology system
Column Name | Data Type | Nullable | References | Description |
---|---|---|---|---|
body_site_concept_id | varchar | body_site_concept | ID of the body site code | |
system | varchar | URI of the terminology system, for example http://snomed.info/sct | ||
code | varchar | Code symbol defined by the terminology system | ||
display | varchar | Human-readable string representing the code |
contact_point
Details for all kinds of technology-mediated contact points for a person or organization, including telephone, email, etc.
Column Name | Data Type | Nullable | References | Description |
---|---|---|---|---|
id | varchar | No | ID of the Contact Point | |
system | varchar | Telecommunications form for contact point - what communications system is required to make use of the contact. Possible values: phone | fax | email | pager | url | sms | other | ||
value | varchar | The actual contact point details | ||
use | varchar | Purpose of this contact point. Possible values: home | work | temp | old | mobile | ||
rank | int | Specify preferred order of use (1 = highest) | ||
period_start | timestamp | Start of time period when contact point is/was in use | ||
period_end | timestamp | End of time period when contact point is/was in use |
dosage
Instructions for how a medication should be taken.
Column Name | Data Type | Nullable | References | Description |
---|---|---|---|---|
id | varchar | No | ID of the Dosage | |
display | varchar | Plain text representation of the dosage. This field comes from the "text" field in the codeable concept group | ||
timing_repeat_period_unit | varchar | Unit for the timing schedule for when the medication should be administered | ||
timing_repeat_bounds_start | timestamp | Start of when medication should be administered | ||
timing_repeat_bounds_end | timestamp | End of when medication should be administered | ||
timing_period | decimal | Indicates the duration of time over which repetitions are to occur | ||
route_concept_id | varchar | route_concept | ID of the route concept that expresses how the drug should enter body | |
dosage_method_id | varchar | dosage_method | ID of the route concept that expresses the technique for administering medication | |
additional_instruction_display | varchar | Supplemental instruction or warnings to the patient - e.g. "with meals", "may cause drowsiness" | ||
dose_quantity_unit | varchar | Unit of the amount of medication per dose | ||
dose_quantity_value | decimal | Amount of medication per dose |
dosage_method
The dosage method expresses the technique for administering medication. This table contains the primary keys of all unique concept groups that represent the dosage methods. Individual codings within each group are in the dosage_method_coding table.
Column Name | Data Type | Nullable | References | Description |
---|---|---|---|---|
id | varchar | No | ID of the method | |
display | varchar | Plain text representation of the dosage method. This field comes from the "text" field in the codeable concept group |
dosage_method_coding
Representation of a defined dosage method concept using a symbol from a defined terminology system
Column Name | Data Type | Nullable | References | Description |
---|---|---|---|---|
dosage_method_id | varchar | dosage_method | ID of the Dosage method | |
system | varchar | URI of the terminology system, for example http://snomed.info/sct | ||
code | varchar | Code symbol defined by the terminology system | ||
display | varchar | Human-readable string representing the code |
human_name
A name of a human with text, parts and usage information.
Column Name | Data Type | Nullable | References | Description |
---|---|---|---|---|
id | varchar | No | ID of the name | |
use | varchar | Identifies the purpose for this name. Possible values: usual | official | temp | nickname | anonymous | old | maiden | ||
display | varchar | Text representation of the full name | ||
family | varchar | Family name (often called "Surname") | ||
prefix_1 | varchar | The first of the parts that come before the name | ||
suffix_1 | varchar | The first of the parts that come after the name | ||
period_start | timestamp | Start of time period when name is/was in use | ||
period_end | timestamp | End of time period when name is/was in use |
human_name_given
Column Name | Data Type | Nullable | References | Description |
---|---|---|---|---|
human_name_id | varchar | human_name | ID of the name | |
given | varchar | Given names (not always "first"). Includes middle names | ||
given_index | int | Index for presenting the name, starting with 1 |
identifier
An identifier is a string associated with a single object or entity within a given system, typically used to connect content in resources to external content available in other frameworks or protocols
Column Name | Data Type | Nullable | References | Description |
---|---|---|---|---|
id | varchar | No | Unique ID of this identifier | |
system | varchar | The namespace for the identifier value | ||
value | varchar | The value that is unique | ||
use | varchar | The purpose of this identifier | ||
type_display | varchar | Description of identifier in plain text, used to determine which identifier to use for a specific purpose | ||
type_code | varchar | Description of identifier as a code, used to determine which identifier to use for a specific purpose | ||
assigner_display | varchar | Display of the organization that issued id |
medication_concept
This table holds the primary keys of all unique medication concept groups. Individual codings within each concept group are in the medication_concept_coding table.
Column Name | Data Type | Nullable | References | Description |
---|---|---|---|---|
id | varchar | No | Unique ID of the medication code | |
display | varchar | Plain text representation of the medication concept. This field comes from the "text" field in the codeable concept group |
medication_concept_coding
This table holds the individual codings within each medication concept group. Each row in this table represents a single coding within a medication concept group.
Column Name | Data Type | Nullable | References | Description |
---|---|---|---|---|
medication_concept_id | varchar | medication_concept | ID of the medication concept group | |
system | varchar | URI of the terminology system | ||
code | varchar | Code symbol defined by the terminology system | ||
display | varchar | Human-readable string representing the code |
route_concept
Representation of the route of which a drug should enter the body
Column Name | Data Type | Nullable | References | Description |
---|---|---|---|---|
id | varchar | No | Unique ID of the body site | |
display | varchar | Plain text representation of the route concept. This field comes from the "text" field in the codeable concept group |
route_concept_coding
Representation of a defined route concept using a symbol from a defined terminology system
Column Name | Data Type | Nullable | References | Description |
---|---|---|---|---|
route_concept_id | varchar | route_concept | ID of the route code | |
system | varchar | URI of the terminology system | ||
code | varchar | Code symbol defined by the terminology system | ||
display | varchar | Human-readable string representing the code |
Updated 1 day ago