HL7 Belgium FHIR specifications
0.1 - QA review

This page is part of the HL7 Belgium FHIR Specifications (v2020May: QA Preview) based on FHIR R4. This is the current published version. For a full list of available versions, see the Directory of published versions

StructureDefinition: BECommunication

This is the technical specification for the Communication resource, as it is used in Belgium.

This technical specification corresponds to the FHIR implementation of the Communication section of the Logical Data Model.

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.

The official URL for this profile is: 

https://www.hl7belgium.org/fhir/StructureDefinition/be-communication

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

This structure is derived from Communication

Summary

Must-Support: 7 elements

Structures

This structure refers to these other structures:

This structure is derived from Communication

NameFlagsCard.TypeDescription & Constraintsdoco
.. Communication 0..*CommunicationA record of information transmitted from a sender to a receiver
... identifier S0..*IdentifierUnique identifier for this communication
... status S1..1codeStatus of this communication: preparation | in-progress | not-done | on-hold | stopped | completed | entered-in-error | unknown
... subject 0..1Reference(BePatient)Subject of the communication - typically Patient
... sent S0..1dateTimeDate and Time that the communication has been sent
... recipient S0..*Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson | Group | CareTeam | HealthcareService)Intended receiver of the communication
... sender S0..1Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson | HealthcareService)The actual sender of the communication
... payload S0..*BackboneElementThe content of the communication or diary note. Text (up to 320 characters), Attachments (base-64 encoded) or References.
.... content[x] 1..1Communication content
..... contentStringstring
..... contentAttachmentAttachment
..... contentReferenceReference(Any)

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Communication I0..*CommunicationA record of information transmitted from a sender to a receiver
... id Σ0..1stringLogical id of this artifact
... meta ΣI0..1MetaMetadata about the resource
... implicitRules ?!ΣI0..1uriA set of rules under which this content was created
... language I0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred)
Max Binding: AllLanguages
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension I0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!I0..*ExtensionExtensions that cannot be ignored
... identifier SΣI0..*IdentifierUnique identifier for this communication
... instantiatesCanonical ΣI0..*canonical(PlanDefinition | ActivityDefinition | Measure | OperationDefinition | Questionnaire)Instantiates FHIR protocol or definition
... instantiatesUri ΣI0..*uriInstantiates external protocol or definition
... basedOn ΣI0..*Reference(Resource)Request fulfilled by this communication
... partOf ΣI0..*Reference(Resource)Part of this action
... inResponseTo I0..*Reference(Communication)Reply to
... status ?!SΣI1..1codeStatus of this communication: preparation | in-progress | not-done | on-hold | stopped | completed | entered-in-error | unknown
Binding: EventStatus (required)
... statusReason ΣI0..1CodeableConceptReason for current status
Binding: CommunicationNotDoneReason (example)
... category I0..*CodeableConceptMessage category
Binding: CommunicationCategory (example)
... priority ΣI0..1coderoutine | urgent | asap | stat
Binding: RequestPriority (required)
... medium I0..*CodeableConceptA channel of communication
Binding: v3 Code System ParticipationMode (example)
... subject ΣI0..1Reference(BePatient)Subject of the communication - typically Patient
... topic SI0..1CodeableConceptTopic of the communication
Binding: BEDiaryTopic (preferred)
... about I0..*Reference(Resource)Resources that pertain to this communication
... encounter ΣI0..1Reference(Encounter)Encounter created as part of
... sent SI0..1dateTimeDate and Time that the communication has been sent
... received I0..1dateTimeWhen received
... recipient SI0..*Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson | Group | CareTeam | HealthcareService)Intended receiver of the communication
... sender SI0..1Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson | HealthcareService)The actual sender of the communication
... reasonCode ΣI0..*CodeableConceptIndication for message
Binding: SNOMEDCTClinicalFindings (example)
... reasonReference ΣI0..*Reference(Condition | Observation | DiagnosticReport | DocumentReference)Why was communication done?
... payload SI0..*BackboneElementThe content of the communication or diary note. Text (up to 320 characters), Attachments (base-64 encoded) or References.
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... content[x] I1..1Communication content
..... contentStringstring
..... contentAttachmentAttachment
..... contentReferenceReference(Any)
... note I0..*AnnotationComments made about the communication

doco Documentation for this format

This structure is derived from Communication

Summary

