IKNL PZP STU3
1.0.0-rc1 - consultation International flag

This page is part of the Advance Care Planning (PZP) (v1.0.0-rc1: Release 1) based on FHIR (HL7® FHIR® Standard) R3. No current official version has been published yet. For a full list of available versions, see the Directory of published versions

Resource Profile: Communication

Official URL: https://api.iknl.nl/docs/pzp/stu3/StructureDefinition/ACP-Communication Version: 1.0.0-rc1
Draft as of 2025-10-30 Computable Name: ACPCommunication

Copyright/Legal: Copyright and related rights waived via CC0, https://creativecommons.org/publicdomain/zero/1.0/. This does not apply to information from third parties, for example a medical terminology system. The implementer alone is responsible for identifying and obtaining any necessary licenses or authorizations to utilize third party IP in connection with the specification or otherwise.

Communication events that have taken place in context of Advance Care Planning. Based on Communication resource.

Usages:

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

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

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Communication C 0..* Communication A record of information transmitted from a sender to a receiver
Constraints: dom-2, dom-1, dom-4, dom-3, com-1
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
Slice: Unordered, Open by value:url
... status ?!Σ 1..1 code preparation | in-progress | suspended | aborted | completed | entered-in-error
Binding: EventStatus (required): The status of the communication.
... notDoneReason ΣC 0..1 CodeableConcept Why communication did not occur
Binding: CommunicationNotDoneReason (example): Codes for the reason why a communication was not done.
... subject ΣC 0..1 Reference(Patient(1.0.0-rc1)) Focus of message
Constraints: ref-1
... recipient C 0..* Reference(Patient(1.0.0-rc1)) Message recipient
Constraints: ref-1
... topic C 0..* Reference(Resource) Focal resources
Constraints: ref-1
... sent 0..1 dateTime When sent
... sender C 0..1 Reference(HealthProfessional Practitioner(1.0.0-rc1)) Message sender
Constraints: ref-1
... reasonCode Σ 1..1 CodeableConcept Indication for message
Binding: SNOMED CT Clinical Findings (example): Codes for describing reasons for the occurrence of a communication.

Required Pattern: At least the following
.... id 0..1 string xml:id (or equivalent in JSON)
.... extension 0..* Extension Additional Content defined by implementations
.... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
..... id 0..1 string xml:id (or equivalent in JSON)
..... extension 0..* Extension Additional Content defined by implementations
..... system 1..1 uri Identity of the terminology system
Fixed Value: http://snomed.info/sct
..... version 0..1 string Version of the system - if relevant
..... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 713603004
..... 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

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Communication.statusrequiredEventStatus
http://hl7.org/fhir/ValueSet/event-status|3.0.2
From the FHIR Standard
Communication.notDoneReasonexampleCommunicationNotDoneReason
http://hl7.org/fhir/ValueSet/communication-not-done-reason|3.0.2
From the FHIR Standard
Communication.reasonCodeexamplePattern Value: SNOMED-CT Code 713603004
http://hl7.org/fhir/ValueSet/clinical-findings|3.0.2
From the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
com-1errorCommunicationNot Done Reason can only be specified if NotDone is "true"
: notDone or notDoneReason.exists().not()
dom-1errorCommunicationIf the resource is contained in another resource, it SHALL NOT contain any narrative
: contained.text.empty()
dom-2errorCommunicationIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorCommunicationIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource
: contained.where(('#'+id in %resource.descendants().reference).not()).empty()
dom-4errorCommunicationIf 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()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() | (children().count() > id.count())
ref-1errorCommunication.subject, Communication.recipient, Communication.topic, Communication.senderSHALL have a contained resource if a local reference is provided
: reference.startsWith('#').not() or (reference.substring(1).trace('url') in %resource.contained.id.trace('ids'))

