FHIR © HL7.org  |  Server Home  |  XIG Home  |  Server Source  |  FHIR  

FHIR IG Statistics: StructureDefinition/Episode

Packagehl7.fhir.uv.omop
TypeStructureDefinition
IdEpisode
FHIR VersionR5
Sourcehttp://hl7.org/fhir/uv/omop/https://build.fhir.org/ig/HL7/fhir-omop-ig/StructureDefinition-Episode.html
URLhttp://hl7.org/fhir/uv/omop/StructureDefinition/Episode
Version1.0.0-ballot
Statusactive
Date2025-07-22T19:48:02+00:00
NameEpisode
TitleEpisode OMOP Table
Realmuv
Authorityhl7
DescriptionThe 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.
Typehttp://hl7.org/fhir/uv/omop/StructureDefinition/Episode
Kindlogical

Resources that use this resource

StructureDefinition
EpisodeEpisode OMOP Table
EpisodeEventEpisode Event OMOP Table

Resources that this resource uses

StructureDefinition
EpisodeEpisode OMOP Table
PersonPerson OMOP Table

Narrative

Note: links and images are rebased to the (stated) source

Generated Narrative: StructureDefinition Episode

NameFlagsCard.TypeDescription & Constraintsdoco
.. Episode 0..*BaseEpisode OMOP Table
Instances of this logical model can be the target of a Reference
... episode_id 1..1codeEpisode Identifier
... person_id 1..1Reference(Person OMOP Table)Person
... episode_concept_id 1..1codeEpisode
... episode_start_date 1..1dateEpisode Start Date
... episode_start_datetime 0..1dateTimeEpisode Start Datetime
... episode_end_date 0..1dateEpisode End Date
... episode_end_datetime 0..1dateTimeEpsisode End Datetime
... episode_parent_id 0..1Reference(Episode OMOP Table)Episode Parent
... episode_number 0..1integerEpisode Number
... episode_object_concept_id 1..1codeEpisode Object
... episode_type_concept_id 1..1codeEpisode Type
... episode_source_value 0..1stringEpisode Source Value
... episode_source_concept_id 0..1codeEpisode Source

doco Documentation for this format

Source

