BeModelPopulationScreening
type: StructureDefinition
node role: treeRoot
id:
  v: BeModelPopulationScreening
text:
  status:
    v: extensions
  div: Name Flags Card. Type Description & Constraints<img src="[binary]" alt="doco" style="background-color: inherit"/> <a href="StructureDefinition-BeModelPopulationScreening-definitions.html#BeModelPopulationScreening" title="Logical model for recurrent population based screening. The model represents one iteration of a screening, called episode. A patient can have multiple episodes for a given screening. A screening of a specific type for a given patient can be repeated after a certain period. Each time the screening is repeated results in a new episode.">BeModelPopulationScreening 0..* Element Logical model for population screening event This logical model cannot be the target of a reference patient 1..1 Reference(Patient) The patient for the screening screeningType 1..1 CodeableConcept The related screening <a href="StructureDefinition-BeModelPopulationScreening-definitions.html#BeModelPopulationScreening.screeningYear" title="The year of the screening process/episode for the given screening. If the patient participated, the participation year is taken. If the patient didn't participate, the calendar year of the invitation is taken. If there is no invitation or participation, there will be no episode. For example, if patient is allowed a population based screening every 2 years for a given screening type and the first screening episode invitation took place in 2022, the next episode will be created for the next invitation in 2024. If the patient has a refusal or exclusion registered and does not have a participation/invitation, so the patient does not have any episodes, the calendar year of the registration of the refusal/exclusion is taken.">screeningYear 1..1 string The calendar year of the screening invitation 0..1 BackboneElement The appointment details of the invitation date 1..1 date The date the patient is invited to participate in the population based screening time 0..1 time The time for the screening if there is a proposed appointment. This is the case for …
url:
  v: https://www.ehealth.fgov.be/standards/fhir/public-health/StructureDefinition/BeModelPopulationScreening
version:
  v: 1.0.0
name:
  v: BeModelPopulationScreening
title:
  v: Logical model for population screening event
status:
  v: active
date:
  v: 2023-06-27T13:40:58+02:00
publisher:
  v: eHealth Platform
contact:
  name:
    v: eHealth Platform
  telecom:
    system:
      v: url
    value:
      v: https://www.ehealth.fgov.be/standards/fhir
  telecom:
    system:
      v: email
contact:
  name:
    v: eHealth Platform
  telecom:
    system:
      v: email
    use:
      v: work
description:
  v: Logical model for recurrent population based screening. The model represents one iteration of a screening, called episode. A patient can have multiple episodes for a given screening. A screening of a specific type for a given patient can be repeated after a certain period. Each time the screening is repeated results in a new episode.
jurisdiction:
  coding:
    system:
      v: urn:iso:std:iso:3166
    code:
      v: BE
    display:
      v: Belgium
fhir version:
  v: 4.0.1
mapping:
  identity:
    v: rim
  uri:
    v: http://hl7.org/v3
  name:
    v: RIM Mapping
kind:
  v: logical
abstract:
  v: false
type:
  v: https://www.ehealth.fgov.be/standards/fhir/public-health/StructureDefinition/BeModelPopulationScreening
base definition:
  v: http://hl7.org/fhir/StructureDefinition/Element
  link: http://hl7.org/fhir/StructureDefinition/Element
derivation:
  v: specialization
