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

Page standards status: Draft Maturity Level: 1

Definitions for the Person logical model.

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

0. Person
Definition

This table serves as the central identity management for all Persons in the database. It contains records that uniquely identify each person or patient, and some demographic information.

ShortPerson OMOP Table
Logical ModelInstances of this logical model are not marked to be the target of a Reference
2. Person.person-id
Definition

It is assumed that every person with a different unique identifier is in fact a different person and should be treated independently.

ShortPerson Identifier
Control1..1
Typeinteger
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
4. Person.gender-concept-id
Definition

This field is meant to capture the biological sex at birth of the Person. This field should not be used to study gender identity issues.

ShortGender
Control1..1
Typecode
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
6. Person.year-of-birth
Definition

Compute age using year_of_birth.

ShortYear of Birth
Control1..1
Typeinteger
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
8. Person.month-of-birth
Definition

Month of Birth

ShortMonth of Birth
Control0..1
Typeinteger
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
10. Person.day-of-birth
Definition

Day of Birth

ShortDay of Birth
Control0..1
Typeinteger
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
12. Person.birth-datetime
Definition

Birth Datetime

ShortBirth Datetime
Control0..1
TypedateTime
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
14. Person.race-concept-id
Definition

This field captures race or ethnic background of the person.

ShortRace
Control1..1
Typecode
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
16. Person.ethnicity-concept-id
Definition

This field captures Ethnicity as defined by the Office of Management and Budget (OMB) of the US Government: it distinguishes only between “Hispanic” and “Not Hispanic”. Races and ethnic backgrounds are not stored here.

ShortEthnicity
Control1..1
Typecode
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
18. Person.location-id
Definition

The location refers to the physical address of the person. This field should capture the last known location of the person.

ShortLocation
Control0..1
TypeReference(Location OMOP Table)
20. Person.provider-id
Definition

The Provider refers to the last known primary care provider (General Practitioner).

ShortProvider
Control0..1
TypeReference(Provider OMOP Table)
22. Person.care-site-id
Definition

The Care Site refers to where the Provider typically provides the primary care.

ShortCare Site
Control0..1
TypeReference(CareSite OMOP Table)
24. Person.person-source-value
Definition

Use this field to link back to persons in the source data. This is typically used for error checking of ETL logic.

ShortPerson Identifier Source Value
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
26. Person.gender-source-value
Definition

This field is used to store the biological sex of the person from the source data. It is not intended for use in standard analytics but for reference only.

ShortGender Source Value
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
28. Person.gender-source-concept-id
Definition

If the source data codes biological sex in a non-standard vocabulary, store the concept_id here.

ShortGender Source Concept
Control0..1
Typecode
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
30. Person.race-source-value
Definition

This field is used to store the race of the person from the source data. It is not intended for use in standard analytics but for reference only.

ShortRace Source Value
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
32. Person.race-source-concept-id
Definition

If the source data codes race in an OMOP supported vocabulary store the concept_id here.

ShortRace Source Concept
Control0..1
Typecode
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
34. Person.ethnicity-source-value
Definition

This field is used to store the ethnicity of the person from the source data. It is not intended for use in standard analytics but for reference only.

ShortEthnicity Source Value
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
36. Person.ethnicity-source-concept-id
Definition

If the source data codes ethnicity in an OMOP supported vocabulary, store the concept_id here.

ShortEthnicity Source Concept
Control0..1
Typecode
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension

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

0. Person
Definition

This table serves as the central identity management for all Persons in the database. It contains records that uniquely identify each person or patient, and some demographic information.


Base definition for all types defined in FHIR type system.

ShortPerson 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. Person.person-id
Definition

It is assumed that every person with a different unique identifier is in fact a different person and should be treated independently.

ShortPerson Identifier
Control1..1
Typeinteger
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
4. Person.gender-concept-id
Definition

This field is meant to capture the biological sex at birth of the Person. This field should not be used to study gender identity issues.

ShortGender
Control1..1
Typecode
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
6. Person.year-of-birth
Definition

Compute age using year_of_birth.

ShortYear of Birth
Control1..1
Typeinteger
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
8. Person.month-of-birth
Definition

Month of Birth

ShortMonth of Birth
Control0..1
Typeinteger
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
10. Person.day-of-birth
Definition

Day of Birth

ShortDay of Birth
Control0..1
Typeinteger
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
12. Person.birth-datetime
Definition

Birth Datetime

ShortBirth Datetime
Control0..1
TypedateTime
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
14. Person.race-concept-id
Definition

This field captures race or ethnic background of the person.

ShortRace
Control1..1
Typecode
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
16. Person.ethnicity-concept-id
Definition

This field captures Ethnicity as defined by the Office of Management and Budget (OMB) of the US Government: it distinguishes only between “Hispanic” and “Not Hispanic”. Races and ethnic backgrounds are not stored here.

ShortEthnicity
Control1..1
Typecode
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
18. Person.location-id
Definition

The location refers to the physical address of the person. This field should capture the last known location of the person.

