Health New Zealand Te Whatu Ora Shared Care FHIR API
1.4.8 - release New Zealand flag

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

Resource Profile: CMSCommunicationRequest - Detailed Descriptions

Active as of 2026-11-04

Definitions for the CMSCommunicationRequest resource profile.

See the documentation on how to interpret the contents of this table

0. CommunicationRequest
Definition

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

ShortA request for information to be sent to a receiver
Control0..*
Is Modifierfalse
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())
cms-body-or-template: A CommunicationRequest must have either a message-body or a message-template payload. (payload.where(extension.where(url='https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/cms-payload-type-extension' and value='body').exists()).exists() or payload.where(extension.where(url='https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/cms-payload-type-extension' and value='template').exists()).exists())
2. CommunicationRequest.meta
Definition

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

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

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


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. CommunicationRequest.meta.tag
Definition

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

ShortTags applied to this resource
Comments

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

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

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

TypeCoding
Is Modifierfalse
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
SlicingThis element introduces a set of slices on CommunicationRequest.meta.tag. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ system
8. CommunicationRequest.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|4.0.1
(example to http://hl7.org/fhir/ValueSet/common-tags|4.0.1)

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

TypeCoding
Is Modifierfalse
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
10. CommunicationRequest.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 Value
{
  "system" : "https://hub.services.digital.health.nz/ns/correlation-id"
}
<system value="https://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. CommunicationRequest.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. CommunicationRequest.implicitRules
Definition

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

ShortA set of rules under which this content was created
Comments

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

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

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

ShortContained, inline Resources
Comments

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

Control0..0*
TypeResource
Is Modifierfalse
Summaryfalse
Alternate Namesinline resources, anonymous resources, contained resources
18. CommunicationRequest.extension
Definition

An Extension


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

ShortExtensionAdditional content defined by implementations
Comments

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

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 CommunicationRequest.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
20. CommunicationRequest.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. CommunicationRequest.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. CommunicationRequest.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. CommunicationRequest.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())
28. CommunicationRequest.modifierExtension
Definition

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

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

ShortExtensions that cannot be ignored
Comments

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

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them
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())
30. CommunicationRequest.status
Definition

The status of the proposal or order.

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

The status of the communication request.

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

Captures the reason for the current state of the CommunicationRequest.

ShortReason for current status
Comments

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

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

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

ShortTrue if request is prohibiting action
Comments

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

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

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

ShortA channel of communication
Control10..*
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()))
38. CommunicationRequest.subject
Definition

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

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

Text, attachment(s), or resource(s) to be 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 CommunicationRequest.payload. The slices are Unordered 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
42. CommunicationRequest.payload.modifierExtension
Definition

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

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

ShortExtensions that cannot be ignored even if unrecognized
Comments

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

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

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

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

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

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

Text, attachment(s), or resource(s) to be 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()))
48. CommunicationRequest.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 CommunicationRequest.payload.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
50. CommunicationRequest.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())
52. CommunicationRequest.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 CommunicationRequest.payload.extension.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
54. CommunicationRequest.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 Value
{
  "url" : "https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/cms-payload-type-extension"
}
<url value="https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/cms-payload-type-extension"/>
56. CommunicationRequest.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 Value
{
  "valueCode" : "body"
}
<valueCode value="body"/>
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
58. CommunicationRequest.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())
60. CommunicationRequest.payload:message-body.content[x]
Definition

The 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 CommunicationRequest.payload.content[x]. The slices are Unordered and Closed, and can be differentiated using the following discriminators:
  • type @ $this
62. CommunicationRequest.payload:message-body.content[x]:contentAttachment
Slice NamecontentAttachment
Definition

The 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()))
64. CommunicationRequest.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 Value
{
  "contentType" : "text/plain"
}
<contentType value="text/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()))
66. CommunicationRequest.payload:message-parameters
Slice Namemessage-parameters
Definition