{
  "resourceType": "StructureDefinition",
  "id": "Episode",
  "text": {
    "status": "extensions",
    "div": "<!-- snip (see above) -->"
  },
  "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"
          }
        ]
      }
    }
  ],
  "url": "http://hl7.org/fhir/uv/omop/StructureDefinition/Episode",
  "version": "1.0.0-ballot",
  "name": "Episode",
  "title": "Episode OMOP Table",
  "status": "active",
  "date": "2025-07-22T19:48:02+00:00",
  "publisher": "HL7 International / Biomedical Research and Regulation",
  "contact": [
    {
      "name": "HL7 International / Biomedical Research and Regulation",
      "telecom": [
        {
          "system": "url",
          "value": "http://www.hl7.org/Special/committees/rcrim"
        }
      ]
    }
  ],
  "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.",
  "jurisdiction": [
    {
      "coding": [
        {
          "system": "http://unstats.un.org/unsd/methods/m49/m49.htm",
          "code": "001",
          "display": "World"
        }
      ]
    }
  ],
  "fhirVersion": "5.0.0",
  "mapping": [
    {
      "identity": "rim",
      "uri": "http://hl7.org/v3",
      "name": "RIM Mapping"
    }
  ],
  "kind": "logical",
  "abstract": false,
  "type": "http://hl7.org/fhir/uv/omop/StructureDefinition/Episode",
  "baseDefinition": "http://hl7.org/fhir/StructureDefinition/Base",
  "derivation": "specialization",
  "snapshot": {
    "extension": [
      {
        "url": "http://hl7.org/fhir/tools/StructureDefinition/snapshot-base-version",
        "valueString": "5.0.0"
      }
    ],
    "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.",
        "min": 0,
        "max": "*",
        "base": {
          "path": "Base",
          "min": 0,
          "max": "*"
        },
        "isModifier": false,
        "mapping": [
          {
            "identity": "rim",
            "map": "n/a"
          }
        ]
      },
      {
        "id": "Episode.episode-id",
        "path": "Episode.episode_id",
        "short": "Episode Identifier",
        "definition": "Episode Identifier",
        "min": 1,
        "max": "1",
        "base": {
          "path": "Episode.episode_id",
          "min": 1,
          "max": "1"
        },
        "type": [
          {
            "code": "code"
          }
        ]
      },
      {
        "id": "Episode.person-id",
        "path": "Episode.person_id",
        "short": "Person",
        "definition": "The PERSON_ID of the PERSON for whom the episode is recorded.",
        "min": 1,
        "max": "1",
        "base": {
          "path": "Episode.person_id",
          "min": 1,
          "max": "1"
        },
        "type": [
          {
            "code": "Reference",
            "targetProfile": [
              "http://hl7.org/fhir/uv/omop/StructureDefinition/Person"
            ]
          }
        ]
      },
      {
        "id": "Episode.episode-concept-id",
        "path": "Episode.episode_concept_id",
        "short": "Episode",
        "definition": "The EPISODE_CONCEPT_ID represents the kind abstraction related to the disease phase, outcome or treatment.",
        "min": 1,
        "max": "1",
        "base": {
          "path": "Episode.episode_concept_id",
          "min": 1,
          "max": "1"
        },
        "type": [
          {
            "code": "code"
          }
        ]
      },
      {
        "id": "Episode.episode-start-date",
        "path": "Episode.episode_start_date",
        "short": "Episode Start Date",
        "definition": "The date when the Episode beings.",
        "min": 1,
        "max": "1",
        "base": {
          "path": "Episode.episode_start_date",
          "min": 1,
          "max": "1"
        },
        "type": [
          {
            "code": "date"
          }
        ]
      },
      {
        "id": "Episode.episode-start-datetime",
        "path": "Episode.episode_start_datetime",
        "short": "Episode Start Datetime",
        "definition": "The date and time when the Episode beings.",
        "min": 0,
        "max": "1",
        "base": {
          "path": "Episode.episode_start_datetime",
          "min": 0,
          "max": "1"
        },
        "type": [
          {
            "code": "dateTime"
          }
        ]
      },
      {
        "id": "Episode.episode-end-date",
        "path": "Episode.episode_end_date",
        "short": "Episode End Date",
        "definition": "The date when the instance of the Episode is considered to have ended.",
        "min": 0,
        "max": "1",
        "base": {
          "path": "Episode.episode_end_date",
          "min": 0,
          "max": "1"
        },
        "type": [
          {
            "code": "date"
          }
        ]
      },
      {
        "id": "Episode.episode-end-datetime",
        "path": "Episode.episode_end_datetime",
        "short": "Epsisode End Datetime",
        "definition": "The date when the instance of the Episode is considered to have ended.",
        "min": 0,
        "max": "1",
        "base": {
          "path": "Episode.episode_end_datetime",
          "min": 0,
          "max": "1"
        },
        "type": [
          {
            "code": "dateTime"
          }
        ]
      },
      {
        "id": "Episode.episode-parent-id",
        "path": "Episode.episode_parent_id",
        "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.",
        "min": 0,
        "max": "1",
        "base": {
          "path": "Episode.episode_parent_id",
          "min": 0,
          "max": "1"
        },
        "type": [
          {
            "code": "Reference",
            "targetProfile": [
              "http://hl7.org/fhir/uv/omop/StructureDefinition/Episode"
            ]
          }
        ]
      },
      {
        "id": "Episode.episode-number",
        "path": "Episode.episode_number",
        "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.",
        "min": 0,
        "max": "1",
        "base": {
          "path": "Episode.episode_number",
          "min": 0,
          "max": "1"
        },
        "type": [
          {
            "code": "integer"
          }
        ]
      },
      {
        "id": "Episode.episode-object-concept-id",
        "path": "Episode.episode_object_concept_id",
        "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).",
        "min": 1,
        "max": "1",
        "base": {
          "path": "Episode.episode_object_concept_id",
          "min": 1,
          "max": "1"
        },
        "type": [
          {
            "code": "code"
          }
        ]
      },
      {
        "id": "Episode.episode-type-concept-id",
        "path": "Episode.episode_type_concept_id",
        "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.",
        "min": 1,
        "max": "1",
        "base": {
          "path": "Episode.episode_type_concept_id",
          "min": 1,
          "max": "1"
        },
        "type": [
          {
            "code": "code"
          }
        ]
      },
      {
        "id": "Episode.episode-source-value",
        "path": "Episode.episode_source_value",
        "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.",
        "min": 0,
        "max": "1",
        "base": {
          "path": "Episode.episode_source_value",
          "min": 0,
          "max": "1"
        },
        "type": [
          {
            "code": "string"
          }
        ]
      },
      {
        "id": "Episode.episode-source-concept-id",
        "path": "Episode.episode_source_concept_id",
        "short": "Episode Source",
        "definition": "A foreign key to a Episode Concept that refers to the code used in the source.",
        "min": 0,
        "max": "1",
        "base": {
          "path": "Episode.episode_source_concept_id",
          "min": 0,
          "max": "1"
        },
        "type": [
          {
            "code": "code"
          }
        ]
      }
    ]
  },
  "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",
        "path": "Episode.episode_id",
        "short": "Episode Identifier",
        "definition": "Episode Identifier",
        "min": 1,
        "max": "1",
        "type": [
          {
            "code": "code"
          }
        ]
      },
      {
        "id": "Episode.person-id",
        "path": "Episode.person_id",
        "short": "Person",
        "definition": "The PERSON_ID of the PERSON for whom the episode is recorded.",
        "min": 1,
        "max": "1",
        "type": [
          {
            "code": "Reference",
            "targetProfile": [
              "http://hl7.org/fhir/uv/omop/StructureDefinition/Person"
            ]
          }
        ]
      },
      {
        "id": "Episode.episode-concept-id",
        "path": "Episode.episode_concept_id",
        "short": "Episode",
        "definition": "The EPISODE_CONCEPT_ID represents the kind abstraction related to the disease phase, outcome or treatment.",
        "min": 1,
        "max": "1",
        "type": [
          {
            "code": "code"
          }
        ]
      },
      {
        "id": "Episode.episode-start-date",
        "path": "Episode.episode_start_date",
        "short": "Episode Start Date",
        "definition": "The date when the Episode beings.",
        "min": 1,
        "max": "1",
        "type": [
          {
            "code": "date"
          }
        ]
      },
      {
        "id": "Episode.episode-start-datetime",
        "path": "Episode.episode_start_datetime",
        "short": "Episode Start Datetime",
        "definition": "The date and time when the Episode beings.",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "dateTime"
          }
        ]
      },
      {
        "id": "Episode.episode-end-date",
        "path": "Episode.episode_end_date",
        "short": "Episode End Date",
        "definition": "The date when the instance of the Episode is considered to have ended.",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "date"
          }
        ]
      },
      {
        "id": "Episode.episode-end-datetime",
        "path": "Episode.episode_end_datetime",
        "short": "Epsisode End Datetime",
        "definition": "The date when the instance of the Episode is considered to have ended.",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "dateTime"
          }
        ]
      },
      {
        "id": "Episode.episode-parent-id",
        "path": "Episode.episode_parent_id",
        "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.",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "Reference",
            "targetProfile": [
              "http://hl7.org/fhir/uv/omop/StructureDefinition/Episode"
            ]
          }
        ]
      },
      {
        "id": "Episode.episode-number",
        "path": "Episode.episode_number",
        "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.",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "integer"
          }
        ]
      },
      {
        "id": "Episode.episode-object-concept-id",
        "path": "Episode.episode_object_concept_id",
        "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).",
        "min": 1,
        "max": "1",
        "type": [
          {
            "code": "code"
          }
        ]
      },
      {
        "id": "Episode.episode-type-concept-id",
        "path": "Episode.episode_type_concept_id",
        "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.",
        "min": 1,
        "max": "1",
        "type": [
          {
            "code": "code"
          }
        ]
      },
      {
        "id": "Episode.episode-source-value",
        "path": "Episode.episode_source_value",
        "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.",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "string"
          }
        ]
      },
      {
        "id": "Episode.episode-source-concept-id",
        "path": "Episode.episode_source_concept_id",
        "short": "Episode Source",
        "definition": "A foreign key to a Episode Concept that refers to the code used in the source.",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "code"
          }
        ]
      }
    ]
  }
}