FHIR to OMOP FHIR IG
0.1.0 - ci-build International flag

FHIR to OMOP FHIR IG, published by HL7 International / Biomedical Research and Regulation. This guide is not an authorized publication; it is the continuous build for version 0.1.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/fhir-omop-ig/ and changes regularly. See the Directory of published versions

Logical Model: VisitOccurrence - Detailed Descriptions

Page standards status: Draft Maturity Level: 1

Definitions for the VisitOccurrence logical model.

Guidance on how to interpret the contents of this table can be found here

0. VisitOccurrence
Definition

This table contains Events where Persons engage with the healthcare system for a duration of time. They are often also called "Encounters". Visits are defined by a configuration of circumstances under which they occur, such as (i) whether the patient comes to a healthcare institution, the other way around, or the interaction is remote, (ii) whether and what kind of trained medical staff is delivering the service during the Visit, and (iii) whether the Visit is transient or for a longer period involving a stay in bed.

ShortVisit Occurrence OMOP Table
Logical ModelInstances of this logical model are not marked to be the target of a Reference
2. VisitOccurrence.visit-occurrence-id
Definition

Use this to identify unique interactions between a person and the health care system. This identifier links across the other CDM event tables to associate events with a visit.

ShortVisit Occurrence Identifier
Control1..1
Typeinteger
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
4. VisitOccurrence.person-id
Definition

Person

ShortPerson
Control1..1
TypeReference(Person OMOP Table)
6. VisitOccurrence.visit-concept-id
Definition

This field contains a concept id representing the kind of visit, like inpatient or outpatient. All concepts in this field should be standard and belong to the Visit domain.

ShortVisit
Control1..1
Typecode
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
8. VisitOccurrence.visit-start-date
Definition

For inpatient visits, the start date is typically the admission date. For outpatient visits the start date and end date will be the same.

ShortStart Date
Control1..1
Typedate
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
10. VisitOccurrence.visit-start-datetime
Definition

Start Datetime

ShortStart Datetime
Control0..1
TypedateTime
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
12. VisitOccurrence.visit-end-date
Definition

For inpatient visits the end date is typically the discharge date. If a Person is still an inpatient in the hospital at the time of the data extract and does not have a visit_end_date, then set the visit_end_date to the date of the data pull.

ShortEnd Date
Control1..1
Typedate
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
14. VisitOccurrence.visit-end-datetime
Definition

End Datetime

ShortEnd Datetime
Control0..1
TypedateTime
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
16. VisitOccurrence.visit-type-concept-id
Definition

Use this field to understand the provenance of the visit record, or where the record comes from.

ShortVisit Type
Control1..1
Typecode
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
18. VisitOccurrence.provider-id
Definition

There will only be one provider per visit record and the ETL document should clearly state how they were chosen (attending, admitting, etc.). If there are multiple providers associated with a visit in the source, this can be reflected in the event tables (CONDITION_OCCURRENCE, PROCEDURE_OCCURRENCE, etc.) or in the VISIT_DETAIL table.

ShortProvider
Control0..1
TypeReference(Provider OMOP Table)
20. VisitOccurrence.care-site-id
Definition

This field provides information about the Care Site where the Visit took place.

ShortCare Site
Control0..1
TypeReference(CareSite OMOP Table)
22. VisitOccurrence.visit-source-value
Definition

This field houses the verbatim value from the source data representing the kind of visit that took place (inpatient, outpatient, emergency, etc.)

ShortVisit Source Value
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
24. VisitOccurrence.visit-source-concept-id
Definition

Visit Source Concept

ShortVisit Source Concept
Control0..1
Typecode
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
26. VisitOccurrence.admitted-from-concept-id
Definition

Use this field to determine where the patient was admitted from. This concept is part of the visit domain and can indicate if a patient was admitted to the hospital from a long-term care facility, for example.

ShortAdmitted From Concept
Control0..1
Typecode
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
28. VisitOccurrence.admitted-from-source-value
Definition

Admitted From Source Value

ShortAdmitted From Source Value
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
30. VisitOccurrence.discharged-to-concept-id
Definition

Discharged To Concept

ShortDischarged To Concept
Control0..1
Typecode
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
32. VisitOccurrence.discharged-to-source-value
Definition

Discharged To Source Value