Must-Support: 7 elements

Structures

This structure refers to these other structures:

Differential View

This structure is derived from Communication

NameFlagsCard.TypeDescription & Constraintsdoco
.. Communication 0..*CommunicationA record of information transmitted from a sender to a receiver
... identifier S0..*IdentifierUnique identifier for this communication
... status S1..1codeStatus of this communication: preparation | in-progress | not-done | on-hold | stopped | completed | entered-in-error | unknown
... subject 0..1Reference(BePatient)Subject of the communication - typically Patient
... sent S0..1dateTimeDate and Time that the communication has been sent
... recipient S0..*Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson | Group | CareTeam | HealthcareService)Intended receiver of the communication
... sender S0..1Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson | HealthcareService)The actual sender of the communication
... payload S0..*BackboneElementThe content of the communication or diary note. Text (up to 320 characters), Attachments (base-64 encoded) or References.
.... content[x] 1..1Communication content
..... contentStringstring
..... contentAttachmentAttachment
..... contentReferenceReference(Any)

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Communication I0..*CommunicationA record of information transmitted from a sender to a receiver
... id Σ0..1stringLogical id of this artifact
... meta ΣI0..1MetaMetadata about the resource
... implicitRules ?!ΣI0..1uriA set of rules under which this content was created
... language I0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred)
Max Binding: AllLanguages
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension I0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!I0..*ExtensionExtensions that cannot be ignored
... identifier SΣI0..*IdentifierUnique identifier for this communication
... instantiatesCanonical ΣI0..*canonical(PlanDefinition | ActivityDefinition | Measure | OperationDefinition | Questionnaire)Instantiates FHIR protocol or definition
... instantiatesUri ΣI0..*uriInstantiates external protocol or definition
... basedOn ΣI0..*Reference(Resource)Request fulfilled by this communication
... partOf ΣI0..*Reference(Resource)Part of this action
... inResponseTo I0..*Reference(Communication)Reply to
... status ?!SΣI1..1codeStatus of this communication: preparation | in-progress | not-done | on-hold | stopped | completed | entered-in-error | unknown
Binding: EventStatus (required)
... statusReason ΣI0..1CodeableConceptReason for current status
Binding: CommunicationNotDoneReason (example)
... category I0..*CodeableConceptMessage category
Binding: CommunicationCategory (example)
... priority ΣI0..1coderoutine | urgent | asap | stat
Binding: RequestPriority (required)
... medium I0..*CodeableConceptA channel of communication
Binding: v3 Code System ParticipationMode (example)
... subject ΣI0..1Reference(BePatient)Subject of the communication - typically Patient
... topic SI0..1CodeableConceptTopic of the communication
Binding: BEDiaryTopic (preferred)
... about I0..*Reference(Resource)Resources that pertain to this communication
... encounter ΣI0..1Reference(Encounter)Encounter created as part of
... sent SI0..1dateTimeDate and Time that the communication has been sent
... received I0..1dateTimeWhen received
... recipient SI0..*Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson | Group | CareTeam | HealthcareService)Intended receiver of the communication
... sender SI0..1Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson | HealthcareService)The actual sender of the communication
... reasonCode ΣI0..*CodeableConceptIndication for message
Binding: SNOMEDCTClinicalFindings (example)
... reasonReference ΣI0..*Reference(Condition | Observation | DiagnosticReport | DocumentReference)Why was communication done?
... payload SI0..*BackboneElementThe content of the communication or diary note. Text (up to 320 characters), Attachments (base-64 encoded) or References.
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... content[x] I1..1Communication content
..... contentStringstring
..... contentAttachmentAttachment
..... contentReferenceReference(Any)
... note I0..*AnnotationComments made about the communication

doco Documentation for this format

 

Other representations of profile: Schematron

Terminology Bindings

Terminology Bindings

PathConformanceValueSet
Communication.languagepreferredCommonLanguages
Max Binding: AllLanguages
Communication.statusrequiredEventStatus
Communication.statusReasonexampleCommunicationNotDoneReason
Communication.categoryexampleCommunicationCategory
Communication.priorityrequiredRequestPriority
Communication.mediumexamplev3.ParticipationMode
Communication.topicpreferredBEDiaryTopic
Communication.reasonCodeexampleSNOMEDCTClinicalFindings

Constraints

Constraints

IdPathDetailsRequirements