STU 3 Candidate

This page is part of the FHIR Specification (v1.4.0: STU 3 Ballot 3). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions

F.6.1.4 StructureDefinition: QICore-CommunicationRequest - Detailed Descriptions

Definitions for the qicore-communicationrequest Profile.

CommunicationRequest(QICore-CommunicationRequest)
Definition

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.

Control0..*
TypeCommunicationRequest
CommunicationRequest.id
Definition

The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

Control0..1
Typeid
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. Bundles always have an id, though it is usually a generated UUID.

CommunicationRequest.meta
Definition

The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content may not always be associated with version changes to the resource.

Control0..1
TypeMeta
CommunicationRequest.implicitRules
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.

Control0..1
Typeuri
Is Modifiertrue
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 as much as possible.

CommunicationRequest.language
Definition

The base language in which the resource is written.

Control0..1
BindingA human language.
The codes SHALL be taken from http://tools.ietf.org/html/bcp47
Typecode
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).

CommunicationRequest.text
Definition

A human-readable narrative that contains a summary of the resource, and may 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.

Control0..1 This element is affected by the following invariants: dom-1
TypeNarrative
Alternate Namesnarrative, html, xhtml, display
Comments

Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative.

CommunicationRequest.contained
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.

Control0..*
TypeResource
Alternate Namesinline resources, anonymous resources, contained resources
Comments

This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again.

CommunicationRequest.extension (http://hl7.org/fhir/StructureDefinition/communicationrequest-reasonRejected)
Definition

The reason associated with the rejection of this communication request by the receiver. Applicable only if the status is rejected.

Control0..1
TypeExtension (Extension Type: CodeableConcept)
CommunicationRequest.modifierExtension
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. Usually modifier elements provide negation or qualification. In order 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.

Control0..*
TypeExtension
Is Modifiertrue
Alternate Namesextensions, user content
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.

CommunicationRequest.identifier
Definition

A unique ID of this request for reference purposes. It must be provided if user wants it returned as part of any output, otherwise it will be autogenerated, if needed, by CDS system. Does not need to be the actual ID of the source system.

Control0..*
TypeIdentifier
CommunicationRequest.category
Definition

The type of message to be sent such as alert, notification, reminder, instruction, etc.

Control0..1
BindingCodes for general categories of communications such as alerts, instruction, etc.
TypeCodeableConcept
Must Supporttrue
CommunicationRequest.sender
Definition

The entity (e.g. person, organization, clinical information system, or device) which is to be the source of the communication.

Control0..1
TypeChoice of: Reference(QICore-Practitioner), Reference(QICore-Patient), Reference(QICore-Device), Reference(QICore-RelatedPerson), Reference(QICore-Organization)
Must Supporttrue
CommunicationRequest.recipient
Definition

The entity (e.g. person, organization, clinical information system, or device) which is the intended target of the communication.

Control0..*
TypeChoice of: Reference(QICore-Practitioner), Reference(QICore-Patient), Reference(QICore-Device), Reference(QICore-RelatedPerson), Reference(QICore-Organization)
Must Supporttrue
CommunicationRequest.payload
Definition

Text, attachment(s), or resource(s) to be communicated to the recipient.

Control0..*
TypeBackboneElement
CommunicationRequest.payload.id
Definition

unique id for the element within a resource (for internal references).

Control0..1
Typeid
CommunicationRequest.payload.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. In order 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.

Control0..*
TypeExtension
Alternate Namesextensions, user content
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.

CommunicationRequest.payload.modifierExtension
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 that contains it. Usually modifier elements provide negation or qualification. In order 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.

Control0..*
TypeExtension
Is Modifiertrue
Alternate Namesextensions, user content, modifiers
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.

CommunicationRequest.payload.content[x]
Definition

The communicated content (or for multi-part communications, one portion of the communication).

Control1..1
TypeChoice of: string, Attachment, Reference(Resource)
[x] NoteSee Choice of Data Types for further information about how to use [x]
CommunicationRequest.medium
Definition

A channel that was used for this communication (e.g. email, fax).

Control0..*
BindingThe type of channel used for the communication, for example, telephone, fax, email.
For example codes, see QICore Communication Medium Codes
TypeCodeableConcept
CommunicationRequest.requester
Definition

The responsible person who authorizes this order, e.g. physician. This may be different than the author of the order statement, e.g. clerk, who may have entered the statement into the order entry application.

Control0..1
TypeChoice of: Reference(QICore-Patient), Reference(QICore-Practitioner), Reference(QICore-RelatedPerson)
CommunicationRequest.status
Definition

The status of the proposal or order.

Control0..1
BindingThe status of the communication.
The codes SHALL be taken from CommunicationRequestStatus
Typecode
Is Modifiertrue
Must Supporttrue
CommunicationRequest.encounter
Definition

The encounter within which the communication request was created.

Control0..1
TypeReference(QICore-Encounter)
Must Supporttrue
CommunicationRequest.scheduled[x]
Definition

The time when this communication is to occur.

Control0..1
TypeChoice of: dateTime, Period
[x] NoteSee Choice of Data Types for further information about how to use [x]
CommunicationRequest.reason
Definition

The reason or justification for the communication request.

Control0..*
BindingCodes for describing reasons for the occurrence of a communication.
TypeCodeableConcept
CommunicationRequest.requestedOn
Definition

The time when the request was made.

Control0..1
TypedateTime
Must Supporttrue
CommunicationRequest.subject
Definition

The patient who is the focus of this communication request.

Control0..1
TypeReference(Patient)
Must Supporttrue
CommunicationRequest.priority
Definition

Characterizes how quickly the proposed act must be initiated. Includes concepts such as stat, urgent, routine.

Control0..1
BindingCodes indicating the relative importance of a communication request.
For example codes, see DiagnosticOrderPriority
TypeCodeableConcept