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-request | Version: 8.0.0 | |||
| Active as of 2022-11-10 | Computable Name: CDMCommunicationRequest | |||
LinuxForHealth Common Data Model definition of what fields we currently define for a communication request
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from CommunicationRequest
| Path | Conformance | ValueSet |
| CommunicationRequest.status | required | RequestStatus |
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
  CommunicationRequest | 0..* | CommunicationRequest | A request for information to be sent 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 | ||||
 basedOn | Σ | 0..* | Reference(Resource) | Fulfills plan or proposal | ||||
| replaces | Σ | 0..* | Reference(CommunicationRequest) | Request(s) replaced by this request | ||||
| groupIdentifier | Σ | 0..1 | Identifier | Composite request this is part of | ||||
| status | ?!Σ | 1..1 | code | draft | active | on-hold | revoked | completed | entered-in-error | unknown Binding: RequestStatus (required): The status of the communication request. | ||||
| statusReason | 0..1 | CodeableConcept | Reason for current status Binding: (unbound) (example): Codes identifying the reason for the current state of a request. | |||||
| category | 0..* | CodeableConcept | Message category Binding: CommunicationCategory (example): Codes for general categories of communications such as alerts, instruction, etc. | |||||
| priority | Σ | 0..1 | code | routine | urgent | asap | stat Binding: RequestPriority (required): Codes indicating the relative importance of a communication request. | ||||
| doNotPerform | ?!Σ | 0..1 | boolean | True if request is prohibiting action | ||||
| 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 | |||||
| about | 0..* | Reference(Resource) | Resources that pertain to this communication request | |||||
| encounter | Σ | 0..1 | Reference(Encounter) | Encounter created as part of | ||||
 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) | |||||||
| occurrence[x] | Σ | 0..1 | When scheduled | |||||
| occurrenceDateTime | dateTime | |||||||
| occurrencePeriod | Period | |||||||
| authoredOn | Σ | 0..1 | dateTime | When request transitioned to being actionable | ||||
| requester | Σ | 0..1 | Reference(Practitioner | PractitionerRole | Organization | Patient | RelatedPerson | Device) | Who/what is requesting service | ||||
| 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 | Why is communication needed? Binding: v3 Code System ActReason (example): Codes for describing reasons for the occurrence of a communication. | ||||
| reasonReference | Σ | 0..* | Reference(Condition | Observation | DiagnosticReport | DocumentReference) | Why is communication needed? | ||||
| note | 0..* | Annotation | Comments made about communication request | |||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet | ||||
| CommunicationRequest.language | preferred | CommonLanguages
| ||||
| CommunicationRequest.status | required | RequestStatus | ||||
| CommunicationRequest.statusReason | example | |||||
| CommunicationRequest.category | example | CommunicationCategory | ||||
| CommunicationRequest.priority | required | RequestPriority | ||||
| CommunicationRequest.medium | example | ParticipationMode | ||||
| CommunicationRequest.reasonCode | example | ActReason |
This structure is derived from CommunicationRequest
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 CommunicationRequest
Key Elements View
| Path | Conformance | ValueSet |
| CommunicationRequest.status | required | RequestStatus |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| CommunicationRequest | 0..* | CommunicationRequest | A request for information to be sent 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 | ||||
| basedOn | Σ | 0..* | Reference(Resource) | Fulfills plan or proposal | ||||
| replaces | Σ | 0..* | Reference(CommunicationRequest) | Request(s) replaced by this request | ||||
| groupIdentifier | Σ | 0..1 | Identifier | Composite request this is part of | ||||
| status | ?!Σ | 1..1 | code | draft | active | on-hold | revoked | completed | entered-in-error | unknown Binding: RequestStatus (required): The status of the communication request. | ||||
| statusReason | 0..1 | CodeableConcept | Reason for current status Binding: (unbound) (example): Codes identifying the reason for the current state of a request. | |||||
| category | 0..* | CodeableConcept | Message category Binding: CommunicationCategory (example): Codes for general categories of communications such as alerts, instruction, etc. | |||||
| priority | Σ | 0..1 | code | routine | urgent | asap | stat Binding: RequestPriority (required): Codes indicating the relative importance of a communication request. | ||||
| doNotPerform | ?!Σ | 0..1 | boolean | True if request is prohibiting action | ||||
| 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 | |||||
| about | 0..* | Reference(Resource) | Resources that pertain to this communication request | |||||
| encounter | Σ | 0..1 | Reference(Encounter) | Encounter created as part of | ||||
| 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) | |||||||
| occurrence[x] | Σ | 0..1 | When scheduled | |||||
| occurrenceDateTime | dateTime | |||||||
| occurrencePeriod | Period | |||||||
| authoredOn | Σ | 0..1 | dateTime | When request transitioned to being actionable | ||||
| requester | Σ | 0..1 | Reference(Practitioner | PractitionerRole | Organization | Patient | RelatedPerson | Device) | Who/what is requesting service | ||||
| 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 | Why is communication needed? Binding: v3 Code System ActReason (example): Codes for describing reasons for the occurrence of a communication. | ||||
| reasonReference | Σ | 0..* | Reference(Condition | Observation | DiagnosticReport | DocumentReference) | Why is communication needed? | ||||
| note | 0..* | Annotation | Comments made about communication request | |||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet | ||||
| CommunicationRequest.language | preferred | CommonLanguages
| ||||
| CommunicationRequest.status | required | RequestStatus | ||||
| CommunicationRequest.statusReason | example | |||||
| CommunicationRequest.category | example | CommunicationCategory | ||||
| CommunicationRequest.priority | required | RequestPriority | ||||
| CommunicationRequest.medium | example | ParticipationMode | ||||
| CommunicationRequest.reasonCode | example | ActReason |
This structure is derived from CommunicationRequest
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
