HL7 FHIR Implementation Guide: Public Health IG Release 1 - BE Realm | STU1
1.0.2 - STU1

Publication Build: This will be filled in by the publication tooling

## Logical Model: BeModelPopulationScreeningPlan - XML Profile

Active as of 2023-10-16

XML representation of the BeModelPopulationScreeningPlan logical model.

Raw xml | Download

    <StructureDefinition xmlns="http://hl7.org/fhir">
      <id value="BeModelPopulationScreeningPlan"/>
      <text>
        <status value="extensions"/>
        <div xmlns="http://www.w3.org/1999/xhtml"><table border="0" cellpadding="0" cellspacing="0" style="border: 0px #F0F0F0 solid; font-size: 11px; font-family: verdana; vertical-align: top;"><tr style="border: 1px #F0F0F0 solid; font-size: 11px; font-family: verdana; vertical-align: top"><th style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><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 style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><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 style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><a href="https://build.fhir.org/ig/FHIR/ig-guidance/readingIgs.html#table-views" title="Minimum and Maximum # of times the the element can appear in the instance">Card.</a></th><th style="width: 100px" class="hierarchy"><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 style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><a href="https://build.fhir.org/ig/FHIR/ig-guidance/readingIgs.html#table-views" title="Additional information about the element">Description &amp; 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, " alt="doco" style="background-color: inherit"/></a></span></th></tr><tr style="border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color: white"><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(tbl_bck1.png)" class="hierarchy"><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-BeModelPopulationScreeningPlan-definitions.html#BeModelPopulationScreeningPlan" title="Logical model for recurrent population based screening. This model represents a screening plan for a patient for a given cancer type.">BeModelPopulationScreeningPlan</a><a name="BeModelPopulationScreeningPlan"> </a></td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"/><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><span style="opacity: 0.5">0</span><span style="opacity: 0.5">..</span><span style="opacity: 0.5">*</span></td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><a href="http://hl7.org/fhir/R4/datatypes.html#Element">Element</a></td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><br/>Elements defined in Ancestors: <a href="http://hl7.org/fhir/R4/datatypes.html#Element" title="Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.">@id</a>, <a href="http://hl7.org/fhir/R4/datatypes.html#Element" title="May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance  applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.">extension</a><br/>Logical model for population screening plan<br/><span style="font-weight:bold">Instances of this logical model are not marked to be the target of a Reference</span></td></tr>
    <tr style="border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color: #F7F7F7"><td style="vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(tbl_bck10.png)" class="hierarchy"><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_reference.png" alt="." style="background-color: #F7F7F7; background-color: inherit" title="Reference to another Resource" class="hierarchy"/> <a href="StructureDefinition-BeModelPopulationScreeningPlan-definitions.html#BeModelPopulationScreeningPlan.patient" title="The patient for the screening">patient</a><a name="BeModelPopulationScreeningPlan.patient"> </a></td><td style="vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"/><td style="vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy">1..1</td><td style="vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><a href="http://hl7.org/fhir/R4/references.html">Reference</a>(<a href="http://hl7.org/fhir/R4/patient.html">Patient</a>)</td><td style="vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy">The patient for the screening</td></tr>
    <tr style="border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color: white"><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(tbl_bck10.png)" class="hierarchy"><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_datatype.gif" alt="." style="background-color: white; background-color: inherit" title="Data Type" class="hierarchy"/> <a href="StructureDefinition-BeModelPopulationScreeningPlan-definitions.html#BeModelPopulationScreeningPlan.screeningType" title="The related screening, for example breast cancer, colon cancer or cervicalcancer.">screeningType</a><a name="BeModelPopulationScreeningPlan.screeningType"> </a></td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"/><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy">1..1</td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><a href="http://hl7.org/fhir/R4/datatypes.html#CodeableConcept">CodeableConcept</a></td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy">The related screening</td></tr>
    <tr style="border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color: #F7F7F7"><td style="vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(tbl_bck00.png)" class="hierarchy"><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_resource.png" alt="." style="background-color: #F7F7F7; background-color: inherit" title="Resource" class="hierarchy"/> <a href="StructureDefinition-BeModelPopulationScreeningPlan-definitions.html#BeModelPopulationScreeningPlan.screeningEpisode" title="Each screening event - actual screening or missed scheduled screening">screeningEpisode</a><a name="BeModelPopulationScreeningPlan.screeningEpisode"> </a></td><td style="vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"/><td style="vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy">0..*</td><td style="vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><a href="StructureDefinition-BeModelPopulationScreening.html">BeModelPopulationScreening</a></td><td style="vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy">Each screening event - actual screening or missed scheduled screening<br/></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, " alt="doco" style="background-color: inherit"/> Documentation for this format</a></td></tr></table></div>
      </text>
      <url
           value="https://www.ehealth.fgov.be/standards/fhir/public-health/StructureDefinition/BeModelPopulationScreeningPlan"/>
      <version value="1.0.2"/>
      <name value="BeModelPopulationScreeningPlan"/>
      <title value="Logical model for population screening plan"/>
      <status value="active"/>
      <date value="2023-10-16T14:06:47+02:00"/>
      <publisher value="eHealth Platform"/>
      <contact>
        <name value="eHealth Platform"/>
        <telecom>
          <system value="url"/>
          <value value="https://www.ehealth.fgov.be/standards/fhir"/>
        </telecom>
        <telecom>
          <system value="email"/>
          <value value="support@be-ehealth-standards.atlassian.net"/>
        </telecom>
      </contact>
      <contact>
        <name value="eHealth Platform"/>
        <telecom>
          <system value="email"/>
          <value value="support@be-ehealth-standards.atlassian.net"/>
          <use value="work"/>
        </telecom>
      </contact>
      <description
                   value="Logical model for recurrent population based screening. This model represents a screening plan for a patient for a given cancer type."/>
      <jurisdiction>
        <coding>
          <system value="urn:iso:std:iso:3166"/>
          <code value="BE"/>
          <display value="Belgium"/>
        </coding>
      </jurisdiction>
      <fhirVersion value="4.0.1"/>
      <mapping>
        <identity value="rim"/>
        <uri value="http://hl7.org/v3"/>
        <name value="RIM Mapping"/>
      </mapping>
      <kind value="logical"/>
      <abstract value="false"/>
      <type
            value="https://www.ehealth.fgov.be/standards/fhir/public-health/StructureDefinition/BeModelPopulationScreeningPlan"/>
      <baseDefinition value="http://hl7.org/fhir/StructureDefinition/Element"/>
      <derivation value="specialization"/>
      <snapshot>
        <element id="BeModelPopulationScreeningPlan">
          <path value="BeModelPopulationScreeningPlan"/>
          <short value="Logical model for population screening plan"/>
          <definition
                      value="Logical model for recurrent population based screening. This model represents a screening plan for a patient for a given cancer type."/>
          <min value="0"/>
          <max value="*"/>
          <base>
            <path value="Element"/>
            <min value="0"/>
            <max value="*"/>
          </base>
          <condition value="ele-1"/>
          <constraint>
            <key value="ele-1"/>
            <severity value="error"/>
            <human value="All FHIR elements must have a @value or children"/>
            <expression
                        value="hasValue() or (children().count() &gt; id.count())"/>
            <xpath value="@value|f:*|h:div"/>
            <source value="http://hl7.org/fhir/StructureDefinition/Element"/>
          </constraint>
          <isModifier value="false"/>
          <mapping>
            <identity value="rim"/>
            <map value="n/a"/>
          </mapping>
        </element>
        <element id="BeModelPopulationScreeningPlan.id">
          <path value="BeModelPopulationScreeningPlan.id"/>
          <representation value="xmlAttr"/>
          <short value="Unique id for inter-element referencing"/>
          <definition
                      value="Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces."/>
          <min value="0"/>
          <max value="1"/>
          <base>
            <path value="Element.id"/>
            <min value="0"/>
            <max value="1"/>
          </base>
          <type>
            <extension
                       url="http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type">
              <valueUrl value="string"/>
            </extension>
            <code value="http://hl7.org/fhirpath/System.String"/>
          </type>
          <isModifier value="false"/>
          <isSummary value="false"/>
          <mapping>
            <identity value="rim"/>
            <map value="n/a"/>
          </mapping>
        </element>
        <element id="BeModelPopulationScreeningPlan.extension">
          <path value="BeModelPopulationScreeningPlan.extension"/>
          <slicing>
            <discriminator>
              <type value="value"/>
              <path value="url"/>
            </discriminator>
            <description value="Extensions are always sliced by (at least) url"/>
            <rules value="open"/>
          </slicing>
          <short value="Additional content defined by implementations"/>
          <definition
                      value="May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance  applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension."/>
          <comment
                   value="There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions.  The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone."/>
          <alias value="extensions"/>
          <alias value="user content"/>
          <min value="0"/>
          <max value="*"/>
          <base>
            <path value="Element.extension"/>
            <min value="0"/>
            <max value="*"/>
          </base>
          <type>
            <code value="Extension"/>
          </type>
          <constraint>
            <key value="ele-1"/>
            <severity value="error"/>
            <human value="All FHIR elements must have a @value or children"/>
            <expression
                        value="hasValue() or (children().count() &gt; id.count())"/>
            <xpath value="@value|f:*|h:div"/>
            <source value="http://hl7.org/fhir/StructureDefinition/Element"/>
          </constraint>
          <constraint>
            <key value="ext-1"/>
            <severity value="error"/>
            <human value="Must have either extensions or value[x], not both"/>
            <expression value="extension.exists() != value.exists()"/>
            <xpath
                   value="exists(f:extension)!=exists(f:*[starts-with(local-name(.), &quot;value&quot;)])"/>
            <source value="http://hl7.org/fhir/StructureDefinition/Extension"/>
          </constraint>
          <isModifier value="false"/>
          <isSummary value="false"/>
          <mapping>
            <identity value="rim"/>
            <map value="n/a"/>
          </mapping>
        </element>
        <element id="BeModelPopulationScreeningPlan.patient">
          <path value="BeModelPopulationScreeningPlan.patient"/>
          <short value="The patient for the screening"/>
          <definition value="The patient for the screening"/>
          <min value="1"/>
          <max value="1"/>
          <base>
            <path value="BeModelPopulationScreeningPlan.patient"/>
            <min value="1"/>
            <max value="1"/>
          </base>
          <type>
            <code value="Reference"/>
            <targetProfile
                           value="http://hl7.org/fhir/StructureDefinition/Patient"/>
          </type>
        </element>
        <element id="BeModelPopulationScreeningPlan.screeningType">
          <path value="BeModelPopulationScreeningPlan.screeningType"/>
          <short value="The related screening"/>
          <definition
                      value="The related screening, for example breast cancer, colon cancer or cervicalcancer."/>
          <min value="1"/>
          <max value="1"/>
          <base>
            <path value="BeModelPopulationScreeningPlan.screeningType"/>
            <min value="1"/>
            <max value="1"/>
          </base>
          <type>
            <code value="CodeableConcept"/>
          </type>
        </element>
        <element id="BeModelPopulationScreeningPlan.screeningEpisode">
          <path value="BeModelPopulationScreeningPlan.screeningEpisode"/>
          <short
                 value="Each screening event - actual screening or missed scheduled screening"/>
          <definition
                      value="Each screening event - actual screening or missed scheduled screening"/>
          <min value="0"/>
          <max value="*"/>
          <base>
            <path value="BeModelPopulationScreeningPlan.screeningEpisode"/>
            <min value="0"/>
            <max value="*"/>
          </base>
          <type>
            <code
                  value="https://www.ehealth.fgov.be/standards/fhir/public-health/StructureDefinition/BeModelPopulationScreening"/>
          </type>
        </element>
      </snapshot>
      <differential>
        <element id="BeModelPopulationScreeningPlan">
          <path value="BeModelPopulationScreeningPlan"/>
          <short value="Logical model for population screening plan"/>
          <definition
                      value="Logical model for recurrent population based screening. This model represents a screening plan for a patient for a given cancer type."/>
        </element>
        <element id="BeModelPopulationScreeningPlan.patient">
          <path value="BeModelPopulationScreeningPlan.patient"/>
          <short value="The patient for the screening"/>
          <definition value="The patient for the screening"/>
          <min value="1"/>
          <max value="1"/>
          <type>
            <code value="Reference"/>
            <targetProfile
                           value="http://hl7.org/fhir/StructureDefinition/Patient"/>
          </type>
        </element>
        <element id="BeModelPopulationScreeningPlan.screeningType">
          <path value="BeModelPopulationScreeningPlan.screeningType"/>
          <short value="The related screening"/>
          <definition
                      value="The related screening, for example breast cancer, colon cancer or cervicalcancer."/>
          <min value="1"/>
          <max value="1"/>
          <type>
            <code value="CodeableConcept"/>
          </type>
        </element>
        <element id="BeModelPopulationScreeningPlan.screeningEpisode">
          <path value="BeModelPopulationScreeningPlan.screeningEpisode"/>
          <short
                 value="Each screening event - actual screening or missed scheduled screening"/>
          <definition
                      value="Each screening event - actual screening or missed scheduled screening"/>
          <min value="0"/>
          <max value="*"/>
          <type>
            <code
                  value="https://www.ehealth.fgov.be/standards/fhir/public-health/StructureDefinition/BeModelPopulationScreening"/>
          </type>
        </element>
      </differential>
    </StructureDefinition>