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.
Subclass of hl7.model.DomainResource (A resource that includes narrative, extensions, and contained resources.)
- Value parameters:
- about
- Other resources that pertain to this communication request and to which this communication request should be associated.
- authoredOn
- For draft requests, indicates the date of initial creation. For requests with other statuses, indicates the date of activation.
- basedOn
- A plan or proposal that is fulfilled in whole or in part by this request.
- category
- The type of message to be sent such as alert, notification, reminder, instruction, etc.
- contained
- 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.
- doNotPerform
- If true indicates that the CommunicationRequest is asking for the specified action to not occur.
- encounter
- The Encounter during which this CommunicationRequest was created or to which the creation of this record is tightly associated.
- 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.
- groupIdentifier
- 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.
- id
- The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
- 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.
- implicitRules
- 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.
- language
- The base language in which the resource is written.
- medium
- A channel that was used for this communication (e.g. email, fax).
- 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.
- modifierExtension
- 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).
- note
- Comments made about the request by the requester, sender, recipient, subject or other participants.
- occurrence
- The time when this communication is to occur.
- payload
- Text, attachment(s), or resource(s) to be communicated to the recipient.
- priority
- Characterizes how quickly the proposed act must be initiated. Includes concepts such as stat, urgent, routine.
- reasonCode
- Describes why the request is being made in coded or textual form.
- reasonReference
- Indicates another resource whose existence justifies this request.
- recipient
- The entity (e.g. person, organization, clinical information system, device, group, or care team) which is the intended target of the communication.
- replaces
- Completed or terminated request(s) whose function is taken by this new request.
- requester
- The device, individual, or organization who initiated the request and has responsibility for its activation.
- sender
- The entity (e.g. person, organization, clinical information system, or device) which is to be the source of the communication.
- status
- The status of the proposal or order.
- statusReason
- Captures the reason for the current state of the CommunicationRequest.
- subject
- The patient or group that is the focus of this communication request.
- text
- 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.
- Constructor:
Introduces the fields note, about, status, medium, sender, basedOn, subject, replaces, category, priority, encounter, requester, recipient, identifier, authoredOn, reasonCode, statusReason, doNotPerform, occurrence, groupIdentifier, reasonReference, payload.
- Companion:
- object
Value members
Inherited methods
Slower than nodalMap, but should work with subtypes (e.g. PositiveInt). If you must use it, then:
Slower than nodalMap, but should work with subtypes (e.g. PositiveInt). If you must use it, then:
T
should not be a Choice[_], a LitSeq[_] or an Option[_]- It may require a type parameter sometimes (e.g.
sampleResource >>[BUNDLE_TYPE] { (_: BUNDLE_TYPE) => BUNDLE_TYPE.SEARCHSET }
)
- Inherited from:
- FHIRObject
- Inherited from:
- FHIRObject
Extract values of type From, and map to LitSeq[To] using fn: From => To. Unlike >>, this is safe even if From is a Choice[], a LitSeq[] or an Option[_] Quite slow, slower than nodalExtract
Extract values of type From, and map to LitSeq[To] using fn: From => To. Unlike >>, this is safe even if From is a Choice[], a LitSeq[] or an Option[_] Quite slow, slower than nodalExtract
- Inherited from:
- FHIRObject
- Inherited from:
- Utils
- Inherited from:
- Utils
- Inherited from:
- FHIRObject
- Inherited from:
- FHIRObject
Convenience alias for nodalGetByClass andThen map to LitSeq[To] using fn: From => To.
Convenience alias for nodalGetByClass andThen map to LitSeq[To] using fn: From => To.
- Inherited from:
- FHIRObject
Extract values of type From Unlike nodalMap, this is safe even if From is a Choice[_], a LitSeq[_] or an Option[_], however there remains a caveat with 'subtyped' types (eg PositiveInt), in that we can't differentiate them from the parent class Quite slow but faster than ^^
Extract values of type From Unlike nodalMap, this is safe even if From is a Choice[_], a LitSeq[_] or an Option[_], however there remains a caveat with 'subtyped' types (eg PositiveInt), in that we can't differentiate them from the parent class Quite slow but faster than ^^
- Inherited from:
- FHIRObject
Bit faster than >>
, but still much slower than using update$foo
when possible. If you must use it, then:
Bit faster than >>
, but still much slower than using update$foo
when possible. If you must use it, then:
T
should not be a Choice[_], a LitSeq[_], an Option[_], or any 'subtyped' type (eg PositiveInt). You should ensure, if T is a supertype of multiple valid choice values (e.g. T =:= Object), that the return value of fn retains the same type as the input value.
- Inherited from:
- FHIRObject
- Inherited from:
- FHIRObject
- Inherited from:
- FHIRObject
- Inherited from:
- FHIRObject
- Inherited from:
- FHIRObject
- Inherited from:
- FHIRObject
- Inherited from:
- FHIRObject