snapshot:
  element:
    id:
      v: BeModelPopulationScreening
    path:
      v: BeModelPopulationScreening
    short:
      v: Logical model for population screening event
    definition:
      v: Logical model for recurrent population based screening. The model represents one iteration of a screening, called episode. A patient can have multiple episodes for a given screening. A screening of a specific type for a given patient can be repeated after a certain period. Each time the screening is repeated results in a new episode.
    min:
      v: 0
    max:
      v: *
    base:
      path:
        v: Element
      min:
        v: 0
      max:
        v: *
    condition:
      v: ele-1
    constraint:
      key:
        v: ele-1
      severity:
        v: error
      human:
        v: All FHIR elements must have a @value or children
      expression:
        v: hasValue() or (children().count() > id.count())
      xpath:
        v: @value|f:*|h:div
      source:
        v: http://hl7.org/fhir/StructureDefinition/Element
        link: http://hl7.org/fhir/StructureDefinition/Element
    is modifier:
      v: false
    mapping:
      identity:
        v: rim
      map:
        v: n/a
  element:
    id:
      v: BeModelPopulationScreening.id
    path:
      v: BeModelPopulationScreening.id
    representation:
      v: xmlAttr
    short:
      v: Unique id for inter-element referencing
    definition:
      v: Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
    min:
      v: 0
    max:
      v: 1
    base:
      path:
        v: Element.id
      min:
        v: 0
      max:
        v: 1
    type:
      code:
        v: http://hl7.org/fhirpath/System.String
    is modifier:
      v: false
    is summary:
      v: false
    mapping:
      identity:
        v: rim
      map:
        v: n/a
  element:
    id:
      v: BeModelPopulationScreening.extension
    path:
      v: BeModelPopulationScreening.extension
    slicing:
      description:
        v: Extensions are always sliced by (at least) url
      rules:
        v: open
    short:
      v: Additional content defined by implementations
    definition:
      v: 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:
      v: 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:
      v: extensions
    alias:
      v: user content
    min:
      v: 0
    max:
      v: *
    base:
      path:
        v: Element.extension
      min:
        v: 0
      max:
        v: *
    type:
      code:
        v: Extension
    constraint:
      key:
        v: ele-1
      severity:
        v: error
      human:
        v: All FHIR elements must have a @value or children
      expression:
        v: hasValue() or (children().count() > id.count())
      xpath:
        v: @value|f:*|h:div
      source:
        v: http://hl7.org/fhir/StructureDefinition/Element
        link: http://hl7.org/fhir/StructureDefinition/Element
    constraint:
      key:
        v: ext-1
      severity:
        v: error
      human:
        v: Must have either extensions or value[x], not both

v: string

v: value

v: url

v: extension.exists() != value.exists()

v: exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")])

v: false

v: false

identity:
  v: rim
map:
  v: n/a

id:
  v: BeModelPopulationScreening.patient
path:
  v: BeModelPopulationScreening.patient
short:
  v: The patient for the screening
definition:
  v: The patient for the screening
min:
  v: 1
max:
  v: 1
base:
  path:
    v: BeModelPopulationScreening.patient
  min:
    v: 1
  max:
    v: 1
type:
  code:
    v: Reference
  target profile:
    v: http://hl7.org/fhir/StructureDefinition/Patient
    link: http://hl7.org/fhir/StructureDefinition/Patient

id:
  v: BeModelPopulationScreening.screeningType
path:
  v: BeModelPopulationScreening.screeningType
short:
  v: The related screening
definition:
  v: The related screening, for example breast cancer, colon cancer or cervicalcancer.
min:
  v: 1
max:
  v: 1
base:
  path:
    v: BeModelPopulationScreening.screeningType
  min:
    v: 1
  max:
    v: 1
type:
  code:
    v: CodeableConcept

id:
  v: BeModelPopulationScreening.screeningYear
path:
  v: BeModelPopulationScreening.screeningYear
short:
  v: The calendar year of the screening
definition:
  v: The year of the screening process/episode for the given screening. If the patient participated, the participation year is taken. If the patient didn't participate, the calendar year of the invitation is taken. If there is no invitation or participation, there will be no episode. For example, if patient is allowed a population based screening every 2 years for a given screening type and the first screening episode invitation took place in 2022, the next episode will be created for the next invitation in 2024. If the patient has a refusal or exclusion registered and does not have a participation/invitation, so the patient does not have any episodes, the calendar year of the registration of the refusal/exclusion is taken.
min:
  v: 1
max:
  v: 1
base:
  path:
    v: BeModelPopulationScreening.screeningYear
  min:
    v: 1
  max:
    v: 1
type:
  code:
    v: string

id:
  v: BeModelPopulationScreening.invitation
path:
  v: BeModelPopulationScreening.invitation
short:
  v: The appointment details of the invitation
definition:
  v: An invitation is not mandatory, in some cases a patient can participate for a screening without an invitation.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: BeModelPopulationScreening.invitation
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: BackboneElement
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element