This structure is derived from Communication

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Communication 0..* Communication A record of information transmitted from a sender to a receiver
... subject 0..1 Reference(Patient(1.0.0-rc1)) Focus of message
... recipient 0..* Reference(Patient(1.0.0-rc1)) Message recipient
... topic 0..* Reference(Resource) Focal resources
... sender 0..1 Reference(HealthProfessional Practitioner(1.0.0-rc1)) Message sender
... reasonCode 1..1 CodeableConcept Indication for message
Required Pattern: At least the following
.... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
..... system 1..1 uri Identity of the terminology system
Fixed Value: http://snomed.info/sct
..... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 713603004

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Communication C 0..* Communication A record of information transmitted from a sender to a receiver
Constraints: dom-2, dom-1, dom-4, dom-3, com-1
... 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: Common Languages (extensible): A human language.
Additional BindingsPurpose
All Languages Max Binding
... text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional Content defined by implementations
Slice: Unordered, Open by value:url
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
Slice: Unordered, Open by value:url
... identifier Σ 0..* Identifier Unique identifier
... definition ΣC 0..* Reference(PlanDefinition | ActivityDefinition) Instantiates protocol or definition
Constraints: ref-1
... basedOn ΣC 0..* Reference(Resource) Request fulfilled by this communication
Constraints: ref-1
... partOf ΣC 0..* Reference(Resource) Part of this action
Constraints: ref-1
... status ?!Σ 1..1 code preparation | in-progress | suspended | aborted | completed | entered-in-error
Binding: EventStatus (required): The status of the communication.
... notDone ?!Σ 0..1 boolean Communication did not occur
... notDoneReason ΣC 0..1 CodeableConcept Why communication did not occur
Binding: CommunicationNotDoneReason (example): Codes for the reason why a communication was not done.
... category 0..* CodeableConcept Message category
Binding: CommunicationCategory (example): Codes for general categories of communications such as alerts, instruction, etc.
... medium 0..* CodeableConcept A channel of communication
Binding: ParticipationMode|2016-11-11 (example): Codes for communication mediums such as phone, fax, email, in person, etc.
... subject ΣC 0..1 Reference(Patient(1.0.0-rc1)) Focus of message
Constraints: ref-1
... recipient C 0..* Reference(Patient(1.0.0-rc1)) Message recipient
Constraints: ref-1
... topic C 0..* Reference(Resource) Focal resources
Constraints: ref-1
... context ΣC 0..1 Reference(Encounter | EpisodeOfCare) Encounter or episode leading to message
Constraints: ref-1
... sent 0..1 dateTime When sent
... received 0..1 dateTime When received
... sender C 0..1 Reference(HealthProfessional Practitioner(1.0.0-rc1)) Message sender
Constraints: ref-1
... reasonCode Σ 1..1 CodeableConcept Indication for message
Binding: SNOMED CT Clinical Findings (example): Codes for describing reasons for the occurrence of a communication.

Required Pattern: At least the following
.... id 0..1 string xml:id (or equivalent in JSON)
.... extension 0..* Extension Additional Content defined by implementations
.... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
..... id 0..1 string xml:id (or equivalent in JSON)
..... extension 0..* Extension Additional Content defined by implementations
..... system 1..1 uri Identity of the terminology system
Fixed Value: http://snomed.info/sct
..... version 0..1 string Version of the system - if relevant
..... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 713603004
..... 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
... reasonReference ΣC 0..* Reference(Condition | Observation) Why was communication done?
Constraints: ref-1
... payload 0..* BackboneElement Message payload
.... id 0..1 string xml:id (or equivalent in JSON)
.... extension 0..* Extension Additional Content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
.... content[x] 1..1 Message part content
Constraints: ele-1
..... contentString string
..... contentAttachment Attachment
..... contentReference Reference(Resource)
... note 0..* Annotation Comments made about the communication

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Communication.languageextensibleCommon Languages
http://hl7.org/fhir/ValueSet/languages|3.0.2
From the FHIR Standard
Additional Bindings Purpose
All Languages Max Binding
Communication.statusrequiredEventStatus
http://hl7.org/fhir/ValueSet/event-status|3.0.2
From the FHIR Standard
Communication.notDoneReasonexampleCommunicationNotDoneReason
http://hl7.org/fhir/ValueSet/communication-not-done-reason|3.0.2
From the FHIR Standard
Communication.categoryexampleCommunicationCategory
http://hl7.org/fhir/ValueSet/communication-category|3.0.2
From the FHIR Standard
Communication.mediumexamplev3 Code System ParticipationMode
http://hl7.org/fhir/ValueSet/v3-ParticipationMode|2016-11-11
From the FHIR Standard
Communication.reasonCodeexamplePattern Value: SNOMED-CT Code 713603004
http://hl7.org/fhir/ValueSet/clinical-findings|3.0.2
From the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
com-1errorCommunicationNot Done Reason can only be specified if NotDone is "true"
: notDone or notDoneReason.exists().not()
dom-1errorCommunicationIf the resource is contained in another resource, it SHALL NOT contain any narrative
: contained.text.empty()
dom-2errorCommunicationIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorCommunicationIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource
: contained.where(('#'+id in %resource.descendants().reference).not()).empty()
dom-4errorCommunicationIf 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()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() | (children().count() > id.count())
ref-1errorCommunication.definition, Communication.basedOn, Communication.partOf, Communication.subject, Communication.recipient, Communication.topic, Communication.context, Communication.sender, Communication.reasonReferenceSHALL have a contained resource if a local reference is provided
: reference.startsWith('#').not() or (reference.substring(1).trace('url') in %resource.contained.id.trace('ids'))

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Communication C 0..* Communication A record of information transmitted from a sender to a receiver
Constraints: dom-2, dom-1, dom-4, dom-3, com-1
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
Slice: Unordered, Open by value:url
... status ?!Σ 1..1 code preparation | in-progress | suspended | aborted | completed | entered-in-error
Binding: EventStatus (required): The status of the communication.
... notDoneReason ΣC 0..1 CodeableConcept Why communication did not occur
Binding: CommunicationNotDoneReason (example): Codes for the reason why a communication was not done.
... subject ΣC 0..1 Reference(Patient(1.0.0-rc1)) Focus of message
Constraints: ref-1
... recipient C 0..* Reference(Patient(1.0.0-rc1)) Message recipient
Constraints: ref-1
... topic C 0..* Reference(Resource) Focal resources
Constraints: ref-1
... sent 0..1 dateTime When sent
... sender C 0..1 Reference(HealthProfessional Practitioner(1.0.0-rc1)) Message sender
Constraints: ref-1
... reasonCode Σ 1..1 CodeableConcept Indication for message
Binding: SNOMED CT Clinical Findings (example): Codes for describing reasons for the occurrence of a communication.

