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

FHIR IG Statistics: StructureDefinition/ProcedureOccurrence

Packagehl7.fhir.uv.omop
TypeStructureDefinition
IdProcedureOccurrence
FHIR VersionR5
Sourcehttp://hl7.org/fhir/uv/omop/https://build.fhir.org/ig/HL7/fhir-omop-ig/StructureDefinition-ProcedureOccurrence.html
URLhttp://hl7.org/fhir/uv/omop/StructureDefinition/ProcedureOccurrence
Version0.1.0
Statusdraft
Date2025-07-21T21:36:05+00:00
NameProcedureOccurrence
TitleProcedure Occurrence OMOP Table
Realmuv
Authorityhl7
DescriptionThis table contains records of activities or processes ordered by, or carried out by, a healthcare provider on the patient with a diagnostic or therapeutic purpose.
Typehttp://hl7.org/fhir/uv/omop/StructureDefinition/ProcedureOccurrence
Kindlogical

Resources that use this resource

No resources found


Resources that this resource uses

StructureDefinition
PersonPerson OMOP Table
ProviderProvider OMOP Table
VisitDetailVisit Detail OMOP Table
VisitOccurrenceVisit Occurrence OMOP Table

Narrative

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

Generated Narrative: StructureDefinition ProcedureOccurrence

NameFlagsCard.TypeDescription & Constraintsdoco
.. ProcedureOccurrence 0..*BaseProcedure Occurrence OMOP Table
Instances of this logical model can be the target of a Reference
... procedure_occurrence_id 1..1integerProcedure Occurrence Identifier
... person_id 1..1Reference(Person OMOP Table)Person
... procedure_concept_id 1..1codeProcedure
... procedure_date 1..1dateProcedure Date
... procedure_datetime 0..1dateTimeProcedure Datetime
... procedure_end_date 0..1dateProcedure End Date
... procedure_end_datetime 0..1dateTimeprocedure_end_datetime
... procedure_type_concept_id 1..1codeProcedure Type
... modifier_concept_id 0..1codeModifier
... quantity 0..1integerQuantity
... provider_id 0..1Reference(Provider OMOP Table)Provider
... visit_occurrence_id 0..1Reference(Visit Occurrence OMOP Table)VisitOccurrence
... visit_detail_id 0..1Reference(Visit Detail OMOP Table)Visit Detail
... procedure_source_value 0..1stringProcedure Source Value
... procedure_source_concept_id 0..1codeProcedure Source Concept
... modifier_source_value 0..1stringModifier Source Value

doco Documentation for this format

Source

