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

HL7 FHIR Implementation Guide: Public Health IG Release 1 - BE Realm | STU1 - Local Development build (v1.0.1). See the Directory of published versions

## Logical Model: BeModelPopulationScreening - Detailed Descriptions

Active as of 2023-08-11

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.

1. 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.
Control | 0..?
Logical Model | This logical model cannot be the target of a reference
2. BeModelPopulationScreening.patient
Definition | The patient for the screening
Control | 1..1
Type | Reference(Patient)
3. BeModelPopulationScreening.screeningType
Definition | The related screening, for example breast cancer, colon cancer or cervicalcancer.
Control | 1..1
Type | CodeableConcept
4. 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.
Control | 1..1
Type | string
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
5. BeModelPopulationScreening.invitation
Definition | An invitation is not mandatory, in some cases a patient can participate for a screening without an invitation.
Control | 0..1
Type | BackboneElement
6. BeModelPopulationScreening.invitation.date
Definition | 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
7. BeModelPopulationScreening.invitation.time
Definition | 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
8. BeModelPopulationScreening.invitation.locationName
Definition | For some screenings, but not all, a location is provided for the patient.
Control | 0..1
Type | string
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
9. BeModelPopulationScreening.invitation.locationAddress
Definition | For some screenings, but not all, a location is provided for the patient.
Control | 0..1
Type | string
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
10. BeModelPopulationScreening.participation
Definition | A participation is not mandatory. A patient can choose not to participate for a screening.
Control | 0..1
Type | BackboneElement
11. BeModelPopulationScreening.participation.date
Definition | 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
12. BeModelPopulationScreening.participation.locationName
Definition | For some screenings, but not all, a location is provided for the patient.
Control | 0..1
Type | string
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
13. BeModelPopulationScreening.participation.locationAddress
Definition | For some screenings, but not all, a location is provided for the patient.
Control | 0..1
Type | string
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
14. BeModelPopulationScreening.participation.result
Definition | Notify the patient if the result was abnormal/positive or normal/negative
Control | 0..1
Type | CodeableConcept
15. 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.
Control | 0..1
Type | BackboneElement
16. BeModelPopulationScreening.participation.followup.needed
Definition | 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
17. BeModelPopulationScreening.participation.followup.advice
Definition | 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
18. BeModelPopulationScreening.participation.followup.request
Definition | 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
19. 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.
Control | 1..1
Type | BackboneElement
20. BeModelPopulationScreening.nextInvitation.type
Definition | Type of the next invitation or lack of next invitation
Control | 1..1
Type | CodeableConcept
21. BeModelPopulationScreening.nextInvitation.date
Definition | (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.

1. 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.
Control | 0..* This element is affected by the following invariants: ele-1
Logical Model | This logical model cannot be the target of a reference
Invariants | Defined on this element 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
Control | 1..1
Type | Reference(Patient)
3. BeModelPopulationScreening.screeningType
Definition | The related screening, for example breast cancer, colon cancer or cervicalcancer.
Control | 1..1
Type | CodeableConcept
4. 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.
Control | 1..1
Type | string
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
5. BeModelPopulationScreening.invitation
Definition | An invitation is not mandatory, in some cases a patient can participate for a screening without an invitation.
Control | 0..1
Type | BackboneElement
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
6. 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).
Control | 0..*
Type | Extension
Is Modifier | true
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
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.
Invariants | Defined on this element 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())
7. BeModelPopulationScreening.invitation.date
Definition | 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
8. BeModelPopulationScreening.invitation.time
Definition | 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
9. BeModelPopulationScreening.invitation.locationName
Definition | For some screenings, but not all, a location is provided for the patient.
Control | 0..1
Type | string
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
10. BeModelPopulationScreening.invitation.locationAddress
Definition | For some screenings, but not all, a location is provided for the patient.
Control | 0..1
Type | string
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
11. BeModelPopulationScreening.participation
Definition | A participation is not mandatory. A patient can choose not to participate for a screening.
Control | 0..1
Type | BackboneElement
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
12. 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).
Control | 0..*
Type | Extension
Is Modifier | true
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
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.
Invariants | Defined on this element 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())
13. BeModelPopulationScreening.participation.date
Definition | 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
14. BeModelPopulationScreening.participation.locationName
Definition | For some screenings, but not all, a location is provided for the patient.
Control | 0..1
Type | string
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
15. BeModelPopulationScreening.participation.locationAddress
Definition | For some screenings, but not all, a location is provided for the patient.
Control | 0..1
Type | string
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
16. BeModelPopulationScreening.participation.result
Definition | Notify the patient if the result was abnormal/positive or normal/negative
Control | 0..1
Type | CodeableConcept
17. 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.
Control | 0..1
Type | BackboneElement
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
18. 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).
Control | 0..*
Type | Extension
Is Modifier | true
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
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.
Invariants | Defined on this element 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())
19. BeModelPopulationScreening.participation.followup.needed
Definition | 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
20. BeModelPopulationScreening.participation.followup.advice
Definition | 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
21. BeModelPopulationScreening.participation.followup.request
Definition | 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
22. 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.
Control | 1..1
Type | BackboneElement
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
23. 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).
Control | 0..*
Type | Extension
Is Modifier | true
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
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.
Invariants | Defined on this element 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.nextInvitation.type
Definition | Type of the next invitation or lack of next invitation
Control | 1..1
Type | CodeableConcept
25. BeModelPopulationScreening.nextInvitation.date
Definition | (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.

1. 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.
Control | 0..* This element is affected by the following invariants: ele-1
Logical Model | This logical model cannot be the target of a reference
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.
Control | 0..1
Type | string
XML Representation | In the XML format, this property is represented as an attribute.
Summary | false
3. 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.
Control | 0..*
Type | Extension
Summary | false
Alternate Names | extensions, user content
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.
Invariants | Defined on this element 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: value @ url
4. BeModelPopulationScreening.patient
Definition | The patient for the screening
Control | 1..1
Type | Reference(Patient)
5. BeModelPopulationScreening.screeningType
Definition | The related screening, for example breast cancer, colon cancer or cervicalcancer.
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.
Control | 1..1
Type | string
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
7. BeModelPopulationScreening.invitation
Definition | An invitation is not mandatory, in some cases a patient can participate for a screening without an invitation.
Control | 0..1
Type | BackboneElement
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
8. 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.
Control | 0..1
Type | string
XML Representation | In the XML format, this property is represented as an attribute.
Summary | false
9. 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.
Control | 0..*
Type | Extension
Summary | false
Alternate Names | extensions, user content
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.
Invariants | Defined on this element 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: value @ url
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).
Control | 0..*
Type | Extension
Is Modifier | true
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
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.
Invariants | Defined on this element 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())
11. BeModelPopulationScreening.invitation.date
Definition | 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.
Control | 0..1
Type | time
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
13. BeModelPopulationScreening.invitation.locationName
Definition | For some screenings, but not all, a location is provided for the patient.
Control | 0..1
Type | string
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
14. BeModelPopulationScreening.invitation.locationAddress
Definition | For some screenings, but not all, a location is provided for the patient.
Control | 0..1
Type | string
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
15. BeModelPopulationScreening.participation
Definition | A participation is not mandatory. A patient can choose not to participate for a screening.
Control | 0..1
Type | BackboneElement
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
16. 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.
Control | 0..1
Type | string
XML Representation | In the XML format, this property is represented as an attribute.
Summary | false
17. 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.
Control | 0..*
Type | Extension
Summary | false
Alternate Names | extensions, user content
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.
Invariants | Defined on this element 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: value @ url
18. 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).
Control | 0..*
Type | Extension
Is Modifier | true
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
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.
Invariants | Defined on this element 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())
19. BeModelPopulationScreening.participation.date
Definition | 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
20. BeModelPopulationScreening.participation.locationName
Definition | For some screenings, but not all, a location is provided for the patient.
Control | 0..1
Type | string
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
21. BeModelPopulationScreening.participation.locationAddress
Definition | For some screenings, but not all, a location is provided for the patient.
Control | 0..1
Type | string
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
22. BeModelPopulationScreening.participation.result
Definition | Notify the patient if the result was abnormal/positive or normal/negative
Control | 0..1
Type | CodeableConcept
23. 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.
Control | 0..1
Type | BackboneElement
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
24. 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.
Control | 0..1
Type | string
XML Representation | In the XML format, this property is represented as an attribute.
Summary | false
25. 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.
Control | 0..*
Type | Extension
Summary | false
Alternate Names | extensions, user content
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.
Invariants | Defined on this element 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: value @ url
26. 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).
Control | 0..*
Type | Extension
Is Modifier | true
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
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.
Invariants | Defined on this element 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())
27. BeModelPopulationScreening.participation.followup.needed
Definition | 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
28. BeModelPopulationScreening.participation.followup.advice
Definition | 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
29. BeModelPopulationScreening.participation.followup.request
Definition | 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
30. 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.
Control | 1..1
Type | BackboneElement
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
31. 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.
Control | 0..1
Type | string
XML Representation | In the XML format, this property is represented as an attribute.
Summary | false
32. 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.
Control | 0..*
Type | Extension
Summary | false
Alternate Names | extensions, user content
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.
Invariants | Defined on this element 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: value @ url
33. 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).
Control | 0..*
Type | Extension
Is Modifier | true
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
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.
Invariants | Defined on this element 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())
34. BeModelPopulationScreening.nextInvitation.type
Definition | Type of the next invitation or lack of next invitation
Control | 1..1
Type | CodeableConcept
35. BeModelPopulationScreening.nextInvitation.date
Definition | (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