0.1.0 - ci-build

eReferralMustSupport - Local Development build (v0.1.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

## Resource Profile: CAeReCCommunication

Official URL: http://hl7.ca/fhir/eReferral/StructureDefinition/CAeReCCommunication | Version: 0.1.0
Draft as of 2024-08-15 | Computable Name: CAeReCCommunication

Communication resource is used to achieve the bi-directional communication between two systems. The Communication resource can be used to ask questions regarding a referral, request a referral be updated with missing information, or request additional information not covered by the specific referral dataset.

Usage:

- Use this Resource Profile: CAeReCBundle
- Refer to this Resource Profile: CAeReCMessageHeader and CAeReCServiceRequest

### Formal Views of Profile Content

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

- Differential Table
- Key Elements Table
- Snapshot Table
- Statistics/References
- All

This structure is derived from Communication

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
Communication |  |  | Communication |
basedOn | S | 0..* | Reference(CAeReCServiceRequest) | Request fulfilled by this communication
reference | S | 0..1 | string | Literal reference, Relative, internal or absolute URL
identifier | S | 0..1 | Identifier | Logical reference, when literal reference is not known
system | S | 1..1 | uri | The namespace for the identifier value
value | S | 1..1 | string | The value that is unique
inResponseTo | S | 0..* | Reference(Communication) | Reply to
status | S | 1..1 | code | preparation | in-progress | not-done | on-hold | stopped | completed | entered-in-error | unknown Fixed Value: completed
category | S | 0..* | CodeableConcept | Message category Binding: Communication Category (extensible)
subject | S | 0..1 | Reference(CAeReCPatient) | Focus of message
reference | S | 0..1 | string | Literal reference, Relative, internal or absolute URL
identifier | S | 0..1 | Identifier | Logical reference, when literal reference is not known
system | S | 1..1 | uri | The namespace for the identifier value
value | S | 1..1 | string | The value that is unique
sent | S | 0..1 | dateTime | When sent
received | S | 0..1 | dateTime | When received
sender | S | 0..1 | Reference(CAeReCPractitionerRole) | Message sender
reference | S | 0..1 | string | Literal reference, Relative, internal or absolute URL
identifier | S | 0..1 | Identifier | Logical reference, when literal reference is not known
system | S | 1..1 | uri | The namespace for the identifier value
value | S | 1..1 | string | The value that is unique
payload | S | 0..* | BackboneElement | Message payload
content[x] | S | 1..1 |  | Message part content
contentString |  |  | string |
contentAttachment |  |  | Attachment |
Documentation for this format

#### Terminology Bindings (Differential)

Path | Conformance | ValueSet | URI
Communication.category | extensible | CommunicationCategory `http://hl7.ca/fhir/eReferral/ValueSet/communication-category` from this IG

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
basedOn | S Σ | 0..* | Reference(CAeReCServiceRequest) | Request fulfilled by this communication
reference | S Σ C | 0..1 | string | Literal reference, Relative, internal or absolute URL
identifier | S Σ | 0..1 | Identifier | Logical reference, when literal reference is not known
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
system | S Σ | 1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
value | S Σ | 1..1 | string | The value that is unique Example General: 123456
inResponseTo | S | 0..* | Reference(Communication) | Reply to
status | ?!S Σ | 1..1 | code | preparation | in-progress | not-done | on-hold | stopped | completed | entered-in-error | unknown Binding: EventStatus (required): The status of the communication. Fixed Value: completed
category | S | 0..* | CodeableConcept | Message category Binding: Communication Category (extensible)
subject | S Σ | 0..1 | Reference(CAeReCPatient) | Focus of message
reference | S Σ C | 0..1 | string | Literal reference, Relative, internal or absolute URL
identifier | S Σ | 0..1 | Identifier | Logical reference, when literal reference is not known
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
system | S Σ | 1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
value | S Σ | 1..1 | string | The value that is unique Example General: 123456
sent | S | 0..1 | dateTime | When sent
received | S | 0..1 | dateTime | When received
sender | S | 0..1 | Reference(CAeReCPractitionerRole) | Message sender
reference | S Σ C | 0..1 | string | Literal reference, Relative, internal or absolute URL
identifier | S Σ | 0..1 | Identifier | Logical reference, when literal reference is not known
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
system | S Σ | 1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
value | S Σ | 1..1 | string | The value that is unique Example General: 123456
payload | S | 0..* | BackboneElement | Message payload
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
content[x] | S | 1..1 |  | Message part content
contentString |  |  | string |
contentAttachment |  |  | Attachment |
Documentation for this format

#### Terminology Bindings

Path | Conformance | ValueSet / Code | URI
Communication.basedOn.identifier.use | required | IdentifierUse `http://hl7.org/fhir/ValueSet/identifier-use|4.0.1` from the FHIR Standard
Communication.status | required | Fixed Value: completed `http://hl7.org/fhir/ValueSet/event-status|4.0.1` from the FHIR Standard
Communication.category | extensible | CommunicationCategory `http://hl7.ca/fhir/eReferral/ValueSet/communication-category` from this IG
Communication.subject.identifier.use | required | IdentifierUse `http://hl7.org/fhir/ValueSet/identifier-use|4.0.1` from the FHIR Standard
Communication.sender.identifier.use | required | IdentifierUse `http://hl7.org/fhir/ValueSet/identifier-use|4.0.1` from the FHIR Standard

#### Constraints

Id | Grade | Path(s) | Details | Requirements
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().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(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() |

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.
Additional Bindings | Purpose
AllLanguages | Max Binding
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 | S Σ | 0..* | Reference(CAeReCServiceRequest) | Request fulfilled by this communication
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
reference | S Σ C | 0..1 | string | Literal reference, Relative, internal or absolute URL
type | Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
identifier | S Σ | 0..1 | Identifier | Logical reference, when literal reference is not known
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type | Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
system | S Σ | 1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
value | S Σ | 1..1 | string | The value that is unique Example General: 123456
period | Σ | 0..1 | Period | Time period when id is/was valid for use
assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text)
display | Σ | 0..1 | string | Text alternative for the resource
partOf | Σ | 0..* | Reference(Resource) | Part of this action
inResponseTo | S | 0..* | Reference(Communication) | Reply to
status | ?!S Σ | 1..1 | code | preparation | in-progress | not-done | on-hold | stopped | completed | entered-in-error | unknown Binding: EventStatus (required): The status of the communication. Fixed Value: completed
statusReason | Σ | 0..1 | CodeableConcept | Reason for current status Binding: CommunicationNotDoneReason (example): Codes for the reason why a communication did not happen.
category | S | 0..* | CodeableConcept | Message category Binding: Communication Category (extensible)
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 Σ | 0..1 | Reference(CAeReCPatient) | Focus of message
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
reference | S Σ C | 0..1 | string | Literal reference, Relative, internal or absolute URL
type | Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
identifier | S Σ | 0..1 | Identifier | Logical reference, when literal reference is not known
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type | Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
system | S Σ | 1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
value | S Σ | 1..1 | string | The value that is unique Example General: 123456
period | Σ | 0..1 | Period | Time period when id is/was valid for use
assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text)
display | Σ | 0..1 | string | Text alternative for the resource
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 | S | 0..1 | dateTime | When sent
received | S | 0..1 | dateTime | When received
recipient |  | 0..* | Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson | Group | CareTeam | HealthcareService) | Message recipient
sender | S | 0..1 | Reference(CAeReCPractitionerRole) | Message sender
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
reference | S Σ C | 0..1 | string | Literal reference, Relative, internal or absolute URL
type | Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
identifier | S Σ | 0..1 | Identifier | Logical reference, when literal reference is not known
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type | Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
system | S Σ | 1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
value | S Σ | 1..1 | string | The value that is unique Example General: 123456
period | Σ | 0..1 | Period | Time period when id is/was valid for use
assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text)
display | Σ | 0..1 | string | Text alternative for the resource
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 | S | 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] | S | 1..1 |  | Message part content
contentString |  |  | string |
contentAttachment |  |  | Attachment |
note |  | 0..* | Annotation | Comments made about the communication
Documentation for this format

