Data Model Libraries
    Preparing search index...

    Class Communication

    Communication Class

    An occurrence of information being transmitted; e.g. an alert that was sent to a responsible provider, a public health agency that was notified about a reportable condition.

    FHIR Specification

    • Short: A record of information transmitted from a sender to a receiver
    • Definition: An occurrence of information being transmitted; e.g. an alert that was sent to a responsible provider, a public health agency that was notified about a reportable condition.
    • FHIR Version: 4.3.0

    FHIR Communication

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    constructor

    Properties

    identifier? instantiatesCanonical? instantiatesUri? basedOn? partOf? inResponseTo? eventStatusEnum status statusReason? category? requestPriorityEnum priority? medium? subject? topic? about? encounter? sent? received? recipient? sender? reasonCode? reasonReference? payload? note?

    Methods

    parse getIdentifier setIdentifier addIdentifier hasIdentifier getInstantiatesCanonicalElement setInstantiatesCanonicalElement addInstantiatesCanonicalElement hasInstantiatesCanonicalElement getInstantiatesCanonical setInstantiatesCanonical addInstantiatesCanonical hasInstantiatesCanonical getInstantiatesUriElement setInstantiatesUriElement addInstantiatesUriElement hasInstantiatesUriElement getInstantiatesUri setInstantiatesUri addInstantiatesUri hasInstantiatesUri getBasedOn setBasedOn addBasedOn hasBasedOn getPartOf setPartOf addPartOf hasPartOf getInResponseTo setInResponseTo addInResponseTo hasInResponseTo getStatusEnumType setStatusEnumType hasStatusEnumType getStatusElement setStatusElement hasStatusElement getStatus setStatus hasStatus getStatusReason setStatusReason hasStatusReason getCategory setCategory addCategory hasCategory getPriorityEnumType setPriorityEnumType hasPriorityEnumType getPriorityElement setPriorityElement hasPriorityElement getPriority setPriority hasPriority getMedium setMedium addMedium hasMedium getSubject setSubject hasSubject getTopic setTopic hasTopic getAbout setAbout addAbout hasAbout getEncounter setEncounter hasEncounter getSentElement setSentElement hasSentElement getSent setSent hasSent getReceivedElement setReceivedElement hasReceivedElement getReceived setReceived hasReceived getRecipient setRecipient addRecipient hasRecipient getSender setSender hasSender getReasonCode setReasonCode addReasonCode hasReasonCode getReasonReference setReasonReference addReasonReference hasReasonReference getPayload setPayload addPayload hasPayload 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 initInstantiatesCanonical initInstantiatesUri initBasedOn initPartOf initInResponseTo initCategory initMedium initAbout initRecipient initReasonCode initReasonReference initPayload initNote

    Constructors

    Properties

    identifier?: Identifier[]

    Communication.identifier Element

    FHIR Specification

    • Short: Unique identifier
    • Definition: Business identifiers assigned to this communication 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 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
    instantiatesCanonical?: CanonicalType[]

    Communication.instantiatesCanonical Element

    FHIR Specification

    instantiatesUri?: UriType[]

    Communication.instantiatesUri Element

    FHIR Specification

    • Short: Instantiates external protocol or definition
    • Definition: The URL pointing to an externally maintained protocol, guideline, orderset or other definition that is adhered to in whole or in part by this Communication.
    • Comment: This might be an HTML page, PDF, etc. or could just be a non-resolvable URI identifier.
    • FHIR Type: uri
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true
    basedOn?: Reference[]

    Communication.basedOn Element

    FHIR Specification

    • Short: Request fulfilled by this communication
    • Definition: An order, proposal or plan fulfilled in whole or in part by this Communication.
    • Comment: This must point to some sort of a 'Request' resource, such as CarePlan, CommunicationRequest, ServiceRequest, MedicationRequest, etc.
    • FHIR Type: Reference
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true
    partOf?: Reference[]

    Communication.partOf Element

    FHIR Specification

    inResponseTo?: Reference[]

    Communication.inResponseTo Element

    FHIR Specification

    eventStatusEnum: EventStatusEnum

    FHIR CodeSystem: EventStatus

    EventStatusEnum

    status: null | EnumCodeType

    Communication.status Element

    FHIR Specification

    • Short: preparation | in-progress | not-done | on-hold | stopped | completed | entered-in-error | unknown
    • Definition: The status of the transmission.
    • Comment: This element is labeled as a modifier because the status contains the codes aborted and entered-in-error that mark the communication as not currently valid.
    • 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: EventStatusEnum

    statusReason?: CodeableConcept

    Communication.statusReason Element

    FHIR Specification

    • Short: Reason for current status
    • Definition: Captures the reason for the current state of the Communication.
    • Comment: This is generally only used for "exception" statuses such as "not-done", "suspended" or "aborted". The reason for performing the event at all is captured in reasonCode, not here.
    • FHIR Type: CodeableConcept
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    category?: CodeableConcept[]

    Communication.category Element

    FHIR Specification

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

    FHIR CodeSystem: RequestPriority

    RequestPriorityEnum

    priority?: EnumCodeType

    Communication.priority Element

    FHIR Specification

    • Short: routine | urgent | asap | stat
    • Definition: Characterizes how quickly the planned or in progress communication must be addressed. Includes concepts such as stat, urgent, routine.
    • Comment: Used to prioritize workflow (such as which communication to read first) when the communication is planned or in progress.
    • FHIR Type: code
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true

    CodeSystem Enumeration: RequestPriorityEnum

    medium?: CodeableConcept[]

    Communication.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

    Communication.subject Element

    FHIR Specification

    topic?: CodeableConcept

    Communication.topic Element

    FHIR Specification

    • Short: Description of the purpose/content
    • Definition: Description of the purpose/content, similar to a subject line in an email.
    • Comment: Communication.topic.text can be used without any codings.
    • FHIR Type: CodeableConcept
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    about?: Reference[]

    Communication.about Element

    FHIR Specification

    • Short: Resources that pertain to this communication
    • Definition: Other resources that pertain to this communication and to which this communication should be associated.
    • Comment: Don't use Communication.about element when a more specific element exists, such as basedOn or reasonReference.
    • FHIR Type: Reference
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    encounter?: Reference

    Communication.encounter Element

    FHIR Specification

    • Short: Encounter created as part of
    • Definition: The Encounter during which this Communication 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
    sent?: DateTimeType

    Communication.sent Element

    FHIR Specification

    • Short: When sent
    • Definition: The time when this communication was sent.
    • FHIR Type: dateTime
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    received?: DateTimeType

    Communication.received Element

    FHIR Specification

    • Short: When received
    • Definition: The time when this communication arrived at the destination.
    • FHIR Type: dateTime
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    recipient?: Reference[]

    Communication.recipient Element

    FHIR Specification

    sender?: Reference

    Communication.sender Element

    FHIR Specification

    reasonCode?: CodeableConcept[]

    Communication.reasonCode Element

    FHIR Specification

    • Short: Indication for message
    • Definition: The reason or justification for the communication.
    • Comment: Textual reasons can be captured using reasonCode.text.
    • FHIR Type: CodeableConcept
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true
    reasonReference?: Reference[]

    Communication.reasonReference Element

    FHIR Specification

    payload?: CommunicationPayloadComponent[]

    Communication.payload Element

    FHIR Specification

    • Short: Message payload
    • Definition: Text, attachment(s), or resource(s) that was communicated to the recipient.
    • FHIR Type: BackboneElement
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    note?: Annotation[]

    Communication.note Element

    FHIR Specification

    • Short: Comments made about the communication
    • Definition: Additional notes or commentary about the communication by the sender, receiver or other interested parties.
    • FHIR Type: Annotation
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false

    Methods

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

      Parameters

      • sourceJson: Value

        JSON representing FHIR Communication

      • OptionaloptSourceField: string

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

      Returns undefined | Communication

      Communication data model or undefined for Communication

      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('Communication.recipient', ['Device','Organization','Patient','Practitioner','PractitionerRole','RelatedPerson','Group','CareTeam','HealthcareService',])

      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('Communication.recipient', ['Device','Organization','Patient','Practitioner','PractitionerRole','RelatedPerson','Group','CareTeam','HealthcareService',])

      InvalidTypeError for invalid data type or reference value

    • Assigns the provided Sender object value to the sender property.

      Parameters

      • value: undefined | Reference

        the sender object value

      Returns this

      this

      @ReferenceTargets('Communication.sender', ['Device','Organization','Patient','Practitioner','PractitionerRole','RelatedPerson','HealthcareService',])

      InvalidTypeError for invalid data type or reference value

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

      Parameters

      • value: undefined | Reference[]

        the reasonReference array value

      Returns this

      this

      @ReferenceTargets('Communication.reasonReference', ['Condition','Observation','DiagnosticReport','DocumentReference',])

      InvalidTypeError for invalid data type or reference value

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

      Parameters

      • value: undefined | Reference

        the reasonReference value

      Returns this

      this

      @ReferenceTargets('Communication.reasonReference', ['Condition','Observation','DiagnosticReport','DocumentReference',])

      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
    parsegetIdentifiersetIdentifieraddIdentifierhasIdentifiergetInstantiatesCanonicalElementsetInstantiatesCanonicalElementaddInstantiatesCanonicalElementhasInstantiatesCanonicalElementgetInstantiatesCanonicalsetInstantiatesCanonicaladdInstantiatesCanonicalhasInstantiatesCanonicalgetInstantiatesUriElementsetInstantiatesUriElementaddInstantiatesUriElementhasInstantiatesUriElementgetInstantiatesUrisetInstantiatesUriaddInstantiatesUrihasInstantiatesUrigetBasedOnsetBasedOnaddBasedOnhasBasedOngetPartOfsetPartOfaddPartOfhasPartOfgetInResponseTosetInResponseToaddInResponseTohasInResponseTogetStatusEnumTypesetStatusEnumTypehasStatusEnumTypegetStatusElementsetStatusElementhasStatusElementgetStatussetStatushasStatusgetStatusReasonsetStatusReasonhasStatusReasongetCategorysetCategoryaddCategoryhasCategorygetPriorityEnumTypesetPriorityEnumTypehasPriorityEnumTypegetPriorityElementsetPriorityElementhasPriorityElementgetPrioritysetPriorityhasPrioritygetMediumsetMediumaddMediumhasMediumgetSubjectsetSubjecthasSubjectgetTopicsetTopichasTopicgetAboutsetAboutaddAbouthasAboutgetEncountersetEncounterhasEncountergetSentElementsetSentElementhasSentElementgetSentsetSenthasSentgetReceivedElementsetReceivedElementhasReceivedElementgetReceivedsetReceivedhasReceivedgetRecipientsetRecipientaddRecipienthasRecipientgetSendersetSenderhasSendergetReasonCodesetReasonCodeaddReasonCodehasReasonCodegetReasonReferencesetReasonReferenceaddReasonReferencehasReasonReferencegetPayloadsetPayloadaddPayloadhasPayloadgetNotesetNoteaddNotehasNotefhirTypeisEmptyisRequiredFieldsEmptycopytoJSONgetTextsetTexthasTextgetContainedsetContainedaddContainedhasContainedgetExtensionsetExtensionhasExtensiongetExtensionByUrladdExtensionremoveExtensiongetModifierExtensionsetModifierExtensionhasModifierExtensiongetModifierExtensionByUrladdModifierExtensionremoveModifierExtensionresourceTypegetIdElementsetIdElementhasIdElementgetIdsetIdhasIdgetMetasetMetahasMetagetImplicitRulesElementsetImplicitRulesElementhasImplicitRulesElementgetImplicitRulessetImplicitRuleshasImplicitRulesgetLanguageElementsetLanguageElementhasLanguageElementgetLanguagesetLanguagehasLanguageisResourceisDataTypeisComplexDataTypeisPrimitiveisBooleanPrimitiveisStringPrimitiveisNumberPrimitiveisBigIntPrimitiveisDateTimePrimitivecopyValuesinitIdentifierinitInstantiatesCanonicalinitInstantiatesUriinitBasedOninitPartOfinitInResponseToinitCategoryinitMediuminitAboutinitRecipientinitReasonCodeinitReasonReferenceinitPayloadinitNote