PackagesCanonicalsLogsProblems
    Packages
    hl7.fhir.uv.omop@1.0.0-ballot
    http://hl7.org/fhir/uv/omop/StructureDefinition/Episode
{
  "description": "The EPISODE table aggregates lower-level clinical events (VISIT_OCCURRENCE, DRUG_EXPOSURE, PROCEDURE_OCCURRENCE, DEVICE_EXPOSURE) into a higher-level abstraction representing clinically and analytically relevant disease phases,outcomes and treatments. The EPISODE_EVENT table connects qualifying clinical events (VISIT_OCCURRENCE, DRUG_EXPOSURE, PROCEDURE_OCCURRENCE, DEVICE_EXPOSURE) to the appropriate EPISODE entry. For example cancers including their development over time, their treatment, and final resolution.",
  "_filename": "StructureDefinition-Episode.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": "Episode",
  "mapping": [ {
    "uri": "http://hl7.org/v3",
    "name": "RIM Mapping",
    "identity": "rim"
  } ],
  "abstract": false,
  "type": "http://hl7.org/fhir/uv/omop/StructureDefinition/Episode",
  "experimental": null,
  "resourceType": "StructureDefinition",
  "title": "Episode 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": "Episode",
      "min": 0,
      "definition": "The EPISODE table aggregates lower-level clinical events (VISIT_OCCURRENCE, DRUG_EXPOSURE, PROCEDURE_OCCURRENCE, DEVICE_EXPOSURE) into a higher-level abstraction representing clinically and analytically relevant disease phases,outcomes and treatments. The EPISODE_EVENT table connects qualifying clinical events (VISIT_OCCURRENCE, DRUG_EXPOSURE, PROCEDURE_OCCURRENCE, DEVICE_EXPOSURE) to the appropriate EPISODE entry. For example cancers including their development over time, their treatment, and final resolution.",
      "isModifier": false,
      "short": "Episode OMOP Table",
      "mapping": [ {
        "map": "n/a",
        "identity": "rim"
      } ],
      "max": "*",
      "id": "Episode",
      "base": {
        "max": "*",
        "min": 0,
        "path": "Base"
      }
    }, {
      "id": "Episode.episode-id",
      "max": "1",
      "min": 1,
      "base": {
        "max": "1",
        "min": 1,
        "path": "Episode.episode_id"
      },
      "path": "Episode.episode_id",
      "type": [ {
        "code": "code"
      } ],
      "short": "Episode Identifier",
      "definition": "Episode Identifier"
    }, {
      "id": "Episode.person-id",
      "max": "1",
      "min": 1,
      "base": {
        "max": "1",
        "min": 1,
        "path": "Episode.person_id"
      },
      "path": "Episode.person_id",
      "type": [ {
        "code": "Reference",
        "targetProfile": [ "http://hl7.org/fhir/uv/omop/StructureDefinition/Person" ]
      } ],
      "short": "Person",
      "definition": "The PERSON_ID of the PERSON for whom the episode is recorded."
    }, {
      "id": "Episode.episode-concept-id",
      "max": "1",
      "min": 1,
      "base": {
        "max": "1",
        "min": 1,
        "path": "Episode.episode_concept_id"
      },
      "path": "Episode.episode_concept_id",
      "type": [ {
        "code": "code"
      } ],
      "short": "Episode",
      "definition": "The EPISODE_CONCEPT_ID represents the kind abstraction related to the disease phase, outcome or treatment."
    }, {
      "id": "Episode.episode-start-date",
      "max": "1",
      "min": 1,
      "base": {
        "max": "1",
        "min": 1,
        "path": "Episode.episode_start_date"
      },
      "path": "Episode.episode_start_date",
      "type": [ {
        "code": "date"
      } ],
      "short": "Episode Start Date",
      "definition": "The date when the Episode beings."
    }, {
      "id": "Episode.episode-start-datetime",
      "max": "1",
      "min": 0,
      "base": {
        "max": "1",
        "min": 0,
        "path": "Episode.episode_start_datetime"
      },
      "path": "Episode.episode_start_datetime",
      "type": [ {
        "code": "dateTime"
      } ],
      "short": "Episode Start Datetime",
      "definition": "The date and time when the Episode beings."
    }, {
      "id": "Episode.episode-end-date",
      "max": "1",
      "min": 0,
      "base": {
        "max": "1",
        "min": 0,
        "path": "Episode.episode_end_date"
      },
      "path": "Episode.episode_end_date",
      "type": [ {
        "code": "date"
      } ],
      "short": "Episode End Date",
      "definition": "The date when the instance of the Episode is considered to have ended."
    }, {
      "id": "Episode.episode-end-datetime",
      "max": "1",
      "min": 0,
      "base": {
        "max": "1",
        "min": 0,
        "path": "Episode.episode_end_datetime"
      },
      "path": "Episode.episode_end_datetime",
      "type": [ {
        "code": "dateTime"
      } ],
      "short": "Epsisode End Datetime",
      "definition": "The date when the instance of the Episode is considered to have ended."
    }, {
      "id": "Episode.episode-parent-id",
      "max": "1",
      "min": 0,
      "base": {
        "max": "1",
        "min": 0,
        "path": "Episode.episode_parent_id"
      },
      "path": "Episode.episode_parent_id",
      "type": [ {
        "code": "Reference",
        "targetProfile": [ "http://hl7.org/fhir/uv/omop/StructureDefinition/Episode" ]
      } ],
      "short": "Episode Parent",
      "definition": "Use this field to find the Episode that subsumes the given Episode record. This is used in the case that an Episode are nested into each other."
    }, {
      "id": "Episode.episode-number",
      "max": "1",
      "min": 0,
      "base": {
        "max": "1",
        "min": 0,
        "path": "Episode.episode_number"
      },
      "path": "Episode.episode_number",
      "type": [ {
        "code": "integer"
      } ],
      "short": "Episode Number",
      "definition": "For sequences of episodes, this is used to indicate the order the episodes occurred. For example, lines of treatment could be indicated here."
    }, {
      "id": "Episode.episode-object-concept-id",
      "max": "1",
      "min": 1,
      "base": {
        "max": "1",
        "min": 1,
        "path": "Episode.episode_object_concept_id"
      },
      "path": "Episode.episode_object_concept_id",
      "type": [ {
        "code": "code"
      } ],
      "short": "Episode Object",
      "definition": "A Standard Concept representing the disease phase, outcome, or other abstraction of which the episode consists.  For example, if the EPISODE_CONCEPT_ID is [treatment regimen](https://athena.ohdsi.org/search-terms/terms/32531) then the EPISODE_OBJECT_CONCEPT_ID should contain the chemotherapy regimen concept, like [Afatinib monotherapy](https://athena.ohdsi.org/search-terms/terms/35804392)."
    }, {
      "id": "Episode.episode-type-concept-id",
      "max": "1",
      "min": 1,
      "base": {
        "max": "1",
        "min": 1,
        "path": "Episode.episode_type_concept_id"
      },
      "path": "Episode.episode_type_concept_id",
      "type": [ {
        "code": "code"
      } ],
      "short": "Episode Type",
      "definition": "This field can be used to determine the provenance of the Episode record, as in whether the episode was from an EHR system, insurance claim, registry, or other sources."
    }, {
      "id": "Episode.episode-source-value",
      "max": "1",
      "min": 0,
      "base": {
        "max": "1",
        "min": 0,
        "path": "Episode.episode_source_value"
      },
      "path": "Episode.episode_source_value",
      "type": [ {
        "code": "string"
      } ],
      "short": "Episode Source Value",
      "definition": "The source code for the Episdoe as it appears in the source data. This code is mapped to a Standard Condition Concept in the Standardized Vocabularies and the original code is stored here for reference."
    }, {
      "id": "Episode.episode-source-concept-id",
      "max": "1",
      "min": 0,
      "base": {
        "max": "1",
        "min": 0,
        "path": "Episode.episode_source_concept_id"
      },
      "path": "Episode.episode_source_concept_id",
      "type": [ {
        "code": "code"
      } ],
      "short": "Episode Source",
      "definition": "A foreign key to a Episode Concept that refers to the code used in the source."
    } ],
    "extension": [ {
      "url": "http://hl7.org/fhir/tools/StructureDefinition/snapshot-base-version",
      "valueString": "5.0.0"
    } ]
  },
  "status": "active",
  "id": "5ddf5231-a289-4641-8255-688f2896e55c",
  "kind": "logical",
  "url": "http://hl7.org/fhir/uv/omop/StructureDefinition/Episode",
  "version": "1.0.0-ballot",
  "differential": {
    "element": [ {
      "id": "Episode",
      "path": "Episode",
      "short": "Episode OMOP Table",
      "definition": "The EPISODE table aggregates lower-level clinical events (VISIT_OCCURRENCE, DRUG_EXPOSURE, PROCEDURE_OCCURRENCE, DEVICE_EXPOSURE) into a higher-level abstraction representing clinically and analytically relevant disease phases,outcomes and treatments. The EPISODE_EVENT table connects qualifying clinical events (VISIT_OCCURRENCE, DRUG_EXPOSURE, PROCEDURE_OCCURRENCE, DEVICE_EXPOSURE) to the appropriate EPISODE entry. For example cancers including their development over time, their treatment, and final resolution."
    }, {
      "id": "Episode.episode-id",
      "max": "1",
      "min": 1,
      "path": "Episode.episode_id",
      "type": [ {
        "code": "code"
      } ],
      "short": "Episode Identifier",
      "definition": "Episode Identifier"
    }, {
      "id": "Episode.person-id",
      "max": "1",
      "min": 1,
      "path": "Episode.person_id",
      "type": [ {
        "code": "Reference",
        "targetProfile": [ "http://hl7.org/fhir/uv/omop/StructureDefinition/Person" ]
      } ],
      "short": "Person",
      "definition": "The PERSON_ID of the PERSON for whom the episode is recorded."
    }, {
      "id": "Episode.episode-concept-id",
      "max": "1",
      "min": 1,
      "path": "Episode.episode_concept_id",
      "type": [ {
        "code": "code"
      } ],
      "short": "Episode",
      "definition": "The EPISODE_CONCEPT_ID represents the kind abstraction related to the disease phase, outcome or treatment."
    }, {
      "id": "Episode.episode-start-date",
      "max": "1",
      "min": 1,
      "path": "Episode.episode_start_date",
      "type": [ {
        "code": "date"
      } ],
      "short": "Episode Start Date",
      "definition": "The date when the Episode beings."
    }, {
      "id": "Episode.episode-start-datetime",
      "max": "1",
      "min": 0,
      "path": "Episode.episode_start_datetime",
      "type": [ {
        "code": "dateTime"
      } ],
      "short": "Episode Start Datetime",
      "definition": "The date and time when the Episode beings."
    }, {
      "id": "Episode.episode-end-date",
      "max": "1",
      "min": 0,
      "path": "Episode.episode_end_date",
      "type": [ {
        "code": "date"
      } ],
      "short": "Episode End Date",
      "definition": "The date when the instance of the Episode is considered to have ended."
    }, {
      "id": "Episode.episode-end-datetime",
      "max": "1",
      "min": 0,
      "path": "Episode.episode_end_datetime",
      "type": [ {
        "code": "dateTime"
      } ],
      "short": "Epsisode End Datetime",
      "definition": "The date when the instance of the Episode is considered to have ended."
    }, {
      "id": "Episode.episode-parent-id",
      "max": "1",
      "min": 0,
      "path": "Episode.episode_parent_id",
      "type": [ {
        "code": "Reference",
        "targetProfile": [ "http://hl7.org/fhir/uv/omop/StructureDefinition/Episode" ]
      } ],
      "short": "Episode Parent",
      "definition": "Use this field to find the Episode that subsumes the given Episode record. This is used in the case that an Episode are nested into each other."
    }, {
      "id": "Episode.episode-number",
      "max": "1",
      "min": 0,
      "path": "Episode.episode_number",
      "type": [ {
        "code": "integer"
      } ],
      "short": "Episode Number",
      "definition": "For sequences of episodes, this is used to indicate the order the episodes occurred. For example, lines of treatment could be indicated here."
    }, {
      "id": "Episode.episode-object-concept-id",
      "max": "1",
      "min": 1,
      "path": "Episode.episode_object_concept_id",
      "type": [ {
        "code": "code"
      } ],
      "short": "Episode Object",
      "definition": "A Standard Concept representing the disease phase, outcome, or other abstraction of which the episode consists.  For example, if the EPISODE_CONCEPT_ID is [treatment regimen](https://athena.ohdsi.org/search-terms/terms/32531) then the EPISODE_OBJECT_CONCEPT_ID should contain the chemotherapy regimen concept, like [Afatinib monotherapy](https://athena.ohdsi.org/search-terms/terms/35804392)."
    }, {
      "id": "Episode.episode-type-concept-id",
      "max": "1",
      "min": 1,
      "path": "Episode.episode_type_concept_id",
      "type": [ {
        "code": "code"
      } ],
      "short": "Episode Type",
      "definition": "This field can be used to determine the provenance of the Episode record, as in whether the episode was from an EHR system, insurance claim, registry, or other sources."
    }, {
      "id": "Episode.episode-source-value",
      "max": "1",
      "min": 0,
      "path": "Episode.episode_source_value",
      "type": [ {
        "code": "string"
      } ],
      "short": "Episode Source Value",
      "definition": "The source code for the Episdoe as it appears in the source data. This code is mapped to a Standard Condition Concept in the Standardized Vocabularies and the original code is stored here for reference."
    }, {
      "id": "Episode.episode-source-concept-id",
      "max": "1",
      "min": 0,
      "path": "Episode.episode_source_concept_id",
      "type": [ {
        "code": "code"
      } ],
      "short": "Episode Source",
      "definition": "A foreign key to a Episode Concept that refers to the code used in the source."
    } ]
  },
  "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"
}