Data Model Libraries
    Preparing search index...

    Class CommunicationRequest

    CommunicationRequest Class

    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.

    FHIR Specification

    • Short: A request for information to be sent to a receiver
    • 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.
    • FHIR Version: 5.0.0

    FHIR CommunicationRequest

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    constructor

    Properties

    identifier? basedOn? replaces? groupIdentifier? requestStatusEnum status statusReason? requestIntentEnum intent category? requestPriorityEnum priority? doNotPerform? medium? subject? about? encounter? payload? occurrence? authoredOn? requester? recipient? informationProvider? reason? note?

    Methods

    parse getIdentifier setIdentifier addIdentifier hasIdentifier getBasedOn setBasedOn addBasedOn hasBasedOn getReplaces setReplaces addReplaces hasReplaces getGroupIdentifier setGroupIdentifier hasGroupIdentifier getStatusEnumType setStatusEnumType hasStatusEnumType getStatusElement setStatusElement hasStatusElement getStatus setStatus hasStatus getStatusReason setStatusReason hasStatusReason getIntentEnumType setIntentEnumType hasIntentEnumType getIntentElement setIntentElement hasIntentElement getIntent setIntent hasIntent getCategory setCategory addCategory hasCategory getPriorityEnumType setPriorityEnumType hasPriorityEnumType getPriorityElement setPriorityElement hasPriorityElement getPriority setPriority hasPriority getDoNotPerformElement setDoNotPerformElement hasDoNotPerformElement getDoNotPerform setDoNotPerform hasDoNotPerform getMedium setMedium addMedium hasMedium getSubject setSubject hasSubject getAbout setAbout addAbout hasAbout getEncounter setEncounter hasEncounter getPayload setPayload addPayload hasPayload getOccurrence setOccurrence hasOccurrence getOccurrenceDateTimeType hasOccurrenceDateTimeType getOccurrencePeriod hasOccurrencePeriod getAuthoredOnElement setAuthoredOnElement hasAuthoredOnElement getAuthoredOn setAuthoredOn hasAuthoredOn getRequester setRequester hasRequester getRecipient setRecipient addRecipient hasRecipient getInformationProvider setInformationProvider addInformationProvider hasInformationProvider getReason setReason addReason hasReason getNote setNote addNote hasNote fhirType isEmpty isRequiredFieldsEmpty copy toJSON getText setText hasText getContained setContained addContained hasContained getExtension setExtension hasExtension getExtensionByUrl addExtension removeExtension getModifierExtension setModifierExtension hasModifierExtension getModifierExtensionByUrl addModifierExtension removeModifierExtension resourceType getIdElement setIdElement hasIdElement getId setId hasId getMeta setMeta hasMeta getImplicitRulesElement setImplicitRulesElement hasImplicitRulesElement getImplicitRules setImplicitRules hasImplicitRules getLanguageElement setLanguageElement hasLanguageElement getLanguage setLanguage hasLanguage isResource isDataType isComplexDataType isPrimitive isBooleanPrimitive isStringPrimitive isNumberPrimitive isBigIntPrimitive isDateTimePrimitive copyValues initIdentifier initBasedOn initReplaces initCategory initMedium initAbout initPayload initRecipient initInformationProvider initReason initNote

    Constructors

    Properties

    identifier?: Identifier[]

    CommunicationRequest.identifier Element

    FHIR Specification

    • 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.
    • Comment: 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.
    • Requirements: Allows identification of the communication request as it is known by various participating systems and in a way that remains consistent across servers.
    • FHIR Type: Identifier
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true
    basedOn?: Reference[]

    CommunicationRequest.basedOn Element

    FHIR Specification

    • 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.
    • FHIR Type: Reference
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true
    replaces?: Reference[]

    CommunicationRequest.replaces Element

    FHIR Specification

    • Short: Request(s) replaced by this request
    • Definition: Completed or terminated request(s) whose function is taken by this new request.
    • Comment: 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.
    • Requirements: Allows tracing the continuation of a therapy or administrative process instantiated through multiple requests.
    • FHIR Type: Reference
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true
    groupIdentifier?: Identifier

    CommunicationRequest.groupIdentifier Element

    FHIR Specification

    • Short: Composite request this is part of
    • Definition: A shared identifier common to multiple independent Request instances that were activated/authorized more or less simultaneously by a single author. The presence of the same identifier on each request ties those requests together and may have business ramifications in terms of reporting of results, billing, etc. E.g. a requisition number shared by a set of lab tests ordered together, or a prescription number shared by all meds ordered at one time.
    • Comment: 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.
    • FHIR Type: Identifier
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    requestStatusEnum: RequestStatusEnum

    FHIR CodeSystem: RequestStatus

    RequestStatusEnum

    status: null | EnumCodeType

    CommunicationRequest.status Element

    FHIR Specification

    • Short: draft | active | on-hold | revoked | completed | entered-in-error | unknown
    • Definition: The status of the proposal or order.
    • FHIR Type: code
    • Cardinality: 1..1
    • isModifier: true
    • isModifierReason: 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.
    • isSummary: true

    CodeSystem Enumeration: RequestStatusEnum

    statusReason?: CodeableConcept

    CommunicationRequest.statusReason Element

    FHIR Specification

    • Short: Reason for current status
    • Definition: Captures the reason for the current state of the CommunicationRequest.
    • Comment: This is generally only used for "exception" statuses such as "on-hold" or "revoked". The reason why the CommunicationRequest was created at all is captured in reasonCode, not here.
    • FHIR Type: CodeableConcept
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    requestIntentEnum: RequestIntentEnum

    FHIR CodeSystem: RequestIntent

    RequestIntentEnum

    intent: null | EnumCodeType

    CommunicationRequest.intent Element

    FHIR Specification

    • Short: proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option
    • Definition: Indicates the level of authority/intentionality associated with the CommunicationRequest and where the request fits into the workflow chain.
    • Comment: This element is expected to be immutable. E.g. A "proposal" instance should never change to be a "plan" instance or "order" instance. Instead, a new instance 'basedOn' the prior instance should be created with the new 'intent' value. One exception to this is that the granularity of CommunicationRequest.intent is allowed to change. For example, a Request identified as an "order" might later be clarified to be a "filler-order". Or, in rarer cases (to meet recipient constraints), the reverse might also occur.
    • Requirements: Proposals/recommendations, plans and orders all use the same structure and can exist in the same fulfillment chain.
    • FHIR Type: code
    • Cardinality: 1..1
    • isModifier: true
    • isModifierReason: This element changes the interpretation of all descriptive attributes. For example "the time the request is recommended to occur" vs. "the time the request is authorized to occur" or "who is recommended to perform the request" vs. "who is authorized to perform the request
    • isSummary: true

    CodeSystem Enumeration: RequestIntentEnum

    category?: CodeableConcept[]

    CommunicationRequest.category Element

    FHIR Specification

    • Short: Message category
    • Definition: The type of message to be sent such as alert, notification, reminder, instruction, etc.
    • Comment: There may be multiple axes of categorization and one communication request may serve multiple purposes.
    • FHIR Type: CodeableConcept
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    requestPriorityEnum: RequestPriorityEnum

    FHIR CodeSystem: RequestPriority

    RequestPriorityEnum

    priority?: EnumCodeType

    CommunicationRequest.priority Element

    FHIR Specification

    • Short: routine | urgent | asap | stat
    • Definition: Characterizes how quickly the proposed act must be initiated. Includes concepts such as stat, urgent, routine.
    • FHIR Type: code
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true

    CodeSystem Enumeration: RequestPriorityEnum

    doNotPerform?: BooleanType

    CommunicationRequest.doNotPerform Element

    FHIR Specification

    • Short: True if request is prohibiting action
    • Definition: If true indicates that the CommunicationRequest is asking for the specified action to not occur.
    • Comment: The attributes provided with the request qualify what is not to be done.
    • FHIR Type: boolean
    • Cardinality: 0..1
    • isModifier: true
    • isModifierReason: 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.
    • isSummary: true
    medium?: CodeableConcept[]

    CommunicationRequest.medium Element

    FHIR Specification

    • Short: A channel of communication
    • Definition: A channel that was used for this communication (e.g. email, fax).
    • FHIR Type: CodeableConcept
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    subject?: Reference

    CommunicationRequest.subject Element

    FHIR Specification

    about?: Reference[]

    CommunicationRequest.about Element

    FHIR Specification

    • 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.
    • Comment: Don't use CommunicationRequest.about element when a more specific element exists, such as basedOn, reasonReference, or replaces.
    • FHIR Type: Reference
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    encounter?: Reference

    CommunicationRequest.encounter Element

    FHIR Specification

    • Short: The Encounter during which this CommunicationRequest was created
    • Definition: The Encounter during which this CommunicationRequest was created or to which the creation of this record is tightly associated.
    • Comment: 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.
    • FHIR Type: Reference
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    payload?: CommunicationRequestPayloadComponent[]

    CommunicationRequest.payload Element

    FHIR Specification

    • Short: Message payload
    • Definition: Text, attachment(s), or resource(s) to be communicated to the recipient.
    • FHIR Type: BackboneElement
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    occurrence?: IDataType

    CommunicationRequest.occurrence[x] Element

    @ChoiceDataTypesMeta('CommunicationRequest.occurrence[x]', ['dateTime','Period',]

    FHIR Specification

    • Short: When scheduled
    • Definition: The time when this communication is to occur.
    • FHIR Types: 'dateTime', 'Period',
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    authoredOn?: DateTimeType

    CommunicationRequest.authoredOn Element

    FHIR Specification

    • Short: When request transitioned to being actionable
    • Definition: For draft requests, indicates the date of initial creation. For requests with other statuses, indicates the date of activation.
    • FHIR Type: dateTime
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    requester?: Reference

    CommunicationRequest.requester Element

    FHIR Specification

    recipient?: Reference[]

    CommunicationRequest.recipient Element

    FHIR Specification

    informationProvider?: Reference[]

    CommunicationRequest.informationProvider Element

    FHIR Specification

    reason?: CodeableReference[]

    CommunicationRequest.reason Element

    FHIR Specification

    • Short: Why is communication needed?
    • Definition: Describes why the request is being made in coded or textual form.
    • Comment: Textual reasons can be captured using reasonCode.text.
    • FHIR Type: CodeableReference
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true
    note?: Annotation[]

    CommunicationRequest.note Element

    FHIR Specification

    • Short: Comments made about communication request
    • Definition: Comments made about the request by the requester, sender, recipient, subject or other participants.
    • FHIR Type: Annotation
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false

    Methods

    • Parse the provided CommunicationRequest JSON to instantiate the CommunicationRequest data model.

      Parameters

      • sourceJson: Value

        JSON representing FHIR CommunicationRequest

      • OptionaloptSourceField: string

        Optional data source field (e.g. <complexTypeName>.<complexTypeFieldName>); defaults to CommunicationRequest

      Returns undefined | CommunicationRequest

      CommunicationRequest data model or undefined for CommunicationRequest

      JsonError if the provided JSON is not a valid JSON object

    • Assigns the provided Reference array value to the recipient property.

      Parameters

      • value: undefined | Reference[]

        the recipient array value

      Returns this

      this

      @ReferenceTargets('CommunicationRequest.recipient', ['Device','Organization','Patient','Practitioner','PractitionerRole','RelatedPerson','Group','CareTeam','HealthcareService','Endpoint',])

      InvalidTypeError for invalid data type or reference value

    • Add the provided Reference value to the recipient array property.

      Parameters

      • value: undefined | Reference

        the recipient value

      Returns this

      this

      @ReferenceTargets('CommunicationRequest.recipient', ['Device','Organization','Patient','Practitioner','PractitionerRole','RelatedPerson','Group','CareTeam','HealthcareService','Endpoint',])

      InvalidTypeError for invalid data type or reference value

    • Assigns the provided Reference array value to the informationProvider property.

      Parameters

      • value: undefined | Reference[]

        the informationProvider array value

      Returns this

      this

      @ReferenceTargets('CommunicationRequest.informationProvider', ['Device','Organization','Patient','Practitioner','PractitionerRole','RelatedPerson','HealthcareService','Endpoint',])

      InvalidTypeError for invalid data type or reference value

    • Add the provided Reference value to the informationProvider array property.

      Parameters

      • value: undefined | Reference

        the informationProvider value

      Returns this

      this

      @ReferenceTargets('CommunicationRequest.informationProvider', ['Device','Organization','Patient','Practitioner','PractitionerRole','RelatedPerson','HealthcareService','Endpoint',])

      InvalidTypeError for invalid data type or reference value

    • Assigns the provided value to the text property.

      Parameters

      Returns this

      this

    • Returns boolean

      true if the text property exists and has a value; false otherwise

    • Assigns the provided Resource array value to the contained property.

      Parameters

      • value: undefined | IResource[]

        the contained array value

      Returns this

      this

    • Returns boolean

      true if the contained property exists and has a value; false otherwise

    • Assigns the provided array of Extension values to the extension property.

      Parameters

      • extension: undefined | IExtension[]

        array of Extensions

      Returns this

      this

    • Determines if the extension property exists.

      Parameters

      • Optionalurl: string

        the url that identifies a specific Extension

      Returns boolean

      true if an Extension has the provided url; false otherwise

      If the url is provided, determines if an Extension having the provided url exists. If the url is not provided, determines if the extension property exists and has any values.

      AssertionError for invalid url

    • Adds the provided Extension to the extension property array.

      Parameters

      • extension: undefined | IExtension

        the Extension value to add to the extension property array

      Returns this

      this

    • Removes the Extension having the provided url from the extension property array.

      Parameters

      • url: string

        the url that identifies a specific Extension to remove

      Returns void

      AssertionError for invalid url

    • Determines if the modifierExtension property exists.

      Parameters

      • Optionalurl: string

        the url that identifies a specific Extension

      Returns boolean

      true if an Extension has the provided url

      If the url is provided, determines if an Extension having the provided url exists. If the url is not provided, determines if the modifierExtension property exists and has any values.

      AssertionError for invalid url

    • Assigns the provided PrimitiveType value to the id property.

      Parameters

      • element: undefined | IdType

        the id value

      Returns this

      this

    • Returns undefined | string

      the id property value as a primitive value

    • Assigns the provided primitive value to the id property.

      Parameters

      • value: undefined | string

        the id value

      Returns this

      this

      PrimitiveTypeError for invalid primitive types

    • Returns boolean

      true if the id property exists and has a value; false otherwise

    • Assigns the provided value to the meta property.

      Parameters

      • value: undefined | Meta

        the meta value

      Returns this

      this

    • Returns boolean

      true if the meta property exists and has a value; false otherwise

    • Assigns the provided primitive value to the implicitRules property.

      Parameters

      • value: undefined | string

        the implicitRules value

      Returns this

      this

      PrimitiveTypeError for invalid primitive types

    • Returns undefined | string

      the language property value as a primitive value

    • Assigns the provided primitive value to the language property.

      Parameters

      • value: undefined | string

        the language value

      Returns this

      this

      PrimitiveTypeError for invalid primitive types

    • Returns boolean

      true if the language property exists and has a value; false otherwise

    • Returns boolean

      true if the instance is a FHIR complex or primitive datatype; false otherwise

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    parsegetIdentifiersetIdentifieraddIdentifierhasIdentifiergetBasedOnsetBasedOnaddBasedOnhasBasedOngetReplacessetReplacesaddReplaceshasReplacesgetGroupIdentifiersetGroupIdentifierhasGroupIdentifiergetStatusEnumTypesetStatusEnumTypehasStatusEnumTypegetStatusElementsetStatusElementhasStatusElementgetStatussetStatushasStatusgetStatusReasonsetStatusReasonhasStatusReasongetIntentEnumTypesetIntentEnumTypehasIntentEnumTypegetIntentElementsetIntentElementhasIntentElementgetIntentsetIntenthasIntentgetCategorysetCategoryaddCategoryhasCategorygetPriorityEnumTypesetPriorityEnumTypehasPriorityEnumTypegetPriorityElementsetPriorityElementhasPriorityElementgetPrioritysetPriorityhasPrioritygetDoNotPerformElementsetDoNotPerformElementhasDoNotPerformElementgetDoNotPerformsetDoNotPerformhasDoNotPerformgetMediumsetMediumaddMediumhasMediumgetSubjectsetSubjecthasSubjectgetAboutsetAboutaddAbouthasAboutgetEncountersetEncounterhasEncountergetPayloadsetPayloadaddPayloadhasPayloadgetOccurrencesetOccurrencehasOccurrencegetOccurrenceDateTimeTypehasOccurrenceDateTimeTypegetOccurrencePeriodhasOccurrencePeriodgetAuthoredOnElementsetAuthoredOnElementhasAuthoredOnElementgetAuthoredOnsetAuthoredOnhasAuthoredOngetRequestersetRequesterhasRequestergetRecipientsetRecipientaddRecipienthasRecipientgetInformationProvidersetInformationProvideraddInformationProviderhasInformationProvidergetReasonsetReasonaddReasonhasReasongetNotesetNoteaddNotehasNotefhirTypeisEmptyisRequiredFieldsEmptycopytoJSONgetTextsetTexthasTextgetContainedsetContainedaddContainedhasContainedgetExtensionsetExtensionhasExtensiongetExtensionByUrladdExtensionremoveExtensiongetModifierExtensionsetModifierExtensionhasModifierExtensiongetModifierExtensionByUrladdModifierExtensionremoveModifierExtensionresourceTypegetIdElementsetIdElementhasIdElementgetIdsetIdhasIdgetMetasetMetahasMetagetImplicitRulesElementsetImplicitRulesElementhasImplicitRulesElementgetImplicitRulessetImplicitRuleshasImplicitRulesgetLanguageElementsetLanguageElementhasLanguageElementgetLanguagesetLanguagehasLanguageisResourceisDataTypeisComplexDataTypeisPrimitiveisBooleanPrimitiveisStringPrimitiveisNumberPrimitiveisBigIntPrimitiveisDateTimePrimitivecopyValuesinitIdentifierinitBasedOninitReplacesinitCategoryinitMediuminitAboutinitPayloadinitRecipientinitInformationProviderinitReasoninitNote