Skip to content

Communication Request Profile

Canonicalhttps://fhir.apps.health/StructureDefinition/nexus-core-communicationrequest
Statusdraft · 1.33.0
BaseCommunicationRequest (constraint)
SourceFSH · JSON

The request a client submits to send one message by fax, SMS or email: to which recipients, by which channel and sending account, and what to send. It is the input to the message exchange service's $send-message operation, validated against this profile and not stored. Each send is recorded as an outbound-delivery Communication. One channel, or fax with email. Recipients are contained Organizations holding the name and address to use. First pass.

Elements / Details

Every element this profile touches, with its full definition. Element names in the tables link here.

CommunicationRequest

Short Nexus EMR request to send a fax, SMS or email
Definition The request a client submits to send one message by fax, SMS or email: the recipients and the address to use for each, the channel and sending account, and what to send. It is the input to the message exchange service's $send-message operation, validated against this profile and not stored; nothing refers back to it. Each send is recorded as an outbound-delivery Communication, one per recipient per channel.
Cardinality 0..*
Invariants dom-2, dom-3, dom-4, dom-5, dom-6, nexus-note-extension-not-where-native, nexus-commreq-status, nexus-commreq-channels, nexus-commreq-recipient-contained, nexus-commreq-recipient-named, nexus-commreq-address-matches-medium, nexus-commreq-one-address-per-channel, nexus-commreq-channel-has-addressee, nexus-commreq-email-subject, nexus-commreq-fax-document, nexus-commreq-email-body, nexus-commreq-sms-text

CommunicationRequest.id

Short Logical id of this artifact
Definition The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
Comments The only time that a resource does not have an id is when it is being submitted to the server using a create operation.
Cardinality 0..1
Type http://hl7.org/fhirpath/System.String

CommunicationRequest.meta

Short Metadata about the resource
Definition The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
Cardinality 0..1
Type Meta
Invariants ele-1

CommunicationRequest.implicitRules

Short A set of rules under which this content was created
Definition A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
Comments Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.
Cardinality 0..0
Type uri
Modifier yes — This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation
Invariants ele-1

CommunicationRequest.language

Short Language of the resource content
Definition The base language in which the resource is written.
Comments Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).
Cardinality 0..1
Type code
Binding languages (preferred)
Invariants ele-1

CommunicationRequest.text

Short Text summary of the resource, for human interpretation
Definition A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
Comments Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.
Cardinality 0..1
Type Narrative
Invariants ele-1
Also called narrative, html, xhtml, display

CommunicationRequest.contained

Short The recipients: one Organization each, with a name and the address to use
Definition These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
Comments Each holds name and telecom: at most one address per channel, each for a channel on the request, and every channel has at least one (invariants nexus-commreq-recipient-named, nexus-commreq-one-address-per-channel, nexus-commreq-address-matches-medium, nexus-commreq-channel-has-addressee). SMS addresses use telecom.system sms. A bare number carries the number as its name. The address is copied in, not read off a stored record; each delivery Communication records the address it used in its delivery-address extension.
Cardinality 1..*
Type Organization
Must Support yes
Also called inline resources, anonymous resources, contained resources

CommunicationRequest.extension

Short Additional content defined by implementations
Definition May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Comments There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Cardinality 0..*
Type Extension
Invariants ele-1, ext-1
Also called extensions, user content

CommunicationRequest.extension:emailSubject

Short The subject line of the email
Definition May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Comments Required when medium includes email, absent otherwise (invariant nexus-commreq-email-subject). The email's Communication carries the same text as topic.text.
Cardinality 0..1
Type Extension(Communication Email Subject Extension)
Must Support yes
Invariants ele-1, ext-1
Also called extensions, user content

CommunicationRequest.modifierExtension

Short Extensions that cannot be ignored
Definition May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Requirements Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.
Comments There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Cardinality 0..0
Type Extension
Modifier yes — Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them
Invariants ele-1, ext-1
Also called extensions, user content

CommunicationRequest.identifier

Short Unique identifier
Definition Business identifiers assigned to this communication request by the performer or other systems which remain constant as the resource is updated and propagates from server to server.
Requirements Allows identification of the communication request as it is known by various participating systems and in a way that remains consistent across servers.
Comments This is a business identifier, not a resource identifier (see discussion). It is best practice for the identifier to only appear on a single resource instance, however business practices may occasionally dictate that multiple resource instances with the same identifier can exist - possibly even with different resource types. For example, multiple Patient and a Person resource instance might share the same social insurance number.
Cardinality 0..*
Type Identifier
Invariants ele-1

CommunicationRequest.basedOn

Short Fulfills plan or proposal
Definition A plan or proposal that is fulfilled in whole or in part by this request.
Requirements Allows tracing of authorization for the request and tracking whether proposals/recommendations were acted upon.
Cardinality 0..0
Type Reference(Resource)
Invariants ele-1
Also called fulfills

