Extensions for Using Data Elements from FHIR DSTU2 in FHIR R4
0.1.0 - STU International flag

Extensions for Using Data Elements from FHIR DSTU2 in FHIR R4 - Downloaded Version null See the Directory of published versions

Resource Profile: Profile_R2_Communication_R4 - Detailed Descriptions

Page standards status: Trial-use Maturity Level: 0

Definitions for the profile-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.

ShortA 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())
dom-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()))
ele-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())
ele-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.status
Definition

The status of the transmission.

Shortpreparation | 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()))
ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
8. Communication.status.extension
Definition

An Extension


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.

ShortExtensionAdditional 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())
ele-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.status.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
  • value @ url
  • 10. Communication.status.extension:status
    Slice Namestatus
    Definition

    DSTU2: Communication.status additional codes

    ShortDSTU2: in-progress | completed | suspended | rejected | failed additional codes
    Comments

    Element Communication.status is mapped to FHIR R4 element Communication.status as RelatedTo. The mappings for Communication.status do not allow expression of the necessary codes, per the bindings on the source and target. The target context Communication.status is a modifier element, so this extension does not need to be defined as a modifier.

    Control0..1
    This element is affected by the following invariants: ele-1
    TypeExtension(DSTU2: in-progress | completed | suspended | rejected | failed additional codes) (Extension Type: code)
    Is Modifierfalse
    Summaryfalse
    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())
    ele-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())

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

    0. Communication
    2. Communication.meta
    4. Communication.meta.extension
    Control0..*
    SlicingThis element introduces a set of slices on Communication.meta.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
    • value @ url
    • 6. Communication.meta.extension:meta
      Slice Namemeta
      Definition

      DSTU2: Communication.meta additional types (Meta) additional types from child elements (lastUpdated, profile, security, tag, versionId)

      ShortDSTU2: meta additional types
      Comments

      Element Communication.meta is mapped to FHIR R4 element Communication.meta as SourceIsBroaderThanTarget. The mappings for Communication.meta do not cover the following types: Meta. The mappings for Communication.meta do not cover the following types based on type expansion: lastUpdated, profile, security, tag, versionId.

      Control0..1
      TypeExtension(DSTU2: meta additional types) (Extension Type: Meta)
      8. Communication.text
      10. Communication.text.extension
      Control0..*
      SlicingThis element introduces a set of slices on Communication.text.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
      • value @ url
      • 12. Communication.text.extension:text
        Slice Nametext
        Definition

        DSTU2: Communication.text additional types (Narrative) additional types from child elements (div, status)

        ShortDSTU2: text additional types
        Comments

        Element Communication.text is mapped to FHIR R4 element Communication.text as SourceIsBroaderThanTarget. The mappings for Communication.text do not cover the following types: Narrative. The mappings for Communication.text do not cover the following types based on type expansion: div, status. Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative.

        Control0..1
        TypeExtension(DSTU2: text additional types) (Complex Extension)
        14. Communication.identifier
        NoteThis is a business identifier, not a resource identifier (see discussion)
        16. Communication.identifier.extension
        Control0..*
        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
        • 18. Communication.identifier.extension:identifier
          Slice Nameidentifier
          Definition

          DSTU2: Communication.identifier additional types (Identifier) additional types from child elements (assigner, period, system, type, use, value)

          ShortDSTU2: identifier additional types
          Comments

          Element Communication.identifier is mapped to FHIR R4 element Communication.identifier as SourceIsBroaderThanTarget. The mappings for Communication.identifier do not cover the following types: Identifier. The mappings for Communication.identifier do not cover the following types based on type expansion: assigner, period, system, type, use, value.

          Control0..*
          TypeExtension(DSTU2: identifier additional types) (Extension Type: Identifier)
          20. Communication.basedOn
          22. Communication.basedOn.extension
          Control0..*
          SlicingThis element introduces a set of slices on Communication.basedOn.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
          • value @ url
          • 24. Communication.basedOn.extension:requestDetail
            Slice NamerequestDetail
            Definition

            DSTU2: Communication.requestDetail additional types from child elements (display, reference)

            ShortDSTU2: CommunicationRequest producing this message additional types
            Comments

            Element Communication.requestDetail is mapped to FHIR R4 element Communication.basedOn as RelatedTo. The mappings for Communication.requestDetail do not cover the following types based on type expansion: display, reference. The standard extension alternate-reference has been mapped as the representation of FHIR DSTU2 element Communication.requestDetail with unmapped reference targets: CommunicationRequest.

            Control0..1
            TypeExtension(Alternate Reference) (Extension Type: Reference(Resource))
            26. Communication.status
            28. Communication.status.extension
            Control0..*
            SlicingThis element introduces a set of slices on Communication.status.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
            • value @ url
            • 30. Communication.status.extension:status
              Slice Namestatus
              Definition

              DSTU2: Communication.status additional codes

              ShortDSTU2: in-progress | completed | suspended | rejected | failed additional codes
              Comments

              Element Communication.status is mapped to FHIR R4 element Communication.status as RelatedTo. The mappings for Communication.status do not allow expression of the necessary codes, per the bindings on the source and target. The target context Communication.status is a modifier element, so this extension does not need to be defined as a modifier.

              Control0..1
              TypeExtension(DSTU2: in-progress | completed | suspended | rejected | failed additional codes) (Extension Type: code)
              32. Communication.subject
              34. Communication.subject.extension
              Control0..*
              SlicingThis element introduces a set of slices on Communication.subject.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
              • value @ url
              • 36. Communication.subject.extension:subject
                Slice Namesubject
                Definition

                DSTU2: Communication.subject additional types from child elements (display, reference)

                ShortDSTU2: subject additional types
                Comments

                Element Communication.subject is mapped to FHIR R4 element Communication.subject as SourceIsBroaderThanTarget. The mappings for Communication.subject do not cover the following types based on type expansion: display, reference. The standard extension alternate-reference has been mapped as the representation of FHIR DSTU2 element Communication.subject with unmapped reference targets: Patient.

                Control0..1
                TypeExtension(Alternate Reference) (Extension Type: Reference(Resource))
                38. Communication.encounter
                40. Communication.encounter.extension
                Control0..*
                SlicingThis element introduces a set of slices on Communication.encounter.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                • value @ url
                • 42. Communication.encounter.extension:encounter
                  Slice Nameencounter
                  Definition

                  DSTU2: Communication.encounter additional types from child elements (display, reference)

                  ShortDSTU2: Encounter leading to message additional types
                  Comments

                  Element Communication.encounter is mapped to FHIR R4 element Communication.encounter as SourceIsBroaderThanTarget. The mappings for Communication.encounter do not cover the following types based on type expansion: display, reference. The standard extension alternate-reference has been mapped as the representation of FHIR DSTU2 element Communication.encounter with unmapped reference targets: Encounter.

                  Control0..1
                  TypeExtension(Alternate Reference) (Extension Type: Reference(Resource))
                  44. Communication.recipient
                  46. Communication.recipient.extension
                  Control0..*
                  SlicingThis element introduces a set of slices on Communication.recipient.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                  • value @ url
                  • 48. Communication.recipient.extension:recipient
                    Slice Namerecipient
                    Definition

                    DSTU2: Communication.recipient

                    ShortDSTU2: recipient
                    Comments

                    Element Communication.recipient is mapped to FHIR R4 element Communication.recipient as RelatedTo. The standard extension alternate-reference has been mapped as the representation of FHIR DSTU2 element Communication.recipient with unmapped reference targets: Device, Group, Organization, Patient, Practitioner, RelatedPerson.

                    Control0..*
                    TypeExtension(Alternate Reference) (Extension Type: Reference(Resource))
                    50. Communication.sender
                    52. Communication.sender.extension
                    Control0..*
                    SlicingThis element introduces a set of slices on Communication.sender.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                    • value @ url
                    • 54. Communication.sender.extension:sender
                      Slice Namesender
                      Definition

                      DSTU2: Communication.sender

                      ShortDSTU2: sender
                      Comments

                      Element Communication.sender is mapped to FHIR R4 element Communication.sender as RelatedTo. The standard extension alternate-reference has been mapped as the representation of FHIR DSTU2 element Communication.sender with unmapped reference targets: Device, Organization, Patient, Practitioner, RelatedPerson.

                      Control0..1
                      TypeExtension(Alternate Reference) (Extension Type: Reference(Resource))
                      56. Communication.payload
                      58. Communication.payload.extension
                      Control0..*
                      SlicingThis element introduces a set of slices on Communication.payload.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                      • value @ url
                      • 60. Communication.payload.extension:content
                        Slice Namecontent
                        Definition

                        DSTU2: Communication.payload.content[x] additional types (Attachment)

                        ShortDSTU2: content additional types
                        Comments

                        Element Communication.payload.content[x] is mapped to FHIR R4 element Communication.payload.content[x] as SourceIsBroaderThanTarget. The mappings for Communication.payload.content[x] do not cover the following types: Attachment. The target context Communication.payload.content[x] is a choice-type element and cannot directly hold extensions. The context is moved up to parent element Communication.payload. The standard extension alternate-reference has been mapped as PART of the representation of FHIR DSTU2 element Communication.payload.content[x] with unmapped reference targets: Resource. Source element Communication.payload.content[x] has unmapped reference types. While the target element Communication.payload.content[x] is a choice type and does not allow extensions, the alternate-reference extension can be applied to Reference values within it.

                        Control0..1
                        TypeExtension(DSTU2: content additional types) (Extension Type: Attachment)
                        62. Communication.payload.contentReference
                        64. Communication.payload.contentReference.extension:alternateReference
                        Slice NamealternateReference
                        Definition

                        DSTU2: Communication.payload.content[x] additional types (Attachment)

                        ShortDSTU2: content additional types
                        Comments

                        Element Communication.payload.content[x] is mapped to FHIR R4 element Communication.payload.content[x] as SourceIsBroaderThanTarget. The mappings for Communication.payload.content[x] do not cover the following types: Attachment. The target context Communication.payload.content[x] is a choice-type element and cannot directly hold extensions. The context is moved up to parent element Communication.payload. The standard extension alternate-reference has been mapped as PART of the representation of FHIR DSTU2 element Communication.payload.content[x] with unmapped reference targets: Resource. Source element Communication.payload.content[x] has unmapped reference types. While the target element Communication.payload.content[x] is a choice type and does not allow extensions, the alternate-reference extension can be applied to Reference values within it.

                        TypeExtension(Alternate Reference) (Extension Type: Reference(Resource))

                        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.

                        ShortA 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.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.meta.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
                        8. Communication.meta.extension
                        Definition

                        An Extension

                        ShortExtension
                        Control0..*
                        TypeExtension
                        Is Modifierfalse
                        Summaryfalse
                        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.meta.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                        • value @ url
                        • 10. Communication.meta.extension:meta
                          Slice Namemeta
                          Definition

                          DSTU2: Communication.meta additional types (Meta) additional types from child elements (lastUpdated, profile, security, tag, versionId)

                          ShortDSTU2: meta additional types
                          Comments

                          Element Communication.meta is mapped to FHIR R4 element Communication.meta as SourceIsBroaderThanTarget. The mappings for Communication.meta do not cover the following types: Meta. The mappings for Communication.meta do not cover the following types based on type expansion: lastUpdated, profile, security, tag, versionId.

                          Control0..1
                          TypeExtension(DSTU2: meta additional types) (Extension Type: Meta)
                          Is Modifierfalse
                          Summaryfalse
                          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())
                          12. Communication.meta.versionId
                          Definition

                          The version specific identifier, as it appears in the version portion of the URL. This value changes when the resource is created, updated, or deleted.

                          ShortVersion specific identifier
                          Comments

                          The server assigns this value, and ignores what the client specifies, except in the case that the server is imposing version integrity on updates/deletes.

                          Control0..1
                          Typeid
                          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()))
                          14. Communication.meta.lastUpdated
                          Definition

                          When the resource last changed - e.g. when the version changed.

                          ShortWhen the resource version last changed
                          Comments

                          This value is always populated except when the resource is first being created. The server / resource manager sets this value; what a client provides is irrelevant. This is equivalent to the HTTP Last-Modified and SHOULD have the same value on a read interaction.

                          Control0..1
                          Typeinstant
                          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()))
                          16. Communication.meta.source
                          Definition

                          A uri that identifies the source system of the resource. This provides a minimal amount of Provenance information that can be used to track or differentiate the source of information in the resource. The source may identify another FHIR server, document, message, database, etc.

                          ShortIdentifies where the resource comes from
                          Comments

                          In the provenance resource, this corresponds to Provenance.entity.what[x]. The exact use of the source (and the implied Provenance.entity.role) is left to implementer discretion. Only one nominated source is allowed; for additional provenance details, a full Provenance resource should be used.

                          This element can be used to indicate where the current master source of a resource that has a canonical URL if the resource is no longer hosted at the canonical URL.

                          Control0..1
                          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()))
                          18. Communication.meta.profile
                          Definition

                          A list of profiles (references to StructureDefinition resources) that this resource claims to conform to. The URL is a reference to StructureDefinition.url.

                          ShortProfiles this resource claims to conform to
                          Comments

                          It is up to the server and/or other infrastructure of policy to determine whether/how these claims are verified and/or updated over time. The list of profile URLs is a set.

                          Control0..*
                          Typecanonical(StructureDefinition)
                          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()))
                          20. Communication.meta.security
                          Definition

                          Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure.

                          ShortSecurity Labels applied to this resource
                          Comments

                          The security labels can be updated without changing the stated version of the resource. The list of security labels is a set. Uniqueness is based the system/code, and version and display are ignored.

                          Control0..*
                          BindingUnless not suitable, these codes SHALL be taken from All Security Labels .
                          (extensible to http://hl7.org/fhir/ValueSet/security-labels|4.0.1)

                          Security Labels from the Healthcare Privacy and Security Classification System.

                          TypeCoding
                          Is Modifierfalse
                          Summarytrue
                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                          22. Communication.meta.tag
                          Definition

                          Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource.

                          ShortTags applied to this resource
                          Comments

                          The tags can be updated without changing the stated version of the resource. The list of tags is a set. Uniqueness is based the system/code, and version and display are ignored.

                          Control0..*
                          BindingFor example codes, see CommonTags
                          (example to http://hl7.org/fhir/ValueSet/common-tags|4.0.1)

                          Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".

                          TypeCoding
                          Is Modifierfalse
                          Summarytrue
                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                          24. 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()))
                          26. 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()))
                          28. 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()))
                          30. Communication.text.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
                          32. Communication.text.extension
                          Definition

                          An Extension

                          ShortExtension
                          Control0..*
                          TypeExtension
                          Is Modifierfalse
                          Summaryfalse
                          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.text.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                          • value @ url
                          • 34. Communication.text.extension:text
                            Slice Nametext
                            Definition

                            DSTU2: Communication.text additional types (Narrative) additional types from child elements (div, status)

                            ShortDSTU2: text additional types
                            Comments

                            Element Communication.text is mapped to FHIR R4 element Communication.text as SourceIsBroaderThanTarget. The mappings for Communication.text do not cover the following types: Narrative. The mappings for Communication.text do not cover the following types based on type expansion: div, status. Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative.

                            Control0..1
                            TypeExtension(DSTU2: text additional types) (Complex Extension)
                            Is Modifierfalse
                            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())
                            36. Communication.text.status
                            Definition

                            The status of the narrative - whether it's entirely generated (from just the defined data or the extensions too), or whether a human authored it and it may contain additional data.

                            Shortgenerated | extensions | additional | empty
                            Control1..1
                            BindingThe codes SHALL be taken from NarrativeStatus
                            (required to http://hl7.org/fhir/ValueSet/narrative-status|4.0.1)

                            The status of a resource narrative.

                            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()))
                            38. Communication.text.div
                            Definition

                            The actual narrative content, a stripped down version of XHTML.

                            ShortLimited xhtml content
                            Comments

                            The contents of the html element are an XHTML fragment containing only the basic html formatting elements described in chapters 7-11 and 15 of the HTML 4.0 standard, <a> elements (either name or href), images and internally contained stylesheets. The XHTML content SHALL NOT contain a head, a body, external stylesheet references, scripts, forms, base/link/xlink, frames, iframes and objects.

                            Control1..1
                            Typexhtml
                            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()))
                            txt-1: The narrative SHALL contain only the basic html formatting elements and attributes described in chapters 7-11 (except section 4 of chapter 9) and 15 of the HTML 4.0 standard, <a> elements (either name or href), images and internally contained style attributes (htmlChecks())
                            txt-2: The narrative SHALL have some non-whitespace content (htmlChecks())
                            40. 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
                            42. 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())
                            44. 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())
                            46. Communication.identifier
                            Definition

                            Business identifiers assigned to this communication by the performer or other systems which remain constant as the resource is updated and propagates from server to server.

                            ShortUnique 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)
                            Control0..*
                            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()))
                            48. Communication.identifier.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
                            50. Communication.identifier.extension
                            Definition

                            An Extension

                            ShortExtension
                            Control0..*
                            TypeExtension
                            Is Modifierfalse
                            Summaryfalse
                            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
                            • 52. Communication.identifier.extension:identifier
                              Slice Nameidentifier
                              Definition

                              DSTU2: Communication.identifier additional types (Identifier) additional types from child elements (assigner, period, system, type, use, value)

                              ShortDSTU2: identifier additional types
                              Comments

                              Element Communication.identifier is mapped to FHIR R4 element Communication.identifier as SourceIsBroaderThanTarget. The mappings for Communication.identifier do not cover the following types: Identifier. The mappings for Communication.identifier do not cover the following types based on type expansion: assigner, period, system, type, use, value.

                              Control0..*
                              TypeExtension(DSTU2: identifier additional types) (Extension Type: Identifier)
                              Is Modifierfalse
                              Summaryfalse
                              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())
                              54. Communication.identifier.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()))
                              56. Communication.identifier.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()))
                              58. Communication.identifier.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.

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

                              ExampleGeneral: http://www.acme.com/identifiers/patient
                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                              60. Communication.identifier.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.

                              Control0..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()))
                              62. Communication.identifier.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()))
                              64. Communication.identifier.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()))
                              66. 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()))
                              68. 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()))
                              70. 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()))
                              72. Communication.basedOn.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
                              74. Communication.basedOn.extension
                              Definition

                              An Extension

                              ShortExtension
                              Control0..*
                              TypeExtension
                              Is Modifierfalse
                              Summaryfalse
                              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.basedOn.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                              • value @ url
                              • 76. Communication.basedOn.extension:requestDetail
                                Slice NamerequestDetail
                                Definition

                                DSTU2: Communication.requestDetail additional types from child elements (display, reference)

                                ShortDSTU2: CommunicationRequest producing this message additional types
                                Comments

                                Element Communication.requestDetail is mapped to FHIR R4 element Communication.basedOn as RelatedTo. The mappings for Communication.requestDetail do not cover the following types based on type expansion: display, reference. The standard extension alternate-reference has been mapped as the representation of FHIR DSTU2 element Communication.requestDetail with unmapped reference targets: CommunicationRequest.

                                Control0..1
                                TypeExtension(Alternate Reference) (Extension Type: Reference(Resource))
                                Is Modifierfalse
                                Summaryfalse
                                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())
                                78. Communication.basedOn.reference
                                Definition

                                A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.

                                ShortLiteral reference, Relative, internal or absolute URL
                                Comments

                                Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server.

                                Control0..1
                                This element is affected by the following invariants: ref-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()))
                                80. Communication.basedOn.type
                                Definition

                                The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.

                                The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).

                                ShortType the reference refers to (e.g. "Patient")
                                Comments

                                This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified.

                                Control0..1
                                BindingUnless not suitable, these codes SHALL be taken from ResourceType .
                                (extensible to http://hl7.org/fhir/ValueSet/resource-types|4.0.1)

                                Aa resource (or, for logical models, the URI of the logical model).

                                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()))
                                82. Communication.basedOn.identifier
                                Definition

                                An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.

                                ShortLogical reference, when literal reference is not known
                                Comments

                                When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy.

                                When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference

                                Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it.

                                Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any).

                                NoteThis is a business identifier, not a resource identifier (see discussion)
                                Control0..1
                                TypeIdentifier
                                Is Modifierfalse
                                Summarytrue
                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                84. Communication.basedOn.display
                                Definition

                                Plain text narrative that identifies the resource in addition to the resource reference.

                                ShortText alternative for the resource
                                Comments

                                This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.

                                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()))
                                86. Communication.partOf
                                Definition

                                Part of this action.

                                ShortPart of this action
                                Control0..*
                                TypeReference(Resource)
                                Is Modifierfalse
                                Summarytrue
                                Alternate Namescontainer
                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                88. 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()))
                                90. Communication.status
                                Definition

                                The status of the transmission.

                                Shortpreparation | 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 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()))
                                92. Communication.status.id
                                Definition

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

                                Shortxml:id (or equivalent in JSON)
                                Control0..1
                                Typestring
                                Is Modifierfalse
                                XML FormatIn the XML format, this property is represented as an attribute.
                                Summaryfalse
                                94. Communication.status.extension
                                Definition

                                An Extension

                                ShortExtension
                                Control0..*
                                TypeExtension
                                Is Modifierfalse
                                Summaryfalse
                                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.status.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                • value @ url
                                • 96. Communication.status.extension:status
                                  Slice Namestatus
                                  Definition

                                  DSTU2: Communication.status additional codes

                                  ShortDSTU2: in-progress | completed | suspended | rejected | failed additional codes
                                  Comments

                                  Element Communication.status is mapped to FHIR R4 element Communication.status as RelatedTo. The mappings for Communication.status do not allow expression of the necessary codes, per the bindings on the source and target. The target context Communication.status is a modifier element, so this extension does not need to be defined as a modifier.

                                  Control0..1
                                  This element is affected by the following invariants: ele-1
                                  TypeExtension(DSTU2: in-progress | completed | suspended | rejected | failed additional codes) (Extension Type: code)
                                  Is Modifierfalse
                                  Summaryfalse
                                  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())
                                  98. Communication.status.value
                                  Definition

                                  Primitive value for code

                                  ShortPrimitive value for code
                                  Control0..1
                                  Typestring
                                  Is Modifierfalse
                                  XML FormatIn the XML format, this property is represented as an attribute.
                                  Summaryfalse
                                  100. 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()))
                                  102. Communication.category
                                  Definition

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

                                  ShortMessage category
                                  Comments

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

                                  Control0..*
                                  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()))
                                  104. 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()))
                                  106. Communication.medium
                                  Definition

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

                                  ShortA channel of communication
                                  Control0..*
                                  BindingFor example codes, see ParticipationMode (3.0.0)
                                  (example to http://terminology.hl7.org/ValueSet/v3-ParticipationMode|3.0.0)

                                  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()))
                                  108. 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()))
                                  110. Communication.subject.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
                                  112. Communication.subject.extension
                                  Definition

                                  An Extension

                                  ShortExtension
                                  Control0..*
                                  TypeExtension
                                  Is Modifierfalse
                                  Summaryfalse
                                  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.subject.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                  • value @ url
                                  • 114. Communication.subject.extension:subject
                                    Slice Namesubject
                                    Definition

                                    DSTU2: Communication.subject additional types from child elements (display, reference)

                                    ShortDSTU2: subject additional types
                                    Comments

                                    Element Communication.subject is mapped to FHIR R4 element Communication.subject as SourceIsBroaderThanTarget. The mappings for Communication.subject do not cover the following types based on type expansion: display, reference. The standard extension alternate-reference has been mapped as the representation of FHIR DSTU2 element Communication.subject with unmapped reference targets: Patient.

                                    Control0..1
                                    TypeExtension(Alternate Reference) (Extension Type: Reference(Resource))
                                    Is Modifierfalse
                                    Summaryfalse
                                    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())
                                    116. Communication.subject.reference
                                    Definition

                                    A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.

                                    ShortLiteral reference, Relative, internal or absolute URL
                                    Comments

                                    Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server.

                                    Control0..1
                                    This element is affected by the following invariants: ref-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()))
                                    118. Communication.subject.type
                                    Definition

                                    The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.

                                    The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).

                                    ShortType the reference refers to (e.g. "Patient")
                                    Comments

                                    This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified.

                                    Control0..1
                                    BindingUnless not suitable, these codes SHALL be taken from ResourceType .
                                    (extensible to http://hl7.org/fhir/ValueSet/resource-types|4.0.1)

                                    Aa resource (or, for logical models, the URI of the logical model).

                                    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()))
                                    120. Communication.subject.identifier
                                    Definition

                                    An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.

                                    ShortLogical reference, when literal reference is not known
                                    Comments

                                    When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy.

                                    When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference

                                    Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it.

                                    Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any).

                                    NoteThis is a business identifier, not a resource identifier (see discussion)
                                    Control0..1
                                    TypeIdentifier
                                    Is Modifierfalse
                                    Summarytrue
                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                    122. Communication.subject.display
                                    Definition

                                    Plain text narrative that identifies the resource in addition to the resource reference.

                                    ShortText alternative for the resource
                                    Comments

                                    This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.

                                    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()))
                                    124. 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()))
                                    126. 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()))
                                    128. 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()))
                                    130. Communication.encounter.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
                                    132. Communication.encounter.extension
                                    Definition

                                    An Extension

                                    ShortExtension
                                    Control0..*
                                    TypeExtension
                                    Is Modifierfalse
                                    Summaryfalse
                                    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.encounter.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                    • value @ url
                                    • 134. Communication.encounter.extension:encounter
                                      Slice Nameencounter
                                      Definition

                                      DSTU2: Communication.encounter additional types from child elements (display, reference)

                                      ShortDSTU2: Encounter leading to message additional types
                                      Comments

                                      Element Communication.encounter is mapped to FHIR R4 element Communication.encounter as SourceIsBroaderThanTarget. The mappings for Communication.encounter do not cover the following types based on type expansion: display, reference. The standard extension alternate-reference has been mapped as the representation of FHIR DSTU2 element Communication.encounter with unmapped reference targets: Encounter.

                                      Control0..1
                                      TypeExtension(Alternate Reference) (Extension Type: Reference(Resource))
                                      Is Modifierfalse
                                      Summaryfalse
                                      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())
                                      136. Communication.encounter.reference
                                      Definition

                                      A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.

                                      ShortLiteral reference, Relative, internal or absolute URL
                                      Comments

                                      Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server.

                                      Control0..1
                                      This element is affected by the following invariants: ref-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()))
                                      138. Communication.encounter.type
                                      Definition

                                      The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.

                                      The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).

                                      ShortType the reference refers to (e.g. "Patient")
                                      Comments

                                      This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified.

                                      Control0..1
                                      BindingUnless not suitable, these codes SHALL be taken from ResourceType .
                                      (extensible to http://hl7.org/fhir/ValueSet/resource-types|4.0.1)

                                      Aa resource (or, for logical models, the URI of the logical model).

                                      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()))
                                      140. Communication.encounter.identifier
                                      Definition

                                      An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.

                                      ShortLogical reference, when literal reference is not known
                                      Comments

                                      When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy.

                                      When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference

                                      Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it.

                                      Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any).

                                      NoteThis is a business identifier, not a resource identifier (see discussion)
                                      Control0..1
                                      TypeIdentifier
                                      Is Modifierfalse
                                      Summarytrue
                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                      142. Communication.encounter.display
                                      Definition

                                      Plain text narrative that identifies the resource in addition to the resource reference.

                                      ShortText alternative for the resource
                                      Comments

                                      This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.

                                      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()))
                                      144. Communication.sent
                                      Definition

                                      The time when this communication was sent.

                                      ShortWhen 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()))
                                      146. Communication.received
                                      Definition

                                      The time when this communication arrived at the destination.

                                      ShortWhen 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()))
                                      148. Communication.recipient
                                      Definition

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

                                      ShortMessage recipient
                                      Control0..*
                                      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()))
                                      150. Communication.recipient.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
                                      152. Communication.recipient.extension
                                      Definition

                                      An Extension

                                      ShortExtension
                                      Control0..*
                                      TypeExtension
                                      Is Modifierfalse
                                      Summaryfalse
                                      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.recipient.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                      • value @ url
                                      • 154. Communication.recipient.extension:recipient
                                        Slice Namerecipient
                                        Definition

                                        DSTU2: Communication.recipient

                                        ShortDSTU2: recipient
                                        Comments

                                        Element Communication.recipient is mapped to FHIR R4 element Communication.recipient as RelatedTo. The standard extension alternate-reference has been mapped as the representation of FHIR DSTU2 element Communication.recipient with unmapped reference targets: Device, Group, Organization, Patient, Practitioner, RelatedPerson.

                                        Control0..1
                                        TypeExtension(Alternate Reference) (Extension Type: Reference(Resource))
                                        Is Modifierfalse
                                        Summaryfalse
                                        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())
                                        156. Communication.recipient.reference
                                        Definition

                                        A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.

                                        ShortLiteral reference, Relative, internal or absolute URL
                                        Comments

                                        Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server.

                                        Control0..1
                                        This element is affected by the following invariants: ref-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()))
                                        158. Communication.recipient.type
                                        Definition

                                        The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.

                                        The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).

                                        ShortType the reference refers to (e.g. "Patient")
                                        Comments

                                        This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified.

                                        Control0..1
                                        BindingUnless not suitable, these codes SHALL be taken from ResourceType .
                                        (extensible to http://hl7.org/fhir/ValueSet/resource-types|4.0.1)

                                        Aa resource (or, for logical models, the URI of the logical model).

                                        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()))
                                        160. Communication.recipient.identifier
                                        Definition

                                        An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.

                                        ShortLogical reference, when literal reference is not known
                                        Comments

                                        When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy.

                                        When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference

                                        Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it.

                                        Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any).

                                        NoteThis is a business identifier, not a resource identifier (see discussion)
                                        Control0..1
                                        TypeIdentifier
                                        Is Modifierfalse
                                        Summarytrue
                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                        162. Communication.recipient.display
                                        Definition

                                        Plain text narrative that identifies the resource in addition to the resource reference.

                                        ShortText alternative for the resource
                                        Comments

                                        This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.

                                        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()))
                                        164. Communication.sender
                                        Definition

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

                                        ShortMessage sender
                                        Control0..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()))
                                        166. Communication.sender.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
                                        168. Communication.sender.extension
                                        Definition

                                        An Extension

                                        ShortExtension
                                        Control0..*
                                        TypeExtension
                                        Is Modifierfalse
                                        Summaryfalse
                                        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.sender.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                        • value @ url
                                        • 170. Communication.sender.extension:sender
                                          Slice Namesender
                                          Definition

                                          DSTU2: Communication.sender

                                          ShortDSTU2: sender
                                          Comments

                                          Element Communication.sender is mapped to FHIR R4 element Communication.sender as RelatedTo. The standard extension alternate-reference has been mapped as the representation of FHIR DSTU2 element Communication.sender with unmapped reference targets: Device, Organization, Patient, Practitioner, RelatedPerson.

                                          Control0..1
                                          TypeExtension(Alternate Reference) (Extension Type: Reference(Resource))
                                          Is Modifierfalse
                                          Summaryfalse
                                          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())
                                          172. Communication.sender.reference
                                          Definition

                                          A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.

                                          ShortLiteral reference, Relative, internal or absolute URL
                                          Comments

                                          Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server.

                                          Control0..1
                                          This element is affected by the following invariants: ref-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()))
                                          174. Communication.sender.type
                                          Definition

                                          The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.

                                          The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).

                                          ShortType the reference refers to (e.g. "Patient")
                                          Comments

                                          This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified.

                                          Control0..1
                                          BindingUnless not suitable, these codes SHALL be taken from ResourceType .
                                          (extensible to http://hl7.org/fhir/ValueSet/resource-types|4.0.1)

                                          Aa resource (or, for logical models, the URI of the logical model).

                                          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()))
                                          176. Communication.sender.identifier
                                          Definition

                                          An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.

                                          ShortLogical reference, when literal reference is not known
                                          Comments

                                          When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy.

                                          When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference

                                          Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it.

                                          Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any).

                                          NoteThis is a business identifier, not a resource identifier (see discussion)
                                          Control0..1
                                          TypeIdentifier
                                          Is Modifierfalse
                                          Summarytrue
                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                          178. Communication.sender.display
                                          Definition

                                          Plain text narrative that identifies the resource in addition to the resource reference.

                                          ShortText alternative for the resource
                                          Comments

                                          This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.

                                          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()))
                                          180. 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()))
                                          182. 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()))
                                          184. Communication.payload
                                          Definition

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

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

                                          An Extension

                                          ShortExtension
                                          Control0..*
                                          TypeExtension
                                          Is Modifierfalse
                                          Summaryfalse
                                          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.payload.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                          • value @ url
                                          • 190. Communication.payload.extension:content
                                            Slice Namecontent
                                            Definition

                                            DSTU2: Communication.payload.content[x] additional types (Attachment)

                                            ShortDSTU2: content additional types
                                            Comments

                                            Element Communication.payload.content[x] is mapped to FHIR R4 element Communication.payload.content[x] as SourceIsBroaderThanTarget. The mappings for Communication.payload.content[x] do not cover the following types: Attachment. The target context Communication.payload.content[x] is a choice-type element and cannot directly hold extensions. The context is moved up to parent element Communication.payload. The standard extension alternate-reference has been mapped as PART of the representation of FHIR DSTU2 element Communication.payload.content[x] with unmapped reference targets: Resource. Source element Communication.payload.content[x] has unmapped reference types. While the target element Communication.payload.content[x] is a choice type and does not allow extensions, the alternate-reference extension can be applied to Reference values within it.

                                            Control0..1
                                            This element is affected by the following invariants: ele-1
                                            TypeExtension(DSTU2: content additional types) (Extension Type: Attachment)
                                            Is Modifierfalse
                                            Summaryfalse
                                            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())
                                            192. 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())
                                            194. Communication.payload.content[x]
                                            Definition

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

                                            ShortMessage part content
                                            Control1..1
                                            TypeChoice of: string, Attachment, Reference(Resource)
                                            [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()))
                                            196. Communication.payload.content[x].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
                                            198. Communication.payload.content[x].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.payload.content[x].extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                            • value @ url
                                            • 200. Communication.payload.content[x].extension:alternateReference
                                              Slice NamealternateReference
                                              Definition

                                              DSTU2: Communication.payload.content[x] additional types (Attachment)

                                              ShortDSTU2: content additional types
                                              Comments

                                              Element Communication.payload.content[x] is mapped to FHIR R4 element Communication.payload.content[x] as SourceIsBroaderThanTarget. The mappings for Communication.payload.content[x] do not cover the following types: Attachment. The target context Communication.payload.content[x] is a choice-type element and cannot directly hold extensions. The context is moved up to parent element Communication.payload. The standard extension alternate-reference has been mapped as PART of the representation of FHIR DSTU2 element Communication.payload.content[x] with unmapped reference targets: Resource. Source element Communication.payload.content[x] has unmapped reference types. While the target element Communication.payload.content[x] is a choice type and does not allow extensions, the alternate-reference extension can be applied to Reference values within it.

                                              Control0..1
                                              TypeExtension(Alternate Reference) (Extension Type: Reference(Resource))
                                              Is Modifierfalse
                                              Summaryfalse
                                              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())
                                              202. 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()))