FHIR to OMOP FHIR IG
0.1.0 - ci-build International flag

FHIR to OMOP FHIR IG, published by HL7 International / Biomedical Research and Regulation. This guide is not an authorized publication; it is the continuous build for version 0.1.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/fhir-omop-ig/ and changes regularly. See the Directory of published versions

Logical Model: Payer Plan Period OMOP Table

Official URL: http://hl7.org/fhir/uv/omop/StructureDefinition/PayerPlanPeriod Version: 0.1.0
Standards status: Draft Maturity Level: 1 Computable Name: PayerPlanPeriod

The PAYER_PLAN_PERIOD table captures details of the period of time that a Person is continuously enrolled under a specific health Plan benefit structure from a given Payer. Each Person receiving healthcare is typically covered by a health benefit plan, which pays for (fully or partially), or directly provides, the care. These benefit plans are provided by payers, such as health insurances or state or government agencies. In each plan the details of the health benefits are defined for the Person or her family, and the health benefit Plan might change over time typically with increasing utilization (reaching certain cost thresholds such as deductibles), plan availability and purchasing choices of the Person. The unique combinations of Payer organizations, health benefit Plans and time periods in which they are valid for a Person are recorded in this table.

Usage:

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

This structure is derived from Base

NameFlagsCard.TypeDescription & Constraintsdoco
.. PayerPlanPeriod 0..* Base Payer Plan Period OMOP Table
Instances of this logical model are not marked to be the target of a Reference
... payer_plan_period_id 1..1 code Payer Plan Period Identifier
... person_id 1..1 Reference(Person OMOP Table) Person
... payer_plan_period_start_date 1..1 date Payer Plan Period Start Date
... payer_concept_id 0..1 code Payer
... payer_source_value 0..1 string Payer Source Value
... payer_source_concept_id 0..1 code Payer Source
... plan_concept_id 0..1 code Plan
... plan_source_value 0..1 string Plan Source Value
... plan_source_concept_id 0..1 code Plan Source
... sponsor_concept_id 0..1 code Sponsor
... sponsor_source_value 0..1 string Sponsor Source Value
... sponsor_source_concept_id 0..1 code Sponsor Source
... family_source_value 0..1 string Family Source Value
... stop_reason_concept_id 0..1 code Stop Reason
... stop_reason_source_value 0..1 string Stop Reason Source Value
... stop_reason_source_concept_id 0..1 code Stop Reason Source

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. PayerPlanPeriod 0..* Base Payer Plan Period OMOP Table
Instances of this logical model are not marked to be the target of a Reference
... payer_plan_period_id 1..1 code Payer Plan Period Identifier
... person_id 1..1 Reference(Person OMOP Table) Person
... payer_plan_period_start_date 1..1 date Payer Plan Period Start Date
... payer_concept_id 0..1 code Payer
... payer_source_value 0..1 string Payer Source Value
... payer_source_concept_id 0..1 code Payer Source
... plan_concept_id 0..1 code Plan
... plan_source_value 0..1 string Plan Source Value
... plan_source_concept_id 0..1 code Plan Source
... sponsor_concept_id 0..1 code Sponsor
... sponsor_source_value 0..1 string Sponsor Source Value
... sponsor_source_concept_id 0..1 code Sponsor Source
... family_source_value 0..1 string Family Source Value
... stop_reason_concept_id 0..1 code Stop Reason
... stop_reason_source_value 0..1 string Stop Reason Source Value
... stop_reason_source_concept_id 0..1 code Stop Reason Source

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. PayerPlanPeriod 0..* Base Payer Plan Period OMOP Table
Instances of this logical model are not marked to be the target of a Reference
... payer_plan_period_id 1..1 code Payer Plan Period Identifier
... person_id 1..1 Reference(Person OMOP Table) Person
... payer_plan_period_start_date 1..1 date Payer Plan Period Start Date
... payer_concept_id 0..1 code Payer
... payer_source_value 0..1 string Payer Source Value
... payer_source_concept_id 0..1 code Payer Source
... plan_concept_id 0..1 code Plan
... plan_source_value 0..1 string Plan Source Value
... plan_source_concept_id 0..1 code Plan Source
... sponsor_concept_id 0..1 code Sponsor
... sponsor_source_value 0..1 string Sponsor Source Value
... sponsor_source_concept_id 0..1 code Sponsor Source
... family_source_value 0..1 string Family Source Value
... stop_reason_concept_id 0..1 code Stop Reason
... stop_reason_source_value 0..1 string Stop Reason Source Value
... stop_reason_source_concept_id 0..1 code Stop Reason Source