Text, attachment(s), or resource(s) to be 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()))
68. CommunicationRequest.payload:message-parameters.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 CommunicationRequest.payload.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
70. CommunicationRequest.payload:message-parameters.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())
72. CommunicationRequest.payload:message-parameters.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 CommunicationRequest.payload.extension.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
74. CommunicationRequest.payload:message-parameters.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 Value
{
  "url" : "https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/cms-payload-type-extension"
}
<url value="https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/cms-payload-type-extension"/>
76. CommunicationRequest.payload:message-parameters.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 Value
{
  "valueCode" : "parameters"
}
<valueCode value="parameters"/>
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
78. CommunicationRequest.payload:message-parameters.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())
80. CommunicationRequest.payload:message-parameters.content[x]
Definition

The 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 CommunicationRequest.payload.content[x]. The slices are Unordered and Closed, and can be differentiated using the following discriminators:
  • type @ $this
82. CommunicationRequest.payload:message-parameters.content[x]:contentAttachment
Slice NamecontentAttachment
Definition

The 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()))
84. CommunicationRequest.payload:message-parameters.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 Value
{
  "contentType" : "application/json"
}
<contentType value="application/json"/>
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()))
86. CommunicationRequest.payload:attachment-file
Slice Nameattachment-file
Definition

Text, attachment(s), or resource(s) to be 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()))
88. CommunicationRequest.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 CommunicationRequest.payload.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
90. CommunicationRequest.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())
92. CommunicationRequest.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 CommunicationRequest.payload.extension.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
94. CommunicationRequest.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 Value
{
  "url" : "https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/cms-payload-type-extension"
}
<url value="https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/cms-payload-type-extension"/>
96. CommunicationRequest.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 Value
{
  "valueCode" : "attachment"
}
<valueCode value="attachment"/>
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
98. CommunicationRequest.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())
100. CommunicationRequest.payload:attachment-file.content[x]
Definition

The 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 CommunicationRequest.payload.content[x]. The slices are Unordered and Closed, and can be differentiated using the following discriminators:
  • type @ $this
102. CommunicationRequest.payload:attachment-file.content[x]:contentAttachment
Slice NamecontentAttachment
Definition

The 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()))
104. CommunicationRequest.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())
106. CommunicationRequest.payload:message-template
Slice Namemessage-template
Definition

Text, attachment(s), or resource(s) to be 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()))
108. CommunicationRequest.payload:message-template.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 CommunicationRequest.payload.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
110. CommunicationRequest.payload:message-template.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())
112. CommunicationRequest.payload:message-template.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 CommunicationRequest.payload.extension.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
114. CommunicationRequest.payload:message-template.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 Value
{
  "url" : "https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/cms-payload-type-extension"
}
<url value="https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/cms-payload-type-extension"/>
116. CommunicationRequest.payload:message-template.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 Value
{
  "valueCode" : "template"
}
<valueCode value="template"/>
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
118. CommunicationRequest.payload:message-template.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())
120. CommunicationRequest.payload:message-template.content[x]
Definition

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

ShortMessage part content
Control1..1
TypeChoice of: string, Attachment, Reference(Resource)
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
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 CommunicationRequest.payload.content[x]. The slices are Unordered and Closed, and can be differentiated using the following discriminators:
  • type @ $this

Slicing Note: Other type slices that contain no new information are not shown in this view

122. CommunicationRequest.payload:message-template.content[x]:contentReference
Slice NamecontentReference
Definition

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

ShortMessage part content
Control01..1
TypeReference(CMSTemplateDocumentReference, Resource), string, Attachment
[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()))
126. CommunicationRequest.occurrence[x]
Definition

The time when this communication is to occur.

ShortWhen scheduled
Control0..1
TypeChoice of: dateTime, Period
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Alternate Namestiming
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 CommunicationRequest.occurrence[x]. The slices are Unordered and Closed, and can be differentiated using the following discriminators:
  • type @ $this

Slicing Note: Other type slices that contain no new information are not shown in this view

128. CommunicationRequest.occurrence[x]:occurrenceDateTime
Slice NameoccurrenceDateTime
Definition

The time when this communication is to occur.

ShortMust be in UTC timezone on the FHIR serverWhen scheduled
Control0..1
TypedateTime, Period
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Alternate Namestiming
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
131. CommunicationRequest.authoredOn
Definition

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

