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: VisitDetail - Detailed Descriptions

Page standards status: Draft Maturity Level: 1

Definitions for the VisitDetail logical model.

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

0. VisitDetail
Definition

The VISIT_DETAIL table is an optional table used to represents details of each record in the parent VISIT_OCCURRENCE table. A good example of this would be the movement between units in a hospital during an inpatient stay or claim lines associated with a one insurance claim. For every record in the VISIT_OCCURRENCE table there may be 0 or more records in the VISIT_DETAIL table with a 1:n relationship where n may be 0. The VISIT_DETAIL table is structurally very similar to VISIT_OCCURRENCE table and belongs to the visit domain.

ShortVisit Detail OMOP Table
Logical ModelInstances of this logical model are not marked to be the target of a Reference
2. VisitDetail.visit-detail-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 detail.

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

Person

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

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

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

This is the date of the start of the encounter. This may or may not be equal to the date of the Visit the Visit Detail is associated with.

ShortVisit Detail Start Date
Control1..1
Typedate
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
10. VisitDetail.visit-detail-start-datetime
Definition

Visit Detail Start Datetime

ShortVisit Detail Start Datetime
Control0..1
TypedateTime
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
12. VisitDetail.visit-detail-end-date
Definition

This the end date of the patient-provider interaction. 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.

ShortVisit Detail End Date
Control1..1
Typedate
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
14. VisitDetail.visit-detail-end-datetime
Definition

If a Person is still an inpatient in the hospital at the time of the data extract and does not have a visit_end_datetime, then set the visit_end_datetime to the datetime of the data pull.

ShortVisit Detail End Datetime
Control0..1
TypedateTime
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
16. VisitDetail.visit-detail-type-concept-id
Definition

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

ShortVisit Detail Type
Control1..1
Typecode
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
18. VisitDetail.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.). This is a typical reason for leveraging the VISIT_DETAIL table as even though each VISIT_DETAIL record can only have one provider, there is no limit to the number of VISIT_DETAIL records that can be associated to a VISIT_OCCURRENCE record.

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

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

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

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

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

Visit Detail Source Concept

ShortVisit Detail Source Concept
Control0..1
Typecode
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
26. VisitDetail.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
Control0..1
Typecode
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
28. VisitDetail.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. VisitDetail.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
32. VisitDetail.discharged-to-concept-id
Definition

Use this field to determine where the patient was discharged to after a visit. This concept is part of the visit domain and can indicate if a patient was transferred to another hospital or sent to a long-term care facility, for example. It is assumed that a person is discharged to home therefore there is not a standard concept id for "home". Use concept id = 0 when a person is discharged to home.

ShortDischarged To
Control0..1
Typecode
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
34. VisitDetail.preceding-visit-detail-id
Definition

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

ShortPreceding Visit
Control0..1
TypeReference(Visit Detail OMOP Table)
36. VisitDetail.parent-visit-detail-id
Definition

Use this field to find the visit detail that subsumes the given visit detail record. This is used in the case that a visit detail record needs to be nested beyond the VISIT_OCCURRENCE/VISIT_DETAIL relationship.

ShortParent Visit
Control0..1
TypeReference(Visit Detail OMOP Table)
38. VisitDetail.visit-occurrence-id
Definition

Use this field to link the VISIT_DETAIL record to its VISIT_OCCURRENCE.

ShortVisit Occurrence
Control1..1
TypeReference(Visit Occurrence OMOP Table)

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

0. VisitDetail
Definition

The VISIT_DETAIL table is an optional table used to represents details of each record in the parent VISIT_OCCURRENCE table. A good example of this would be the movement between units in a hospital during an inpatient stay or claim lines associated with a one insurance claim. For every record in the VISIT_OCCURRENCE table there may be 0 or more records in the VISIT_DETAIL table with a 1:n relationship where n may be 0. The VISIT_DETAIL table is structurally very similar to VISIT_OCCURRENCE table and belongs to the visit domain.


Base definition for all types defined in FHIR type system.

ShortVisit Detail 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. VisitDetail.visit-detail-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 detail.

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

Person

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

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

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

This is the date of the start of the encounter. This may or may not be equal to the date of the Visit the Visit Detail is associated with.

ShortVisit Detail Start Date
Control1..1
Typedate
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
10. VisitDetail.visit-detail-start-datetime
Definition

Visit Detail Start Datetime

ShortVisit Detail Start Datetime
Control0..1
TypedateTime
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
12. VisitDetail.visit-detail-end-date
Definition

This the end date of the patient-provider interaction. 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.

ShortVisit Detail End Date
Control1..1
Typedate
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
14. VisitDetail.visit-detail-end-datetime
Definition

If a Person is still an inpatient in the hospital at the time of the data extract and does not have a visit_end_datetime, then set the visit_end_datetime to the datetime of the data pull.

ShortVisit Detail End Datetime
Control0..1
TypedateTime
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
16. VisitDetail.visit-detail-type-concept-id
Definition

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

