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: PayerPlanPeriod - Detailed Descriptions

Page standards status: Draft Maturity Level: 1

Definitions for the PayerPlanPeriod logical model.

Guidance on how to interpret the contents of this table can be found here

0. PayerPlanPeriod
Definition

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.

ShortPayer Plan Period OMOP Table
Logical ModelInstances of this logical model are not marked to be the target of a Reference
2. PayerPlanPeriod.payer-plan-period-id
Definition

Payer Plan Period Identifier

ShortPayer Plan Period Identifier
Control1..1
Typecode
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
4. PayerPlanPeriod.person-id
Definition

The Person covered by the Plan.

ShortPerson
Control1..1
TypeReference(Person OMOP Table)
6. PayerPlanPeriod.payer-plan-period-start-date
Definition

Start date of Plan coverage.

ShortPayer Plan Period Start Date
Control1..1
Typedate
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
8. PayerPlanPeriod.payer-plan-period-end-date
Definition

End date of Plan coverage.

ShortPayer Plan Period End Date
Control1..1
Typedate
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
10. PayerPlanPeriod.payer-concept-id
Definition

This field represents the organization who reimburses the provider which administers care to the Person.

ShortPayer
Control0..1
Typecode
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
12. PayerPlanPeriod.payer-source-value
Definition

This is the Payer as it appears in the source data.

ShortPayer Source Value
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
14. PayerPlanPeriod.payer-source-concept-id
Definition

Payer Source

ShortPayer Source
Control0..1
Typecode
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
16. PayerPlanPeriod.plan-concept-id
Definition

This field represents the specific health benefit Plan the Person is enrolled in.

ShortPlan
Control0..1
Typecode
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
18. PayerPlanPeriod.plan-source-value
Definition

This is the health benefit Plan of the Person as it appears in the source data.

ShortPlan Source Value
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
20. PayerPlanPeriod.plan-source-concept-id
Definition

Plan Source

ShortPlan Source
Control0..1
Typecode
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
22. PayerPlanPeriod.sponsor-concept-id
Definition

This field represents the sponsor of the Plan who finances the Plan. This includes self-insured, small group health plan and large group health plan.

ShortSponsor
Control0..1
Typecode
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
24. PayerPlanPeriod.sponsor-source-value
Definition

The Plan sponsor as it appears in the source data.

ShortSponsor Source Value
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
26. PayerPlanPeriod.sponsor-source-concept-id
Definition

Sponsor Source

ShortSponsor Source
Control0..1
Typecode
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
28. PayerPlanPeriod.family-source-value
Definition

The common identifier for all people (often a family) that covered by the same policy.

ShortFamily Source Value
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
30. PayerPlanPeriod.stop-reason-concept-id
Definition

This field represents the reason the Person left the Plan, if known.

ShortStop Reason
Control0..1
Typecode
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
32. PayerPlanPeriod.stop-reason-source-value
Definition

The Plan stop reason as it appears in the source data.

ShortStop Reason Source Value
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
34. PayerPlanPeriod.stop-reason-source-concept-id
Definition

Stop Reason Source

ShortStop Reason Source
Control0..1
Typecode
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension

Guidance on how to interpret the contents of this table can be found here

0. PayerPlanPeriod
Definition

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.


Base definition for all types defined in FHIR type system.

ShortPayer Plan Period OMOP TableBase for all types and resources
Control0..*
Is Modifierfalse
Logical ModelInstances of this logical model are not marked to be the target of a Reference
2. PayerPlanPeriod.payer-plan-period-id
Definition

Payer Plan Period Identifier

ShortPayer Plan Period Identifier
Control1..1
Typecode
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
4. PayerPlanPeriod.person-id
Definition

The Person covered by the Plan.

ShortPerson
Control1..1
TypeReference(Person OMOP Table)
6. PayerPlanPeriod.payer-plan-period-start-date
Definition

Start date of Plan coverage.

ShortPayer Plan Period Start Date
Control1..1
Typedate
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
8. PayerPlanPeriod.payer-plan-period-end-date
Definition

End date of Plan coverage.

ShortPayer Plan Period End Date
Control1..1
Typedate
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
10. PayerPlanPeriod.payer-concept-id
Definition

This field represents the organization who reimburses the provider which administers care to the Person.

ShortPayer
Control0..1
Typecode
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
12. PayerPlanPeriod.payer-source-value
Definition

This is the Payer as it appears in the source data.

ShortPayer Source Value
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
14. PayerPlanPeriod.payer-source-concept-id
Definition

Payer Source

ShortPayer Source
Control0..1
Typecode
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
16. PayerPlanPeriod.plan-concept-id
Definition