ShortDischarged To Source Value
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
34. VisitOccurrence.preceding-visit-occurrence-id
Definition

Use this field to find the visit that occurred for the person prior to the given visit. There could be a few days or a few years in between.

ShortPreceding Visit Occurrence
Control0..1
TypeReference(Visit Occurrence OMOP Table)

Guidance on how to interpret the contents of this table can be found here

0. VisitOccurrence
Definition

This table contains Events where Persons engage with the healthcare system for a duration of time. They are often also called "Encounters". Visits are defined by a configuration of circumstances under which they occur, such as (i) whether the patient comes to a healthcare institution, the other way around, or the interaction is remote, (ii) whether and what kind of trained medical staff is delivering the service during the Visit, and (iii) whether the Visit is transient or for a longer period involving a stay in bed.


Base definition for all types defined in FHIR type system.

ShortVisit Occurrence OMOP TableBase for all types and resources
Control0..*
Is Modifierfalse
Logical ModelInstances of this logical model are not marked to be the target of a Reference
2. VisitOccurrence.visit-occurrence-id
Definition

Use this to identify unique interactions between a person and the health care system. This identifier links across the other CDM event tables to associate events with a visit.

ShortVisit Occurrence Identifier
Control1..1
Typeinteger
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
4. VisitOccurrence.person-id
Definition

Person

ShortPerson
Control1..1
TypeReference(Person OMOP Table)
6. VisitOccurrence.visit-concept-id
Definition

This field contains a concept id representing the kind of visit, like inpatient or outpatient. All concepts in this field should be standard and belong to the Visit domain.

ShortVisit
Control1..1
Typecode
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
8. VisitOccurrence.visit-start-date
Definition

For inpatient visits, the start date is typically the admission date. For outpatient visits the start date and end date will be the same.

ShortStart Date
Control1..1
Typedate
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
10. VisitOccurrence.visit-start-datetime
Definition

Start Datetime

ShortStart Datetime
Control0..1
TypedateTime
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
12. VisitOccurrence.visit-end-date
Definition

For inpatient visits the end date is typically the discharge date. If a Person is still an inpatient in the hospital at the time of the data extract and does not have a visit_end_date, then set the visit_end_date to the date of the data pull.

ShortEnd Date
Control1..1
Typedate
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
14. VisitOccurrence.visit-end-datetime
Definition

End Datetime

ShortEnd Datetime
Control0..1
TypedateTime
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
16. VisitOccurrence.visit-type-concept-id
Definition

Use this field to understand the provenance of the visit record, or where the record comes from.

ShortVisit Type
Control1..1
Typecode
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
18. VisitOccurrence.provider-id
Definition

There will only be one provider per visit record and the ETL document should clearly state how they were chosen (attending, admitting, etc.). If there are multiple providers associated with a visit in the source, this can be reflected in the event tables (CONDITION_OCCURRENCE, PROCEDURE_OCCURRENCE, etc.) or in the VISIT_DETAIL table.

ShortProvider
Control0..1
TypeReference(Provider OMOP Table)
20. VisitOccurrence.care-site-id
Definition

This field provides information about the Care Site where the Visit took place.

ShortCare Site
Control0..1
TypeReference(CareSite OMOP Table)
22. VisitOccurrence.visit-source-value
Definition

This field houses the verbatim value from the source data representing the kind of visit that took place (inpatient, outpatient, emergency, etc.)

ShortVisit Source Value
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
24. VisitOccurrence.visit-source-concept-id
Definition

Visit Source Concept

ShortVisit Source Concept
Control0..1
Typecode
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
26. VisitOccurrence.admitted-from-concept-id
Definition

Use this field to determine where the patient was admitted from. This concept is part of the visit domain and can indicate if a patient was admitted to the hospital from a long-term care facility, for example.

ShortAdmitted From Concept
Control0..1
Typecode
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
28. VisitOccurrence.admitted-from-source-value
Definition

Admitted From Source Value

ShortAdmitted From Source Value
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
30. VisitOccurrence.discharged-to-concept-id
Definition

Discharged To Concept

ShortDischarged To Concept
Control0..1
Typecode
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
32. VisitOccurrence.discharged-to-source-value
Definition

Discharged To Source Value

ShortDischarged To Source Value
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
34. VisitOccurrence.preceding-visit-occurrence-id
Definition

