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

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

## Logical Model: BeModelPopulationScreeningPlan - JSON Profile

Active as of 2023-06-27

JSON representation of the BeModelPopulationScreeningPlan logical model.

Raw json | Download

    {
      "resourceType" : "StructureDefinition",
      "id" : "BeModelPopulationScreeningPlan",
      "text" : {
        "status" : "extensions",
        "div" : "<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\">Logical model for population screening plan<br/><span style=\"font-weight:bold\">This logical model cannot be the target of a reference</span></td></tr>\r\n<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>\r\n<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>\r\n<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>\r\n<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>"
      },
      "url" : "https://www.ehealth.fgov.be/standards/fhir/public-health/StructureDefinition/BeModelPopulationScreeningPlan",
      "version" : "1.0.0",
      "name" : "BeModelPopulationScreeningPlan",
      "title" : "Logical model for population screening plan",
      "status" : "active",
      "date" : "2023-06-27T13:40:58+02:00",
      "publisher" : "eHealth Platform",
      "contact" : [
        {
          "name" : "eHealth Platform",
          "telecom" : [
            {
              "system" : "url",
              "value" : "https://www.ehealth.fgov.be/standards/fhir"
            },
            {
              "system" : "email",
              "value" : "support@be-ehealth-standards.atlassian.net"
            }
          ]
        },
        {
          "name" : "eHealth Platform",
          "telecom" : [
            {
              "system" : "email",
              "value" : "support@be-ehealth-standards.atlassian.net",
              "use" : "work"
            }
          ]
        }
      ],
      "description" : "Logical model for recurrent population based screening. This model represents a screening plan for a patient for a given cancer type.",
      "jurisdiction" : [
        {
          "coding" : [
            {
              "system" : "urn:iso:std:iso:3166",
              "code" : "BE",
              "display" : "Belgium"
            }
          ]
        }
      ],
      "fhirVersion" : "4.0.1",
      "mapping" : [
        {
          "identity" : "rim",
          "uri" : "http://hl7.org/v3",
          "name" : "RIM Mapping"
        }
      ],
      "kind" : "logical",
      "abstract" : false,
      "type" : "https://www.ehealth.fgov.be/standards/fhir/public-health/StructureDefinition/BeModelPopulationScreeningPlan",
      "baseDefinition" : "http://hl7.org/fhir/StructureDefinition/Element",
      "derivation" : "specialization",
      "snapshot" : {
        "element" : [
          {
            "id" : "BeModelPopulationScreeningPlan",
            "path" : "BeModelPopulationScreeningPlan",
            "short" : "Logical model for population screening plan",
            "definition" : "Logical model for recurrent population based screening. This model represents a screening plan for a patient for a given cancer type.",
            "min" : 0,
            "max" : "*",
            "base" : {
              "path" : "Element",
              "min" : 0,
              "max" : "*"
            },
            "condition" : [
              "ele-1"
            ],
            "constraint" : [
              {
                "key" : "ele-1",
                "severity" : "error",
                "human" : "All FHIR elements must have a @value or children",
                "expression" : "hasValue() or (children().count() > id.count())",
                "xpath" : "@value|f:*|h:div",
                "source" : "http://hl7.org/fhir/StructureDefinition/Element"
              }
            ],
            "isModifier" : false,
            "mapping" : [
              {
                "identity" : "rim",
                "map" : "n/a"
              }
            ]
          },
          {
            "id" : "BeModelPopulationScreeningPlan.id",
            "path" : "BeModelPopulationScreeningPlan.id",
            "representation" : [
              "xmlAttr"
            ],
            "short" : "Unique id for inter-element referencing",
            "definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
            "min" : 0,
            "max" : "1",
            "base" : {
              "path" : "Element.id",
              "min" : 0,
              "max" : "1"
            },
            "type" : [
              {
                "extension" : [
                  {
                    "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
                    "valueUrl" : "string"
                  }
                ],
                "code" : "http://hl7.org/fhirpath/System.String"
              }
            ],
            "isModifier" : false,
            "isSummary" : false,
            "mapping" : [
              {
                "identity" : "rim",
                "map" : "n/a"
              }
            ]
          },
          {
            "id" : "BeModelPopulationScreeningPlan.extension",
            "path" : "BeModelPopulationScreeningPlan.extension",
            "slicing" : {
              "discriminator" : [
                {
                  "type" : "value",
                  "path" : "url"
                }
              ],
              "description" : "Extensions are always sliced by (at least) url",
              "rules" : "open"
            },
            "short" : "Additional content defined by implementations",
            "definition" : "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" : "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" : [
              "extensions",
              "user content"
            ],
            "min" : 0,
            "max" : "*",
            "base" : {
              "path" : "Element.extension",
              "min" : 0,
              "max" : "*"
            },
            "type" : [
              {
                "code" : "Extension"
              }
            ],
            "constraint" : [
              {
                "key" : "ele-1",
                "severity" : "error",
                "human" : "All FHIR elements must have a @value or children",
                "expression" : "hasValue() or (children().count() > id.count())",
                "xpath" : "@value|f:*|h:div",
                "source" : "http://hl7.org/fhir/StructureDefinition/Element"
              },
              {
                "key" : "ext-1",
                "severity" : "error",
                "human" : "Must have either extensions or value[x], not both",
                "expression" : "extension.exists() != value.exists()",
                "xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
                "source" : "http://hl7.org/fhir/StructureDefinition/Extension"
              }
            ],
            "isModifier" : false,
            "isSummary" : false,
            "mapping" : [
              {
                "identity" : "rim",
                "map" : "n/a"
              }
            ]
          },
          {
            "id" : "BeModelPopulationScreeningPlan.patient",
            "path" : "BeModelPopulationScreeningPlan.patient",
            "short" : "The patient for the screening",
            "definition" : "The patient for the screening",
            "min" : 1,
            "max" : "1",
            "base" : {
              "path" : "BeModelPopulationScreeningPlan.patient",
              "min" : 1,
              "max" : "1"
            },
            "type" : [
              {
                "code" : "Reference",
                "targetProfile" : [
                  "http://hl7.org/fhir/StructureDefinition/Patient"
                ]
              }
            ]
          },
          {
            "id" : "BeModelPopulationScreeningPlan.screeningType",
            "path" : "BeModelPopulationScreeningPlan.screeningType",
            "short" : "The related screening",
            "definition" : "The related screening, for example breast cancer, colon cancer or cervicalcancer.",
            "min" : 1,
            "max" : "1",
            "base" : {
              "path" : "BeModelPopulationScreeningPlan.screeningType",
              "min" : 1,
              "max" : "1"
            },
            "type" : [
              {
                "code" : "CodeableConcept"
              }
            ]
          },
          {
            "id" : "BeModelPopulationScreeningPlan.screeningEpisode",
            "path" : "BeModelPopulationScreeningPlan.screeningEpisode",
            "short" : "Each screening event - actual screening or missed scheduled screening",
            "definition" : "Each screening event - actual screening or missed scheduled screening",
            "min" : 0,
            "max" : "*",
            "base" : {
              "path" : "BeModelPopulationScreeningPlan.screeningEpisode",
              "min" : 0,
              "max" : "*"
            },
            "type" : [
              {
                "code" : "https://www.ehealth.fgov.be/standards/fhir/public-health/StructureDefinition/BeModelPopulationScreening"
              }
            ]
          }
        ]
      },
      "differential" : {
        "element" : [
          {
            "id" : "BeModelPopulationScreeningPlan",
            "path" : "BeModelPopulationScreeningPlan",
            "short" : "Logical model for population screening plan",
            "definition" : "Logical model for recurrent population based screening. This model represents a screening plan for a patient for a given cancer type."
          },
          {
            "id" : "BeModelPopulationScreeningPlan.patient",
            "path" : "BeModelPopulationScreeningPlan.patient",
            "short" : "The patient for the screening",
            "definition" : "The patient for the screening",
            "min" : 1,
            "max" : "1",
            "type" : [
              {
                "code" : "Reference",
                "targetProfile" : [
                  "http://hl7.org/fhir/StructureDefinition/Patient"
                ]
              }
            ]
          },
          {
            "id" : "BeModelPopulationScreeningPlan.screeningType",
            "path" : "BeModelPopulationScreeningPlan.screeningType",
            "short" : "The related screening",
            "definition" : "The related screening, for example breast cancer, colon cancer or cervicalcancer.",
            "min" : 1,
            "max" : "1",
            "type" : [
              {
                "code" : "CodeableConcept"
              }
            ]
          },
          {
            "id" : "BeModelPopulationScreeningPlan.screeningEpisode",
            "path" : "BeModelPopulationScreeningPlan.screeningEpisode",
            "short" : "Each screening event - actual screening or missed scheduled screening",
            "definition" : "Each screening event - actual screening or missed scheduled screening",
            "min" : 0,
            "max" : "*",
            "type" : [
              {
                "code" : "https://www.ehealth.fgov.be/standards/fhir/public-health/StructureDefinition/BeModelPopulationScreening"
              }
            ]
          }
        ]
      }
    }