CommunicationRequest.replaces

Short Request(s) replaced by this request
Definition Completed or terminated request(s) whose function is taken by this new request.
Requirements Allows tracing the continuation of a therapy or administrative process instantiated through multiple requests.
Comments The replacement could be because the initial request was immediately rejected (due to an issue) or because the previous request was completed, but the need for the action described by the request remains ongoing.
Cardinality 0..0
Type Reference(CommunicationRequest)
Invariants ele-1
Also called supersedes, prior

CommunicationRequest.groupIdentifier

Short Composite request this is part of
Definition A shared identifier common to all requests that were authorized more or less simultaneously by a single author, representing the identifier of the requisition, prescription or similar form.
Comments Requests are linked either by a "basedOn" relationship (i.e. one request is fulfilling another) or by having a common requisition. Requests that are part of the same requisition are generally treated independently from the perspective of changing their state or maintaining them after initial creation.
Cardinality 0..0
Type Identifier
Invariants ele-1
Also called grouperId

CommunicationRequest.status

Short active
Definition The status of the proposal or order.
Comments Always active: a request is posted to be sent (invariant nexus-commreq-status). It is not stored, so it has no lifecycle of its own; the outcome of each send, delivered or failed, is on its Communication.
Cardinality 1..1
Type code
Must Support yes
Modifier yes — This element is labelled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid.
Binding request-status (required)
Invariants ele-1

CommunicationRequest.statusReason

Short Reason for current status
Definition Captures the reason for the current state of the CommunicationRequest.
Comments This is generally only used for "exception" statuses such as "suspended" or "cancelled". The reason why the CommunicationRequest was created at all is captured in reasonCode, not here. [distinct reason codes for different statuses can be enforced using invariants if they are universal bindings].
Cardinality 0..0
Type CodeableConcept
Invariants ele-1
Also called Suspended Reason, Cancelled Reason

CommunicationRequest.category

Short Message category
Definition The type of message to be sent such as alert, notification, reminder, instruction, etc.
Comments There may be multiple axes of categorization and one communication request may serve multiple purposes.
Cardinality 0..0
Type CodeableConcept
Binding communication-category (example)
Invariants ele-1

CommunicationRequest.priority

Short routine | urgent | asap | stat
Definition Characterizes how quickly the proposed act must be initiated. Includes concepts such as stat, urgent, routine.
Cardinality 0..0
Type code
Binding request-priority (required)
Invariants ele-1

CommunicationRequest.doNotPerform

Short True if request is prohibiting action
Definition If true indicates that the CommunicationRequest is asking for the specified action to not occur.
Comments The attributes provided with the request qualify what is not to be done.
Cardinality 0..0
Type boolean
Modifier yes — If true this element negates the specified action. For Example, instead of a request for a communication, it is a request for the communication to not occur.
Invariants ele-1
Also called prohibited

CommunicationRequest.medium

Short One entry per channel: the kind (FAXWRIT | EMAILWRIT | SMSWRIT) and the account that sends it
Definition A channel that was used for this communication (e.g. email, fax).
Comments One channel, or fax with email (invariant nexus-commreq-channels). Each entry carries exactly two codings, told apart by their fixed system: the HL7 ParticipationMode kind, and the clinic sending account under nexus-message-integration. Each Communication written for a send carries its own channel's entry.
Cardinality 1..2
Type CodeableConcept
Must Support yes
Binding v3-ParticipationMode (example)
Invariants ele-1

CommunicationRequest.medium.id

Short Unique id for inter-element referencing
Definition Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality 0..1
Type http://hl7.org/fhirpath/System.String

CommunicationRequest.medium.extension

Short Additional content defined by implementations
Definition May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Comments There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Cardinality 0..*
Type Extension
Invariants ele-1, ext-1
Also called extensions, user content

CommunicationRequest.medium.coding

Short Code defined by a terminology system
Definition A reference to a code defined by a terminology system.
Requirements Allows for alternative encodings within a code system, and translations to other code systems.
Comments Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.
Cardinality 2..*
Type Coding
Invariants ele-1

CommunicationRequest.medium.coding:kind

Short FAXWRIT | EMAILWRIT | SMSWRIT
Definition A reference to a code defined by a terminology system.
Requirements Allows for alternative encodings within a code system, and translations to other code systems.
Comments Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.
Cardinality 1..1
Type Coding
Must Support yes
Binding Communication Medium Value Set (required)
Invariants ele-1

CommunicationRequest.medium.coding:kind.id

Short Unique id for inter-element referencing
Definition Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality 0..1
Type http://hl7.org/fhirpath/System.String

CommunicationRequest.medium.coding:kind.extension

Short Additional content defined by implementations
Definition May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Comments There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Cardinality 0..*
Type Extension
Invariants ele-1, ext-1
Also called extensions, user content

