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: Logical model for population screening event

Official URL: https://www.ehealth.fgov.be/standards/fhir/public-health/StructureDefinition/BeModelPopulationScreening | Version: 1.0.2
Active as of 2023-10-16 | Computable Name: BeModelPopulationScreening

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.

Usage:

- Use this Logical Model Profile: Logical model for population screening plan

### Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

- Differential Table
- Key Elements Table
- Snapshot Table
- Statistics/References
- All

This structure is derived from Element

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
BeModelPopulationScreening |  | 0..* | Element | Elements defined in Ancestors: @id, extension Logical model for population screening event Instances of this logical model are not marked to be the target of a Reference
patient |  | 1..1 | Reference(Patient) | The patient for the screening
screeningType |  | 1..1 | CodeableConcept | The related screening
screeningYear |  | 1..1 | string | The calendar year of the screening
invitation |  | 0..1 | BackboneElement | The appointment details of the invitation
date |  | 1..1 | date | The date the patient is invited to participate in the population based screening
time |  | 0..1 | time | The time for the screening if there is a proposed appointment. This is the case for breast cancer screening.
locationName |  | 0..1 | string | Human readable name of the location where the patient is invited to participate.
locationAddress |  | 0..1 | string | Human readable address of the invitation location
participation |  | 0..1 | BackboneElement | The participation details
date |  | 1..1 | date | The date the patient participated in the population based screening
locationName |  | 0..1 | string | Human readable name of the location where the patient participated
locationAddress |  | 0..1 | string | Human readable address of the participation location
result |  | 0..1 | CodeableConcept | The result of participation in the population based screening
followup |  | 0..1 | BackboneElement | Details of proposed actions for the patient after the screening concluded.
needed |  | 0..1 | boolean | Indication if the patient should request or take other examinations/steps based on the outcome of the screening.
advice |  | 0..1 | string | Indication what other examinations/steps the patient should take.
request |  | 0..1 | string | The other examinations that the patient should take.
nextInvitation |  | 1..1 | BackboneElement | 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.
type |  | 1..1 | CodeableConcept | Type of the next invitation or lack of next invitation
date |  | 0..1 | dateTime | (Partial) date of next invitation, if applicable
Documentation for this format

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
BeModelPopulationScreening |  | 0..* | Element | Elements defined in Ancestors: @id, extension Logical model for population screening event Instances of this logical model are not marked to be the target of a Reference
patient |  | 1..1 | Reference(Patient) | The patient for the screening
screeningType |  | 1..1 | CodeableConcept | The related screening
screeningYear |  | 1..1 | string | The calendar year of the screening
invitation |  | 0..1 | BackboneElement | The appointment details of the invitation
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
date |  | 1..1 | date | The date the patient is invited to participate in the population based screening
time |  | 0..1 | time | The time for the screening if there is a proposed appointment. This is the case for breast cancer screening.
locationName |  | 0..1 | string | Human readable name of the location where the patient is invited to participate.
locationAddress |  | 0..1 | string | Human readable address of the invitation location
participation |  | 0..1 | BackboneElement | The participation details
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
date |  | 1..1 | date | The date the patient participated in the population based screening
locationName |  | 0..1 | string | Human readable name of the location where the patient participated
locationAddress |  | 0..1 | string | Human readable address of the participation location
result |  | 0..1 | CodeableConcept | The result of participation in the population based screening
followup |  | 0..1 | BackboneElement | Details of proposed actions for the patient after the screening concluded.
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
needed |  | 0..1 | boolean | Indication if the patient should request or take other examinations/steps based on the outcome of the screening.
advice |  | 0..1 | string | Indication what other examinations/steps the patient should take.
request |  | 0..1 | string | The other examinations that the patient should take.
nextInvitation |  | 1..1 | BackboneElement | 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.
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
type |  | 1..1 | CodeableConcept | Type of the next invitation or lack of next invitation
date |  | 0..1 | dateTime | (Partial) date of next invitation, if applicable
Documentation for this format

#### Constraints

Id | Grade | Path(s) | Details | Requirements
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
BeModelPopulationScreening |  | 0..* | Element | Elements defined in Ancestors: @id, extension Logical model for population screening event Instances of this logical model are not marked to be the target of a Reference
@id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
patient |  | 1..1 | Reference(Patient) | The patient for the screening
screeningType |  | 1..1 | CodeableConcept | The related screening
screeningYear |  | 1..1 | string | The calendar year of the screening
invitation |  | 0..1 | BackboneElement | The appointment details of the invitation
@id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
date |  | 1..1 | date | The date the patient is invited to participate in the population based screening
time |  | 0..1 | time | The time for the screening if there is a proposed appointment. This is the case for breast cancer screening.
locationName |  | 0..1 | string | Human readable name of the location where the patient is invited to participate.
locationAddress |  | 0..1 | string | Human readable address of the invitation location
participation |  | 0..1 | BackboneElement | The participation details
@id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
date |  | 1..1 | date | The date the patient participated in the population based screening
locationName |  | 0..1 | string | Human readable name of the location where the patient participated
locationAddress |  | 0..1 | string | Human readable address of the participation location
result |  | 0..1 | CodeableConcept | The result of participation in the population based screening
followup |  | 0..1 | BackboneElement | Details of proposed actions for the patient after the screening concluded.
@id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
needed |  | 0..1 | boolean | Indication if the patient should request or take other examinations/steps based on the outcome of the screening.
advice |  | 0..1 | string | Indication what other examinations/steps the patient should take.
request |  | 0..1 | string | The other examinations that the patient should take.
nextInvitation |  | 1..1 | BackboneElement | 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.
@id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
type |  | 1..1 | CodeableConcept | Type of the next invitation or lack of next invitation
date |  | 0..1 | dateTime | (Partial) date of next invitation, if applicable
Documentation for this format

#### Constraints

Id | Grade | Path(s) | Details | Requirements
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |

This structure is derived from Element

Summary

Mandatory: 0 element (7 nested mandatory elements)

Differential View

This structure is derived from Element

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
BeModelPopulationScreening |  | 0..* | Element | Elements defined in Ancestors: @id, extension Logical model for population screening event Instances of this logical model are not marked to be the target of a Reference
patient |  | 1..1 | Reference(Patient) | The patient for the screening
screeningType |  | 1..1 | CodeableConcept | The related screening
screeningYear |  | 1..1 | string | The calendar year of the screening
invitation |  | 0..1 | BackboneElement | The appointment details of the invitation
date |  | 1..1 | date | The date the patient is invited to participate in the population based screening
time |  | 0..1 | time | The time for the screening if there is a proposed appointment. This is the case for breast cancer screening.
locationName |  | 0..1 | string | Human readable name of the location where the patient is invited to participate.
locationAddress |  | 0..1 | string | Human readable address of the invitation location
participation |  | 0..1 | BackboneElement | The participation details
date |  | 1..1 | date | The date the patient participated in the population based screening
locationName |  | 0..1 | string | Human readable name of the location where the patient participated
locationAddress |  | 0..1 | string | Human readable address of the participation location
result |  | 0..1 | CodeableConcept | The result of participation in the population based screening
followup |  | 0..1 | BackboneElement | Details of proposed actions for the patient after the screening concluded.
needed |  | 0..1 | boolean | Indication if the patient should request or take other examinations/steps based on the outcome of the screening.
advice |  | 0..1 | string | Indication what other examinations/steps the patient should take.
request |  | 0..1 | string | The other examinations that the patient should take.
nextInvitation |  | 1..1 | BackboneElement | 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.
type |  | 1..1 | CodeableConcept | Type of the next invitation or lack of next invitation
date |  | 0..1 | dateTime | (Partial) date of next invitation, if applicable
Documentation for this format

Key Elements View

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
BeModelPopulationScreening |  | 0..* | Element | Elements defined in Ancestors: @id, extension Logical model for population screening event Instances of this logical model are not marked to be the target of a Reference
patient |  | 1..1 | Reference(Patient) | The patient for the screening
screeningType |  | 1..1 | CodeableConcept | The related screening
screeningYear |  | 1..1 | string | The calendar year of the screening
invitation |  | 0..1 | BackboneElement | The appointment details of the invitation
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
date |  | 1..1 | date | The date the patient is invited to participate in the population based screening
time |  | 0..1 | time | The time for the screening if there is a proposed appointment. This is the case for breast cancer screening.
locationName |  | 0..1 | string | Human readable name of the location where the patient is invited to participate.
locationAddress |  | 0..1 | string | Human readable address of the invitation location
participation |  | 0..1 | BackboneElement | The participation details
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
date |  | 1..1 | date | The date the patient participated in the population based screening
locationName |  | 0..1 | string | Human readable name of the location where the patient participated
locationAddress |  | 0..1 | string | Human readable address of the participation location
result |  | 0..1 | CodeableConcept | The result of participation in the population based screening
followup |  | 0..1 | BackboneElement | Details of proposed actions for the patient after the screening concluded.
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
needed |  | 0..1 | boolean | Indication if the patient should request or take other examinations/steps based on the outcome of the screening.
advice |  | 0..1 | string | Indication what other examinations/steps the patient should take.
request |  | 0..1 | string | The other examinations that the patient should take.
nextInvitation |  | 1..1 | BackboneElement | 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.
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
type |  | 1..1 | CodeableConcept | Type of the next invitation or lack of next invitation
date |  | 0..1 | dateTime | (Partial) date of next invitation, if applicable
Documentation for this format

#### Constraints

Id | Grade | Path(s) | Details | Requirements
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |

Snapshot View

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
BeModelPopulationScreening |  | 0..* | Element | Elements defined in Ancestors: @id, extension Logical model for population screening event Instances of this logical model are not marked to be the target of a Reference
@id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
patient |  | 1..1 | Reference(Patient) | The patient for the screening
screeningType |  | 1..1 | CodeableConcept | The related screening
screeningYear |  | 1..1 | string | The calendar year of the screening
invitation |  | 0..1 | BackboneElement | The appointment details of the invitation
@id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
date |  | 1..1 | date | The date the patient is invited to participate in the population based screening
time |  | 0..1 | time | The time for the screening if there is a proposed appointment. This is the case for breast cancer screening.
locationName |  | 0..1 | string | Human readable name of the location where the patient is invited to participate.
locationAddress |  | 0..1 | string | Human readable address of the invitation location
participation |  | 0..1 | BackboneElement | The participation details
@id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
date |  | 1..1 | date | The date the patient participated in the population based screening
locationName |  | 0..1 | string | Human readable name of the location where the patient participated
locationAddress |  | 0..1 | string | Human readable address of the participation location
result |  | 0..1 | CodeableConcept | The result of participation in the population based screening
followup |  | 0..1 | BackboneElement | Details of proposed actions for the patient after the screening concluded.
@id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
needed |  | 0..1 | boolean | Indication if the patient should request or take other examinations/steps based on the outcome of the screening.
advice |  | 0..1 | string | Indication what other examinations/steps the patient should take.
request |  | 0..1 | string | The other examinations that the patient should take.
nextInvitation |  | 1..1 | BackboneElement | 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.
@id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
type |  | 1..1 | CodeableConcept | Type of the next invitation or lack of next invitation
date |  | 0..1 | dateTime | (Partial) date of next invitation, if applicable
Documentation for this format

#### Constraints

Id | Grade | Path(s) | Details | Requirements
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |

This structure is derived from Element

Summary

Mandatory: 0 element (7 nested mandatory elements)

Other representations of profile: CSV, Excel