Use this field to find the visit that occurred for the person prior to the given visit. There could be a few days or a few years in between.

ShortPreceding Visit Occurrence
Control0..1
TypeReference(Visit Occurrence OMOP Table)

Guidance on how to interpret the contents of this table can be found here

0. VisitOccurrence
Definition

This table contains Events where Persons engage with the healthcare system for a duration of time. They are often also called "Encounters". Visits are defined by a configuration of circumstances under which they occur, such as (i) whether the patient comes to a healthcare institution, the other way around, or the interaction is remote, (ii) whether and what kind of trained medical staff is delivering the service during the Visit, and (iii) whether the Visit is transient or for a longer period involving a stay in bed.

ShortVisit Occurrence OMOP Table
Control0..*
Is Modifierfalse
Logical ModelInstances of this logical model are not marked to be the target of a Reference
2. VisitOccurrence.visit-occurrence-id
Definition

Use this to identify unique interactions between a person and the health care system. This identifier links across the other CDM event tables to associate events with a visit.

ShortVisit Occurrence Identifier
Control1..1
Typeinteger
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
4. VisitOccurrence.person-id
Definition

Person

ShortPerson
Control1..1
TypeReference(Person OMOP Table)
6. VisitOccurrence.visit-concept-id
Definition

This field contains a concept id representing the kind of visit, like inpatient or outpatient. All concepts in this field should be standard and belong to the Visit domain.

ShortVisit
Control1..1
Typecode
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
8. VisitOccurrence.visit-start-date
Definition

For inpatient visits, the start date is typically the admission date. For outpatient visits the start date and end date will be the same.

ShortStart Date
Control1..1
Typedate
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
10. VisitOccurrence.visit-start-datetime
Definition

Start Datetime

ShortStart Datetime
Control0..1
TypedateTime
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
12. VisitOccurrence.visit-end-date
Definition

For inpatient visits the end date is typically the discharge date. If a Person is still an inpatient in the hospital at the time of the data extract and does not have a visit_end_date, then set the visit_end_date to the date of the data pull.

ShortEnd Date
Control1..1
Typedate
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
14. VisitOccurrence.visit-end-datetime
Definition

End Datetime

ShortEnd Datetime
Control0..1
TypedateTime
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
16. VisitOccurrence.visit-type-concept-id
Definition

Use this field to understand the provenance of the visit record, or where the record comes from.

ShortVisit Type
Control1..1
Typecode
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
18. VisitOccurrence.provider-id
Definition

There will only be one provider per visit record and the ETL document should clearly state how they were chosen (attending, admitting, etc.). If there are multiple providers associated with a visit in the source, this can be reflected in the event tables (CONDITION_OCCURRENCE, PROCEDURE_OCCURRENCE, etc.) or in the VISIT_DETAIL table.

ShortProvider
Control0..1
TypeReference(Provider OMOP Table)
20. VisitOccurrence.care-site-id
Definition

This field provides information about the Care Site where the Visit took place.

ShortCare Site
Control0..1
TypeReference(CareSite OMOP Table)
22. VisitOccurrence.visit-source-value
Definition

This field houses the verbatim value from the source data representing the kind of visit that took place (inpatient, outpatient, emergency, etc.)

ShortVisit Source Value
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
24. VisitOccurrence.visit-source-concept-id
Definition

Visit Source Concept

ShortVisit Source Concept
Control0..1
Typecode
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
26. VisitOccurrence.admitted-from-concept-id
Definition

Use this field to determine where the patient was admitted from. This concept is part of the visit domain and can indicate if a patient was admitted to the hospital from a long-term care facility, for example.

ShortAdmitted From Concept
Control0..1
Typecode
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
28. VisitOccurrence.admitted-from-source-value
Definition

Admitted From Source Value

ShortAdmitted From Source Value
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
30. VisitOccurrence.discharged-to-concept-id
Definition

Discharged To Concept

ShortDischarged To Concept
Control0..1
Typecode
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
32. VisitOccurrence.discharged-to-source-value
Definition

Discharged To Source Value

ShortDischarged To Source Value
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
34. VisitOccurrence.preceding-visit-occurrence-id
Definition

Use this field to find the visit that occurred for the person prior to the given visit. There could be a few days or a few years in between.

ShortPreceding Visit Occurrence
Control0..1
TypeReference(Visit Occurrence OMOP Table)