Required Pattern: At least the following
.... id 0..1 string xml:id (or equivalent in JSON)
.... extension 0..* Extension Additional Content defined by implementations
.... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
..... id 0..1 string xml:id (or equivalent in JSON)
..... extension 0..* Extension Additional Content defined by implementations
..... system 1..1 uri Identity of the terminology system
Fixed Value: http://snomed.info/sct
..... version 0..1 string Version of the system - if relevant
..... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 713603004
..... 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

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Communication.statusrequiredEventStatus
http://hl7.org/fhir/ValueSet/event-status|3.0.2
From the FHIR Standard
Communication.notDoneReasonexampleCommunicationNotDoneReason
http://hl7.org/fhir/ValueSet/communication-not-done-reason|3.0.2
From the FHIR Standard
Communication.reasonCodeexamplePattern Value: SNOMED-CT Code 713603004
http://hl7.org/fhir/ValueSet/clinical-findings|3.0.2
From the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
com-1errorCommunicationNot Done Reason can only be specified if NotDone is "true"
: notDone or notDoneReason.exists().not()
dom-1errorCommunicationIf the resource is contained in another resource, it SHALL NOT contain any narrative
: contained.text.empty()
dom-2errorCommunicationIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorCommunicationIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource
: contained.where(('#'+id in %resource.descendants().reference).not()).empty()
dom-4errorCommunicationIf 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()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() | (children().count() > id.count())
ref-1errorCommunication.subject, Communication.recipient, Communication.topic, Communication.senderSHALL have a contained resource if a local reference is provided
: reference.startsWith('#').not() or (reference.substring(1).trace('url') in %resource.contained.id.trace('ids'))

Differential View

This structure is derived from Communication

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Communication 0..* Communication A record of information transmitted from a sender to a receiver
... subject 0..1 Reference(Patient(1.0.0-rc1)) Focus of message
... recipient 0..* Reference(Patient(1.0.0-rc1)) Message recipient
... topic 0..* Reference(Resource) Focal resources
... sender 0..1 Reference(HealthProfessional Practitioner(1.0.0-rc1)) Message sender
... reasonCode 1..1 CodeableConcept Indication for message
Required Pattern: At least the following
.... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
..... system 1..1 uri Identity of the terminology system
Fixed Value: http://snomed.info/sct
..... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 713603004

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Communication C 0..* Communication A record of information transmitted from a sender to a receiver
Constraints: dom-2, dom-1, dom-4, dom-3, com-1
... 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: Common Languages (extensible): A human language.
Additional BindingsPurpose
All Languages Max Binding
... text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional Content defined by implementations
Slice: Unordered, Open by value:url
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
Slice: Unordered, Open by value:url
... identifier Σ 0..* Identifier Unique identifier
... definition ΣC 0..* Reference(PlanDefinition | ActivityDefinition) Instantiates protocol or definition
Constraints: ref-1
... basedOn ΣC 0..* Reference(Resource) Request fulfilled by this communication
Constraints: ref-1
... partOf ΣC 0..* Reference(Resource) Part of this action
Constraints: ref-1
... status ?!Σ 1..1 code preparation | in-progress | suspended | aborted | completed | entered-in-error
Binding: EventStatus (required): The status of the communication.
... notDone ?!Σ 0..1 boolean Communication did not occur
... notDoneReason ΣC 0..1 CodeableConcept Why communication did not occur
Binding: CommunicationNotDoneReason (example): Codes for the reason why a communication was not done.
... category 0..* CodeableConcept Message category
Binding: CommunicationCategory (example): Codes for general categories of communications such as alerts, instruction, etc.
... medium 0..* CodeableConcept A channel of communication
Binding: ParticipationMode|2016-11-11 (example): Codes for communication mediums such as phone, fax, email, in person, etc.
... subject ΣC 0..1 Reference(Patient(1.0.0-rc1)) Focus of message
Constraints: ref-1
... recipient C 0..* Reference(Patient(1.0.0-rc1)) Message recipient
Constraints: ref-1
... topic C 0..* Reference(Resource) Focal resources
Constraints: ref-1
... context ΣC 0..1 Reference(Encounter | EpisodeOfCare) Encounter or episode leading to message
Constraints: ref-1
... sent 0..1 dateTime When sent
... received 0..1 dateTime When received
... sender C 0..1 Reference(HealthProfessional Practitioner(1.0.0-rc1)) Message sender
Constraints: ref-1
... reasonCode Σ 1..1 CodeableConcept Indication for message
Binding: SNOMED CT Clinical Findings (example): Codes for describing reasons for the occurrence of a communication.

Required Pattern: At least the following
.... id 0..1 string xml:id (or equivalent in JSON)
.... extension 0..* Extension Additional Content defined by implementations
.... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
..... id 0..1 string xml:id (or equivalent in JSON)
..... extension 0..* Extension Additional Content defined by implementations
..... system 1..1 uri Identity of the terminology system
Fixed Value: http://snomed.info/sct
..... version 0..1 string Version of the system - if relevant
..... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 713603004
..... 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
... reasonReference ΣC 0..* Reference(Condition | Observation) Why was communication done?
Constraints: ref-1
... payload 0..* BackboneElement Message payload
.... id 0..1 string xml:id (or equivalent in JSON)
.... extension 0..* Extension Additional Content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
.... content[x] 1..1 Message part content
Constraints: ele-1
..... contentString string
..... contentAttachment Attachment
..... contentReference Reference(Resource)
... note 0..* Annotation Comments made about the communication

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Communication.languageextensibleCommon Languages
http://hl7.org/fhir/ValueSet/languages|3.0.2
From the FHIR Standard
Additional Bindings Purpose
All Languages Max Binding
Communication.statusrequiredEventStatus
http://hl7.org/fhir/ValueSet/event-status|3.0.2
From the FHIR Standard
Communication.notDoneReasonexampleCommunicationNotDoneReason
http://hl7.org/fhir/ValueSet/communication-not-done-reason|3.0.2
From the FHIR Standard
Communication.categoryexampleCommunicationCategory
http://hl7.org/fhir/ValueSet/communication-category|3.0.2
From the FHIR Standard
Communication.mediumexamplev3 Code System ParticipationMode
http://hl7.org/fhir/ValueSet/v3-ParticipationMode|2016-11-11
From the FHIR Standard
Communication.reasonCodeexamplePattern Value: SNOMED-CT Code 713603004
http://hl7.org/fhir/ValueSet/clinical-findings|3.0.2
From the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
com-1errorCommunicationNot Done Reason can only be specified if NotDone is "true"
: notDone or notDoneReason.exists().not()
dom-1errorCommunicationIf the resource is contained in another resource, it SHALL NOT contain any narrative
: contained.text.empty()
dom-2errorCommunicationIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorCommunicationIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource
: contained.where(('#'+id in %resource.descendants().reference).not()).empty()
dom-4errorCommunicationIf 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()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() | (children().count() > id.count())
ref-1errorCommunication.definition, Communication.basedOn, Communication.partOf, Communication.subject, Communication.recipient, Communication.topic, Communication.context, Communication.sender, Communication.reasonReferenceSHALL have a contained resource if a local reference is provided
: reference.startsWith('#').not() or (reference.substring(1).trace('url') in %resource.contained.id.trace('ids'))

 

Other representations of profile: CSV, Excel, Schematron