HL7 Belgium care-coordination
0.0.1 - R4 Belgium flag

HL7 Belgium care-coordination, published by eHealth Platform. This guide is not an authorized publication; it is the continuous build for version 0.0.1 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/hl7-be/care-coordination/ and changes regularly. See the Directory of published versions

Resource Profile: BeCommunication

Official URL: https://www.ehealth.fgov.be/standards/fhir/care-coordination/StructureDefinition/be-communication Version: 0.0.1
Active as of 2021-01-18 Computable Name: BeCommunication

This is the technical specification for the Communication resource, as it is used in Belgium. This specification is compatible with the current version of KMEHR Diary Note, namely the selection of attributes that are supported, and the maximum length of the payload (320 characters). It also relies on the foundation Belgium resources, for example the Belgian Patient, Practitioner and other resources.

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.

This structure is derived from Communication

NameFlagsCard.TypeDescription & Constraintsdoco
.. Communication 0..* Communication A record of information transmitted from a sender to a receiver
... identifier S 0..* Identifier Unique identifier for this communication
... status S 1..1 code Status of this communication: preparation | in-progress | not-done | on-hold | stopped | completed | entered-in-error | unknown
... category S 0..* CodeableConcept Message category
... subject S 0..1 Reference(BePatient(2.1.2) | Group) Subject of the communication - typically Patient
... topic S 0..1 CodeableConcept Topic of the communication
Binding: BeVSDiaryTopic (preferred)
... sent S 0..1 dateTime Date and Time that the communication has been sent
... recipient S 0..* Reference(Device | BePatient(2.1.2) | BePractitioner(2.1.2) | BePractitionerRole(2.1.2) | RelatedPerson | Group | CareTeam | HealthcareService | BeOrganization(2.1.2)) Intended receiver of the communication
... sender S 0..1 Reference(Device | BePatient(2.1.2) | BePractitioner(2.1.2) | BePractitionerRole(2.1.2) | RelatedPerson | HealthcareService | BeOrganization(2.1.2)) The actual sender of the communication
... payload S 0..* BackboneElement The content of the communication or diary note. Text (up to 320 characters), Attachments (base-64 encoded) or References.
.... Slices for content[x] 1..1 string, Attachment, Reference(Resource) Communication content
Slice: Unordered, Open by type:$this
..... content[x]:contentString 0..1 string Message part content

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
Communication.topicpreferredBeVSDiaryTopic
https://www.ehealth.fgov.be/standards/fhir/care-coordination/ValueSet/be-vs-diarytopic
from this IG
NameFlagsCard.TypeDescription & Constraintsdoco
.. Communication 0..* Communication A record of information transmitted from a sender to a receiver
dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
dom-3: 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
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
dom-5: If a resource is contained in another resource, it SHALL NOT have a security label
dom-6: A resource should have narrative for robust management
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
ele-1: All FHIR elements must have a @value or children
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
... identifier SΣ 0..* Identifier Unique identifier for this communication
ele-1: All FHIR elements must have a @value or children
... category S 0..* CodeableConcept Message category
Binding: CommunicationCategory (example): Codes for general categories of communications such as alerts, instructions, etc.


ele-1: All FHIR elements must have a @value or children
... priority SΣ 0..1 code routine | urgent | asap | stat
Binding: RequestPriority (required): Codes indicating the relative importance of a communication.


ele-1: All FHIR elements must have a @value or children
... subject SΣ 0..1 Reference(BePatient(2.1.2) | Group) Subject of the communication - typically Patient
ele-1: All FHIR elements must have a @value or children
... topic S 0..1 CodeableConcept Topic of the communication
Binding: BeVSDiaryTopic (preferred)
ele-1: All FHIR elements must have a @value or children
... sent S 0..1 dateTime Date and Time that the communication has been sent
ele-1: All FHIR elements must have a @value or children
... recipient S 0..* Reference(Device | BePatient(2.1.2) | BePractitioner(2.1.2) | BePractitionerRole(2.1.2) | RelatedPerson | Group | CareTeam | HealthcareService | BeOrganization(2.1.2)) Intended receiver of the communication
ele-1: All FHIR elements must have a @value or children
... sender S 0..1 Reference(Device | BePatient(2.1.2) | BePractitioner(2.1.2) | BePractitionerRole(2.1.2) | RelatedPerson | HealthcareService | BeOrganization(2.1.2)) The actual sender of the communication
ele-1: All FHIR elements must have a @value or children
... payload S 0..* BackboneElement The content of the communication or diary note. Text (up to 320 characters), Attachments (base-64 encoded) or References.
ele-1: All FHIR elements must have a @value or children
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... Slices for content[x] 1..1 Communication content
Slice: Unordered, Open by type:$this
ele-1: All FHIR elements must have a @value or children
..... contentString string
..... contentAttachment Attachment
..... contentReference Reference(Resource)
..... content[x]:contentString 0..1 string Message part content
ele-1: All FHIR elements must have a @value or children

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Communication.statusrequiredEventStatus
http://hl7.org/fhir/ValueSet/event-status|4.0.1
from the FHIR Standard
Communication.categoryexampleCommunicationCategory
http://hl7.org/fhir/ValueSet/communication-category
from the FHIR Standard
Communication.priorityrequiredRequestPriority
http://hl7.org/fhir/ValueSet/request-priority|4.0.1
from the FHIR Standard
Communication.topicpreferredBeVSDiaryTopic
https://www.ehealth.fgov.be/standards/fhir/care-coordination/ValueSet/be-vs-diarytopic
from this IG
NameFlagsCard.TypeDescription & Constraintsdoco
.. 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 BindingsPurpose
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 for this communication
... 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 ?!SΣ 1..1 code Status of this communication: 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.

... category S 0..* CodeableConcept Message category
Binding: CommunicationCategory (example): Codes for general categories of communications such as alerts, instructions, etc.


... priority SΣ 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 SΣ 0..1 Reference(BePatient(2.1.2) | Group) Subject of the communication - typically Patient
... topic S 0..1 CodeableConcept Topic of the communication
Binding: BeVSDiaryTopic (preferred)
... about 0..* Reference(Resource) Resources that pertain to this communication
... encounter Σ 0..1 Reference(Encounter) Encounter created as part of
... sent S 0..1 dateTime Date and Time that the communication has been sent
... received 0..1 dateTime When received
... recipient S 0..* Reference(Device | BePatient(2.1.2) | BePractitioner(2.1.2) | BePractitionerRole(2.1.2) | RelatedPerson | Group | CareTeam | HealthcareService | BeOrganization(2.1.2)) Intended receiver of the communication
... sender S 0..1 Reference(Device | BePatient(2.1.2) | BePractitioner(2.1.2) | BePractitionerRole(2.1.2) | RelatedPerson | HealthcareService | BeOrganization(2.1.2)) The actual sender of the communication
... 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 S 0..* BackboneElement The content of the communication or diary note. Text (up to 320 characters), Attachments (base-64 encoded) or References.
.... 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 Communication content
Slice: Unordered, Open by type:$this
..... contentString string
..... contentAttachment Attachment
..... contentReference Reference(Resource)
..... content[x]:contentString 0..1 string Message part content
... note 0..* Annotation Comments made about the communication

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Communication.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding
Communication.statusrequiredEventStatus
http://hl7.org/fhir/ValueSet/event-status|4.0.1
from the FHIR Standard
Communication.statusReasonexampleCommunicationNotDoneReason
http://hl7.org/fhir/ValueSet/communication-not-done-reason
from the FHIR Standard
Communication.categoryexampleCommunicationCategory
http://hl7.org/fhir/ValueSet/communication-category
from the FHIR Standard
Communication.priorityrequiredRequestPriority
http://hl7.org/fhir/ValueSet/request-priority|4.0.1
from the FHIR Standard
Communication.mediumexampleParticipationMode
http://terminology.hl7.org/ValueSet/v3-ParticipationMode
Communication.topicpreferredBeVSDiaryTopic
https://www.ehealth.fgov.be/standards/fhir/care-coordination/ValueSet/be-vs-diarytopic
from this IG
Communication.reasonCodeexampleSNOMEDCTClinicalFindings
http://hl7.org/fhir/ValueSet/clinical-findings
from the FHIR Standard

