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

Active as of 2023-10-16

Definitions for the BeModelPopulationScreening logical model.

- Differential Elements Table
- Key Elements Table
- Snapshot Elements Table

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

0. BeModelPopulationScreening
Definition | 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.
Short | Logical model for population screening event
Logical Model | Instances of this logical model are not marked to be the target of a Reference
2. BeModelPopulationScreening.patient
Definition | The patient for the screening
Short | The patient for the screening
Control | 1..1
Type | Reference(Patient)
4. BeModelPopulationScreening.screeningType
Definition | The related screening, for example breast cancer, colon cancer or cervicalcancer.
Short | The related screening
Control | 1..1
Type | CodeableConcept
6. BeModelPopulationScreening.screeningYear
Definition | 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.
Short | The calendar year of the screening
Control | 1..1
Type | string
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
8. BeModelPopulationScreening.invitation
Definition | An invitation is not mandatory, in some cases a patient can participate for a screening without an invitation.
Short | The appointment details of the invitation
Control | 0..1
Type | BackboneElement
10. BeModelPopulationScreening.invitation.date
Definition | The date the patient is invited to participate in the population based screening
Short | The date the patient is invited to participate in the population based screening
Control | 1..1
Type | date
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
12. BeModelPopulationScreening.invitation.time
Definition | The time for the screening if there is a proposed appointment. This is the case for breast cancer screening.
Short | The time for the screening if there is a proposed appointment. This is the case for breast cancer screening.
Control | 0..1
Type | time
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
14. BeModelPopulationScreening.invitation.locationName
Definition | For some screenings, but not all, a location is provided for the patient.
Short | Human readable name of the location where the patient is invited to participate.
Control | 0..1
Type | string
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
16. BeModelPopulationScreening.invitation.locationAddress
Definition | For some screenings, but not all, a location is provided for the patient.
Short | Human readable address of the invitation location
Control | 0..1
Type | string
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
18. BeModelPopulationScreening.participation
Definition | A participation is not mandatory. A patient can choose not to participate for a screening.
Short | The participation details
Control | 0..1
Type | BackboneElement
20. BeModelPopulationScreening.participation.date
Definition | The date the patient participated in the population based screening
Short | The date the patient participated in the population based screening
Control | 1..1
Type | date
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
22. BeModelPopulationScreening.participation.locationName
Definition | For some screenings, but not all, a location is provided for the patient.
Short | Human readable name of the location where the patient participated
Control | 0..1
Type | string
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
24. BeModelPopulationScreening.participation.locationAddress
Definition | For some screenings, but not all, a location is provided for the patient.
Short | Human readable address of the participation location
Control | 0..1
Type | string
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
26. BeModelPopulationScreening.participation.result
Definition | Notify the patient if the result was abnormal/positive or normal/negative
Short | The result of participation in the population based screening
Control | 0..1
Type | CodeableConcept
28. BeModelPopulationScreening.participation.followup
Definition | 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.
Short | Details of proposed actions for the patient after the screening concluded.
Control | 0..1
Type | BackboneElement
30. BeModelPopulationScreening.participation.followup.needed
Definition | Indication if the patient should request or take other examinations/steps based on the outcome of the screening.
Short | Indication if the patient should request or take other examinations/steps based on the outcome of the screening.
Control | 0..1
Type | boolean
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
32. BeModelPopulationScreening.participation.followup.advice
Definition | Indication what other examinations/steps the patient should take.
Short | Indication what other examinations/steps the patient should take.
Control | 0..1
Type | string
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
34. BeModelPopulationScreening.participation.followup.request
Definition | The other examinations that the patient should take.
Short | The other examinations that the patient should take.
Control | 0..1
Type | string
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
36. BeModelPopulationScreening.nextInvitation
Definition | 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.
Short | 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.
Control | 1..1
Type | BackboneElement
38. BeModelPopulationScreening.nextInvitation.type
Definition | Type of the next invitation or lack of next invitation
Short | Type of the next invitation or lack of next invitation
Control | 1..1
Type | CodeableConcept
40. BeModelPopulationScreening.nextInvitation.date
Definition | (Partial) date of next invitation, if applicable
Short | (Partial) date of next invitation, if applicable
Control | 0..1
Type | dateTime
Primitive Value | This primitive element may be present, or absent, or replaced by an extension

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