id:
  v: BeModelPopulationScreening.invitation.id
path:
  v: BeModelPopulationScreening.invitation.id
representation:
  v: xmlAttr
short:
  v: Unique id for inter-element referencing
definition:
  v: Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Element.id
  min:
    v: 0
  max:
    v: 1
type:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type
    value:
      v: string
  code:
    v: http://hl7.org/fhirpath/System.String
is modifier:
  v: false
is summary:
  v: false
mapping:
  identity:
    v: rim
  map:
    v: n/a

id:
  v: BeModelPopulationScreening.invitation.extension
path:
  v: BeModelPopulationScreening.invitation.extension
slicing:
  discriminator:
    type:
      v: value
    path:
      v: url
  description:
    v: Extensions are always sliced by (at least) url
  rules:
    v: open
short:
  v: Additional content defined by implementations
definition:
  v: 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:
  v: 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:
  v: extensions
alias:
  v: user content
min:
  v: 0
max:
  v: *
base:
  path:
    v: Element.extension
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Extension
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
constraint:
  key:
    v: ext-1
  severity:
    v: error
  human:
    v: Must have either extensions or value[x], not both
  expression:
    v: extension.exists() != value.exists()
  xpath:
    v: exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")])
  source:
    v: http://hl7.org/fhir/StructureDefinition/Extension
    link: http://hl7.org/fhir/StructureDefinition/Extension
is modifier:
  v: false
is summary:
  v: false
mapping:
  identity:
    v: rim
  map:
    v: n/a

id:
  v: BeModelPopulationScreening.invitation.modifierExtension
path:
  v: BeModelPopulationScreening.invitation.modifierExtension
short:
  v: Extensions that cannot be ignored even if unrecognized
definition:
  v: May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
comment:
  v: 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.
requirements:
  v: Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](http://hl7.org/fhir/R4/extensibility.html#modifierExtension).
alias:
  v: extensions
alias:
  v: user content
alias:
  v: modifiers
min:
  v: 0
max:
  v: *
base:
  path:
    v: BackboneElement.modifierExtension
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Extension
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
constraint:
  key:
    v: ext-1
  severity:
    v: error
  human:
    v: Must have either extensions or value[x], not both
  expression:
    v: extension.exists() != value.exists()
  xpath:
    v: exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")])
  source:
    v: http://hl7.org/fhir/StructureDefinition/Extension
    link: http://hl7.org/fhir/StructureDefinition/Extension
is modifier:
  v: true
is modifier reason:
  v: Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
is summary:
  v: true
mapping:
  identity:
    v: rim
  map:
    v: N/A

id:
  v: BeModelPopulationScreening.invitation.date
path:
  v: BeModelPopulationScreening.invitation.date
short:
  v: The date the patient is invited to participate in the population based screening
definition:
  v: The date the patient is invited to participate in the population based screening
min:
  v: 1
max:
  v: 1
base:
  path:
    v: BeModelPopulationScreening.invitation.date
  min:
    v: 1
  max:
    v: 1
type:
  code:
    v: date

id:
  v: BeModelPopulationScreening.invitation.time
path:
  v: BeModelPopulationScreening.invitation.time
short:
  v: The time for the screening if there is a proposed appointment. This is the case for breast cancer screening.
definition:
  v: The time for the screening if there is a proposed appointment. This is the case for breast cancer screening.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: BeModelPopulationScreening.invitation.time
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: time

id:
  v: BeModelPopulationScreening.invitation.locationName
path:
  v: BeModelPopulationScreening.invitation.locationName
short:
  v: Human readable name of the location where the patient is invited to participate.
definition:
  v: For some screenings, but not all, a location is provided for the patient.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: BeModelPopulationScreening.invitation.locationName
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: string

id:
  v: BeModelPopulationScreening.invitation.locationAddress
path:
  v: BeModelPopulationScreening.invitation.locationAddress
short:
  v: Human readable address of the invitation location
definition:
  v: For some screenings, but not all, a location is provided for the patient.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: BeModelPopulationScreening.invitation.locationAddress
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: string

id:
  v: BeModelPopulationScreening.participation
path:
  v: BeModelPopulationScreening.participation
short:
  v: The participation details
definition:
  v: A participation is not mandatory. A patient can choose not to participate for a screening.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: BeModelPopulationScreening.participation
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: BackboneElement
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element

id:
  v: BeModelPopulationScreening.participation.id
path:
  v: BeModelPopulationScreening.participation.id
representation:
  v: xmlAttr
short:
  v: Unique id for inter-element referencing
definition:
  v: Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Element.id
  min:
    v: 0
  max:
    v: 1
type:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type
    value:
      v: string
  code:
    v: http://hl7.org/fhirpath/System.String
is modifier:
  v: false
is summary:
  v: false
mapping:
  identity:
    v: rim
  map:
    v: n/a

id:
  v: BeModelPopulationScreening.participation.extension
path:
  v: BeModelPopulationScreening.participation.extension
slicing:
  discriminator:
    type:
      v: value
    path:
      v: url
  description:
    v: Extensions are always sliced by (at least) url
  rules:
    v: open
short:
  v: Additional content defined by implementations
definition:
  v: 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:
  v: 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:
  v: extensions
alias:
  v: user content
min:
  v: 0
max:
  v: *
base:
  path:
    v: Element.extension
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Extension
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
constraint:
  key:
    v: ext-1
  severity:
    v: error
  human:
    v: Must have either extensions or value[x], not both
  expression:
    v: extension.exists() != value.exists()
  xpath:
    v: exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")])
  source:
    v: http://hl7.org/fhir/StructureDefinition/Extension
    link: http://hl7.org/fhir/StructureDefinition/Extension
is modifier:
  v: false
is summary:
  v: false
mapping:
  identity:
    v: rim
  map:
    v: n/a

id:
  v: BeModelPopulationScreening.participation.modifierExtension
path:
  v: BeModelPopulationScreening.participation.modifierExtension
short:
  v: Extensions that cannot be ignored even if unrecognized
definition:
  v: May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
comment:
  v: 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.
requirements:
  v: Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](http://hl7.org/fhir/R4/extensibility.html#modifierExtension).
alias:
  v: extensions
alias:
  v: user content
alias:
  v: modifiers
min:
  v: 0
max:
  v: *
base:
  path:
    v: BackboneElement.modifierExtension
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Extension
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
constraint:
  key:
    v: ext-1
  severity:
    v: error
  human:
    v: Must have either extensions or value[x], not both
  expression:
    v: extension.exists() != value.exists()
  xpath:
    v: exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")])
  source:
    v: http://hl7.org/fhir/StructureDefinition/Extension
    link: http://hl7.org/fhir/StructureDefinition/Extension
is modifier:
  v: true
is modifier reason:
  v: Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
is summary:
  v: true
mapping:
  identity:
    v: rim
  map:
    v: N/A

id:
  v: BeModelPopulationScreening.participation.date
path:
  v: BeModelPopulationScreening.participation.date
short:
  v: The date the patient participated in the population based screening
definition:
  v: The date the patient participated in the population based screening
min:
  v: 1
max:
  v: 1
base:
  path:
    v: BeModelPopulationScreening.participation.date
  min:
    v: 1
  max:
    v: 1
type:
  code:
    v: date

id:
  v: BeModelPopulationScreening.participation.locationName
path:
  v: BeModelPopulationScreening.participation.locationName
short:
  v: Human readable name of the location where the patient participated
definition:
  v: For some screenings, but not all, a location is provided for the patient.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: BeModelPopulationScreening.participation.locationName
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: string

id:
  v: BeModelPopulationScreening.participation.locationAddress
path:
  v: BeModelPopulationScreening.participation.locationAddress
short:
  v: Human readable address of the participation location
definition:
  v: For some screenings, but not all, a location is provided for the patient.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: BeModelPopulationScreening.participation.locationAddress
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: string

id:
  v: BeModelPopulationScreening.participation.result
path:
  v: BeModelPopulationScreening.participation.result
short:
  v: The result of participation in the population based screening
definition:
  v: Notify the patient if the result was abnormal/positive or normal/negative
min:
  v: 0
max:
  v: 1
base:
  path:
    v: BeModelPopulationScreening.participation.result
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: CodeableConcept

id:
  v: BeModelPopulationScreening.participation.followup
path:
  v: BeModelPopulationScreening.participation.followup
short:
  v: Details of proposed actions for the patient after the screening concluded.
definition:
  v: This data acts purely as info for the patient to inform the patient of proposed actions and should not be followed up by the screening authority.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: BeModelPopulationScreening.participation.followup
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: BackboneElement
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element

id:
  v: BeModelPopulationScreening.participation.followup.id
path:
  v: BeModelPopulationScreening.participation.followup.id
representation:
  v: xmlAttr
short:
  v: Unique id for inter-element referencing
definition:
  v: Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Element.id
  min:
    v: 0
  max:
    v: 1
type:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type
    value:
      v: string
  code:
    v: http://hl7.org/fhirpath/System.String
is modifier:
  v: false
is summary:
  v: false
mapping:
  identity:
    v: rim
  map:
    v: n/a

id:
  v: BeModelPopulationScreening.participation.followup.extension
path:
  v: BeModelPopulationScreening.participation.followup.extension
slicing:
  discriminator:
    type:
      v: value
    path:
      v: url
  description:
    v: Extensions are always sliced by (at least) url
  rules:
    v: open
short:
  v: Additional content defined by implementations
definition:
  v: 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:
  v: 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:
  v: extensions
alias:
  v: user content
min:
  v: 0
max:
  v: *
base:
  path:
    v: Element.extension
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Extension
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
constraint:
  key:
    v: ext-1
  severity:
    v: error
  human:
    v: Must have either extensions or value[x], not both
  expression:
    v: extension.exists() != value.exists()
  xpath:
    v: exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")])
  source:
    v: http://hl7.org/fhir/StructureDefinition/Extension
    link: http://hl7.org/fhir/StructureDefinition/Extension
is modifier:
  v: false
is summary:
  v: false
mapping:
  identity:
    v: rim
  map:
    v: n/a

id:
  v: BeModelPopulationScreening.participation.followup.modifierExtension
path:
  v: BeModelPopulationScreening.participation.followup.modifierExtension
short:
  v: Extensions that cannot be ignored even if unrecognized
definition:
  v: May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
comment:
  v: 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.
requirements:
  v: Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](http://hl7.org/fhir/R4/extensibility.html#modifierExtension).
alias:
  v: extensions
alias:
  v: user content
alias:
  v: modifiers
min:
  v: 0
max:
  v: *
base:
  path:
    v: BackboneElement.modifierExtension
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Extension
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
constraint:
  key:
    v: ext-1
  severity:
    v: error
  human:
    v: Must have either extensions or value[x], not both
  expression:
    v: extension.exists() != value.exists()
  xpath:
    v: exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")])
  source:
    v: http://hl7.org/fhir/StructureDefinition/Extension
    link: http://hl7.org/fhir/StructureDefinition/Extension
is modifier:
  v: true
is modifier reason:
  v: Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
is summary:
  v: true
mapping:
  identity:
    v: rim
  map:
    v: N/A

id:
  v: BeModelPopulationScreening.participation.followup.needed
path:
  v: BeModelPopulationScreening.participation.followup.needed
short:
  v: Indication if the patient should request or take other examinations/steps based on the outcome of the screening.
definition:
  v: Indication if the patient should request or take other examinations/steps based on the outcome of the screening.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: BeModelPopulationScreening.participation.followup.needed
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: boolean

id:
  v: BeModelPopulationScreening.participation.followup.advice
path:
  v: BeModelPopulationScreening.participation.followup.advice
short:
  v: Indication what other examinations/steps the patient should take.
definition:
  v: Indication what other examinations/steps the patient should take.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: BeModelPopulationScreening.participation.followup.advice
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: string

id:
  v: BeModelPopulationScreening.participation.followup.request
path:
  v: BeModelPopulationScreening.participation.followup.request
short:
  v: The other examinations that the patient should take.
definition:
  v: The other examinations that the patient should take.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: BeModelPopulationScreening.participation.followup.request
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: string

id:
  v: BeModelPopulationScreening.nextInvitation
path:
  v: BeModelPopulationScreening.nextInvitation
short:
  v: This field gives a short human readable indication for the patient if the patient can expect future invitations for the population based screening and an estimation when the next invitation will be created. If the patient will not receive future invitations for the screening, a short explanation will be given.
definition:
  v: This field gives a short human readable indication for the patient if the patient can expect future invitations for the population based screening and an estimation when the next invitation will be created. If the patient will not receive future invitations for the screening, a short explanation will be given.
min:
  v: 1
max:
  v: 1
base:
  path:
    v: BeModelPopulationScreening.nextInvitation
  min:
    v: 1
  max:
    v: 1
type:
  code:
    v: BackboneElement
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element

id:
  v: BeModelPopulationScreening.nextInvitation.id
path:
  v: BeModelPopulationScreening.nextInvitation.id
representation:
  v: xmlAttr
short:
  v: Unique id for inter-element referencing
definition:
  v: Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Element.id
  min:
    v: 0
  max:
    v: 1
type:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type
    value:
      v: string
  code:
    v: http://hl7.org/fhirpath/System.String
is modifier:
  v: false
is summary:
  v: false
mapping:
  identity:
    v: rim
  map:
    v: n/a

id:
  v: BeModelPopulationScreening.nextInvitation.extension
path:
  v: BeModelPopulationScreening.nextInvitation.extension
slicing:
  discriminator:
    type:
      v: value
    path:
      v: url
  description:
    v: Extensions are always sliced by (at least) url
  rules:
    v: open
short:
  v: Additional content defined by implementations
definition:
  v: 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:
  v: 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:
  v: extensions
alias:
  v: user content
min:
  v: 0
max:
  v: *
base:
  path:
    v: Element.extension
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Extension
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
constraint:
  key:
    v: ext-1
  severity:
    v: error
  human:
    v: Must have either extensions or value[x], not both
  expression:
    v: extension.exists() != value.exists()
  xpath:
    v: exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")])
  source:
    v: http://hl7.org/fhir/StructureDefinition/Extension
    link: http://hl7.org/fhir/StructureDefinition/Extension
is modifier:
  v: false
is summary:
  v: false
mapping:
  identity:
    v: rim
  map:
    v: n/a

id:
  v: BeModelPopulationScreening.nextInvitation.modifierExtension
path:
  v: BeModelPopulationScreening.nextInvitation.modifierExtension
short:
  v: Extensions that cannot be ignored even if unrecognized
definition:
  v: May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
comment:
  v: 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.
requirements:
  v: Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](http://hl7.org/fhir/R4/extensibility.html#modifierExtension).
alias:
  v: extensions
alias:
  v: user content
alias:
  v: modifiers
min:
  v: 0
max:
  v: *
base:
  path:
    v: BackboneElement.modifierExtension
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Extension
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
constraint:
  key:
    v: ext-1
  severity:
    v: error
  human:
    v: Must have either extensions or value[x], not both
  expression:
    v: extension.exists() != value.exists()
  xpath:
    v: exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")])
  source:
    v: http://hl7.org/fhir/StructureDefinition/Extension
    link: http://hl7.org/fhir/StructureDefinition/Extension
is modifier:
  v: true
is modifier reason:
  v: Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
is summary:
  v: true
mapping:
  identity:
    v: rim
  map:
    v: N/A

id:
  v: BeModelPopulationScreening.nextInvitation.type
path:
  v: BeModelPopulationScreening.nextInvitation.type
short:
  v: Type of the next invitation or lack of next invitation
definition:
  v: Type of the next invitation or lack of next invitation
min:
  v: 1
max:
  v: 1
base:
  path:
    v: BeModelPopulationScreening.nextInvitation.type
  min:
    v: 1
  max:
    v: 1
type:
  code:
    v: CodeableConcept

id:
  v: BeModelPopulationScreening.nextInvitation.date
path:
  v: BeModelPopulationScreening.nextInvitation.date
short:
  v: (Partial) date of next invitation, if applicable
definition:
  v: (Partial) date of next invitation, if applicable
min:
  v: 0
max:
  v: 1
base:
  path:
    v: BeModelPopulationScreening.nextInvitation.date
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: dateTime

element:
  id:
    v: BeModelPopulationScreening
  path:
    v: BeModelPopulationScreening
  short:
    v: Logical model for population screening event
  definition:
    v: Logical model for recurrent population based screening. The model represents one iteration of a screening, called episode. A patient can have multiple episodes for a given screening. A screening of a specific type for a given patient can be repeated after a certain period. Each time the screening is repeated results in a new episode.
element:
  id:
    v: BeModelPopulationScreening.patient
  path:
    v: BeModelPopulationScreening.patient
  short:
    v: The patient for the screening
  definition:
    v: The patient for the screening
  min:
    v: 1
  max:
    v: 1
  type:
    code:
      v: Reference
    target profile:
      v: http://hl7.org/fhir/StructureDefinition/Patient
      link: http://hl7.org/fhir/StructureDefinition/Patient
element:
  id:
    v: BeModelPopulationScreening.screeningType
  path:
    v: BeModelPopulationScreening.screeningType
  short:
    v: The related screening
  definition:
    v: The related screening, for example breast cancer, colon cancer or cervicalcancer.
  min:
    v: 1
  max:
    v: 1
  type:
    code:
      v: CodeableConcept
element:
  id:
    v: BeModelPopulationScreening.screeningYear
  path:
    v: BeModelPopulationScreening.screeningYear
  short:
    v: The calendar year of the screening
  definition:
    v: The year of the screening process/episode for the given screening. If the patient participated, the participation year is taken. If the patient didn't participate, the calendar year of the invitation is taken. If there is no invitation or participation, there will be no episode. For example, if patient is allowed a population based screening every 2 years for a given screening type and the first screening episode invitation took place in 2022, the next episode will be created for the next invitation in 2024. If the patient has a refusal or exclusion registered and does not have a participation/invitation, so the patient does not have any episodes, the calendar year of the registration of the refusal/exclusion is taken.
  min:
    v: 1
  max:
    v: 1
  type:
    code:
      v: string
element:
  id:
    v: BeModelPopulationScreening.invitation
  path:
    v: BeModelPopulationScreening.invitation
  short:
    v: The appointment details of the invitation
  definition:
    v: An invitation is not mandatory, in some cases a patient can participate for a screening without an invitation.
  min:
    v: 0
  max:
    v: 1
  type:
    code:
      v: BackboneElement
element:
  id:
    v: BeModelPopulationScreening.invitation.date
  path:
    v: BeModelPopulationScreening.invitation.date
  short:
    v: The date the patient is invited to participate in the population based screening
  definition:
    v: The date the patient is invited to participate in the population based screening
  min:
    v: 1
  max:
    v: 1
  type:
    code:
      v: date
element:
  id:
    v: BeModelPopulationScreening.invitation.time
  path:
    v: BeModelPopulationScreening.invitation.time
  short:
    v: The time for the screening if there is a proposed appointment. This is the case for breast cancer screening.
  definition:
    v: The time for the screening if there is a proposed appointment. This is the case for breast cancer screening.
  min:
    v: 0
  max:
    v: 1
  type:
    code:
      v: time
element:
  id:
    v: BeModelPopulationScreening.invitation.locationName
  path:
    v: BeModelPopulationScreening.invitation.locationName
  short:
    v: Human readable name of the location where the patient is invited to participate.
  definition:
    v: For some screenings, but not all, a location is provided for the patient.
  min:
    v: 0
  max:
    v: 1
  type:
    code:
      v: string
element:
  id:
    v: BeModelPopulationScreening.invitation.locationAddress
  path:
    v: BeModelPopulationScreening.invitation.locationAddress
  short:
    v: Human readable address of the invitation location
  definition:
    v: For some screenings, but not all, a location is provided for the patient.
  min:
    v: 0
  max:
    v: 1
  type:
    code:
      v: string
element:
  id:
    v: BeModelPopulationScreening.participation
  path:
    v: BeModelPopulationScreening.participation
  short:
    v: The participation details
  definition:
    v: A participation is not mandatory. A patient can choose not to participate for a screening.
  min:
    v: 0
  max:
    v: 1
  type:
    code:
      v: BackboneElement
element:
  id:
    v: BeModelPopulationScreening.participation.date
  path:
    v: BeModelPopulationScreening.participation.date
  short:
    v: The date the patient participated in the population based screening
  definition:
    v: The date the patient participated in the population based screening
  min:
    v: 1
  max:
    v: 1
  type:
    code:
      v: date
element:
  id:
    v: BeModelPopulationScreening.participation.locationName
  path:
    v: BeModelPopulationScreening.participation.locationName
  short:
    v: Human readable name of the location where the patient participated
  definition:
    v: For some screenings, but not all, a location is provided for the patient.
  min:
    v: 0
  max:
    v: 1
  type:
    code:
      v: string
element:
  id:
    v: BeModelPopulationScreening.participation.locationAddress
  path:
    v: BeModelPopulationScreening.participation.locationAddress
  short:
    v: Human readable address of the participation location
  definition:
    v: For some screenings, but not all, a location is provided for the patient.
  min:
    v: 0
  max:
    v: 1

code:
  v: string

id:
  v: BeModelPopulationScreening.participation.result
path:
  v: BeModelPopulationScreening.participation.result
short:
  v: The result of participation in the population based screening
definition:
  v: Notify the patient if the result was abnormal/positive or normal/negative
min:
  v: 0
max:
  v: 1
type:
  code:
    v: CodeableConcept

id:
  v: BeModelPopulationScreening.participation.followup
path:
  v: BeModelPopulationScreening.participation.followup
short:
  v: Details of proposed actions for the patient after the screening concluded.
definition:
  v: This data acts purely as info for the patient to inform the patient of proposed actions and should not be followed up by the screening authority.
min:
  v: 0
max:
  v: 1
type:
  code:
    v: BackboneElement

id:
  v: BeModelPopulationScreening.participation.followup.needed
path:
  v: BeModelPopulationScreening.participation.followup.needed
short:
  v: Indication if the patient should request or take other examinations/steps based on the outcome of the screening.
definition:
  v: Indication if the patient should request or take other examinations/steps based on the outcome of the screening.
min:
  v: 0
max:
  v: 1
type:
  code:
    v: boolean

id:
  v: BeModelPopulationScreening.participation.followup.advice
path:
  v: BeModelPopulationScreening.participation.followup.advice
short:
  v: Indication what other examinations/steps the patient should take.
definition:
  v: Indication what other examinations/steps the patient should take.
min:
  v: 0
max:
  v: 1
type:
  code:
    v: string

id:
  v: BeModelPopulationScreening.participation.followup.request
path:
  v: BeModelPopulationScreening.participation.followup.request
short:
  v: The other examinations that the patient should take.
definition:
  v: The other examinations that the patient should take.
min:
  v: 0
max:
  v: 1
type:
  code:
    v: string

id:
  v: BeModelPopulationScreening.nextInvitation
path:
  v: BeModelPopulationScreening.nextInvitation
short:
  v: This field gives a short human readable indication for the patient if the patient can expect future invitations for the population based screening and an estimation when the next invitation will be created. If the patient will not receive future invitations for the screening, a short explanation will be given.
definition:
  v: This field gives a short human readable indication for the patient if the patient can expect future invitations for the population based screening and an estimation when the next invitation will be created. If the patient will not receive future invitations for the screening, a short explanation will be given.
min:
  v: 1
max:
  v: 1
type:
  code:
    v: BackboneElement

id:
  v: BeModelPopulationScreening.nextInvitation.type
path:
  v: BeModelPopulationScreening.nextInvitation.type
short:
  v: Type of the next invitation or lack of next invitation
definition:
  v: Type of the next invitation or lack of next invitation
min:
  v: 1
max:
  v: 1
type:
  code:
    v: CodeableConcept

id:
  v: BeModelPopulationScreening.nextInvitation.date
path:
  v: BeModelPopulationScreening.nextInvitation.date
short:
  v: (Partial) date of next invitation, if applicable
definition:
  v: (Partial) date of next invitation, if applicable
min:
  v: 0
max:
  v: 1
type:
  code:
    v: dateTime