Health New Zealand Te Whatu Ora Shared Care FHIR API
0.4.5 - release NZ

Health New Zealand Te Whatu Ora Shared Care FHIR API - Local Development build (v0.4.5) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

Resource Profile: CMSCommunication - Detailed Descriptions

Active as of 2026-05-13

Definitions for the CMSCommunication resource profile.

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

0. Communication
Definition

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

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

The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

ShortMetadata about the resource
Control10..1
TypeMeta
Is Modifierfalse
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
4. Communication.meta.profile
Definition

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


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.

Control10..1*
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()))
6. Communication.meta.tag
Definition

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

ShortTags applied to this resource
Comments

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

Control10..*
BindingFor example codes, see CommonTagshttp://hl7.org/fhir/ValueSet/common-tags
(example to http://hl7.org/fhir/ValueSet/common-tags)

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

TypeCoding
Is Modifierfalse
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
SlicingThis element introduces a set of slices on Communication.meta.tag. The slices areUnordered and Open, and can be differentiated using the following discriminators:
  • value @ system
  • 8. Communication.meta.tag:correlationId
    Slice NamecorrelationId
    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.

    Control10..1*
    BindingFor example codes, see CommonTagshttp://hl7.org/fhir/ValueSet/common-tags
    (example to http://hl7.org/fhir/ValueSet/common-tags)

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

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

    The system URI used by the hub to identify its correlation ID.


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

    ShortHub correlation ID systemIdentity of the terminology system
    Comments

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

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

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

    Pattern Valuehttps://hub.services.digital.health.nz/ns/correlation-id
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    12. Communication.meta.tag:correlationId.code
    Definition

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

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

    Need to refer to a particular code in the system.

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

    A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

    ShortA set of rules under which this content was created
    Comments

    Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.

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

    These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.

    ShortContained, inline Resources
    Comments

    This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.

    Control0..0*
    TypeResource
    Is Modifierfalse
    Summaryfalse
    Alternate Namesinline resources, anonymous resources, contained resources
    18. Communication.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.

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

      For storing campaign codes and names

      ShortCampaign details
      Control0..1
      This element is affected by the following invariants: ele-1
      TypeExtension(Campaign details) (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())
      22. Communication.extension:ContactPoint
      Slice NameContactPoint
      Definition

      Communication send to and from contact point

      ShortSend to and from communication to contact points
      Control1..1
      This element is affected by the following invariants: ele-1
      TypeExtension(Send to and from communication to contact points) (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())
      24. Communication.extension:CallbackUrl
      Slice NameCallbackUrl
      Definition

      Callback Url for system

      ShortCallback Url
      Control0..1
      This element is affected by the following invariants: ele-1
      TypeExtension(Callback Url) (Extension Type: url)
      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())
      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
      26. Communication.extension:StatusDateTime
      Slice NameStatusDateTime
      Definition

      Status updated date time

      ShortStatus DateTime
      Control1..1
      This element is affected by the following invariants: ele-1
      TypeExtension(Status DateTime) (Extension Type: dateTime)
      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())
      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
      28. Communication.extension:Reply
      Slice NameReply
      Definition

      Specifies whether a reply is expected and provides a webhook URL for the reply.

      ShortFor sms reply
      Control0..1
      This element is affected by the following invariants: ele-1
      TypeExtension(For sms reply) (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())
      30. Communication.modifierExtension
      Definition

      May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

      Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

      ShortExtensions that cannot be ignored
      Comments

      There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

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

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

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

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

      ShortRequest fulfilled by this communication
      Comments

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

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

      Prior communication that this communication is in response to.

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

      The status of the transmission.

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

      This element is labeled as a modifier because the status contains the codes aborted and entered-in-error that mark the communication as not currently valid.

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

      The status of the communication.

      Typecode
      Is Modifiertrue because This element is labelled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      Summarytrue
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      38. Communication.statusReason
      Definition

      Captures the reason for the current state of the Communication.

      ShortReason for current status
      Comments

      This is generally only used for "exception" statuses such as "not-done", "suspended" or "aborted". The reason for performing the event at all is captured in reasonCode, not here.

      Control0..1
      BindingThe codes SHALL be taken from For example codes, see Valueset for Communication Delivery Statushttp://hl7.org/fhir/ValueSet/communication-not-done-reason
      (required to https://fhir-ig.digital.health.nz/shared-care/ValueSet/hnz-communication-delivery-status-valueset)
      TypeCodeableConcept
      Is Modifierfalse
      Summarytrue
      Alternate NamesSuspended Reason, Cancelled Reason
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      40. Communication.category
      Definition

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

      ShortMessage category
      Comments

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

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

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

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

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

      ShortA channel of communication
      Control10..1*
      BindingThe codes SHALL be taken from For example codes, see Valueset for Participation Modehttp://terminology.hl7.org/ValueSet/v3-ParticipationMode
      (required to https://fhir-ig.digital.health.nz/shared-care/ValueSet/hnz-participation-mode-valueset)
      TypeCodeableConcept
      Is Modifierfalse
      Summaryfalse
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      44. Communication.subject
      Definition

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

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

      The time when this communication was sent.

      ShortMust be in UTC timezone on the FHIR serverWhen sent
      Control0..1
      TypedateTime
      Is Modifierfalse
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      Summaryfalse
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      48. Communication.recipient
      Definition

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

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

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

      ShortMessage payload
      Control0..*
      TypeBackboneElement
      Is Modifierfalse
      Summaryfalse
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      SlicingThis element introduces a set of slices on Communication.payload. The slices areUnordered and Open, and can be differentiated using the following discriminators:
      • value @ extension('https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/cms-payload-type-extension').value
      • 52. Communication.payload.modifierExtension
        Definition

        May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

        Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

        ShortExtensions that cannot be ignored even if unrecognized
        Comments

        There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

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

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

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

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

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

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

        ShortMessage payload
        Control0..1*
        TypeBackboneElement
        Is Modifierfalse
        Summaryfalse
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        58. Communication.payload:message-body.extension
        Definition

        An Extension


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

        ShortExtensionAdditional content defined by implementations
        Comments

        There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

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

          Identifies the logical type of the payload element.

          ShortCMS Payload Type Extension
          Control1..1
          This element is affected by the following invariants: ele-1
          TypeExtension(CMS Payload Type Extension) (Extension Type: code)
          Is Modifierfalse
          Summaryfalse
          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
          ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
          62. Communication.payload:message-body.extension:payloadType.extension
          Definition

          An Extension


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

          ShortExtensionAdditional content defined by implementations
          Comments

          There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

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

            Source of the definition for the extension code - a logical name or a URL.

            Shortidentifies the meaning of the extension
            Comments

            The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

            Control1..1
            Typeuri
            Is Modifierfalse
            XML FormatIn the XML format, this property is represented as an attribute.
            Summaryfalse
            Fixed Valuehttps://fhir-ig.digital.health.nz/shared-care/StructureDefinition/cms-payload-type-extension
            66. Communication.payload:message-body.extension:payloadType.value[x]
            Definition

            Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

            ShortValue of extension
            Control0..1
            BindingThe codes SHALL be taken from For codes, see CMS Payload Type ValueSet
            (required to https://fhir-ig.digital.health.nz/shared-care/ValueSet/cms-payload-type-vs)
            Typecode, date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, Coding, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, CodeableConcept, ParameterDefinition, dateTime, string, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, Signature, unsignedInt, time
            [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
            Is Modifierfalse
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            Summaryfalse
            Pattern Valuebody
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            68. Communication.payload:message-body.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())
            70. Communication.payload:message-body.content[x]
            Definition

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

            ShortMessage part content
            Control1..1
            TypeAttachment, string, Reference(Resource)
            [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
            Is Modifierfalse
            Summaryfalse
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            SlicingThis element introduces a set of slices on Communication.payload.content[x]. The slices areUnordered and Closed, and can be differentiated using the following discriminators:
            • type @ $this
            • 72. Communication.payload:message-body.content[x]:contentAttachment
              Slice NamecontentAttachment
              Definition

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

              ShortMessage part content
              Control1..1
              TypeAttachment, string, Reference(Resource)
              [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
              Is Modifierfalse
              Summaryfalse
              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              74. Communication.payload:message-body.content[x]:contentAttachment.contentType
              Definition

              Identifies the type of the data in the attachment and allows a method to be chosen to interpret or render the data. Includes mime type parameters such as charset where appropriate.

              ShortMime type of the content, with charset etc.
              Control0..1
              BindingThe codes SHALL be taken from Mime Typeshttp://hl7.org/fhir/ValueSet/mimetypes|4.0.1
              (required to http://hl7.org/fhir/ValueSet/mimetypes|4.0.1)

              The mime type of an attachment. Any valid mime type is allowed.

              Typecode
              Is Modifierfalse
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              Summarytrue
              Requirements

              Processors of the data need to be able to know how to interpret the data.

              Pattern Valuetext/plain
              ExampleGeneral: text/plain; charset=UTF-8, image/png
              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              76. Communication.payload:attachment-file
              Slice Nameattachment-file
              Definition

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

              ShortMessage payload
              Control0..*
              TypeBackboneElement
              Is Modifierfalse
              Summaryfalse
              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              78. Communication.payload:attachment-file.extension
              Definition

              An Extension


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

              ShortExtensionAdditional content defined by implementations
              Comments

              There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

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

                Identifies the logical type of the payload element.

                ShortCMS Payload Type Extension
                Control1..1
                This element is affected by the following invariants: ele-1
                TypeExtension(CMS Payload Type Extension) (Extension Type: code)
                Is Modifierfalse
                Summaryfalse
                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                82. Communication.payload:attachment-file.extension:payloadType.extension
                Definition

                An Extension


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

                ShortExtensionAdditional content defined by implementations
                Comments

                There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

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

                  Source of the definition for the extension code - a logical name or a URL.

                  Shortidentifies the meaning of the extension
                  Comments

                  The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

                  Control1..1
                  Typeuri
                  Is Modifierfalse
                  XML FormatIn the XML format, this property is represented as an attribute.
                  Summaryfalse
                  Fixed Valuehttps://fhir-ig.digital.health.nz/shared-care/StructureDefinition/cms-payload-type-extension
                  86. Communication.payload:attachment-file.extension:payloadType.value[x]
                  Definition

                  Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

                  ShortValue of extension
                  Control0..1
                  BindingThe codes SHALL be taken from For codes, see CMS Payload Type ValueSet
                  (required to https://fhir-ig.digital.health.nz/shared-care/ValueSet/cms-payload-type-vs)
                  Typecode, date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, Coding, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, CodeableConcept, ParameterDefinition, dateTime, string, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, Signature, unsignedInt, time
                  [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                  Is Modifierfalse
                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                  Summaryfalse
                  Pattern Valueattachment
                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                  88. Communication.payload:attachment-file.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())
                  90. Communication.payload:attachment-file.content[x]
                  Definition

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

                  ShortMessage part content
                  Control1..1
                  TypeAttachment, string, Reference(Resource)
                  [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                  Is Modifierfalse
                  Summaryfalse
                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                  SlicingThis element introduces a set of slices on Communication.payload.content[x]. The slices areUnordered and Closed, and can be differentiated using the following discriminators:
                  • type @ $this
                  • 92. Communication.payload:attachment-file.content[x]:contentAttachment
                    Slice NamecontentAttachment
                    Definition

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

                    ShortMessage part content
                    Control1..1
                    TypeAttachment, string, Reference(Resource)
                    [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                    Is Modifierfalse
                    Summaryfalse
                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                    94. Communication.payload:attachment-file.content[x]:contentAttachment.extension:AttachmentExtension
                    Slice NameAttachmentExtension
                    Definition

                    Extra details for attachment to help with rendering

                    ShortAttachment details
                    Control0..1
                    TypeExtension(Attachment details) (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())

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

                    0. Communication
                    2. Communication.meta
                    Control1..?
                    4. Communication.meta.profile
                    Control1..1
                    6. Communication.meta.tag
                    Control1..?
                    SlicingThis element introduces a set of slices on Communication.meta.tag. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                    • value @ system
                    • 8. Communication.meta.tag:correlationId
                      Slice NamecorrelationId
                      Control1..1
                      10. Communication.meta.tag:correlationId.system
                      Definition

                      The system URI used by the hub to identify its correlation ID.

                      ShortHub correlation ID system
                      Control1..?
                      Pattern Valuehttps://hub.services.digital.health.nz/ns/correlation-id
                      12. Communication.meta.tag:correlationId.code
                      Control1..?
                      14. Communication.contained
                      Control0..0
                      16. Communication.extension
                      Control2..?
                      SlicingThis element introduces a set of slices on Communication.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                      • value @ url
                      • 18. Communication.extension:Campaign
                        Slice NameCampaign
                        Control0..1
                        TypeExtension(Campaign details) (Complex Extension)
                        20. Communication.extension:ContactPoint
                        Slice NameContactPoint
                        Control1..1
                        TypeExtension(Send to and from communication to contact points) (Complex Extension)
                        22. Communication.extension:CallbackUrl
                        Slice NameCallbackUrl
                        Control0..1
                        TypeExtension(Callback Url) (Extension Type: url)
                        24. Communication.extension:StatusDateTime
                        Slice NameStatusDateTime
                        Control1..1
                        TypeExtension(Status DateTime) (Extension Type: dateTime)
                        26. Communication.extension:Reply
                        Slice NameReply
                        Control0..1
                        TypeExtension(For sms reply) (Complex Extension)
                        28. Communication.basedOn
                        Control0..1
                        30. Communication.inResponseTo
                        Control0..1
                        32. Communication.statusReason
                        BindingThe codes SHALL be taken from Valueset for Communication Delivery Status
                        (required to https://fhir-ig.digital.health.nz/shared-care/ValueSet/hnz-communication-delivery-status-valueset)
                        34. Communication.category
                        Control0..1
                        36. Communication.medium
                        Control1..1
                        BindingThe codes SHALL be taken from Valueset for Participation Mode
                        (required to https://fhir-ig.digital.health.nz/shared-care/ValueSet/hnz-participation-mode-valueset)
                        38. Communication.subject
                        TypeReference(Patient)
                        40. Communication.sent
                        ShortMust be in UTC timezone on the FHIR server
                        42. Communication.recipient
                        TypeReference(Patient, Practitioner)
                        44. Communication.payload
                        SlicingThis element introduces a set of slices on Communication.payload. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                        • value @ extension('https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/cms-payload-type-extension').value
                        • 46. Communication.payload:message-body
                          Slice Namemessage-body
                          Control0..1
                          48. Communication.payload:message-body.extension
                          Control1..?
                          SlicingThis element introduces a set of slices on Communication.payload.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                          • value @ url
                          • 50. Communication.payload:message-body.extension:payloadType
                            Slice NamepayloadType
                            Control1..1
                            TypeExtension(CMS Payload Type Extension) (Extension Type: code)
                            52. Communication.payload:message-body.extension:payloadType.value[x]
                            [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                            Pattern Valuebody
                            54. Communication.payload:message-body.content[x]
                            [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                            SlicingThis element introduces a set of slices on Communication.payload.content[x]. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                            • type @ $this
                            • 56. Communication.payload:message-body.content[x]:contentAttachment
                              Slice NamecontentAttachment
                              Control1..1
                              TypeAttachment
                              [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                              58. Communication.payload:message-body.content[x]:contentAttachment.contentType
                              Pattern Valuetext/plain
                              60. Communication.payload:attachment-file
                              Slice Nameattachment-file
                              Control0..*
                              62. Communication.payload:attachment-file.extension
                              Control1..?
                              SlicingThis element introduces a set of slices on Communication.payload.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                              • value @ url
                              • 64. Communication.payload:attachment-file.extension:payloadType
                                Slice NamepayloadType
                                Control1..1
                                TypeExtension(CMS Payload Type Extension) (Extension Type: code)
                                66. Communication.payload:attachment-file.extension:payloadType.value[x]
                                [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                                Pattern Valueattachment
                                68. Communication.payload:attachment-file.content[x]
                                [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                                SlicingThis element introduces a set of slices on Communication.payload.content[x]. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                • type @ $this
                                • 70. Communication.payload:attachment-file.content[x]:contentAttachment
                                  Slice NamecontentAttachment
                                  Control1..1
                                  TypeAttachment
                                  [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                                  72. Communication.payload:attachment-file.content[x]:contentAttachment.extension:AttachmentExtension
                                  Slice NameAttachmentExtension
                                  Control0..1
                                  TypeExtension(Attachment details) (Complex Extension)

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

                                  0. Communication
                                  Definition

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

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

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

                                  ShortLogical id of this artifact
                                  Comments

                                  The only time that a resource does not have an id is when it is being submitted to the server using a create operation.

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

                                  The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

                                  ShortMetadata about the resource
                                  Control1..1
                                  TypeMeta
                                  Is Modifierfalse
                                  Summarytrue
                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                  6. Communication.meta.id
                                  Definition

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

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

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

                                  ShortAdditional content defined by implementations
                                  Comments

                                  There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

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

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

                                    ShortVersion specific identifier
                                    Comments

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

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

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

                                    ShortWhen the resource version last changed
                                    Comments

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

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

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

                                    ShortIdentifies where the resource comes from
                                    Comments

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

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

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

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

                                    ShortProfiles this resource claims to conform to
                                    Comments

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

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

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

                                    ShortSecurity Labels applied to this resource
                                    Comments

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

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

                                    Security Labels from the Healthcare Privacy and Security Classification System.

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

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

                                    ShortTags applied to this resource
                                    Comments

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

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

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

                                    TypeCoding
                                    Is Modifierfalse
                                    Summarytrue
                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                    SlicingThis element introduces a set of slices on Communication.meta.tag. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                    • value @ system
                                    • 22. Communication.meta.tag:correlationId
                                      Slice NamecorrelationId
                                      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.

                                      Control1..1
                                      BindingFor example codes, see CommonTags
                                      (example to http://hl7.org/fhir/ValueSet/common-tags)

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

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

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

                                      ShortAdditional content defined by implementations
                                      Comments

                                      There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

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

                                        The system URI used by the hub to identify its correlation ID.

                                        ShortHub correlation ID system
                                        Comments

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

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

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

                                        Pattern Valuehttps://hub.services.digital.health.nz/ns/correlation-id
                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                        30. Communication.meta.tag:correlationId.version
                                        Definition

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

                                        ShortVersion of the system - if relevant
                                        Comments

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

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

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

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

                                        Need to refer to a particular code in the system.

                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                        34. Communication.meta.tag:correlationId.display
                                        Definition

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

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

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

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

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

                                        ShortIf this coding was chosen directly by the user
                                        Comments

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

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

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

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

                                        A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

                                        ShortA set of rules under which this content was created
                                        Comments

                                        Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.

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

                                        The base language in which the resource is written.

                                        ShortLanguage of the resource content
                                        Comments

                                        Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).

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

                                        A human language.

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

                                        A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

                                        ShortText summary of the resource, for human interpretation
                                        Comments

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

                                        Control0..1
                                        TypeNarrative
                                        Is Modifierfalse
                                        Summaryfalse
                                        Alternate Namesnarrative, html, xhtml, display
                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                        44. Communication.contained
                                        Definition

                                        These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.

                                        ShortContained, inline Resources
                                        Comments

                                        This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.

                                        Control0..0
                                        TypeResource
                                        Is Modifierfalse
                                        Summaryfalse
                                        Alternate Namesinline resources, anonymous resources, contained resources
                                        46. Communication.extension
                                        Definition

                                        An Extension

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

                                          For storing campaign codes and names

                                          ShortCampaign details
                                          Control0..1
                                          This element is affected by the following invariants: ele-1
                                          TypeExtension(Campaign details) (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())
                                          50. Communication.extension:ContactPoint
                                          Slice NameContactPoint
                                          Definition

                                          Communication send to and from contact point

                                          ShortSend to and from communication to contact points
                                          Control1..1
                                          This element is affected by the following invariants: ele-1
                                          TypeExtension(Send to and from communication to contact points) (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())
                                          52. Communication.extension:CallbackUrl
                                          Slice NameCallbackUrl
                                          Definition

                                          Callback Url for system

                                          ShortCallback Url
                                          Control0..1
                                          This element is affected by the following invariants: ele-1
                                          TypeExtension(Callback Url) (Extension Type: url)
                                          Is Modifierfalse
                                          Summaryfalse
                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                          ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                          54. Communication.extension:StatusDateTime
                                          Slice NameStatusDateTime
                                          Definition

                                          Status updated date time

                                          ShortStatus DateTime
                                          Control1..1
                                          This element is affected by the following invariants: ele-1
                                          TypeExtension(Status DateTime) (Extension Type: dateTime)
                                          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. Communication.extension:Reply
                                          Slice NameReply
                                          Definition

                                          Specifies whether a reply is expected and provides a webhook URL for the reply.

                                          ShortFor sms reply
                                          Control0..1
                                          This element is affected by the following invariants: ele-1
                                          TypeExtension(For sms reply) (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())
                                          58. Communication.modifierExtension
                                          Definition

                                          May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

                                          Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

                                          ShortExtensions that cannot be ignored
                                          Comments

                                          There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

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

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

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

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

                                          ShortUnique identifier
                                          Comments

                                          This is a business identifier, not a resource identifier (see discussion). It is best practice for the identifier to only appear on a single resource instance, however business practices may occasionally dictate that multiple resource instances with the same identifier can exist - possibly even with different resource types. For example, multiple Patient and a Person resource instance might share the same social insurance number.

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

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

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

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

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

                                          The URL pointing to an externally maintained protocol, guideline, orderset or other definition that is adhered to in whole or in part by this Communication.

                                          ShortInstantiates external protocol or definition
                                          Comments

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

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

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

                                          ShortRequest fulfilled by this communication
                                          Comments

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

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

                                          Part of this action.

                                          ShortPart of this action
                                          Control0..*
                                          TypeReference(Resource)
                                          Is Modifierfalse
                                          Summarytrue
                                          Alternate Namescontainer
                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                          70. Communication.inResponseTo
                                          Definition

                                          Prior communication that this communication is in response to.

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

                                          The status of the transmission.

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

                                          This element is labeled as a modifier because the status contains the codes aborted and entered-in-error that mark the communication as not currently valid.

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

                                          The status of the communication.

                                          Typecode
                                          Is Modifiertrue because This element is labelled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid
                                          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                          Summarytrue
                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                          74. Communication.statusReason
                                          Definition

                                          Captures the reason for the current state of the Communication.

                                          ShortReason for current status
                                          Comments

                                          This is generally only used for "exception" statuses such as "not-done", "suspended" or "aborted". The reason for performing the event at all is captured in reasonCode, not here.

                                          Control0..1
                                          BindingThe codes SHALL be taken from Valueset for Communication Delivery Status
                                          (required to https://fhir-ig.digital.health.nz/shared-care/ValueSet/hnz-communication-delivery-status-valueset)
                                          TypeCodeableConcept
                                          Is Modifierfalse
                                          Summarytrue
                                          Alternate NamesSuspended Reason, Cancelled Reason
                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                          76. Communication.category
                                          Definition

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

                                          ShortMessage category
                                          Comments

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

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

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

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

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

                                          Shortroutine | urgent | asap | stat
                                          Comments

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

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

                                          Codes indicating the relative importance of a communication.

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

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

                                          ShortA channel of communication
                                          Control1..1
                                          BindingThe codes SHALL be taken from Valueset for Participation Mode
                                          (required to https://fhir-ig.digital.health.nz/shared-care/ValueSet/hnz-participation-mode-valueset)
                                          TypeCodeableConcept
                                          Is Modifierfalse
                                          Summaryfalse
                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                          82. Communication.subject
                                          Definition

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

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

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

                                          ShortDescription of the purpose/content
                                          Comments

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

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

                                          Codes describing the purpose or content of the communication.

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

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

                                          ShortResources that pertain to this communication
                                          Comments

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

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

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

                                          ShortEncounter created as part of
                                          Comments

                                          This will typically be the encounter the event occurred within, but some activities may be initiated prior to or after the official completion of an encounter but still be tied to the context of the encounter.

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

                                          The time when this communication was sent.

                                          ShortMust be in UTC timezone on the FHIR server
                                          Control0..1
                                          TypedateTime
                                          Is Modifierfalse
                                          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                          Summaryfalse
                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                          92. Communication.received
                                          Definition

                                          The time when this communication arrived at the destination.

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

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

                                          ShortMessage recipient
                                          Control0..*
                                          TypeReference(Patient, Practitioner)
                                          Is Modifierfalse
                                          Summaryfalse
                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                          96. Communication.sender
                                          Definition

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

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

                                          The reason or justification for the communication.

                                          ShortIndication for message
                                          Comments

                                          Textual reasons can be captured using reasonCode.text.

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

                                          Codes for describing reasons for the occurrence of a communication.

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

                                          Indicates another resource whose existence justifies this communication.

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

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

                                          ShortMessage payload
                                          Control0..*
                                          TypeBackboneElement
                                          Is Modifierfalse
                                          Summaryfalse
                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                          SlicingThis element introduces a set of slices on Communication.payload. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                          • value @ extension('https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/cms-payload-type-extension').value
                                          • 104. Communication.payload.id
                                            Definition

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

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

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

                                            ShortAdditional content defined by implementations
                                            Comments

                                            There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

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

                                            May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

                                            Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

                                            ShortExtensions that cannot be ignored even if unrecognized
                                            Comments

                                            There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

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

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

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

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

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

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

                                            ShortMessage payload
                                            Control0..1
                                            TypeBackboneElement
                                            Is Modifierfalse
                                            Summaryfalse
                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                            114. Communication.payload:message-body.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
                                            116. Communication.payload:message-body.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 Communication.payload.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                            • value @ url
                                            • 118. Communication.payload:message-body.extension:payloadType
                                              Slice NamepayloadType
                                              Definition

                                              Identifies the logical type of the payload element.

                                              ShortCMS Payload Type Extension
                                              Control1..1
                                              This element is affected by the following invariants: ele-1
                                              TypeExtension(CMS Payload Type Extension) (Extension Type: code)
                                              Is Modifierfalse
                                              Summaryfalse
                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                              ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                              120. Communication.payload:message-body.extension:payloadType.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
                                              122. Communication.payload:message-body.extension:payloadType.extension
                                              Definition

                                              An Extension

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

                                                Source of the definition for the extension code - a logical name or a URL.

                                                Shortidentifies the meaning of the extension
                                                Comments

                                                The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

                                                Control1..1
                                                Typeuri
                                                Is Modifierfalse
                                                XML FormatIn the XML format, this property is represented as an attribute.
                                                Summaryfalse
                                                Fixed Valuehttps://fhir-ig.digital.health.nz/shared-care/StructureDefinition/cms-payload-type-extension
                                                126. Communication.payload:message-body.extension:payloadType.value[x]
                                                Definition

                                                Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

                                                ShortValue of extension
                                                Control0..1
                                                BindingThe codes SHALL be taken from CMS Payload Type ValueSet
                                                (required to https://fhir-ig.digital.health.nz/shared-care/ValueSet/cms-payload-type-vs)
                                                Typecode
                                                [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                                                Is Modifierfalse
                                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                Summaryfalse
                                                Pattern Valuebody
                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                128. Communication.payload:message-body.modifierExtension
                                                Definition

                                                May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

                                                Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

                                                ShortExtensions that cannot be ignored even if unrecognized
                                                Comments

                                                There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

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

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

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

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

                                                ShortMessage part content
                                                Control1..1
                                                TypeAttachment
                                                [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                                                Is Modifierfalse
                                                Summaryfalse
                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                SlicingThis element introduces a set of slices on Communication.payload.content[x]. The slices areUnordered and Closed, and can be differentiated using the following discriminators:
                                                • type @ $this
                                                • 132. Communication.payload:message-body.content[x]:contentAttachment
                                                  Slice NamecontentAttachment
                                                  Definition

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

                                                  ShortMessage part content
                                                  Control1..1
                                                  TypeAttachment
                                                  [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                                                  Is Modifierfalse
                                                  Summaryfalse
                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                  134. Communication.payload:message-body.content[x]:contentAttachment.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
                                                  136. Communication.payload:message-body.content[x]:contentAttachment.extension
                                                  Definition

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

                                                  ShortAdditional content defined by implementations
                                                  Comments

                                                  There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

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

                                                    Identifies the type of the data in the attachment and allows a method to be chosen to interpret or render the data. Includes mime type parameters such as charset where appropriate.

                                                    ShortMime type of the content, with charset etc.
                                                    Control0..1
                                                    BindingThe codes SHALL be taken from Mime Types
                                                    (required to http://hl7.org/fhir/ValueSet/mimetypes|4.0.1)

                                                    The mime type of an attachment. Any valid mime type is allowed.

                                                    Typecode
                                                    Is Modifierfalse
                                                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                    Summarytrue
                                                    Requirements

                                                    Processors of the data need to be able to know how to interpret the data.

                                                    Pattern Valuetext/plain
                                                    ExampleGeneral: text/plain; charset=UTF-8, image/png
                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                    140. Communication.payload:message-body.content[x]:contentAttachment.language
                                                    Definition

                                                    The human language of the content. The value can be any valid value according to BCP 47.

                                                    ShortHuman language of the content (BCP-47)
                                                    Control0..1
                                                    BindingThe codes SHOULD be taken from CommonLanguages
                                                    (preferred to http://hl7.org/fhir/ValueSet/languages)

                                                    A human language.

                                                    Additional BindingsPurpose
                                                    AllLanguagesMax Binding
                                                    Typecode
                                                    Is Modifierfalse
                                                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                    Summarytrue
                                                    Requirements

                                                    Users need to be able to choose between the languages in a set of attachments.

                                                    ExampleGeneral: en-AU
                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                    142. Communication.payload:message-body.content[x]:contentAttachment.data
                                                    Definition

                                                    The actual data of the attachment - a sequence of bytes, base64 encoded.

                                                    ShortData inline, base64ed
                                                    Comments

                                                    The base64-encoded data SHALL be expressed in the same character set as the base resource XML or JSON.

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

                                                    The data needs to able to be transmitted inline.

                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                    144. Communication.payload:message-body.content[x]:contentAttachment.url
                                                    Definition

                                                    A location where the data can be accessed.

                                                    ShortUri where the data can be found
                                                    Comments

                                                    If both data and url are provided, the url SHALL point to the same content as the data contains. Urls may be relative references or may reference transient locations such as a wrapping envelope using cid: though this has ramifications for using signatures. Relative URLs are interpreted relative to the service url, like a resource reference, rather than relative to the resource itself. If a URL is provided, it SHALL resolve to actual data.

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

                                                    The data needs to be transmitted by reference.

                                                    ExampleGeneral: http://www.acme.com/logo-small.png
                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                    146. Communication.payload:message-body.content[x]:contentAttachment.size
                                                    Definition

                                                    The number of bytes of data that make up this attachment (before base64 encoding, if that is done).

                                                    ShortNumber of bytes of content (if url provided)
                                                    Comments

                                                    The number of bytes is redundant if the data is provided as a base64binary, but is useful if the data is provided as a url reference.

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

                                                    Representing the size allows applications to determine whether they should fetch the content automatically in advance, or refuse to fetch it at all.

                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                    148. Communication.payload:message-body.content[x]:contentAttachment.hash
                                                    Definition

                                                    The calculated hash of the data using SHA-1. Represented using base64.

                                                    ShortHash of the data (sha-1, base64ed)
                                                    Comments

                                                    The hash is calculated on the data prior to base64 encoding, if the data is based64 encoded. The hash is not intended to support digital signatures. Where protection against malicious threats a digital signature should be considered, see Provenance.signature for mechanism to protect a resource with a digital signature.

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

                                                    Included so that applications can verify that the contents of a location have not changed due to technical failures (e.g., storage rot, transport glitch, incorrect version).

                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                    150. Communication.payload:message-body.content[x]:contentAttachment.title
                                                    Definition

                                                    A label or set of text to display in place of the data.

                                                    ShortLabel to display in place of the data
                                                    Control0..1
                                                    Typestring
                                                    Is Modifierfalse
                                                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                    Summarytrue
                                                    Requirements

                                                    Applications need a label to display to a human user in place of the actual data if the data cannot be rendered or perceived by the viewer.

                                                    ExampleGeneral: Official Corporate Logo
                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                    152. Communication.payload:message-body.content[x]:contentAttachment.creation
                                                    Definition

                                                    The date that the attachment was first created.

                                                    ShortDate attachment was first created
                                                    Control0..1
                                                    TypedateTime
                                                    Is Modifierfalse
                                                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                    Summarytrue
                                                    Requirements

                                                    This is often tracked as an integrity issue for use of the attachment.

                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                    154. Communication.payload:attachment-file
                                                    Slice Nameattachment-file
                                                    Definition

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

                                                    ShortMessage payload
                                                    Control0..*
                                                    TypeBackboneElement
                                                    Is Modifierfalse
                                                    Summaryfalse
                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                    156. Communication.payload:attachment-file.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
                                                    158. Communication.payload:attachment-file.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 Communication.payload.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                    • value @ url
                                                    • 160. Communication.payload:attachment-file.extension:payloadType
                                                      Slice NamepayloadType
                                                      Definition

                                                      Identifies the logical type of the payload element.

                                                      ShortCMS Payload Type Extension
                                                      Control1..1
                                                      This element is affected by the following invariants: ele-1
                                                      TypeExtension(CMS Payload Type Extension) (Extension Type: code)
                                                      Is Modifierfalse
                                                      Summaryfalse
                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                      162. Communication.payload:attachment-file.extension:payloadType.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
                                                      164. Communication.payload:attachment-file.extension:payloadType.extension
                                                      Definition

                                                      An Extension

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

                                                        Source of the definition for the extension code - a logical name or a URL.

                                                        Shortidentifies the meaning of the extension
                                                        Comments

                                                        The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

                                                        Control1..1
                                                        Typeuri
                                                        Is Modifierfalse
                                                        XML FormatIn the XML format, this property is represented as an attribute.
                                                        Summaryfalse
                                                        Fixed Valuehttps://fhir-ig.digital.health.nz/shared-care/StructureDefinition/cms-payload-type-extension
                                                        168. Communication.payload:attachment-file.extension:payloadType.value[x]
                                                        Definition

                                                        Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

                                                        ShortValue of extension
                                                        Control0..1
                                                        BindingThe codes SHALL be taken from CMS Payload Type ValueSet
                                                        (required to https://fhir-ig.digital.health.nz/shared-care/ValueSet/cms-payload-type-vs)
                                                        Typecode
                                                        [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                                                        Is Modifierfalse
                                                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                        Summaryfalse
                                                        Pattern Valueattachment
                                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                        170. Communication.payload:attachment-file.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())
                                                        172. Communication.payload:attachment-file.content[x]
                                                        Definition

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

                                                        ShortMessage part content
                                                        Control1..1
                                                        TypeAttachment
                                                        [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                                                        Is Modifierfalse
                                                        Summaryfalse
                                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                        SlicingThis element introduces a set of slices on Communication.payload.content[x]. The slices areUnordered and Closed, and can be differentiated using the following discriminators:
                                                        • type @ $this
                                                        • 174. Communication.payload:attachment-file.content[x]:contentAttachment
                                                          Slice NamecontentAttachment
                                                          Definition

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

                                                          ShortMessage part content
                                                          Control1..1
                                                          TypeAttachment
                                                          [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                                                          Is Modifierfalse
                                                          Summaryfalse
                                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                          176. Communication.payload:attachment-file.content[x]:contentAttachment.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
                                                          178. Communication.payload:attachment-file.content[x]:contentAttachment.extension
                                                          Definition

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

                                                          ShortAdditional content defined by implementations
                                                          Comments

                                                          There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

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

                                                            Extra details for attachment to help with rendering

                                                            ShortAttachment details
                                                            Control0..1
                                                            TypeExtension(Attachment details) (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())
                                                            182. Communication.payload:attachment-file.content[x]:contentAttachment.contentType
                                                            Definition

                                                            Identifies the type of the data in the attachment and allows a method to be chosen to interpret or render the data. Includes mime type parameters such as charset where appropriate.

                                                            ShortMime type of the content, with charset etc.
                                                            Control0..1
                                                            BindingThe codes SHALL be taken from Mime Types
                                                            (required to http://hl7.org/fhir/ValueSet/mimetypes|4.0.1)

                                                            The mime type of an attachment. Any valid mime type is allowed.

                                                            Typecode
                                                            Is Modifierfalse
                                                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                            Summarytrue
                                                            Requirements

                                                            Processors of the data need to be able to know how to interpret the data.

                                                            ExampleGeneral: text/plain; charset=UTF-8, image/png
                                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                            184. Communication.payload:attachment-file.content[x]:contentAttachment.language
                                                            Definition

                                                            The human language of the content. The value can be any valid value according to BCP 47.

                                                            ShortHuman language of the content (BCP-47)
                                                            Control0..1
                                                            BindingThe codes SHOULD be taken from CommonLanguages
                                                            (preferred to http://hl7.org/fhir/ValueSet/languages)

                                                            A human language.

                                                            Additional BindingsPurpose
                                                            AllLanguagesMax Binding
                                                            Typecode
                                                            Is Modifierfalse
                                                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                            Summarytrue
                                                            Requirements

                                                            Users need to be able to choose between the languages in a set of attachments.

                                                            ExampleGeneral: en-AU
                                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                            186. Communication.payload:attachment-file.content[x]:contentAttachment.data
                                                            Definition

                                                            The actual data of the attachment - a sequence of bytes, base64 encoded.

                                                            ShortData inline, base64ed
                                                            Comments

                                                            The base64-encoded data SHALL be expressed in the same character set as the base resource XML or JSON.

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

                                                            The data needs to able to be transmitted inline.

                                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                            188. Communication.payload:attachment-file.content[x]:contentAttachment.url
                                                            Definition

                                                            A location where the data can be accessed.

                                                            ShortUri where the data can be found
                                                            Comments

                                                            If both data and url are provided, the url SHALL point to the same content as the data contains. Urls may be relative references or may reference transient locations such as a wrapping envelope using cid: though this has ramifications for using signatures. Relative URLs are interpreted relative to the service url, like a resource reference, rather than relative to the resource itself. If a URL is provided, it SHALL resolve to actual data.

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

                                                            The data needs to be transmitted by reference.

                                                            ExampleGeneral: http://www.acme.com/logo-small.png
                                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                            190. Communication.payload:attachment-file.content[x]:contentAttachment.size
                                                            Definition

                                                            The number of bytes of data that make up this attachment (before base64 encoding, if that is done).

                                                            ShortNumber of bytes of content (if url provided)
                                                            Comments

                                                            The number of bytes is redundant if the data is provided as a base64binary, but is useful if the data is provided as a url reference.

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

                                                            Representing the size allows applications to determine whether they should fetch the content automatically in advance, or refuse to fetch it at all.

                                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                            192. Communication.payload:attachment-file.content[x]:contentAttachment.hash
                                                            Definition

                                                            The calculated hash of the data using SHA-1. Represented using base64.

                                                            ShortHash of the data (sha-1, base64ed)
                                                            Comments

                                                            The hash is calculated on the data prior to base64 encoding, if the data is based64 encoded. The hash is not intended to support digital signatures. Where protection against malicious threats a digital signature should be considered, see Provenance.signature for mechanism to protect a resource with a digital signature.

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

                                                            Included so that applications can verify that the contents of a location have not changed due to technical failures (e.g., storage rot, transport glitch, incorrect version).

                                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                            194. Communication.payload:attachment-file.content[x]:contentAttachment.title
                                                            Definition

                                                            A label or set of text to display in place of the data.

                                                            ShortLabel to display in place of the data
                                                            Control0..1
                                                            Typestring
                                                            Is Modifierfalse
                                                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                            Summarytrue
                                                            Requirements

                                                            Applications need a label to display to a human user in place of the actual data if the data cannot be rendered or perceived by the viewer.

                                                            ExampleGeneral: Official Corporate Logo
                                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                            196. Communication.payload:attachment-file.content[x]:contentAttachment.creation
                                                            Definition

                                                            The date that the attachment was first created.

                                                            ShortDate attachment was first created
                                                            Control0..1
                                                            TypedateTime
                                                            Is Modifierfalse
                                                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                            Summarytrue
                                                            Requirements

                                                            This is often tracked as an integrity issue for use of the attachment.

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

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

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