ShortLocation
Control0..1
TypeReference(Location OMOP Table)
20. Person.provider-id
Definition

The Provider refers to the last known primary care provider (General Practitioner).

ShortProvider
Control0..1
TypeReference(Provider OMOP Table)
22. Person.care-site-id
Definition

The Care Site refers to where the Provider typically provides the primary care.

ShortCare Site
Control0..1
TypeReference(CareSite OMOP Table)
24. Person.person-source-value
Definition

Use this field to link back to persons in the source data. This is typically used for error checking of ETL logic.

ShortPerson Identifier Source Value
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
26. Person.gender-source-value
Definition

This field is used to store the biological sex of the person from the source data. It is not intended for use in standard analytics but for reference only.

ShortGender Source Value
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
28. Person.gender-source-concept-id
Definition

If the source data codes biological sex in a non-standard vocabulary, store the concept_id here.

ShortGender Source Concept
Control0..1
Typecode
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
30. Person.race-source-value
Definition

This field is used to store the race of the person from the source data. It is not intended for use in standard analytics but for reference only.

ShortRace Source Value
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
32. Person.race-source-concept-id
Definition

If the source data codes race in an OMOP supported vocabulary store the concept_id here.

ShortRace Source Concept
Control0..1
Typecode
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
34. Person.ethnicity-source-value
Definition

This field is used to store the ethnicity of the person from the source data. It is not intended for use in standard analytics but for reference only.

ShortEthnicity Source Value
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
36. Person.ethnicity-source-concept-id
Definition

If the source data codes ethnicity in an OMOP supported vocabulary, store the concept_id here.

ShortEthnicity Source Concept
Control0..1
Typecode
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension

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

0. Person
Definition

This table serves as the central identity management for all Persons in the database. It contains records that uniquely identify each person or patient, and some demographic information.

ShortPerson OMOP Table
Control0..*
Is Modifierfalse
Logical ModelInstances of this logical model are not marked to be the target of a Reference
2. Person.person-id
Definition

It is assumed that every person with a different unique identifier is in fact a different person and should be treated independently.

ShortPerson Identifier
Control1..1
Typeinteger
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
4. Person.gender-concept-id
Definition

This field is meant to capture the biological sex at birth of the Person. This field should not be used to study gender identity issues.

ShortGender
Control1..1
Typecode
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
6. Person.year-of-birth
Definition

Compute age using year_of_birth.

ShortYear of Birth
Control1..1
Typeinteger
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
8. Person.month-of-birth
Definition

Month of Birth

ShortMonth of Birth
Control0..1
Typeinteger
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
10. Person.day-of-birth
Definition

Day of Birth

ShortDay of Birth
Control0..1
Typeinteger
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
12. Person.birth-datetime
Definition

Birth Datetime

ShortBirth Datetime
Control0..1
TypedateTime
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
14. Person.race-concept-id
Definition

This field captures race or ethnic background of the person.

ShortRace
Control1..1
Typecode
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
16. Person.ethnicity-concept-id
Definition

This field captures Ethnicity as defined by the Office of Management and Budget (OMB) of the US Government: it distinguishes only between “Hispanic” and “Not Hispanic”. Races and ethnic backgrounds are not stored here.

ShortEthnicity
Control1..1
Typecode
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
18. Person.location-id
Definition

The location refers to the physical address of the person. This field should capture the last known location of the person.

ShortLocation
Control0..1
TypeReference(Location OMOP Table)
20. Person.provider-id
Definition

The Provider refers to the last known primary care provider (General Practitioner).

ShortProvider
Control0..1
TypeReference(Provider OMOP Table)
22. Person.care-site-id
Definition

The Care Site refers to where the Provider typically provides the primary care.

ShortCare Site
Control0..1
TypeReference(CareSite OMOP Table)
24. Person.person-source-value
Definition

Use this field to link back to persons in the source data. This is typically used for error checking of ETL logic.

ShortPerson Identifier Source Value
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
26. Person.gender-source-value
Definition

This field is used to store the biological sex of the person from the source data. It is not intended for use in standard analytics but for reference only.

ShortGender Source Value
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
28. Person.gender-source-concept-id
Definition

If the source data codes biological sex in a non-standard vocabulary, store the concept_id here.

ShortGender Source Concept
Control0..1
Typecode
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
30. Person.race-source-value
Definition

This field is used to store the race of the person from the source data. It is not intended for use in standard analytics but for reference only.

ShortRace Source Value
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
32. Person.race-source-concept-id
Definition

If the source data codes race in an OMOP supported vocabulary store the concept_id here.

ShortRace Source Concept
Control0..1
Typecode
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
34. Person.ethnicity-source-value
Definition

This field is used to store the ethnicity of the person from the source data. It is not intended for use in standard analytics but for reference only.

ShortEthnicity Source Value
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
36. Person.ethnicity-source-concept-id
Definition

If the source data codes ethnicity in an OMOP supported vocabulary, store the concept_id here.

ShortEthnicity Source Concept
Control0..1
Typecode
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension