Care Coordination Management
0.0.1 - ci-build Estonia (EST)

Care Coordination Management, published by Helex OÜ. This guide is not an authorized publication; it is the continuous build for version 0.0.1 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/helexlab/ig-ccm/ and changes regularly. See the Directory of published versions

Resource Profile: CommunicationCcm

Official URL: http://helex.org/ig/ccm/StructureDefinition/communication-ccm Version: 0.0.1
Draft as of 2025-12-05 Computable Name: CommunicationCcm

CCM Communication profile linking a patient with a ResearchStudy and tracking lifecycle via progress entries.

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 0..* Communication A clinical or business level record of information being transmitted or shared
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... contained 0..* Resource Contained, inline Resources
... 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.
Required Pattern: completed
... category S 1..1 CodeableConcept Message category
Binding: CommunicationCategory (example): Codes for general categories of communications such as alerts, instructions, etc.

Required Pattern: At least the following
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... system 0..1 uri Identity of the terminology system
..... version 0..1 string Version of the system - if relevant
..... code 1..1 code Symbol in syntax defined by the system
Fixed Value: instruction
..... 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
... subject SΣ 1..1 Reference(PatientCcm) Focus of message
... topic S 1..1 CodeableConcept Description of the purpose/content
Binding: https://dev.termx.org/api/fhir/ValueSet/ccm-communication-topic--1.0.0 (required)
... sent S 1..1 dateTime When sent
... recipient S 1..1 Reference(PatientCcm) Who the information is shared with
... sender S 1..1 Reference(PractitionerCcm) Who shares the information
... note S 0..1 Annotation Comments made about the communication

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Communication.status Base required EventStatus 📍5.0.0 FHIR Std.
Communication.category Base example Communication Category 📍5.0.0 FHIR Std.
Communication.topic Base required https://dev.termx.org/api/fhir/ValueSet/ccm-communication-topic--1.0.0 Not State Unknown

Constraints

Id Grade Path(s) Description Expression
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 or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).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()
dom-5 error Communication If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Communication A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()

This structure is derived from Communication

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Communication 0..* Communication A clinical or business level record of information being transmitted or shared
... identifier 0..0 Unique identifier
... basedOn S 0..* Reference(Resource) Request fulfilled by this communication
... partOf 0..0 Part of referenced event (e.g. Communication, Procedure)
... status 1..1 code preparation | in-progress | not-done | on-hold | stopped | completed | entered-in-error | unknown
Required Pattern: completed
... statusReason 0..0 Reason for current status
... category S 1..1 CodeableConcept Message category
Required Pattern: At least the following
.... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
..... code 1..1 code Symbol in syntax defined by the system
Fixed Value: instruction
... priority 0..0 routine | urgent | asap | stat
... medium 0..0 A channel of communication
... subject S 1..1 Reference(PatientCcm) Focus of message
... topic S 1..1 CodeableConcept Description of the purpose/content
Binding: https://dev.termx.org/api/fhir/ValueSet/ccm-communication-topic--1.0.0 (required)
... about 0..0 Resources that pertain to this communication
... encounter 0..0 The Encounter during which this Communication was created
... sent S 1..1 dateTime When sent
... received 0..0 When received
... recipient S 1..1 Reference(PatientCcm) Who the information is shared with
... sender S 1..1 Reference(PractitionerCcm) Who shares the information
... reason 0..0 Indication for message
... payload 0..0 Message payload
... note S 0..1 Annotation Comments made about the communication

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
Communication.topic Base required https://dev.termx.org/api/fhir/ValueSet/ccm-communication-topic--1.0.0 Not State Unknown
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Communication 0..* Communication A clinical or business level record of information being transmitted or shared
... 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
... 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
... instantiatesCanonical Σ 0..* canonical(PlanDefinition | ActivityDefinition | Measure | OperationDefinition | Questionnaire) Instantiates FHIR protocol or definition
... instantiatesUri Σ 0..* uri Instantiates external protocol or definition
... basedOn SΣ 0..* Reference(Resource) Request fulfilled by this communication
... 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.
Required Pattern: completed
... category S 1..1 CodeableConcept Message category
Binding: CommunicationCategory (example): Codes for general categories of communications such as alerts, instructions, etc.

Required Pattern: At least the following
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... system 0..1 uri Identity of the terminology system
..... version 0..1 string Version of the system - if relevant
..... code 1..1 code Symbol in syntax defined by the system
Fixed Value: instruction
..... 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
... subject SΣ 1..1 Reference(PatientCcm) Focus of message
... topic S 1..1 CodeableConcept Description of the purpose/content
Binding: https://dev.termx.org/api/fhir/ValueSet/ccm-communication-topic--1.0.0 (required)
... sent S 1..1 dateTime When sent
... recipient S 1..1 Reference(PatientCcm) Who the information is shared with
... sender S 1..1 Reference(PractitionerCcm) Who shares the information
... note S 0..1 Annotation Comments made about the communication

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Communication.language Base required All Languages 📍5.0.0 FHIR Std.
Communication.status Base required EventStatus 📍5.0.0 FHIR Std.
Communication.category Base example Communication Category 📍5.0.0 FHIR Std.
Communication.topic Base required https://dev.termx.org/api/fhir/ValueSet/ccm-communication-topic--1.0.0 Not State Unknown

Constraints

