Skip to main content

CommunicationRequest

PropertyValue
Publisher
NameCommunicationRequest
URLhttp://hl7.org/fhir/StructureDefinition/CommunicationRequest
Statusdraft
Description
Abstractfalse

Structure

PathCardinalityTypeDescription
CommunicationRequest0..*CommunicationRequestA 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.id0..1http://hl7.org/fhirpath/System.StringThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
CommunicationRequest.meta0..1MetaThe 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.implicitRules0..1uriA 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.language0..1codeThe base language in which the resource is written.
CommunicationRequest.text0..1NarrativeA 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.contained0..*ResourceThese 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.extension0..*ExtensionMay 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.modifierExtension0..*ExtensionMay 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.identifier0..*IdentifierBusiness 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.basedOn0..*ReferenceA plan or proposal that is fulfilled in whole or in part by this request.
CommunicationRequest.replaces0..*ReferenceCompleted or terminated request(s) whose function is taken by this new request.
CommunicationRequest.groupIdentifier0..1IdentifierA 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.status1..1codeThe status of the proposal or order.
CommunicationRequest.statusReason0..1CodeableConceptCaptures the reason for the current state of the CommunicationRequest.
CommunicationRequest.category0..*CodeableConceptThe type of message to be sent such as alert, notification, reminder, instruction, etc.
CommunicationRequest.priority0..1codeCharacterizes how quickly the proposed act must be initiated. Includes concepts such as stat, urgent, routine.
CommunicationRequest.doNotPerform0..1booleanIf true indicates that the CommunicationRequest is asking for the specified action to not occur.
CommunicationRequest.medium0..*CodeableConceptA channel that was used for this communication (e.g. email, fax).
CommunicationRequest.subject0..1ReferenceThe patient or group that is the focus of this communication request.
CommunicationRequest.about0..*ReferenceOther resources that pertain to this communication request and to which this communication request should be associated.
CommunicationRequest.encounter0..1ReferenceThe Encounter during which this CommunicationRequest was created or to which the creation of this record is tightly associated.
CommunicationRequest.payload0..*BackboneElementText, attachment(s), or resource(s) to be communicated to the recipient.
CommunicationRequest.payload.id0..1http://hl7.org/fhirpath/System.StringUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
CommunicationRequest.payload.extension0..*ExtensionMay 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.modifierExtension0..*ExtensionMay 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..1stringThe communicated content (or for multi-part communications, one portion of the communication).
CommunicationRequest.occurrence[x]0..1dateTimeThe time when this communication is to occur.
CommunicationRequest.authoredOn0..1dateTimeFor draft requests, indicates the date of initial creation. For requests with other statuses, indicates the date of activation.
CommunicationRequest.requester0..1ReferenceThe device, individual, or organization who initiated the request and has responsibility for its activation.
CommunicationRequest.recipient0..*ReferenceThe entity (e.g. person, organization, clinical information system, device, group, or care team) which is the intended target of the communication.
CommunicationRequest.sender0..1ReferenceThe entity (e.g. person, organization, clinical information system, or device) which is to be the source of the communication.
CommunicationRequest.reasonCode0..*CodeableConceptDescribes why the request is being made in coded or textual form.
CommunicationRequest.reasonReference0..*ReferenceIndicates another resource whose existence justifies this request.
CommunicationRequest.note0..*AnnotationComments made about the request by the requester, sender, recipient, subject or other participants.

Search Parameters

NameTypeDescriptionExpression
_textstringSearch on the narrative of the resource
_contentstringSearch on the entire content of the resource
_filtertokenFilter search parameter which supports a more sophisticated grammar for searching. See documentation for further details
_hasstringProvides 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
_idtokenLogical id of this artifactResource.id
_lastUpdateddateWhen the resource version last changedResource.meta.lastUpdated
_liststringAll resources in nominated list (by id, Type/id, url or one of the magic List types)
_profileuriProfiles this resource claims to conform toResource.meta.profile
_querytokenA custom search profile that describes a specific defined query operation
_securitytokenSecurity Labels applied to this resourceResource.meta.security
_sourceuriIdentifies where the resource comes fromResource.meta.source
_tagtokenTags applied to this resourceResource.meta.tag
_textstringSearch on the narrative text (html) of the resource
_typetokenUsed 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
authoreddateWhen request transitioned to being actionableCommunicationRequest.authoredOn
based-onreferenceFulfills plan or proposalCommunicationRequest.basedOn
categorytokenMessage categoryCommunicationRequest.category
encounterreferenceEncounter created as part ofCommunicationRequest.encounter
group-identifiertokenComposite request this is part ofCommunicationRequest.groupIdentifier
identifiertokenUnique identifierCommunicationRequest.identifier
mediumtokenA channel of communicationCommunicationRequest.medium
occurrencedateWhen scheduled(CommunicationRequest.occurrence.ofType(dateTime))
patientreferenceFocus of messageCommunicationRequest.subject.where(resolve() is Patient)
prioritytokenroutine / urgent / asap / statCommunicationRequest.priority
recipientreferenceMessage recipientCommunicationRequest.recipient
replacesreferenceRequest(s) replaced by this requestCommunicationRequest.replaces
requesterreferenceWho/what is requesting serviceCommunicationRequest.requester
senderreferenceMessage senderCommunicationRequest.sender
statustokendraft / active / on-hold / revoked / completed / entered-in-error / unknownCommunicationRequest.status
subjectreferenceFocus of messageCommunicationRequest.subject