HL7 FHIR Implementation Guide: Public Health IG Release 1 - BE Realm | STU1
1.0.2 - STU1 Belgium flag

This page is part of the HL7 FHIR Implementation Guide: Public Health IG Release 1 - BE Realm | STU1 (v1.0.2: Release) based on FHIR R4. This is the current published version in its permanent home (it will always be available at this URL). For a full list of available versions, see the Directory of published versions

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:

Formal Views of Profile Content

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

This structure is derived from Element

NameFlagsCard.TypeDescription & Constraintsdoco
.. 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..1Reference(Patient)The patient for the screening
... screeningType 1..1CodeableConceptThe related screening
... screeningYear 1..1stringThe calendar year of the screening
.... date 1..1dateThe date the patient is invited to participate in the population based screening
.... time 0..1timeThe time for the screening if there is a proposed appointment. This is the case for breast cancer screening.
.... locationName 0..1stringHuman readable name of the location where the patient is invited to participate.
.... locationAddress 0..1stringHuman readable address of the invitation location
... participation 0..1BackboneElementThe participation details
.... date 1..1dateThe date the patient participated in the population based screening
.... locationName 0..1stringHuman readable name of the location where the patient participated
.... locationAddress 0..1stringHuman readable address of the participation location
.... result 0..1CodeableConceptThe result of participation in the population based screening
.... followup 0..1BackboneElementDetails of proposed actions for the patient after the screening concluded.
..... needed 0..1booleanIndication if the patient should request or take other examinations/steps based on the outcome of the screening.
..... advice 0..1stringIndication what other examinations/steps the patient should take.
..... request 0..1stringThe other examinations that the patient should take.
... nextInvitation 1..1BackboneElementThis 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..1CodeableConceptType of the next invitation or lack of next invitation
.... date 0..1dateTime(Partial) date of next invitation, if applicable

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. 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..1Reference(Patient)The patient for the screening
... screeningType 1..1CodeableConceptThe related screening
... screeningYear 1..1stringThe calendar year of the screening
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... date 1..1dateThe date the patient is invited to participate in the population based screening
.... time 0..1timeThe time for the screening if there is a proposed appointment. This is the case for breast cancer screening.
.... locationName 0..1stringHuman readable name of the location where the patient is invited to participate.
.... locationAddress 0..1stringHuman readable address of the invitation location
... participation 0..1BackboneElementThe participation details
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... date 1..1dateThe date the patient participated in the population based screening
.... locationName 0..1stringHuman readable name of the location where the patient participated
.... locationAddress 0..1stringHuman readable address of the participation location
.... result 0..1CodeableConceptThe result of participation in the population based screening
.... followup 0..1BackboneElementDetails of proposed actions for the patient after the screening concluded.
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... needed 0..1booleanIndication if the patient should request or take other examinations/steps based on the outcome of the screening.
..... advice 0..1stringIndication what other examinations/steps the patient should take.
..... request 0..1stringThe other examinations that the patient should take.
... nextInvitation 1..1BackboneElementThis 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..*ExtensionExtensions that cannot be ignored even if unrecognized
.... type 1..1CodeableConceptType of the next invitation or lack of next invitation
.... date 0..1dateTime(Partial) date of next invitation, if applicable

doco Documentation for this format

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
NameFlagsCard.TypeDescription & Constraintsdoco
.. 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..1stringUnique id for inter-element referencing
... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
... patient 1..1Reference(Patient)The patient for the screening
... screeningYear 1..1stringThe calendar year of the screening
... invitation 0..1BackboneElementThe appointment details of the invitation
.... @id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... date 1..1dateThe date the patient is invited to participate in the population based screening
.... time 0..1timeThe time for the screening if there is a proposed appointment. This is the case for breast cancer screening.
.... locationName 0..1stringHuman readable name of the location where the patient is invited to participate.
.... locationAddress 0..1stringHuman readable address of the invitation location
... participation 0..1BackboneElementThe participation details
.... @id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... date 1..1dateThe date the patient participated in the population based screening
.... locationName 0..1stringHuman readable name of the location where the patient participated
.... locationAddress 0..1stringHuman readable address of the participation location
.... result 0..1CodeableConceptThe result of participation in the population based screening
.... followup 0..1BackboneElementDetails of proposed actions for the patient after the screening concluded.
..... @id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... needed 0..1booleanIndication if the patient should request or take other examinations/steps based on the outcome of the screening.
..... advice 0..1stringIndication what other examinations/steps the patient should take.
..... request 0..1stringThe other examinations that the patient should take.
... nextInvitation 1..1BackboneElementThis 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..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... type 1..1CodeableConceptType of the next invitation or lack of next invitation
.... date 0..1dateTime(Partial) date of next invitation, if applicable

doco Documentation for this format

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust 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

NameFlagsCard.TypeDescription & Constraintsdoco
.. 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..1Reference(Patient)The patient for the screening
... screeningType 1..1CodeableConceptThe related screening
... screeningYear 1..1stringThe calendar year of the screening
.... date 1..1dateThe date the patient is invited to participate in the population based screening
.... time 0..1timeThe time for the screening if there is a proposed appointment. This is the case for breast cancer screening.
.... locationName 0..1stringHuman readable name of the location where the patient is invited to participate.
.... locationAddress 0..1stringHuman readable address of the invitation location
... participation 0..1BackboneElementThe participation details
.... date 1..1dateThe date the patient participated in the population based screening
.... locationName 0..1stringHuman readable name of the location where the patient participated
.... locationAddress 0..1stringHuman readable address of the participation location
.... result 0..1CodeableConceptThe result of participation in the population based screening
.... followup 0..1BackboneElementDetails of proposed actions for the patient after the screening concluded.
..... needed 0..1booleanIndication if the patient should request or take other examinations/steps based on the outcome of the screening.
..... advice 0..1stringIndication what other examinations/steps the patient should take.
..... request 0..1stringThe other examinations that the patient should take.
... nextInvitation 1..1BackboneElementThis 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..1CodeableConceptType of the next invitation or lack of next invitation
.... date 0..1dateTime(Partial) date of next invitation, if applicable

doco Documentation for this format

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. 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..1Reference(Patient)The patient for the screening
... screeningType 1..1CodeableConceptThe related screening
... screeningYear 1..1stringThe calendar year of the screening
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... date 1..1dateThe date the patient is invited to participate in the population based screening
.... time 0..1timeThe time for the screening if there is a proposed appointment. This is the case for breast cancer screening.
.... locationName 0..1stringHuman readable name of the location where the patient is invited to participate.
.... locationAddress 0..1stringHuman readable address of the invitation location
... participation 0..1BackboneElementThe participation details
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... date 1..1dateThe date the patient participated in the population based screening
.... locationName 0..1stringHuman readable name of the location where the patient participated
.... locationAddress 0..1stringHuman readable address of the participation location
.... result 0..1CodeableConceptThe result of participation in the population based screening
.... followup 0..1BackboneElementDetails of proposed actions for the patient after the screening concluded.
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... needed 0..1booleanIndication if the patient should request or take other examinations/steps based on the outcome of the screening.
..... advice 0..1stringIndication what other examinations/steps the patient should take.
..... request 0..1stringThe other examinations that the patient should take.
... nextInvitation 1..1BackboneElementThis 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..*ExtensionExtensions that cannot be ignored even if unrecognized
.... type 1..1CodeableConceptType of the next invitation or lack of next invitation
.... date 0..1dateTime(Partial) date of next invitation, if applicable

doco Documentation for this format

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. 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..1stringUnique id for inter-element referencing
... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
... patient 1..1Reference(Patient)The patient for the screening
... screeningYear 1..1stringThe calendar year of the screening
... invitation 0..1BackboneElementThe appointment details of the invitation
.... @id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... date 1..1dateThe date the patient is invited to participate in the population based screening
.... time 0..1timeThe time for the screening if there is a proposed appointment. This is the case for breast cancer screening.
.... locationName 0..1stringHuman readable name of the location where the patient is invited to participate.
.... locationAddress 0..1stringHuman readable address of the invitation location
... participation 0..1BackboneElementThe participation details
.... @id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... date 1..1dateThe date the patient participated in the population based screening
.... locationName 0..1stringHuman readable name of the location where the patient participated
.... locationAddress 0..1stringHuman readable address of the participation location
.... result 0..1CodeableConceptThe result of participation in the population based screening
.... followup 0..1BackboneElementDetails of proposed actions for the patient after the screening concluded.
..... @id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... needed 0..1booleanIndication if the patient should request or take other examinations/steps based on the outcome of the screening.
..... advice 0..1stringIndication what other examinations/steps the patient should take.
..... request 0..1stringThe other examinations that the patient should take.
... nextInvitation 1..1BackboneElementThis 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..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... type 1..1CodeableConceptType of the next invitation or lack of next invitation
.... date 0..1dateTime(Partial) date of next invitation, if applicable

doco Documentation for this format

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust 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