CommunicationRequest

Property	Value
Publisher
Name	CommunicationRequest
URL	http://hl7.org/fhir/StructureDefinition/CommunicationRequest
Status	draft
Description
Abstract	false

Structure

Path	Cardinality	Type	Description
CommunicationRequest	0..*	CommunicationRequest	A request to convey information; e.g. the CDS system proposes that an alert be sent to a responsible provider, the CDS system proposes that the public health agency be notified about a reportable condition.
CommunicationRequest.id	0..1	http://hl7.org/fhirpath/System.String	The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
CommunicationRequest.meta	0..1	Meta	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.
CommunicationRequest.implicitRules	0..1	uri	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.
CommunicationRequest.language	0..1	code	The base language in which the resource is written.
CommunicationRequest.text	0..1	Narrative	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.
CommunicationRequest.contained	0..*	Resource	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.
CommunicationRequest.extension	0..*	Extension	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.
CommunicationRequest.modifierExtension	0..*	Extension	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).
CommunicationRequest.identifier	0..*	Identifier	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.
CommunicationRequest.basedOn	0..*	Reference	A plan or proposal that is fulfilled in whole or in part by this request.
CommunicationRequest.replaces	0..*	Reference	Completed or terminated request(s) whose function is taken by this new request.
CommunicationRequest.groupIdentifier	0..1	Identifier	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.
CommunicationRequest.status	1..1	code	The status of the proposal or order.
CommunicationRequest.statusReason	0..1	CodeableConcept	Captures the reason for the current state of the CommunicationRequest.
CommunicationRequest.category	0..*	CodeableConcept	The type of message to be sent such as alert, notification, reminder, instruction, etc.
CommunicationRequest.priority	0..1	code	Characterizes how quickly the proposed act must be initiated. Includes concepts such as stat, urgent, routine.
CommunicationRequest.doNotPerform	0..1	boolean	If true indicates that the CommunicationRequest is asking for the specified action to not occur.
CommunicationRequest.medium	0..*	CodeableConcept	A channel that was used for this communication (e.g. email, fax).
CommunicationRequest.subject	0..1	Reference	The patient or group that is the focus of this communication request.
CommunicationRequest.about	0..*	Reference	Other resources that pertain to this communication request and to which this communication request should be associated.
CommunicationRequest.encounter	0..1	Reference	The Encounter during which this CommunicationRequest was created or to which the creation of this record is tightly associated.
CommunicationRequest.payload	0..*	BackboneElement	Text, attachment(s), or resource(s) to be communicated to the recipient.
CommunicationRequest.payload.id	0..1	http://hl7.org/fhirpath/System.String	Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
CommunicationRequest.payload.extension	0..*	Extension	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.
CommunicationRequest.payload.modifierExtension	0..*	Extension	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).
CommunicationRequest.payload.content[x]	1..1	string	The communicated content (or for multi-part communications, one portion of the communication).
CommunicationRequest.occurrence[x]	0..1	dateTime	The time when this communication is to occur.
CommunicationRequest.authoredOn	0..1	dateTime	For draft requests, indicates the date of initial creation. For requests with other statuses, indicates the date of activation.
CommunicationRequest.requester	0..1	Reference	The device, individual, or organization who initiated the request and has responsibility for its activation.
CommunicationRequest.recipient	0..*	Reference	The entity (e.g. person, organization, clinical information system, device, group, or care team) which is the intended target of the communication.
CommunicationRequest.sender	0..1	Reference	The entity (e.g. person, organization, clinical information system, or device) which is to be the source of the communication.
CommunicationRequest.reasonCode	0..*	CodeableConcept	Describes why the request is being made in coded or textual form.
CommunicationRequest.reasonReference	0..*	Reference	Indicates another resource whose existence justifies this request.
CommunicationRequest.note	0..*	Annotation	Comments made about the request by the requester, sender, recipient, subject or other participants.

Search Parameters

Name	Type	Description	Expression
_text	string	Search on the narrative of the resource
_content	string	Search on the entire content of the resource
_filter	token	Filter search parameter which supports a more sophisticated grammar for searching. See documentation for further details
_has	string	Provides limited support for reverse chaining - that is, selecting resources based on the properties of resources that refer to them (instead of chaining where resources can be selected based on the properties of resources that they refer to). See the FHIR search page for further documentation
_id	token	Logical id of this artifact	Resource.id
_lastUpdated	date	When the resource version last changed	Resource.meta.lastUpdated
_list	string	All resources in nominated list (by id, Type/id, url or one of the magic List types)
_profile	uri	Profiles this resource claims to conform to	Resource.meta.profile
_query	token	A custom search profile that describes a specific defined query operation
_security	token	Security Labels applied to this resource	Resource.meta.security
_source	uri	Identifies where the resource comes from	Resource.meta.source
_tag	token	Tags applied to this resource	Resource.meta.tag
_text	string	Search on the narrative text (html) of the resource
_type	token	Used when a search is performed in a context which doesn't limit the search to indicate which types are being searched. See the FHIR search page for further discussion
authored	date	When request transitioned to being actionable	CommunicationRequest.authoredOn
based-on	reference	Fulfills plan or proposal	CommunicationRequest.basedOn
category	token	Message category	CommunicationRequest.category
encounter	reference	Encounter created as part of	CommunicationRequest.encounter
group-identifier	token	Composite request this is part of	CommunicationRequest.groupIdentifier
identifier	token	Unique identifier	CommunicationRequest.identifier
medium	token	A channel of communication	CommunicationRequest.medium
occurrence	date	When scheduled	(CommunicationRequest.occurrence.ofType(dateTime))
patient	reference	Focus of message	CommunicationRequest.subject.where(resolve() is Patient)
priority	token	routine / urgent / asap / stat	CommunicationRequest.priority
recipient	reference	Message recipient	CommunicationRequest.recipient
replaces	reference	Request(s) replaced by this request	CommunicationRequest.replaces
requester	reference	Who/what is requesting service	CommunicationRequest.requester
sender	reference	Message sender	CommunicationRequest.sender
status	token	draft / active / on-hold / revoked / completed / entered-in-error / unknown	CommunicationRequest.status
subject	reference	Focus of message	CommunicationRequest.subject