eHealth Platform Federal Core Profiles
2.1.2 - STU1
This page is part of the HL7 Belgium FHIR Implementation Guide - Core profiles (v2.1.2: Release) based on FHIR (HL7® FHIR® Standard) R4. This is the current published version. For a full list of available versions, see the Directory of published versions
Official URL: https://www.ehealth.fgov.be/standards/fhir/core/StructureDefinition/be-communication | Version: 2.1.2 | |||
Active as of 2024-08-30 | Computable Name: BeCommunication |
Belgian federal profile on Communication
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
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 | |
subject | S | 1..1 | Reference(BePatient | Group) | Focus of message |
sender | S | 1..1 | Reference(Device | BeOrganization | BePatient | BePractitioner | BePractitionerRole | RelatedPerson | HealthcareService) | Message sender |
Documentation for this format |
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 |
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. |
subject | SΣ | 1..1 | Reference(BePatient | Group) | Focus of message |
sender | S | 1..1 | Reference(Device | BeOrganization | BePatient | BePractitioner | BePractitionerRole | RelatedPerson | HealthcareService) | Message sender |
Documentation for this format |
Path | Conformance | ValueSet | URI |
Communication.status | required | EventStatushttp://hl7.org/fhir/ValueSet/event-status|4.0.1 from the FHIR Standard |
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.
| |||||
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 | Σ | 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. | ||||
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. | ||||
medium | 0..* | CodeableConcept | A channel of communication Binding: ParticipationMode (example): Codes for communication mediums such as phone, fax, email, in person, etc. | |||||
subject | SΣ | 1..1 | Reference(BePatient | Group) | Focus of message | ||||
topic | 0..1 | CodeableConcept | Description of the purpose/content Binding: CommunicationTopic (example): Codes describing the purpose or content of the communication. | |||||
about | 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 | 0..* | Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson | Group | CareTeam | HealthcareService) | Message recipient | |||||
sender | S | 1..1 | Reference(Device | BeOrganization | BePatient | BePractitioner | BePractitionerRole | 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 | ||||
content[x] | 1..1 | Message part content | ||||||
contentString | string | |||||||
contentAttachment | Attachment | |||||||
contentReference | Reference(Resource) | |||||||
note | 0..* | Annotation | Comments made about the communication | |||||
Documentation for this format |
Path | Conformance | ValueSet | URI | |||
Communication.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languages from the FHIR Standard | ||||
Communication.status | required | EventStatushttp://hl7.org/fhir/ValueSet/event-status|4.0.1 from the FHIR Standard | ||||
Communication.statusReason | example | CommunicationNotDoneReasonhttp://hl7.org/fhir/ValueSet/communication-not-done-reason from the FHIR Standard | ||||
Communication.category | example | CommunicationCategoryhttp://hl7.org/fhir/ValueSet/communication-category from the FHIR Standard | ||||
Communication.priority | required | RequestPriorityhttp://hl7.org/fhir/ValueSet/request-priority|4.0.1 from the FHIR Standard | ||||
Communication.medium | example | ParticipationModehttp://terminology.hl7.org/ValueSet/v3-ParticipationMode | ||||
Communication.topic | example | CommunicationTopichttp://hl7.org/fhir/ValueSet/communication-topic from the FHIR Standard | ||||
Communication.reasonCode | example | SNOMEDCTClinicalFindingshttp://hl7.org/fhir/ValueSet/clinical-findings from the FHIR Standard |
This structure is derived from Communication
Summary
Mandatory: 2 elements
Must-Support: 2 elements
Structures
This structure refers to these other structures:
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 | |
subject | S | 1..1 | Reference(BePatient | Group) | Focus of message |
sender | S | 1..1 | Reference(Device | BeOrganization | BePatient | BePractitioner | BePractitionerRole | RelatedPerson | HealthcareService) | Message sender |
Documentation for this format |
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 |
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. |
subject | SΣ | 1..1 | Reference(BePatient | Group) | Focus of message |
sender | S | 1..1 | Reference(Device | BeOrganization | BePatient | BePractitioner | BePractitionerRole | RelatedPerson | HealthcareService) | Message sender |
Documentation for this format |
Path | Conformance | ValueSet | URI |
Communication.status | required | EventStatushttp://hl7.org/fhir/ValueSet/event-status|4.0.1 from the FHIR Standard |
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.
| |||||
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 | Σ | 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. | ||||
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. | ||||
medium | 0..* | CodeableConcept | A channel of communication Binding: ParticipationMode (example): Codes for communication mediums such as phone, fax, email, in person, etc. | |||||
subject | SΣ | 1..1 | Reference(BePatient | Group) | Focus of message | ||||
topic | 0..1 | CodeableConcept | Description of the purpose/content Binding: CommunicationTopic (example): Codes describing the purpose or content of the communication. | |||||
about | 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 | 0..* | Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson | Group | CareTeam | HealthcareService) | Message recipient | |||||
sender | S | 1..1 | Reference(Device | BeOrganization | BePatient | BePractitioner | BePractitionerRole | 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 | ||||
content[x] | 1..1 | Message part content | ||||||
contentString | string | |||||||
contentAttachment | Attachment | |||||||
contentReference | Reference(Resource) | |||||||
note | 0..* | Annotation | Comments made about the communication | |||||
Documentation for this format |
Path | Conformance | ValueSet | URI | |||
Communication.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languages from the FHIR Standard | ||||
Communication.status | required | EventStatushttp://hl7.org/fhir/ValueSet/event-status|4.0.1 from the FHIR Standard | ||||
Communication.statusReason | example | CommunicationNotDoneReasonhttp://hl7.org/fhir/ValueSet/communication-not-done-reason from the FHIR Standard | ||||
Communication.category | example | CommunicationCategoryhttp://hl7.org/fhir/ValueSet/communication-category from the FHIR Standard | ||||
Communication.priority | required | RequestPriorityhttp://hl7.org/fhir/ValueSet/request-priority|4.0.1 from the FHIR Standard | ||||
Communication.medium | example | ParticipationModehttp://terminology.hl7.org/ValueSet/v3-ParticipationMode | ||||
Communication.topic | example | CommunicationTopichttp://hl7.org/fhir/ValueSet/communication-topic from the FHIR Standard | ||||
Communication.reasonCode | example | SNOMEDCTClinicalFindingshttp://hl7.org/fhir/ValueSet/clinical-findings from the FHIR Standard |
This structure is derived from Communication
Summary
Mandatory: 2 elements
Must-Support: 2 elements
Structures
This structure refers to these other structures:
Other representations of profile: CSV, Excel, Schematron