PackagesCanonicalsLogsProblems
    Packages
    hl7.fhir.uv.omop@1.0.0-ballot
    http://hl7.org/fhir/uv/omop/StructureDefinition/Person
{
  "description": "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.",
  "_filename": "StructureDefinition-Person.json",
  "package_name": "hl7.fhir.uv.omop",
  "date": "2025-07-29T21:03:04+00:00",
  "derivation": "specialization",
  "publisher": "HL7 International / Biomedical Research and Regulation",
  "fhirVersion": "5.0.0",
  "jurisdiction": [ {
    "coding": [ {
      "code": "001",
      "system": "http://unstats.un.org/unsd/methods/m49/m49.htm",
      "display": "World"
    } ]
  } ],
  "name": "Person",
  "mapping": [ {
    "uri": "http://hl7.org/v3",
    "name": "RIM Mapping",
    "identity": "rim"
  } ],
  "abstract": false,
  "type": "http://hl7.org/fhir/uv/omop/StructureDefinition/Person",
  "experimental": null,
  "resourceType": "StructureDefinition",
  "title": "Person OMOP Table",
  "package_version": "1.0.0-ballot",
  "extension": [ {
    "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-type-characteristics",
    "valueCode": "can-be-target"
  }, {
    "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
    "valueCode": "brr"
  }, {
    "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
    "valueInteger": 1,
    "_valueInteger": {
      "extension": [ {
        "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom",
        "valueCanonical": "http://hl7.org/fhir/uv/omop/ImplementationGuide/hl7.fhir.uv.omop"
      } ]
    }
  }, {
    "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
    "valueCode": "informative",
    "_valueCode": {
      "extension": [ {
        "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom",
        "valueCanonical": "http://hl7.org/fhir/uv/omop/ImplementationGuide/hl7.fhir.uv.omop"
      } ]
    }
  } ],
  "snapshot": {
    "element": [ {
      "path": "Person",
      "min": 0,
      "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.",
      "isModifier": false,
      "short": "Person OMOP Table",
      "mapping": [ {
        "map": "n/a",
        "identity": "rim"
      } ],
      "max": "*",
      "id": "Person",
      "base": {
        "max": "*",
        "min": 0,
        "path": "Base"
      }
    }, {
      "id": "Person.person-id",
      "max": "1",
      "min": 1,
      "base": {
        "max": "1",
        "min": 1,
        "path": "Person.person_id"
      },
      "path": "Person.person_id",
      "type": [ {
        "code": "integer"
      } ],
      "short": "Person Identifier",
      "definition": "It is assumed that every person with a different unique identifier is in fact a different person and should be treated independently."
    }, {
      "id": "Person.gender-concept-id",
      "max": "1",
      "min": 1,
      "base": {
        "max": "1",
        "min": 1,
        "path": "Person.gender_concept_id"
      },
      "path": "Person.gender_concept_id",
      "type": [ {
        "code": "code"
      } ],
      "short": "Gender",
      "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."
    }, {
      "id": "Person.year-of-birth",
      "max": "1",
      "min": 1,
      "base": {
        "max": "1",
        "min": 1,
        "path": "Person.year_of_birth"
      },
      "path": "Person.year_of_birth",
      "type": [ {
        "code": "integer"
      } ],
      "short": "Year of Birth",
      "definition": "Compute age using year_of_birth."
    }, {
      "id": "Person.month-of-birth",
      "max": "1",
      "min": 0,
      "base": {
        "max": "1",
        "min": 0,
        "path": "Person.month_of_birth"
      },
      "path": "Person.month_of_birth",
      "type": [ {
        "code": "integer"
      } ],
      "short": "Month of Birth",
      "definition": "Month of Birth"
    }, {
      "id": "Person.day-of-birth",
      "max": "1",
      "min": 0,
      "base": {
        "max": "1",
        "min": 0,
        "path": "Person.day_of_birth"
      },
      "path": "Person.day_of_birth",
      "type": [ {
        "code": "integer"
      } ],
      "short": "Day of Birth",
      "definition": "Day of Birth"
    }, {
      "id": "Person.birth-datetime",
      "max": "1",
      "min": 0,
      "base": {
        "max": "1",
        "min": 0,
        "path": "Person.birth_datetime"
      },
      "path": "Person.birth_datetime",
      "type": [ {
        "code": "dateTime"
      } ],
      "short": "Birth Datetime",
      "definition": "Birth Datetime"
    }, {
      "id": "Person.race-concept-id",
      "max": "1",
      "min": 1,
      "base": {
        "max": "1",
        "min": 1,
        "path": "Person.race_concept_id"
      },
      "path": "Person.race_concept_id",
      "type": [ {
        "code": "code"
      } ],
      "short": "Race",
      "definition": "This field captures race or ethnic background of the person."
    }, {
      "id": "Person.ethnicity-concept-id",
      "max": "1",
      "min": 1,
      "base": {
        "max": "1",
        "min": 1,
        "path": "Person.ethnicity_concept_id"
      },
      "path": "Person.ethnicity_concept_id",
      "type": [ {
        "code": "code"
      } ],
      "short": "Ethnicity",
      "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."
    }, {
      "id": "Person.location-id",
      "max": "1",
      "min": 0,
      "base": {
        "max": "1",
        "min": 0,
        "path": "Person.location_id"
      },
      "path": "Person.location_id",
      "type": [ {
        "code": "Reference",
        "targetProfile": [ "http://hl7.org/fhir/uv/omop/StructureDefinition/Location" ]
      } ],
      "short": "Location",
      "definition": "The location refers to the physical address of the person. This field should capture the last known location of the person."
    }, {
      "id": "Person.provider-id",
      "max": "1",
      "min": 0,
      "base": {
        "max": "1",
        "min": 0,
        "path": "Person.provider_id"
      },
      "path": "Person.provider_id",
      "type": [ {
        "code": "Reference",
        "targetProfile": [ "http://hl7.org/fhir/uv/omop/StructureDefinition/Provider" ]
      } ],
      "short": "Provider",
      "definition": "The Provider refers to the last known primary care provider (General Practitioner)."
    }, {
      "id": "Person.care-site-id",
      "max": "1",
      "min": 0,
      "base": {
        "max": "1",
        "min": 0,
        "path": "Person.care_site_id"
      },
      "path": "Person.care_site_id",
      "type": [ {
        "code": "Reference",
        "targetProfile": [ "http://hl7.org/fhir/uv/omop/StructureDefinition/CareSite" ]
      } ],
      "short": "Care Site",
      "definition": "The Care Site refers to where the Provider typically provides the primary care."
    }, {
      "id": "Person.person-source-value",
      "max": "1",
      "min": 0,
      "base": {
        "max": "1",
        "min": 0,
        "path": "Person.person_source_value"
      },
      "path": "Person.person_source_value",
      "type": [ {
        "code": "string"
      } ],
      "short": "Person Identifier 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."
    }, {
      "id": "Person.gender-source-value",
      "max": "1",
      "min": 0,
      "base": {
        "max": "1",
        "min": 0,
        "path": "Person.gender_source_value"
      },
      "path": "Person.gender_source_value",
      "type": [ {
        "code": "string"
      } ],
      "short": "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."
    }, {
      "id": "Person.gender-source-concept-id",
      "max": "1",
      "min": 0,
      "base": {
        "max": "1",
        "min": 0,
        "path": "Person.gender_source_concept_id"
      },
      "path": "Person.gender_source_concept_id",
      "type": [ {
        "code": "code"
      } ],
      "short": "Gender Source Concept",
      "definition": "If the source data codes biological sex in a non-standard vocabulary, store the concept_id here."
    }, {
      "id": "Person.race-source-value",
      "max": "1",
      "min": 0,
      "base": {
        "max": "1",
        "min": 0,
        "path": "Person.race_source_value"
      },
      "path": "Person.race_source_value",
      "type": [ {
        "code": "string"
      } ],
      "short": "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."
    }, {
      "id": "Person.race-source-concept-id",
      "max": "1",
      "min": 0,
      "base": {
        "max": "1",
        "min": 0,
        "path": "Person.race_source_concept_id"
      },
      "path": "Person.race_source_concept_id",
      "type": [ {
        "code": "code"
      } ],
      "short": "Race Source Concept",
      "definition": "If the source data codes race in an OMOP supported vocabulary store the concept_id here."
    }, {
      "id": "Person.ethnicity-source-value",
      "max": "1",
      "min": 0,
      "base": {
        "max": "1",
        "min": 0,
        "path": "Person.ethnicity_source_value"
      },
      "path": "Person.ethnicity_source_value",
      "type": [ {
        "code": "string"
      } ],
      "short": "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."
    }, {
      "id": "Person.ethnicity-source-concept-id",
      "max": "1",
      "min": 0,
      "base": {
        "max": "1",
        "min": 0,
        "path": "Person.ethnicity_source_concept_id"
      },
      "path": "Person.ethnicity_source_concept_id",
      "type": [ {
        "code": "code"
      } ],
      "short": "Ethnicity Source Concept",
      "definition": "If the source data codes ethnicity in an OMOP supported vocabulary, store the concept_id here."
    } ],
    "extension": [ {
      "url": "http://hl7.org/fhir/tools/StructureDefinition/snapshot-base-version",
      "valueString": "5.0.0"
    } ]
  },
  "status": "active",
  "id": "1f2741ee-78bd-47fc-9572-8ccf869d3421",
  "kind": "logical",
  "url": "http://hl7.org/fhir/uv/omop/StructureDefinition/Person",
  "version": "1.0.0-ballot",
  "differential": {
    "element": [ {
      "id": "Person",
      "path": "Person",
      "short": "Person OMOP Table",
      "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."
    }, {
      "id": "Person.person-id",
      "max": "1",
      "min": 1,
      "path": "Person.person_id",
      "type": [ {
        "code": "integer"
      } ],
      "short": "Person Identifier",
      "definition": "It is assumed that every person with a different unique identifier is in fact a different person and should be treated independently."
    }, {
      "id": "Person.gender-concept-id",
      "max": "1",
      "min": 1,
      "path": "Person.gender_concept_id",
      "type": [ {
        "code": "code"
      } ],
      "short": "Gender",
      "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."
    }, {
      "id": "Person.year-of-birth",
      "max": "1",
      "min": 1,
      "path": "Person.year_of_birth",
      "type": [ {
        "code": "integer"
      } ],
      "short": "Year of Birth",
      "definition": "Compute age using year_of_birth."
    }, {
      "id": "Person.month-of-birth",
      "max": "1",
      "min": 0,
      "path": "Person.month_of_birth",
      "type": [ {
        "code": "integer"
      } ],
      "short": "Month of Birth",
      "definition": "Month of Birth"
    }, {
      "id": "Person.day-of-birth",
      "max": "1",
      "min": 0,
      "path": "Person.day_of_birth",
      "type": [ {
        "code": "integer"
      } ],
      "short": "Day of Birth",
      "definition": "Day of Birth"
    }, {
      "id": "Person.birth-datetime",
      "max": "1",
      "min": 0,
      "path": "Person.birth_datetime",
      "type": [ {
        "code": "dateTime"
      } ],
      "short": "Birth Datetime",
      "definition": "Birth Datetime"
    }, {
      "id": "Person.race-concept-id",
      "max": "1",
      "min": 1,
      "path": "Person.race_concept_id",
      "type": [ {
        "code": "code"
      } ],
      "short": "Race",
      "definition": "This field captures race or ethnic background of the person."
    }, {
      "id": "Person.ethnicity-concept-id",
      "max": "1",
      "min": 1,
      "path": "Person.ethnicity_concept_id",
      "type": [ {
        "code": "code"
      } ],
      "short": "Ethnicity",
      "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."
    }, {
      "id": "Person.location-id",
      "max": "1",
      "min": 0,
      "path": "Person.location_id",
      "type": [ {
        "code": "Reference",
        "targetProfile": [ "http://hl7.org/fhir/uv/omop/StructureDefinition/Location" ]
      } ],
      "short": "Location",
      "definition": "The location refers to the physical address of the person. This field should capture the last known location of the person."
    }, {
      "id": "Person.provider-id",
      "max": "1",
      "min": 0,
      "path": "Person.provider_id",
      "type": [ {
        "code": "Reference",
        "targetProfile": [ "http://hl7.org/fhir/uv/omop/StructureDefinition/Provider" ]
      } ],
      "short": "Provider",
      "definition": "The Provider refers to the last known primary care provider (General Practitioner)."
    }, {
      "id": "Person.care-site-id",
      "max": "1",
      "min": 0,
      "path": "Person.care_site_id",
      "type": [ {
        "code": "Reference",
        "targetProfile": [ "http://hl7.org/fhir/uv/omop/StructureDefinition/CareSite" ]
      } ],
      "short": "Care Site",
      "definition": "The Care Site refers to where the Provider typically provides the primary care."
    }, {
      "id": "Person.person-source-value",
      "max": "1",
      "min": 0,
      "path": "Person.person_source_value",
      "type": [ {
        "code": "string"
      } ],
      "short": "Person Identifier 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."
    }, {
      "id": "Person.gender-source-value",
      "max": "1",
      "min": 0,
      "path": "Person.gender_source_value",
      "type": [ {
        "code": "string"
      } ],
      "short": "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."
    }, {
      "id": "Person.gender-source-concept-id",
      "max": "1",
      "min": 0,
      "path": "Person.gender_source_concept_id",
      "type": [ {
        "code": "code"
      } ],
      "short": "Gender Source Concept",
      "definition": "If the source data codes biological sex in a non-standard vocabulary, store the concept_id here."
    }, {
      "id": "Person.race-source-value",
      "max": "1",
      "min": 0,
      "path": "Person.race_source_value",
      "type": [ {
        "code": "string"
      } ],
      "short": "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."
    }, {
      "id": "Person.race-source-concept-id",
      "max": "1",
      "min": 0,
      "path": "Person.race_source_concept_id",
      "type": [ {
        "code": "code"
      } ],
      "short": "Race Source Concept",
      "definition": "If the source data codes race in an OMOP supported vocabulary store the concept_id here."
    }, {
      "id": "Person.ethnicity-source-value",
      "max": "1",
      "min": 0,
      "path": "Person.ethnicity_source_value",
      "type": [ {
        "code": "string"
      } ],
      "short": "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."
    }, {
      "id": "Person.ethnicity-source-concept-id",
      "max": "1",
      "min": 0,
      "path": "Person.ethnicity_source_concept_id",
      "type": [ {
        "code": "code"
      } ],
      "short": "Ethnicity Source Concept",
      "definition": "If the source data codes ethnicity in an OMOP supported vocabulary, store the concept_id here."
    } ]
  },
  "contact": [ {
    "name": "HL7 International / Biomedical Research and Regulation",
    "telecom": [ {
      "value": "http://www.hl7.org/Special/committees/rcrim",
      "system": "url"
    } ]
  } ],
  "baseDefinition": "http://hl7.org/fhir/StructureDefinition/Base"
}