#### Terminology Bindings

Path | Conformance | ValueSet / Code | URI
Communication.language | preferred | CommonLanguages
Additional Bindings | Purpose
AllLanguages | Max Binding
`http://hl7.org/fhir/ValueSet/languages` from the FHIR Standard
Communication.basedOn.type | extensible | ResourceType `http://hl7.org/fhir/ValueSet/resource-types` from the FHIR Standard
Communication.basedOn.identifier.use | required | IdentifierUse `http://hl7.org/fhir/ValueSet/identifier-use|4.0.1` from the FHIR Standard
Communication.basedOn.identifier.type | extensible | Identifier Type Codes `http://hl7.org/fhir/ValueSet/identifier-type` from the FHIR Standard
Communication.status | required | Fixed Value: completed `http://hl7.org/fhir/ValueSet/event-status|4.0.1` from the FHIR Standard
Communication.statusReason | example | CommunicationNotDoneReason `http://hl7.org/fhir/ValueSet/communication-not-done-reason` from the FHIR Standard
Communication.category | extensible | CommunicationCategory `http://hl7.ca/fhir/eReferral/ValueSet/communication-category` from this IG
Communication.priority | required | RequestPriority `http://hl7.org/fhir/ValueSet/request-priority|4.0.1` from the FHIR Standard
Communication.medium | example | ParticipationMode `http://terminology.hl7.org/ValueSet/v3-ParticipationMode`
Communication.subject.type | extensible | ResourceType `http://hl7.org/fhir/ValueSet/resource-types` from the FHIR Standard
Communication.subject.identifier.use | required | IdentifierUse `http://hl7.org/fhir/ValueSet/identifier-use|4.0.1` from the FHIR Standard
Communication.subject.identifier.type | extensible | Identifier Type Codes `http://hl7.org/fhir/ValueSet/identifier-type` from the FHIR Standard
Communication.topic | example | CommunicationTopic `http://hl7.org/fhir/ValueSet/communication-topic` from the FHIR Standard
Communication.sender.type | extensible | ResourceType `http://hl7.org/fhir/ValueSet/resource-types` from the FHIR Standard
Communication.sender.identifier.use | required | IdentifierUse `http://hl7.org/fhir/ValueSet/identifier-use|4.0.1` from the FHIR Standard
Communication.sender.identifier.type | extensible | Identifier Type Codes `http://hl7.org/fhir/ValueSet/identifier-type` from the FHIR Standard
Communication.reasonCode | example | SNOMEDCTClinicalFindings `http://hl7.org/fhir/ValueSet/clinical-findings` from the FHIR Standard

#### Constraints

Id | Grade | Path(s) | Details | Requirements
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().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(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: 0 element(6 nested mandatory elements)
Must-Support: 22 elements
Fixed: 1 element

Structures

This structure refers to these other structures:

- CAeReCServiceRequest (http://hl7.ca/fhir/eReferral/StructureDefinition/CAeReCServiceRequest)
- CAeReCPatient (http://hl7.ca/fhir/eReferral/StructureDefinition/CAeReCPatient)
- CAeReCPractitionerRole (http://hl7.ca/fhir/eReferral/StructureDefinition/CAeReCPractitionerRole)

Differential View

This structure is derived from Communication

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
Communication |  |  | Communication |
basedOn | S | 0..* | Reference(CAeReCServiceRequest) | Request fulfilled by this communication
reference | S | 0..1 | string | Literal reference, Relative, internal or absolute URL
identifier | S | 0..1 | Identifier | Logical reference, when literal reference is not known
system | S | 1..1 | uri | The namespace for the identifier value
value | S | 1..1 | string | The value that is unique
inResponseTo | S | 0..* | Reference(Communication) | Reply to
status | S | 1..1 | code | preparation | in-progress | not-done | on-hold | stopped | completed | entered-in-error | unknown Fixed Value: completed
category | S | 0..* | CodeableConcept | Message category Binding: Communication Category (extensible)
subject | S | 0..1 | Reference(CAeReCPatient) | Focus of message
reference | S | 0..1 | string | Literal reference, Relative, internal or absolute URL
identifier | S | 0..1 | Identifier | Logical reference, when literal reference is not known
system | S | 1..1 | uri | The namespace for the identifier value
value | S | 1..1 | string | The value that is unique
sent | S | 0..1 | dateTime | When sent
received | S | 0..1 | dateTime | When received
sender | S | 0..1 | Reference(CAeReCPractitionerRole) | Message sender
reference | S | 0..1 | string | Literal reference, Relative, internal or absolute URL
identifier | S | 0..1 | Identifier | Logical reference, when literal reference is not known
system | S | 1..1 | uri | The namespace for the identifier value
value | S | 1..1 | string | The value that is unique
payload | S | 0..* | BackboneElement | Message payload
content[x] | S | 1..1 |  | Message part content
contentString |  |  | string |
contentAttachment |  |  | Attachment |
Documentation for this format

#### Terminology Bindings (Differential)

Path | Conformance | ValueSet | URI
Communication.category | extensible | CommunicationCategory `http://hl7.ca/fhir/eReferral/ValueSet/communication-category` from this IG

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
basedOn | S Σ | 0..* | Reference(CAeReCServiceRequest) | Request fulfilled by this communication
reference | S Σ C | 0..1 | string | Literal reference, Relative, internal or absolute URL
identifier | S Σ | 0..1 | Identifier | Logical reference, when literal reference is not known
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
system | S Σ | 1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
value | S Σ | 1..1 | string | The value that is unique Example General: 123456
inResponseTo | S | 0..* | Reference(Communication) | Reply to
status | ?!S Σ | 1..1 | code | preparation | in-progress | not-done | on-hold | stopped | completed | entered-in-error | unknown Binding: EventStatus (required): The status of the communication. Fixed Value: completed
category | S | 0..* | CodeableConcept | Message category Binding: Communication Category (extensible)
subject | S Σ | 0..1 | Reference(CAeReCPatient) | Focus of message
reference | S Σ C | 0..1 | string | Literal reference, Relative, internal or absolute URL
identifier | S Σ | 0..1 | Identifier | Logical reference, when literal reference is not known
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
system | S Σ | 1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
value | S Σ | 1..1 | string | The value that is unique Example General: 123456
sent | S | 0..1 | dateTime | When sent
received | S | 0..1 | dateTime | When received
sender | S | 0..1 | Reference(CAeReCPractitionerRole) | Message sender
reference | S Σ C | 0..1 | string | Literal reference, Relative, internal or absolute URL
identifier | S Σ | 0..1 | Identifier | Logical reference, when literal reference is not known
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
system | S Σ | 1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
value | S Σ | 1..1 | string | The value that is unique Example General: 123456
payload | S | 0..* | BackboneElement | Message payload
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
content[x] | S | 1..1 |  | Message part content
contentString |  |  | string |
contentAttachment |  |  | Attachment |
Documentation for this format

#### Terminology Bindings

Path | Conformance | ValueSet / Code | URI
Communication.basedOn.identifier.use | required | IdentifierUse `http://hl7.org/fhir/ValueSet/identifier-use|4.0.1` from the FHIR Standard
Communication.status | required | Fixed Value: completed `http://hl7.org/fhir/ValueSet/event-status|4.0.1` from the FHIR Standard
Communication.category | extensible | CommunicationCategory `http://hl7.ca/fhir/eReferral/ValueSet/communication-category` from this IG
Communication.subject.identifier.use | required | IdentifierUse `http://hl7.org/fhir/ValueSet/identifier-use|4.0.1` from the FHIR Standard
Communication.sender.identifier.use | required | IdentifierUse `http://hl7.org/fhir/ValueSet/identifier-use|4.0.1` from the FHIR Standard

#### Constraints

Id | Grade | Path(s) | Details | Requirements
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().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(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() |

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.
Additional Bindings | Purpose
AllLanguages | Max Binding
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 | S Σ | 0..* | Reference(CAeReCServiceRequest) | Request fulfilled by this communication
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
reference | S Σ C | 0..1 | string | Literal reference, Relative, internal or absolute URL
type | Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
identifier | S Σ | 0..1 | Identifier | Logical reference, when literal reference is not known
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type | Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
system | S Σ | 1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
value | S Σ | 1..1 | string | The value that is unique Example General: 123456
period | Σ | 0..1 | Period | Time period when id is/was valid for use
assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text)
display | Σ | 0..1 | string | Text alternative for the resource
partOf | Σ | 0..* | Reference(Resource) | Part of this action
inResponseTo | S | 0..* | Reference(Communication) | Reply to
status | ?!S Σ | 1..1 | code | preparation | in-progress | not-done | on-hold | stopped | completed | entered-in-error | unknown Binding: EventStatus (required): The status of the communication. Fixed Value: completed
statusReason | Σ | 0..1 | CodeableConcept | Reason for current status Binding: CommunicationNotDoneReason (example): Codes for the reason why a communication did not happen.
category | S | 0..* | CodeableConcept | Message category Binding: Communication Category (extensible)
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 Σ | 0..1 | Reference(CAeReCPatient) | Focus of message
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
reference | S Σ C | 0..1 | string | Literal reference, Relative, internal or absolute URL
type | Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
identifier | S Σ | 0..1 | Identifier | Logical reference, when literal reference is not known
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type | Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
system | S Σ | 1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
value | S Σ | 1..1 | string | The value that is unique Example General: 123456
period | Σ | 0..1 | Period | Time period when id is/was valid for use
assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text)
display | Σ | 0..1 | string | Text alternative for the resource
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 | S | 0..1 | dateTime | When sent
received | S | 0..1 | dateTime | When received
recipient |  | 0..* | Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson | Group | CareTeam | HealthcareService) | Message recipient
sender | S | 0..1 | Reference(CAeReCPractitionerRole) | Message sender
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
reference | S Σ C | 0..1 | string | Literal reference, Relative, internal or absolute URL
type | Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
identifier | S Σ | 0..1 | Identifier | Logical reference, when literal reference is not known
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type | Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
system | S Σ | 1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
value | S Σ | 1..1 | string | The value that is unique Example General: 123456
period | Σ | 0..1 | Period | Time period when id is/was valid for use
assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text)
display | Σ | 0..1 | string | Text alternative for the resource
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 | S | 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] | S | 1..1 |  | Message part content
contentString |  |  | string |
contentAttachment |  |  | Attachment |
note |  | 0..* | Annotation | Comments made about the communication
Documentation for this format

#### Terminology Bindings

Path | Conformance | ValueSet / Code | URI
Communication.language | preferred | CommonLanguages
Additional Bindings | Purpose
AllLanguages | Max Binding
`http://hl7.org/fhir/ValueSet/languages` from the FHIR Standard
Communication.basedOn.type | extensible | ResourceType `http://hl7.org/fhir/ValueSet/resource-types` from the FHIR Standard
Communication.basedOn.identifier.use | required | IdentifierUse `http://hl7.org/fhir/ValueSet/identifier-use|4.0.1` from the FHIR Standard
Communication.basedOn.identifier.type | extensible | Identifier Type Codes `http://hl7.org/fhir/ValueSet/identifier-type` from the FHIR Standard
Communication.status | required | Fixed Value: completed `http://hl7.org/fhir/ValueSet/event-status|4.0.1` from the FHIR Standard
Communication.statusReason | example | CommunicationNotDoneReason `http://hl7.org/fhir/ValueSet/communication-not-done-reason` from the FHIR Standard
Communication.category | extensible | CommunicationCategory `http://hl7.ca/fhir/eReferral/ValueSet/communication-category` from this IG
Communication.priority | required | RequestPriority `http://hl7.org/fhir/ValueSet/request-priority|4.0.1` from the FHIR Standard
Communication.medium | example | ParticipationMode `http://terminology.hl7.org/ValueSet/v3-ParticipationMode`
Communication.subject.type | extensible | ResourceType `http://hl7.org/fhir/ValueSet/resource-types` from the FHIR Standard
Communication.subject.identifier.use | required | IdentifierUse `http://hl7.org/fhir/ValueSet/identifier-use|4.0.1` from the FHIR Standard
Communication.subject.identifier.type | extensible | Identifier Type Codes `http://hl7.org/fhir/ValueSet/identifier-type` from the FHIR Standard
Communication.topic | example | CommunicationTopic `http://hl7.org/fhir/ValueSet/communication-topic` from the FHIR Standard
Communication.sender.type | extensible | ResourceType `http://hl7.org/fhir/ValueSet/resource-types` from the FHIR Standard
Communication.sender.identifier.use | required | IdentifierUse `http://hl7.org/fhir/ValueSet/identifier-use|4.0.1` from the FHIR Standard
Communication.sender.identifier.type | extensible | Identifier Type Codes `http://hl7.org/fhir/ValueSet/identifier-type` from the FHIR Standard
Communication.reasonCode | example | SNOMEDCTClinicalFindings `http://hl7.org/fhir/ValueSet/clinical-findings` from the FHIR Standard

#### Constraints

Id | Grade | Path(s) | Details | Requirements
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().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(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: 0 element(6 nested mandatory elements)
Must-Support: 22 elements
Fixed: 1 element

Structures

This structure refers to these other structures:

- CAeReCServiceRequest (http://hl7.ca/fhir/eReferral/StructureDefinition/CAeReCServiceRequest)
- CAeReCPatient (http://hl7.ca/fhir/eReferral/StructureDefinition/CAeReCPatient)
- CAeReCPractitionerRole (http://hl7.ca/fhir/eReferral/StructureDefinition/CAeReCPractitionerRole)

Other representations of profile: CSV, Excel, Schematron