| Package | hl7.fhir.be.public-health |
| Type | StructureDefinition |
| Id | BeModelPopulationScreening |
| FHIR Version | R4 |
| Source | https://www.ehealth.fgov.be/standards/fhir/public-health/https://www.ehealth.fgov.be/standards/fhir/public-health/1.0.3/StructureDefinition-BeModelPopulationScreening.html |
| URL | https://www.ehealth.fgov.be/standards/fhir/public-health/StructureDefinition/BeModelPopulationScreening |
| Version | 1.0.3 |
| Status | active |
| Date | 2024-06-12T10:52:09+02:00 |
| Name | BeModelPopulationScreening |
| Title | Logical model for population screening event |
| Realm | be |
| Authority | hl7 |
| Description | 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. |
| Type | https://www.ehealth.fgov.be/standards/fhir/public-health/StructureDefinition/BeModelPopulationScreening |
| Kind | logical |
| StructureDefinition | |
| BeModelPopulationScreeningPlan | Logical model for population screening plan |
No resources found
Note: links and images are rebased to the (stated) source
| 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 | ||||
FHIR{
"resourceType": "StructureDefinition",
"id": "BeModelPopulationScreening",
"text": {
"status": "extensions",
"div": "<!-- snip (see above) -->"
},
"url": "https://www.ehealth.fgov.be/standards/fhir/public-health/StructureDefinition/BeModelPopulationScreening",
"version": "1.0.3",
"name": "BeModelPopulationScreening",
"title": "Logical model for population screening event",
"status": "active",
"date": "2024-06-12T10:52:09+02:00",
"publisher": "eHealth Platform",
"contact": [
{
"name": "eHealth Platform",
"telecom": [
{
"system": "url",
"value": "https://www.ehealth.fgov.be/standards/fhir"
},
{
"system": "email",
"value": "support@be-ehealth-standards.atlassian.net"
}
]
},
{
"name": "eHealth Platform",
"telecom": [
{
"system": "email",
"value": "support@be-ehealth-standards.atlassian.net",
"use": "work"
}
]
}
],
"description": "Logical model for recurrent population based screening. The model represents one iteration of a screening, called episode. A patient can have multiple episodes for a given screening. A screening of a specific type for a given patient can be repeated after a certain period. Each time the screening is repeated results in a new episode.",
"jurisdiction": [
{
"coding": [
{
"system": "urn:iso:std:iso:3166",
"code": "BE",
"display": "Belgium"
}
]
}
],
"fhirVersion": "4.0.1",
"mapping": [
{
"identity": "rim",
"uri": "http://hl7.org/v3",
"name": "RIM Mapping"
}
],
"kind": "logical",
"abstract": false,
"type": "https://www.ehealth.fgov.be/standards/fhir/public-health/StructureDefinition/BeModelPopulationScreening",
"baseDefinition": "http://hl7.org/fhir/StructureDefinition/Element",
"derivation": "specialization",
"snapshot": {
"element": [
{
"id": "BeModelPopulationScreening",
"path": "BeModelPopulationScreening",
"short": "Logical model for population screening event",
"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.",
"min": 0,
"max": "*",
"base": {
"path": "Element",
"min": 0,
"max": "*"
},
"condition": [
"ele-1"
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "BeModelPopulationScreening.id",
"path": "BeModelPopulationScreening.id",
"representation": [
"xmlAttr"
],
"short": "Unique id for inter-element referencing",
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min": 0,
"max": "1",
"base": {
"path": "Element.id",
"min": 0,
"max": "1"
},
"type": [
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "string"
}
],
"code": "http://hl7.org/fhirpath/System.String"
}
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "BeModelPopulationScreening.extension",
"path": "BeModelPopulationScreening.extension",
"slicing": {
"discriminator": [
{
"type": "value",
"path": "url"
}
],
"description": "Extensions are always sliced by (at least) url",
"rules": "open"
},
"short": "Additional content defined by implementations",
"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.",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key": "ext-1",
"severity": "error",
"human": "Must have either extensions or value[x], not both",
"expression": "extension.exists() != value.exists()",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source": "http://hl7.org/fhir/StructureDefinition/Extension"
}
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "BeModelPopulationScreening.patient",
"path": "BeModelPopulationScreening.patient",
"short": "The patient for the screening",
"definition": "The patient for the screening",
"min": 1,
"max": "1",
"base": {
"path": "BeModelPopulationScreening.patient",
"min": 1,
"max": "1"
},
"type": [
{
"code": "Reference",
"targetProfile": [
"http://hl7.org/fhir/StructureDefinition/Patient"
]
}
]
},
{
"id": "BeModelPopulationScreening.screeningType",
"path": "BeModelPopulationScreening.screeningType",
"short": "The related screening",
"definition": "The related screening, for example breast cancer, colon cancer or cervicalcancer.",
"min": 1,
"max": "1",
"base": {
"path": "BeModelPopulationScreening.screeningType",
"min": 1,
"max": "1"
},
"type": [
{
"code": "CodeableConcept"
}
]
},
{
"id": "BeModelPopulationScreening.screeningYear",
"path": "BeModelPopulationScreening.screeningYear",
"short": "The calendar year of the screening",
"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. \nIf there is no invitation or participation, there will be no episode.\nFor 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. \nIf the patient has a refusal or exclusion registered and does not have a participation/invitation, so the patient does not have any episodes, the calendar year of the registration of the refusal/exclusion is taken.",
"min": 1,
"max": "1",
"base": {
"path": "BeModelPopulationScreening.screeningYear",
"min": 1,
"max": "1"
},
"type": [
{
"code": "string"
}
]
},
{
"id": "BeModelPopulationScreening.invitation",
"path": "BeModelPopulationScreening.invitation",
"short": "The appointment details of the invitation",
"definition": "An invitation is not mandatory, in some cases a patient can participate for a screening without an invitation.",
"min": 0,
"max": "1",
"base": {
"path": "BeModelPopulationScreening.invitation",
"min": 0,
"max": "1"
},
"type": [
{
"code": "BackboneElement"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
]
},
{
"id": "BeModelPopulationScreening.invitation.id",
"path": "BeModelPopulationScreening.invitation.id",
"representation": [
"xmlAttr"
],
"short": "Unique id for inter-element referencing",
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min": 0,
"max": "1",
"base": {
"path": "Element.id",
"min": 0,
"max": "1"
},
"type": [
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "string"
}
],
"code": "http://hl7.org/fhirpath/System.String"
}
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "BeModelPopulationScreening.invitation.extension",
"path": "BeModelPopulationScreening.invitation.extension",
"slicing": {
"discriminator": [
{
"type": "value",
"path": "url"
}
],
"description": "Extensions are always sliced by (at least) url",
"rules": "open"
},
"short": "Additional content defined by implementations",
"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.",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key": "ext-1",
"severity": "error",
"human": "Must have either extensions or value[x], not both",
"expression": "extension.exists() != value.exists()",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source": "http://hl7.org/fhir/StructureDefinition/Extension"
}
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "BeModelPopulationScreening.invitation.modifierExtension",
"path": "BeModelPopulationScreening.invitation.modifierExtension",
"short": "Extensions that cannot be ignored even if unrecognized",
"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.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](http://hl7.org/fhir/R4/extensibility.html#modifierExtension).",
"alias": [
"extensions",
"user content",
"modifiers"
],
"min": 0,
"max": "*",
"base": {
"path": "BackboneElement.modifierExtension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key": "ext-1",
"severity": "error",
"human": "Must have either extensions or value[x], not both",
"expression": "extension.exists() != value.exists()",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source": "http://hl7.org/fhir/StructureDefinition/Extension"
}
],
"isModifier": true,
"isModifierReason": "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "BeModelPopulationScreening.invitation.date",
"path": "BeModelPopulationScreening.invitation.date",
"short": "The date the patient is invited to participate in the population based screening",
"definition": "The date the patient is invited to participate in the population based screening",
"min": 1,
"max": "1",
"base": {
"path": "BeModelPopulationScreening.invitation.date",
"min": 1,
"max": "1"
},
"type": [
{
"code": "date"
}
]
},
{
"id": "BeModelPopulationScreening.invitation.time",
"path": "BeModelPopulationScreening.invitation.time",
"short": "The time for the screening if there is a proposed appointment. This is the case for breast cancer screening.",
"definition": "The time for the screening if there is a proposed appointment. This is the case for breast cancer screening.",
"min": 0,
"max": "1",
"base": {
"path": "BeModelPopulationScreening.invitation.time",
"min": 0,
"max": "1"
},
"type": [
{
"code": "time"
}
]
},
{
"id": "BeModelPopulationScreening.invitation.locationName",
"path": "BeModelPopulationScreening.invitation.locationName",
"short": "Human readable name of the location where the patient is invited to participate.",
"definition": "For some screenings, but not all, a location is provided for the patient.",
"min": 0,
"max": "1",
"base": {
"path": "BeModelPopulationScreening.invitation.locationName",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
]
},
{
"id": "BeModelPopulationScreening.invitation.locationAddress",
"path": "BeModelPopulationScreening.invitation.locationAddress",
"short": "Human readable address of the invitation location",
"definition": "For some screenings, but not all, a location is provided for the patient.",
"min": 0,
"max": "1",
"base": {
"path": "BeModelPopulationScreening.invitation.locationAddress",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
]
},
{
"id": "BeModelPopulationScreening.participation",
"path": "BeModelPopulationScreening.participation",
"short": "The participation details",
"definition": "A participation is not mandatory. A patient can choose not to participate for a screening.",
"min": 0,
"max": "1",
"base": {
"path": "BeModelPopulationScreening.participation",
"min": 0,
"max": "1"
},
"type": [
{
"code": "BackboneElement"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
]
},
{
"id": "BeModelPopulationScreening.participation.id",
"path": "BeModelPopulationScreening.participation.id",
"representation": [
"xmlAttr"
],
"short": "Unique id for inter-element referencing",
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min": 0,
"max": "1",
"base": {
"path": "Element.id",
"min": 0,
"max": "1"
},
"type": [
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "string"
}
],
"code": "http://hl7.org/fhirpath/System.String"
}
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "BeModelPopulationScreening.participation.extension",
"path": "BeModelPopulationScreening.participation.extension",
"slicing": {
"discriminator": [
{
"type": "value",
"path": "url"
}
],
"description": "Extensions are always sliced by (at least) url",
"rules": "open"
},
"short": "Additional content defined by implementations",
"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.",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key": "ext-1",
"severity": "error",
"human": "Must have either extensions or value[x], not both",
"expression": "extension.exists() != value.exists()",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source": "http://hl7.org/fhir/StructureDefinition/Extension"
}
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "BeModelPopulationScreening.participation.modifierExtension",
"path": "BeModelPopulationScreening.participation.modifierExtension",
"short": "Extensions that cannot be ignored even if unrecognized",
"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.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](http://hl7.org/fhir/R4/extensibility.html#modifierExtension).",
"alias": [
"extensions",
"user content",
"modifiers"
],
"min": 0,
"max": "*",
"base": {
"path": "BackboneElement.modifierExtension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key": "ext-1",
"severity": "error",
"human": "Must have either extensions or value[x], not both",
"expression": "extension.exists() != value.exists()",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source": "http://hl7.org/fhir/StructureDefinition/Extension"
}
],
"isModifier": true,
"isModifierReason": "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "BeModelPopulationScreening.participation.date",
"path": "BeModelPopulationScreening.participation.date",
"short": "The date the patient participated in the population based screening",
"definition": "The date the patient participated in the population based screening",
"min": 1,
"max": "1",
"base": {
"path": "BeModelPopulationScreening.participation.date",
"min": 1,
"max": "1"
},
"type": [
{
"code": "date"
}
]
},
{
"id": "BeModelPopulationScreening.participation.locationName",
"path": "BeModelPopulationScreening.participation.locationName",
"short": "Human readable name of the location where the patient participated",
"definition": "For some screenings, but not all, a location is provided for the patient.",
"min": 0,
"max": "1",
"base": {
"path": "BeModelPopulationScreening.participation.locationName",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
]
},
{
"id": "BeModelPopulationScreening.participation.locationAddress",
"path": "BeModelPopulationScreening.participation.locationAddress",
"short": "Human readable address of the participation location",
"definition": "For some screenings, but not all, a location is provided for the patient.",
"min": 0,
"max": "1",
"base": {
"path": "BeModelPopulationScreening.participation.locationAddress",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
]
},
{
"id": "BeModelPopulationScreening.participation.result",
"path": "BeModelPopulationScreening.participation.result",
"short": "The result of participation in the population based screening",
"definition": "Notify the patient if the result was abnormal/positive or normal/negative",
"min": 0,
"max": "1",
"base": {
"path": "BeModelPopulationScreening.participation.result",
"min": 0,
"max": "1"
},
"type": [
{
"code": "CodeableConcept"
}
]
},
{
"id": "BeModelPopulationScreening.participation.followup",
"path": "BeModelPopulationScreening.participation.followup",
"short": "Details of proposed actions for the patient after the screening concluded.",
"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.",
"min": 0,
"max": "1",
"base": {
"path": "BeModelPopulationScreening.participation.followup",
"min": 0,
"max": "1"
},
"type": [
{
"code": "BackboneElement"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
]
},
{
"id": "BeModelPopulationScreening.participation.followup.id",
"path": "BeModelPopulationScreening.participation.followup.id",
"representation": [
"xmlAttr"
],
"short": "Unique id for inter-element referencing",
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min": 0,
"max": "1",
"base": {
"path": "Element.id",
"min": 0,
"max": "1"
},
"type": [
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "string"
}
],
"code": "http://hl7.org/fhirpath/System.String"
}
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "BeModelPopulationScreening.participation.followup.extension",
"path": "BeModelPopulationScreening.participation.followup.extension",
"slicing": {
"discriminator": [
{
"type": "value",
"path": "url"
}
],
"description": "Extensions are always sliced by (at least) url",
"rules": "open"
},
"short": "Additional content defined by implementations",
"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.",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key": "ext-1",
"severity": "error",
"human": "Must have either extensions or value[x], not both",
"expression": "extension.exists() != value.exists()",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source": "http://hl7.org/fhir/StructureDefinition/Extension"
}
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "BeModelPopulationScreening.participation.followup.modifierExtension",
"path": "BeModelPopulationScreening.participation.followup.modifierExtension",
"short": "Extensions that cannot be ignored even if unrecognized",
"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.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](http://hl7.org/fhir/R4/extensibility.html#modifierExtension).",
"alias": [
"extensions",
"user content",
"modifiers"
],
"min": 0,
"max": "*",
"base": {
"path": "BackboneElement.modifierExtension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key": "ext-1",
"severity": "error",
"human": "Must have either extensions or value[x], not both",
"expression": "extension.exists() != value.exists()",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source": "http://hl7.org/fhir/StructureDefinition/Extension"
}
],
"isModifier": true,
"isModifierReason": "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "BeModelPopulationScreening.participation.followup.needed",
"path": "BeModelPopulationScreening.participation.followup.needed",
"short": "Indication if the patient should request or take other examinations/steps based on the outcome of the screening.",
"definition": "Indication if the patient should request or take other examinations/steps based on the outcome of the screening.",
"min": 0,
"max": "1",
"base": {
"path": "BeModelPopulationScreening.participation.followup.needed",
"min": 0,
"max": "1"
},
"type": [
{
"code": "boolean"
}
]
},
{
"id": "BeModelPopulationScreening.participation.followup.advice",
"path": "BeModelPopulationScreening.participation.followup.advice",
"short": "Indication what other examinations/steps the patient should take.",
"definition": "Indication what other examinations/steps the patient should take.",
"min": 0,
"max": "1",
"base": {
"path": "BeModelPopulationScreening.participation.followup.advice",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
]
},
{
"id": "BeModelPopulationScreening.participation.followup.request",
"path": "BeModelPopulationScreening.participation.followup.request",
"short": "The other examinations that the patient should take.",
"definition": "The other examinations that the patient should take.",
"min": 0,
"max": "1",
"base": {
"path": "BeModelPopulationScreening.participation.followup.request",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
]
},
{
"id": "BeModelPopulationScreening.nextInvitation",
"path": "BeModelPopulationScreening.nextInvitation",
"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.",
"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.",
"min": 1,
"max": "1",
"base": {
"path": "BeModelPopulationScreening.nextInvitation",
"min": 1,
"max": "1"
},
"type": [
{
"code": "BackboneElement"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
]
},
{
"id": "BeModelPopulationScreening.nextInvitation.id",
"path": "BeModelPopulationScreening.nextInvitation.id",
"representation": [
"xmlAttr"
],
"short": "Unique id for inter-element referencing",
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min": 0,
"max": "1",
"base": {
"path": "Element.id",
"min": 0,
"max": "1"
},
"type": [
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "string"
}
],
"code": "http://hl7.org/fhirpath/System.String"
}
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "BeModelPopulationScreening.nextInvitation.extension",
"path": "BeModelPopulationScreening.nextInvitation.extension",
"slicing": {
"discriminator": [
{
"type": "value",
"path": "url"
}
],
"description": "Extensions are always sliced by (at least) url",
"rules": "open"
},
"short": "Additional content defined by implementations",
"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.",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key": "ext-1",
"severity": "error",
"human": "Must have either extensions or value[x], not both",
"expression": "extension.exists() != value.exists()",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source": "http://hl7.org/fhir/StructureDefinition/Extension"
}
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "BeModelPopulationScreening.nextInvitation.modifierExtension",
"path": "BeModelPopulationScreening.nextInvitation.modifierExtension",
"short": "Extensions that cannot be ignored even if unrecognized",
"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.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](http://hl7.org/fhir/R4/extensibility.html#modifierExtension).",
"alias": [
"extensions",
"user content",
"modifiers"
],
"min": 0,
"max": "*",
"base": {
"path": "BackboneElement.modifierExtension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key": "ext-1",
"severity": "error",
"human": "Must have either extensions or value[x], not both",
"expression": "extension.exists() != value.exists()",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source": "http://hl7.org/fhir/StructureDefinition/Extension"
}
],
"isModifier": true,
"isModifierReason": "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "BeModelPopulationScreening.nextInvitation.type",
"path": "BeModelPopulationScreening.nextInvitation.type",
"short": "Type of the next invitation or lack of next invitation",
"definition": "Type of the next invitation or lack of next invitation",
"min": 1,
"max": "1",
"base": {
"path": "BeModelPopulationScreening.nextInvitation.type",
"min": 1,
"max": "1"
},
"type": [
{
"code": "CodeableConcept"
}
]
},
{
"id": "BeModelPopulationScreening.nextInvitation.date",
"path": "BeModelPopulationScreening.nextInvitation.date",
"short": "(Partial) date of next invitation, if applicable",
"definition": "(Partial) date of next invitation, if applicable",
"min": 0,
"max": "1",
"base": {
"path": "BeModelPopulationScreening.nextInvitation.date",
"min": 0,
"max": "1"
},
"type": [
{
"code": "dateTime"
}
]
}
]
},
"differential": {
"element": [
{
"id": "BeModelPopulationScreening",
"path": "BeModelPopulationScreening",
"short": "Logical model for population screening event",
"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."
},
{
"id": "BeModelPopulationScreening.patient",
"path": "BeModelPopulationScreening.patient",
"short": "The patient for the screening",
"definition": "The patient for the screening",
"min": 1,
"max": "1",
"type": [
{
"code": "Reference",
"targetProfile": [
"http://hl7.org/fhir/StructureDefinition/Patient"
]
}
]
},
{
"id": "BeModelPopulationScreening.screeningType",
"path": "BeModelPopulationScreening.screeningType",
"short": "The related screening",
"definition": "The related screening, for example breast cancer, colon cancer or cervicalcancer.",
"min": 1,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
]
},
{
"id": "BeModelPopulationScreening.screeningYear",
"path": "BeModelPopulationScreening.screeningYear",
"short": "The calendar year of the screening",
"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. \nIf there is no invitation or participation, there will be no episode.\nFor 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. \nIf the patient has a refusal or exclusion registered and does not have a participation/invitation, so the patient does not have any episodes, the calendar year of the registration of the refusal/exclusion is taken.",
"min": 1,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"id": "BeModelPopulationScreening.invitation",
"path": "BeModelPopulationScreening.invitation",
"short": "The appointment details of the invitation",
"definition": "An invitation is not mandatory, in some cases a patient can participate for a screening without an invitation.",
"min": 0,
"max": "1",
"type": [
{
"code": "BackboneElement"
}
]
},
{
"id": "BeModelPopulationScreening.invitation.date",
"path": "BeModelPopulationScreening.invitation.date",
"short": "The date the patient is invited to participate in the population based screening",
"definition": "The date the patient is invited to participate in the population based screening",
"min": 1,
"max": "1",
"type": [
{
"code": "date"
}
]
},
{
"id": "BeModelPopulationScreening.invitation.time",
"path": "BeModelPopulationScreening.invitation.time",
"short": "The time for the screening if there is a proposed appointment. This is the case for breast cancer screening.",
"definition": "The time for the screening if there is a proposed appointment. This is the case for breast cancer screening.",
"min": 0,
"max": "1",
"type": [
{
"code": "time"
}
]
},
{
"id": "BeModelPopulationScreening.invitation.locationName",
"path": "BeModelPopulationScreening.invitation.locationName",
"short": "Human readable name of the location where the patient is invited to participate.",
"definition": "For some screenings, but not all, a location is provided for the patient.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"id": "BeModelPopulationScreening.invitation.locationAddress",
"path": "BeModelPopulationScreening.invitation.locationAddress",
"short": "Human readable address of the invitation location",
"definition": "For some screenings, but not all, a location is provided for the patient.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"id": "BeModelPopulationScreening.participation",
"path": "BeModelPopulationScreening.participation",
"short": "The participation details",
"definition": "A participation is not mandatory. A patient can choose not to participate for a screening.",
"min": 0,
"max": "1",
"type": [
{
"code": "BackboneElement"
}
]
},
{
"id": "BeModelPopulationScreening.participation.date",
"path": "BeModelPopulationScreening.participation.date",
"short": "The date the patient participated in the population based screening",
"definition": "The date the patient participated in the population based screening",
"min": 1,
"max": "1",
"type": [
{
"code": "date"
}
]
},
{
"id": "BeModelPopulationScreening.participation.locationName",
"path": "BeModelPopulationScreening.participation.locationName",
"short": "Human readable name of the location where the patient participated",
"definition": "For some screenings, but not all, a location is provided for the patient.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"id": "BeModelPopulationScreening.participation.locationAddress",
"path": "BeModelPopulationScreening.participation.locationAddress",
"short": "Human readable address of the participation location",
"definition": "For some screenings, but not all, a location is provided for the patient.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"id": "BeModelPopulationScreening.participation.result",
"path": "BeModelPopulationScreening.participation.result",
"short": "The result of participation in the population based screening",
"definition": "Notify the patient if the result was abnormal/positive or normal/negative",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
]
},
{
"id": "BeModelPopulationScreening.participation.followup",
"path": "BeModelPopulationScreening.participation.followup",
"short": "Details of proposed actions for the patient after the screening concluded.",
"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.",
"min": 0,
"max": "1",
"type": [
{
"code": "BackboneElement"
}
]
},
{
"id": "BeModelPopulationScreening.participation.followup.needed",
"path": "BeModelPopulationScreening.participation.followup.needed",
"short": "Indication if the patient should request or take other examinations/steps based on the outcome of the screening.",
"definition": "Indication if the patient should request or take other examinations/steps based on the outcome of the screening.",
"min": 0,
"max": "1",
"type": [
{
"code": "boolean"
}
]
},
{
"id": "BeModelPopulationScreening.participation.followup.advice",
"path": "BeModelPopulationScreening.participation.followup.advice",
"short": "Indication what other examinations/steps the patient should take.",
"definition": "Indication what other examinations/steps the patient should take.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"id": "BeModelPopulationScreening.participation.followup.request",
"path": "BeModelPopulationScreening.participation.followup.request",
"short": "The other examinations that the patient should take.",
"definition": "The other examinations that the patient should take.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"id": "BeModelPopulationScreening.nextInvitation",
"path": "BeModelPopulationScreening.nextInvitation",
"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.",
"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.",
"min": 1,
"max": "1",
"type": [
{
"code": "BackboneElement"
}
]
},
{
"id": "BeModelPopulationScreening.nextInvitation.type",
"path": "BeModelPopulationScreening.nextInvitation.type",
"short": "Type of the next invitation or lack of next invitation",
"definition": "Type of the next invitation or lack of next invitation",
"min": 1,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
]
},
{
"id": "BeModelPopulationScreening.nextInvitation.date",
"path": "BeModelPopulationScreening.nextInvitation.date",
"short": "(Partial) date of next invitation, if applicable",
"definition": "(Partial) date of next invitation, if applicable",
"min": 0,
"max": "1",
"type": [
{
"code": "dateTime"
}
]
}
]
}
}