Differential View

This structure is derived from Communication

NameFlagsCard.TypeDescription & Constraintsdoco
.. Communication 0..* Communication A record of information transmitted from a sender to a receiver
... identifier S 0..* Identifier Unique identifier for this communication
... status S 1..1 code Status of this communication: preparation | in-progress | not-done | on-hold | stopped | completed | entered-in-error | unknown
... category S 0..* CodeableConcept Message category
... subject S 0..1 Reference(BePatient(2.1.2) | Group) Subject of the communication - typically Patient
... topic S 0..1 CodeableConcept Topic of the communication
Binding: BeVSDiaryTopic (preferred)
... sent S 0..1 dateTime Date and Time that the communication has been sent
... recipient S 0..* Reference(Device | BePatient(2.1.2) | BePractitioner(2.1.2) | BePractitionerRole(2.1.2) | RelatedPerson | Group | CareTeam | HealthcareService | BeOrganization(2.1.2)) Intended receiver of the communication
... sender S 0..1 Reference(Device | BePatient(2.1.2) | BePractitioner(2.1.2) | BePractitionerRole(2.1.2) | RelatedPerson | HealthcareService | BeOrganization(2.1.2)) The actual sender of the communication
... payload S 0..* BackboneElement The content of the communication or diary note. Text (up to 320 characters), Attachments (base-64 encoded) or References.
.... Slices for content[x] 1..1 string, Attachment, Reference(Resource) Communication content
Slice: Unordered, Open by type:$this
..... content[x]:contentString 0..1 string Message part content

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
Communication.topicpreferredBeVSDiaryTopic
https://www.ehealth.fgov.be/standards/fhir/care-coordination/ValueSet/be-vs-diarytopic
from this IG

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Communication 0..* Communication A record of information transmitted from a sender to a receiver
dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
dom-3: 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
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
dom-5: If a resource is contained in another resource, it SHALL NOT have a security label
dom-6: A resource should have narrative for robust management
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
ele-1: All FHIR elements must have a @value or children
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
... identifier SΣ 0..* Identifier Unique identifier for this communication
ele-1: All FHIR elements must have a @value or children
... category S 0..* CodeableConcept Message category
Binding: CommunicationCategory (example): Codes for general categories of communications such as alerts, instructions, etc.


ele-1: All FHIR elements must have a @value or children
... priority SΣ 0..1 code routine | urgent | asap | stat
Binding: RequestPriority (required): Codes indicating the relative importance of a communication.