Id Grade Path(s) Description Expression
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 or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).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()
dom-5 error Communication If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Communication A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()

This structure is derived from Communication

Summary

Mandatory: 6 elements
Must-Support: 8 elements
Prohibited: 11 elements

Structures

This structure refers to these other structures:

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Communication 0..* Communication A clinical or business level record of information being transmitted or shared
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... contained 0..* Resource Contained, inline Resources
... 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.
Required Pattern: completed
... category S 1..1 CodeableConcept Message category
Binding: CommunicationCategory (example): Codes for general categories of communications such as alerts, instructions, etc.

Required Pattern: At least the following
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... system 0..1 uri Identity of the terminology system
..... version 0..1 string Version of the system - if relevant
..... code 1..1 code Symbol in syntax defined by the system
Fixed Value: instruction
..... 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
... subject SΣ 1..1 Reference(PatientCcm) Focus of message
... topic S 1..1 CodeableConcept Description of the purpose/content
Binding: https://dev.termx.org/api/fhir/ValueSet/ccm-communication-topic--1.0.0 (required)
... sent S 1..1 dateTime When sent
... recipient S 1..1 Reference(PatientCcm) Who the information is shared with
... sender S 1..1 Reference(PractitionerCcm) Who shares the information
... note S 0..1 Annotation Comments made about the communication

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Communication.status Base required EventStatus 📍5.0.0 FHIR Std.
Communication.category Base example Communication Category 📍5.0.0 FHIR Std.
Communication.topic Base required https://dev.termx.org/api/fhir/ValueSet/ccm-communication-topic--1.0.0 Not State Unknown

Constraints

Id Grade Path(s) Description Expression
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 or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).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()
dom-5 error Communication If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Communication A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()

Differential View

This structure is derived from Communication

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Communication 0..* Communication A clinical or business level record of information being transmitted or shared
... identifier 0..0 Unique identifier
... basedOn S 0..* Reference(Resource) Request fulfilled by this communication
... partOf 0..0 Part of referenced event (e.g. Communication, Procedure)
... status 1..1 code preparation | in-progress | not-done | on-hold | stopped | completed | entered-in-error | unknown
Required Pattern: completed
... statusReason 0..0 Reason for current status
... category S 1..1 CodeableConcept Message category
Required Pattern: At least the following
.... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
..... code 1..1 code Symbol in syntax defined by the system
Fixed Value: instruction
... priority 0..0 routine | urgent | asap | stat
... medium 0..0 A channel of communication
... subject S 1..1 Reference(PatientCcm) Focus of message
... topic S 1..1 CodeableConcept Description of the purpose/content
Binding: https://dev.termx.org/api/fhir/ValueSet/ccm-communication-topic--1.0.0 (required)
... about 0..0 Resources that pertain to this communication
... encounter 0..0 The Encounter during which this Communication was created
... sent S 1..1 dateTime When sent
... received 0..0 When received
... recipient S 1..1 Reference(PatientCcm) Who the information is shared with
... sender S 1..1 Reference(PractitionerCcm) Who shares the information
... reason 0..0 Indication for message
... payload 0..0 Message payload
... note S 0..1 Annotation Comments made about the communication

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
Communication.topic Base required https://dev.termx.org/api/fhir/ValueSet/ccm-communication-topic--1.0.0 Not State Unknown

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Communication 0..* Communication A clinical or business level record of information being transmitted or shared
... 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
... 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
... instantiatesCanonical Σ 0..* canonical(PlanDefinition | ActivityDefinition | Measure | OperationDefinition | Questionnaire) Instantiates FHIR protocol or definition
... instantiatesUri Σ 0..* uri Instantiates external protocol or definition
... basedOn SΣ 0..* Reference(Resource) Request fulfilled by this communication
... 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.
Required Pattern: completed
... category S 1..1 CodeableConcept Message category
Binding: CommunicationCategory (example): Codes for general categories of communications such as alerts, instructions, etc.

Required Pattern: At least the following
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... system 0..1 uri Identity of the terminology system
..... version 0..1 string Version of the system - if relevant
..... code 1..1 code Symbol in syntax defined by the system
Fixed Value: instruction
..... 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
... subject SΣ 1..1 Reference(PatientCcm) Focus of message
... topic S 1..1 CodeableConcept Description of the purpose/content
Binding: https://dev.termx.org/api/fhir/ValueSet/ccm-communication-topic--1.0.0 (required)
... sent S 1..1 dateTime When sent
... recipient S 1..1 Reference(PatientCcm) Who the information is shared with
... sender S 1..1 Reference(PractitionerCcm) Who shares the information
... note S 0..1 Annotation Comments made about the communication

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Communication.language Base required All Languages 📍5.0.0 FHIR Std.
Communication.status Base required EventStatus 📍5.0.0 FHIR Std.
Communication.category Base example Communication Category 📍5.0.0 FHIR Std.
Communication.topic Base required https://dev.termx.org/api/fhir/ValueSet/ccm-communication-topic--1.0.0 Not State Unknown

Constraints

Id Grade Path(s) Description Expression
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 or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).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()
dom-5 error Communication If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Communication A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()

This structure is derived from Communication

Summary

Mandatory: 6 elements
Must-Support: 8 elements
Prohibited: 11 elements

Structures

This structure refers to these other structures:

 

Other representations of profile: CSV, Excel, Schematron