CommunicationRequest.medium.coding:kind.system

Short Identity of the terminology system
Definition The identification of the code system that defines the meaning of the symbol in the code.
Requirements Need to be unambiguous about the source of the definition of the symbol.
Comments The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.
Cardinality 1..1
Type uri
Pattern http://terminology.hl7.org/CodeSystem/v3-ParticipationMode
Invariants ele-1

CommunicationRequest.medium.coding:kind.version

Short Version of the system - if relevant
Definition The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.
Comments Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.
Cardinality 0..1
Type string
Invariants ele-1

CommunicationRequest.medium.coding:kind.code

Short Symbol in syntax defined by the system
Definition A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).
Requirements Need to refer to a particular code in the system.
Cardinality 1..1
Type code
Invariants ele-1

CommunicationRequest.medium.coding:kind.display

Short Representation defined by the system
Definition A representation of the meaning of the code in the system, following the rules of the system.
Requirements Need to be able to carry a human-readable meaning of the code for readers that do not know the system.
Cardinality 0..1
Type string
Invariants ele-1

CommunicationRequest.medium.coding:kind.userSelected

Short If this coding was chosen directly by the user
Definition Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).
Requirements This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.
Comments Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.
Cardinality 0..1
Type boolean
Invariants ele-1

CommunicationRequest.medium.coding:integration

Short The clinic sending account that carries this channel
Definition A reference to a code defined by a terminology system.
Requirements Allows for alternative encodings within a code system, and translations to other code systems.
Comments The code is the account's id in the clinic service; display is the account's name when the request was made.
Cardinality 1..1
Type Coding
Must Support yes
Invariants ele-1

CommunicationRequest.medium.coding:integration.id

Short Unique id for inter-element referencing
Definition Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality 0..1
Type http://hl7.org/fhirpath/System.String

CommunicationRequest.medium.coding:integration.extension

Short Additional content defined by implementations
Definition May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Comments There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Cardinality 0..*
Type Extension
Invariants ele-1, ext-1
Also called extensions, user content

CommunicationRequest.medium.coding:integration.system

Short Identity of the terminology system
Definition The identification of the code system that defines the meaning of the symbol in the code.
Requirements Need to be unambiguous about the source of the definition of the symbol.
Comments The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.
Cardinality 1..1
Type uri
Pattern https://fhir.apps.health/CodeSystem/nexus-message-integration
Invariants ele-1

CommunicationRequest.medium.coding:integration.version

Short Version of the system - if relevant
Definition The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.
Comments Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.
Cardinality 0..1
Type string
Invariants ele-1

CommunicationRequest.medium.coding:integration.code

Short Symbol in syntax defined by the system
Definition A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).
Requirements Need to refer to a particular code in the system.
Cardinality 1..1
Type code
Invariants ele-1

CommunicationRequest.medium.coding:integration.display

Short Representation defined by the system
Definition A representation of the meaning of the code in the system, following the rules of the system.
Requirements Need to be able to carry a human-readable meaning of the code for readers that do not know the system.
Cardinality 0..1
Type string
Invariants ele-1

CommunicationRequest.medium.coding:integration.userSelected

Short If this coding was chosen directly by the user
Definition Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).
Requirements This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.
Comments Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.
Cardinality 0..1
Type boolean
Invariants ele-1

CommunicationRequest.medium.text

Short Plain text representation of the concept
Definition A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.
Requirements The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.
Comments Very often the text is the same as a displayName of one of the codings.
Cardinality 0..1
Type string
Invariants ele-1

CommunicationRequest.subject

Short The patient the message is about
Definition The patient or group that is the focus of this communication request.
Comments Absent for a message about no patient.
Cardinality 0..1
Type Reference(Patient Profile)
Must Support yes
Invariants ele-1
Also called patient

CommunicationRequest.about

Short Resources that pertain to this communication request
Definition Other resources that pertain to this communication request and to which this communication request should be associated.
Comments Don't use CommunicationRequest.about element when a more specific element exists, such as basedOn, reasonReference, or replaces.
Cardinality 0..0
Type Reference(Resource)
Invariants ele-1

CommunicationRequest.encounter

Short Encounter created as part of
Definition The Encounter during which this CommunicationRequest was created or to which the creation of this record is tightly associated.
Comments This will typically be the encounter the event occurred within, but some activities may be initiated prior to or after the official completion of an encounter but still be tied to the context of the encounter.
Cardinality 0..0
Type Reference(Encounter)
Invariants ele-1

CommunicationRequest.payload

