Data Management with FHIR
0.1.0 - ci-build

Data Management with FHIR - Local Development build (v0.1.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

## Logical Model: OMOPObservationPeriod - JSON Profile

Draft as of 2025-10-23

JSON representation of the OMOPObservationPeriod logical model.

Raw json | Download

    {
      "resourceType" : "StructureDefinition",
      "id" : "OMOPObservationPeriod",
      "text" : {
        "status" : "extensions",
        "div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p class=\"res-header-id\"><b>Narratif généré : DéfinitionStructure OMOPObservationPeriod</b></p><table border=\"0\" cellpadding=\"0\" cellspacing=\"0\" style=\"border: 0px #F0F0F0 solid; font-size: 11px; font-family: verdana; vertical-align: top;\"><tr style=\"border: 1px #F0F0F0 solid; font-size: 11px; font-family: verdana; vertical-align: top\"><th style=\"vertical-align: top; text-align : var(--ig-left,left); background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; padding-top: 3px; padding-bottom: 3px\" class=\"hierarchy\"><a href=\"https://build.fhir.org/ig/FHIR/ig-guidance/readingIgs.html#table-views\" title=\"Le nom logique de lélément\">Nom</a></th><th style=\"vertical-align: top; text-align : var(--ig-left,left); background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; padding-top: 3px; padding-bottom: 3px\" class=\"hierarchy\"><a href=\"https://build.fhir.org/ig/FHIR/ig-guidance/readingIgs.html#table-views\" title=\"Information about the use of the element\">Drapeaux</a></th><th style=\"vertical-align: top; text-align : var(--ig-left,left); background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; padding-top: 3px; padding-bottom: 3px\" class=\"hierarchy\"><a href=\"https://build.fhir.org/ig/FHIR/ig-guidance/readingIgs.html#table-views\" title=\"Minimum and Maximum # of times the element can appear in the instance\">Card.</a></th><th style=\"vertical-align: top; text-align : var(--ig-left,left); background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; padding-top: 3px; padding-bottom: 3px; width: 100px\" class=\"hierarchy\"><a href=\"https://build.fhir.org/ig/FHIR/ig-guidance/readingIgs.html#table-views\" title=\"Reference to the type of the element\">Type</a></th><th style=\"vertical-align: top; text-align : var(--ig-left,left); background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; padding-top: 3px; padding-bottom: 3px\" class=\"hierarchy\"><a href=\"https://build.fhir.org/ig/FHIR/ig-guidance/readingIgs.html#table-views\" title=\"Additional information about the element\">Description et contraintes</a><span style=\"float: right\"><a href=\"https://build.fhir.org/ig/FHIR/ig-guidance/readingIgs.html#table-views\" title=\"Legend for this format\"><img src=\"data:image/png;base64, \" alt=\"doco\" style=\"background-color: inherit\"/></a></span></th></tr><tr style=\"border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color: white\"><td style=\"vertical-align: top; text-align : var(--ig-left,left); background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(tbl_bck1.png)\" class=\"hierarchy\"><img src=\"tbl_spacer.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"icon_element.gif\" alt=\".\" style=\"background-color: white; background-color: inherit\" title=\"Element\" class=\"hierarchy\"/> <a href=\"StructureDefinition-OMOPObservationPeriod-definitions.html#OMOPObservationPeriod\" title=\"This table contains records which define spans of time during which two conditions are expected to hold: (i) Clinical Events that happened to the Person are recorded in the Event tables, and (ii) absense of records indicate such Events did not occur during this span of time.\">OMOPObservationPeriod</a><a name=\"OMOPObservationPeriod\"> </a></td><td style=\"vertical-align: top; text-align : var(--ig-left,left); background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"/><td style=\"vertical-align: top; text-align : var(--ig-left,left); background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"><span style=\"opacity: 0.5\">0</span><span style=\"opacity: 0.5\">..</span><span style=\"opacity: 0.5\">*</span></td><td style=\"vertical-align: top; text-align : var(--ig-left,left); background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"><a href=\"http://build.fhir.org/types.html#Base\">Base</a></td><td style=\"vertical-align: top; text-align : var(--ig-left,left); background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\">Observation Period OMOP Table<br/><span style=\"font-weight:bold\">Instances of this logical model can be the target of a Reference</span></td></tr>\r\n<tr style=\"border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color: #F7F7F7\"><td style=\"vertical-align: top; text-align : var(--ig-left,left); background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(tbl_bck10.png)\" class=\"hierarchy\"><img src=\"tbl_spacer.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"tbl_vjoin.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"icon_primitive.png\" alt=\".\" style=\"background-color: #F7F7F7; background-color: inherit\" title=\"Type de donnée primitif\" class=\"hierarchy\"/> <a href=\"StructureDefinition-OMOPObservationPeriod-definitions.html#OMOPObservationPeriod.observation-period-id\" title=\"A Person can have multiple discrete Observation Periods which are identified by the Observation_Period_Id.\">observation_period_id</a><a name=\"OMOPObservationPeriod.observation_period_id\"> </a></td><td style=\"vertical-align: top; text-align : var(--ig-left,left); background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"/><td style=\"vertical-align: top; text-align : var(--ig-left,left); background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\">1..1</td><td style=\"vertical-align: top; text-align : var(--ig-left,left); background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"><a href=\"http://hl7.org/fhir/R4/datatypes.html#integer\">integer</a></td><td style=\"vertical-align: top; text-align : var(--ig-left,left); background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\">Observation Period Identifier</td></tr>\r\n<tr style=\"border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color: white\"><td style=\"vertical-align: top; text-align : var(--ig-left,left); background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(tbl_bck10.png)\" class=\"hierarchy\"><img src=\"tbl_spacer.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"tbl_vjoin.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"icon_reference.png\" alt=\".\" style=\"background-color: white; background-color: inherit\" title=\"Reference to another Resource\" class=\"hierarchy\"/> <a href=\"StructureDefinition-OMOPObservationPeriod-definitions.html#OMOPObservationPeriod.person-id\" title=\"The Person ID of the PERSON record for which the Observation Period is recorded.\">person_id</a><a name=\"OMOPObservationPeriod.person_id\"> </a></td><td style=\"vertical-align: top; text-align : var(--ig-left,left); background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"/><td style=\"vertical-align: top; text-align : var(--ig-left,left); background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\">1..1</td><td style=\"vertical-align: top; text-align : var(--ig-left,left); background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"><a href=\"http://hl7.org/fhir/R4/references.html\">Reference</a>(<a href=\"StructureDefinition-OMOPPerson.html\">Person OMOP Table</a>)</td><td style=\"vertical-align: top; text-align : var(--ig-left,left); background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\">Person</td></tr>\r\n<tr style=\"border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color: #F7F7F7\"><td style=\"vertical-align: top; text-align : var(--ig-left,left); background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(tbl_bck10.png)\" class=\"hierarchy\"><img src=\"tbl_spacer.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"tbl_vjoin.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"icon_primitive.png\" alt=\".\" style=\"background-color: #F7F7F7; background-color: inherit\" title=\"Type de donnée primitif\" class=\"hierarchy\"/> <a href=\"StructureDefinition-OMOPObservationPeriod-definitions.html#OMOPObservationPeriod.observation-period-start-date\" title=\"Use this date to determine the start date of the Observation Period.\">observation_period_start_date</a><a name=\"OMOPObservationPeriod.observation_period_start_date\"> </a></td><td style=\"vertical-align: top; text-align : var(--ig-left,left); background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"/><td style=\"vertical-align: top; text-align : var(--ig-left,left); background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\">1..1</td><td style=\"vertical-align: top; text-align : var(--ig-left,left); background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"><a href=\"http://hl7.org/fhir/R4/datatypes.html#date\">date</a></td><td style=\"vertical-align: top; text-align : var(--ig-left,left); background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\">Start Date</td></tr>\r\n<tr style=\"border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color: white\"><td style=\"vertical-align: top; text-align : var(--ig-left,left); background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(tbl_bck10.png)\" class=\"hierarchy\"><img src=\"tbl_spacer.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"tbl_vjoin.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"icon_primitive.png\" alt=\".\" style=\"background-color: white; background-color: inherit\" title=\"Type de donnée primitif\" class=\"hierarchy\"/> <a href=\"StructureDefinition-OMOPObservationPeriod-definitions.html#OMOPObservationPeriod.observation-period-end-date\" title=\"Use this date to determine the end date of the period for which we can assume that all events for a Person are recorded.\">observation_period_end_date</a><a name=\"OMOPObservationPeriod.observation_period_end_date\"> </a></td><td style=\"vertical-align: top; text-align : var(--ig-left,left); background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"/><td style=\"vertical-align: top; text-align : var(--ig-left,left); background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\">1..1</td><td style=\"vertical-align: top; text-align : var(--ig-left,left); background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"><a href=\"http://hl7.org/fhir/R4/datatypes.html#date\">date</a></td><td style=\"vertical-align: top; text-align : var(--ig-left,left); background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\">End Date</td></tr>\r\n<tr style=\"border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color: #F7F7F7\"><td style=\"vertical-align: top; text-align : var(--ig-left,left); background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(tbl_bck00.png)\" class=\"hierarchy\"><img src=\"tbl_spacer.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"tbl_vjoin_end.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"icon_reference.png\" alt=\".\" style=\"background-color: #F7F7F7; background-color: inherit\" title=\"Reference to another Resource\" class=\"hierarchy\"/> <a href=\"StructureDefinition-OMOPObservationPeriod-definitions.html#OMOPObservationPeriod.period-type-concept-id\" title=\"This field can be used to determine the provenance of the Observation Period as in whether the period was determined from an insurance enrollment file, EHR healthcare encounters, or other sources.\">period_type_concept_id</a><a name=\"OMOPObservationPeriod.period_type_concept_id\"> </a></td><td style=\"vertical-align: top; text-align : var(--ig-left,left); background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"/><td style=\"vertical-align: top; text-align : var(--ig-left,left); background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\">1..1</td><td style=\"vertical-align: top; text-align : var(--ig-left,left); background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"><a href=\"http://hl7.org/fhir/R4/references.html\">Reference</a>(<a href=\"StructureDefinition-OMOPConcept.html\">Concept OMOP Table</a>)</td><td style=\"vertical-align: top; text-align : var(--ig-left,left); background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\">Period Type</td></tr>\r\n<tr><td colspan=\"5\" class=\"hierarchy\"><br/><a href=\"https://build.fhir.org/ig/FHIR/ig-guidance/readingIgs.html#table-views\" title=\"Legend for this format\"><img src=\"data:image/png;base64, \" alt=\"doco\" style=\"background-color: inherit\"/> Documentation for this format</a></td></tr></table></div>"
      },
      "extension" : [
        {
          "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-type-characteristics",
          "valueCode" : "can-be-target"
        }
      ],
      "url" : "https://interop.aphp.fr/ig/fhir/dm/StructureDefinition/OMOPObservationPeriod",
      "version" : "0.1.0",
      "name" : "OMOPObservationPeriod",
      "title" : "Observation Period OMOP Table",
      "status" : "draft",
      "date" : "2025-10-23T20:49:03+00:00",
      "publisher" : "AP-HP",
      "contact" : [
        {
          "name" : "AP-HP",
          "telecom" : [
            {
              "system" : "url",
              "value" : "https://aphp.fr"
            }
          ]
        }
      ],
      "description" : "This table contains records which define spans of time during which two conditions are expected to hold: (i) Clinical Events that happened to the Person are recorded in the Event tables, and (ii) absense of records indicate such Events did not occur during this span of time.",
      "jurisdiction" : [
        {
          "coding" : [
            {
              "system" : "urn:iso:std:iso:3166",
              "code" : "FR",
              "display" : "France"
            }
          ]
        }
      ],
      "fhirVersion" : "4.0.1",
      "kind" : "logical",
      "abstract" : false,
      "type" : "https://interop.aphp.fr/ig/fhir/dm/StructureDefinition/OMOPObservationPeriod",
      "baseDefinition" : "http://hl7.org/fhir/StructureDefinition/Base",
      "derivation" : "specialization",
      "snapshot" : {
        "extension" : [
          {
            "url" : "http://hl7.org/fhir/tools/StructureDefinition/snapshot-base-version",
            "valueString" : "4.0.1"
          }
        ],
        "element" : [
          {
            "id" : "OMOPObservationPeriod",
            "path" : "OMOPObservationPeriod",
            "short" : "Observation Period OMOP Table",
            "definition" : "This table contains records which define spans of time during which two conditions are expected to hold: (i) Clinical Events that happened to the Person are recorded in the Event tables, and (ii) absense of records indicate such Events did not occur during this span of time.",
            "min" : 0,
            "max" : "*",
            "base" : {
              "path" : "Base",
              "min" : 0,
              "max" : "*"
            },
            "isModifier" : false
          },
          {
            "id" : "OMOPObservationPeriod.observation-period-id",
            "path" : "OMOPObservationPeriod.observation_period_id",
            "short" : "Observation Period Identifier",
            "definition" : "A Person can have multiple discrete Observation Periods which are identified by the Observation_Period_Id.",
            "min" : 1,
            "max" : "1",
            "base" : {
              "path" : "OMOPObservationPeriod.observation_period_id",
              "min" : 1,
              "max" : "1"
            },
            "type" : [
              {
                "code" : "integer"
              }
            ]
          },
          {
            "id" : "OMOPObservationPeriod.person-id",
            "path" : "OMOPObservationPeriod.person_id",
            "short" : "Person",
            "definition" : "The Person ID of the PERSON record for which the Observation Period is recorded.",
            "min" : 1,
            "max" : "1",
            "base" : {
              "path" : "OMOPObservationPeriod.person_id",
              "min" : 1,
              "max" : "1"
            },
            "type" : [
              {
                "code" : "Reference",
                "targetProfile" : [
                  🔗 "https://interop.aphp.fr/ig/fhir/dm/StructureDefinition/OMOPPerson"
                ]
              }
            ]
          },
          {
            "id" : "OMOPObservationPeriod.observation-period-start-date",
            "path" : "OMOPObservationPeriod.observation_period_start_date",
            "short" : "Start Date",
            "definition" : "Use this date to determine the start date of the Observation Period.",
            "min" : 1,
            "max" : "1",
            "base" : {
              "path" : "OMOPObservationPeriod.observation_period_start_date",
              "min" : 1,
              "max" : "1"
            },
            "type" : [
              {
                "code" : "date"
              }
            ]
          },
          {
            "id" : "OMOPObservationPeriod.observation-period-end-date",
            "path" : "OMOPObservationPeriod.observation_period_end_date",
            "short" : "End Date",
            "definition" : "Use this date to determine the end date of the period for which we can assume that all events for a Person are recorded.",
            "min" : 1,
            "max" : "1",
            "base" : {
              "path" : "OMOPObservationPeriod.observation_period_end_date",
              "min" : 1,
              "max" : "1"
            },
            "type" : [
              {
                "code" : "date"
              }
            ]
          },
          {
            "id" : "OMOPObservationPeriod.period-type-concept-id",
            "path" : "OMOPObservationPeriod.period_type_concept_id",
            "short" : "Period Type",
            "definition" : "This field can be used to determine the provenance of the Observation Period as in whether the period was determined from an insurance enrollment file, EHR healthcare encounters, or other sources.",
            "min" : 1,
            "max" : "1",
            "base" : {
              "path" : "OMOPObservationPeriod.period_type_concept_id",
              "min" : 1,
              "max" : "1"
            },
            "type" : [
              {
                "code" : "Reference",
                "targetProfile" : [
                  🔗 "https://interop.aphp.fr/ig/fhir/dm/StructureDefinition/OMOPConcept"
                ]
              }
            ]
          }
        ]
      },
      "differential" : {
        "element" : [
          {
            "id" : "OMOPObservationPeriod",
            "path" : "OMOPObservationPeriod",
            "short" : "Observation Period OMOP Table",
            "definition" : "This table contains records which define spans of time during which two conditions are expected to hold: (i) Clinical Events that happened to the Person are recorded in the Event tables, and (ii) absense of records indicate such Events did not occur during this span of time."
          },
          {
            "id" : "OMOPObservationPeriod.observation-period-id",
            "path" : "OMOPObservationPeriod.observation_period_id",
            "short" : "Observation Period Identifier",
            "definition" : "A Person can have multiple discrete Observation Periods which are identified by the Observation_Period_Id.",
            "min" : 1,
            "max" : "1",
            "type" : [
              {
                "code" : "integer"
              }
            ]
          },
          {
            "id" : "OMOPObservationPeriod.person-id",
            "path" : "OMOPObservationPeriod.person_id",
            "short" : "Person",
            "definition" : "The Person ID of the PERSON record for which the Observation Period is recorded.",
            "min" : 1,
            "max" : "1",
            "type" : [
              {
                "code" : "Reference",
                "targetProfile" : [
                  🔗 "https://interop.aphp.fr/ig/fhir/dm/StructureDefinition/OMOPPerson"
                ]
              }
            ]
          },
          {
            "id" : "OMOPObservationPeriod.observation-period-start-date",
            "path" : "OMOPObservationPeriod.observation_period_start_date",
            "short" : "Start Date",
            "definition" : "Use this date to determine the start date of the Observation Period.",
            "min" : 1,
            "max" : "1",
            "type" : [
              {
                "code" : "date"
              }
            ]
          },
          {
            "id" : "OMOPObservationPeriod.observation-period-end-date",
            "path" : "OMOPObservationPeriod.observation_period_end_date",
            "short" : "End Date",
            "definition" : "Use this date to determine the end date of the period for which we can assume that all events for a Person are recorded.",
            "min" : 1,
            "max" : "1",
            "type" : [
              {
                "code" : "date"
              }
            ]
          },
          {
            "id" : "OMOPObservationPeriod.period-type-concept-id",
            "path" : "OMOPObservationPeriod.period_type_concept_id",
            "short" : "Period Type",
            "definition" : "This field can be used to determine the provenance of the Observation Period as in whether the period was determined from an insurance enrollment file, EHR healthcare encounters, or other sources.",
            "min" : 1,
            "max" : "1",
            "type" : [
              {
                "code" : "Reference",
                "targetProfile" : [
                  🔗 "https://interop.aphp.fr/ig/fhir/dm/StructureDefinition/OMOPConcept"
                ]
              }
            ]
          }
        ]
      }
    }