IMMUNIZATION_AUDIT
| Column Section | Relationship Section | Top of Page |
Table-level Detail
| Description: | IMMUNIZATION AUDIT |
| Definition: | This table stores immunization audit events |
| Table Type: | ACTIVITY |
Column Detail - IMMUNIZATION_AUDIT
| Column Name | Type | Null? | Definition |
|---|---|---|---|
| EVENT_ID | DOUBLE | Y | This would be an event_id from clinical_event table. This will be useful piece of detail when capturing the audit event using the Lights on timers network. This would be only numerical value of double data type.; |
| EVENT_TYPE_TFLG | VARCHAR(40) | Y | This would specify what kind of event this particular audit event is for. For example, if it is immunization administration or query for the registry etc. This column needs to be a flag. The possible values could be 'ADMIN_SUB_RES' or 'IIS_QUERY'. |
| IMMUNIZATION_AUDIT_ID | DOUBLE | N | PRIMARY KEY |
| MESSAGE_SENT_DT_TM | DATETIME | Y | The Date and Time the message was sent |
| PERSON_ID | DOUBLE | Y | This would be a person_id (foreign key) from the person table. This would be useful for the clients for reporting for the audit events of type queries. This would be only numerical value of double data type.; |
| REGISTRY_IDENT | VARCHAR(255) | Y | This would be a unique identifier that identies a particular Immunization registry (i.e. IIS stands for Immunization Information System). FSI would be sending all this data. This detail will be captured as metadata on lights on so they could be sorted by IIS. |
| RESPONSE_STATUS_DT_TM | DATETIME | Y | This is the date and time when an acknowledgement came back from IIS (Immunization registry) for the message sent earlier by FSI. As per FSI, it would always be in UTC. There will be some scenarios when the acknowledgement is lost (never received). |
| RESPONSE_STATUS_TFLG | VARCHAR(30) | Y | This would specify what kind of response (or acknowledgement) was received for this particular audit event from IIS (Immunization Information System). For example, if it is successful or some kind of error. This column needs to be a flag. The possible values could be 'NO_RESPONSE' or 'ADMIN_SUB_SUCCESS'. |
| TRANSACTION_IDENT | VARCHAR(50) | Y | This would be a unique identifier that could be used the table lookups and then populate some of the missing fields later. FSI would be sending this value as their trigger id (a double value), appended with a fully qualified domain name and separated by some delimeter like colon, for example, ipmdvla.ip.devcerner.net:7592922910 for mdvla (dev) domain.; |
| UPDT_APPLCTX | DOUBLE | Y | The application context number from the record info block. The UPDT family of columns are typically used for housekeeping and external system process and should never be depended on for solution specific logic. |
| UPDT_CNT | DOUBLE | Y | Set to 0 on insert. Incremented by 1 on update. Used to recognize update conflict where data in a row updated by one application is at risk of being lost by a second application attempting to update the row. The UPDT family of columns are typically used for housekeeping and external system process and should never be depended on for solution specific logic. |
| UPDT_DT_TM | DATETIME | Y | The date and time the row was last inserted or updated. The UPDT family of columns are typically used for housekeeping and external system process and should never be depended on for solution specific logic. |
| UPDT_ID | DOUBLE | Y | The person_id of the person from the personnel table (prsnl) that caused the last insert or update of the row in the table. The UPDT family of columns are typically used for housekeeping and external system process and should never be depended on for solution specific logic. |
| UPDT_TASK | DOUBLE | Y | The registered (assigned) task number for the process that inserted or updated the row. The UPDT family of columns are typically used for housekeeping and external system process and should never be depended on for solution specific logic. |
Relationship Detail - IMMUNIZATION_AUDIT
| Child Column in IMMUNIZATION_AUDIT(FK) | Parent Table Name | Parent Column Name | |
|---|---|---|---|
| Parents: | PERSON_ID | PERSON | PERSON_ID |
IMMUNIZATION_EXT_CLOB
| Column Section | Relationship Section | Top of Page |
Table-level Detail
| Description: | External staging table for data from an interface for the Immunizations concept |
| Definition: | To temporarily hold untrusted data that has come from an external source (e.g. FHIR). This table will hold the actual data that came across the interface. |
| Table Type: | ACTIVITY |
Column Detail - IMMUNIZATION_EXT_CLOB
| Column Name | Type | Null? | Definition |
|---|---|---|---|
| DATA_CLOB | LONGTEXT | Y | The data that has come from an external interface. |
| IMMUNIZATION_EXT_CLOB_ID | DOUBLE | N | PRIMARY KEY |
| UPDT_APPLCTX | DOUBLE | N | The application context number from the record info block. The UPDT family of columns are typically used for housekeeping and external system process and should never be depended on for solution specific logic. |
| UPDT_CNT | DOUBLE | N | Set to 0 on insert. Incremented by 1 on update. Used to recognize update conflict where data in a row updated by one application is at risk of being lost by a second application attempting to update the row. The UPDT family of columns are typically used for housekeeping and external system process and should never be depended on for solution specific logic. |
| UPDT_DT_TM | DATETIME | N | The date and time the row was last inserted or updated. The UPDT family of columns are typically used for housekeeping and external system process and should never be depended on for solution specific logic. |
| UPDT_ID | DOUBLE | N | The person_id of the person from the personnel table (prsnl) that caused the last insert or update of the row in the table. The UPDT family of columns are typically used for housekeeping and external system process and should never be depended on for solution specific logic. |
| UPDT_TASK | DOUBLE | N | The registered (assigned) task number for the process that inserted or updated the row. The UPDT family of columns are typically used for housekeeping and external system process and should never be depended on for solution specific logic. |
| VERSION_NBR | DOUBLE | N | The version of the external data. |
Relationship Detail - IMMUNIZATION_EXT_CLOB
| Parent Column in IMMUNIZATION_EXT_CLOB (PK) | Child Table Name | Child Column Name | |
|---|---|---|---|
| Children: | IMMUNIZATION_EXT_CLOB_ID | IMMUNIZATION_EXT_DATA | IMMUNIZATION_EXT_CLOB_ID |
IMMUNIZATION_EXT_DATA
| Column Section | Relationship Section | Top of Page |
Table-level Detail
| Description: | External staging data table for Immunizations concept |
| Definition: | To temporarily hold untrusted data that has come from an external source (e.g. FHIR) |
| Table Type: | ACTIVITY |
Column Detail - IMMUNIZATION_EXT_DATA
| Column Name | Type | Null? | Definition |
|---|---|---|---|
| ACTION_DT_TM | DATETIME | Y | The date and time of the action. |
| ACTION_PRSNL_ID | DOUBLE | N | The personnel who performed the action. |
| ACTIVE_IND | DOUBLE | N | The table row is active or inactive. A row is generally active unless it is in an inactive state such as logically deleted, combined away, pending purge, etc. |
| ACTIVE_STATUS_CD | DOUBLE | N | Indicates the status of the row itself (not the data in the row) such as active, inactive, combined away, pending purge, etc. |
| ACTIVE_STATUS_DT_TM | DATETIME | N | The date and time that the active_status_cd was set. |
| ACTIVE_STATUS_PRSNL_ID | DOUBLE | N | The person who caused the active_status_cd to be set or change. |
| ADMIN_DT_TM_TXT | VARCHAR(30) | N | The date and time for the administrative action in ISO 8601 format. Date and Time will be local. |
| CLIENT_IDENT | VARCHAR(255) | N | An unique string representing the registration information provided by the client |
| CORRELATION_IDENT | VARCHAR(80) | N | Upper case hyphenated GUID that identifies the transaction that updated this row. |
| DATA_STATUS_CD | DOUBLE | N | Data status indicates a level of authenticity of the row data. |
| ENCNTR_ID | DOUBLE | N | The encounter related to the external data. |
| EVENT_CD | DOUBLE | N | The event code for the immunization. |
| EVENT_ID | DOUBLE | N | An EVENT_ID from tha CLINICAL_EVENT table. Identifies the CLINICAL EVENT/s associated to this immunization |
| IMMUNIZATION_EXT_CLOB_ID | DOUBLE | N | The associated data that came from an external interface. |
| IMMUNIZATION_EXT_DATA_ID | DOUBLE | N | PRIMARY KEY |
| PERSONA_TXT | VARCHAR(40) | Y | The persona is part of the OAuth2 token, and indicates the type of user contacting the service. |
| PERSON_ID | DOUBLE | N | The PERSON related to the external data |
| REQUESTED_ACTION_CD | DOUBLE | N | Action requested for the data. |
| SUBMITTED_DT_TM | DATETIME | Y | The date and time this external data was added to the staging tables. |
| UPDT_APPLCTX | DOUBLE | N | The application context number from the record info block. The UPDT family of columns are typically used for housekeeping and external system process and should never be depended on for solution specific logic. |
| UPDT_CNT | DOUBLE | N | Set to 0 on insert. Incremented by 1 on update. Used to recognize update conflict where data in a row updated by one application is at risk of being lost by a second application attempting to update the row. The UPDT family of columns are typically used for housekeeping and external system process and should never be depended on for solution specific logic. |
| UPDT_DT_TM | DATETIME | N | The date and time the row was last inserted or updated. The UPDT family of columns are typically used for housekeeping and external system process and should never be depended on for solution specific logic. |
| UPDT_ID | DOUBLE | N | The person_id of the person from the personnel table (prsnl) that caused the last insert or update of the row in the table. The UPDT family of columns are typically used for housekeeping and external system process and should never be depended on for solution specific logic. |
| UPDT_TASK | DOUBLE | N | The registered (assigned) task number for the process that inserted or updated the row. The UPDT family of columns are typically used for housekeeping and external system process and should never be depended on for solution specific logic. |
Relationship Detail - IMMUNIZATION_EXT_DATA
| Child Column in IMMUNIZATION_EXT_DATA(FK) | Parent Table Name | Parent Column Name | |
|---|---|---|---|
| Parents: | ENCNTR_ID | ENCOUNTER | ENCNTR_ID |
| IMMUNIZATION_EXT_CLOB_ID | IMMUNIZATION_EXT_CLOB | IMMUNIZATION_EXT_CLOB_ID | |
| PERSON_ID | PERSON | PERSON_ID | |
| ACTION_PRSNL_ID | PRSNL | PERSON_ID |
IMMUNIZATION_MODIFIER
| Column Section | Relationship Section | Top of Page |
Table-level Detail
| Description: | IMMUNIZATION MODIFIER |
| Definition: | This is the list of modifiers to expectations and Immunization events. |
| Table Type: | ACTIVITY |
Column Detail - IMMUNIZATION_MODIFIER
| Column Name | Type | Null? | Definition |
|---|---|---|---|
| BEG_EFFECTIVE_DT_TM | DATETIME | Y | The date and time for which this table row becomes effective. Normally, this will be the date and time the row is added, but could be a past or future date and time. |
| CLINICAL_EVENT_ID | DOUBLE | N | THIS COLUMN NOT USED. Clinical event identifier (from CLINICAL_EVENT) related to this modifier information. This column is not used and will be made obsolete. Use EVENT_ID instead. 6/25/03 |
| CONSENT_LONG_TEXT_ID | DOUBLE | N | OBSOLETE - ID to LONG_TEXT for comments related to the consent for the related Expectation. |
| CONSENT_PERSON_ID | DOUBLE | N | OBSOLETE - ID from PERSON of the person giving consent for the Expectation. |
| CONSENT_PERSON_REL_CD | DOUBLE | N | OBSOLETE - Value from CS40 to indicate the relationship of the person giving consent for the person identified by person_id. |
| DEFAULT_EVENT_IND | DOUBLE | Y | Indicates whether the event for the immunization was selected by default. |
| END_EFFECTIVE_DT_TM | DATETIME | Y | The date/time after which the row is no longer valid as active current data. This may be valued with the date that the row became inactive. |
| EVENT_CD | DOUBLE | N | The event code that corresponds to this modifier. |
| EVENT_ID | DOUBLE | N | This value comes from the non-key EVENT_ID column in the CLINICAL_EVENT table. |
| EXPECT_MEANING | VARCHAR(250) | N | The Expectation meaning of the HM Expectation associated with the modifier. |
| FUNDING_SOURCE_CD | DOUBLE | N | The funding source code associated to this modifier. |
| IMMUNIZATION_MODIFIER_ID | DOUBLE | N | Unique Identifier for the immunization_modifier table. |
| ORGANIZATION_ID | DOUBLE | N | Foreign Key from ORGANIZATION table |
| PERSON_ID | DOUBLE | N | This is the value of the unique primary identifier of the person table. It is an internal system assigned number. |
| UPDT_APPLCTX | DOUBLE | N | The application context number from the record info block. |
| UPDT_CNT | DOUBLE | N | Set to 0 on insert. Incremented by 1 on update. Used to recognize update conflict where data in a row updated by one application is at risk of being lost by a second application attempting to update the row. |
| UPDT_DT_TM | DATETIME | N | The date and time the row was last inserted or updated. |
| UPDT_ID | DOUBLE | N | The person_id of the person from the personnel table (prsnl) that caused the last insert or update of the row in the table. |
| UPDT_TASK | DOUBLE | N | The registered (assigned) task number for the process that inserted or updated the row. |
| VFC_STATUS_CD | DOUBLE | N | The Code that identifies the Vaccines For Children (VFC) status for the related Expectation. |
| VIS_CD | DOUBLE | N | The Vaccine Information Statement code associated to this modifier |
| VIS_DT_ISO | VARCHAR(10) | Y | Stores a string value of the Vaccine Information Statement (VIS) published on date in the following ISO supported formats:; YYYYMMDD |
| VIS_DT_TM | DATETIME | Y | The version date printed on the Vaccine Information Sheet (VIS) for the related Expectation. |
| VIS_GIVEN_ON_DT_ISO | VARCHAR(10) | Y | Stores a string value of the Vaccine Information Statement (VIS) given on date in the following ISO supported format:; YYYYMMDD |
| VIS_PROVIDED_ON_DT_TM | DATETIME | Y | The date and time that the VIS was provided to the patient or their parent/guardian |
Relationship Detail - IMMUNIZATION_MODIFIER
| Child Column in IMMUNIZATION_MODIFIER(FK) | Parent Table Name | Parent Column Name | |
|---|---|---|---|
| Parents: | CONSENT_LONG_TEXT_ID | LONG_TEXT | LONG_TEXT_ID |
| ORGANIZATION_ID | ORGANIZATION | ORGANIZATION_ID | |
| CONSENT_PERSON_ID | PERSON | PERSON_ID | |
| PERSON_ID | PERSON | PERSON_ID |
IMMUNIZATION_OBSERVATION
| Column Section | Relationship Section | Top of Page |
Table-level Detail
| Description: | Immunization Observation |
| Definition: | Documented patient observations that correspond to a codified Indication or Contraindication for Immunization Forecasting. |
| Table Type: | ACTIVITY |
Column Detail - IMMUNIZATION_OBSERVATION
| Column Name | Type | Null? | Definition |
|---|---|---|---|
| ACTIVE_IND | DOUBLE | N | The table row is active or inactive. A row is generally active unless it is in an inactive state such as logically deleted, combined away, pending purge, etc. |
| ACTIVE_STATUS_CD | DOUBLE | N | Indicates the status of the row itself (not the data in the row) such as active, inactive, combined away, pending purge, etc. |
| ACTIVE_STATUS_DT_TM | DATETIME | N | The date and time that the active_status_cd was set. |
| ACTIVE_STATUS_PRSNL_ID | DOUBLE | N | The person who caused the active_status_cd to be set or change. |
| BEGIN_DT_TM | DATETIME | Y | Begin Date Time of the Observation |
| BEG_EFFECTIVE_DT_TM | DATETIME | N | The date and time for which this table row becomes effective. Normally, this will be the date and time the row is added, but could be a past or future date and time. |
| END_DT_TM | DATETIME | Y | End Date Time of the Observation |
| END_EFFECTIVE_DT_TM | DATETIME | N | The date/time after which the row is no longer valid as active current data. This may be valued with the date that the row became inactive. |
| IMMUNIZATION_OBSERVATION_ID | DOUBLE | N | PRIMARY KEY |
| OBSERVATION_CD | DOUBLE | N | observation code |
| OBSERVATION_ID | DOUBLE | Y | a grouper for history on the table and will reference the IMMUNIZATION_OBSERVATION_ID associated with the initial write to the table. |
| PERSON_ID | DOUBLE | N | Foreign Key to the Patient Person |
| UPDT_APPLCTX | DOUBLE | N | The application context number from the record info block. The UPDT family of columns are typically used for housekeeping and external system process and should never be depended on for solution specific logic. |
| UPDT_CNT | DOUBLE | N | Set to 0 on insert. Incremented by 1 on update. Used to recognize update conflict where data in a row updated by one application is at risk of being lost by a second application attempting to update the row. The UPDT family of columns are typically used for housekeeping and external system process and should never be depended on for solution specific logic. |
| UPDT_DT_TM | DATETIME | N | The date and time the row was last inserted or updated. The UPDT family of columns are typically used for housekeeping and external system process and should never be depended on for solution specific logic. |
| UPDT_ID | DOUBLE | N | The person_id of the person from the personnel table (prsnl) that caused the last insert or update of the row in the table. The UPDT family of columns are typically used for housekeeping and external system process and should never be depended on for solution specific logic. |
| UPDT_TASK | DOUBLE | N | The registered (assigned) task number for the process that inserted or updated the row. The UPDT family of columns are typically used for housekeeping and external system process and should never be depended on for solution specific logic. |
| VACCINE_GROUP_CD | DOUBLE | N | Code Value for the Vaccine Group |
Relationship Detail - IMMUNIZATION_OBSERVATION
| Child Column in IMMUNIZATION_OBSERVATION(FK) | Parent Table Name | Parent Column Name | |
|---|---|---|---|
| Parents: | OBSERVATION_ID | IMMUNIZATION_OBSERVATION | IMMUNIZATION_OBSERVATION_ID |
| PERSON_ID | PERSON | PERSON_ID |
| Parent Column in IMMUNIZATION_OBSERVATION (PK) | Child Table Name | Child Column Name | |
|---|---|---|---|
| Children: | IMMUNIZATION_OBSERVATION_ID | IMMUNIZATION_OBSERVATION | OBSERVATION_ID |