ShortMust be in UTC timezone on the FHIR serverWhen request transitioned to being actionable
Control0..1
TypedateTime
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Alternate NamescreatedOn
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
133. CommunicationRequest.recipient
Definition

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

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

See the documentation on how to interpret the contents of this table

0. CommunicationRequest
Invariantscms-body-or-template: A CommunicationRequest must have either a message-body or a message-template payload. (payload.where(extension.where(url='https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/cms-payload-type-extension' and value='body').exists()).exists() or payload.where(extension.where(url='https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/cms-payload-type-extension' and value='template').exists()).exists())
2. CommunicationRequest.meta
Control1..?
4. CommunicationRequest.meta.profile
Control1..1
6. CommunicationRequest.meta.tag
Control1..?
SlicingThis element introduces a set of slices on CommunicationRequest.meta.tag. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ system
8. CommunicationRequest.meta.tag:correlationId
Slice NamecorrelationId
Control1..1
10. CommunicationRequest.meta.tag:correlationId.system
Definition

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

ShortHub correlation ID system
Control1..?
Pattern Value
{
  "system" : "https://hub.services.digital.health.nz/ns/correlation-id"
}
<system value="https://hub.services.digital.health.nz/ns/correlation-id"/>
12. CommunicationRequest.meta.tag:correlationId.code
Control1..?
14. CommunicationRequest.contained
Control0..0
16. CommunicationRequest.extension
Control1..?
SlicingThis element introduces a set of slices on CommunicationRequest.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
18. CommunicationRequest.extension:Campaign
Slice NameCampaign
Control0..1
TypeExtension(Campaign details) (Complex Extension)
20. CommunicationRequest.extension:ContactPoint
Slice NameContactPoint
Control1..1
TypeExtension(Send to and from communication to contact points) (Complex Extension)
22. CommunicationRequest.extension:CallbackUrl
Slice NameCallbackUrl
Control0..1
TypeExtension(Callback Url) (Extension Type: url)
24. CommunicationRequest.extension:Reply
Slice NameReply
Control0..1
TypeExtension(For sms reply) (Complex Extension)
26. CommunicationRequest.identifier
NoteThis is a business identifier, not a resource identifier (see discussion)
28. CommunicationRequest.identifier.use
Control1..?
30. CommunicationRequest.identifier.system
Control1..?
32. CommunicationRequest.identifier.value
Control1..?
34. CommunicationRequest.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)
36. CommunicationRequest.medium
Control1..?
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. CommunicationRequest.subject
TypeReference(Patient)
40. CommunicationRequest.payload
SlicingThis element introduces a set of slices on CommunicationRequest.payload. The slices are Unordered 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
42. CommunicationRequest.payload:message-body
Slice Namemessage-body
Control0..1
44. CommunicationRequest.payload:message-body.extension
Control1..?
SlicingThis element introduces a set of slices on CommunicationRequest.payload.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
46. CommunicationRequest.payload:message-body.extension:payloadType
Slice NamepayloadType
Control1..1
TypeExtension(CMS Payload Type Extension) (Extension Type: code)
48. CommunicationRequest.payload:message-body.extension:payloadType.value[x]
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
Pattern Value
{
  "valueCode" : "body"
}
<valueCode value="body"/>
50. CommunicationRequest.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 CommunicationRequest.payload.content[x]. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • type @ $this
52. CommunicationRequest.payload:message-body.content[x]:contentAttachment
Slice NamecontentAttachment
Control1..1
TypeAttachment
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
54. CommunicationRequest.payload:message-body.content[x]:contentAttachment.contentType
Pattern Value
{
  "contentType" : "text/plain"
}
<contentType value="text/plain"/>
56. CommunicationRequest.payload:message-parameters
Slice Namemessage-parameters
Control0..1
58. CommunicationRequest.payload:message-parameters.extension
Control1..?
SlicingThis element introduces a set of slices on CommunicationRequest.payload.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
60. CommunicationRequest.payload:message-parameters.extension:payloadType
Slice NamepayloadType
Control1..1
TypeExtension(CMS Payload Type Extension) (Extension Type: code)
62. CommunicationRequest.payload:message-parameters.extension:payloadType.value[x]
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
Pattern Value
{
  "valueCode" : "parameters"
}
<valueCode value="parameters"/>
64. CommunicationRequest.payload:message-parameters.content[x]
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
SlicingThis element introduces a set of slices on CommunicationRequest.payload.content[x]. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • type @ $this
66. CommunicationRequest.payload:message-parameters.content[x]:contentAttachment
Slice NamecontentAttachment
Control1..1
TypeAttachment
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
68. CommunicationRequest.payload:message-parameters.content[x]:contentAttachment.contentType
Pattern Value
{
  "contentType" : "application/json"
}
<contentType value="application/json"/>
70. CommunicationRequest.payload:attachment-file
Slice Nameattachment-file
Control0..*
72. CommunicationRequest.payload:attachment-file.extension
Control1..?
SlicingThis element introduces a set of slices on CommunicationRequest.payload.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
74. CommunicationRequest.payload:attachment-file.extension:payloadType
Slice NamepayloadType
Control1..1
TypeExtension(CMS Payload Type Extension) (Extension Type: code)
76. CommunicationRequest.payload:attachment-file.extension:payloadType.value[x]
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
Pattern Value
{
  "valueCode" : "attachment"
}
<valueCode value="attachment"/>
78. CommunicationRequest.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 CommunicationRequest.payload.content[x]. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • type @ $this
80. CommunicationRequest.payload:attachment-file.content[x]:contentAttachment
Slice NamecontentAttachment
Control1..1
TypeAttachment
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
82. CommunicationRequest.payload:attachment-file.content[x]:contentAttachment.extension:AttachmentExtension
Slice NameAttachmentExtension
Control0..1
TypeExtension(Attachment details) (Complex Extension)
84. CommunicationRequest.payload:message-template
Slice Namemessage-template
Control0..1
86. CommunicationRequest.payload:message-template.extension
Control1..?
SlicingThis element introduces a set of slices on CommunicationRequest.payload.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
88. CommunicationRequest.payload:message-template.extension:payloadType
Slice NamepayloadType
Control1..1
TypeExtension(CMS Payload Type Extension) (Extension Type: code)
90. CommunicationRequest.payload:message-template.extension:payloadType.value[x]
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
Pattern Value
{
  "valueCode" : "template"
}
<valueCode value="template"/>
92. CommunicationRequest.payload:message-template.content[x]
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
SlicingThis element introduces a set of slices on CommunicationRequest.payload.content[x]. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • type @ $this

