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

FHIR IG Statistics: StructureDefinition/VisitOccurrence

Packagehl7.fhir.uv.omop
TypeStructureDefinition
IdVisitOccurrence
FHIR VersionR5
Sourcehttp://hl7.org/fhir/uv/omop/https://build.fhir.org/ig/HL7/fhir-omop-ig/StructureDefinition-VisitOccurrence.html
URLhttp://hl7.org/fhir/uv/omop/StructureDefinition/VisitOccurrence
Version1.0.0-ballot
Statusactive
Date2025-07-22T19:48:02+00:00
NameVisitOccurrence
TitleVisit Occurrence OMOP Table
Realmuv
Authorityhl7
DescriptionThis table contains Events where Persons engage with the healthcare system for a duration of time. They are often also called "Encounters". Visits are defined by a configuration of circumstances under which they occur, such as (i) whether the patient comes to a healthcare institution, the other way around, or the interaction is remote, (ii) whether and what kind of trained medical staff is delivering the service during the Visit, and (iii) whether the Visit is transient or for a longer period involving a stay in bed.
Typehttp://hl7.org/fhir/uv/omop/StructureDefinition/VisitOccurrence
Kindlogical

Resources that use this resource

StructureDefinition
ConditionOccurrenceCondition Occurrence OMOP Table
DeviceExposureDevice Exposure OMOP Table
DrugExposureDrug Exposure OMOP Table
MeasurementMeasurement OMOP Table
NoteNote OMOP Table
ObservationObservation OMOP Table
ProcedureOccurrenceProcedure Occurrence OMOP Table
VisitDetailVisit Detail OMOP Table
VisitOccurrenceVisit Occurrence OMOP Table

Resources that this resource uses

StructureDefinition
CareSiteCareSite OMOP Table
PersonPerson OMOP Table
ProviderProvider OMOP Table
VisitOccurrenceVisit Occurrence OMOP Table

Narrative

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

Generated Narrative: StructureDefinition VisitOccurrence

NameFlagsCard.TypeDescription & Constraintsdoco
.. VisitOccurrence 0..*BaseVisit Occurrence OMOP Table
Instances of this logical model can be the target of a Reference
... visit_occurrence_id 1..1integerVisit Occurrence Identifier
... person_id 1..1Reference(Person OMOP Table)Person
... visit_concept_id 1..1codeVisit
... visit_start_date 1..1dateStart Date
... visit_start_datetime 0..1dateTimeStart Datetime
... visit_end_date 1..1dateEnd Date
... visit_end_datetime 0..1dateTimeEnd Datetime
... visit_type_concept_id 1..1codeVisit Type
... provider_id 0..1Reference(Provider OMOP Table)Provider
... care_site_id 0..1Reference(CareSite OMOP Table)Care Site
... visit_source_value 0..1stringVisit Source Value
... visit_source_concept_id 0..1codeVisit Source Concept
... admitted_from_concept_id 0..1codeAdmitted From Concept
... admitted_from_source_value 0..1stringAdmitted From Source Value
... discharged_to_concept_id 0..1codeDischarged To Concept
... discharged_to_source_value 0..1stringDischarged To Source Value
... preceding_visit_occurrence_id 0..1Reference(Visit Occurrence OMOP Table)Preceding Visit Occurrence

doco Documentation for this format

Source