0. BeModelPopulationScreening
Definition | 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. Base definition for all elements in a resource.
Short | Logical model for population screening eventBase for all elements
Control | 0..* This element is affected by the following invariants: ele-1
Is Modifier | false
Logical Model | Instances of this logical model are not marked to be the target of a Reference
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2. BeModelPopulationScreening.patient
Definition | The patient for the screening
Short | The patient for the screening
Control | 1..1
Type | Reference(Patient)
4. BeModelPopulationScreening.screeningType
Definition | The related screening, for example breast cancer, colon cancer or cervicalcancer.
Short | The related screening
Control | 1..1
Type | CodeableConcept
6. BeModelPopulationScreening.screeningYear
Definition | 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.
Short | The calendar year of the screening
Control | 1..1
Type | string
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
8. BeModelPopulationScreening.invitation
Definition | An invitation is not mandatory, in some cases a patient can participate for a screening without an invitation.
Short | The appointment details of the invitation
Control | 0..1
Type | BackboneElement
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
10. BeModelPopulationScreening.invitation.modifierExtension
Definition | 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).
Short | Extensions that cannot be ignored even if unrecognized
Comments | 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.
Control | 0..*
Type | Extension
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summary | true
Requirements | 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.
Alternate Names | extensions, user content, modifiers
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
12. BeModelPopulationScreening.invitation.date
Definition | The date the patient is invited to participate in the population based screening
Short | The date the patient is invited to participate in the population based screening
Control | 1..1
Type | date
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
14. BeModelPopulationScreening.invitation.time
Definition | The time for the screening if there is a proposed appointment. This is the case for breast cancer screening.
Short | The time for the screening if there is a proposed appointment. This is the case for breast cancer screening.
Control | 0..1
Type | time
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
16. BeModelPopulationScreening.invitation.locationName
Definition | For some screenings, but not all, a location is provided for the patient.
Short | Human readable name of the location where the patient is invited to participate.
Control | 0..1
Type | string
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
18. BeModelPopulationScreening.invitation.locationAddress
Definition | For some screenings, but not all, a location is provided for the patient.
Short | Human readable address of the invitation location
Control | 0..1
Type | string
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
20. BeModelPopulationScreening.participation
Definition | A participation is not mandatory. A patient can choose not to participate for a screening.
Short | The participation details
Control | 0..1
Type | BackboneElement
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
22. BeModelPopulationScreening.participation.modifierExtension
Definition | 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).
Short | Extensions that cannot be ignored even if unrecognized
Comments | 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.
Control | 0..*
Type | Extension
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summary | true
Requirements | 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.
Alternate Names | extensions, user content, modifiers
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
24. BeModelPopulationScreening.participation.date
Definition | The date the patient participated in the population based screening
Short | The date the patient participated in the population based screening
Control | 1..1
Type | date
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
26. BeModelPopulationScreening.participation.locationName
Definition | For some screenings, but not all, a location is provided for the patient.
Short | Human readable name of the location where the patient participated
Control | 0..1
Type | string
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
28. BeModelPopulationScreening.participation.locationAddress
Definition | For some screenings, but not all, a location is provided for the patient.
Short | Human readable address of the participation location
Control | 0..1
Type | string
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
30. BeModelPopulationScreening.participation.result
Definition | Notify the patient if the result was abnormal/positive or normal/negative
Short | The result of participation in the population based screening
Control | 0..1
Type | CodeableConcept
32. BeModelPopulationScreening.participation.followup
Definition | 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.
Short | Details of proposed actions for the patient after the screening concluded.
Control | 0..1
Type | BackboneElement
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
34. BeModelPopulationScreening.participation.followup.modifierExtension
Definition | 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).
Short | Extensions that cannot be ignored even if unrecognized
Comments | 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.
Control | 0..*
Type | Extension
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summary | true
Requirements | 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.
Alternate Names | extensions, user content, modifiers
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
36. BeModelPopulationScreening.participation.followup.needed
Definition | Indication if the patient should request or take other examinations/steps based on the outcome of the screening.
Short | Indication if the patient should request or take other examinations/steps based on the outcome of the screening.
Control | 0..1
Type | boolean
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
38. BeModelPopulationScreening.participation.followup.advice
Definition | Indication what other examinations/steps the patient should take.
Short | Indication what other examinations/steps the patient should take.
Control | 0..1
Type | string
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
40. BeModelPopulationScreening.participation.followup.request
Definition | The other examinations that the patient should take.
Short | The other examinations that the patient should take.
Control | 0..1
Type | string
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
42. BeModelPopulationScreening.nextInvitation
Definition | 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.
Short | 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.
Control | 1..1
Type | BackboneElement
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
44. BeModelPopulationScreening.nextInvitation.modifierExtension
Definition | 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).
Short | Extensions that cannot be ignored even if unrecognized
Comments | 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.
Control | 0..*
Type | Extension
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summary | true
Requirements | 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.
Alternate Names | extensions, user content, modifiers
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
46. BeModelPopulationScreening.nextInvitation.type
Definition | Type of the next invitation or lack of next invitation
Short | Type of the next invitation or lack of next invitation
Control | 1..1
Type | CodeableConcept
48. BeModelPopulationScreening.nextInvitation.date
Definition | (Partial) date of next invitation, if applicable
Short | (Partial) date of next invitation, if applicable
Control | 0..1
Type | dateTime
Primitive Value | This primitive element may be present, or absent, or replaced by an extension

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