Slicing Note: Other type slices that contain no new information are not shown in this view

94. CommunicationRequest.payload:message-template.content[x]:contentReference
Slice NamecontentReference
Control0..1
TypeReference(CMSTemplateDocumentReference)
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
96. CommunicationRequest.occurrence[x]
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
SlicingThis element introduces a set of slices on CommunicationRequest.occurrence[x]. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • type @ $this

Slicing Note: Other type slices that contain no new information are not shown in this view

98. CommunicationRequest.occurrence[x]:occurrenceDateTime
Slice NameoccurrenceDateTime
ShortMust be in UTC timezone on the FHIR server
Control0..1
TypedateTime
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
100. CommunicationRequest.authoredOn
ShortMust be in UTC timezone on the FHIR server
102. CommunicationRequest.recipient
TypeReference(Patient, Practitioner)

See the documentation on how to interpret the contents of this table

0. CommunicationRequest
Definition

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

ShortA request for information to be sent to a receiver
Control0..*
Is Modifierfalse
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())
cms-body-or-template: A CommunicationRequest must have either a message-body or a message-template payload. (payload.where(extension.where(url='https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/cms-payload-type-extension' and value='body').exists()).exists() or payload.where(extension.where(url='https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/cms-payload-type-extension' and value='template').exists()).exists())
2. CommunicationRequest.id
Definition

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

ShortLogical id of this artifact
Comments

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

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

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

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

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

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
8. CommunicationRequest.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 CommunicationRequest.meta.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
10. CommunicationRequest.meta.versionId
Definition

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

ShortVersion specific identifier
Comments

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

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

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