ShortVisit Detail Type
Control1..1
Typecode
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
18. VisitDetail.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.). This is a typical reason for leveraging the VISIT_DETAIL table as even though each VISIT_DETAIL record can only have one provider, there is no limit to the number of VISIT_DETAIL records that can be associated to a VISIT_OCCURRENCE record.

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

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

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

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

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

Visit Detail Source Concept

ShortVisit Detail Source Concept
Control0..1
Typecode
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
26. VisitDetail.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
Control0..1
Typecode
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
28. VisitDetail.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. VisitDetail.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
32. VisitDetail.discharged-to-concept-id
Definition

Use this field to determine where the patient was discharged to after a visit. This concept is part of the visit domain and can indicate if a patient was transferred to another hospital or sent to a long-term care facility, for example. It is assumed that a person is discharged to home therefore there is not a standard concept id for "home". Use concept id = 0 when a person is discharged to home.

ShortDischarged To
Control0..1
Typecode
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
34. VisitDetail.preceding-visit-detail-id
Definition

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

ShortPreceding Visit
Control0..1
TypeReference(Visit Detail OMOP Table)
36. VisitDetail.parent-visit-detail-id
Definition

Use this field to find the visit detail that subsumes the given visit detail record. This is used in the case that a visit detail record needs to be nested beyond the VISIT_OCCURRENCE/VISIT_DETAIL relationship.

ShortParent Visit
Control0..1
TypeReference(Visit Detail OMOP Table)
38. VisitDetail.visit-occurrence-id
Definition

Use this field to link the VISIT_DETAIL record to its VISIT_OCCURRENCE.

ShortVisit Occurrence
Control1..1
TypeReference(Visit Occurrence OMOP Table)

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

0. VisitDetail
Definition

The VISIT_DETAIL table is an optional table used to represents details of each record in the parent VISIT_OCCURRENCE table. A good example of this would be the movement between units in a hospital during an inpatient stay or claim lines associated with a one insurance claim. For every record in the VISIT_OCCURRENCE table there may be 0 or more records in the VISIT_DETAIL table with a 1:n relationship where n may be 0. The VISIT_DETAIL table is structurally very similar to VISIT_OCCURRENCE table and belongs to the visit domain.

ShortVisit Detail OMOP Table
Control0..*
Is Modifierfalse
Logical ModelInstances of this logical model are not marked to be the target of a Reference
2. VisitDetail.visit-detail-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 detail.

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

Person

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

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

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

This is the date of the start of the encounter. This may or may not be equal to the date of the Visit the Visit Detail is associated with.

ShortVisit Detail Start Date
Control1..1
Typedate
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
10. VisitDetail.visit-detail-start-datetime
Definition

Visit Detail Start Datetime

ShortVisit Detail Start Datetime
Control0..1
TypedateTime
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
12. VisitDetail.visit-detail-end-date
Definition

This the end date of the patient-provider interaction. 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.

ShortVisit Detail End Date
Control1..1
Typedate
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
14. VisitDetail.visit-detail-end-datetime
Definition

If a Person is still an inpatient in the hospital at the time of the data extract and does not have a visit_end_datetime, then set the visit_end_datetime to the datetime of the data pull.

ShortVisit Detail End Datetime
Control0..1
TypedateTime
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
16. VisitDetail.visit-detail-type-concept-id
Definition

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

ShortVisit Detail Type
Control1..1
Typecode
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
18. VisitDetail.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.). This is a typical reason for leveraging the VISIT_DETAIL table as even though each VISIT_DETAIL record can only have one provider, there is no limit to the number of VISIT_DETAIL records that can be associated to a VISIT_OCCURRENCE record.

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

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

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

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

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

Visit Detail Source Concept

ShortVisit Detail Source Concept
Control0..1
Typecode
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
26. VisitDetail.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
Control0..1
Typecode
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
28. VisitDetail.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. VisitDetail.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
32. VisitDetail.discharged-to-concept-id
Definition

Use this field to determine where the patient was discharged to after a visit. This concept is part of the visit domain and can indicate if a patient was transferred to another hospital or sent to a long-term care facility, for example. It is assumed that a person is discharged to home therefore there is not a standard concept id for "home". Use concept id = 0 when a person is discharged to home.

ShortDischarged To
Control0..1
Typecode
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
34. VisitDetail.preceding-visit-detail-id
Definition

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

ShortPreceding Visit
Control0..1
TypeReference(Visit Detail OMOP Table)
36. VisitDetail.parent-visit-detail-id
Definition

Use this field to find the visit detail that subsumes the given visit detail record. This is used in the case that a visit detail record needs to be nested beyond the VISIT_OCCURRENCE/VISIT_DETAIL relationship.

ShortParent Visit
Control0..1
TypeReference(Visit Detail OMOP Table)
38. VisitDetail.visit-occurrence-id
Definition

Use this field to link the VISIT_DETAIL record to its VISIT_OCCURRENCE.

ShortVisit Occurrence
Control1..1
TypeReference(Visit Occurrence OMOP Table)