ele-1: All FHIR elements must have a @value or children
... subject SΣ 0..1 Reference(BePatient(2.1.2) | Group) Subject of the communication - typically Patient
ele-1: All FHIR elements must have a @value or children
... topic S 0..1 CodeableConcept Topic of the communication
Binding: BeVSDiaryTopic (preferred)
ele-1: All FHIR elements must have a @value or children
... sent S 0..1 dateTime Date and Time that the communication has been sent
ele-1: All FHIR elements must have a @value or children
... recipient S 0..* Reference(Device | BePatient(2.1.2) | BePractitioner(2.1.2) | BePractitionerRole(2.1.2) | RelatedPerson | Group | CareTeam | HealthcareService | BeOrganization(2.1.2)) Intended receiver of the communication
ele-1: All FHIR elements must have a @value or children
... sender S 0..1 Reference(Device | BePatient(2.1.2) | BePractitioner(2.1.2) | BePractitionerRole(2.1.2) | RelatedPerson | HealthcareService | BeOrganization(2.1.2)) The actual sender of the communication
ele-1: All FHIR elements must have a @value or children
... payload S 0..* BackboneElement The content of the communication or diary note. Text (up to 320 characters), Attachments (base-64 encoded) or References.
ele-1: All FHIR elements must have a @value or children
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... Slices for content[x] 1..1 Communication content
Slice: Unordered, Open by type:$this
ele-1: All FHIR elements must have a @value or children
..... contentString string
..... contentAttachment Attachment
..... contentReference Reference(Resource)
..... content[x]:contentString 0..1 string Message part content
ele-1: All FHIR elements must have a @value or children

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Communication.statusrequiredEventStatus
http://hl7.org/fhir/ValueSet/event-status|4.0.1
from the FHIR Standard
Communication.categoryexampleCommunicationCategory
http://hl7.org/fhir/ValueSet/communication-category
from the FHIR Standard
Communication.priorityrequiredRequestPriority
http://hl7.org/fhir/ValueSet/request-priority|4.0.1
from the FHIR Standard
Communication.topicpreferredBeVSDiaryTopic
https://www.ehealth.fgov.be/standards/fhir/care-coordination/ValueSet/be-vs-diarytopic
from this IG

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. 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 BindingsPurpose
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 for this communication
... 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 ?!SΣ 1..1 code Status of this communication: 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.

... category S 0..* CodeableConcept Message category
Binding: CommunicationCategory (example): Codes for general categories of communications such as alerts, instructions, etc.


... priority SΣ 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 SΣ 0..1 Reference(BePatient(2.1.2) | Group) Subject of the communication - typically Patient
... topic S 0..1 CodeableConcept Topic of the communication
Binding: BeVSDiaryTopic (preferred)
... about 0..* Reference(Resource) Resources that pertain to this communication
... encounter Σ 0..1 Reference(Encounter) Encounter created as part of
... sent S 0..1 dateTime Date and Time that the communication has been sent
... received 0..1 dateTime When received
... recipient S 0..* Reference(Device | BePatient(2.1.2) | BePractitioner(2.1.2) | BePractitionerRole(2.1.2) | RelatedPerson | Group | CareTeam | HealthcareService | BeOrganization(2.1.2)) Intended receiver of the communication
... sender S 0..1 Reference(Device | BePatient(2.1.2) | BePractitioner(2.1.2) | BePractitionerRole(2.1.2) | RelatedPerson | HealthcareService | BeOrganization(2.1.2)) The actual sender of the communication
... 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 S 0..* BackboneElement The content of the communication or diary note. Text (up to 320 characters), Attachments (base-64 encoded) or References.
.... 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 Communication content
Slice: Unordered, Open by type:$this
..... contentString string
..... contentAttachment Attachment
..... contentReference Reference(Resource)
..... content[x]:contentString 0..1 string Message part content
... note 0..* Annotation Comments made about the communication

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Communication.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding
Communication.statusrequiredEventStatus
http://hl7.org/fhir/ValueSet/event-status|4.0.1
from the FHIR Standard
Communication.statusReasonexampleCommunicationNotDoneReason
http://hl7.org/fhir/ValueSet/communication-not-done-reason
from the FHIR Standard
Communication.categoryexampleCommunicationCategory
http://hl7.org/fhir/ValueSet/communication-category
from the FHIR Standard
Communication.priorityrequiredRequestPriority
http://hl7.org/fhir/ValueSet/request-priority|4.0.1
from the FHIR Standard
Communication.mediumexampleParticipationMode
http://terminology.hl7.org/ValueSet/v3-ParticipationMode
Communication.topicpreferredBeVSDiaryTopic
https://www.ehealth.fgov.be/standards/fhir/care-coordination/ValueSet/be-vs-diarytopic
from this IG
Communication.reasonCodeexampleSNOMEDCTClinicalFindings
http://hl7.org/fhir/ValueSet/clinical-findings
from the FHIR Standard

 

Other representations of profile: CSV, Excel, Schematron