IKNL PZP STU3
1.0.0-alpha1 - consultation International flag

IKNL PZP STU3, published by IKNL. This guide is not an authorized publication; it is the continuous build for version 1.0.0-alpha1 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/IKNL/PZP-FHIR-STU3/ and changes regularly. 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-alpha1
Draft as of 2025-10-23 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: com-1
... 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 | suspended | aborted | completed | entered-in-error
Binding: EventStatus (required): The status of the communication.
... subject Σ 0..1 Reference(Patient(1.0.0-alpha1)) Focus of message
... recipient 0..* Reference(Patient(1.0.0-alpha1)) Message recipient
... topic 0..* Reference(Resource) Focal resources
... sent 0..1 dateTime When sent
... sender 0..1 Reference(HealthProfessional Practitioner(1.0.0-alpha1)) Message sender
... 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

Path Status Usage ValueSet Version Source
Communication.status Base required EventStatus 📍3.0.2 FHIR Std.
Communication.reasonCode Base example SNOMED CT Clinical Findings 📍3.0.2 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
com-1 error Communication Not Done Reason can only be specified if NotDone is "true" notDone or notDoneReason.exists().not()
dom-1 error Communication If the resource is contained in another resource, it SHALL NOT contain any narrative contained.text.empty()
dom-2 error Communication If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Communication If 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-4 error 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()

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-alpha1)) Focus of message
... recipient 0..* Reference(Patient(1.0.0-alpha1)) Message recipient
... topic 0..* Reference(Resource) Focal resources
... sender 0..1 Reference(HealthProfessional Practitioner(1.0.0-alpha1)) 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: 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
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier Σ 0..* Identifier Unique identifier
... definition Σ 0..* Reference(PlanDefinition | ActivityDefinition) Instantiates protocol or definition
... basedOn Σ 0..* Reference(Resource) Request fulfilled by this communication
... partOf Σ 0..* Reference(Resource) Part of this action
... 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 Σ 0..1 Reference(Patient(1.0.0-alpha1)) Focus of message
... recipient 0..* Reference(Patient(1.0.0-alpha1)) Message recipient
... topic 0..* Reference(Resource) Focal resources
... context Σ 0..1 Reference(Encounter | EpisodeOfCare) Encounter or episode leading to message
... sent 0..1 dateTime When sent
... received 0..1 dateTime When received
... sender 0..1 Reference(HealthProfessional Practitioner(1.0.0-alpha1)) Message sender
... 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 Σ 0..* Reference(Condition | Observation) Why was communication done?
... payload 0..* BackboneElement Message payload
.... id 0..1 string xml:id (or equivalent in JSON)
.... extension 0..* Extension Additional Content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
.... content[x] 1..1 Message part content
..... contentString string
..... contentAttachment Attachment
..... contentReference Reference(Resource)
... note 0..* Annotation Comments made about the communication

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Communication.language Base extensible Common Languages 📍3.0.2 FHIR Std.
Communication.status Base required EventStatus 📍3.0.2 FHIR Std.
Communication.notDoneReason Base example CommunicationNotDoneReason 📍3.0.2 FHIR Std.
Communication.category Base example CommunicationCategory 📍3.0.2 FHIR Std.
Communication.medium Base example v3 Code System ParticipationMode 📍2016-11-11 FHIR Std.
Communication.reasonCode Base example SNOMED CT Clinical Findings 📍3.0.2 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
com-1 error Communication Not Done Reason can only be specified if NotDone is "true" notDone or notDoneReason.exists().not()
dom-1 error Communication If the resource is contained in another resource, it SHALL NOT contain any narrative contained.text.empty()
dom-2 error Communication If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Communication If 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-4 error 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()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() | (children().count() > id.count())

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Communication C 0..* Communication A record of information transmitted from a sender to a receiver
Constraints: com-1
... 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 | suspended | aborted | completed | entered-in-error
Binding: EventStatus (required): The status of the communication.
... subject Σ 0..1 Reference(Patient(1.0.0-alpha1)) Focus of message
... recipient 0..* Reference(Patient(1.0.0-alpha1)) Message recipient
... topic 0..* Reference(Resource) Focal resources
... sent 0..1 dateTime When sent
... sender 0..1 Reference(HealthProfessional Practitioner(1.0.0-alpha1)) Message sender
... 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

Path Status Usage ValueSet Version Source
Communication.status Base required EventStatus 📍3.0.2 FHIR Std.
Communication.reasonCode Base example SNOMED CT Clinical Findings 📍3.0.2 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
com-1 error Communication Not Done Reason can only be specified if NotDone is "true" notDone or notDoneReason.exists().not()
dom-1 error Communication If the resource is contained in another resource, it SHALL NOT contain any narrative contained.text.empty()
dom-2 error Communication If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Communication If 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-4 error 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()

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-alpha1)) Focus of message
... recipient 0..* Reference(Patient(1.0.0-alpha1)) Message recipient
... topic 0..* Reference(Resource) Focal resources
... sender 0..1 Reference(HealthProfessional Practitioner(1.0.0-alpha1)) 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: 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
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier Σ 0..* Identifier Unique identifier
... definition Σ 0..* Reference(PlanDefinition | ActivityDefinition) Instantiates protocol or definition
... basedOn Σ 0..* Reference(Resource) Request fulfilled by this communication
... partOf Σ 0..* Reference(Resource) Part of this action
... 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 Σ 0..1 Reference(Patient(1.0.0-alpha1)) Focus of message
... recipient 0..* Reference(Patient(1.0.0-alpha1)) Message recipient
... topic 0..* Reference(Resource) Focal resources
... context Σ 0..1 Reference(Encounter | EpisodeOfCare) Encounter or episode leading to message
... sent 0..1 dateTime When sent
... received 0..1 dateTime When received
... sender 0..1 Reference(HealthProfessional Practitioner(1.0.0-alpha1)) Message sender
... 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 Σ 0..* Reference(Condition | Observation) Why was communication done?
... payload 0..* BackboneElement Message payload
.... id 0..1 string xml:id (or equivalent in JSON)
.... extension 0..* Extension Additional Content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
.... content[x] 1..1 Message part content
..... contentString string
..... contentAttachment Attachment
..... contentReference Reference(Resource)
... note 0..* Annotation Comments made about the communication

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Communication.language Base extensible Common Languages 📍3.0.2 FHIR Std.
Communication.status Base required EventStatus 📍3.0.2 FHIR Std.
Communication.notDoneReason Base example CommunicationNotDoneReason 📍3.0.2 FHIR Std.
Communication.category Base example CommunicationCategory 📍3.0.2 FHIR Std.
Communication.medium Base example v3 Code System ParticipationMode 📍2016-11-11 FHIR Std.
Communication.reasonCode Base example SNOMED CT Clinical Findings 📍3.0.2 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
com-1 error Communication Not Done Reason can only be specified if NotDone is "true" notDone or notDoneReason.exists().not()
dom-1 error Communication If the resource is contained in another resource, it SHALL NOT contain any narrative contained.text.empty()
dom-2 error Communication If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Communication If 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-4 error 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()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() | (children().count() > id.count())

 

Other representations of profile: CSV, Excel, Schematron