ShortWhen the resource version last changed
Comments

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

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

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

ShortIdentifies where the resource comes from
Comments

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

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

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

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

ShortProfiles this resource claims to conform to
Comments

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

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. CommunicationRequest.meta.security
Definition

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

ShortSecurity Labels applied to this resource
Comments

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

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

Security Labels from the Healthcare Privacy and Security Classification System.

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

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

ShortTags applied to this resource
Comments

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

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

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

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

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

TypeCoding
Is Modifierfalse
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
24. CommunicationRequest.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. CommunicationRequest.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 CommunicationRequest.meta.tag.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
28. CommunicationRequest.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 Value
{
  "system" : "https://hub.services.digital.health.nz/ns/correlation-id"
}
<system value="https://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. CommunicationRequest.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. CommunicationRequest.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. CommunicationRequest.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. CommunicationRequest.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. CommunicationRequest.implicitRules
Definition

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

ShortA set of rules under which this content was created
Comments

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

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

The base language in which the resource is written.

ShortLanguage of the resource content
Comments

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

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

A human language.

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

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

ShortText summary of the resource, for human interpretation
Comments

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

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

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

ShortContained, inline Resources
Comments

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

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

An Extension

ShortExtension
Control1..*
TypeExtension
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
SlicingThis element introduces a set of slices on CommunicationRequest.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
48. CommunicationRequest.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. CommunicationRequest.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. CommunicationRequest.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. CommunicationRequest.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())
56. CommunicationRequest.modifierExtension
Definition

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

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

ShortExtensions that cannot be ignored
Comments

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

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them
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())
58. CommunicationRequest.identifier
Definition

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

ShortUnique identifier
Comments

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

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

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

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

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

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

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

ShortAdditional content defined by implementations
Comments

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

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

The purpose of this identifier.

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

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

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

Identifies the purpose for this identifier, if known .

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

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

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

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

ShortDescription of identifier
Comments

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

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

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

TypeCodeableConcept
Is Modifierfalse
Summarytrue
Requirements

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

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

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

ShortThe namespace for the identifier value
Comments

Identifier.system is always case sensitive.

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

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

ExampleGeneral: http://www.acme.com/identifiers/patient
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
70. CommunicationRequest.identifier.value
Definition

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

ShortThe value that is unique
Comments

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

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

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

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

Organization that issued/manages the identifier.

ShortOrganization that issued id (may be just text)
Comments

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

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

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

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

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

Alternate Namesfulfills
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
78. CommunicationRequest.replaces
Definition

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

ShortRequest(s) replaced by this request
Comments

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

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

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

Alternate Namessupersedes, prior
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
80. CommunicationRequest.groupIdentifier
Definition

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

ShortComposite request this is part of
Comments

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

Control0..1
TypeIdentifier
Is Modifierfalse
Summarytrue
Alternate NamesgrouperId
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
82. CommunicationRequest.status
Definition

The status of the proposal or order.

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

The status of the communication request.

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

Captures the reason for the current state of the CommunicationRequest.

ShortReason for current status
Comments

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

Control0..1
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
Summaryfalse
Alternate NamesSuspended Reason, Cancelled Reason
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
86. CommunicationRequest.category
Definition

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

ShortMessage category
Comments

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

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

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

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

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

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

Codes indicating the relative importance of a communication request.

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

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

ShortTrue if request is prohibiting action
Comments

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

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

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

ShortA channel of communication
Control1..*
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()))
94. CommunicationRequest.subject
Definition

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

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

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

ShortResources that pertain to this communication request
Comments

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

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

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

ShortEncounter created as part of
Comments

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

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

Text, attachment(s), or resource(s) to be 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 CommunicationRequest.payload. The slices are Unordered 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
102. CommunicationRequest.payload.id
Definition

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

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
104. CommunicationRequest.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())
106. CommunicationRequest.payload.modifierExtension
Definition

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

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

ShortExtensions that cannot be ignored even if unrecognized
Comments

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

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

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

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

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

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

