Belgium eHealth FHIR Core specifications
1.2.2 - CI Build
Belgium eHealth FHIR Core specifications
1.2.2 - CI Build
This page is part of the Belgium eHealth FHIR Core specifications (v1.2.2: Trial Use) based on FHIR R4. This is the current published version. For a full list of available versions, see the Directory of published versions 
| Defining URL: | https://www.ehealth.fgov.be/standards/fhir/StructureDefinition/be-communication |
| Version: | 1.2.2 |
| Name: | BeCommunication |
| Status: | Active as of 2021-01-18T09:02:46+00:00 |
| Definition: | 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. |
| Publisher: | eHealth |
| Source Resource: | XML / JSON / Turtle |
The official URL for this profile is:
https://www.ehealth.fgov.be/standards/fhir/StructureDefinition/be-communication
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from Communication
Summary
Must-Support: 10 elements
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
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 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 |
| priority | S | 0..1 | code | routine | urgent | asap | stat |
 subject | S | 0..1 | Reference(BePatient | 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 | BePractitioner | BePractitionerRole | RelatedPerson | Group | CareTeam | HealthcareService | BeOrganization) | Intended receiver of the communication |
| sender | S | 0..1 | Reference(Device | BePatient | BePractitioner | BePractitionerRole | RelatedPerson | HealthcareService | BeOrganization) | 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 | 1..1 | string | Message part content | |
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Communication | 0..* | Communication | A record of information transmitted from a sender to a receiver | |
 id | Σ | 0..1 | string | 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) Max Binding: AllLanguages: A human language. | |
| 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 | 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 | BePractitioner | BePractitionerRole | RelatedPerson | Group | CareTeam | HealthcareService | BeOrganization) | Intended receiver of the communication |
| sender | S | 0..1 | Reference(Device | BePatient | BePractitioner | BePractitionerRole | RelatedPerson | HealthcareService | BeOrganization) | 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 | 1..1 | string | Message part content | |
 note | 0..* | Annotation | Comments made about the communication | |
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Communication | 0..* | Communication | A record of information transmitted from a sender to a receiver | |
| identifier | Σ | 0..* | Identifier | Unique identifier for this communication |
| status | ?!Σ | 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. |
| category | 0..* | CodeableConcept | Message category Binding: CommunicationCategory (example): Codes for general categories of communications such as alerts, instructions, etc. | |
| priority | Σ | 0..1 | code | routine | urgent | asap | stat Binding: RequestPriority (required): Codes indicating the relative importance of a communication. |
| subject | Σ | 0..1 | Reference(BePatient | Group) | Subject of the communication - typically Patient |
| topic | 0..1 | CodeableConcept | Topic of the communication Binding: BeVSDiaryTopic (preferred) | |
| sent | 0..1 | dateTime | Date and Time that the communication has been sent | |
| recipient | 0..* | Reference(Device | BePatient | BePractitioner | BePractitionerRole | RelatedPerson | Group | CareTeam | HealthcareService | BeOrganization) | Intended receiver of the communication | |
| sender | 0..1 | Reference(Device | BePatient | BePractitioner | BePractitionerRole | RelatedPerson | HealthcareService | BeOrganization) | The actual sender of the communication | |
| payload | 0..* | BackboneElement | The content of the communication or diary note. Text (up to 320 characters), Attachments (base-64 encoded) or References. | |
| Documentation for this format | ||||
This structure is derived from Communication
Summary
Must-Support: 10 elements
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
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 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 |
| priority | S | 0..1 | code | routine | urgent | asap | stat |
| subject | S | 0..1 | Reference(BePatient | 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 | BePractitioner | BePractitionerRole | RelatedPerson | Group | CareTeam | HealthcareService | BeOrganization) | Intended receiver of the communication |
| sender | S | 0..1 | Reference(Device | BePatient | BePractitioner | BePractitionerRole | RelatedPerson | HealthcareService | BeOrganization) | 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 | 1..1 | string | Message part content | |
| Documentation for this format | ||||
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 | string | 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) Max Binding: AllLanguages: A human language. | |
| 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 | 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 | BePractitioner | BePractitionerRole | RelatedPerson | Group | CareTeam | HealthcareService | BeOrganization) | Intended receiver of the communication |
| sender | S | 0..1 | Reference(Device | BePatient | BePractitioner | BePractitionerRole | RelatedPerson | HealthcareService | BeOrganization) | 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 | 1..1 | string | Message part content | |
| note | 0..* | Annotation | Comments made about the communication | |
| Documentation for this format | ||||
Other representations of profile: CSV, Excel, Schematron
| Path | Conformance | ValueSet |
| Communication.language | preferred | CommonLanguages Max Binding: AllLanguages |
| Communication.status | required | EventStatus |
| Communication.statusReason | example | CommunicationNotDoneReason |
| Communication.category | example | CommunicationCategory |
| Communication.priority | required | RequestPriority |
| Communication.medium | example | ParticipationMode |
| Communication.topic | preferred | BeVSDiaryTopic |
| Communication.reasonCode | example | SNOMEDCTClinicalFindings |
| Id | Path | Details | Requirements |
| dom-2 | Communication | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | 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 | 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 | Communication | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | Communication | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | Communication.meta | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Communication.implicitRules | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Communication.language | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Communication.text | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Communication.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | Communication.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | Communication.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | Communication.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | Communication.identifier | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Communication.instantiatesCanonical | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Communication.instantiatesUri | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Communication.basedOn | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Communication.partOf | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Communication.inResponseTo | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Communication.status | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Communication.statusReason | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Communication.category | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Communication.priority | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Communication.medium | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Communication.subject | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Communication.topic | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Communication.about | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Communication.encounter | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Communication.sent | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Communication.received | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Communication.recipient | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Communication.sender | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Communication.reasonCode | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Communication.reasonReference | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Communication.payload | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Communication.payload.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | Communication.payload.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | Communication.payload.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | Communication.payload.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | Communication.payload.content[x] | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Communication.payload.content[x]:contentString | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Communication.note | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |