LinuxForHealth FHIR Implementation Guide
8.0.0 - draft
LinuxForHealth FHIR Implementation Guide
8.0.0 - draft
LinuxForHealth FHIR Implementation Guide - Local Development build (v8.0.0). See the Directory of published versions
| Official URL: http://linuxforhealth.org/fhir/cdm/StructureDefinition/cdm-communication | Version: 8.0.0 | |||
| Active as of 2022-11-10 | Computable Name: CDMCommunication | |||
LinuxForHealth Common Data Model definition of what fields we currently define for a communication
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from Communication
| Path | Conformance | ValueSet |
| Communication.status | required | EventStatus |
| 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 | ProcessMeta | Metadata about a 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.
| |||||
| text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
 Slices for extension | 1..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
 communicationProduct | 0..1 | CodeableConcept | Product generating the communication URL: http://linuxforhealth.org/fhir/cdm/StructureDefinition/communication-product Binding: Engagement Product Value Set (extensible) | |||||
| communicationOnBehalfOf | 0..1 | Reference(Practitioner | PractitionerRole | Organization | Location) | Attributed provider, location, or organization communication is on-behalf of URL: http://linuxforhealth.org/fhir/cdm/StructureDefinition/communication-on-behalf-of | |||||
| communicationContact | S | 1..1 | Address, CDMCommunicationContactPoint | Phone number, email, or address to contact URL: http://linuxforhealth.org/fhir/cdm/StructureDefinition/communication-contact | ||||
| communicationMeasure | 0..1 | Reference(Measure) | Reference to the measure that resulted in the communication URL: http://linuxforhealth.org/fhir/cdm/StructureDefinition/communication-measure | |||||
| communicationCareGap | 0..1 | string | ID of care gap for which we are communicating URL: http://linuxforhealth.org/fhir/cdm/StructureDefinition/communication-care-gap | |||||
| communicationPrioritySequence | 0..1 | decimal | Priority of the communication request (1 = highest) URL: http://linuxforhealth.org/fhir/cdm/StructureDefinition/communication-priority-sequence | |||||
| communicationLanguage | 0..1 | code | Language used for communication messaging content URL: http://linuxforhealth.org/fhir/cdm/StructureDefinition/communication-language Binding: AllLanguages (preferred) | |||||
| communicationTemplate | 0..1 | string, Attachment | ID or url reference to template to be used for communication URL: http://linuxforhealth.org/fhir/cdm/StructureDefinition/communication-template | |||||
| communicationPayloadData | 0..1 | string | Contains dynamic data elements and vendor / medium specific elements to be included in the message payload URL: http://linuxforhealth.org/fhir/cdm/StructureDefinition/communication-payload-data | |||||
| communicationVendor | 0..1 | Reference(Organization) | Vendor used to send the communication URL: http://linuxforhealth.org/fhir/cdm/StructureDefinition/communication-vendor | |||||
 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 | Σ | 0..* | Reference(Resource) | Request fulfilled by this communication | ||||
| partOf | Σ | 0..* | Reference(Resource) | Part of this action | ||||
| inResponseTo | 0..* | Reference(Communication) | Reply to | |||||
| 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. | ||||
| statusReason | Σ | 0..1 | CodeableConcept | Reason for current status Binding: CommunicationNotDoneReason (example): Codes for the reason why a communication did not happen. | ||||
| category | 0..* | CodeableConcept | Message category Binding: CommunicationCategory (example): Codes for general categories of communications such as alerts, instructions, etc. | |||||
| 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 | Σ | 0..1 | Reference(Patient | Group) | Focus of message | ||||
| 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 | 0..1 | dateTime | When sent | |||||
| received | 0..1 | dateTime | When received | |||||
| recipient | 0..* | Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson | Group | CareTeam | HealthcareService) | Message recipient | |||||
| sender | 0..1 | Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson | HealthcareService) | Message sender | |||||
| 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 | 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] | 1..1 | Message part content | ||||||
 contentString | string | |||||||
| contentAttachment | Attachment | |||||||
 contentReference | Reference(Resource) | |||||||
| note | 0..* | Annotation | Comments made about the communication | |||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet | ||||
| Communication.language | preferred | CommonLanguages
| ||||
| Communication.status | required | EventStatus | ||||
| Communication.statusReason | example | CommunicationNotDoneReason | ||||
| Communication.category | example | CommunicationCategory | ||||
| Communication.priority | required | RequestPriority | ||||
| Communication.medium | example | ParticipationMode | ||||
| Communication.topic | example | CommunicationTopic | ||||
| Communication.reasonCode | example | SNOMEDCTClinicalFindings |
This structure is derived from Communication
Summary
Mandatory: 2 elements
Must-Support: 1 element
Prohibited: 1 element
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Differential View
This structure is derived from Communication
Key Elements View
| Path | Conformance | ValueSet |
| Communication.status | required | EventStatus |
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 | ProcessMeta | Metadata about a 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.
| |||||
| text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
| Slices for extension | 1..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| communicationProduct | 0..1 | CodeableConcept | Product generating the communication URL: http://linuxforhealth.org/fhir/cdm/StructureDefinition/communication-product Binding: Engagement Product Value Set (extensible) | |||||
| communicationOnBehalfOf | 0..1 | Reference(Practitioner | PractitionerRole | Organization | Location) | Attributed provider, location, or organization communication is on-behalf of URL: http://linuxforhealth.org/fhir/cdm/StructureDefinition/communication-on-behalf-of | |||||
| communicationContact | S | 1..1 | Address, CDMCommunicationContactPoint | Phone number, email, or address to contact URL: http://linuxforhealth.org/fhir/cdm/StructureDefinition/communication-contact | ||||
| communicationMeasure | 0..1 | Reference(Measure) | Reference to the measure that resulted in the communication URL: http://linuxforhealth.org/fhir/cdm/StructureDefinition/communication-measure | |||||
| communicationCareGap | 0..1 | string | ID of care gap for which we are communicating URL: http://linuxforhealth.org/fhir/cdm/StructureDefinition/communication-care-gap | |||||
| communicationPrioritySequence | 0..1 | decimal | Priority of the communication request (1 = highest) URL: http://linuxforhealth.org/fhir/cdm/StructureDefinition/communication-priority-sequence | |||||
| communicationLanguage | 0..1 | code | Language used for communication messaging content URL: http://linuxforhealth.org/fhir/cdm/StructureDefinition/communication-language Binding: AllLanguages (preferred) | |||||
| communicationTemplate | 0..1 | string, Attachment | ID or url reference to template to be used for communication URL: http://linuxforhealth.org/fhir/cdm/StructureDefinition/communication-template | |||||
| communicationPayloadData | 0..1 | string | Contains dynamic data elements and vendor / medium specific elements to be included in the message payload URL: http://linuxforhealth.org/fhir/cdm/StructureDefinition/communication-payload-data | |||||
| communicationVendor | 0..1 | Reference(Organization) | Vendor used to send the communication URL: http://linuxforhealth.org/fhir/cdm/StructureDefinition/communication-vendor | |||||
| 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 | Σ | 0..* | Reference(Resource) | Request fulfilled by this communication | ||||
| partOf | Σ | 0..* | Reference(Resource) | Part of this action | ||||
| inResponseTo | 0..* | Reference(Communication) | Reply to | |||||
| 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. | ||||
| statusReason | Σ | 0..1 | CodeableConcept | Reason for current status Binding: CommunicationNotDoneReason (example): Codes for the reason why a communication did not happen. | ||||
| category | 0..* | CodeableConcept | Message category Binding: CommunicationCategory (example): Codes for general categories of communications such as alerts, instructions, etc. | |||||
| 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 | Σ | 0..1 | Reference(Patient | Group) | Focus of message | ||||
| 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 | 0..1 | dateTime | When sent | |||||
| received | 0..1 | dateTime | When received | |||||
| recipient | 0..* | Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson | Group | CareTeam | HealthcareService) | Message recipient | |||||
| sender | 0..1 | Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson | HealthcareService) | Message sender | |||||
| 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 | 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] | 1..1 | Message part content | ||||||
| contentString | string | |||||||
| contentAttachment | Attachment | |||||||
| contentReference | Reference(Resource) | |||||||
| note | 0..* | Annotation | Comments made about the communication | |||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet | ||||
| Communication.language | preferred | CommonLanguages
| ||||
| Communication.status | required | EventStatus | ||||
| Communication.statusReason | example | CommunicationNotDoneReason | ||||
| Communication.category | example | CommunicationCategory | ||||
| Communication.priority | required | RequestPriority | ||||
| Communication.medium | example | ParticipationMode | ||||
| Communication.topic | example | CommunicationTopic | ||||
| Communication.reasonCode | example | SNOMEDCTClinicalFindings |
This structure is derived from Communication
Summary
Mandatory: 2 elements
Must-Support: 1 element
Prohibited: 1 element
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Other representations of profile: CSV, Excel, Schematron