Short What to send
Definition Text, attachment(s), or resource(s) to be communicated to the recipient.
Comments - fax: exactly one contentReference, version-specific (DocumentReference/<id>/_history/<vid>), so the delivery record says which version was faxed (invariant nexus-commreq-fax-document). - SMS: exactly one contentString, the text (invariant nexus-commreq-sms-text). - email: at most one contentString, the body (invariant nexus-commreq-email-body), plus one contentReference per attached document. The subject is the emailSubject extension. - fax with email: exactly one contentReference, the document, which is faxed and is the email's only attachment; no other document can be attached to the email, because nexus-commreq-fax-document counts every contentReference on the request. The string is the email body and is never faxed.
Cardinality 1..*
Type BackboneElement
Must Support yes
Invariants ele-1

CommunicationRequest.payload.id

Short Unique id for inter-element referencing
Definition Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality 0..1
Type http://hl7.org/fhirpath/System.String

CommunicationRequest.payload.extension

Short Additional content defined by implementations
Definition May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Comments There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Cardinality 0..*
Type Extension
Invariants ele-1, ext-1
Also called extensions, user content

CommunicationRequest.payload.modifierExtension

Short Extensions that cannot be ignored even if unrecognized
Definition May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Requirements Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.
Comments There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Cardinality 0..*
Type Extension
Modifier yes — Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Invariants ele-1, ext-1
Also called extensions, user content, modifiers

CommunicationRequest.payload.content[x]

Short Message part content
Definition The communicated content (or for multi-part communications, one portion of the communication).
Cardinality 1..1
Type string, Reference(DocumentReference)
Invariants ele-1

CommunicationRequest.occurrence[x]

Short When scheduled
Definition The time when this communication is to occur.
Cardinality 0..0
Type dateTime, Period
Invariants ele-1
Also called timing

CommunicationRequest.authoredOn

Short When the request was made
Definition For draft requests, indicates the date of initial creation. For requests with other statuses, indicates the date of activation.
Comments Allowed but not must-support: the send operation does not read it.
Cardinality 0..1
Type dateTime
Invariants ele-1
Also called createdOn

CommunicationRequest.requester

Short Who asked for the message to be sent
Definition The device, individual, or organization who initiated the request and has responsibility for its activation.
Comments A Practitioner or PractitionerRole for a person, a Device for a system. Allowed but not must-support: the send operation does not read it. Who sent the message is the authenticated caller.
Cardinality 0..1
Type Reference(Practitioner Profile | PractitionerRole Profile | Device)
Invariants ele-1
Also called author

CommunicationRequest.recipient

Short A local reference to a contained recipient
Definition The entity (e.g. person, organization, clinical information system, device, group, or care team) which is the intended target of the communication.
Comments Always a local reference (#id) into contained (invariant nexus-commreq-recipient-contained); never a stored Practitioner, Organization or Patient.
Cardinality 1..*
Type Reference(Organization)
Must Support yes
Invariants ele-1

CommunicationRequest.recipient.id

Short Unique id for inter-element referencing
Definition Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality 0..1
Type http://hl7.org/fhirpath/System.String

CommunicationRequest.recipient.extension

Short Additional content defined by implementations
Definition May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Comments There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Cardinality 0..*
Type Extension
Invariants ele-1, ext-1
Also called extensions, user content

CommunicationRequest.recipient.reference

Short Literal reference, Relative, internal or absolute URL
Definition A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.
Comments Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server.
Cardinality 0..1
Type string
Invariants ele-1

CommunicationRequest.recipient.type

Short Type the reference refers to (e.g. "Patient")
Definition The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent. The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).
Comments This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified.
Cardinality 0..1
Type uri
Binding resource-types (extensible)
Invariants ele-1

CommunicationRequest.recipient.identifier

Short Logical reference, when literal reference is not known
Definition An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.
Comments When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it. Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any).
Cardinality 0..1
Type Identifier
Invariants ele-1

CommunicationRequest.recipient.display

Short Text alternative for the resource
Definition Plain text narrative that identifies the resource in addition to the resource reference.
Comments This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.
Cardinality 1..1
Type string
Must Support yes
Invariants ele-1

CommunicationRequest.sender

Short Message sender
Definition The entity (e.g. person, organization, clinical information system, or device) which is to be the source of the communication.
Cardinality 0..0
Type Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson | HealthcareService)
Invariants ele-1

CommunicationRequest.reasonCode

Short Why is communication needed?
Definition Describes why the request is being made in coded or textual form.
Comments Textual reasons can be captured using reasonCode.text.
Cardinality 0..0
Type CodeableConcept
Binding v3-ActReason (example)
Invariants ele-1

CommunicationRequest.reasonReference

Short Why is communication needed?
Definition Indicates another resource whose existence justifies this request.
Cardinality 0..0
Type Reference(Condition | Observation | DiagnosticReport | DocumentReference)
Invariants ele-1

CommunicationRequest.note

Short Comments made about communication request
Definition Comments made about the request by the requester, sender, recipient, subject or other participants.
Cardinality 0..0
Type Annotation
Invariants ele-1