{
  "resourceType": "StructureDefinition",
  "id": "LogicalModel-OMOP-Person",
  "meta": {
    "versionId": "6",
    "lastUpdated": "2022-06-20T08:53:17.4700841+00:00"
  },
  "url": "https://fhir.ohdsi.org/LogicalModel/OMOPPerson",
  "name": "LogicalModelOMOPPerson",
  "title": "LogicalModel OMOP Person",
  "status": "draft",
  "date": "2022-06-20T15:18:48.5858112+00:00",
  "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.",
  "fhirVersion": "4.0.1",
  "mapping": [
    {
      "identity": "OMOP-CDM-v5.3.1",
      "uri": "https://ohdsi.github.io/CommonDataModel/cdm531.html",
      "name": "OMOP Common Data Model v5.3.1"
    },
    {
      "identity": "OMOP-CDM-v6.0",
      "uri": "https://ohdsi.github.io/CommonDataModel/cdm60.html"
    }
  ],
  "kind": "logical",
  "abstract": false,
  "type": "https://fhir.ohdsi.org/LogicalModels/OMOPPerson",
  "baseDefinition": "http://hl7.org/fhir/StructureDefinition/Element",
  "derivation": "specialization",
  "snapshot": {
    "element": [
      {
        "id": "OMOPPerson",
        "path": "OMOPPerson",
        "short": "Base for all elements",
        "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.",
        "min": 0,
        "max": "*",
        "base": {
          "path": "OMOPPerson",
          "min": 0,
          "max": "*"
        },
        "type": [
          {
            "code": "Element"
          }
        ],
        "condition": [
          "ele-1"
        ],
        "constraint": [
          {
            "key": "ele-1",
            "severity": "error",
            "human": "All FHIR elements must have a @value or children",
            "expression": "hasValue() or (children().count() > id.count())",
            "xpath": "@value|f:*|h:div",
            "source": "http://hl7.org/fhir/StructureDefinition/Element"
          }
        ],
        "mapping": [
          {
            "identity": "rim",
            "map": "n/a"
          },
          {
            "identity": "OMOP-CDM-v5.3.1",
            "map": "Person"
          }
        ]
      },
      {
        "id": "OMOPPerson.id",
        "path": "OMOPPerson.id",
        "representation": [
          "xmlAttr"
        ],
        "short": "Unique id for inter-element referencing",
        "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
        "min": 0,
        "max": "1",
        "base": {
          "path": "Element.id",
          "min": 0,
          "max": "1"
        },
        "type": [
          {
            "extension": [
              {
                "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
                "valueUrl": "string"
              }
            ],
            "code": "http://hl7.org/fhirpath/System.String"
          }
        ],
        "mapping": [
          {
            "identity": "rim",
            "map": "n/a"
          }
        ]
      },
      {
        "id": "OMOPPerson.extension",
        "path": "OMOPPerson.extension",
        "slicing": {
          "discriminator": [
            {
              "type": "value",
              "path": "url"
            }
          ],
          "description": "Extensions are always sliced by (at least) url",
          "rules": "open"
        },
        "short": "Additional content defined by implementations",
        "definition": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance  applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
        "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions.  The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
        "alias": [
          "extensions",
          "user content"
        ],
        "min": 0,
        "max": "*",
        "base": {
          "path": "Element.extension",
          "min": 0,
          "max": "*"
        },
        "type": [
          {
            "code": "Extension"
          }
        ],
        "condition": [
          "ele-1"
        ],
        "constraint": [
          {
            "key": "ele-1",
            "severity": "error",
            "human": "All FHIR elements must have a @value or children",
            "expression": "hasValue() or (children().count() > id.count())",
            "xpath": "@value|f:*|h:div",
            "source": "http://hl7.org/fhir/StructureDefinition/Element"
          },
          {
            "key": "ext-1",
            "severity": "error",
            "human": "Must have either extensions or value[x], not both",
            "expression": "extension.exists() != value.exists()",
            "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])",
            "source": "http://hl7.org/fhir/StructureDefinition/Extension"
          }
        ],
        "mapping": [
          {
            "identity": "rim",
            "map": "n/a"
          },
          {
            "identity": "rim",
            "map": "N/A"
          }
        ]
      },
      {
        "id": "OMOPPerson.person_id",
        "path": "OMOPPerson.person_id",
        "short": "Primitive Type integer",
        "definition": "It is assumed that every person with a different unique identifier is in fact a different person and should be treated independently.\r\n\r\nAny person linkage that needs to occur to uniquely identify Persons ought to be done prior to writing this table. This identifier can be the original id from the source data provided if it is an integer, otherwise it can be an autogenerated number.",
        "comment": "32 bit number; for values larger than this, use decimal",
        "min": 1,
        "max": "1",
        "base": {
          "path": "OMOPPerson.person_id",
          "min": 1,
          "max": "1"
        },
        "type": [
          {
            "code": "integer",
            "profile": [
              "http://hl7.org/fhir/StructureDefinition/integer"
            ]
          }
        ],
        "condition": [
          "ele-1"
        ],
        "constraint": [
          {
            "key": "ele-1",
            "severity": "error",
            "human": "All FHIR elements must have a @value or children",
            "expression": "hasValue() or (children().count() > id.count())",
            "xpath": "@value|f:*|h:div",
            "source": "http://hl7.org/fhir/StructureDefinition/Element"
          }
        ],
        "mapping": [
          {
            "identity": "rim",
            "map": "n/a"
          },
          {
            "identity": "OMOP-CDM-v5.3.1",
            "map": "Person.person_id"
          }
        ]
      },
      {
        "id": "OMOPPerson.gender_concept_id",
        "extension": [
          {
            "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
            "valueCode": "normative"
          },
          {
            "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version",
            "valueCode": "4.0.0"
          }
        ],
        "path": "OMOPPerson.gender_concept_id",
        "short": "Concept - reference to a terminology or just  text",
        "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.",
        "comment": "Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination.",
        "min": 1,
        "max": "1",
        "base": {
          "path": "OMOPPerson.gender_concept_id",
          "min": 1,
          "max": "1"
        },
        "type": [
          {
            "code": "CodeableConcept",
            "profile": [
              "http://hl7.org/fhir/StructureDefinition/CodeableConcept"
            ]
          }
        ],
        "condition": [
          "ele-1"
        ],
        "constraint": [
          {
            "key": "ele-1",
            "severity": "error",
            "human": "All FHIR elements must have a @value or children",
            "expression": "hasValue() or (children().count() > id.count())",
            "xpath": "@value|f:*|h:div",
            "source": "http://hl7.org/fhir/StructureDefinition/Element"
          }
        ],
        "binding": {
          "strength": "required",
          "valueSet": "https://fhir.ohdsi.org/ValueSet/OMOPGender"
        },
        "mapping": [
          {
            "identity": "rim",
            "map": "n/a"
          },
          {
            "identity": "v2",
            "map": "CE/CNE/CWE"
          },
          {
            "identity": "rim",
            "map": "CD"
          },
          {
            "identity": "orim",
            "map": "fhir:CodeableConcept rdfs:subClassOf dt:CD"
          },
          {
            "identity": "OMOP-CDM-v5.3.1",
            "map": "Person.gender_concept_id"
          }
        ]
      },
      {
        "id": "OMOPPerson.year_of_birth",
        "path": "OMOPPerson.year_of_birth",
        "short": "Primitive Type integer",
        "definition": "Compute age using year_of_birth.\r\n\r\nFor data sources with date of birth, the year should be extracted. For data sources where the year of birth is not available, the approximate year of birth could be derived based on age group categorization, if available.",
        "comment": "32 bit number; for values larger than this, use decimal",
        "min": 1,
        "max": "1",
        "base": {
          "path": "OMOPPerson.year_of_birth",
          "min": 1,
          "max": "1"
        },
        "type": [
          {
            "code": "integer",
            "profile": [
              "http://hl7.org/fhir/StructureDefinition/integer"
            ]
          }
        ],
        "condition": [
          "ele-1"
        ],
        "constraint": [
          {
            "key": "ele-1",
            "severity": "error",
            "human": "All FHIR elements must have a @value or children",
            "expression": "hasValue() or (children().count() > id.count())",
            "xpath": "@value|f:*|h:div",
            "source": "http://hl7.org/fhir/StructureDefinition/Element"
          }
        ],
        "mapping": [
          {
            "identity": "rim",
            "map": "n/a"
          },
          {
            "identity": "OMOP-CDM-v5.3.1",
            "map": "Person.year_of_birth"
          }
        ]
      }
    ]
  },
  "differential": {
    "element": [
      {
        "id": "OMOPPerson",
        "path": "OMOPPerson",
        "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.",
        "min": 0,
        "max": "*",
        "type": [
          {
            "code": "Element"
          }
        ],
        "mapping": [
          {
            "identity": "OMOP-CDM-v5.3.1",
            "map": "Person"
          }
        ]
      },
      {
        "id": "OMOPPerson.person_id",
        "path": "OMOPPerson.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.\r\n\r\nAny person linkage that needs to occur to uniquely identify Persons ought to be done prior to writing this table. This identifier can be the original id from the source data provided if it is an integer, otherwise it can be an autogenerated number.",
        "min": 1,
        "max": "1",
        "type": [
          {
            "code": "integer",
            "profile": [
              "http://hl7.org/fhir/StructureDefinition/integer"
            ]
          }
        ],
        "mapping": [
          {
            "identity": "OMOP-CDM-v5.3.1",
            "map": "Person.person_id"
          }
        ]
      },
      {
        "id": "OMOPPerson.gender_concept_id",
        "path": "OMOPPerson.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.",
        "min": 1,
        "max": "1",
        "type": [
          {
            "code": "CodeableConcept",
            "profile": [
              "http://hl7.org/fhir/StructureDefinition/CodeableConcept"
            ]
          }
        ],
        "binding": {
          "strength": "required",
          "valueSet": "https://fhir.ohdsi.org/ValueSet/OMOPGender"
        },
        "mapping": [
          {
            "identity": "OMOP-CDM-v5.3.1",
            "map": "Person.gender_concept_id"
          }
        ]
      },
      {
        "id": "OMOPPerson.year_of_birth",
        "path": "OMOPPerson.year_of_birth",
        "definition": "Compute age using year_of_birth.\r\n\r\nFor data sources with date of birth, the year should be extracted. For data sources where the year of birth is not available, the approximate year of birth could be derived based on age group categorization, if available.",
        "min": 1,
        "max": "1",
        "type": [
          {
            "code": "integer",
            "profile": [
              "http://hl7.org/fhir/StructureDefinition/integer"
            ]
          }
        ],
        "mapping": [
          {
            "identity": "OMOP-CDM-v5.3.1",
            "map": "Person.year_of_birth"
          }
        ]
      }
    ]
  }
}