doco Documentation for this format

This structure is derived from Base

Summary

Mandatory: 0 element(4 nested mandatory elements)

Structures

This structure refers to these other structures:

Maturity: 1

Differential View

This structure is derived from Base

NameFlagsCard.TypeDescription & Constraintsdoco
.. PayerPlanPeriod 0..* Base Payer Plan Period OMOP Table
Instances of this logical model are not marked to be the target of a Reference
... payer_plan_period_id 1..1 code Payer Plan Period Identifier
... person_id 1..1 Reference(Person OMOP Table) Person
... payer_plan_period_start_date 1..1 date Payer Plan Period Start Date
... payer_concept_id 0..1 code Payer
... payer_source_value 0..1 string Payer Source Value
... payer_source_concept_id 0..1 code Payer Source
... plan_concept_id 0..1 code Plan
... plan_source_value 0..1 string Plan Source Value
... plan_source_concept_id 0..1 code Plan Source
... sponsor_concept_id 0..1 code Sponsor
... sponsor_source_value 0..1 string Sponsor Source Value
... sponsor_source_concept_id 0..1 code Sponsor Source
... family_source_value 0..1 string Family Source Value
... stop_reason_concept_id 0..1 code Stop Reason
... stop_reason_source_value 0..1 string Stop Reason Source Value
... stop_reason_source_concept_id 0..1 code Stop Reason Source

doco Documentation for this format

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. PayerPlanPeriod 0..* Base Payer Plan Period OMOP Table
Instances of this logical model are not marked to be the target of a Reference
... payer_plan_period_id 1..1 code Payer Plan Period Identifier
... person_id 1..1 Reference(Person OMOP Table) Person
... payer_plan_period_start_date 1..1 date Payer Plan Period Start Date
... payer_concept_id 0..1 code Payer
... payer_source_value 0..1 string Payer Source Value
... payer_source_concept_id 0..1 code Payer Source
... plan_concept_id 0..1 code Plan
... plan_source_value 0..1 string Plan Source Value
... plan_source_concept_id 0..1 code Plan Source
... sponsor_concept_id 0..1 code Sponsor
... sponsor_source_value 0..1 string Sponsor Source Value
... sponsor_source_concept_id 0..1 code Sponsor Source
... family_source_value 0..1 string Family Source Value
... stop_reason_concept_id 0..1 code Stop Reason
... stop_reason_source_value 0..1 string Stop Reason Source Value
... stop_reason_source_concept_id 0..1 code Stop Reason Source

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. PayerPlanPeriod 0..* Base Payer Plan Period OMOP Table
Instances of this logical model are not marked to be the target of a Reference
... payer_plan_period_id 1..1 code Payer Plan Period Identifier
... person_id 1..1 Reference(Person OMOP Table) Person
... payer_plan_period_start_date 1..1 date Payer Plan Period Start Date
... payer_concept_id 0..1 code Payer
... payer_source_value 0..1 string Payer Source Value
... payer_source_concept_id 0..1 code Payer Source
... plan_concept_id 0..1 code Plan
... plan_source_value 0..1 string Plan Source Value
... plan_source_concept_id 0..1 code Plan Source
... sponsor_concept_id 0..1 code Sponsor
... sponsor_source_value 0..1 string Sponsor Source Value
... sponsor_source_concept_id 0..1 code Sponsor Source
... family_source_value 0..1 string Family Source Value
... stop_reason_concept_id 0..1 code Stop Reason
... stop_reason_source_value 0..1 string Stop Reason Source Value
... stop_reason_source_concept_id 0..1 code Stop Reason Source

doco Documentation for this format

This structure is derived from Base

Summary

Mandatory: 0 element(4 nested mandatory elements)

Structures

This structure refers to these other structures:

Maturity: 1

 

Other representations of profile: CSV, Excel