Extensions for Using Data Elements from FHIR STU3 in FHIR R4B
0.1.0 - STU International flag

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

Resource Profile: Profile_R3_CommunicationRequest_R4B - Detailed Descriptions

Page standards status: Trial-use Maturity Level: 0

Definitions for the profile-CommunicationRequest resource profile.

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

0. CommunicationRequest
Definition

A request to convey information; e.g. the CDS system proposes that an alert be sent to a responsible provider, the CDS system proposes that the public health agency be notified about a reportable condition.

ShortA request for information to be sent to a receiver
Control0..*
Is Modifierfalse
Must Supportfalse
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.exists() and ('#'+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(uri) = '#').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.exists() and ('#'+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(uri) = '#').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. CommunicationRequest.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
Must Supportfalse
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. CommunicationRequest.extension
Definition

An Extension


May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

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
Must Supportfalse
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 CommunicationRequest.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
  • value @ url
  • 6. CommunicationRequest.extension:topic
    Slice Nametopic
    Definition

    STU3: CommunicationRequest.topic (new:Reference(Resource))

    ShortSTU3: Focal resources (new)
    Comments

    Element CommunicationRequest.topic has a context of CommunicationRequest based on following the parent source element upwards and mapping to CommunicationRequest. Element CommunicationRequest.topic has no mapping targets in FHIR R4B. Typically, this is because the element has been added (is a new element).

    Control0..*
    This element is affected by the following invariants: ele-1
    TypeExtension(STU3: Focal resources (new)) (Extension Type: Reference(Cross-version Profile for STU3.Resource for use in FHIR R4B, Resource))
    Is Modifierfalse
    Must Supportfalse
    Summaryfalse
    Invariantsele-1: All FHIR elements must have a @value or children unless an empty Parameters resource (hasValue() or (children().count() > id.count()) or $this is Parameters)
    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())
    8. CommunicationRequest.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
    Must Supportfalse
    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())
    10. CommunicationRequest.status
    Definition

    The status of the proposal or order.

    Shortdraft | active | on-hold | revoked | completed | entered-in-error | unknown
    Control1..1
    BindingThe codes SHALL be taken from RequestStatushttp://hl7.org/fhir/ValueSet/request-status|4.3.0
    (required to http://hl7.org/fhir/ValueSet/request-status|4.3.0)

    The status of the communication request.

    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
    Must Supportfalse
    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()))
    12. CommunicationRequest.doNotPerform
    Definition

    If true indicates that the CommunicationRequest is asking for the specified action to not occur.

    ShortTrue if request is prohibiting action
    Comments

    The attributes provided with the request qualify what is not to be done.

    Control0..1
    Typeboolean
    Is Modifiertrue because If true this element negates the specified action. For Example, instead of a request for a communication, it is a request for the communication to not occur.
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Must Supportfalse
    Summarytrue
    Alternate Namesprohibited
    Meaning if MissingIf do not perform is not specified, the request is a positive request e.g. "do perform"
    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()))

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

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

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

      ShortSTU3: meta additional types
      Comments

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

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

        STU3: CommunicationRequest.text additional types (Narrative) additional types from child elements (div, status)

        ShortSTU3: text additional types
        Comments

        Element CommunicationRequest.text is mapped to FHIR R4B element CommunicationRequest.text as SourceIsBroaderThanTarget. The mappings for CommunicationRequest.text do not cover the following types: Narrative. The mappings for CommunicationRequest.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. 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 in formation is added later.

        Control0..1
        TypeExtension(STU3: text additional types) (Complex Extension)
        14. CommunicationRequest.extension
        Control0..*
        SlicingThis element introduces a set of slices on CommunicationRequest.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
        • value @ url
        • 16. CommunicationRequest.extension:topic
          Slice Nametopic
          Definition

          STU3: CommunicationRequest.topic (new:Reference(Resource))

          ShortSTU3: Focal resources (new)
          Comments

          Element CommunicationRequest.topic has a context of CommunicationRequest based on following the parent source element upwards and mapping to CommunicationRequest. Element CommunicationRequest.topic has no mapping targets in FHIR R4B. Typically, this is because the element has been added (is a new element).

          Control0..*
          TypeExtension(STU3: Focal resources (new)) (Extension Type: Reference(Cross-version Profile for STU3.Resource for use in FHIR R4B, Resource))
          18. CommunicationRequest.identifier
          NoteThis is a business identifier, not a resource identifier (see discussion)
          20. CommunicationRequest.identifier.extension
          Control0..*
          SlicingThis element introduces a set of slices on CommunicationRequest.identifier.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
          • value @ url
          • 22. CommunicationRequest.identifier.extension:identifier
            Slice Nameidentifier
            Definition

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

            ShortSTU3: identifier additional types
            Comments

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

            Control0..*
            TypeExtension(STU3: identifier additional types) (Extension Type: Identifier)
            24. CommunicationRequest.basedOn
            26. CommunicationRequest.basedOn.extension
            Control0..*
            SlicingThis element introduces a set of slices on CommunicationRequest.basedOn.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
            • value @ url
            • 28. CommunicationRequest.basedOn.extension:basedOn
              Slice NamebasedOn
              Definition

              STU3: CommunicationRequest.basedOn additional types from child elements (display, identifier, reference)

              ShortSTU3: basedOn additional types
              Comments

              Element CommunicationRequest.basedOn is mapped to FHIR R4B element CommunicationRequest.basedOn as SourceIsBroaderThanTarget. The mappings for CommunicationRequest.basedOn do not cover the following types based on type expansion: display, identifier, reference. The standard extension alternate-reference has been mapped as the representation of FHIR STU3 element CommunicationRequest.basedOn with unmapped reference targets: Resource.

              Control0..*
              TypeExtension(Alternate Reference) (Extension Type: Reference(Resource))
              30. CommunicationRequest.replaces
              32. CommunicationRequest.replaces.extension
              Control0..*
              SlicingThis element introduces a set of slices on CommunicationRequest.replaces.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
              • value @ url
              • 34. CommunicationRequest.replaces.extension:replaces
                Slice Namereplaces
                Definition

                STU3: CommunicationRequest.replaces additional types from child elements (display, identifier, reference)

                ShortSTU3: replaces additional types
                Comments

                Element CommunicationRequest.replaces is mapped to FHIR R4B element CommunicationRequest.replaces as SourceIsBroaderThanTarget. The mappings for CommunicationRequest.replaces do not cover the following types based on type expansion: display, identifier, reference. The standard extension alternate-reference has been mapped as the representation of FHIR STU3 element CommunicationRequest.replaces with unmapped reference targets: CommunicationRequest. The replacement could be because the initial request was immediately rejected (due to an issue) or because the previous request was completed, but the need for the action described by the request remains ongoing.

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

                  STU3: CommunicationRequest.groupIdentifier additional types (Identifier) additional types from child elements (assigner, period, system, type, use, value)

                  ShortSTU3: groupIdentifier additional types
                  Comments

                  Element CommunicationRequest.groupIdentifier is mapped to FHIR R4B element CommunicationRequest.groupIdentifier as SourceIsBroaderThanTarget. The mappings for CommunicationRequest.groupIdentifier do not cover the following types: Identifier. The mappings for CommunicationRequest.groupIdentifier do not cover the following types based on type expansion: assigner, period, system, type, use, value. Requests are linked either by a "basedOn" relationship (i.e. one request is fulfilling another) or by having a common requisition. Requests that are part of the same requisition are generally treated independently from the perspective of changing their state or maintaining them after initial creation.

                  Control0..1
                  TypeExtension(STU3: groupIdentifier additional types) (Extension Type: Identifier)
                  42. CommunicationRequest.subject
                  44. CommunicationRequest.subject.extension
                  Control0..*
                  SlicingThis element introduces a set of slices on CommunicationRequest.subject.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                  • value @ url
                  • 46. CommunicationRequest.subject.extension:subject
                    Slice Namesubject
                    Definition

                    STU3: CommunicationRequest.subject additional types from child elements (display, identifier, reference)

                    ShortSTU3: subject additional types
                    Comments

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

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

                      STU3: CommunicationRequest.context additional types from child elements (display, identifier, reference)

                      ShortSTU3: Encounter or episode leading to message additional types
                      Comments

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

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

                        STU3: CommunicationRequest.payload.content[x] additional types (Attachment)

                        ShortSTU3: content additional types
                        Comments

                        Element CommunicationRequest.payload.content[x] is mapped to FHIR R4B element CommunicationRequest.payload.content[x] as SourceIsBroaderThanTarget. The mappings for CommunicationRequest.payload.content[x] do not cover the following types: Attachment. The target context CommunicationRequest.payload.content[x] is a choice-type element and cannot directly hold extensions. The context is moved up to parent element CommunicationRequest.payload. The standard extension alternate-reference has been mapped as PART of the representation of FHIR STU3 element CommunicationRequest.payload.content[x] with unmapped reference targets: Resource. Source element CommunicationRequest.payload.content[x] has unmapped reference types. While the target element CommunicationRequest.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(STU3: content additional types) (Extension Type: Attachment)
                        60. CommunicationRequest.payload.contentReference
                        62. CommunicationRequest.payload.contentReference.extension:alternateReference
                        Slice NamealternateReference
                        Definition

                        STU3: CommunicationRequest.payload.content[x] additional types (Attachment)

                        ShortSTU3: content additional types
                        Comments

                        Element CommunicationRequest.payload.content[x] is mapped to FHIR R4B element CommunicationRequest.payload.content[x] as SourceIsBroaderThanTarget. The mappings for CommunicationRequest.payload.content[x] do not cover the following types: Attachment. The target context CommunicationRequest.payload.content[x] is a choice-type element and cannot directly hold extensions. The context is moved up to parent element CommunicationRequest.payload. The standard extension alternate-reference has been mapped as PART of the representation of FHIR STU3 element CommunicationRequest.payload.content[x] with unmapped reference targets: Resource. Source element CommunicationRequest.payload.content[x] has unmapped reference types. While the target element CommunicationRequest.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))
                        64. CommunicationRequest.requester
                        66. CommunicationRequest.requester.extension
                        Control1..*
                        SlicingThis element introduces a set of slices on CommunicationRequest.requester.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                        • value @ url
                        • 68. CommunicationRequest.requester.extension:agent
                          Slice Nameagent
                          Definition

                          STU3: CommunicationRequest.requester.agent

                          ShortSTU3: Individual making the request
                          Comments

                          Element CommunicationRequest.requester.agent is mapped to FHIR R4B element CommunicationRequest.requester as SourceIsBroaderThanTarget. The standard extension alternate-reference has been mapped as the representation of FHIR STU3 element CommunicationRequest.requester.agent with unmapped reference targets: Device, Organization, Patient, Practitioner, RelatedPerson.

                          Control1..1
                          TypeExtension(Alternate Reference) (Extension Type: Reference(Resource))
                          70. CommunicationRequest.requester.extension:onBehalfOf
                          Slice NameonBehalfOf
                          Definition

                          STU3: CommunicationRequest.requester.onBehalfOf (new:Reference(Organization))

                          ShortSTU3: Organization agent is acting for (new)
                          Comments

                          Element CommunicationRequest.requester.onBehalfOf has a context of CommunicationRequest.requester based on following the parent source element upwards and mapping to CommunicationRequest. Element CommunicationRequest.requester.onBehalfOf has no mapping targets in FHIR R4B. Typically, this is because the element has been added (is a new element).

                          Control0..1
                          TypeExtension(STU3: Organization agent is acting for (new)) (Extension Type: Reference(Cross-version Profile for STU3.Organization for use in FHIR R4B, Organization))
                          72. CommunicationRequest.recipient
                          74. CommunicationRequest.recipient.extension
                          Control0..*
                          SlicingThis element introduces a set of slices on CommunicationRequest.recipient.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                          • value @ url
                          • 76. CommunicationRequest.recipient.extension:recipient
                            Slice Namerecipient
                            Definition

                            STU3: CommunicationRequest.recipient

                            ShortSTU3: recipient
                            Comments

                            Element CommunicationRequest.recipient is mapped to FHIR R4B element CommunicationRequest.recipient as SourceIsBroaderThanTarget. The standard extension alternate-reference has been mapped as the representation of FHIR STU3 element CommunicationRequest.recipient with unmapped reference targets: CareTeam, Device, Group, Organization, Patient, Practitioner, RelatedPerson.

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

                              STU3: CommunicationRequest.sender

                              ShortSTU3: sender
                              Comments

                              Element CommunicationRequest.sender is mapped to FHIR R4B element CommunicationRequest.sender as SourceIsBroaderThanTarget. The standard extension alternate-reference has been mapped as the representation of FHIR STU3 element CommunicationRequest.sender with unmapped reference targets: Device, Organization, Patient, Practitioner, RelatedPerson.

                              Control0..1
                              TypeExtension(Alternate Reference) (Extension Type: Reference(Resource))
                              84. CommunicationRequest.reasonReference
                              86. CommunicationRequest.reasonReference.extension
                              Control0..*
                              SlicingThis element introduces a set of slices on CommunicationRequest.reasonReference.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                              • value @ url
                              • 88. CommunicationRequest.reasonReference.extension:reasonReference
                                Slice NamereasonReference
                                Definition

                                STU3: CommunicationRequest.reasonReference additional types from child elements (display, identifier, reference)

                                ShortSTU3: reasonReference additional types
                                Comments

                                Element CommunicationRequest.reasonReference is mapped to FHIR R4B element CommunicationRequest.reasonReference as SourceIsBroaderThanTarget. The mappings for CommunicationRequest.reasonReference do not cover the following types based on type expansion: display, identifier, reference. The standard extension alternate-reference has been mapped as the representation of FHIR STU3 element CommunicationRequest.reasonReference with unmapped reference targets: Condition, Observation.

                                Control0..*
                                TypeExtension(Alternate Reference) (Extension Type: Reference(Resource))
                                90. CommunicationRequest.note
                                92. CommunicationRequest.note.extension
                                Control0..*
                                SlicingThis element introduces a set of slices on CommunicationRequest.note.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                • value @ url
                                • 94. CommunicationRequest.note.extension:note
                                  Slice Namenote
                                  Definition

                                  STU3: CommunicationRequest.note additional types (Annotation) additional types from child elements (author[x], text, time)

                                  ShortSTU3: note additional types
                                  Comments

                                  Element CommunicationRequest.note is mapped to FHIR R4B element CommunicationRequest.note as SourceIsBroaderThanTarget. The mappings for CommunicationRequest.note do not cover the following types: Annotation. The mappings for CommunicationRequest.note do not cover the following types based on type expansion: author[x], text, time.

                                  Control0..*
                                  TypeExtension(STU3: note additional types) (Extension Type: Annotation)

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

                                  0. CommunicationRequest
                                  Definition

                                  A request to convey information; e.g. the CDS system proposes that an alert be sent to a responsible provider, the CDS system proposes that the public health agency be notified about a reportable condition.

                                  ShortA request for information to be sent to a receiver
                                  Control0..*
                                  Is Modifierfalse
                                  Must Supportfalse
                                  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.exists() and ('#'+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(uri) = '#').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. CommunicationRequest.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
                                  Must Supportfalse
                                  Summarytrue
                                  4. CommunicationRequest.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
                                  Must Supportfalse
                                  Summarytrue
                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                  6. CommunicationRequest.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
                                  Typeid
                                  Is Modifierfalse
                                  XML FormatIn the XML format, this property is represented as an attribute.
                                  Summaryfalse
                                  8. CommunicationRequest.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 CommunicationRequest.meta.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                  • value @ url
                                  • 10. CommunicationRequest.meta.extension:meta
                                    Slice Namemeta
                                    Definition

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

                                    ShortSTU3: meta additional types
                                    Comments

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

                                    Control0..1
                                    TypeExtension(STU3: meta 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())
                                    12. CommunicationRequest.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. CommunicationRequest.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. CommunicationRequest.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. CommunicationRequest.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. CommunicationRequest.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.3.0)
                                    TypeCoding
                                    Is Modifierfalse
                                    Summarytrue
                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                    22. CommunicationRequest.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.3.0)
                                    TypeCoding
                                    Is Modifierfalse
                                    Summarytrue
                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                    24. CommunicationRequest.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
                                    Must Supportfalse
                                    Summarytrue
                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                    26. CommunicationRequest.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.3.0)

                                    IETF language tag

                                    Additional BindingsPurpose
                                    AllLanguagesMax Binding
                                    Typecode
                                    Is Modifierfalse
                                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                    Must Supportfalse
                                    Summaryfalse
                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                    28. CommunicationRequest.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
                                    Must Supportfalse
                                    Summaryfalse
                                    Alternate Namesnarrative, html, xhtml, display
                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                    30. CommunicationRequest.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
                                    Typeid
                                    Is Modifierfalse
                                    XML FormatIn the XML format, this property is represented as an attribute.
                                    Summaryfalse
                                    32. CommunicationRequest.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 CommunicationRequest.text.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                    • value @ url
                                    • 34. CommunicationRequest.text.extension:text
                                      Slice Nametext
                                      Definition

                                      STU3: CommunicationRequest.text additional types (Narrative) additional types from child elements (div, status)

                                      ShortSTU3: text additional types
                                      Comments

                                      Element CommunicationRequest.text is mapped to FHIR R4B element CommunicationRequest.text as SourceIsBroaderThanTarget. The mappings for CommunicationRequest.text do not cover the following types: Narrative. The mappings for CommunicationRequest.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. 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 in formation is added later.

                                      Control0..1
                                      TypeExtension(STU3: 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. CommunicationRequest.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.3.0)
                                      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. CommunicationRequest.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. CommunicationRequest.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
                                      Must Supportfalse
                                      Summaryfalse
                                      Alternate Namesinline resources, anonymous resources, contained resources
                                      Invariantsdom-r4b: Containing new R4B resources within R4 resources may cause interoperability issues if instances are shared with R4 systems (($this is Citation or $this is Evidence or $this is EvidenceReport or $this is EvidenceVariable or $this is MedicinalProductDefinition or $this is PackagedProductDefinition or $this is AdministrableProductDefinition or $this is Ingredient or $this is ClinicalUseDefinition or $this is RegulatedAuthorization or $this is SubstanceDefinition or $this is SubscriptionStatus or $this is SubscriptionTopic) implies (%resource is Citation or %resource is Evidence or %resource is EvidenceReport or %resource is EvidenceVariable or %resource is MedicinalProductDefinition or %resource is PackagedProductDefinition or %resource is AdministrableProductDefinition or %resource is Ingredient or %resource is ClinicalUseDefinition or %resource is RegulatedAuthorization or %resource is SubstanceDefinition or %resource is SubscriptionStatus or %resource is SubscriptionTopic))
                                      42. CommunicationRequest.extension
                                      Definition

                                      An Extension

                                      ShortExtension
                                      Control0..*
                                      TypeExtension
                                      Is Modifierfalse
                                      Must Supportfalse
                                      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 CommunicationRequest.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                      • value @ url
                                      • 44. CommunicationRequest.extension:topic
                                        Slice Nametopic
                                        Definition

                                        STU3: CommunicationRequest.topic (new:Reference(Resource))

                                        ShortSTU3: Focal resources (new)
                                        Comments

                                        Element CommunicationRequest.topic has a context of CommunicationRequest based on following the parent source element upwards and mapping to CommunicationRequest. Element CommunicationRequest.topic has no mapping targets in FHIR R4B. Typically, this is because the element has been added (is a new element).

                                        Control0..*
                                        This element is affected by the following invariants: ele-1
                                        TypeExtension(STU3: Focal resources (new)) (Extension Type: Reference(Cross-version Profile for STU3.Resource for use in FHIR R4B, Resource))
                                        Is Modifierfalse
                                        Must Supportfalse
                                        Summaryfalse
                                        Invariantsele-1: All FHIR elements must have a @value or children unless an empty Parameters resource (hasValue() or (children().count() > id.count()) or $this is Parameters)
                                        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                        46. CommunicationRequest.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
                                        Must Supportfalse
                                        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())
                                        48. CommunicationRequest.identifier
                                        Definition

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

                                        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
                                        Must Supportfalse
                                        Summarytrue
                                        Requirements

                                        Allows identification of the communication request 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()))
                                        50. CommunicationRequest.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
                                        Typeid
                                        Is Modifierfalse
                                        XML FormatIn the XML format, this property is represented as an attribute.
                                        Summaryfalse
                                        52. CommunicationRequest.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 CommunicationRequest.identifier.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                        • value @ url
                                        • 54. CommunicationRequest.identifier.extension:identifier
                                          Slice Nameidentifier
                                          Definition

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

                                          ShortSTU3: identifier additional types
                                          Comments

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

                                          Control0..*
                                          TypeExtension(STU3: 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())
                                          56. CommunicationRequest.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.3.0)
                                          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()))
                                          58. CommunicationRequest.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.3.0)
                                          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()))
                                          60. CommunicationRequest.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()))
                                          62. CommunicationRequest.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()))
                                          64. CommunicationRequest.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()))
                                          66. CommunicationRequest.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()))
                                          68. CommunicationRequest.basedOn
                                          Definition

                                          A plan or proposal that is fulfilled in whole or in part by this request.

                                          ShortFulfills plan or proposal
                                          Control0..*
                                          TypeReference(Resource)
                                          Is Modifierfalse
                                          Must Supportfalse
                                          Summarytrue
                                          Requirements

                                          Allows tracing of authorization for the request and tracking whether proposals/recommendations were acted upon.

                                          Alternate Namesfulfills
                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                          70. CommunicationRequest.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
                                          Typeid
                                          Is Modifierfalse
                                          XML FormatIn the XML format, this property is represented as an attribute.
                                          Summaryfalse
                                          72. CommunicationRequest.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 CommunicationRequest.basedOn.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                          • value @ url
                                          • 74. CommunicationRequest.basedOn.extension:basedOn
                                            Slice NamebasedOn
                                            Definition

                                            STU3: CommunicationRequest.basedOn additional types from child elements (display, identifier, reference)

                                            ShortSTU3: basedOn additional types
                                            Comments

                                            Element CommunicationRequest.basedOn is mapped to FHIR R4B element CommunicationRequest.basedOn as SourceIsBroaderThanTarget. The mappings for CommunicationRequest.basedOn do not cover the following types based on type expansion: display, identifier, reference. The standard extension alternate-reference has been mapped as the representation of FHIR STU3 element CommunicationRequest.basedOn with unmapped reference targets: Resource.

                                            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())
                                            76. CommunicationRequest.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()))
                                            78. CommunicationRequest.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.3.0)
                                            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()))
                                            80. CommunicationRequest.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()))
                                            82. CommunicationRequest.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()))
                                            84. CommunicationRequest.replaces
                                            Definition

                                            Completed or terminated request(s) whose function is taken by this new request.

                                            ShortRequest(s) replaced by this request
                                            Comments

                                            The replacement could be because the initial request was immediately rejected (due to an issue) or because the previous request was completed, but the need for the action described by the request remains ongoing.

                                            Control0..*
                                            TypeReference(CommunicationRequest)
                                            Is Modifierfalse
                                            Must Supportfalse
                                            Summarytrue
                                            Requirements

                                            Allows tracing the continuation of a therapy or administrative process instantiated through multiple requests.

                                            Alternate Namessupersedes, prior
                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                            86. CommunicationRequest.replaces.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
                                            Typeid
                                            Is Modifierfalse
                                            XML FormatIn the XML format, this property is represented as an attribute.
                                            Summaryfalse
                                            88. CommunicationRequest.replaces.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 CommunicationRequest.replaces.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                            • value @ url
                                            • 90. CommunicationRequest.replaces.extension:replaces
                                              Slice Namereplaces
                                              Definition

                                              STU3: CommunicationRequest.replaces additional types from child elements (display, identifier, reference)

                                              ShortSTU3: replaces additional types
                                              Comments

                                              Element CommunicationRequest.replaces is mapped to FHIR R4B element CommunicationRequest.replaces as SourceIsBroaderThanTarget. The mappings for CommunicationRequest.replaces do not cover the following types based on type expansion: display, identifier, reference. The standard extension alternate-reference has been mapped as the representation of FHIR STU3 element CommunicationRequest.replaces with unmapped reference targets: CommunicationRequest. The replacement could be because the initial request was immediately rejected (due to an issue) or because the previous request was completed, but the need for the action described by the request remains ongoing.

                                              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())
                                              92. CommunicationRequest.replaces.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()))
                                              94. CommunicationRequest.replaces.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.3.0)
                                              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()))
                                              96. CommunicationRequest.replaces.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()))
                                              98. CommunicationRequest.replaces.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()))
                                              100. CommunicationRequest.groupIdentifier
                                              Definition

                                              A shared identifier common to all requests that were authorized more or less simultaneously by a single author, representing the identifier of the requisition, prescription or similar form.

                                              ShortComposite request this is part of
                                              Comments

                                              Requests are linked either by a "basedOn" relationship (i.e. one request is fulfilling another) or by having a common requisition. Requests that are part of the same requisition are generally treated independently from the perspective of changing their state or maintaining them after initial creation.

                                              Control0..1
                                              TypeIdentifier
                                              Is Modifierfalse
                                              Must Supportfalse
                                              Summarytrue
                                              Alternate NamesgrouperId
                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                              102. CommunicationRequest.groupIdentifier.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
                                              Typeid
                                              Is Modifierfalse
                                              XML FormatIn the XML format, this property is represented as an attribute.
                                              Summaryfalse
                                              104. CommunicationRequest.groupIdentifier.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 CommunicationRequest.groupIdentifier.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                              • value @ url
                                              • 106. CommunicationRequest.groupIdentifier.extension:groupIdentifier
                                                Slice NamegroupIdentifier
                                                Definition

                                                STU3: CommunicationRequest.groupIdentifier additional types (Identifier) additional types from child elements (assigner, period, system, type, use, value)

                                                ShortSTU3: groupIdentifier additional types
                                                Comments

                                                Element CommunicationRequest.groupIdentifier is mapped to FHIR R4B element CommunicationRequest.groupIdentifier as SourceIsBroaderThanTarget. The mappings for CommunicationRequest.groupIdentifier do not cover the following types: Identifier. The mappings for CommunicationRequest.groupIdentifier do not cover the following types based on type expansion: assigner, period, system, type, use, value. Requests are linked either by a "basedOn" relationship (i.e. one request is fulfilling another) or by having a common requisition. Requests that are part of the same requisition are generally treated independently from the perspective of changing their state or maintaining them after initial creation.

                                                Control0..1
                                                TypeExtension(STU3: groupIdentifier 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())
                                                108. CommunicationRequest.groupIdentifier.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.3.0)
                                                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()))
                                                110. CommunicationRequest.groupIdentifier.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.3.0)
                                                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()))
                                                112. CommunicationRequest.groupIdentifier.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()))
                                                114. CommunicationRequest.groupIdentifier.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()))
                                                116. CommunicationRequest.groupIdentifier.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()))
                                                118. CommunicationRequest.groupIdentifier.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()))
                                                120. CommunicationRequest.status
                                                Definition

                                                The status of the proposal or order.

                                                Shortdraft | active | on-hold | revoked | completed | entered-in-error | unknown
                                                Control1..1
                                                BindingThe codes SHALL be taken from RequestStatus
                                                (required to http://hl7.org/fhir/ValueSet/request-status|4.3.0)

                                                The status of the communication request.

                                                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
                                                Must Supportfalse
                                                Summarytrue
                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                122. CommunicationRequest.statusReason
                                                Definition

                                                Captures the reason for the current state of the CommunicationRequest.

                                                ShortReason for current status
                                                Comments

                                                This is generally only used for "exception" statuses such as "suspended" or "cancelled". The reason why the CommunicationRequest was created at all is captured in reasonCode, not here. [distinct reason codes for different statuses can be enforced using invariants if they are universal bindings].

                                                Control0..1
                                                Binding

                                                Codes identifying the reason for the current state of a request.

                                                TypeCodeableConcept
                                                Is Modifierfalse
                                                Must Supportfalse
                                                Summaryfalse
                                                Alternate NamesSuspended Reason, Cancelled Reason
                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                124. CommunicationRequest.category
                                                Definition

                                                The type of message to be sent such as alert, notification, reminder, instruction, etc.

                                                ShortMessage category
                                                Comments

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

                                                Control0..*
                                                BindingFor example codes, see CommunicationCategory
                                                (example to http://hl7.org/fhir/ValueSet/communication-category|4.3.0)

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

                                                TypeCodeableConcept
                                                Is Modifierfalse
                                                Must Supportfalse
                                                Summaryfalse
                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                126. CommunicationRequest.priority
                                                Definition

                                                Characterizes how quickly the proposed act must be initiated. Includes concepts such as stat, urgent, routine.

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

                                                Codes indicating the relative importance of a communication request.

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

                                                If true indicates that the CommunicationRequest is asking for the specified action to not occur.

                                                ShortTrue if request is prohibiting action
                                                Comments

                                                The attributes provided with the request qualify what is not to be done.

                                                Control0..1
                                                Typeboolean
                                                Is Modifiertrue because If true this element negates the specified action. For Example, instead of a request for a communication, it is a request for the communication to not occur.
                                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                Must Supportfalse
                                                Summarytrue
                                                Alternate Namesprohibited
                                                Meaning if MissingIf do not perform is not specified, the request is a positive request e.g. "do perform"
                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                130. CommunicationRequest.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
                                                Must Supportfalse
                                                Summaryfalse
                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                132. CommunicationRequest.subject
                                                Definition

                                                The patient or group that is the focus of this communication request.

                                                ShortFocus of message
                                                Control0..1
                                                TypeReference(Patient, Group)
                                                Is Modifierfalse
                                                Must Supportfalse
                                                Summaryfalse
                                                Alternate Namespatient
                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                134. CommunicationRequest.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
                                                Typeid
                                                Is Modifierfalse
                                                XML FormatIn the XML format, this property is represented as an attribute.
                                                Summaryfalse
                                                136. CommunicationRequest.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 CommunicationRequest.subject.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                • value @ url
                                                • 138. CommunicationRequest.subject.extension:subject
                                                  Slice Namesubject
                                                  Definition

                                                  STU3: CommunicationRequest.subject additional types from child elements (display, identifier, reference)

                                                  ShortSTU3: subject additional types
                                                  Comments

                                                  Element CommunicationRequest.subject is mapped to FHIR R4B element CommunicationRequest.subject as SourceIsBroaderThanTarget. The mappings for CommunicationRequest.subject do not cover the following types based on type expansion: display, identifier, reference. The standard extension alternate-reference has been mapped as the representation of FHIR STU3 element CommunicationRequest.subject with unmapped reference targets: Group, 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())
                                                  140. CommunicationRequest.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()))
                                                  142. CommunicationRequest.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.3.0)
                                                  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()))
                                                  144. CommunicationRequest.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()))
                                                  146. CommunicationRequest.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()))
                                                  148. CommunicationRequest.about
                                                  Definition

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

                                                  ShortResources that pertain to this communication request
                                                  Comments

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

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

                                                  The Encounter during which this CommunicationRequest 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
                                                  Must Supportfalse
                                                  Summarytrue
                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                  152. CommunicationRequest.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
                                                  Typeid
                                                  Is Modifierfalse
                                                  XML FormatIn the XML format, this property is represented as an attribute.
                                                  Summaryfalse
                                                  154. CommunicationRequest.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 CommunicationRequest.encounter.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                  • value @ url
                                                  • 156. CommunicationRequest.encounter.extension:context
                                                    Slice Namecontext
                                                    Definition

                                                    STU3: CommunicationRequest.context additional types from child elements (display, identifier, reference)

                                                    ShortSTU3: Encounter or episode leading to message additional types
                                                    Comments

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

                                                    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())
                                                    158. CommunicationRequest.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()))
                                                    160. CommunicationRequest.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.3.0)
                                                    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()))
                                                    162. CommunicationRequest.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()))
                                                    164. CommunicationRequest.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()))
                                                    166. CommunicationRequest.payload
                                                    Definition

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

                                                    ShortMessage payload
                                                    Control0..*
                                                    TypeBackboneElement
                                                    Is Modifierfalse
                                                    Must Supportfalse
                                                    Summaryfalse
                                                    Invariantsele-1: All FHIR elements must have a @value or children unless an empty Parameters resource (hasValue() or (children().count() > id.count()) or $this is Parameters)
                                                    168. CommunicationRequest.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
                                                    170. CommunicationRequest.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 CommunicationRequest.payload.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                    • value @ url
                                                    • 172. CommunicationRequest.payload.extension:content
                                                      Slice Namecontent
                                                      Definition

                                                      STU3: CommunicationRequest.payload.content[x] additional types (Attachment)

                                                      ShortSTU3: content additional types
                                                      Comments

                                                      Element CommunicationRequest.payload.content[x] is mapped to FHIR R4B element CommunicationRequest.payload.content[x] as SourceIsBroaderThanTarget. The mappings for CommunicationRequest.payload.content[x] do not cover the following types: Attachment. The target context CommunicationRequest.payload.content[x] is a choice-type element and cannot directly hold extensions. The context is moved up to parent element CommunicationRequest.payload. The standard extension alternate-reference has been mapped as PART of the representation of FHIR STU3 element CommunicationRequest.payload.content[x] with unmapped reference targets: Resource. Source element CommunicationRequest.payload.content[x] has unmapped reference types. While the target element CommunicationRequest.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(STU3: content additional types) (Extension Type: Attachment)
                                                      Is Modifierfalse
                                                      Summaryfalse
                                                      Invariantsele-1: All FHIR elements must have a @value or children unless an empty Parameters resource (hasValue() or (children().count() > id.count()) or $this is Parameters)
                                                      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                      174. CommunicationRequest.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())
                                                      176. CommunicationRequest.payload.content[x]
                                                      Definition

                                                      The 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
                                                      Must Supportfalse
                                                      Summaryfalse
                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                      178. CommunicationRequest.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
                                                      Typeid
                                                      Is Modifierfalse
                                                      XML FormatIn the XML format, this property is represented as an attribute.
                                                      Summaryfalse
                                                      180. CommunicationRequest.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 CommunicationRequest.payload.content[x].extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                      • value @ url
                                                      • 182. CommunicationRequest.payload.content[x].extension:alternateReference
                                                        Slice NamealternateReference
                                                        Definition

                                                        STU3: CommunicationRequest.payload.content[x] additional types (Attachment)

                                                        ShortSTU3: content additional types
                                                        Comments

                                                        Element CommunicationRequest.payload.content[x] is mapped to FHIR R4B element CommunicationRequest.payload.content[x] as SourceIsBroaderThanTarget. The mappings for CommunicationRequest.payload.content[x] do not cover the following types: Attachment. The target context CommunicationRequest.payload.content[x] is a choice-type element and cannot directly hold extensions. The context is moved up to parent element CommunicationRequest.payload. The standard extension alternate-reference has been mapped as PART of the representation of FHIR STU3 element CommunicationRequest.payload.content[x] with unmapped reference targets: Resource. Source element CommunicationRequest.payload.content[x] has unmapped reference types. While the target element CommunicationRequest.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())
                                                        184. CommunicationRequest.occurrence[x]
                                                        Definition

                                                        The time when this communication is to occur.

                                                        ShortWhen scheduled
                                                        Control0..1
                                                        TypeChoice of: dateTime, Period
                                                        [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
                                                        Must Supportfalse
                                                        Summarytrue
                                                        Alternate Namestiming
                                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                        186. CommunicationRequest.authoredOn
                                                        Definition

                                                        For draft requests, indicates the date of initial creation. For requests with other statuses, indicates the date of activation.

                                                        ShortWhen request transitioned to being actionable
                                                        Control0..1
                                                        TypedateTime
                                                        Is Modifierfalse
                                                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                        Must Supportfalse
                                                        Summarytrue
                                                        Alternate NamescreatedOn
                                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                        188. CommunicationRequest.requester
                                                        Definition

                                                        The device, individual, or organization who initiated the request and has responsibility for its activation.

                                                        ShortWho/what is requesting service
                                                        Control0..1
                                                        TypeReference(Practitioner, PractitionerRole, Organization, Patient, RelatedPerson, Device)
                                                        Is Modifierfalse
                                                        Must Supportfalse
                                                        Summarytrue
                                                        Alternate Namesauthor
                                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                        190. CommunicationRequest.requester.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
                                                        Typeid
                                                        Is Modifierfalse
                                                        XML FormatIn the XML format, this property is represented as an attribute.
                                                        Summaryfalse
                                                        192. CommunicationRequest.requester.extension
                                                        Definition

                                                        An Extension

                                                        ShortExtension
                                                        Control1..*
                                                        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 CommunicationRequest.requester.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                        • value @ url
                                                        • 194. CommunicationRequest.requester.extension:agent
                                                          Slice Nameagent
                                                          Definition

                                                          STU3: CommunicationRequest.requester.agent

                                                          ShortSTU3: Individual making the request
                                                          Comments

                                                          Element CommunicationRequest.requester.agent is mapped to FHIR R4B element CommunicationRequest.requester as SourceIsBroaderThanTarget. The standard extension alternate-reference has been mapped as the representation of FHIR STU3 element CommunicationRequest.requester.agent with unmapped reference targets: Device, Organization, Patient, Practitioner, RelatedPerson.

                                                          Control1..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())
                                                          196. CommunicationRequest.requester.extension:onBehalfOf
                                                          Slice NameonBehalfOf
                                                          Definition

                                                          STU3: CommunicationRequest.requester.onBehalfOf (new:Reference(Organization))

                                                          ShortSTU3: Organization agent is acting for (new)
                                                          Comments

                                                          Element CommunicationRequest.requester.onBehalfOf has a context of CommunicationRequest.requester based on following the parent source element upwards and mapping to CommunicationRequest. Element CommunicationRequest.requester.onBehalfOf has no mapping targets in FHIR R4B. Typically, this is because the element has been added (is a new element).

                                                          Control0..1
                                                          TypeExtension(STU3: Organization agent is acting for (new)) (Extension Type: Reference(Cross-version Profile for STU3.Organization for use in FHIR R4B, Organization))
                                                          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())
                                                          198. CommunicationRequest.requester.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()))
                                                          200. CommunicationRequest.requester.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.3.0)
                                                          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()))
                                                          202. CommunicationRequest.requester.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()))
                                                          204. CommunicationRequest.requester.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()))
                                                          206. CommunicationRequest.recipient
                                                          Definition

                                                          The entity (e.g. person, organization, clinical information system, device, group, or care team) which is the intended target of the communication.

                                                          ShortMessage recipient
                                                          Control0..*
                                                          TypeReference(Device, Organization, Patient, Practitioner, PractitionerRole, RelatedPerson, Group, CareTeam, HealthcareService)
                                                          Is Modifierfalse
                                                          Must Supportfalse
                                                          Summaryfalse
                                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                          208. CommunicationRequest.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
                                                          Typeid
                                                          Is Modifierfalse
                                                          XML FormatIn the XML format, this property is represented as an attribute.
                                                          Summaryfalse
                                                          210. CommunicationRequest.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 CommunicationRequest.recipient.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                          • value @ url
                                                          • 212. CommunicationRequest.recipient.extension:recipient
                                                            Slice Namerecipient
                                                            Definition

                                                            STU3: CommunicationRequest.recipient

                                                            ShortSTU3: recipient
                                                            Comments

                                                            Element CommunicationRequest.recipient is mapped to FHIR R4B element CommunicationRequest.recipient as SourceIsBroaderThanTarget. The standard extension alternate-reference has been mapped as the representation of FHIR STU3 element CommunicationRequest.recipient with unmapped reference targets: CareTeam, 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())
                                                            214. CommunicationRequest.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()))
                                                            216. CommunicationRequest.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.3.0)
                                                            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()))
                                                            218. CommunicationRequest.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()))
                                                            220. CommunicationRequest.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()))
                                                            222. CommunicationRequest.sender
                                                            Definition

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

                                                            ShortMessage sender
                                                            Control0..1
                                                            TypeReference(Device, Organization, Patient, Practitioner, PractitionerRole, RelatedPerson, HealthcareService)
                                                            Is Modifierfalse
                                                            Must Supportfalse
                                                            Summarytrue
                                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                            224. CommunicationRequest.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
                                                            Typeid
                                                            Is Modifierfalse
                                                            XML FormatIn the XML format, this property is represented as an attribute.
                                                            Summaryfalse
                                                            226. CommunicationRequest.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 CommunicationRequest.sender.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                            • value @ url
                                                            • 228. CommunicationRequest.sender.extension:sender
                                                              Slice Namesender
                                                              Definition

                                                              STU3: CommunicationRequest.sender

                                                              ShortSTU3: sender
                                                              Comments

                                                              Element CommunicationRequest.sender is mapped to FHIR R4B element CommunicationRequest.sender as SourceIsBroaderThanTarget. The standard extension alternate-reference has been mapped as the representation of FHIR STU3 element CommunicationRequest.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())
                                                              230. CommunicationRequest.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()))
                                                              232. CommunicationRequest.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.3.0)
                                                              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()))
                                                              234. CommunicationRequest.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()))
                                                              236. CommunicationRequest.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()))
                                                              238. CommunicationRequest.reasonCode
                                                              Definition

                                                              Describes why the request is being made in coded or textual form.

                                                              ShortWhy is communication needed?
                                                              Comments

                                                              Textual reasons can be captured using reasonCode.text.

                                                              Control0..*
                                                              BindingFor example codes, see ActReason (3.0.0)
                                                              (example to http://terminology.hl7.org/ValueSet/v3-ActReason|3.0.0)

                                                              Codes for describing reasons for the occurrence of a communication.

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

                                                              Indicates another resource whose existence justifies this request.

                                                              ShortWhy is communication needed?
                                                              Control0..*
                                                              TypeReference(Condition, Observation, DiagnosticReport, DocumentReference)
                                                              Is Modifierfalse
                                                              Must Supportfalse
                                                              Summarytrue
                                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                              242. CommunicationRequest.reasonReference.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
                                                              Typeid
                                                              Is Modifierfalse
                                                              XML FormatIn the XML format, this property is represented as an attribute.
                                                              Summaryfalse
                                                              244. CommunicationRequest.reasonReference.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 CommunicationRequest.reasonReference.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                              • value @ url
                                                              • 246. CommunicationRequest.reasonReference.extension:reasonReference
                                                                Slice NamereasonReference
                                                                Definition

                                                                STU3: CommunicationRequest.reasonReference additional types from child elements (display, identifier, reference)

                                                                ShortSTU3: reasonReference additional types
                                                                Comments

                                                                Element CommunicationRequest.reasonReference is mapped to FHIR R4B element CommunicationRequest.reasonReference as SourceIsBroaderThanTarget. The mappings for CommunicationRequest.reasonReference do not cover the following types based on type expansion: display, identifier, reference. The standard extension alternate-reference has been mapped as the representation of FHIR STU3 element CommunicationRequest.reasonReference with unmapped reference targets: Condition, Observation.

                                                                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())
                                                                248. CommunicationRequest.reasonReference.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()))
                                                                250. CommunicationRequest.reasonReference.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.3.0)
                                                                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()))
                                                                252. CommunicationRequest.reasonReference.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()))
                                                                254. CommunicationRequest.reasonReference.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()))
                                                                256. CommunicationRequest.note
                                                                Definition

                                                                Comments made about the request by the requester, sender, recipient, subject or other participants.

                                                                ShortComments made about communication request
                                                                Control0..*
                                                                TypeAnnotation
                                                                Is Modifierfalse
                                                                Must Supportfalse
                                                                Summaryfalse
                                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                258. CommunicationRequest.note.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
                                                                Typeid
                                                                Is Modifierfalse
                                                                XML FormatIn the XML format, this property is represented as an attribute.
                                                                Summaryfalse
                                                                260. CommunicationRequest.note.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 CommunicationRequest.note.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                                • value @ url
                                                                • 262. CommunicationRequest.note.extension:note
                                                                  Slice Namenote
                                                                  Definition

                                                                  STU3: CommunicationRequest.note additional types (Annotation) additional types from child elements (author[x], text, time)

                                                                  ShortSTU3: note additional types
                                                                  Comments

                                                                  Element CommunicationRequest.note is mapped to FHIR R4B element CommunicationRequest.note as SourceIsBroaderThanTarget. The mappings for CommunicationRequest.note do not cover the following types: Annotation. The mappings for CommunicationRequest.note do not cover the following types based on type expansion: author[x], text, time.

                                                                  Control0..*
                                                                  TypeExtension(STU3: note additional types) (Extension Type: Annotation)
                                                                  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())
                                                                  264. CommunicationRequest.note.author[x]
                                                                  Definition

                                                                  The individual responsible for making the annotation.

                                                                  ShortIndividual responsible for the annotation
                                                                  Comments

                                                                  Organization is used when there's no need for specific attribution as to who made the comment.

                                                                  Control0..1
                                                                  TypeChoice of: Reference(Practitioner, Patient, RelatedPerson, Organization), string
                                                                  [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
                                                                  Summarytrue
                                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                  266. CommunicationRequest.note.time
                                                                  Definition

                                                                  Indicates when this particular annotation was made.

                                                                  ShortWhen the annotation was made
                                                                  Control0..1
                                                                  TypedateTime
                                                                  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()))
                                                                  268. CommunicationRequest.note.text
                                                                  Definition

                                                                  The text of the annotation in markdown format.

                                                                  ShortThe annotation - text content (as markdown)
                                                                  Control1..1
                                                                  Typemarkdown
                                                                  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()))