Text, attachment(s), or resource(s) to be 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()))
112. CommunicationRequest.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
114. CommunicationRequest.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 CommunicationRequest.payload.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
116. CommunicationRequest.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())
118. CommunicationRequest.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
120. CommunicationRequest.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 CommunicationRequest.payload.extension.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
122. CommunicationRequest.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 Value
{
  "url" : "https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/cms-payload-type-extension"
}
<url value="https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/cms-payload-type-extension"/>
124. CommunicationRequest.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 Value
{
  "valueCode" : "body"
}
<valueCode value="body"/>
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
126. CommunicationRequest.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())
128. CommunicationRequest.payload:message-body.content[x]
Definition

The 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 CommunicationRequest.payload.content[x]. The slices are Unordered and Closed, and can be differentiated using the following discriminators:
  • type @ $this
130. CommunicationRequest.payload:message-body.content[x]:contentAttachment
Slice NamecontentAttachment
Definition

The 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()))
132. CommunicationRequest.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
134. CommunicationRequest.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 CommunicationRequest.payload.content[x].extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
136. CommunicationRequest.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 Value
{
  "contentType" : "text/plain"
}
<contentType value="text/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()))
138. CommunicationRequest.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|4.0.1)

A human language.

Additional BindingsPurpose
AllLanguagesMax Binding
Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
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()))
140. CommunicationRequest.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()))
142. CommunicationRequest.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()))
144. CommunicationRequest.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()))
146. CommunicationRequest.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()))
148. CommunicationRequest.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()))
150. CommunicationRequest.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()))
152. CommunicationRequest.payload:message-parameters
Slice Namemessage-parameters
Definition

Text, attachment(s), or resource(s) to be 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()))
154. CommunicationRequest.payload:message-parameters.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
156. CommunicationRequest.payload:message-parameters.extension
Definition

An Extension

ShortExtension
Control1..*
TypeExtension
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
SlicingThis element introduces a set of slices on CommunicationRequest.payload.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
158. CommunicationRequest.payload:message-parameters.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())
160. CommunicationRequest.payload:message-parameters.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
162. CommunicationRequest.payload:message-parameters.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 CommunicationRequest.payload.extension.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
164. CommunicationRequest.payload:message-parameters.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 Value
{
  "url" : "https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/cms-payload-type-extension"
}
<url value="https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/cms-payload-type-extension"/>
166. CommunicationRequest.payload:message-parameters.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 Value
{
  "valueCode" : "parameters"
}
<valueCode value="parameters"/>
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
168. CommunicationRequest.payload:message-parameters.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())
170. CommunicationRequest.payload:message-parameters.content[x]
Definition

The 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 CommunicationRequest.payload.content[x]. The slices are Unordered and Closed, and can be differentiated using the following discriminators:
  • type @ $this
172. CommunicationRequest.payload:message-parameters.content[x]:contentAttachment
Slice NamecontentAttachment
Definition

The 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()))
174. CommunicationRequest.payload:message-parameters.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
176. CommunicationRequest.payload:message-parameters.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 CommunicationRequest.payload.content[x].extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
178. CommunicationRequest.payload:message-parameters.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 Value
{
  "contentType" : "application/json"
}
<contentType value="application/json"/>
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()))
180. CommunicationRequest.payload:message-parameters.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|4.0.1)

A human language.

Additional BindingsPurpose
AllLanguagesMax Binding
Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
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()))
182. CommunicationRequest.payload:message-parameters.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()))
184. CommunicationRequest.payload:message-parameters.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()))
186. CommunicationRequest.payload:message-parameters.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()))
188. CommunicationRequest.payload:message-parameters.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()))
190. CommunicationRequest.payload:message-parameters.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()))
192. CommunicationRequest.payload:message-parameters.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()))
194. CommunicationRequest.payload:attachment-file
Slice Nameattachment-file
Definition

Text, attachment(s), or resource(s) to be 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()))
196. CommunicationRequest.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
198. CommunicationRequest.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 CommunicationRequest.payload.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
200. CommunicationRequest.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())
202. CommunicationRequest.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
204. CommunicationRequest.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 CommunicationRequest.payload.extension.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
206. CommunicationRequest.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 Value
{
  "url" : "https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/cms-payload-type-extension"
}
<url value="https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/cms-payload-type-extension"/>
208. CommunicationRequest.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 Value
{
  "valueCode" : "attachment"
}
<valueCode value="attachment"/>
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
210. CommunicationRequest.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())
212. CommunicationRequest.payload:attachment-file.content[x]
Definition

