Projo FHIR Documentation
0.1.0 - ci-build Switzerland flag

Projo FHIR Documentation - Local Development build (v0.1.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

Resource Profile: ProjoCommunication - Detailed Descriptions

Draft as of 2024-01-01

Definitions for the projo-communication resource profile.

Guidance on how to interpret the contents of this table can be foundhere

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

ShortPer-message audit + projection stateA record of information transmitted from a sender to a receiver
Control0..*
Is Modifierfalse
Summaryfalse
Invariantsdom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty())
dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource (contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty())
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated (contained.meta.versionId.empty() and contained.meta.lastUpdated.empty())
dom-5: If a resource is contained in another resource, it SHALL NOT have a security label (contained.meta.security.empty())
dom-6: A resource should have narrative for robust management (text.`div`.exists())
2. Communication.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. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

ShortA set of rules under which this content was created
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. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.

Control0..1
Typeuri
Is Modifiertrue because This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
4. Communication.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 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).

ShortExtensions that cannot be ignored
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.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them
Summaryfalse
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
6. Communication.identifier
Definition

Always present. The WhatsApp message id, used for inbound idempotency. Three layers: (1) isDuplicateInbound short-circuits on Communication?identifier=wamid-system|wamid before any work; (2) If-None-Exist conditional create on the POST; (3) atomic transaction bundling inbound Communication + QR answer or reverse CR.


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.

Shortwamid (wamid identifier system)Unique identifier
Comments

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.

NoteThis is a business identifier, not a resource identifier (see discussion)
Control10..*
TypeIdentifier
Is Modifierfalse
Summarytrue
Requirements