{
  "resourceType": "StructureDefinition",
  "id": "VisitOccurrence",
  "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/VisitOccurrence",
  "version": "1.0.0-ballot",
  "name": "VisitOccurrence",
  "title": "Visit Occurrence 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": "This table contains Events where Persons engage with the healthcare system for a duration of time. They are often also called \"Encounters\". Visits are defined by a configuration of circumstances under which they occur, such as (i) whether the patient comes to a healthcare institution, the other way around, or the interaction is remote, (ii) whether and what kind of trained medical staff is delivering the service during the Visit, and (iii) whether the Visit is transient or for a longer period involving a stay in bed.",
  "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/VisitOccurrence",
  "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": "VisitOccurrence",
        "path": "VisitOccurrence",
        "short": "Visit Occurrence OMOP Table",
        "definition": "This table contains Events where Persons engage with the healthcare system for a duration of time. They are often also called \"Encounters\". Visits are defined by a configuration of circumstances under which they occur, such as (i) whether the patient comes to a healthcare institution, the other way around, or the interaction is remote, (ii) whether and what kind of trained medical staff is delivering the service during the Visit, and (iii) whether the Visit is transient or for a longer period involving a stay in bed.",
        "min": 0,
        "max": "*",
        "base": {
          "path": "Base",
          "min": 0,
          "max": "*"
        },
        "isModifier": false,
        "mapping": [
          {
            "identity": "rim",
            "map": "n/a"
          }
        ]
      },
      {
        "id": "VisitOccurrence.visit-occurrence-id",
        "path": "VisitOccurrence.visit_occurrence_id",
        "short": "Visit Occurrence Identifier",
        "definition": "Use this to identify unique interactions between a person and the health care system. This identifier links across the other CDM event tables to associate events with a visit.",
        "min": 1,
        "max": "1",
        "base": {
          "path": "VisitOccurrence.visit_occurrence_id",
          "min": 1,
          "max": "1"
        },
        "type": [
          {
            "code": "integer"
          }
        ]
      },
      {
        "id": "VisitOccurrence.person-id",
        "path": "VisitOccurrence.person_id",
        "short": "Person",
        "definition": "Person",
        "min": 1,
        "max": "1",
        "base": {
          "path": "VisitOccurrence.person_id",
          "min": 1,
          "max": "1"
        },
        "type": [
          {
            "code": "Reference",
            "targetProfile": [
              "http://hl7.org/fhir/uv/omop/StructureDefinition/Person"
            ]
          }
        ]
      },
      {
        "id": "VisitOccurrence.visit-concept-id",
        "path": "VisitOccurrence.visit_concept_id",
        "short": "Visit",
        "definition": "This field contains a concept id representing the kind of visit, like inpatient or outpatient. All concepts in this field should be standard and belong to the Visit domain.",
        "min": 1,
        "max": "1",
        "base": {
          "path": "VisitOccurrence.visit_concept_id",
          "min": 1,
          "max": "1"
        },
        "type": [
          {
            "code": "code"
          }
        ]
      },
      {
        "id": "VisitOccurrence.visit-start-date",
        "path": "VisitOccurrence.visit_start_date",
        "short": "Start Date",
        "definition": "For inpatient visits, the start date is typically the admission date. For outpatient visits the start date and end date will be the same.",
        "min": 1,
        "max": "1",
        "base": {
          "path": "VisitOccurrence.visit_start_date",
          "min": 1,
          "max": "1"
        },
        "type": [
          {
            "code": "date"
          }
        ]
      },
      {
        "id": "VisitOccurrence.visit-start-datetime",
        "path": "VisitOccurrence.visit_start_datetime",
        "short": "Start Datetime",
        "definition": "Start Datetime",
        "min": 0,
        "max": "1",
        "base": {
          "path": "VisitOccurrence.visit_start_datetime",
          "min": 0,
          "max": "1"
        },
        "type": [
          {
            "code": "dateTime"
          }
        ]
      },
      {
        "id": "VisitOccurrence.visit-end-date",
        "path": "VisitOccurrence.visit_end_date",
        "short": "End Date",
        "definition": "For inpatient visits the end date is typically the discharge date.  If a Person is still an inpatient in the hospital at the time of the data extract and does not have a visit_end_date, then set the visit_end_date to the date of the data pull.",
        "min": 1,
        "max": "1",
        "base": {
          "path": "VisitOccurrence.visit_end_date",
          "min": 1,
          "max": "1"
        },
        "type": [
          {
            "code": "date"
          }
        ]
      },
      {
        "id": "VisitOccurrence.visit-end-datetime",
        "path": "VisitOccurrence.visit_end_datetime",
        "short": "End Datetime",
        "definition": "End Datetime",
        "min": 0,
        "max": "1",
        "base": {
          "path": "VisitOccurrence.visit_end_datetime",
          "min": 0,
          "max": "1"
        },
        "type": [
          {
            "code": "dateTime"
          }
        ]
      },
      {
        "id": "VisitOccurrence.visit-type-concept-id",
        "path": "VisitOccurrence.visit_type_concept_id",
        "short": "Visit Type",
        "definition": "Use this field to understand the provenance of the visit record, or where the record comes from.",
        "min": 1,
        "max": "1",
        "base": {
          "path": "VisitOccurrence.visit_type_concept_id",
          "min": 1,
          "max": "1"
        },
        "type": [
          {
            "code": "code"
          }
        ]
      },
      {
        "id": "VisitOccurrence.provider-id",
        "path": "VisitOccurrence.provider_id",
        "short": "Provider",
        "definition": "There will only be one provider per visit record and the ETL document should clearly state how they were chosen (attending, admitting, etc.). If there are multiple providers associated with a visit in the source, this can be reflected in the event tables (CONDITION_OCCURRENCE, PROCEDURE_OCCURRENCE, etc.) or in the VISIT_DETAIL table.",
        "min": 0,
        "max": "1",
        "base": {
          "path": "VisitOccurrence.provider_id",
          "min": 0,
          "max": "1"
        },
        "type": [
          {
            "code": "Reference",
            "targetProfile": [
              "http://hl7.org/fhir/uv/omop/StructureDefinition/Provider"
            ]
          }
        ]
      },
      {
        "id": "VisitOccurrence.care-site-id",
        "path": "VisitOccurrence.care_site_id",
        "short": "Care Site",
        "definition": "This field provides information about the Care Site where the Visit took place.",
        "min": 0,
        "max": "1",
        "base": {
          "path": "VisitOccurrence.care_site_id",
          "min": 0,
          "max": "1"
        },
        "type": [
          {
            "code": "Reference",
            "targetProfile": [
              "http://hl7.org/fhir/uv/omop/StructureDefinition/CareSite"
            ]
          }
        ]
      },
      {
        "id": "VisitOccurrence.visit-source-value",
        "path": "VisitOccurrence.visit_source_value",
        "short": "Visit Source Value",
        "definition": "This field houses the verbatim value from the source data representing the kind of visit that took place (inpatient, outpatient, emergency, etc.)",
        "min": 0,
        "max": "1",
        "base": {
          "path": "VisitOccurrence.visit_source_value",
          "min": 0,
          "max": "1"
        },
        "type": [
          {
            "code": "string"
          }
        ]
      },
      {
        "id": "VisitOccurrence.visit-source-concept-id",
        "path": "VisitOccurrence.visit_source_concept_id",
        "short": "Visit Source Concept",
        "definition": "Visit Source Concept",
        "min": 0,
        "max": "1",
        "base": {
          "path": "VisitOccurrence.visit_source_concept_id",
          "min": 0,
          "max": "1"
        },
        "type": [
          {
            "code": "code"
          }
        ]
      },
      {
        "id": "VisitOccurrence.admitted-from-concept-id",
        "path": "VisitOccurrence.admitted_from_concept_id",
        "short": "Admitted From Concept",
        "definition": "Use this field to determine where the patient was admitted from. This concept is part of the visit domain and can indicate if a patient was admitted to the hospital from a long-term care facility, for example.",
        "min": 0,
        "max": "1",
        "base": {
          "path": "VisitOccurrence.admitted_from_concept_id",
          "min": 0,
          "max": "1"
        },
        "type": [
          {
            "code": "code"
          }
        ]
      },
      {
        "id": "VisitOccurrence.admitted-from-source-value",
        "path": "VisitOccurrence.admitted_from_source_value",
        "short": "Admitted From Source Value",
        "definition": "Admitted From Source Value",
        "min": 0,
        "max": "1",
        "base": {
          "path": "VisitOccurrence.admitted_from_source_value",
          "min": 0,
          "max": "1"
        },
        "type": [
          {
            "code": "string"
          }
        ]
      },
      {
        "id": "VisitOccurrence.discharged-to-concept-id",
        "path": "VisitOccurrence.discharged_to_concept_id",
        "short": "Discharged To Concept",
        "definition": "Discharged To Concept",
        "min": 0,
        "max": "1",
        "base": {
          "path": "VisitOccurrence.discharged_to_concept_id",
          "min": 0,
          "max": "1"
        },
        "type": [
          {
            "code": "code"
          }
        ]
      },
      {
        "id": "VisitOccurrence.discharged-to-source-value",
        "path": "VisitOccurrence.discharged_to_source_value",
        "short": "Discharged To Source Value",
        "definition": "Discharged To Source Value",
        "min": 0,
        "max": "1",
        "base": {
          "path": "VisitOccurrence.discharged_to_source_value",
          "min": 0,
          "max": "1"
        },
        "type": [
          {
            "code": "string"
          }
        ]
      },
      {
        "id": "VisitOccurrence.preceding-visit-occurrence-id",
        "path": "VisitOccurrence.preceding_visit_occurrence_id",
        "short": "Preceding Visit Occurrence",
        "definition": "Use this field to find the visit that occurred for the person prior to the given visit. There could be a few days or a few years in between.",
        "min": 0,
        "max": "1",
        "base": {
          "path": "VisitOccurrence.preceding_visit_occurrence_id",
          "min": 0,
          "max": "1"
        },
        "type": [
          {
            "code": "Reference",
            "targetProfile": [
              "http://hl7.org/fhir/uv/omop/StructureDefinition/VisitOccurrence"
            ]
          }
        ]
      }
    ]
  },
  "differential": {
    "element": [
      {
        "id": "VisitOccurrence",
        "path": "VisitOccurrence",
        "short": "Visit Occurrence OMOP Table",
        "definition": "This table contains Events where Persons engage with the healthcare system for a duration of time. They are often also called \"Encounters\". Visits are defined by a configuration of circumstances under which they occur, such as (i) whether the patient comes to a healthcare institution, the other way around, or the interaction is remote, (ii) whether and what kind of trained medical staff is delivering the service during the Visit, and (iii) whether the Visit is transient or for a longer period involving a stay in bed."
      },
      {
        "id": "VisitOccurrence.visit-occurrence-id",
        "path": "VisitOccurrence.visit_occurrence_id",
        "short": "Visit Occurrence Identifier",
        "definition": "Use this to identify unique interactions between a person and the health care system. This identifier links across the other CDM event tables to associate events with a visit.",
        "min": 1,
        "max": "1",
        "type": [
          {
            "code": "integer"
          }
        ]
      },
      {
        "id": "VisitOccurrence.person-id",
        "path": "VisitOccurrence.person_id",
        "short": "Person",
        "definition": "Person",
        "min": 1,
        "max": "1",
        "type": [
          {
            "code": "Reference",
            "targetProfile": [
              "http://hl7.org/fhir/uv/omop/StructureDefinition/Person"
            ]
          }
        ]
      },
      {
        "id": "VisitOccurrence.visit-concept-id",
        "path": "VisitOccurrence.visit_concept_id",
        "short": "Visit",
        "definition": "This field contains a concept id representing the kind of visit, like inpatient or outpatient. All concepts in this field should be standard and belong to the Visit domain.",
        "min": 1,
        "max": "1",
        "type": [
          {
            "code": "code"
          }
        ]
      },
      {
        "id": "VisitOccurrence.visit-start-date",
        "path": "VisitOccurrence.visit_start_date",
        "short": "Start Date",
        "definition": "For inpatient visits, the start date is typically the admission date. For outpatient visits the start date and end date will be the same.",
        "min": 1,
        "max": "1",
        "type": [
          {
            "code": "date"
          }
        ]
      },
      {
        "id": "VisitOccurrence.visit-start-datetime",
        "path": "VisitOccurrence.visit_start_datetime",
        "short": "Start Datetime",
        "definition": "Start Datetime",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "dateTime"
          }
        ]
      },
      {
        "id": "VisitOccurrence.visit-end-date",
        "path": "VisitOccurrence.visit_end_date",
        "short": "End Date",
        "definition": "For inpatient visits the end date is typically the discharge date.  If a Person is still an inpatient in the hospital at the time of the data extract and does not have a visit_end_date, then set the visit_end_date to the date of the data pull.",
        "min": 1,
        "max": "1",
        "type": [
          {
            "code": "date"
          }
        ]
      },
      {
        "id": "VisitOccurrence.visit-end-datetime",
        "path": "VisitOccurrence.visit_end_datetime",
        "short": "End Datetime",
        "definition": "End Datetime",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "dateTime"
          }
        ]
      },
      {
        "id": "VisitOccurrence.visit-type-concept-id",
        "path": "VisitOccurrence.visit_type_concept_id",
        "short": "Visit Type",
        "definition": "Use this field to understand the provenance of the visit record, or where the record comes from.",
        "min": 1,
        "max": "1",
        "type": [
          {
            "code": "code"
          }
        ]
      },
      {
        "id": "VisitOccurrence.provider-id",
        "path": "VisitOccurrence.provider_id",
        "short": "Provider",
        "definition": "There will only be one provider per visit record and the ETL document should clearly state how they were chosen (attending, admitting, etc.). If there are multiple providers associated with a visit in the source, this can be reflected in the event tables (CONDITION_OCCURRENCE, PROCEDURE_OCCURRENCE, etc.) or in the VISIT_DETAIL table.",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "Reference",
            "targetProfile": [
              "http://hl7.org/fhir/uv/omop/StructureDefinition/Provider"
            ]
          }
        ]
      },
      {
        "id": "VisitOccurrence.care-site-id",
        "path": "VisitOccurrence.care_site_id",
        "short": "Care Site",
        "definition": "This field provides information about the Care Site where the Visit took place.",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "Reference",
            "targetProfile": [
              "http://hl7.org/fhir/uv/omop/StructureDefinition/CareSite"
            ]
          }
        ]
      },
      {
        "id": "VisitOccurrence.visit-source-value",
        "path": "VisitOccurrence.visit_source_value",
        "short": "Visit Source Value",
        "definition": "This field houses the verbatim value from the source data representing the kind of visit that took place (inpatient, outpatient, emergency, etc.)",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "string"
          }
        ]
      },
      {
        "id": "VisitOccurrence.visit-source-concept-id",
        "path": "VisitOccurrence.visit_source_concept_id",
        "short": "Visit Source Concept",
        "definition": "Visit Source Concept",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "code"
          }
        ]
      },
      {
        "id": "VisitOccurrence.admitted-from-concept-id",
        "path": "VisitOccurrence.admitted_from_concept_id",
        "short": "Admitted From Concept",
        "definition": "Use this field to determine where the patient was admitted from. This concept is part of the visit domain and can indicate if a patient was admitted to the hospital from a long-term care facility, for example.",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "code"
          }
        ]
      },
      {
        "id": "VisitOccurrence.admitted-from-source-value",
        "path": "VisitOccurrence.admitted_from_source_value",
        "short": "Admitted From Source Value",
        "definition": "Admitted From Source Value",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "string"
          }
        ]
      },
      {
        "id": "VisitOccurrence.discharged-to-concept-id",
        "path": "VisitOccurrence.discharged_to_concept_id",
        "short": "Discharged To Concept",
        "definition": "Discharged To Concept",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "code"
          }
        ]
      },
      {
        "id": "VisitOccurrence.discharged-to-source-value",
        "path": "VisitOccurrence.discharged_to_source_value",
        "short": "Discharged To Source Value",
        "definition": "Discharged To Source Value",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "string"
          }
        ]
      },
      {
        "id": "VisitOccurrence.preceding-visit-occurrence-id",
        "path": "VisitOccurrence.preceding_visit_occurrence_id",
        "short": "Preceding Visit Occurrence",
        "definition": "Use this field to find the visit that occurred for the person prior to the given visit. There could be a few days or a few years in between.",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "Reference",
            "targetProfile": [
              "http://hl7.org/fhir/uv/omop/StructureDefinition/VisitOccurrence"
            ]
          }
        ]
      }
    ]
  }
}