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 2.0.0-ballot 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
| Page standards status: Trial-use | Maturity Level: 2 |
XML representation of the PayerPlanPeriod logical model.
<StructureDefinition xmlns="http://hl7.org/fhir">
<id value="PayerPlanPeriod"/>
<language value="en"/>
<text>
<status value="extensions"/>
<div xmlns="http://www.w3.org/1999/xhtml"><p class="res-header-id"><b>Generated Narrative: StructureDefinition PayerPlanPeriod</b></p><table border="0" cellpadding="0" cellspacing="0" class="xhtTableBorder0"><tr class="xhtRowBorder1"><th scope="col" style="" class="hierarchy xhtCellBorder0"><a href="https://build.fhir.org/ig/FHIR/ig-guidance/readingIgs.html#table-views" title="The logical name of the element">Name</a></th><th scope="col" style="" class="hierarchy xhtCellBorder0"><a href="https://build.fhir.org/ig/FHIR/ig-guidance/readingIgs.html#table-views" title="Information about the use of the element">Flags</a></th><th scope="col" style="" class="hierarchy xhtCellBorder0"><a href="https://build.fhir.org/ig/FHIR/ig-guidance/readingIgs.html#table-views" title="Minimum and Maximum # of times the element can appear in the instance">Card.</a></th><th scope="col" style="; width: 100px" class="hierarchy xhtCellBorder0"><a href="https://build.fhir.org/ig/FHIR/ig-guidance/readingIgs.html#table-views" title="Reference to the type of the element">Type</a></th><th scope="col" style="" class="hierarchy xhtCellBorder0"><a href="https://build.fhir.org/ig/FHIR/ig-guidance/readingIgs.html#table-views" title="Additional information about the element">Description & Constraints</a><span style="float: right"><a href="https://build.fhir.org/ig/FHIR/ig-guidance/readingIgs.html#table-views" title="Legend for this format"><img src="data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABAAAAAQCAYAAAAf8/9hAAAABmJLR0QA/wD/AP+gvaeTAAAACXBIWXMAAAsTAAALEwEAmpwYAAAAB3RJTUUH3goXBCwdPqAP0wAAAldJREFUOMuNk0tIlFEYhp9z/vE2jHkhxXA0zJCMitrUQlq4lnSltEqCFhFG2MJFhIvIFpkEWaTQqjaWZRkp0g26URZkTpbaaOJkDqk10szoODP//7XIMUe0elcfnPd9zsfLOYplGrpRwZaqTtw3K7PtGem7Q6FoidbGgqHVy/HRb669R+56zx7eRV1L31JGxYbBtjKK93cxeqfyQHbehkZbUkK20goELEuIzEd+dHS+qz/Y8PTSif0FnGkbiwcAjHaU1+QWOptFiyCLp/LnKptpqIuXHx6rbR26kJcBX3yLgBfnd7CxwJmflpP2wUg0HIAoUUpZBmKzELGWcN8nAr6Gpu7tLU/CkwAaoKTWRSQyt89Q8w6J+oVQkKnBoblH7V0PPvUOvDYXfopE/SJmALsxnVm6LbkotrUtNowMeIrVrBcBpaMmdS0j9df7abpSuy7HWehwJdt1lhVwi/J58U5beXGAF6c3UXLycw1wdFklArBn87xdh0ZsZtArghBdAA3+OEDVubG4UEzP6x1FOWneHh2VDAHBAt80IbdXDcesNoCvs3E5AFyNSU5nbrDPZpcUEQQTFZiEVx+51fxMhhyJEAgvlriadIJZZksRuwBYMOPBbO3hePVVqgEJhFeUuFLhIPkRP6BQLIBrmMenujm/3g4zc398awIe90Zb5A1vREALqneMcYgP/xVQWlG+Ncu5vgwwlaUNx+3799rfe96u9K0JSDXcOzOTJg4B6IgmXfsygc7/Bvg9g9E58/cDVmGIBOP/zT8Bz1zqWqpbXIsd0O9hajXfL6u4BaOS6SeWAAAAAElFTkSuQmCC" alt="doco" style="background-color: inherit"/></a></span></th></tr><tr class="xhtRowBorder0 xhtRowEven"><td style="background-image: url(tbl_bck1.png)" class="hierarchy xhtCellBorder0 xhtCellNoWrap"><img src="tbl_spacer.png" alt="" style="background-color: inherit" class="hierarchy"/><img src="icon_element.gif" alt="" style="background-color: white; background-color: inherit" title="Element" class="hierarchy"/> <a href="StructureDefinition-PayerPlanPeriod-definitions.html#PayerPlanPeriod" title="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.">PayerPlanPeriod</a><a name="PayerPlanPeriod"> </a></td><td style="" class="hierarchy xhtCellBorder0"/><td style="" class="hierarchy xhtCellBorder0"><span class="xhtPieceDeEmphasized">0</span><span class="xhtPieceDeEmphasized">..</span><span class="xhtPieceDeEmphasized">*</span></td><td style="" class="hierarchy xhtCellBorder0"><a href="http://hl7.org/fhir/R5/types.html#Base">Base</a></td><td style="" class="hierarchy xhtCellBorder0">Payer Plan Period OMOP Table<br/><span class="xhtPieceBold">Instances of this type can be the target of a Reference</span></td></tr>
<tr class="xhtRowBorder0 xhtRowOdd"><td style="background-image: url(tbl_bck10.png)" class="hierarchy xhtCellBorder0 xhtCellNoWrap"><img src="tbl_spacer.png" alt="" style="background-color: inherit" class="hierarchy"/><img src="tbl_vjoin.png" alt="" style="background-color: inherit" class="hierarchy"/><img src="icon_primitive.png" alt="" style="background-color: #F7F7F7; background-color: inherit" title="Primitive Data Type" class="hierarchy"/> <span style="position: absolute; width: 1px; height: 1px; padding: 0; margin: -1px; overflow: hidden; clip: rect(0, 0, 0, 0); white-space: nowrap; border: 0" class="sr-only">PayerPlanPeriod.</span><a href="StructureDefinition-PayerPlanPeriod-definitions.html#PayerPlanPeriod.payer-plan-period-id" title="Payer Plan Period Identifier">payer_plan_period_id</a><a name="PayerPlanPeriod.payer-plan-period-id"> </a></td><td style="" class="hierarchy xhtCellBorder0"/><td style="" class="hierarchy xhtCellBorder0">1..1</td><td style="" class="hierarchy xhtCellBorder0"><a href="http://hl7.org/fhir/R5/datatypes.html#code">code</a></td><td style="" class="hierarchy xhtCellBorder0">Payer Plan Period Identifier</td></tr>
<tr class="xhtRowBorder0 xhtRowEven"><td style="background-image: url(tbl_bck10.png)" class="hierarchy xhtCellBorder0 xhtCellNoWrap"><img src="tbl_spacer.png" alt="" style="background-color: inherit" class="hierarchy"/><img src="tbl_vjoin.png" alt="" style="background-color: inherit" class="hierarchy"/><img src="icon_primitive.png" alt="" style="background-color: white; background-color: inherit" title="Primitive Data Type" class="hierarchy"/> <span style="position: absolute; width: 1px; height: 1px; padding: 0; margin: -1px; overflow: hidden; clip: rect(0, 0, 0, 0); white-space: nowrap; border: 0" class="sr-only">PayerPlanPeriod.</span><a href="StructureDefinition-PayerPlanPeriod-definitions.html#PayerPlanPeriod.person-id" title="The Person covered by the Plan.">person_id</a><a name="PayerPlanPeriod.person-id"> </a></td><td style="" class="hierarchy xhtCellBorder0"/><td style="" class="hierarchy xhtCellBorder0">1..1</td><td style="" class="hierarchy xhtCellBorder0"><a href="http://hl7.org/fhir/R5/datatypes.html#integer">integer</a></td><td style="" class="hierarchy xhtCellBorder0">Person</td></tr>
<tr class="xhtRowBorder0 xhtRowOdd"><td style="background-image: url(tbl_bck10.png)" class="hierarchy xhtCellBorder0 xhtCellNoWrap"><img src="tbl_spacer.png" alt="" style="background-color: inherit" class="hierarchy"/><img src="tbl_vjoin.png" alt="" style="background-color: inherit" class="hierarchy"/><img src="icon_primitive.png" alt="" style="background-color: #F7F7F7; background-color: inherit" title="Primitive Data Type" class="hierarchy"/> <span style="position: absolute; width: 1px; height: 1px; padding: 0; margin: -1px; overflow: hidden; clip: rect(0, 0, 0, 0); white-space: nowrap; border: 0" class="sr-only">PayerPlanPeriod.</span><a href="StructureDefinition-PayerPlanPeriod-definitions.html#PayerPlanPeriod.payer-plan-period-start-date" title="Start date of Plan coverage.">payer_plan_period_start_date</a><a name="PayerPlanPeriod.payer-plan-period-start-date"> </a></td><td style="" class="hierarchy xhtCellBorder0"/><td style="" class="hierarchy xhtCellBorder0">1..1</td><td style="" class="hierarchy xhtCellBorder0"><a href="http://hl7.org/fhir/R5/datatypes.html#date">date</a></td><td style="" class="hierarchy xhtCellBorder0">Payer Plan Period Start Date</td></tr>
<tr class="xhtRowBorder0 xhtRowEven"><td style="background-image: url(tbl_bck10.png)" class="hierarchy xhtCellBorder0 xhtCellNoWrap"><img src="tbl_spacer.png" alt="" style="background-color: inherit" class="hierarchy"/><img src="tbl_vjoin.png" alt="" style="background-color: inherit" class="hierarchy"/><img src="icon_primitive.png" alt="" style="background-color: white; background-color: inherit" title="Primitive Data Type" class="hierarchy"/> <span style="position: absolute; width: 1px; height: 1px; padding: 0; margin: -1px; overflow: hidden; clip: rect(0, 0, 0, 0); white-space: nowrap; border: 0" class="sr-only">PayerPlanPeriod.</span><a href="StructureDefinition-PayerPlanPeriod-definitions.html#PayerPlanPeriod.payer-plan-period-end-date" title="End date of Plan coverage.">payer_plan_period_end_date</a><a name="PayerPlanPeriod.payer-plan-period-end-date"> </a></td><td style="" class="hierarchy xhtCellBorder0"/><td style="" class="hierarchy xhtCellBorder0">1..1</td><td style="" class="hierarchy xhtCellBorder0"><a href="http://hl7.org/fhir/R5/datatypes.html#date">date</a></td><td style="" class="hierarchy xhtCellBorder0">Payer Plan Period End Date</td></tr>
<tr class="xhtRowBorder0 xhtRowOdd"><td style="background-image: url(tbl_bck10.png)" class="hierarchy xhtCellBorder0 xhtCellNoWrap"><img src="tbl_spacer.png" alt="" style="background-color: inherit" class="hierarchy"/><img src="tbl_vjoin.png" alt="" style="background-color: inherit" class="hierarchy"/><img src="icon_primitive.png" alt="" style="background-color: #F7F7F7; background-color: inherit" title="Primitive Data Type" class="hierarchy"/> <span style="position: absolute; width: 1px; height: 1px; padding: 0; margin: -1px; overflow: hidden; clip: rect(0, 0, 0, 0); white-space: nowrap; border: 0" class="sr-only">PayerPlanPeriod.</span><a href="StructureDefinition-PayerPlanPeriod-definitions.html#PayerPlanPeriod.payer-concept-id" title="This field represents the organization who reimburses the provider which administers care to the Person.">payer_concept_id</a><a name="PayerPlanPeriod.payer-concept-id"> </a></td><td style="" class="hierarchy xhtCellBorder0"/><td style="" class="hierarchy xhtCellBorder0">0..1</td><td style="" class="hierarchy xhtCellBorder0"><a href="http://hl7.org/fhir/R5/datatypes.html#code">code</a></td><td style="" class="hierarchy xhtCellBorder0">Payer</td></tr>
<tr class="xhtRowBorder0 xhtRowEven"><td style="background-image: url(tbl_bck10.png)" class="hierarchy xhtCellBorder0 xhtCellNoWrap"><img src="tbl_spacer.png" alt="" style="background-color: inherit" class="hierarchy"/><img src="tbl_vjoin.png" alt="" style="background-color: inherit" class="hierarchy"/><img src="icon_primitive.png" alt="" style="background-color: white; background-color: inherit" title="Primitive Data Type" class="hierarchy"/> <span style="position: absolute; width: 1px; height: 1px; padding: 0; margin: -1px; overflow: hidden; clip: rect(0, 0, 0, 0); white-space: nowrap; border: 0" class="sr-only">PayerPlanPeriod.</span><a href="StructureDefinition-PayerPlanPeriod-definitions.html#PayerPlanPeriod.payer-source-value" title="This is the Payer as it appears in the source data.">payer_source_value</a><a name="PayerPlanPeriod.payer-source-value"> </a></td><td style="" class="hierarchy xhtCellBorder0"/><td style="" class="hierarchy xhtCellBorder0">0..1</td><td style="" class="hierarchy xhtCellBorder0"><a href="http://hl7.org/fhir/R5/datatypes.html#string">string</a></td><td style="" class="hierarchy xhtCellBorder0">Payer Source Value</td></tr>
<tr class="xhtRowBorder0 xhtRowOdd"><td style="background-image: url(tbl_bck10.png)" class="hierarchy xhtCellBorder0 xhtCellNoWrap"><img src="tbl_spacer.png" alt="" style="background-color: inherit" class="hierarchy"/><img src="tbl_vjoin.png" alt="" style="background-color: inherit" class="hierarchy"/><img src="icon_primitive.png" alt="" style="background-color: #F7F7F7; background-color: inherit" title="Primitive Data Type" class="hierarchy"/> <span style="position: absolute; width: 1px; height: 1px; padding: 0; margin: -1px; overflow: hidden; clip: rect(0, 0, 0, 0); white-space: nowrap; border: 0" class="sr-only">PayerPlanPeriod.</span><a href="StructureDefinition-PayerPlanPeriod-definitions.html#PayerPlanPeriod.payer-source-concept-id" title="Payer Source">payer_source_concept_id</a><a name="PayerPlanPeriod.payer-source-concept-id"> </a></td><td style="" class="hierarchy xhtCellBorder0"/><td style="" class="hierarchy xhtCellBorder0">0..1</td><td style="" class="hierarchy xhtCellBorder0"><a href="http://hl7.org/fhir/R5/datatypes.html#code">code</a></td><td style="" class="hierarchy xhtCellBorder0">Payer Source</td></tr>
<tr class="xhtRowBorder0 xhtRowEven"><td style="background-image: url(tbl_bck10.png)" class="hierarchy xhtCellBorder0 xhtCellNoWrap"><img src="tbl_spacer.png" alt="" style="background-color: inherit" class="hierarchy"/><img src="tbl_vjoin.png" alt="" style="background-color: inherit" class="hierarchy"/><img src="icon_primitive.png" alt="" style="background-color: white; background-color: inherit" title="Primitive Data Type" class="hierarchy"/> <span style="position: absolute; width: 1px; height: 1px; padding: 0; margin: -1px; overflow: hidden; clip: rect(0, 0, 0, 0); white-space: nowrap; border: 0" class="sr-only">PayerPlanPeriod.</span><a href="StructureDefinition-PayerPlanPeriod-definitions.html#PayerPlanPeriod.plan-concept-id" title="This field represents the specific health benefit Plan the Person is enrolled in.">plan_concept_id</a><a name="PayerPlanPeriod.plan-concept-id"> </a></td><td style="" class="hierarchy xhtCellBorder0"/><td style="" class="hierarchy xhtCellBorder0">0..1</td><td style="" class="hierarchy xhtCellBorder0"><a href="http://hl7.org/fhir/R5/datatypes.html#code">code</a></td><td style="" class="hierarchy xhtCellBorder0">Plan</td></tr>
<tr class="xhtRowBorder0 xhtRowOdd"><td style="background-image: url(tbl_bck10.png)" class="hierarchy xhtCellBorder0 xhtCellNoWrap"><img src="tbl_spacer.png" alt="" style="background-color: inherit" class="hierarchy"/><img src="tbl_vjoin.png" alt="" style="background-color: inherit" class="hierarchy"/><img src="icon_primitive.png" alt="" style="background-color: #F7F7F7; background-color: inherit" title="Primitive Data Type" class="hierarchy"/> <span style="position: absolute; width: 1px; height: 1px; padding: 0; margin: -1px; overflow: hidden; clip: rect(0, 0, 0, 0); white-space: nowrap; border: 0" class="sr-only">PayerPlanPeriod.</span><a href="StructureDefinition-PayerPlanPeriod-definitions.html#PayerPlanPeriod.plan-source-value" title="This is the health benefit Plan of the Person as it appears in the source data.">plan_source_value</a><a name="PayerPlanPeriod.plan-source-value"> </a></td><td style="" class="hierarchy xhtCellBorder0"/><td style="" class="hierarchy xhtCellBorder0">0..1</td><td style="" class="hierarchy xhtCellBorder0"><a href="http://hl7.org/fhir/R5/datatypes.html#string">string</a></td><td style="" class="hierarchy xhtCellBorder0">Plan Source Value</td></tr>
<tr class="xhtRowBorder0 xhtRowEven"><td style="background-image: url(tbl_bck10.png)" class="hierarchy xhtCellBorder0 xhtCellNoWrap"><img src="tbl_spacer.png" alt="" style="background-color: inherit" class="hierarchy"/><img src="tbl_vjoin.png" alt="" style="background-color: inherit" class="hierarchy"/><img src="icon_primitive.png" alt="" style="background-color: white; background-color: inherit" title="Primitive Data Type" class="hierarchy"/> <span style="position: absolute; width: 1px; height: 1px; padding: 0; margin: -1px; overflow: hidden; clip: rect(0, 0, 0, 0); white-space: nowrap; border: 0" class="sr-only">PayerPlanPeriod.</span><a href="StructureDefinition-PayerPlanPeriod-definitions.html#PayerPlanPeriod.plan-source-concept-id" title="Plan Source">plan_source_concept_id</a><a name="PayerPlanPeriod.plan-source-concept-id"> </a></td><td style="" class="hierarchy xhtCellBorder0"/><td style="" class="hierarchy xhtCellBorder0">0..1</td><td style="" class="hierarchy xhtCellBorder0"><a href="http://hl7.org/fhir/R5/datatypes.html#code">code</a></td><td style="" class="hierarchy xhtCellBorder0">Plan Source</td></tr>
<tr class="xhtRowBorder0 xhtRowOdd"><td style="background-image: url(tbl_bck10.png)" class="hierarchy xhtCellBorder0 xhtCellNoWrap"><img src="tbl_spacer.png" alt="" style="background-color: inherit" class="hierarchy"/><img src="tbl_vjoin.png" alt="" style="background-color: inherit" class="hierarchy"/><img src="icon_primitive.png" alt="" style="background-color: #F7F7F7; background-color: inherit" title="Primitive Data Type" class="hierarchy"/> <span style="position: absolute; width: 1px; height: 1px; padding: 0; margin: -1px; overflow: hidden; clip: rect(0, 0, 0, 0); white-space: nowrap; border: 0" class="sr-only">PayerPlanPeriod.</span><a href="StructureDefinition-PayerPlanPeriod-definitions.html#PayerPlanPeriod.sponsor-concept-id" title="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.">sponsor_concept_id</a><a name="PayerPlanPeriod.sponsor-concept-id"> </a></td><td style="" class="hierarchy xhtCellBorder0"/><td style="" class="hierarchy xhtCellBorder0">0..1</td><td style="" class="hierarchy xhtCellBorder0"><a href="http://hl7.org/fhir/R5/datatypes.html#code">code</a></td><td style="" class="hierarchy xhtCellBorder0">Sponsor</td></tr>
<tr class="xhtRowBorder0 xhtRowEven"><td style="background-image: url(tbl_bck10.png)" class="hierarchy xhtCellBorder0 xhtCellNoWrap"><img src="tbl_spacer.png" alt="" style="background-color: inherit" class="hierarchy"/><img src="tbl_vjoin.png" alt="" style="background-color: inherit" class="hierarchy"/><img src="icon_primitive.png" alt="" style="background-color: white; background-color: inherit" title="Primitive Data Type" class="hierarchy"/> <span style="position: absolute; width: 1px; height: 1px; padding: 0; margin: -1px; overflow: hidden; clip: rect(0, 0, 0, 0); white-space: nowrap; border: 0" class="sr-only">PayerPlanPeriod.</span><a href="StructureDefinition-PayerPlanPeriod-definitions.html#PayerPlanPeriod.sponsor-source-value" title="The Plan sponsor as it appears in the source data.">sponsor_source_value</a><a name="PayerPlanPeriod.sponsor-source-value"> </a></td><td style="" class="hierarchy xhtCellBorder0"/><td style="" class="hierarchy xhtCellBorder0">0..1</td><td style="" class="hierarchy xhtCellBorder0"><a href="http://hl7.org/fhir/R5/datatypes.html#string">string</a></td><td style="" class="hierarchy xhtCellBorder0">Sponsor Source Value</td></tr>
<tr class="xhtRowBorder0 xhtRowOdd"><td style="background-image: url(tbl_bck10.png)" class="hierarchy xhtCellBorder0 xhtCellNoWrap"><img src="tbl_spacer.png" alt="" style="background-color: inherit" class="hierarchy"/><img src="tbl_vjoin.png" alt="" style="background-color: inherit" class="hierarchy"/><img src="icon_primitive.png" alt="" style="background-color: #F7F7F7; background-color: inherit" title="Primitive Data Type" class="hierarchy"/> <span style="position: absolute; width: 1px; height: 1px; padding: 0; margin: -1px; overflow: hidden; clip: rect(0, 0, 0, 0); white-space: nowrap; border: 0" class="sr-only">PayerPlanPeriod.</span><a href="StructureDefinition-PayerPlanPeriod-definitions.html#PayerPlanPeriod.sponsor-source-concept-id" title="Sponsor Source">sponsor_source_concept_id</a><a name="PayerPlanPeriod.sponsor-source-concept-id"> </a></td><td style="" class="hierarchy xhtCellBorder0"/><td style="" class="hierarchy xhtCellBorder0">0..1</td><td style="" class="hierarchy xhtCellBorder0"><a href="http://hl7.org/fhir/R5/datatypes.html#code">code</a></td><td style="" class="hierarchy xhtCellBorder0">Sponsor Source</td></tr>
<tr class="xhtRowBorder0 xhtRowEven"><td style="background-image: url(tbl_bck10.png)" class="hierarchy xhtCellBorder0 xhtCellNoWrap"><img src="tbl_spacer.png" alt="" style="background-color: inherit" class="hierarchy"/><img src="tbl_vjoin.png" alt="" style="background-color: inherit" class="hierarchy"/><img src="icon_primitive.png" alt="" style="background-color: white; background-color: inherit" title="Primitive Data Type" class="hierarchy"/> <span style="position: absolute; width: 1px; height: 1px; padding: 0; margin: -1px; overflow: hidden; clip: rect(0, 0, 0, 0); white-space: nowrap; border: 0" class="sr-only">PayerPlanPeriod.</span><a href="StructureDefinition-PayerPlanPeriod-definitions.html#PayerPlanPeriod.family-source-value" title="The common identifier for all people (often a family) that covered by the same policy.">family_source_value</a><a name="PayerPlanPeriod.family-source-value"> </a></td><td style="" class="hierarchy xhtCellBorder0"/><td style="" class="hierarchy xhtCellBorder0">0..1</td><td style="" class="hierarchy xhtCellBorder0"><a href="http://hl7.org/fhir/R5/datatypes.html#string">string</a></td><td style="" class="hierarchy xhtCellBorder0">Family Source Value</td></tr>
<tr class="xhtRowBorder0 xhtRowOdd"><td style="background-image: url(tbl_bck10.png)" class="hierarchy xhtCellBorder0 xhtCellNoWrap"><img src="tbl_spacer.png" alt="" style="background-color: inherit" class="hierarchy"/><img src="tbl_vjoin.png" alt="" style="background-color: inherit" class="hierarchy"/><img src="icon_primitive.png" alt="" style="background-color: #F7F7F7; background-color: inherit" title="Primitive Data Type" class="hierarchy"/> <span style="position: absolute; width: 1px; height: 1px; padding: 0; margin: -1px; overflow: hidden; clip: rect(0, 0, 0, 0); white-space: nowrap; border: 0" class="sr-only">PayerPlanPeriod.</span><a href="StructureDefinition-PayerPlanPeriod-definitions.html#PayerPlanPeriod.stop-reason-concept-id" title="This field represents the reason the Person left the Plan, if known.">stop_reason_concept_id</a><a name="PayerPlanPeriod.stop-reason-concept-id"> </a></td><td style="" class="hierarchy xhtCellBorder0"/><td style="" class="hierarchy xhtCellBorder0">0..1</td><td style="" class="hierarchy xhtCellBorder0"><a href="http://hl7.org/fhir/R5/datatypes.html#code">code</a></td><td style="" class="hierarchy xhtCellBorder0">Stop Reason</td></tr>
<tr class="xhtRowBorder0 xhtRowEven"><td style="background-image: url(tbl_bck10.png)" class="hierarchy xhtCellBorder0 xhtCellNoWrap"><img src="tbl_spacer.png" alt="" style="background-color: inherit" class="hierarchy"/><img src="tbl_vjoin.png" alt="" style="background-color: inherit" class="hierarchy"/><img src="icon_primitive.png" alt="" style="background-color: white; background-color: inherit" title="Primitive Data Type" class="hierarchy"/> <span style="position: absolute; width: 1px; height: 1px; padding: 0; margin: -1px; overflow: hidden; clip: rect(0, 0, 0, 0); white-space: nowrap; border: 0" class="sr-only">PayerPlanPeriod.</span><a href="StructureDefinition-PayerPlanPeriod-definitions.html#PayerPlanPeriod.stop-reason-source-value" title="The Plan stop reason as it appears in the source data.">stop_reason_source_value</a><a name="PayerPlanPeriod.stop-reason-source-value"> </a></td><td style="" class="hierarchy xhtCellBorder0"/><td style="" class="hierarchy xhtCellBorder0">0..1</td><td style="" class="hierarchy xhtCellBorder0"><a href="http://hl7.org/fhir/R5/datatypes.html#string">string</a></td><td style="" class="hierarchy xhtCellBorder0">Stop Reason Source Value</td></tr>
<tr class="xhtRowBorder0 xhtRowOdd"><td style="background-image: url(tbl_bck00.png)" class="hierarchy xhtCellBorder0 xhtCellNoWrap"><img src="tbl_spacer.png" alt="" style="background-color: inherit" class="hierarchy"/><img src="tbl_vjoin_end.png" alt="" style="background-color: inherit" class="hierarchy"/><img src="icon_primitive.png" alt="" style="background-color: #F7F7F7; background-color: inherit" title="Primitive Data Type" class="hierarchy"/> <span style="position: absolute; width: 1px; height: 1px; padding: 0; margin: -1px; overflow: hidden; clip: rect(0, 0, 0, 0); white-space: nowrap; border: 0" class="sr-only">PayerPlanPeriod.</span><a href="StructureDefinition-PayerPlanPeriod-definitions.html#PayerPlanPeriod.stop-reason-source-concept-id" title="Stop Reason Source">stop_reason_source_concept_id</a><a name="PayerPlanPeriod.stop-reason-source-concept-id"> </a></td><td style="" class="hierarchy xhtCellBorder0"/><td style="" class="hierarchy xhtCellBorder0">0..1</td><td style="" class="hierarchy xhtCellBorder0"><a href="http://hl7.org/fhir/R5/datatypes.html#code">code</a></td><td style="" class="hierarchy xhtCellBorder0">Stop Reason Source</td></tr>
<tr><td colspan="5" class="hierarchy"><br/><a href="https://build.fhir.org/ig/FHIR/ig-guidance/readingIgs.html#table-views" title="Legend for this format"><img src="data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABAAAAAQCAYAAAAf8/9hAAAABmJLR0QA/wD/AP+gvaeTAAAACXBIWXMAAAsTAAALEwEAmpwYAAAAB3RJTUUH3goXBCwdPqAP0wAAAldJREFUOMuNk0tIlFEYhp9z/vE2jHkhxXA0zJCMitrUQlq4lnSltEqCFhFG2MJFhIvIFpkEWaTQqjaWZRkp0g26URZkTpbaaOJkDqk10szoODP//7XIMUe0elcfnPd9zsfLOYplGrpRwZaqTtw3K7PtGem7Q6FoidbGgqHVy/HRb669R+56zx7eRV1L31JGxYbBtjKK93cxeqfyQHbehkZbUkK20goELEuIzEd+dHS+qz/Y8PTSif0FnGkbiwcAjHaU1+QWOptFiyCLp/LnKptpqIuXHx6rbR26kJcBX3yLgBfnd7CxwJmflpP2wUg0HIAoUUpZBmKzELGWcN8nAr6Gpu7tLU/CkwAaoKTWRSQyt89Q8w6J+oVQkKnBoblH7V0PPvUOvDYXfopE/SJmALsxnVm6LbkotrUtNowMeIrVrBcBpaMmdS0j9df7abpSuy7HWehwJdt1lhVwi/J58U5beXGAF6c3UXLycw1wdFklArBn87xdh0ZsZtArghBdAA3+OEDVubG4UEzP6x1FOWneHh2VDAHBAt80IbdXDcesNoCvs3E5AFyNSU5nbrDPZpcUEQQTFZiEVx+51fxMhhyJEAgvlriadIJZZksRuwBYMOPBbO3hePVVqgEJhFeUuFLhIPkRP6BQLIBrmMenujm/3g4zc398awIe90Zb5A1vREALqneMcYgP/xVQWlG+Ncu5vgwwlaUNx+3799rfe96u9K0JSDXcOzOTJg4B6IgmXfsygc7/Bvg9g9E58/cDVmGIBOP/zT8Bz1zqWqpbXIsd0O9hajXfL6u4BaOS6SeWAAAAAElFTkSuQmCC" alt="doco" style="background-color: inherit"/> Documentation for this format</a></td></tr></table></div>
</text>
<extension
url="http://hl7.org/fhir/StructureDefinition/structuredefinition-type-characteristics">
<valueCode value="can-be-target"/>
</extension>
<extension
url="http://hl7.org/fhir/StructureDefinition/structuredefinition-wg">
<valueCode value="brr"/>
</extension>
<extension
url="http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm">
<valueInteger value="2">
<extension
url="http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom">
<valueCanonical
value="http://hl7.org/fhir/uv/omop/ImplementationGuide/hl7.fhir.uv.omop"/>
</extension>
</valueInteger>
</extension>
<extension
url="http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status">
<valueCode value="trial-use">
<extension
url="http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom">
<valueCanonical
value="http://hl7.org/fhir/uv/omop/ImplementationGuide/hl7.fhir.uv.omop"/>
</extension>
</valueCode>
</extension>
<url
value="http://hl7.org/fhir/uv/omop/StructureDefinition/PayerPlanPeriod"/>
<identifier>
<system value="urn:ietf:rfc:3986"/>
<value value="urn:oid:2.16.840.1.113883.4.642.40.77.42.19"/>
</identifier>
<version value="2.0.0-ballot"/>
<name value="PayerPlanPeriod"/>
<title value="Payer Plan Period OMOP Table"/>
<status value="active"/>
<date value="2026-11-06T00:33:48+00:00"/>
<publisher value="HL7 International / Biomedical Research and Regulation"/>
<contact>
<name value="HL7 International / Biomedical Research and Regulation"/>
<telecom>
<system value="url"/>
<value value="http://www.hl7.org/Special/committees/rcrim"/>
</telecom>
</contact>
<description
value="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."/>
<jurisdiction>
<coding>
<system value="http://unstats.un.org/unsd/methods/m49/m49.htm"/>
<code value="001"/>
<display value="World"/>
</coding>
</jurisdiction>
<fhirVersion value="5.0.0"/>
<mapping>
<identity value="rim"/>
<uri value="http://hl7.org/v3"/>
<name value="RIM Mapping"/>
</mapping>
<kind value="logical"/>
<abstract value="false"/>
<type
value="http://hl7.org/fhir/uv/omop/StructureDefinition/PayerPlanPeriod"/>
<baseDefinition value="http://hl7.org/fhir/StructureDefinition/Base"/>
<derivation value="specialization"/>
<snapshot>
<extension
url="http://hl7.org/fhir/tools/StructureDefinition/snapshot-base-version">
<valueString value="5.0.0"/>
</extension>
<element id="PayerPlanPeriod">
<path value="PayerPlanPeriod"/>
<short value="Payer Plan Period OMOP Table"/>
<definition
value="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."/>
<min value="0"/>
<max value="*"/>
<base>
<path value="Base"/>
<min value="0"/>
<max value="*"/>
</base>
<isModifier value="false"/>
<mapping>
<identity value="rim"/>
<map value="n/a"/>
</mapping>
</element>
<element id="PayerPlanPeriod.payer-plan-period-id">
<path value="PayerPlanPeriod.payer_plan_period_id"/>
<short value="Payer Plan Period Identifier"/>
<definition value="Payer Plan Period Identifier"/>
<min value="1"/>
<max value="1"/>
<base>
<path value="PayerPlanPeriod.payer_plan_period_id"/>
<min value="1"/>
<max value="1"/>
</base>
<type>
<code value="code"/>
</type>
</element>
<element id="PayerPlanPeriod.person-id">
<path value="PayerPlanPeriod.person_id"/>
<short value="Person"/>
<definition value="The Person covered by the Plan."/>
<min value="1"/>
<max value="1"/>
<base>
<path value="PayerPlanPeriod.person_id"/>
<min value="1"/>
<max value="1"/>
</base>
<type>
<code value="integer"/>
</type>
</element>
<element id="PayerPlanPeriod.payer-plan-period-start-date">
<path value="PayerPlanPeriod.payer_plan_period_start_date"/>
<short value="Payer Plan Period Start Date"/>
<definition value="Start date of Plan coverage."/>
<min value="1"/>
<max value="1"/>
<base>
<path value="PayerPlanPeriod.payer_plan_period_start_date"/>
<min value="1"/>
<max value="1"/>
</base>
<type>
<code value="date"/>
</type>
</element>
<element id="PayerPlanPeriod.payer-plan-period-end-date">
<path value="PayerPlanPeriod.payer_plan_period_end_date"/>
<short value="Payer Plan Period End Date"/>
<definition value="End date of Plan coverage."/>
<min value="1"/>
<max value="1"/>
<base>
<path value="PayerPlanPeriod.payer_plan_period_end_date"/>
<min value="1"/>
<max value="1"/>
</base>
<type>
<code value="date"/>
</type>
</element>
<element id="PayerPlanPeriod.payer-concept-id">
<path value="PayerPlanPeriod.payer_concept_id"/>
<short value="Payer"/>
<definition
value="This field represents the organization who reimburses the provider which administers care to the Person."/>
<min value="0"/>
<max value="1"/>
<base>
<path value="PayerPlanPeriod.payer_concept_id"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<code value="code"/>
</type>
</element>
<element id="PayerPlanPeriod.payer-source-value">
<path value="PayerPlanPeriod.payer_source_value"/>
<short value="Payer Source Value"/>
<definition
value="This is the Payer as it appears in the source data."/>
<min value="0"/>
<max value="1"/>
<base>
<path value="PayerPlanPeriod.payer_source_value"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<code value="string"/>
</type>
</element>
<element id="PayerPlanPeriod.payer-source-concept-id">
<path value="PayerPlanPeriod.payer_source_concept_id"/>
<short value="Payer Source"/>
<definition value="Payer Source"/>
<min value="0"/>
<max value="1"/>
<base>
<path value="PayerPlanPeriod.payer_source_concept_id"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<code value="code"/>
</type>
</element>
<element id="PayerPlanPeriod.plan-concept-id">
<path value="PayerPlanPeriod.plan_concept_id"/>
<short value="Plan"/>
<definition
value="This field represents the specific health benefit Plan the Person is enrolled in."/>
<min value="0"/>
<max value="1"/>
<base>
<path value="PayerPlanPeriod.plan_concept_id"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<code value="code"/>
</type>
</element>
<element id="PayerPlanPeriod.plan-source-value">
<path value="PayerPlanPeriod.plan_source_value"/>
<short value="Plan Source Value"/>
<definition
value="This is the health benefit Plan of the Person as it appears in the source data."/>
<min value="0"/>
<max value="1"/>
<base>
<path value="PayerPlanPeriod.plan_source_value"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<code value="string"/>
</type>
</element>
<element id="PayerPlanPeriod.plan-source-concept-id">
<path value="PayerPlanPeriod.plan_source_concept_id"/>
<short value="Plan Source"/>
<definition value="Plan Source"/>
<min value="0"/>
<max value="1"/>
<base>
<path value="PayerPlanPeriod.plan_source_concept_id"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<code value="code"/>
</type>
</element>
<element id="PayerPlanPeriod.sponsor-concept-id">
<path value="PayerPlanPeriod.sponsor_concept_id"/>
<short value="Sponsor"/>
<definition
value="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."/>
<min value="0"/>
<max value="1"/>
<base>
<path value="PayerPlanPeriod.sponsor_concept_id"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<code value="code"/>
</type>
</element>
<element id="PayerPlanPeriod.sponsor-source-value">
<path value="PayerPlanPeriod.sponsor_source_value"/>
<short value="Sponsor Source Value"/>
<definition value="The Plan sponsor as it appears in the source data."/>
<min value="0"/>
<max value="1"/>
<base>
<path value="PayerPlanPeriod.sponsor_source_value"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<code value="string"/>
</type>
</element>
<element id="PayerPlanPeriod.sponsor-source-concept-id">
<path value="PayerPlanPeriod.sponsor_source_concept_id"/>
<short value="Sponsor Source"/>
<definition value="Sponsor Source"/>
<min value="0"/>
<max value="1"/>
<base>
<path value="PayerPlanPeriod.sponsor_source_concept_id"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<code value="code"/>
</type>
</element>
<element id="PayerPlanPeriod.family-source-value">
<path value="PayerPlanPeriod.family_source_value"/>
<short value="Family Source Value"/>
<definition
value="The common identifier for all people (often a family) that covered by the same policy."/>
<min value="0"/>
<max value="1"/>
<base>
<path value="PayerPlanPeriod.family_source_value"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<code value="string"/>
</type>
</element>
<element id="PayerPlanPeriod.stop-reason-concept-id">
<path value="PayerPlanPeriod.stop_reason_concept_id"/>
<short value="Stop Reason"/>
<definition
value="This field represents the reason the Person left the Plan, if known."/>
<min value="0"/>
<max value="1"/>
<base>
<path value="PayerPlanPeriod.stop_reason_concept_id"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<code value="code"/>
</type>
</element>
<element id="PayerPlanPeriod.stop-reason-source-value">
<path value="PayerPlanPeriod.stop_reason_source_value"/>
<short value="Stop Reason Source Value"/>
<definition
value="The Plan stop reason as it appears in the source data."/>
<min value="0"/>
<max value="1"/>
<base>
<path value="PayerPlanPeriod.stop_reason_source_value"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<code value="string"/>
</type>
</element>
<element id="PayerPlanPeriod.stop-reason-source-concept-id">
<path value="PayerPlanPeriod.stop_reason_source_concept_id"/>
<short value="Stop Reason Source"/>
<definition value="Stop Reason Source"/>
<min value="0"/>
<max value="1"/>
<base>
<path value="PayerPlanPeriod.stop_reason_source_concept_id"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<code value="code"/>
</type>
</element>
</snapshot>
<differential>
<element id="PayerPlanPeriod">
<path value="PayerPlanPeriod"/>
<short value="Payer Plan Period OMOP Table"/>
<definition
value="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."/>
</element>
<element id="PayerPlanPeriod.payer-plan-period-id">
<path value="PayerPlanPeriod.payer_plan_period_id"/>
<short value="Payer Plan Period Identifier"/>
<definition value="Payer Plan Period Identifier"/>
<min value="1"/>
<max value="1"/>
<type>
<code value="code"/>
</type>
</element>
<element id="PayerPlanPeriod.person-id">
<path value="PayerPlanPeriod.person_id"/>
<short value="Person"/>
<definition value="The Person covered by the Plan."/>
<min value="1"/>
<max value="1"/>
<type>
<code value="integer"/>
</type>
</element>
<element id="PayerPlanPeriod.payer-plan-period-start-date">
<path value="PayerPlanPeriod.payer_plan_period_start_date"/>
<short value="Payer Plan Period Start Date"/>
<definition value="Start date of Plan coverage."/>
<min value="1"/>
<max value="1"/>
<type>
<code value="date"/>
</type>
</element>
<element id="PayerPlanPeriod.payer-plan-period-end-date">
<path value="PayerPlanPeriod.payer_plan_period_end_date"/>
<short value="Payer Plan Period End Date"/>
<definition value="End date of Plan coverage."/>
<min value="1"/>
<max value="1"/>
<type>
<code value="date"/>
</type>
</element>
<element id="PayerPlanPeriod.payer-concept-id">
<path value="PayerPlanPeriod.payer_concept_id"/>
<short value="Payer"/>
<definition
value="This field represents the organization who reimburses the provider which administers care to the Person."/>
<min value="0"/>
<max value="1"/>
<type>
<code value="code"/>
</type>
</element>
<element id="PayerPlanPeriod.payer-source-value">
<path value="PayerPlanPeriod.payer_source_value"/>
<short value="Payer Source Value"/>
<definition
value="This is the Payer as it appears in the source data."/>
<min value="0"/>
<max value="1"/>
<type>
<code value="string"/>
</type>
</element>
<element id="PayerPlanPeriod.payer-source-concept-id">
<path value="PayerPlanPeriod.payer_source_concept_id"/>
<short value="Payer Source"/>
<definition value="Payer Source"/>
<min value="0"/>
<max value="1"/>
<type>
<code value="code"/>
</type>
</element>
<element id="PayerPlanPeriod.plan-concept-id">
<path value="PayerPlanPeriod.plan_concept_id"/>
<short value="Plan"/>
<definition
value="This field represents the specific health benefit Plan the Person is enrolled in."/>
<min value="0"/>
<max value="1"/>
<type>
<code value="code"/>
</type>
</element>
<element id="PayerPlanPeriod.plan-source-value">
<path value="PayerPlanPeriod.plan_source_value"/>
<short value="Plan Source Value"/>
<definition
value="This is the health benefit Plan of the Person as it appears in the source data."/>
<min value="0"/>
<max value="1"/>
<type>
<code value="string"/>
</type>
</element>
<element id="PayerPlanPeriod.plan-source-concept-id">
<path value="PayerPlanPeriod.plan_source_concept_id"/>
<short value="Plan Source"/>
<definition value="Plan Source"/>
<min value="0"/>
<max value="1"/>
<type>
<code value="code"/>
</type>
</element>
<element id="PayerPlanPeriod.sponsor-concept-id">
<path value="PayerPlanPeriod.sponsor_concept_id"/>
<short value="Sponsor"/>
<definition
value="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."/>
<min value="0"/>
<max value="1"/>
<type>
<code value="code"/>
</type>
</element>
<element id="PayerPlanPeriod.sponsor-source-value">
<path value="PayerPlanPeriod.sponsor_source_value"/>
<short value="Sponsor Source Value"/>
<definition value="The Plan sponsor as it appears in the source data."/>
<min value="0"/>
<max value="1"/>
<type>
<code value="string"/>
</type>
</element>
<element id="PayerPlanPeriod.sponsor-source-concept-id">
<path value="PayerPlanPeriod.sponsor_source_concept_id"/>
<short value="Sponsor Source"/>
<definition value="Sponsor Source"/>
<min value="0"/>
<max value="1"/>
<type>
<code value="code"/>
</type>
</element>
<element id="PayerPlanPeriod.family-source-value">
<path value="PayerPlanPeriod.family_source_value"/>
<short value="Family Source Value"/>
<definition
value="The common identifier for all people (often a family) that covered by the same policy."/>
<min value="0"/>
<max value="1"/>
<type>
<code value="string"/>
</type>
</element>
<element id="PayerPlanPeriod.stop-reason-concept-id">
<path value="PayerPlanPeriod.stop_reason_concept_id"/>
<short value="Stop Reason"/>
<definition
value="This field represents the reason the Person left the Plan, if known."/>
<min value="0"/>
<max value="1"/>
<type>
<code value="code"/>
</type>
</element>
<element id="PayerPlanPeriod.stop-reason-source-value">
<path value="PayerPlanPeriod.stop_reason_source_value"/>
<short value="Stop Reason Source Value"/>
<definition
value="The Plan stop reason as it appears in the source data."/>
<min value="0"/>
<max value="1"/>
<type>
<code value="string"/>
</type>
</element>
<element id="PayerPlanPeriod.stop-reason-source-concept-id">
<path value="PayerPlanPeriod.stop_reason_source_concept_id"/>
<short value="Stop Reason Source"/>
<definition value="Stop Reason Source"/>
<min value="0"/>
<max value="1"/>
<type>
<code value="code"/>
</type>
</element>
</differential>
</StructureDefinition>