This field represents the specific health benefit Plan the Person is enrolled in.

ShortPlan
Control0..1
Typecode
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
18. PayerPlanPeriod.plan-source-value
Definition

This is the health benefit Plan of the Person as it appears in the source data.

ShortPlan Source Value
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
20. PayerPlanPeriod.plan-source-concept-id
Definition

Plan Source

ShortPlan Source
Control0..1
Typecode
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
22. PayerPlanPeriod.sponsor-concept-id
Definition

This field represents the sponsor of the Plan who finances the Plan. This includes self-insured, small group health plan and large group health plan.

ShortSponsor
Control0..1
Typecode
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
24. PayerPlanPeriod.sponsor-source-value
Definition

The Plan sponsor as it appears in the source data.

ShortSponsor Source Value
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
26. PayerPlanPeriod.sponsor-source-concept-id
Definition

Sponsor Source

ShortSponsor Source
Control0..1
Typecode
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
28. PayerPlanPeriod.family-source-value
Definition

The common identifier for all people (often a family) that covered by the same policy.

ShortFamily Source Value
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
30. PayerPlanPeriod.stop-reason-concept-id
Definition

This field represents the reason the Person left the Plan, if known.

ShortStop Reason
Control0..1
Typecode
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
32. PayerPlanPeriod.stop-reason-source-value
Definition

The Plan stop reason as it appears in the source data.

ShortStop Reason Source Value
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
34. PayerPlanPeriod.stop-reason-source-concept-id
Definition

Stop Reason Source

ShortStop Reason Source
Control0..1
Typecode
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension

Guidance on how to interpret the contents of this table can be found here

0. PayerPlanPeriod
Definition

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.

ShortPayer Plan Period OMOP Table
Control0..*
Is Modifierfalse
Logical ModelInstances of this logical model are not marked to be the target of a Reference
2. PayerPlanPeriod.payer-plan-period-id
Definition

Payer Plan Period Identifier

ShortPayer Plan Period Identifier
Control1..1
Typecode
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
4. PayerPlanPeriod.person-id
Definition

The Person covered by the Plan.

ShortPerson
Control1..1
TypeReference(Person OMOP Table)
6. PayerPlanPeriod.payer-plan-period-start-date
Definition

Start date of Plan coverage.

ShortPayer Plan Period Start Date
Control1..1
Typedate
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
8. PayerPlanPeriod.payer-plan-period-end-date
Definition

End date of Plan coverage.

ShortPayer Plan Period End Date
Control1..1
Typedate
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
10. PayerPlanPeriod.payer-concept-id
Definition

This field represents the organization who reimburses the provider which administers care to the Person.

ShortPayer
Control0..1
Typecode
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
12. PayerPlanPeriod.payer-source-value
Definition

This is the Payer as it appears in the source data.

ShortPayer Source Value
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
14. PayerPlanPeriod.payer-source-concept-id
Definition

Payer Source

ShortPayer Source
Control0..1
Typecode
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
16. PayerPlanPeriod.plan-concept-id
Definition

This field represents the specific health benefit Plan the Person is enrolled in.

ShortPlan
Control0..1
Typecode
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
18. PayerPlanPeriod.plan-source-value
Definition

This is the health benefit Plan of the Person as it appears in the source data.

ShortPlan Source Value
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
20. PayerPlanPeriod.plan-source-concept-id
Definition

Plan Source

ShortPlan Source
Control0..1
Typecode
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
22. PayerPlanPeriod.sponsor-concept-id
Definition

This field represents the sponsor of the Plan who finances the Plan. This includes self-insured, small group health plan and large group health plan.

ShortSponsor
Control0..1
Typecode
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
24. PayerPlanPeriod.sponsor-source-value
Definition

The Plan sponsor as it appears in the source data.

ShortSponsor Source Value
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
26. PayerPlanPeriod.sponsor-source-concept-id
Definition

Sponsor Source

ShortSponsor Source
Control0..1
Typecode
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
28. PayerPlanPeriod.family-source-value
Definition

The common identifier for all people (often a family) that covered by the same policy.

ShortFamily Source Value
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
30. PayerPlanPeriod.stop-reason-concept-id
Definition

This field represents the reason the Person left the Plan, if known.

ShortStop Reason
Control0..1
Typecode
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
32. PayerPlanPeriod.stop-reason-source-value
Definition

The Plan stop reason as it appears in the source data.

ShortStop Reason Source Value
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
34. PayerPlanPeriod.stop-reason-source-concept-id
Definition

Stop Reason Source

ShortStop Reason Source
Control0..1
Typecode
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension