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

## Resource Profile: PopulationScreening Communication

Official URL: https://www.ehealth.fgov.be/standards/fhir/public-health/StructureDefinition/be-populationscreening-communication | Version: 1.0.1
Active as of 2023-08-11 | Maturity Level: 1 | Computable Name: BePopulationScreeningCommunication

Communication following a patient’s screening activities.

Usage:

- This Resource Profile is not used by any profiles in this Implementation Guide

### 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 Communication

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
Communication |  | 0..* | Communication | A record of information transmitted from a sender to a receiver
identifier | S | 0..* | Identifier | Unique identifier
Slices for category |  | 1..* | CodeableConcept | Message category Slice: Unordered, Open by pattern:coding.system
category:cancerScreeningType | S | 1..1 | CodeableConcept | Message category Binding: Population Screening Type Value Set (required)
coding |  |  |  |
system |  | 1..1 | uri | Identity of the terminology system Required Pattern: https://www.ehealth.fgov.be/standards/fhir/public-health/ValueSet/be-vs-populationscreening-type
topic | S | 0..1 | CodeableConcept | Description of the purpose/content Binding: Population Screening Next Invitation Type Value Set (required)
about | S | 0..* | Reference(Resource) | Resources that pertain to this communication
recipient | S | 1..* | Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson | Group | CareTeam | HealthcareService) | Message recipient
sender | S | 1..1 | Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson | HealthcareService) | Message sender
payload |  |  |  |
Slices for content[x] |  | 1..1 | string, Attachment, Reference(Resource) | Message part content Slice: Unordered, Open by type:$this
content[x]:contentAttachment | S | 0..1 | Attachment | Message part content
Documentation for this format

#### Terminology Bindings (Differential)

Path | Conformance | ValueSet
Communication.category:cancerScreeningType | required | BeVSPopulationScreeningType
Communication.topic | required | BeVSPopulationScreeningNextInvitationType (a valid code from Population Screening Next Invitation Type)

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
Communication |  | 0..* | Communication | A record of information transmitted from a sender to a receiver
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored
identifier | S Σ | 0..* | Identifier | Unique identifier
status | ?!Σ | 1..1 | code | preparation | in-progress | not-done | on-hold | stopped | completed | entered-in-error | unknown Binding: EventStatus (required): The status of the communication.
Slices for category |  | 1..* | CodeableConcept | Message category Slice: Unordered, Open by pattern:coding.system Binding: CommunicationCategory (example): Codes for general categories of communications such as alerts, instructions, etc.
category:cancerScreeningType | S | 1..1 | CodeableConcept | Message category Binding: Population Screening Type Value Set (required)
topic | S | 0..1 | CodeableConcept | Description of the purpose/content Binding: Population Screening Next Invitation Type Value Set (required)
about | S | 0..* | Reference(Resource) | Resources that pertain to this communication
recipient | S | 1..* | Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson | Group | CareTeam | HealthcareService) | Message recipient
sender | S | 1..1 | Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson | HealthcareService) | Message sender
payload |  | 0..* | BackboneElement | Message payload
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
Slices for content[x] |  | 1..1 |  | Message part content Slice: Unordered, Open by type:$this
contentString |  |  | string |
contentAttachment |  |  | Attachment |
contentReference |  |  | Reference(Resource) |
content[x]:contentAttachment | S | 0..1 | Attachment | Message part content
Documentation for this format

#### Terminology Bindings

Path | Conformance | ValueSet
Communication.status | required | EventStatus
Communication.category | example | CommunicationCategory
Communication.category:cancerScreeningType | required | BeVSPopulationScreeningType
Communication.topic | required | BeVSPopulationScreeningNextInvitationType (a valid code from Population Screening Next Invitation Type)

#### Constraints

Id | Grade | Path(s) | Details | Requirements
dom-2 | error | Communication | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() |
dom-3 | error | Communication | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() |
dom-4 | error | Communication | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() |
dom-5 | error | Communication | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() |
dom-6 | best practice | Communication | A resource should have narrative for robust management : text.`div`.exists() |
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
--- | --- | --- | --- | ---
Communication |  | 0..* | Communication | A record of information transmitted from a sender to a receiver
id | Σ | 0..1 | id | Logical id of this artifact
meta | Σ | 0..1 | Meta | Metadata about the resource
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created
language |  | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
Additional Bindings | Purpose
AllLanguages | Max Binding
text |  | 0..1 | Narrative | Text summary of the resource, for human interpretation
contained |  | 0..* | Resource | Contained, inline Resources
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored
identifier | S Σ | 0..* | Identifier | Unique identifier
instantiatesCanonical | Σ | 0..* | canonical(PlanDefinition | ActivityDefinition | Measure | OperationDefinition | Questionnaire) | Instantiates FHIR protocol or definition
instantiatesUri | Σ | 0..* | uri | Instantiates external protocol or definition
basedOn | Σ | 0..* | Reference(Resource) | Request fulfilled by this communication
partOf | Σ | 0..* | Reference(Resource) | Part of this action
inResponseTo |  | 0..* | Reference(Communication) | Reply to
status | ?!Σ | 1..1 | code | preparation | in-progress | not-done | on-hold | stopped | completed | entered-in-error | unknown Binding: EventStatus (required): The status of the communication.
statusReason | Σ | 0..1 | CodeableConcept | Reason for current status Binding: CommunicationNotDoneReason (example): Codes for the reason why a communication did not happen.
Slices for category |  | 1..* | CodeableConcept | Message category Slice: Unordered, Open by pattern:coding.system Binding: CommunicationCategory (example): Codes for general categories of communications such as alerts, instructions, etc.
category:cancerScreeningType | S | 1..1 | CodeableConcept | Message category Binding: Population Screening Type Value Set (required)
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
coding | Σ | 0..* | Coding | Code defined by a terminology system
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
system | Σ | 1..1 | uri | Identity of the terminology system Required Pattern: https://www.ehealth.fgov.be/standards/fhir/public-health/ValueSet/be-vs-populationscreening-type
version | Σ | 0..1 | string | Version of the system - if relevant
code | Σ | 0..1 | code | Symbol in syntax defined by the system
display | Σ | 0..1 | string | Representation defined by the system
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user
text | Σ | 0..1 | string | Plain text representation of the concept
priority | Σ | 0..1 | code | routine | urgent | asap | stat Binding: RequestPriority (required): Codes indicating the relative importance of a communication.
medium |  | 0..* | CodeableConcept | A channel of communication Binding: ParticipationMode (example): Codes for communication mediums such as phone, fax, email, in person, etc.
subject | Σ | 0..1 | Reference(Patient | Group) | Focus of message
topic | S | 0..1 | CodeableConcept | Description of the purpose/content Binding: Population Screening Next Invitation Type Value Set (required)
about | S | 0..* | Reference(Resource) | Resources that pertain to this communication
encounter | Σ | 0..1 | Reference(Encounter) | Encounter created as part of
sent |  | 0..1 | dateTime | When sent
received |  | 0..1 | dateTime | When received
recipient | S | 1..* | Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson | Group | CareTeam | HealthcareService) | Message recipient
sender | S | 1..1 | Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson | HealthcareService) | Message sender
reasonCode | Σ | 0..* | CodeableConcept | Indication for message Binding: SNOMEDCTClinicalFindings (example): Codes for describing reasons for the occurrence of a communication.
reasonReference | Σ | 0..* | Reference(Condition | Observation | DiagnosticReport | DocumentReference) | Why was communication done?
payload |  | 0..* | BackboneElement | Message payload
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
Slices for content[x] |  | 1..1 |  | Message part content Slice: Unordered, Open by type:$this
contentString |  |  | string |
contentAttachment |  |  | Attachment |
contentReference |  |  | Reference(Resource) |
content[x]:contentAttachment | S | 0..1 | Attachment | Message part content
note |  | 0..* | Annotation | Comments made about the communication
Documentation for this format

#### Terminology Bindings

Path | Conformance | ValueSet
Communication.language | preferred | CommonLanguages
Additional Bindings | Purpose
AllLanguages | Max Binding
Communication.status | required | EventStatus
Communication.statusReason | example | CommunicationNotDoneReason
Communication.category | example | CommunicationCategory
Communication.category:cancerScreeningType | required | BeVSPopulationScreeningType
Communication.priority | required | RequestPriority
Communication.medium | example | ParticipationMode
Communication.topic | required | BeVSPopulationScreeningNextInvitationType (a valid code from Population Screening Next Invitation Type)
Communication.reasonCode | example | SNOMEDCTClinicalFindings

#### 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 Communication

Summary

Mandatory: 4 elements (1 nested mandatory element)
Must-Support: 7 elements

Slices

This structure defines the following Slices:

- The element Communication.category is sliced based on the value of pattern:coding.system
- The element Communication.payload.content[x] is sliced based on the value of type:$this

Maturity: 1

Differential View

This structure is derived from Communication

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
Communication |  | 0..* | Communication | A record of information transmitted from a sender to a receiver
identifier | S | 0..* | Identifier | Unique identifier
Slices for category |  | 1..* | CodeableConcept | Message category Slice: Unordered, Open by pattern:coding.system
category:cancerScreeningType | S | 1..1 | CodeableConcept | Message category Binding: Population Screening Type Value Set (required)
coding |  |  |  |
system |  | 1..1 | uri | Identity of the terminology system Required Pattern: https://www.ehealth.fgov.be/standards/fhir/public-health/ValueSet/be-vs-populationscreening-type
topic | S | 0..1 | CodeableConcept | Description of the purpose/content Binding: Population Screening Next Invitation Type Value Set (required)
about | S | 0..* | Reference(Resource) | Resources that pertain to this communication
recipient | S | 1..* | Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson | Group | CareTeam | HealthcareService) | Message recipient
sender | S | 1..1 | Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson | HealthcareService) | Message sender
payload |  |  |  |
Slices for content[x] |  | 1..1 | string, Attachment, Reference(Resource) | Message part content Slice: Unordered, Open by type:$this
content[x]:contentAttachment | S | 0..1 | Attachment | Message part content
Documentation for this format

#### Terminology Bindings (Differential)

Path | Conformance | ValueSet
Communication.category:cancerScreeningType | required | BeVSPopulationScreeningType
Communication.topic | required | BeVSPopulationScreeningNextInvitationType (a valid code from Population Screening Next Invitation Type)

Key Elements View

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
Communication |  | 0..* | Communication | A record of information transmitted from a sender to a receiver
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored
identifier | S Σ | 0..* | Identifier | Unique identifier
status | ?!Σ | 1..1 | code | preparation | in-progress | not-done | on-hold | stopped | completed | entered-in-error | unknown Binding: EventStatus (required): The status of the communication.
Slices for category |  | 1..* | CodeableConcept | Message category Slice: Unordered, Open by pattern:coding.system Binding: CommunicationCategory (example): Codes for general categories of communications such as alerts, instructions, etc.
category:cancerScreeningType | S | 1..1 | CodeableConcept | Message category Binding: Population Screening Type Value Set (required)
topic | S | 0..1 | CodeableConcept | Description of the purpose/content Binding: Population Screening Next Invitation Type Value Set (required)
about | S | 0..* | Reference(Resource) | Resources that pertain to this communication
recipient | S | 1..* | Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson | Group | CareTeam | HealthcareService) | Message recipient
sender | S | 1..1 | Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson | HealthcareService) | Message sender
payload |  | 0..* | BackboneElement | Message payload
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
Slices for content[x] |  | 1..1 |  | Message part content Slice: Unordered, Open by type:$this
contentString |  |  | string |
contentAttachment |  |  | Attachment |
contentReference |  |  | Reference(Resource) |
content[x]:contentAttachment | S | 0..1 | Attachment | Message part content
Documentation for this format

#### Terminology Bindings

Path | Conformance | ValueSet
Communication.status | required | EventStatus
Communication.category | example | CommunicationCategory
Communication.category:cancerScreeningType | required | BeVSPopulationScreeningType
Communication.topic | required | BeVSPopulationScreeningNextInvitationType (a valid code from Population Screening Next Invitation Type)

#### Constraints

Id | Grade | Path(s) | Details | Requirements
dom-2 | error | Communication | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() |
dom-3 | error | Communication | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() |
dom-4 | error | Communication | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() |
dom-5 | error | Communication | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() |
dom-6 | best practice | Communication | A resource should have narrative for robust management : text.`div`.exists() |
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
--- | --- | --- | --- | ---
Communication |  | 0..* | Communication | A record of information transmitted from a sender to a receiver
id | Σ | 0..1 | id | Logical id of this artifact
meta | Σ | 0..1 | Meta | Metadata about the resource
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created
language |  | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
Additional Bindings | Purpose
AllLanguages | Max Binding
text |  | 0..1 | Narrative | Text summary of the resource, for human interpretation
contained |  | 0..* | Resource | Contained, inline Resources
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored
identifier | S Σ | 0..* | Identifier | Unique identifier
instantiatesCanonical | Σ | 0..* | canonical(PlanDefinition | ActivityDefinition | Measure | OperationDefinition | Questionnaire) | Instantiates FHIR protocol or definition
instantiatesUri | Σ | 0..* | uri | Instantiates external protocol or definition
basedOn | Σ | 0..* | Reference(Resource) | Request fulfilled by this communication
partOf | Σ | 0..* | Reference(Resource) | Part of this action
inResponseTo |  | 0..* | Reference(Communication) | Reply to
status | ?!Σ | 1..1 | code | preparation | in-progress | not-done | on-hold | stopped | completed | entered-in-error | unknown Binding: EventStatus (required): The status of the communication.
statusReason | Σ | 0..1 | CodeableConcept | Reason for current status Binding: CommunicationNotDoneReason (example): Codes for the reason why a communication did not happen.
Slices for category |  | 1..* | CodeableConcept | Message category Slice: Unordered, Open by pattern:coding.system Binding: CommunicationCategory (example): Codes for general categories of communications such as alerts, instructions, etc.
category:cancerScreeningType | S | 1..1 | CodeableConcept | Message category Binding: Population Screening Type Value Set (required)
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
coding | Σ | 0..* | Coding | Code defined by a terminology system
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
system | Σ | 1..1 | uri | Identity of the terminology system Required Pattern: https://www.ehealth.fgov.be/standards/fhir/public-health/ValueSet/be-vs-populationscreening-type
version | Σ | 0..1 | string | Version of the system - if relevant
code | Σ | 0..1 | code | Symbol in syntax defined by the system
display | Σ | 0..1 | string | Representation defined by the system
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user
text | Σ | 0..1 | string | Plain text representation of the concept
priority | Σ | 0..1 | code | routine | urgent | asap | stat Binding: RequestPriority (required): Codes indicating the relative importance of a communication.
medium |  | 0..* | CodeableConcept | A channel of communication Binding: ParticipationMode (example): Codes for communication mediums such as phone, fax, email, in person, etc.
subject | Σ | 0..1 | Reference(Patient | Group) | Focus of message
topic | S | 0..1 | CodeableConcept | Description of the purpose/content Binding: Population Screening Next Invitation Type Value Set (required)
about | S | 0..* | Reference(Resource) | Resources that pertain to this communication
encounter | Σ | 0..1 | Reference(Encounter) | Encounter created as part of
sent |  | 0..1 | dateTime | When sent
received |  | 0..1 | dateTime | When received
recipient | S | 1..* | Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson | Group | CareTeam | HealthcareService) | Message recipient
sender | S | 1..1 | Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson | HealthcareService) | Message sender
reasonCode | Σ | 0..* | CodeableConcept | Indication for message Binding: SNOMEDCTClinicalFindings (example): Codes for describing reasons for the occurrence of a communication.
reasonReference | Σ | 0..* | Reference(Condition | Observation | DiagnosticReport | DocumentReference) | Why was communication done?
payload |  | 0..* | BackboneElement | Message payload
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
Slices for content[x] |  | 1..1 |  | Message part content Slice: Unordered, Open by type:$this
contentString |  |  | string |
contentAttachment |  |  | Attachment |
contentReference |  |  | Reference(Resource) |
content[x]:contentAttachment | S | 0..1 | Attachment | Message part content
note |  | 0..* | Annotation | Comments made about the communication
Documentation for this format

#### Terminology Bindings

Path | Conformance | ValueSet
Communication.language | preferred | CommonLanguages
Additional Bindings | Purpose
AllLanguages | Max Binding
Communication.status | required | EventStatus
Communication.statusReason | example | CommunicationNotDoneReason
Communication.category | example | CommunicationCategory
Communication.category:cancerScreeningType | required | BeVSPopulationScreeningType
Communication.priority | required | RequestPriority
Communication.medium | example | ParticipationMode
Communication.topic | required | BeVSPopulationScreeningNextInvitationType (a valid code from Population Screening Next Invitation Type)
Communication.reasonCode | example | SNOMEDCTClinicalFindings

#### 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 Communication

Summary

Mandatory: 4 elements (1 nested mandatory element)
Must-Support: 7 elements

Slices

This structure defines the following Slices:

- The element Communication.category is sliced based on the value of pattern:coding.system
- The element Communication.payload.content[x] is sliced based on the value of type:$this

Maturity: 1

Other representations of profile: CSV, Excel, Schematron