{
  "resourceType": "StructureDefinition",
  "id": "ProcedureOccurrence",
  "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": "draft",
      "_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/ProcedureOccurrence",
  "version": "0.1.0",
  "name": "ProcedureOccurrence",
  "title": "Procedure Occurrence OMOP Table",
  "status": "draft",
  "date": "2025-07-21T21:36:05+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 records of activities or processes ordered by, or carried out by, a healthcare provider on the patient with a diagnostic or therapeutic purpose.",
  "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/ProcedureOccurrence",
  "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": "ProcedureOccurrence",
        "path": "ProcedureOccurrence",
        "short": "Procedure Occurrence OMOP Table",
        "definition": "This table contains records of activities or processes ordered by, or carried out by, a healthcare provider on the patient with a diagnostic or therapeutic purpose.",
        "min": 0,
        "max": "*",
        "base": {
          "path": "Base",
          "min": 0,
          "max": "*"
        },
        "isModifier": false,
        "mapping": [
          {
            "identity": "rim",
            "map": "n/a"
          }
        ]
      },
      {
        "id": "ProcedureOccurrence.procedure-occurrence-id",
        "path": "ProcedureOccurrence.procedure_occurrence_id",
        "short": "Procedure Occurrence Identifier",
        "definition": "The unique key given to a procedure record for a person. Refer to the ETL for how duplicate procedures during the same visit were handled.",
        "min": 1,
        "max": "1",
        "base": {
          "path": "ProcedureOccurrence.procedure_occurrence_id",
          "min": 1,
          "max": "1"
        },
        "type": [
          {
            "code": "integer"
          }
        ]
      },
      {
        "id": "ProcedureOccurrence.person-id",
        "path": "ProcedureOccurrence.person_id",
        "short": "Person",
        "definition": "The PERSON_ID of the PERSON for whom the procedure is recorded. This may be a system generated code.",
        "min": 1,
        "max": "1",
        "base": {
          "path": "ProcedureOccurrence.person_id",
          "min": 1,
          "max": "1"
        },
        "type": [
          {
            "code": "Reference",
            "targetProfile": [
              "http://hl7.org/fhir/uv/omop/StructureDefinition/Person"
            ]
          }
        ]
      },
      {
        "id": "ProcedureOccurrence.procedure-concept-id",
        "path": "ProcedureOccurrence.procedure_concept_id",
        "short": "Procedure",
        "definition": "The PROCEDURE_CONCEPT_ID field is recommended for primary use in analyses, and must be used for network studies. This is the standard concept mapped from the source value which represents a procedure",
        "min": 1,
        "max": "1",
        "base": {
          "path": "ProcedureOccurrence.procedure_concept_id",
          "min": 1,
          "max": "1"
        },
        "type": [
          {
            "code": "code"
          }
        ]
      },
      {
        "id": "ProcedureOccurrence.procedure-date",
        "path": "ProcedureOccurrence.procedure_date",
        "short": "Procedure Date",
        "definition": "Use this date to determine the date the procedure started.",
        "min": 1,
        "max": "1",
        "base": {
          "path": "ProcedureOccurrence.procedure_date",
          "min": 1,
          "max": "1"
        },
        "type": [
          {
            "code": "date"
          }
        ]
      },
      {
        "id": "ProcedureOccurrence.procedure-datetime",
        "path": "ProcedureOccurrence.procedure_datetime",
        "short": "Procedure Datetime",
        "definition": "Procedure Datetime",
        "min": 0,
        "max": "1",
        "base": {
          "path": "ProcedureOccurrence.procedure_datetime",
          "min": 0,
          "max": "1"
        },
        "type": [
          {
            "code": "dateTime"
          }
        ]
      },
      {
        "id": "ProcedureOccurrence.procedure-end-date",
        "path": "ProcedureOccurrence.procedure_end_date",
        "short": "Procedure End Date",
        "definition": "Use this field to house the date that the procedure ended.",
        "min": 0,
        "max": "1",
        "base": {
          "path": "ProcedureOccurrence.procedure_end_date",
          "min": 0,
          "max": "1"
        },
        "type": [
          {
            "code": "date"
          }
        ]
      },
      {
        "id": "ProcedureOccurrence.procedure-end-datetime",
        "path": "ProcedureOccurrence.procedure_end_datetime",
        "short": "procedure_end_datetime",
        "definition": "Use this field to house the datetime that the procedure ended.",
        "min": 0,
        "max": "1",
        "base": {
          "path": "ProcedureOccurrence.procedure_end_datetime",
          "min": 0,
          "max": "1"
        },
        "type": [
          {
            "code": "dateTime"
          }
        ]
      },
      {
        "id": "ProcedureOccurrence.procedure-type-concept-id",
        "path": "ProcedureOccurrence.procedure_type_concept_id",
        "short": "Procedure Type",
        "definition": "This field can be used to determine the provenance of the Procedure record, as in whether the procedure was from an EHR system, insurance claim, registry, or other sources.",
        "min": 1,
        "max": "1",
        "base": {
          "path": "ProcedureOccurrence.procedure_type_concept_id",
          "min": 1,
          "max": "1"
        },
        "type": [
          {
            "code": "code"
          }
        ]
      },
      {
        "id": "ProcedureOccurrence.modifier-concept-id",
        "path": "ProcedureOccurrence.modifier_concept_id",
        "short": "Modifier",
        "definition": "The modifiers are intended to give additional information about the procedure but as of now the vocabulary is under review.",
        "min": 0,
        "max": "1",
        "base": {
          "path": "ProcedureOccurrence.modifier_concept_id",
          "min": 0,
          "max": "1"
        },
        "type": [
          {
            "code": "code"
          }
        ]
      },
      {
        "id": "ProcedureOccurrence.quantity",
        "path": "ProcedureOccurrence.quantity",
        "short": "Quantity",
        "definition": "If the quantity value is omitted, a single procedure is assumed.",
        "min": 0,
        "max": "1",
        "base": {
          "path": "ProcedureOccurrence.quantity",
          "min": 0,
          "max": "1"
        },
        "type": [
          {
            "code": "integer"
          }
        ]
      },
      {
        "id": "ProcedureOccurrence.provider-id",
        "path": "ProcedureOccurrence.provider_id",
        "short": "Provider",
        "definition": "The provider associated with the procedure record, e.g. the provider who performed the Procedure.",
        "min": 0,
        "max": "1",
        "base": {
          "path": "ProcedureOccurrence.provider_id",
          "min": 0,
          "max": "1"
        },
        "type": [
          {
            "code": "Reference",
            "targetProfile": [
              "http://hl7.org/fhir/uv/omop/StructureDefinition/Provider"
            ]
          }
        ]
      },
      {
        "id": "ProcedureOccurrence.visit-occurrence-id",
        "path": "ProcedureOccurrence.visit_occurrence_id",
        "short": "VisitOccurrence",
        "definition": "The visit during which the procedure occurred.",
        "min": 0,
        "max": "1",
        "base": {
          "path": "ProcedureOccurrence.visit_occurrence_id",
          "min": 0,
          "max": "1"
        },
        "type": [
          {
            "code": "Reference",
            "targetProfile": [
              "http://hl7.org/fhir/uv/omop/StructureDefinition/VisitOccurrence"
            ]
          }
        ]
      },
      {
        "id": "ProcedureOccurrence.visit-detail-id",
        "path": "ProcedureOccurrence.visit_detail_id",
        "short": "Visit Detail",
        "definition": "The VISIT_DETAIL record during which the Procedure occurred. For example, if the Person was in the ICU at the time of the Procedure the VISIT_OCCURRENCE record would reflect the overall hospital stay and the VISIT_DETAIL record would reflect the ICU stay during the hospital visit.",
        "min": 0,
        "max": "1",
        "base": {
          "path": "ProcedureOccurrence.visit_detail_id",
          "min": 0,
          "max": "1"
        },
        "type": [
          {
            "code": "Reference",
            "targetProfile": [
              "http://hl7.org/fhir/uv/omop/StructureDefinition/VisitDetail"
            ]
          }
        ]
      },
      {
        "id": "ProcedureOccurrence.procedure-source-value",
        "path": "ProcedureOccurrence.procedure_source_value",
        "short": "Procedure Source Value",
        "definition": "This field houses the verbatim value from the source data representing the procedure that occurred. For example, this could be an CPT4 or OPCS4 code.",
        "min": 0,
        "max": "1",
        "base": {
          "path": "ProcedureOccurrence.procedure_source_value",
          "min": 0,
          "max": "1"
        },
        "type": [
          {
            "code": "string"
          }
        ]
      },
      {
        "id": "ProcedureOccurrence.procedure-source-concept-id",
        "path": "ProcedureOccurrence.procedure_source_concept_id",
        "short": "Procedure Source Concept",
        "definition": "This is the concept representing the procedure source value and may not necessarily be standard. This field is discouraged from use in analysis because it is not required to contain Standard Concepts that are used across the OHDSI community, and should only be used when Standard Concepts do not adequately represent the source detail for the Procedure necessary for a given analytic use case. Consider using PROCEDURE_CONCEPT_ID instead to enable standardized analytics that can be consistent across the network.",
        "min": 0,
        "max": "1",
        "base": {
          "path": "ProcedureOccurrence.procedure_source_concept_id",
          "min": 0,
          "max": "1"
        },
        "type": [
          {
            "code": "code"
          }
        ]
      },
      {
        "id": "ProcedureOccurrence.modifier-source-value",
        "path": "ProcedureOccurrence.modifier_source_value",
        "short": "Modifier Source Value",
        "definition": "Modifier Source Value",
        "min": 0,
        "max": "1",
        "base": {
          "path": "ProcedureOccurrence.modifier_source_value",
          "min": 0,
          "max": "1"
        },
        "type": [
          {
            "code": "string"
          }
        ]
      }
    ]
  },
  "differential": {
    "element": [
      {
        "id": "ProcedureOccurrence",
        "path": "ProcedureOccurrence",
        "short": "Procedure Occurrence OMOP Table",
        "definition": "This table contains records of activities or processes ordered by, or carried out by, a healthcare provider on the patient with a diagnostic or therapeutic purpose."
      },
      {
        "id": "ProcedureOccurrence.procedure-occurrence-id",
        "path": "ProcedureOccurrence.procedure_occurrence_id",
        "short": "Procedure Occurrence Identifier",
        "definition": "The unique key given to a procedure record for a person. Refer to the ETL for how duplicate procedures during the same visit were handled.",
        "min": 1,
        "max": "1",
        "type": [
          {
            "code": "integer"
          }
        ]
      },
      {
        "id": "ProcedureOccurrence.person-id",
        "path": "ProcedureOccurrence.person_id",
        "short": "Person",
        "definition": "The PERSON_ID of the PERSON for whom the procedure is recorded. This may be a system generated code.",
        "min": 1,
        "max": "1",
        "type": [
          {
            "code": "Reference",
            "targetProfile": [
              "http://hl7.org/fhir/uv/omop/StructureDefinition/Person"
            ]
          }
        ]
      },
      {
        "id": "ProcedureOccurrence.procedure-concept-id",
        "path": "ProcedureOccurrence.procedure_concept_id",
        "short": "Procedure",
        "definition": "The PROCEDURE_CONCEPT_ID field is recommended for primary use in analyses, and must be used for network studies. This is the standard concept mapped from the source value which represents a procedure",
        "min": 1,
        "max": "1",
        "type": [
          {
            "code": "code"
          }
        ]
      },
      {
        "id": "ProcedureOccurrence.procedure-date",
        "path": "ProcedureOccurrence.procedure_date",
        "short": "Procedure Date",
        "definition": "Use this date to determine the date the procedure started.",
        "min": 1,
        "max": "1",
        "type": [
          {
            "code": "date"
          }
        ]
      },
      {
        "id": "ProcedureOccurrence.procedure-datetime",
        "path": "ProcedureOccurrence.procedure_datetime",
        "short": "Procedure Datetime",
        "definition": "Procedure Datetime",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "dateTime"
          }
        ]
      },
      {
        "id": "ProcedureOccurrence.procedure-end-date",
        "path": "ProcedureOccurrence.procedure_end_date",
        "short": "Procedure End Date",
        "definition": "Use this field to house the date that the procedure ended.",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "date"
          }
        ]
      },
      {
        "id": "ProcedureOccurrence.procedure-end-datetime",
        "path": "ProcedureOccurrence.procedure_end_datetime",
        "short": "procedure_end_datetime",
        "definition": "Use this field to house the datetime that the procedure ended.",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "dateTime"
          }
        ]
      },
      {
        "id": "ProcedureOccurrence.procedure-type-concept-id",
        "path": "ProcedureOccurrence.procedure_type_concept_id",
        "short": "Procedure Type",
        "definition": "This field can be used to determine the provenance of the Procedure record, as in whether the procedure was from an EHR system, insurance claim, registry, or other sources.",
        "min": 1,
        "max": "1",
        "type": [
          {
            "code": "code"
          }
        ]
      },
      {
        "id": "ProcedureOccurrence.modifier-concept-id",
        "path": "ProcedureOccurrence.modifier_concept_id",
        "short": "Modifier",
        "definition": "The modifiers are intended to give additional information about the procedure but as of now the vocabulary is under review.",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "code"
          }
        ]
      },
      {
        "id": "ProcedureOccurrence.quantity",
        "path": "ProcedureOccurrence.quantity",
        "short": "Quantity",
        "definition": "If the quantity value is omitted, a single procedure is assumed.",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "integer"
          }
        ]
      },
      {
        "id": "ProcedureOccurrence.provider-id",
        "path": "ProcedureOccurrence.provider_id",
        "short": "Provider",
        "definition": "The provider associated with the procedure record, e.g. the provider who performed the Procedure.",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "Reference",
            "targetProfile": [
              "http://hl7.org/fhir/uv/omop/StructureDefinition/Provider"
            ]
          }
        ]
      },
      {
        "id": "ProcedureOccurrence.visit-occurrence-id",
        "path": "ProcedureOccurrence.visit_occurrence_id",
        "short": "VisitOccurrence",
        "definition": "The visit during which the procedure occurred.",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "Reference",
            "targetProfile": [
              "http://hl7.org/fhir/uv/omop/StructureDefinition/VisitOccurrence"
            ]
          }
        ]
      },
      {
        "id": "ProcedureOccurrence.visit-detail-id",
        "path": "ProcedureOccurrence.visit_detail_id",
        "short": "Visit Detail",
        "definition": "The VISIT_DETAIL record during which the Procedure occurred. For example, if the Person was in the ICU at the time of the Procedure the VISIT_OCCURRENCE record would reflect the overall hospital stay and the VISIT_DETAIL record would reflect the ICU stay during the hospital visit.",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "Reference",
            "targetProfile": [
              "http://hl7.org/fhir/uv/omop/StructureDefinition/VisitDetail"
            ]
          }
        ]
      },
      {
        "id": "ProcedureOccurrence.procedure-source-value",
        "path": "ProcedureOccurrence.procedure_source_value",
        "short": "Procedure Source Value",
        "definition": "This field houses the verbatim value from the source data representing the procedure that occurred. For example, this could be an CPT4 or OPCS4 code.",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "string"
          }
        ]
      },
      {
        "id": "ProcedureOccurrence.procedure-source-concept-id",
        "path": "ProcedureOccurrence.procedure_source_concept_id",
        "short": "Procedure Source Concept",
        "definition": "This is the concept representing the procedure source value and may not necessarily be standard. This field is discouraged from use in analysis because it is not required to contain Standard Concepts that are used across the OHDSI community, and should only be used when Standard Concepts do not adequately represent the source detail for the Procedure necessary for a given analytic use case. Consider using PROCEDURE_CONCEPT_ID instead to enable standardized analytics that can be consistent across the network.",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "code"
          }
        ]
      },
      {
        "id": "ProcedureOccurrence.modifier-source-value",
        "path": "ProcedureOccurrence.modifier_source_value",
        "short": "Modifier Source Value",
        "definition": "Modifier Source Value",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "string"
          }
        ]
      }
    ]
  }
}