0. BeModelPopulationScreening
Definition | 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.
Short | Logical model for population screening event
Control | 0..* This element is affected by the following invariants: ele-1
Is Modifier | false
Logical Model | Instances of this logical model are not marked to be the target of a Reference
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
2. BeModelPopulationScreening.id
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Short | Unique id for inter-element referencing
Control | 0..1
Type | string
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
4. BeModelPopulationScreening.extension
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.
Short | Additional content defined by implementations
Comments | 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.
Control | 0..*
Type | Extension
Is Modifier | false
Summary | false
Alternate Names | extensions, user content
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
Slicing | This element introduces a set of slices on `BeModelPopulationScreening.extension`. The slices are unordered and Open, and can be differentiated using the following discriminators: , and can be differentiated using the following discriminators: value @ url
6. BeModelPopulationScreening.patient
Definition | The patient for the screening
Short | The patient for the screening
Control | 1..1
Type | Reference(Patient)
8. BeModelPopulationScreening.screeningType
Definition | The related screening, for example breast cancer, colon cancer or cervicalcancer.
Short | The related screening
Control | 1..1
Type | CodeableConcept
10. BeModelPopulationScreening.screeningYear
Definition | 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.
Short | The calendar year of the screening
Control | 1..1
Type | string
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
12. BeModelPopulationScreening.invitation
Definition | An invitation is not mandatory, in some cases a patient can participate for a screening without an invitation.
Short | The appointment details of the invitation
Control | 0..1
Type | BackboneElement
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
14. BeModelPopulationScreening.invitation.id
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Short | Unique id for inter-element referencing
Control | 0..1
Type | string
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
16. BeModelPopulationScreening.invitation.extension
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.
Short | Additional content defined by implementations
Comments | 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.
Control | 0..*
Type | Extension
Is Modifier | false
Summary | false
Alternate Names | extensions, user content
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
Slicing | This element introduces a set of slices on `BeModelPopulationScreening.invitation.extension`. The slices are unordered and Open, and can be differentiated using the following discriminators: , and can be differentiated using the following discriminators: value @ url
18. BeModelPopulationScreening.invitation.modifierExtension
Definition | 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.
Short | Extensions that cannot be ignored even if unrecognized
Comments | 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.
Control | 0..*
Type | Extension
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summary | true
Requirements | 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.
Alternate Names | extensions, user content, modifiers
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
20. BeModelPopulationScreening.invitation.date
Definition | The date the patient is invited to participate in the population based screening
Short | The date the patient is invited to participate in the population based screening
Control | 1..1
Type | date
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
22. BeModelPopulationScreening.invitation.time
Definition | The time for the screening if there is a proposed appointment. This is the case for breast cancer screening.
Short | The time for the screening if there is a proposed appointment. This is the case for breast cancer screening.
Control | 0..1
Type | time
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
24. BeModelPopulationScreening.invitation.locationName
Definition | For some screenings, but not all, a location is provided for the patient.
Short | Human readable name of the location where the patient is invited to participate.
Control | 0..1
Type | string
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
26. BeModelPopulationScreening.invitation.locationAddress
Definition | For some screenings, but not all, a location is provided for the patient.
Short | Human readable address of the invitation location
Control | 0..1
Type | string
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
28. BeModelPopulationScreening.participation
Definition | A participation is not mandatory. A patient can choose not to participate for a screening.
Short | The participation details
Control | 0..1
Type | BackboneElement
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
30. BeModelPopulationScreening.participation.id
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Short | Unique id for inter-element referencing
Control | 0..1
Type | string
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
32. BeModelPopulationScreening.participation.extension
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.
Short | Additional content defined by implementations
Comments | 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.
Control | 0..*
Type | Extension
Is Modifier | false
Summary | false
Alternate Names | extensions, user content
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
Slicing | This element introduces a set of slices on `BeModelPopulationScreening.participation.extension`. The slices are unordered and Open, and can be differentiated using the following discriminators: , and can be differentiated using the following discriminators: value @ url
34. BeModelPopulationScreening.participation.modifierExtension
Definition | 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.
Short | Extensions that cannot be ignored even if unrecognized
Comments | 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.
Control | 0..*
Type | Extension
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summary | true
Requirements | 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.
Alternate Names | extensions, user content, modifiers
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
36. BeModelPopulationScreening.participation.date
Definition | The date the patient participated in the population based screening
Short | The date the patient participated in the population based screening
Control | 1..1
Type | date
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
38. BeModelPopulationScreening.participation.locationName
Definition | For some screenings, but not all, a location is provided for the patient.
Short | Human readable name of the location where the patient participated
Control | 0..1
Type | string
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
40. BeModelPopulationScreening.participation.locationAddress
Definition | For some screenings, but not all, a location is provided for the patient.
Short | Human readable address of the participation location
Control | 0..1
Type | string
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
42. BeModelPopulationScreening.participation.result
Definition | Notify the patient if the result was abnormal/positive or normal/negative
Short | The result of participation in the population based screening
Control | 0..1
Type | CodeableConcept
44. BeModelPopulationScreening.participation.followup
Definition | 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.
Short | Details of proposed actions for the patient after the screening concluded.
Control | 0..1
Type | BackboneElement
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
46. BeModelPopulationScreening.participation.followup.id
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Short | Unique id for inter-element referencing
Control | 0..1
Type | string
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
48. BeModelPopulationScreening.participation.followup.extension
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.
Short | Additional content defined by implementations
Comments | 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.
Control | 0..*
Type | Extension
Is Modifier | false
Summary | false
Alternate Names | extensions, user content
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
Slicing | This element introduces a set of slices on `BeModelPopulationScreening.participation.followup.extension`. The slices are unordered and Open, and can be differentiated using the following discriminators: , and can be differentiated using the following discriminators: value @ url
50. BeModelPopulationScreening.participation.followup.modifierExtension
Definition | 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.
Short | Extensions that cannot be ignored even if unrecognized
Comments | 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.
Control | 0..*
Type | Extension
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summary | true
Requirements | 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.
Alternate Names | extensions, user content, modifiers
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
52. BeModelPopulationScreening.participation.followup.needed
Definition | Indication if the patient should request or take other examinations/steps based on the outcome of the screening.
Short | Indication if the patient should request or take other examinations/steps based on the outcome of the screening.
Control | 0..1
Type | boolean
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
54. BeModelPopulationScreening.participation.followup.advice
Definition | Indication what other examinations/steps the patient should take.
Short | Indication what other examinations/steps the patient should take.
Control | 0..1
Type | string
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
56. BeModelPopulationScreening.participation.followup.request
Definition | The other examinations that the patient should take.
Short | The other examinations that the patient should take.
Control | 0..1
Type | string
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
58. BeModelPopulationScreening.nextInvitation
Definition | 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.
Short | 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.
Control | 1..1
Type | BackboneElement
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
60. BeModelPopulationScreening.nextInvitation.id
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Short | Unique id for inter-element referencing
Control | 0..1
Type | string
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
62. BeModelPopulationScreening.nextInvitation.extension
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.
Short | Additional content defined by implementations
Comments | 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.
Control | 0..*
Type | Extension
Is Modifier | false
Summary | false
Alternate Names | extensions, user content
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
Slicing | This element introduces a set of slices on `BeModelPopulationScreening.nextInvitation.extension`. The slices are unordered and Open, and can be differentiated using the following discriminators: , and can be differentiated using the following discriminators: value @ url
64. BeModelPopulationScreening.nextInvitation.modifierExtension
Definition | 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.
Short | Extensions that cannot be ignored even if unrecognized
Comments | 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.
Control | 0..*
Type | Extension
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summary | true
Requirements | 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.
Alternate Names | extensions, user content, modifiers
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
66. BeModelPopulationScreening.nextInvitation.type
Definition | Type of the next invitation or lack of next invitation
Short | Type of the next invitation or lack of next invitation
Control | 1..1
Type | CodeableConcept
68. BeModelPopulationScreening.nextInvitation.date
Definition | (Partial) date of next invitation, if applicable
Short | (Partial) date of next invitation, if applicable
Control | 0..1
Type | dateTime
Primitive Value | This primitive element may be present, or absent, or replaced by an extension