The 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 CommunicationRequest.payload.content[x]. The slices are Unordered and Closed, and can be differentiated using the following discriminators:
  • type @ $this
214. CommunicationRequest.payload:attachment-file.content[x]:contentAttachment
Slice NamecontentAttachment
Definition

The 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()))
216. CommunicationRequest.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
218. CommunicationRequest.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 CommunicationRequest.payload.content[x].extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
220. CommunicationRequest.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())
222. CommunicationRequest.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()))
224. CommunicationRequest.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|4.0.1)

A human language.

Additional BindingsPurpose
AllLanguagesMax Binding
Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
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()))
226. CommunicationRequest.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()))
228. CommunicationRequest.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()))
230. CommunicationRequest.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()))
232. CommunicationRequest.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()))
234. CommunicationRequest.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()))
236. CommunicationRequest.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()))
238. CommunicationRequest.payload:message-template
Slice Namemessage-template
Definition

Text, attachment(s), or resource(s) to be 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()))
240. CommunicationRequest.payload:message-template.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
242. CommunicationRequest.payload:message-template.extension
Definition

An Extension

ShortExtension
Control1..*
TypeExtension
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
SlicingThis element introduces a set of slices on CommunicationRequest.payload.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
244. CommunicationRequest.payload:message-template.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())
246. CommunicationRequest.payload:message-template.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
248. CommunicationRequest.payload:message-template.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 CommunicationRequest.payload.extension.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
250. CommunicationRequest.payload:message-template.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 Value
{
  "url" : "https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/cms-payload-type-extension"
}
<url value="https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/cms-payload-type-extension"/>
252. CommunicationRequest.payload:message-template.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 Value
{
  "valueCode" : "template"
}
<valueCode value="template"/>
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
254. CommunicationRequest.payload:message-template.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())
256. CommunicationRequest.payload:message-template.content[x]
Definition

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

ShortMessage part content
Control1..1
TypeChoice of: string, Attachment, Reference(Resource)
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
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 CommunicationRequest.payload.content[x]. The slices are Unordered and Closed, and can be differentiated using the following discriminators:
  • type @ $this

Slicing Note: Other type slices that contain no new information are not shown in this view

258. CommunicationRequest.payload:message-template.content[x]:contentReference
Slice NamecontentReference
Definition

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

ShortMessage part content
Control0..1
TypeReference(CMSTemplateDocumentReference)
[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()))
262. CommunicationRequest.occurrence[x]
Definition

The time when this communication is to occur.

ShortWhen scheduled
Control0..1
TypeChoice of: dateTime, Period
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Alternate Namestiming
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 CommunicationRequest.occurrence[x]. The slices are Unordered and Closed, and can be differentiated using the following discriminators:
  • type @ $this

Slicing Note: Other type slices that contain no new information are not shown in this view

264. CommunicationRequest.occurrence[x]:occurrenceDateTime
Slice NameoccurrenceDateTime
Definition

The time when this communication is to occur.

ShortMust be in UTC timezone on the FHIR server
Control0..1
TypedateTime
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Alternate Namestiming
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
267. CommunicationRequest.authoredOn
Definition

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

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
Summarytrue
Alternate NamescreatedOn
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
269. CommunicationRequest.requester
Definition

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

ShortWho/what is requesting service
Control0..1
TypeReference(Practitioner, PractitionerRole, Organization, Patient, RelatedPerson, Device)
Is Modifierfalse
Summarytrue
Alternate Namesauthor
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
271. CommunicationRequest.recipient
Definition

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

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

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

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

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

ShortWhy is communication needed?
Comments

Textual reasons can be captured using reasonCode.text.

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

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()))
277. CommunicationRequest.reasonReference
Definition

Indicates another resource whose existence justifies this request.

ShortWhy is communication needed?
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()))
279. CommunicationRequest.note
Definition

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

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