Allows identification of the communication as it is known by various participating systems and in a way that remains consistent across servers.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
SlicingThis element introduces a set of slices on Communication.identifier. The slices areUnordered and Open, and can be differentiated using the following discriminators:
  • value @ system
  • 8. Communication.identifier:wamid
    Slice Namewamid
    Definition

    Set by buildInbound immediately (inbound webhook = receipt) or by finalizeOutboundCommunication after the WhatsApp API returns the wamid (outbound). Read by isDuplicateInbound for the primary dedup check.


    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.

    ShortWhatsApp Message IDUnique identifier
    Comments

    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.

    NoteThis is a business identifier, not a resource identifier (see discussion)
    Control10..1*
    TypeIdentifier
    Is Modifierfalse
    Summarytrue
    Requirements

    Allows identification of the communication as it is known by various participating systems and in a way that remains consistent across servers.

    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    10. Communication.identifier:wamid.use
    Definition

    The purpose of this identifier.

    Shortusual | official | temp | secondary | old (If known)
    Comments

    Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.

    Control0..1
    BindingThe codes SHALL be taken from IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1
    (required to http://hl7.org/fhir/ValueSet/identifier-use|4.0.1)

    Identifies the purpose for this identifier, if known .

    Typecode
    Is Modifiertrue because This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one.
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Summarytrue
    Requirements

    Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.

    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    12. Communication.identifier:wamid.system
    Definition

    Establishes the namespace for the value - that is, a URL that describes a set values that are unique.

    ShortThe namespace for the identifier value
    Comments

    Identifier.system is always case sensitive.

    Control10..1
    Typeuri
    Is Modifierfalse
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Summarytrue
    Requirements

    There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.

    Fixed Valuehttps://firearrow.io/fhir/identifier/wamid
    ExampleGeneral: http://www.acme.com/identifiers/patient
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    14. Communication.identifier:wamid.value
    Definition

    The portion of the identifier typically relevant to the user and which is unique within the context of the system.

    ShortThe value that is unique
    Comments

    If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.

    Control10..1
    Typestring
    Is Modifierfalse
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Summarytrue
    ExampleGeneral: 123456
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    16. Communication.partOf
    Definition

    Always present. Set by the sidecar builders. Links this message to the CR that owns the conversation.


    Part of this action.

    ShortCommunicationRequest referencePart of this action
    Control10..1*
    TypeReference(Resource)
    Is Modifierfalse
    Summarytrue
    Alternate Namescontainer
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    18. Communication.status
    Definition

    Outbound: set to 'in-progress' by buildOutboundInProgress (placeholder before WhatsApp accepts the send), promoted to 'completed' by finalizeOutboundCommunication when the WhatsApp API returns the wamid. Inbound: set to 'completed' immediately by buildInbound (webhook = receipt). Abandoned: set to 'entered-in-error' by buildAbandoned when the sidecar gives up after MAX_REMINDERS_PER_CR. 'completed' and 'entered-in-error' are terminal — waStatusProcessor never downgrades from either.


    The status of the transmission.

    Shortin-progress | completed | entered-in-errorpreparation | in-progress | not-done | on-hold | stopped | completed | entered-in-error | unknown
    Comments

    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.

    Control1..1
    BindingThe codes SHALL be taken from EventStatushttp://hl7.org/fhir/ValueSet/event-status|4.0.1
    (required to http://hl7.org/fhir/ValueSet/event-status|4.0.1)

    The status of the communication.

    Typecode
    Is Modifiertrue because 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
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Summarytrue
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    20. Communication.category
    Definition

    Always present. Set by the sidecar builders to classify the message in the conversation audit trail. invitation: initial template. question: next-question template. answer: patient reply. reminder: reminder template. abandoned: message that could not be delivered. completion: closing message.


    The type of message conveyed such as alert, notification, reminder, instruction, etc.

    Shortinvitation | question | answer | reminder | abandoned | completionMessage category
    Comments

    There may be multiple axes of categorization and one communication may serve multiple purposes.

    Control10..1*
    BindingFor example codes, see CommunicationCategoryhttp://hl7.org/fhir/ValueSet/communication-category|4.0.1
    (example to http://hl7.org/fhir/ValueSet/communication-category|4.0.1)

    Codes for general categories of communications such as alerts, instructions, etc.

    TypeCodeableConcept
    Is Modifierfalse
    Summaryfalse
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    22. Communication.category.coding
    Definition

    A reference to a code defined by a terminology system.

    ShortCode defined by a terminology system
    Comments

    Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.

    Control10..*
    TypeCoding
    Is Modifierfalse
    Summarytrue
    Requirements

    Allows for alternative encodings within a code system, and translations to other code systems.

    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    24. Communication.category.coding.system
    Definition

    The identification of the code system that defines the meaning of the symbol in the code.

    ShortIdentity of the terminology system
    Comments

    The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.

    Control10..1
    Typeuri
    Is Modifierfalse
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Summarytrue
    Requirements

    Need to be unambiguous about the source of the definition of the symbol.

    Fixed Valuehttps://firearrow.io/fhir/CodeSystem/communication-category
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    26. Communication.category.coding.code
    Definition

    A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

    ShortSymbol in syntax defined by the system
    Control10..1
    Typecode
    Is Modifierfalse
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Summarytrue
    Requirements

    Need to refer to a particular code in the system.

    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    28. Communication.medium
    Definition

    Always present. Set by the sidecar builders. Identifies the transport channel.


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

    Shortwhatsapp (communication-medium code system)A channel of communication
    Control10..1*
    BindingFor example codes, see ParticipationModehttp://terminology.hl7.org/ValueSet/v3-ParticipationMode
    (example to http://terminology.hl7.org/ValueSet/v3-ParticipationMode)

    Codes for communication mediums such as phone, fax, email, in person, etc.

    TypeCodeableConcept
    Is Modifierfalse
    Summaryfalse
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    30. Communication.medium.coding
    Definition

    A reference to a code defined by a terminology system.

    ShortCode defined by a terminology system
    Comments

    Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.

    Control10..*
    TypeCoding
    Is Modifierfalse
    Summarytrue
    Requirements

    Allows for alternative encodings within a code system, and translations to other code systems.

    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    32. Communication.medium.coding.system
    Definition

    The identification of the code system that defines the meaning of the symbol in the code.

    ShortIdentity of the terminology system
    Comments

    The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.

    Control10..1
    Typeuri
    Is Modifierfalse
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Summarytrue
    Requirements

    Need to be unambiguous about the source of the definition of the symbol.

    Fixed Valuehttps://firearrow.io/fhir/CodeSystem/communication-medium
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    34. Communication.medium.coding.code
    Definition

    A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

    ShortSymbol in syntax defined by the system
    Control10..1
    Typecode
    Is Modifierfalse
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Summarytrue
    Requirements

    Need to refer to a particular code in the system.

    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    36. Communication.sent
    Definition

    Set by finalizeOutboundCommunication when the WhatsApp API accepts the outbound message.


    The time when this communication was sent.

    ShortOutbound: WhatsApp API send timestampWhen sent
    Control0..1
    TypedateTime
    Is Modifierfalse
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Summaryfalse
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    38. Communication.received
    Definition

    Set by buildInbound from the Meta webhook timestamp.


    The time when this communication arrived at the destination.

    ShortInbound: webhook receipt timestampWhen received
    Control0..1
    TypedateTime
    Is Modifierfalse
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Summaryfalse
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    40. Communication.recipient
    Definition

    Always present. On outbound messages: set to the Patient. On inbound messages: set to the Organization.


    The entity (e.g. person, organization, clinical information system, care team or device) which was the target of the communication. If receipts need to be tracked by an individual, a separate resource instance will need to be created for each recipient. Multiple recipient communications are intended where either receipts are not tracked (e.g. a mass mail-out) or a receipt is captured in aggregate (all emails confirmed received by a particular time).

    ShortOpposite side of senderMessage recipient
    Control10..*
    TypeReference(Device, Organization, Patient, Practitioner, PractitionerRole, RelatedPerson, Group, CareTeam, HealthcareService)
    Is Modifierfalse
    Summaryfalse
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    42. Communication.sender
    Definition

    Always present. On outbound messages: set to the Organization (sender). On inbound messages: set to a resolved Reference to Patient/Practitioner/RelatedPerson when identity is known, or an identifier-only Reference (phone or BSUID system) when identity is unresolved (before identity resolution).


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

    ShortResolved Reference or identifier-only Reference (phone/BSUID)Message sender
    Comments

    When identity is unknown, sender carries identifier-only References (phone or BSUID system) rather than a resolved resource reference.

    Control10..1
    TypeReference(Device, Organization, Patient, Practitioner, PractitionerRole, RelatedPerson, HealthcareService)
    Is Modifierfalse
    Summaryfalse
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    44. Communication.payload
    Definition

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

    ShortMessage contentMessage payload
    Control10..*
    TypeBackboneElement
    Is Modifierfalse
    Summaryfalse
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    46. Communication.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 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).

    ShortExtensions that cannot be ignored even if unrecognized
    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.

    Control0..*
    TypeExtension
    Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
    Summarytrue
    Requirements

    Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

    Alternate Namesextensions, user content, modifiers
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    48. Communication.payload.content[x]
    Definition

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

    ShortMessage part content
    Control1..1
    Typestring, Reference(Resource), Attachment
    [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
    Is Modifierfalse
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Summaryfalse
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    SlicingThis element introduces a set of slices on Communication.payload.content[x]. The slices areUnordered and Closed, and can be differentiated using the following discriminators:
    • type @ $this
    • 50. Communication.payload.content[x]:contentString
      Slice NamecontentString
      Definition

      Set by the sidecar builders to the WhatsApp message text (or template body).


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

      ShortMessage textMessage part content
      Control1..1
      Typestring, Reference(Resource), Attachment
      [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
      Is Modifierfalse
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      Summaryfalse
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

      Guidance on how to interpret the contents of this table can be foundhere

      0. Communication
      ShortPer-message audit + projection state
      2. Communication.identifier
      Definition

      Always present. The WhatsApp message id, used for inbound idempotency. Three layers: (1) isDuplicateInbound short-circuits on Communication?identifier=wamid-system|wamid before any work; (2) If-None-Exist conditional create on the POST; (3) atomic transaction bundling inbound Communication + QR answer or reverse CR.

      Shortwamid (wamid identifier system)
      NoteThis is a business identifier, not a resource identifier (see discussion)
      Control1..?
      SlicingThis element introduces a set of slices on Communication.identifier. The slices areUnordered and Open, and can be differentiated using the following discriminators:
      • value @ system
      • 4. Communication.identifier:wamid
        Slice Namewamid
        Definition

        Set by buildInbound immediately (inbound webhook = receipt) or by finalizeOutboundCommunication after the WhatsApp API returns the wamid (outbound). Read by isDuplicateInbound for the primary dedup check.

        ShortWhatsApp Message ID
        NoteThis is a business identifier, not a resource identifier (see discussion)
        Control1..1
        6. Communication.identifier:wamid.system
        Control1..?
        Fixed Valuehttps://firearrow.io/fhir/identifier/wamid
        8. Communication.identifier:wamid.value
        Control1..?
        10. Communication.partOf
        Definition

        Always present. Set by the sidecar builders. Links this message to the CR that owns the conversation.

        ShortCommunicationRequest reference
        Control1..1
        12. Communication.status
        Definition

        Outbound: set to 'in-progress' by buildOutboundInProgress (placeholder before WhatsApp accepts the send), promoted to 'completed' by finalizeOutboundCommunication when the WhatsApp API returns the wamid. Inbound: set to 'completed' immediately by buildInbound (webhook = receipt). Abandoned: set to 'entered-in-error' by buildAbandoned when the sidecar gives up after MAX_REMINDERS_PER_CR. 'completed' and 'entered-in-error' are terminal — waStatusProcessor never downgrades from either.

        Shortin-progress | completed | entered-in-error
        14. Communication.category
        Definition

        Always present. Set by the sidecar builders to classify the message in the conversation audit trail. invitation: initial template. question: next-question template. answer: patient reply. reminder: reminder template. abandoned: message that could not be delivered. completion: closing message.

        Shortinvitation | question | answer | reminder | abandoned | completion
        Control1..1
        16. Communication.category.coding
        Control1..?
        18. Communication.category.coding.system
        Control1..?
        Fixed Valuehttps://firearrow.io/fhir/CodeSystem/communication-category
        20. Communication.category.coding.code
        Control1..?
        22. Communication.medium
        Definition

        Always present. Set by the sidecar builders. Identifies the transport channel.

        Shortwhatsapp (communication-medium code system)
        Control1..1
        24. Communication.medium.coding
        Control1..?
        26. Communication.medium.coding.system
        Control1..?
        Fixed Valuehttps://firearrow.io/fhir/CodeSystem/communication-medium
        28. Communication.medium.coding.code
        Control1..?
        30. Communication.sent
        Definition

        Set by finalizeOutboundCommunication when the WhatsApp API accepts the outbound message.

        ShortOutbound: WhatsApp API send timestamp
        32. Communication.received
        Definition

        Set by buildInbound from the Meta webhook timestamp.

        ShortInbound: webhook receipt timestamp
        34. Communication.recipient
        Definition

        Always present. On outbound messages: set to the Patient. On inbound messages: set to the Organization.

        ShortOpposite side of sender
        Control1..?
        36. Communication.sender
        Definition

        Always present. On outbound messages: set to the Organization (sender). On inbound messages: set to a resolved Reference to Patient/Practitioner/RelatedPerson when identity is known, or an identifier-only Reference (phone or BSUID system) when identity is unresolved (before identity resolution).

        ShortResolved Reference or identifier-only Reference (phone/BSUID)
        Comments

        When identity is unknown, sender carries identifier-only References (phone or BSUID system) rather than a resolved resource reference.

        Control1..?
        38. Communication.payload
        ShortMessage content
        Control1..?
        40. Communication.payload.content[x]
        [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
        SlicingThis element introduces a set of slices on Communication.payload.content[x]. The slices areUnordered and Open, and can be differentiated using the following discriminators:
        • type @ $this
        • 42. Communication.payload.content[x]:contentString
          Slice NamecontentString
          Definition

          Set by the sidecar builders to the WhatsApp message text (or template body).

          ShortMessage text
          Control1..1
          Typestring
          [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension

          Guidance on how to interpret the contents of this table can be foundhere

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

          ShortPer-message audit + projection state
          Control0..*
          Is Modifierfalse
          Summaryfalse
          Invariantsdom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty())
          dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource (contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty())
          dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated (contained.meta.versionId.empty() and contained.meta.lastUpdated.empty())
          dom-5: If a resource is contained in another resource, it SHALL NOT have a security label (contained.meta.security.empty())
          dom-6: A resource should have narrative for robust management (text.`div`.exists())
          2. Communication.id
          Definition

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

          ShortLogical id of this artifact
          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.

          Control0..1
          Typeid
          Is Modifierfalse
          Summarytrue
          4. Communication.meta
          Definition

          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.

          ShortMetadata about the resource
          Control0..1
          TypeMeta
          Is Modifierfalse
          Summarytrue
          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          6. Communication.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. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

          ShortA set of rules under which this content was created
          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. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.

          Control0..1
          Typeuri
          Is Modifiertrue because This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          Summarytrue
          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          8. Communication.language
          Definition

          The base language in which the resource is written.

          ShortLanguage of the resource content
          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).

          Control0..1
          BindingThe codes SHOULD be taken from CommonLanguages
          (preferred to http://hl7.org/fhir/ValueSet/languages|4.0.1)

          A human language.

          Additional BindingsPurpose
          AllLanguagesMax Binding
          Typecode
          Is Modifierfalse
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          Summaryfalse
          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          10. Communication.text
          Definition

          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.

          ShortText summary of the resource, for human interpretation
          Comments

          Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.

          Control0..1
          TypeNarrative
          Is Modifierfalse
          Summaryfalse
          Alternate Namesnarrative, html, xhtml, display
          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          12. Communication.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.

          ShortContained, inline 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. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.

          Control0..*
          TypeResource
          Is Modifierfalse
          Summaryfalse
          Alternate Namesinline resources, anonymous resources, contained resources
          14. Communication.extension
          Definition

          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.

          ShortAdditional content defined by implementations
          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.

          Control0..*
          TypeExtension
          Is Modifierfalse
          Summaryfalse
          Alternate Namesextensions, user content
          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
          16. Communication.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 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).

          ShortExtensions that cannot be ignored
          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.

          Control0..*
          TypeExtension
          Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them
          Summaryfalse
          Requirements

          Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

          Alternate Namesextensions, user content
          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
          18. Communication.identifier
          Definition

          Always present. The WhatsApp message id, used for inbound idempotency. Three layers: (1) isDuplicateInbound short-circuits on Communication?identifier=wamid-system|wamid before any work; (2) If-None-Exist conditional create on the POST; (3) atomic transaction bundling inbound Communication + QR answer or reverse CR.

          Shortwamid (wamid identifier system)
          Comments

          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.

          NoteThis is a business identifier, not a resource identifier (see discussion)
          Control1..*
          TypeIdentifier
          Is Modifierfalse
          Summarytrue
          Requirements

          Allows identification of the communication as it is known by various participating systems and in a way that remains consistent across servers.

          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          SlicingThis element introduces a set of slices on Communication.identifier. The slices areUnordered and Open, and can be differentiated using the following discriminators:
          • value @ system
          • 20. Communication.identifier:wamid
            Slice Namewamid
            Definition

            Set by buildInbound immediately (inbound webhook = receipt) or by finalizeOutboundCommunication after the WhatsApp API returns the wamid (outbound). Read by isDuplicateInbound for the primary dedup check.

            ShortWhatsApp Message ID
            Comments

            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.

            NoteThis is a business identifier, not a resource identifier (see discussion)
            Control1..1
            TypeIdentifier
            Is Modifierfalse
            Summarytrue
            Requirements

            Allows identification of the communication as it is known by various participating systems and in a way that remains consistent across servers.

            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            22. Communication.identifier:wamid.id
            Definition

            Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

            ShortUnique id for inter-element referencing
            Control0..1
            Typestring
            Is Modifierfalse
            XML FormatIn the XML format, this property is represented as an attribute.
            Summaryfalse
            24. Communication.identifier:wamid.extension
            Definition

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

            ShortAdditional content defined by implementations
            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.

            Control0..*
            TypeExtension
            Is Modifierfalse
            Summaryfalse
            Alternate Namesextensions, user content
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
            SlicingThis element introduces a set of slices on Communication.identifier.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
            • value @ url
            • 26. Communication.identifier:wamid.use
              Definition

              The purpose of this identifier.

              Shortusual | official | temp | secondary | old (If known)
              Comments

              Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.

              Control0..1
              BindingThe codes SHALL be taken from IdentifierUse
              (required to http://hl7.org/fhir/ValueSet/identifier-use|4.0.1)

              Identifies the purpose for this identifier, if known .

              Typecode
              Is Modifiertrue because This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one.
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              Summarytrue
              Requirements

              Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.

              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              28. Communication.identifier:wamid.type
              Definition

              A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.

              ShortDescription of identifier
              Comments

              This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.

              Control0..1
              BindingUnless not suitable, these codes SHALL be taken from Identifier Type Codes
              (extensible to http://hl7.org/fhir/ValueSet/identifier-type|4.0.1)

              A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

              TypeCodeableConcept
              Is Modifierfalse
              Summarytrue
              Requirements

              Allows users to make use of identifiers when the identifier system is not known.

              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              30. Communication.identifier:wamid.system
              Definition

              Establishes the namespace for the value - that is, a URL that describes a set values that are unique.

              ShortThe namespace for the identifier value
              Comments

              Identifier.system is always case sensitive.

              Control1..1
              Typeuri
              Is Modifierfalse
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              Summarytrue
              Requirements

              There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.

              Fixed Valuehttps://firearrow.io/fhir/identifier/wamid
              ExampleGeneral: http://www.acme.com/identifiers/patient
              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              32. Communication.identifier:wamid.value
              Definition

              The portion of the identifier typically relevant to the user and which is unique within the context of the system.

              ShortThe value that is unique
              Comments

              If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.

              Control1..1
              Typestring
              Is Modifierfalse
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              Summarytrue
              ExampleGeneral: 123456
              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              34. Communication.identifier:wamid.period
              Definition

              Time period during which identifier is/was valid for use.

              ShortTime period when id is/was valid for use
              Control0..1
              TypePeriod
              Is Modifierfalse
              Summarytrue
              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              36. Communication.identifier:wamid.assigner
              Definition

              Organization that issued/manages the identifier.

              ShortOrganization that issued id (may be just text)
              Comments

              The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.

              Control0..1
              TypeReference(Organization)
              Is Modifierfalse
              Summarytrue
              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              38. Communication.instantiatesCanonical
              Definition

              The URL pointing to a FHIR-defined protocol, guideline, orderset or other definition that is adhered to in whole or in part by this Communication.

              ShortInstantiates FHIR protocol or definition
              Control0..*
              Typecanonical(PlanDefinition, ActivityDefinition, Measure, OperationDefinition, Questionnaire)
              Is Modifierfalse
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              Summarytrue
              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              40. Communication.instantiatesUri
              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.

              ShortInstantiates external protocol or definition
              Comments

              This might be an HTML page, PDF, etc. or could just be a non-resolvable URI identifier.

              Control0..*
              Typeuri
              Is Modifierfalse
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              Summarytrue
              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              42. Communication.basedOn
              Definition

              An order, proposal or plan fulfilled in whole or in part by this Communication.

              ShortRequest fulfilled by this communication
              Comments

              This must point to some sort of a 'Request' resource, such as CarePlan, CommunicationRequest, ServiceRequest, MedicationRequest, etc.

              Control0..*
              TypeReference(Resource)
              Is Modifierfalse
              Summarytrue
              Alternate Namesfulfills
              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              44. Communication.partOf
              Definition

              Always present. Set by the sidecar builders. Links this message to the CR that owns the conversation.

              ShortCommunicationRequest reference
              Control1..1
              TypeReference(Resource)
              Is Modifierfalse
              Summarytrue
              Alternate Namescontainer
              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              46. Communication.inResponseTo
              Definition

              Prior communication that this communication is in response to.

              ShortReply to
              Control0..*
              TypeReference(Communication)
              Is Modifierfalse
              Summaryfalse
              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              48. Communication.status
              Definition

              Outbound: set to 'in-progress' by buildOutboundInProgress (placeholder before WhatsApp accepts the send), promoted to 'completed' by finalizeOutboundCommunication when the WhatsApp API returns the wamid. Inbound: set to 'completed' immediately by buildInbound (webhook = receipt). Abandoned: set to 'entered-in-error' by buildAbandoned when the sidecar gives up after MAX_REMINDERS_PER_CR. 'completed' and 'entered-in-error' are terminal — waStatusProcessor never downgrades from either.

              Shortin-progress | completed | entered-in-error
              Comments

              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.

              Control1..1
              BindingThe codes SHALL be taken from EventStatus
              (required to http://hl7.org/fhir/ValueSet/event-status|4.0.1)

              The status of the communication.

              Typecode
              Is Modifiertrue because 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
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              Summarytrue
              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              50. Communication.statusReason
              Definition

              Captures the reason for the current state of the Communication.

              ShortReason for current status
              Comments

              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.

              Control0..1
              BindingFor example codes, see CommunicationNotDoneReason
              (example to http://hl7.org/fhir/ValueSet/communication-not-done-reason|4.0.1)

              Codes for the reason why a communication did not happen.

              TypeCodeableConcept
              Is Modifierfalse
              Summarytrue
              Alternate NamesSuspended Reason, Cancelled Reason
              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              52. Communication.category
              Definition

              Always present. Set by the sidecar builders to classify the message in the conversation audit trail. invitation: initial template. question: next-question template. answer: patient reply. reminder: reminder template. abandoned: message that could not be delivered. completion: closing message.

              Shortinvitation | question | answer | reminder | abandoned | completion
              Comments

              There may be multiple axes of categorization and one communication may serve multiple purposes.

              Control1..1
              BindingFor example codes, see CommunicationCategory
              (example to http://hl7.org/fhir/ValueSet/communication-category|4.0.1)

              Codes for general categories of communications such as alerts, instructions, etc.

              TypeCodeableConcept
              Is Modifierfalse
              Summaryfalse
              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              54. Communication.category.id
              Definition

              Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

              ShortUnique id for inter-element referencing
              Control0..1
              Typestring
              Is Modifierfalse
              XML FormatIn the XML format, this property is represented as an attribute.
              Summaryfalse
              56. Communication.category.extension
              Definition

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

              ShortAdditional content defined by implementations
              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.

              Control0..*
              TypeExtension
              Is Modifierfalse
              Summaryfalse
              Alternate Namesextensions, user content
              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
              SlicingThis element introduces a set of slices on Communication.category.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
              • value @ url
              • 58. Communication.category.coding
                Definition

                A reference to a code defined by a terminology system.

                ShortCode defined by a terminology system
                Comments

                Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.

                Control1..*
                TypeCoding
                Is Modifierfalse
                Summarytrue
                Requirements

                Allows for alternative encodings within a code system, and translations to other code systems.

                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                60. Communication.category.coding.id
                Definition

                Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                ShortUnique id for inter-element referencing
                Control0..1
                Typestring
                Is Modifierfalse
                XML FormatIn the XML format, this property is represented as an attribute.
                Summaryfalse
                62. Communication.category.coding.extension
                Definition

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

                ShortAdditional content defined by implementations
                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.

                Control0..*
                TypeExtension
                Is Modifierfalse
                Summaryfalse
                Alternate Namesextensions, user content
                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                SlicingThis element introduces a set of slices on Communication.category.coding.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                • value @ url
                • 64. Communication.category.coding.system
                  Definition

                  The identification of the code system that defines the meaning of the symbol in the code.

                  ShortIdentity of the terminology system
                  Comments

                  The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.

                  Control1..1
                  Typeuri
                  Is Modifierfalse
                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                  Summarytrue
                  Requirements

                  Need to be unambiguous about the source of the definition of the symbol.

                  Fixed Valuehttps://firearrow.io/fhir/CodeSystem/communication-category
                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                  66. Communication.category.coding.version
                  Definition

                  The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.

                  ShortVersion of the system - if relevant
                  Comments

                  Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.

                  NoteThis is a business version Id, not a resource version Id (see discussion)
                  Control0..1
                  Typestring
                  Is Modifierfalse
                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                  Summarytrue
                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                  68. Communication.category.coding.code
                  Definition

                  A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

                  ShortSymbol in syntax defined by the system
                  Control1..1
                  Typecode
                  Is Modifierfalse
                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                  Summarytrue
                  Requirements

                  Need to refer to a particular code in the system.

                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                  70. Communication.category.coding.display
                  Definition

                  A representation of the meaning of the code in the system, following the rules of the system.

                  ShortRepresentation defined by the system
                  Control0..1
                  Typestring
                  Is Modifierfalse
                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                  Summarytrue
                  Requirements

                  Need to be able to carry a human-readable meaning of the code for readers that do not know the system.

                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                  72. Communication.category.coding.userSelected
                  Definition

                  Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).

                  ShortIf this coding was chosen directly by the user
                  Comments

                  Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.

                  Control0..1
                  Typeboolean
                  Is Modifierfalse
                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                  Summarytrue
                  Requirements

                  This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.

                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                  74. Communication.category.text
                  Definition

                  A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.

                  ShortPlain text representation of the concept
                  Comments

                  Very often the text is the same as a displayName of one of the codings.

                  Control0..1
                  Typestring
                  Is Modifierfalse
                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                  Summarytrue
                  Requirements

                  The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.

                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                  76. Communication.priority
                  Definition

                  Characterizes how quickly the planned or in progress communication must be addressed. Includes concepts such as stat, urgent, routine.

                  Shortroutine | urgent | asap | stat
                  Comments

                  Used to prioritize workflow (such as which communication to read first) when the communication is planned or in progress.

                  Control0..1
                  BindingThe codes SHALL be taken from RequestPriority
                  (required to http://hl7.org/fhir/ValueSet/request-priority|4.0.1)

                  Codes indicating the relative importance of a communication.

                  Typecode
                  Is Modifierfalse
                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                  Summarytrue
                  Meaning if MissingIf missing, this communication should be treated with normal priority
                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                  78. Communication.medium
                  Definition

                  Always present. Set by the sidecar builders. Identifies the transport channel.

                  Shortwhatsapp (communication-medium code system)
                  Control1..1
                  BindingFor example codes, see ParticipationMode
                  (example to http://terminology.hl7.org/ValueSet/v3-ParticipationMode)

                  Codes for communication mediums such as phone, fax, email, in person, etc.

                  TypeCodeableConcept
                  Is Modifierfalse
                  Summaryfalse
                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                  80. Communication.medium.id
                  Definition

                  Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                  ShortUnique id for inter-element referencing
                  Control0..1
                  Typestring
                  Is Modifierfalse
                  XML FormatIn the XML format, this property is represented as an attribute.
                  Summaryfalse
                  82. Communication.medium.extension
                  Definition

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

                  ShortAdditional content defined by implementations
                  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.

                  Control0..*
                  TypeExtension
                  Is Modifierfalse
                  Summaryfalse
                  Alternate Namesextensions, user content
                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                  ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                  SlicingThis element introduces a set of slices on Communication.medium.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                  • value @ url
                  • 84. Communication.medium.coding
                    Definition

                    A reference to a code defined by a terminology system.

                    ShortCode defined by a terminology system
                    Comments

                    Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.

                    Control1..*
                    TypeCoding
                    Is Modifierfalse
                    Summarytrue
                    Requirements

                    Allows for alternative encodings within a code system, and translations to other code systems.

                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                    86. Communication.medium.coding.id
                    Definition

                    Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                    ShortUnique id for inter-element referencing
                    Control0..1
                    Typestring
                    Is Modifierfalse
                    XML FormatIn the XML format, this property is represented as an attribute.
                    Summaryfalse
                    88. Communication.medium.coding.extension
                    Definition

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

                    ShortAdditional content defined by implementations
                    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.

                    Control0..*
                    TypeExtension
                    Is Modifierfalse
                    Summaryfalse
                    Alternate Namesextensions, user content
                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                    SlicingThis element introduces a set of slices on Communication.medium.coding.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                    • value @ url
                    • 90. Communication.medium.coding.system
                      Definition

                      The identification of the code system that defines the meaning of the symbol in the code.

                      ShortIdentity of the terminology system
                      Comments

                      The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.

                      Control1..1
                      Typeuri
                      Is Modifierfalse
                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                      Summarytrue
                      Requirements

                      Need to be unambiguous about the source of the definition of the symbol.

                      Fixed Valuehttps://firearrow.io/fhir/CodeSystem/communication-medium
                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      92. Communication.medium.coding.version
                      Definition

                      The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.

                      ShortVersion of the system - if relevant
                      Comments

                      Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.

                      NoteThis is a business version Id, not a resource version Id (see discussion)
                      Control0..1
                      Typestring
                      Is Modifierfalse
                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                      Summarytrue
                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      94. Communication.medium.coding.code
                      Definition

                      A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

                      ShortSymbol in syntax defined by the system
                      Control1..1
                      Typecode
                      Is Modifierfalse
                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                      Summarytrue
                      Requirements

                      Need to refer to a particular code in the system.

                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      96. Communication.medium.coding.display
                      Definition

                      A representation of the meaning of the code in the system, following the rules of the system.

                      ShortRepresentation defined by the system
                      Control0..1
                      Typestring
                      Is Modifierfalse
                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                      Summarytrue
                      Requirements

                      Need to be able to carry a human-readable meaning of the code for readers that do not know the system.

                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      98. Communication.medium.coding.userSelected
                      Definition

                      Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).

                      ShortIf this coding was chosen directly by the user
                      Comments

                      Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.

                      Control0..1
                      Typeboolean
                      Is Modifierfalse
                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                      Summarytrue
                      Requirements

                      This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.

                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      100. Communication.medium.text
                      Definition

                      A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.

                      ShortPlain text representation of the concept
                      Comments

                      Very often the text is the same as a displayName of one of the codings.

                      Control0..1
                      Typestring
                      Is Modifierfalse
                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                      Summarytrue
                      Requirements

                      The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.

                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      102. Communication.subject
                      Definition

                      The patient or group that was the focus of this communication.

                      ShortFocus of message
                      Control0..1
                      TypeReference(Patient, Group)
                      Is Modifierfalse
                      Summarytrue
                      Alternate Namespatient
                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      104. Communication.topic
                      Definition

                      Description of the purpose/content, similar to a subject line in an email.

                      ShortDescription of the purpose/content
                      Comments

                      Communication.topic.text can be used without any codings.

                      Control0..1
                      BindingFor example codes, see CommunicationTopic
                      (example to http://hl7.org/fhir/ValueSet/communication-topic|4.0.1)

                      Codes describing the purpose or content of the communication.

                      TypeCodeableConcept
                      Is Modifierfalse
                      Summaryfalse
                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      106. Communication.about
                      Definition

                      Other resources that pertain to this communication and to which this communication should be associated.

                      ShortResources that pertain to this communication
                      Comments

                      Don't use Communication.about element when a more specific element exists, such as basedOn or reasonReference.

                      Control0..*
                      TypeReference(Resource)
                      Is Modifierfalse
                      Summaryfalse
                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      108. Communication.encounter
                      Definition

                      The Encounter during which this Communication was created or to which the creation of this record is tightly associated.

                      ShortEncounter created as part of
                      Comments

                      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.

                      Control0..1
                      TypeReference(Encounter)
                      Is Modifierfalse
                      Summarytrue
                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      110. Communication.sent
                      Definition

                      Set by finalizeOutboundCommunication when the WhatsApp API accepts the outbound message.

                      ShortOutbound: WhatsApp API send timestamp
                      Control0..1
                      TypedateTime
                      Is Modifierfalse
                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                      Summaryfalse
                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      112. Communication.received
                      Definition

                      Set by buildInbound from the Meta webhook timestamp.

                      ShortInbound: webhook receipt timestamp
                      Control0..1
                      TypedateTime
                      Is Modifierfalse
                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                      Summaryfalse
                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      114. Communication.recipient
                      Definition

                      Always present. On outbound messages: set to the Patient. On inbound messages: set to the Organization.

                      ShortOpposite side of sender
                      Control1..*
                      TypeReference(Device, Organization, Patient, Practitioner, PractitionerRole, RelatedPerson, Group, CareTeam, HealthcareService)
                      Is Modifierfalse
                      Summaryfalse
                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      116. Communication.sender
                      Definition

                      Always present. On outbound messages: set to the Organization (sender). On inbound messages: set to a resolved Reference to Patient/Practitioner/RelatedPerson when identity is known, or an identifier-only Reference (phone or BSUID system) when identity is unresolved (before identity resolution).

                      ShortResolved Reference or identifier-only Reference (phone/BSUID)
                      Comments

                      When identity is unknown, sender carries identifier-only References (phone or BSUID system) rather than a resolved resource reference.

                      Control1..1
                      TypeReference(Device, Organization, Patient, Practitioner, PractitionerRole, RelatedPerson, HealthcareService)
                      Is Modifierfalse
                      Summaryfalse
                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      118. Communication.reasonCode
                      Definition

                      The reason or justification for the communication.

                      ShortIndication for message
                      Comments

                      Textual reasons can be captured using reasonCode.text.

                      Control0..*
                      BindingFor example codes, see SNOMEDCTClinicalFindings
                      (example to http://hl7.org/fhir/ValueSet/clinical-findings|4.0.1)

                      Codes for describing reasons for the occurrence of a communication.

                      TypeCodeableConcept
                      Is Modifierfalse
                      Summarytrue
                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      120. Communication.reasonReference
                      Definition

                      Indicates another resource whose existence justifies this communication.

                      ShortWhy was communication done?
                      Control0..*
                      TypeReference(Condition, Observation, DiagnosticReport, DocumentReference)
                      Is Modifierfalse
                      Summarytrue
                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      122. Communication.payload
                      Definition

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

                      ShortMessage content
                      Control1..*
                      TypeBackboneElement
                      Is Modifierfalse
                      Summaryfalse
                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      124. Communication.payload.id
                      Definition

                      Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                      ShortUnique id for inter-element referencing
                      Control0..1
                      Typestring
                      Is Modifierfalse
                      XML FormatIn the XML format, this property is represented as an attribute.
                      Summaryfalse
                      126. Communication.payload.extension
                      Definition

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

                      ShortAdditional content defined by implementations
                      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.

                      Control0..*
                      TypeExtension
                      Is Modifierfalse
                      Summaryfalse
                      Alternate Namesextensions, user content
                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                      128. Communication.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 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).

                      ShortExtensions that cannot be ignored even if unrecognized
                      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.

                      Control0..*
                      TypeExtension
                      Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
                      Summarytrue
                      Requirements

                      Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

                      Alternate Namesextensions, user content, modifiers
                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                      130. Communication.payload.content[x]
                      Definition

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

                      ShortMessage part content
                      Control1..1
                      Typestring
                      [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                      Is Modifierfalse
                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                      Summaryfalse
                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      SlicingThis element introduces a set of slices on Communication.payload.content[x]. The slices areUnordered and Closed, and can be differentiated using the following discriminators:
                      • type @ $this
                      • 132. Communication.payload.content[x]:contentString
                        Slice NamecontentString
                        Definition

                        Set by the sidecar builders to the WhatsApp message text (or template body).

                        ShortMessage text
                        Control1..1
                        Typestring
                        [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                        Is Modifierfalse
                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                        Summaryfalse
                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        134. Communication.note
                        Definition

                        Additional notes or commentary about the communication by the sender, receiver or other interested parties.

                        ShortComments made about the communication
                        Control0..*
                        TypeAnnotation
                        Is Modifierfalse
                        Summaryfalse
                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))