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

• Content
• Detailed Descriptions
• Mappings
• Examples
• XML
• JSON
• TTL

Resource Profile: CMS Communication Request

This resource is a record of a request for a communication to be performed. The performance of a CommunicationRequest may result in a communication resource. The following content attachment ID's are special message-body attachment-fileX message-template message-parameters

A request for communication

Usages:

• Refer to this Profile: Outpatient Communication CarePlan
• Examples for this Profile: CommunicationRequest/EmailCommunicationRequestWithTemplateExample, CommunicationRequest/EmailCommunicationRequestWithoutTemplateExample, CommunicationRequest/OutpatientCommunicationRequestEmailExample, CommunicationRequest/RPMPatientOnboardingCommunicationRequest... Show 2 more, CommunicationRequest/SMSCommunicationRequestWithTemplateExample and CommunicationRequest/SMSCommunicationRequestWithoutTemplateExample
• CapabilityStatements using this Profile: Shared Care FHIR Server Capability Statement

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

• Key Elements Table
• Differential Table
• Snapshot Table
• Statistics/References
• All

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
CommunicationRequest	C	0..*	CommunicationRequest	A request for information to be sent to a receiver Constraints: cms-body-or-template
meta	Σ	1..1	Meta	Metadata about the resource
profile	Σ	1..1	canonical(StructureDefinition)	Profiles this resource claims to conform to
Slices for tag	Σ	1..*	Coding	Tags applied to this resource Slice: Unordered, Open by value:system Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
tag:correlationId	Σ	1..1	Coding	Tags applied to this resource Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
system	Σ	1..1	uri	Hub correlation ID system Required Pattern: https://hub.services.digital.health.nz/ns/correlation-id
code	Σ	1..1	code	Symbol in syntax defined by the system
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url
extension:Campaign		0..1	(Complex)	Campaign details URL: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/hnz-campaign-extension
extension:ContactPoint		1..1	(Complex)	Send to and from communication to contact points URL: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/hnz-contact-point-extension
extension:CallbackUrl		0..1	url	Callback Url URL: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/hnz-system-callback-url-extension
extension:Reply		0..1	(Complex)	For sms reply URL: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/hnz-system-reply-extension
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
status	?!Σ	1..1	code	draft | active | on-hold | revoked | completed | entered-in-error | unknown Binding: RequestStatus (required): The status of the communication request.
statusReason		0..1	CodeableConcept	Reason for current status Binding: Valueset for Communication Delivery Status (required)
doNotPerform	?!Σ	0..1	boolean	True if request is prohibiting action
medium		1..*	CodeableConcept	A channel of communication Binding: Valueset for Participation Mode (required)
subject		0..1	Reference(Patient)	Focus of message
Slices for payload		0..*	BackboneElement	Message payload Slice: Unordered, Open by value:extension('https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/cms-payload-type-extension').value
payload:All Slices				Content/Rules for all slices
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
content[x]		1..1		Message part content
contentString			string
contentAttachment			Attachment
contentReference			Reference(Resource)
payload:message-body		0..1	BackboneElement	Message payload
Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url
Slices for extension				Content/Rules for all slices
extension:payloadType		1..1	(Complex)	CMS Payload Type Extension URL: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/cms-payload-type-extension
extension		0..0		Extension Slice: Unordered, Open by value:url
url		1..1	uri	"https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/cms-payload-type-extension"
value[x]		0..1	code	Value of extension Binding: CMS Payload Type ValueSet (required) Required Pattern: body
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
Slices for content[x]		1..1	Attachment	Message part content Slice: Unordered, Closed by type:$this
Slices for content[x]				Content/Rules for all slices
content[x]:contentAttachment		1..1	Attachment	Message part content
contentType	Σ	0..1	code	Mime type of the content, with charset etc. Binding: Mime Types (required): The mime type of an attachment. Any valid mime type is allowed. Required Pattern: text/plain
payload:message-parameters		0..1	BackboneElement	Message payload
Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url
Slices for extension				Content/Rules for all slices
extension:payloadType		1..1	(Complex)	CMS Payload Type Extension URL: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/cms-payload-type-extension
extension		0..0		Extension Slice: Unordered, Open by value:url
url		1..1	uri	"https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/cms-payload-type-extension"
value[x]		0..1	code	Value of extension Binding: CMS Payload Type ValueSet (required) Required Pattern: parameters
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
Slices for content[x]		1..1	Attachment	Message part content Slice: Unordered, Closed by type:$this
Slices for content[x]				Content/Rules for all slices
content[x]:contentAttachment		1..1	Attachment	Message part content
contentType	Σ	0..1	code	Mime type of the content, with charset etc. Binding: Mime Types (required): The mime type of an attachment. Any valid mime type is allowed. Required Pattern: application/json
payload:attachment-file		0..*	BackboneElement	Message payload
Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url
Slices for extension				Content/Rules for all slices
extension:payloadType		1..1	(Complex)	CMS Payload Type Extension URL: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/cms-payload-type-extension
extension		0..0		Extension Slice: Unordered, Open by value:url
url		1..1	uri	"https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/cms-payload-type-extension"
value[x]		0..1	code	Value of extension Binding: CMS Payload Type ValueSet (required) Required Pattern: attachment
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
Slices for content[x]		1..1	Attachment	Message part content Slice: Unordered, Closed by type:$this
Slices for content[x]				Content/Rules for all slices
content[x]:contentAttachment		1..1	Attachment	Message part content
Slices for extension				Content/Rules for all slices
extension:AttachmentExtension		0..1	(Complex)	Attachment details URL: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/hnz-attachment-extension
payload:message-template		0..1	BackboneElement	Message payload
Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url
Slices for extension				Content/Rules for all slices
extension:payloadType		1..1	(Complex)	CMS Payload Type Extension URL: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/cms-payload-type-extension
extension		0..0		Extension Slice: Unordered, Open by value:url
url		1..1	uri	"https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/cms-payload-type-extension"
value[x]		0..1	code	Value of extension Binding: CMS Payload Type ValueSet (required) Required Pattern: template
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
Slices for content[x]		1..1		Message part content Slice: Unordered, Open by type:$this
contentString			string
contentAttachment			Attachment
contentReference			Reference(Resource)
Slices for content[x]				Content/Rules for all slices
content[x]:contentReference		0..1	Reference(CMSTemplateDocumentReference)	Message part content
Slices for occurrence[x]	Σ	0..1		When scheduled Slice: Unordered, Open by type:$this
occurrenceDateTime			dateTime
occurrencePeriod			Period
occurrence[x]:occurrenceDateTime	Σ	0..1	dateTime	Must be in UTC timezone on the FHIR server
authoredOn	Σ	0..1	dateTime	Must be in UTC timezone on the FHIR server
recipient		0..*	Reference(Patient | Practitioner)	Message recipient
Documentation for this format

Terminology Bindings

Path	Status	Usage	ValueSet	Version	Source
CommunicationRequest.​meta.tag	Base	example	Common Tags	📍4.0.1	FHIR Std.
CommunicationRequest.​meta.tag:correlationId	Base	example	Common Tags	📍4.0.1	FHIR Std.
CommunicationRequest.​status	Base	required	RequestStatus	📍4.0.1	FHIR Std.
CommunicationRequest.​statusReason	Base	required	Valueset for Communication Delivery Status	📦1.0.0	This IG
CommunicationRequest.​medium	Base	required	Valueset for Participation Mode	📦1.0.0	This IG
CommunicationRequest.​payload:message-body.​extension:payloadType.​value[x]	Base	required	CMS Payload Type ValueSet	📦0.4.5	This IG
CommunicationRequest.​payload:message-body.​content[x]:contentAttachment.​contentType	Base	required	MimeType	📍4.0.1	FHIR Std.
CommunicationRequest.​payload:message-parameters.​extension:payloadType.​value[x]	Base	required	CMS Payload Type ValueSet	📦0.4.5	This IG
CommunicationRequest.​payload:message-parameters.​content[x]:contentAttachment.​contentType	Base	required	MimeType	📍4.0.1	FHIR Std.
CommunicationRequest.​payload:attachment-file.​extension:payloadType.​value[x]	Base	required	CMS Payload Type ValueSet	📦0.4.5	This IG
CommunicationRequest.​payload:message-template.​extension:payloadType.​value[x]	Base	required	CMS Payload Type ValueSet	📦0.4.5	This IG

Constraints

Id	Grade	Path(s)	Description	Expression
cms-body-or-template	error	CommunicationRequest	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()
dom-2	error	CommunicationRequest	If the resource is contained in another resource, it SHALL NOT contain nested Resources	contained.contained.empty()
dom-3	error	CommunicationRequest	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	error	CommunicationRequest	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	error	CommunicationRequest	If a resource is contained in another resource, it SHALL NOT have a security label	contained.meta.security.empty()
dom-6	best practice	CommunicationRequest	A resource should have narrative for robust management	text.`div`.exists()
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children	hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both	extension.exists() != value.exists()

This structure is derived from CommunicationRequest

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
CommunicationRequest	C	0..*	CommunicationRequest	A request for information to be sent to a receiver Constraints: cms-body-or-template
meta		1..1	Meta	Metadata about the resource
profile		1..1	canonical(StructureDefinition)	Profiles this resource claims to conform to
Slices for tag		1..*	Coding	Tags applied to this resource Slice: Unordered, Open by value:system
tag:correlationId		1..1	Coding	Tags applied to this resource
system		1..1	uri	Hub correlation ID system Required Pattern: https://hub.services.digital.health.nz/ns/correlation-id
code		1..1	code	Symbol in syntax defined by the system
contained		0..0		Contained, inline Resources
Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url
extension:Campaign		0..1	(Complex)	Campaign details URL: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/hnz-campaign-extension
extension:ContactPoint		1..1	(Complex)	Send to and from communication to contact points URL: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/hnz-contact-point-extension
extension:CallbackUrl		0..1	url	Callback Url URL: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/hnz-system-callback-url-extension
extension:Reply		0..1	(Complex)	For sms reply URL: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/hnz-system-reply-extension
identifier
use		1..1	code	usual | official | temp | secondary | old (If known)
system		1..1	uri	The namespace for the identifier value
value		1..1	string	The value that is unique
statusReason		0..1	CodeableConcept	Reason for current status Binding: Valueset for Communication Delivery Status (required)
medium		1..*	CodeableConcept	A channel of communication Binding: Valueset for Participation Mode (required)
subject		0..1	Reference(Patient)	Focus of message
Slices for payload		0..*	BackboneElement	Message payload Slice: Unordered, Open by value:extension('https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/cms-payload-type-extension').value
payload:message-body		0..1	BackboneElement	Message payload
Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url
Slices for extension				Content/Rules for all slices
extension:payloadType		1..1	(Complex)	CMS Payload Type Extension URL: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/cms-payload-type-extension
value[x]		0..1	code	Value of extension Required Pattern: body
Slices for content[x]		1..1	Attachment	Message part content Slice: Unordered, Open by type:$this
Slices for content[x]				Content/Rules for all slices
content[x]:contentAttachment		1..1	Attachment	Message part content
contentType		0..1	code	Mime type of the content, with charset etc. Required Pattern: text/plain
payload:message-parameters		0..1	BackboneElement	Message payload
Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url
Slices for extension				Content/Rules for all slices
extension:payloadType		1..1	(Complex)	CMS Payload Type Extension URL: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/cms-payload-type-extension
value[x]		0..1	code	Value of extension Required Pattern: parameters
Slices for content[x]		1..1	Attachment	Message part content Slice: Unordered, Open by type:$this
Slices for content[x]				Content/Rules for all slices
content[x]:contentAttachment		1..1	Attachment	Message part content
contentType		0..1	code	Mime type of the content, with charset etc. Required Pattern: application/json
payload:attachment-file		0..*	BackboneElement	Message payload
Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url
Slices for extension				Content/Rules for all slices
extension:payloadType		1..1	(Complex)	CMS Payload Type Extension URL: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/cms-payload-type-extension
value[x]		0..1	code	Value of extension Required Pattern: attachment
Slices for content[x]		1..1	Attachment	Message part content Slice: Unordered, Open by type:$this
Slices for content[x]				Content/Rules for all slices
content[x]:contentAttachment		1..1	Attachment	Message part content
Slices for extension				Content/Rules for all slices
extension:AttachmentExtension		0..1	(Complex)	Attachment details URL: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/hnz-attachment-extension
payload:message-template		0..1	BackboneElement	Message payload
Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url
Slices for extension				Content/Rules for all slices
extension:payloadType		1..1	(Complex)	CMS Payload Type Extension URL: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/cms-payload-type-extension
value[x]		0..1	code	Value of extension Required Pattern: template
Slices for content[x]		1..1	string, Attachment, Reference(Resource)	Message part content Slice: Unordered, Open by type:$this
Slices for content[x]				Content/Rules for all slices
content[x]:contentReference		0..1	Reference(CMSTemplateDocumentReference)	Message part content
Slices for occurrence[x]		0..1	dateTime, Period	When scheduled Slice: Unordered, Open by type:$this
occurrence[x]:occurrenceDateTime		0..1	dateTime	Must be in UTC timezone on the FHIR server
authoredOn		0..1	dateTime	Must be in UTC timezone on the FHIR server
recipient		0..*	Reference(Patient | Practitioner)	Message recipient
Documentation for this format

Terminology Bindings (Differential)

Path	Status	Usage	ValueSet	Version	Source
CommunicationRequest.​statusReason	Base	required	Valueset for Communication Delivery Status	📦1.0.0	This IG
CommunicationRequest.​medium	Base	required	Valueset for Participation Mode	📦1.0.0	This IG

Constraints

Id	Grade	Path(s)	Description	Expression
cms-body-or-template	error	CommunicationRequest	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()

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
CommunicationRequest	C	0..*	CommunicationRequest	A request for information to be sent to a receiver Constraints: cms-body-or-template
id	Σ	0..1	id	Logical id of this artifact
meta	Σ	1..1	Meta	Metadata about the resource
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
versionId	Σ	0..1	id	Version specific identifier
lastUpdated	Σ	0..1	instant	When the resource version last changed
source	Σ	0..1	uri	Identifies where the resource comes from
profile	Σ	1..1	canonical(StructureDefinition)	Profiles this resource claims to conform to
security	Σ	0..*	Coding	Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
Slices for tag	Σ	1..*	Coding	Tags applied to this resource Slice: Unordered, Open by value:system Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
tag:correlationId	Σ	1..1	Coding	Tags applied to this resource Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
system	Σ	1..1	uri	Hub correlation ID system Required Pattern: https://hub.services.digital.health.nz/ns/correlation-id
version	Σ	0..1	string	Version of the system - if relevant
code	Σ	1..1	code	Symbol in syntax defined by the system
display	Σ	0..1	string	Representation defined by the system
userSelected	Σ	0..1	boolean	If this coding was chosen directly by the user
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
language		0..1	code	Language of the resource content Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
text		0..1	Narrative	Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements
Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url
extension:Campaign		0..1	(Complex)	Campaign details URL: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/hnz-campaign-extension
extension:ContactPoint		1..1	(Complex)	Send to and from communication to contact points URL: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/hnz-contact-point-extension
extension:CallbackUrl		0..1	url	Callback Url URL: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/hnz-system-callback-url-extension
extension:Reply		0..1	(Complex)	For sms reply URL: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/hnz-system-reply-extension
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
identifier	Σ	0..*	Identifier	Unique identifier
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
use	?!Σ	1..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type	Σ	0..1	CodeableConcept	Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
system	Σ	1..1	uri	The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
value	Σ	1..1	string	The value that is unique Example General: 123456
period	Σ	0..1	Period	Time period when id is/was valid for use
assigner	Σ	0..1	Reference(Organization)	Organization that issued id (may be just text)
basedOn	Σ	0..*	Reference(Resource)	Fulfills plan or proposal
replaces	Σ	0..*	Reference(CommunicationRequest)	Request(s) replaced by this request
groupIdentifier	Σ	0..1	Identifier	Composite request this is part of
status	?!Σ	1..1	code	draft | active | on-hold | revoked | completed | entered-in-error | unknown Binding: RequestStatus (required): The status of the communication request.
statusReason		0..1	CodeableConcept	Reason for current status Binding: Valueset for Communication Delivery Status (required)
category		0..*	CodeableConcept	Message category Binding: CommunicationCategory (example): Codes for general categories of communications such as alerts, instruction, etc.
priority	Σ	0..1	code	routine | urgent | asap | stat Binding: RequestPriority (required): Codes indicating the relative importance of a communication request.
doNotPerform	?!Σ	0..1	boolean	True if request is prohibiting action
medium		1..*	CodeableConcept	A channel of communication Binding: Valueset for Participation Mode (required)
subject		0..1	Reference(Patient)	Focus of message
about		0..*	Reference(Resource)	Resources that pertain to this communication request
encounter	Σ	0..1	Reference(Encounter)	Encounter created as part of
Slices for payload		0..*	BackboneElement	Message payload Slice: Unordered, Open by value:extension('https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/cms-payload-type-extension').value
payload:All Slices				Content/Rules for all slices
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
content[x]		1..1		Message part content
contentString			string
contentAttachment			Attachment
contentReference			Reference(Resource)
payload:message-body		0..1	BackboneElement	Message payload
id		0..1	string	Unique id for inter-element referencing
Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url
Slices for extension				Content/Rules for all slices
extension:payloadType		1..1	(Complex)	CMS Payload Type Extension URL: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/cms-payload-type-extension
id		0..1	string	Unique id for inter-element referencing
extension		0..0		Extension Slice: Unordered, Open by value:url
url		1..1	uri	"https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/cms-payload-type-extension"
value[x]		0..1	code	Value of extension Binding: CMS Payload Type ValueSet (required) Required Pattern: body
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
Slices for content[x]		1..1	Attachment	Message part content Slice: Unordered, Closed by type:$this
Slices for content[x]				Content/Rules for all slices
content[x]:contentAttachment		1..1	Attachment	Message part content
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
contentType	Σ	0..1	code	Mime type of the content, with charset etc. Binding: Mime Types (required): The mime type of an attachment. Any valid mime type is allowed. Required Pattern: text/plain
language	Σ	0..1	code	Human language of the content (BCP-47) Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding Example General: en-AU
data		0..1	base64Binary	Data inline, base64ed
url	Σ	0..1	url	Uri where the data can be found Example General: http://www.acme.com/logo-small.png
size	Σ	0..1	unsignedInt	Number of bytes of content (if url provided)
hash	Σ	0..1	base64Binary	Hash of the data (sha-1, base64ed)
title	Σ	0..1	string	Label to display in place of the data Example General: Official Corporate Logo
creation	Σ	0..1	dateTime	Date attachment was first created
payload:message-parameters		0..1	BackboneElement	Message payload
id		0..1	string	Unique id for inter-element referencing
Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url
Slices for extension				Content/Rules for all slices
extension:payloadType		1..1	(Complex)	CMS Payload Type Extension URL: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/cms-payload-type-extension
id		0..1	string	Unique id for inter-element referencing
extension		0..0		Extension Slice: Unordered, Open by value:url
url		1..1	uri	"https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/cms-payload-type-extension"
value[x]		0..1	code	Value of extension Binding: CMS Payload Type ValueSet (required) Required Pattern: parameters
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
Slices for content[x]		1..1	Attachment	Message part content Slice: Unordered, Closed by type:$this
Slices for content[x]				Content/Rules for all slices
content[x]:contentAttachment		1..1	Attachment	Message part content
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
contentType	Σ	0..1	code	Mime type of the content, with charset etc. Binding: Mime Types (required): The mime type of an attachment. Any valid mime type is allowed. Required Pattern: application/json
language	Σ	0..1	code	Human language of the content (BCP-47) Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding Example General: en-AU
data		0..1	base64Binary	Data inline, base64ed
url	Σ	0..1	url	Uri where the data can be found Example General: http://www.acme.com/logo-small.png
size	Σ	0..1	unsignedInt	Number of bytes of content (if url provided)
hash	Σ	0..1	base64Binary	Hash of the data (sha-1, base64ed)
title	Σ	0..1	string	Label to display in place of the data Example General: Official Corporate Logo
creation	Σ	0..1	dateTime	Date attachment was first created
payload:attachment-file		0..*	BackboneElement	Message payload
id		0..1	string	Unique id for inter-element referencing
Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url
Slices for extension				Content/Rules for all slices
extension:payloadType		1..1	(Complex)	CMS Payload Type Extension URL: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/cms-payload-type-extension
id		0..1	string	Unique id for inter-element referencing
extension		0..0		Extension Slice: Unordered, Open by value:url
url		1..1	uri	"https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/cms-payload-type-extension"
value[x]		0..1	code	Value of extension Binding: CMS Payload Type ValueSet (required) Required Pattern: attachment
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
Slices for content[x]		1..1	Attachment	Message part content Slice: Unordered, Closed by type:$this
Slices for content[x]				Content/Rules for all slices
content[x]:contentAttachment		1..1	Attachment	Message part content
id		0..1	string	Unique id for inter-element referencing
Slices for extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
Slices for extension				Content/Rules for all slices
extension:AttachmentExtension		0..1	(Complex)	Attachment details URL: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/hnz-attachment-extension
contentType	Σ	0..1	code	Mime type of the content, with charset etc. Binding: Mime Types (required): The mime type of an attachment. Any valid mime type is allowed. Example General: text/plain; charset=UTF-8, image/png
language	Σ	0..1	code	Human language of the content (BCP-47) Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding Example General: en-AU
data		0..1	base64Binary	Data inline, base64ed
url	Σ	0..1	url	Uri where the data can be found Example General: http://www.acme.com/logo-small.png
size	Σ	0..1	unsignedInt	Number of bytes of content (if url provided)
hash	Σ	0..1	base64Binary	Hash of the data (sha-1, base64ed)
title	Σ	0..1	string	Label to display in place of the data Example General: Official Corporate Logo
creation	Σ	0..1	dateTime	Date attachment was first created
payload:message-template		0..1	BackboneElement	Message payload
id		0..1	string	Unique id for inter-element referencing
Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url
Slices for extension				Content/Rules for all slices
extension:payloadType		1..1	(Complex)	CMS Payload Type Extension URL: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/cms-payload-type-extension
id		0..1	string	Unique id for inter-element referencing
extension		0..0		Extension Slice: Unordered, Open by value:url
url		1..1	uri	"https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/cms-payload-type-extension"
value[x]		0..1	code	Value of extension Binding: CMS Payload Type ValueSet (required) Required Pattern: template
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
Slices for content[x]		1..1		Message part content Slice: Unordered, Open by type:$this
contentString			string
contentAttachment			Attachment
contentReference			Reference(Resource)
Slices for content[x]				Content/Rules for all slices
content[x]:contentReference		0..1	Reference(CMSTemplateDocumentReference)	Message part content
Slices for occurrence[x]	Σ	0..1		When scheduled Slice: Unordered, Open by type:$this
occurrenceDateTime			dateTime
occurrencePeriod			Period
occurrence[x]:occurrenceDateTime	Σ	0..1	dateTime	Must be in UTC timezone on the FHIR server
authoredOn	Σ	0..1	dateTime	Must be in UTC timezone on the FHIR server
requester	Σ	0..1	Reference(Practitioner | PractitionerRole | Organization | Patient | RelatedPerson | Device)	Who/what is requesting service
recipient		0..*	Reference(Patient | Practitioner)	Message recipient
sender	Σ	0..1	Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson | HealthcareService)	Message sender
reasonCode	Σ	0..*	CodeableConcept	Why is communication needed? Binding: v3 Code System ActReason (example): Codes for describing reasons for the occurrence of a communication.
reasonReference	Σ	0..*	Reference(Condition | Observation | DiagnosticReport | DocumentReference)	Why is communication needed?
note		0..*	Annotation	Comments made about communication request
Documentation for this format

Terminology Bindings

Path	Status	Usage	ValueSet	Version	Source
CommunicationRequest.​meta.security	Base	extensible	SecurityLabels	📍4.0.1	FHIR Std.
CommunicationRequest.​meta.tag	Base	example	Common Tags	📍4.0.1	FHIR Std.
CommunicationRequest.​meta.tag:correlationId	Base	example	Common Tags	📍4.0.1	FHIR Std.
CommunicationRequest.​language	Base	preferred	Common Languages	📍4.0.1	FHIR Std.
CommunicationRequest.​identifier.use	Base	required	IdentifierUse	📍4.0.1	FHIR Std.
CommunicationRequest.​identifier.type	Base	extensible	IdentifierType	📍4.0.1	FHIR Std.
CommunicationRequest.​status	Base	required	RequestStatus	📍4.0.1	FHIR Std.
CommunicationRequest.​statusReason	Base	required	Valueset for Communication Delivery Status	📦1.0.0	This IG
CommunicationRequest.​category	Base	example	CommunicationCategory	📍4.0.1	FHIR Std.
CommunicationRequest.​priority	Base	required	Request priority	📍4.0.1	FHIR Std.
CommunicationRequest.​medium	Base	required	Valueset for Participation Mode	📦1.0.0	This IG
CommunicationRequest.​payload:message-body.​extension:payloadType.​value[x]	Base	required	CMS Payload Type ValueSet	📦0.4.5	This IG
CommunicationRequest.​payload:message-body.​content[x]:contentAttachment.​contentType	Base	required	MimeType	📍4.0.1	FHIR Std.
CommunicationRequest.​payload:message-body.​content[x]:contentAttachment.​language	Base	preferred	Common Languages	📍4.0.1	FHIR Std.
CommunicationRequest.​payload:message-parameters.​extension:payloadType.​value[x]	Base	required	CMS Payload Type ValueSet	📦0.4.5	This IG
CommunicationRequest.​payload:message-parameters.​content[x]:contentAttachment.​contentType	Base	required	MimeType	📍4.0.1	FHIR Std.
CommunicationRequest.​payload:message-parameters.​content[x]:contentAttachment.​language	Base	preferred	Common Languages	📍4.0.1	FHIR Std.
CommunicationRequest.​payload:attachment-file.​extension:payloadType.​value[x]	Base	required	CMS Payload Type ValueSet	📦0.4.5	This IG
CommunicationRequest.​payload:attachment-file.​content[x]:contentAttachment.​contentType	Base	required	MimeType	📍4.0.1	FHIR Std.
CommunicationRequest.​payload:attachment-file.​content[x]:contentAttachment.​language	Base	preferred	Common Languages	📍4.0.1	FHIR Std.
CommunicationRequest.​payload:message-template.​extension:payloadType.​value[x]	Base	required	CMS Payload Type ValueSet	📦0.4.5	This IG
CommunicationRequest.​reasonCode	Base	example	v3 Code System ActReason	📦3.0.0	THO v6.5

Constraints

Id	Grade	Path(s)	Description	Expression
cms-body-or-template	error	CommunicationRequest	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()
dom-2	error	CommunicationRequest	If the resource is contained in another resource, it SHALL NOT contain nested Resources	contained.contained.empty()
dom-3	error	CommunicationRequest	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	error	CommunicationRequest	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	error	CommunicationRequest	If a resource is contained in another resource, it SHALL NOT have a security label	contained.meta.security.empty()
dom-6	best practice	CommunicationRequest	A resource should have narrative for robust management	text.`div`.exists()
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children	hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both	extension.exists() != value.exists()

This structure is derived from CommunicationRequest

Summary

Mandatory: 9 elements(14 nested mandatory elements)
Prohibited: 1 element

Structures

This structure refers to these other structures:

• CMSTemplateDocumentReference (https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/TemplateDocumentReference)

Extensions

This structure refers to these extensions:

• https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/hnz-campaign-extension
• https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/hnz-contact-point-extension
• https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/hnz-system-callback-url-extension
• https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/hnz-system-reply-extension
• https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/cms-payload-type-extension
• https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/hnz-attachment-extension

Slices

This structure defines the following Slices:

• The element 1 is sliced based on the value of CommunicationRequest.meta.tag
• The element 1 is sliced based on the value of CommunicationRequest.payload
• The element 1 is sliced based on the value of CommunicationRequest.payload.content[x]
• The element 1 is sliced based on the value of CommunicationRequest.occurrence[x]

Key Elements View

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
CommunicationRequest	C	0..*	CommunicationRequest	A request for information to be sent to a receiver Constraints: cms-body-or-template
meta	Σ	1..1	Meta	Metadata about the resource
profile	Σ	1..1	canonical(StructureDefinition)	Profiles this resource claims to conform to
Slices for tag	Σ	1..*	Coding	Tags applied to this resource Slice: Unordered, Open by value:system Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
tag:correlationId	Σ	1..1	Coding	Tags applied to this resource Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
system	Σ	1..1	uri	Hub correlation ID system Required Pattern: https://hub.services.digital.health.nz/ns/correlation-id
code	Σ	1..1	code	Symbol in syntax defined by the system
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url
extension:Campaign		0..1	(Complex)	Campaign details URL: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/hnz-campaign-extension
extension:ContactPoint		1..1	(Complex)	Send to and from communication to contact points URL: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/hnz-contact-point-extension
extension:CallbackUrl		0..1	url	Callback Url URL: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/hnz-system-callback-url-extension
extension:Reply		0..1	(Complex)	For sms reply URL: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/hnz-system-reply-extension
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
status	?!Σ	1..1	code	draft | active | on-hold | revoked | completed | entered-in-error | unknown Binding: RequestStatus (required): The status of the communication request.
statusReason		0..1	CodeableConcept	Reason for current status Binding: Valueset for Communication Delivery Status (required)
doNotPerform	?!Σ	0..1	boolean	True if request is prohibiting action
medium		1..*	CodeableConcept	A channel of communication Binding: Valueset for Participation Mode (required)
subject		0..1	Reference(Patient)	Focus of message
Slices for payload		0..*	BackboneElement	Message payload Slice: Unordered, Open by value:extension('https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/cms-payload-type-extension').value
payload:All Slices				Content/Rules for all slices
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
content[x]		1..1		Message part content
contentString			string
contentAttachment			Attachment
contentReference			Reference(Resource)
payload:message-body		0..1	BackboneElement	Message payload
Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url
Slices for extension				Content/Rules for all slices
extension:payloadType		1..1	(Complex)	CMS Payload Type Extension URL: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/cms-payload-type-extension
extension		0..0		Extension Slice: Unordered, Open by value:url
url		1..1	uri	"https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/cms-payload-type-extension"
value[x]		0..1	code	Value of extension Binding: CMS Payload Type ValueSet (required) Required Pattern: body
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
Slices for content[x]		1..1	Attachment	Message part content Slice: Unordered, Closed by type:$this
Slices for content[x]				Content/Rules for all slices
content[x]:contentAttachment		1..1	Attachment	Message part content
contentType	Σ	0..1	code	Mime type of the content, with charset etc. Binding: Mime Types (required): The mime type of an attachment. Any valid mime type is allowed. Required Pattern: text/plain
payload:message-parameters		0..1	BackboneElement	Message payload
Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url
Slices for extension				Content/Rules for all slices
extension:payloadType		1..1	(Complex)	CMS Payload Type Extension URL: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/cms-payload-type-extension
extension		0..0		Extension Slice: Unordered, Open by value:url
url		1..1	uri	"https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/cms-payload-type-extension"
value[x]		0..1	code	Value of extension Binding: CMS Payload Type ValueSet (required) Required Pattern: parameters
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
Slices for content[x]		1..1	Attachment	Message part content Slice: Unordered, Closed by type:$this
Slices for content[x]				Content/Rules for all slices
content[x]:contentAttachment		1..1	Attachment	Message part content
contentType	Σ	0..1	code	Mime type of the content, with charset etc. Binding: Mime Types (required): The mime type of an attachment. Any valid mime type is allowed. Required Pattern: application/json
payload:attachment-file		0..*	BackboneElement	Message payload
Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url
Slices for extension				Content/Rules for all slices
extension:payloadType		1..1	(Complex)	CMS Payload Type Extension URL: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/cms-payload-type-extension
extension		0..0		Extension Slice: Unordered, Open by value:url
url		1..1	uri	"https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/cms-payload-type-extension"
value[x]		0..1	code	Value of extension Binding: CMS Payload Type ValueSet (required) Required Pattern: attachment
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
Slices for content[x]		1..1	Attachment	Message part content Slice: Unordered, Closed by type:$this
Slices for content[x]				Content/Rules for all slices
content[x]:contentAttachment		1..1	Attachment	Message part content
Slices for extension				Content/Rules for all slices
extension:AttachmentExtension		0..1	(Complex)	Attachment details URL: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/hnz-attachment-extension
payload:message-template		0..1	BackboneElement	Message payload
Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url
Slices for extension				Content/Rules for all slices
extension:payloadType		1..1	(Complex)	CMS Payload Type Extension URL: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/cms-payload-type-extension
extension		0..0		Extension Slice: Unordered, Open by value:url
url		1..1	uri	"https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/cms-payload-type-extension"
value[x]		0..1	code	Value of extension Binding: CMS Payload Type ValueSet (required) Required Pattern: template
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
Slices for content[x]		1..1		Message part content Slice: Unordered, Open by type:$this
contentString			string
contentAttachment			Attachment
contentReference			Reference(Resource)
Slices for content[x]				Content/Rules for all slices
content[x]:contentReference		0..1	Reference(CMSTemplateDocumentReference)	Message part content
Slices for occurrence[x]	Σ	0..1		When scheduled Slice: Unordered, Open by type:$this
occurrenceDateTime			dateTime
occurrencePeriod			Period
occurrence[x]:occurrenceDateTime	Σ	0..1	dateTime	Must be in UTC timezone on the FHIR server
authoredOn	Σ	0..1	dateTime	Must be in UTC timezone on the FHIR server
recipient		0..*	Reference(Patient | Practitioner)	Message recipient
Documentation for this format

Terminology Bindings

Path	Status	Usage	ValueSet	Version	Source
CommunicationRequest.​meta.tag	Base	example	Common Tags	📍4.0.1	FHIR Std.
CommunicationRequest.​meta.tag:correlationId	Base	example	Common Tags	📍4.0.1	FHIR Std.
CommunicationRequest.​status	Base	required	RequestStatus	📍4.0.1	FHIR Std.
CommunicationRequest.​statusReason	Base	required	Valueset for Communication Delivery Status	📦1.0.0	This IG
CommunicationRequest.​medium	Base	required	Valueset for Participation Mode	📦1.0.0	This IG
CommunicationRequest.​payload:message-body.​extension:payloadType.​value[x]	Base	required	CMS Payload Type ValueSet	📦0.4.5	This IG
CommunicationRequest.​payload:message-body.​content[x]:contentAttachment.​contentType	Base	required	MimeType	📍4.0.1	FHIR Std.
CommunicationRequest.​payload:message-parameters.​extension:payloadType.​value[x]	Base	required	CMS Payload Type ValueSet	📦0.4.5	This IG
CommunicationRequest.​payload:message-parameters.​content[x]:contentAttachment.​contentType	Base	required	MimeType	📍4.0.1	FHIR Std.
CommunicationRequest.​payload:attachment-file.​extension:payloadType.​value[x]	Base	required	CMS Payload Type ValueSet	📦0.4.5	This IG
CommunicationRequest.​payload:message-template.​extension:payloadType.​value[x]	Base	required	CMS Payload Type ValueSet	📦0.4.5	This IG

Constraints

Id	Grade	Path(s)	Description	Expression
cms-body-or-template	error	CommunicationRequest	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()
dom-2	error	CommunicationRequest	If the resource is contained in another resource, it SHALL NOT contain nested Resources	contained.contained.empty()
dom-3	error	CommunicationRequest	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	error	CommunicationRequest	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	error	CommunicationRequest	If a resource is contained in another resource, it SHALL NOT have a security label	contained.meta.security.empty()
dom-6	best practice	CommunicationRequest	A resource should have narrative for robust management	text.`div`.exists()
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children	hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both	extension.exists() != value.exists()

Differential View

This structure is derived from CommunicationRequest

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
CommunicationRequest	C	0..*	CommunicationRequest	A request for information to be sent to a receiver Constraints: cms-body-or-template
meta		1..1	Meta	Metadata about the resource
profile		1..1	canonical(StructureDefinition)	Profiles this resource claims to conform to
Slices for tag		1..*	Coding	Tags applied to this resource Slice: Unordered, Open by value:system
tag:correlationId		1..1	Coding	Tags applied to this resource
system		1..1	uri	Hub correlation ID system Required Pattern: https://hub.services.digital.health.nz/ns/correlation-id
code		1..1	code	Symbol in syntax defined by the system
contained		0..0		Contained, inline Resources
Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url
extension:Campaign		0..1	(Complex)	Campaign details URL: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/hnz-campaign-extension
extension:ContactPoint		1..1	(Complex)	Send to and from communication to contact points URL: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/hnz-contact-point-extension
extension:CallbackUrl		0..1	url	Callback Url URL: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/hnz-system-callback-url-extension
extension:Reply		0..1	(Complex)	For sms reply URL: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/hnz-system-reply-extension
identifier
use		1..1	code	usual | official | temp | secondary | old (If known)
system		1..1	uri	The namespace for the identifier value
value		1..1	string	The value that is unique
statusReason		0..1	CodeableConcept	Reason for current status Binding: Valueset for Communication Delivery Status (required)
medium		1..*	CodeableConcept	A channel of communication Binding: Valueset for Participation Mode (required)
subject		0..1	Reference(Patient)	Focus of message
Slices for payload		0..*	BackboneElement	Message payload Slice: Unordered, Open by value:extension('https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/cms-payload-type-extension').value
payload:message-body		0..1	BackboneElement	Message payload
Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url
Slices for extension				Content/Rules for all slices
extension:payloadType		1..1	(Complex)	CMS Payload Type Extension URL: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/cms-payload-type-extension
value[x]		0..1	code	Value of extension Required Pattern: body
Slices for content[x]		1..1	Attachment	Message part content Slice: Unordered, Open by type:$this
Slices for content[x]				Content/Rules for all slices
content[x]:contentAttachment		1..1	Attachment	Message part content
contentType		0..1	code	Mime type of the content, with charset etc. Required Pattern: text/plain
payload:message-parameters		0..1	BackboneElement	Message payload
Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url
Slices for extension				Content/Rules for all slices
extension:payloadType		1..1	(Complex)	CMS Payload Type Extension URL: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/cms-payload-type-extension
value[x]		0..1	code	Value of extension Required Pattern: parameters
Slices for content[x]		1..1	Attachment	Message part content Slice: Unordered, Open by type:$this
Slices for content[x]				Content/Rules for all slices
content[x]:contentAttachment		1..1	Attachment	Message part content
contentType		0..1	code	Mime type of the content, with charset etc. Required Pattern: application/json
payload:attachment-file		0..*	BackboneElement	Message payload
Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url
Slices for extension				Content/Rules for all slices
extension:payloadType		1..1	(Complex)	CMS Payload Type Extension URL: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/cms-payload-type-extension
value[x]		0..1	code	Value of extension Required Pattern: attachment
Slices for content[x]		1..1	Attachment	Message part content Slice: Unordered, Open by type:$this
Slices for content[x]				Content/Rules for all slices
content[x]:contentAttachment		1..1	Attachment	Message part content
Slices for extension				Content/Rules for all slices
extension:AttachmentExtension		0..1	(Complex)	Attachment details URL: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/hnz-attachment-extension
payload:message-template		0..1	BackboneElement	Message payload
Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url
Slices for extension				Content/Rules for all slices
extension:payloadType		1..1	(Complex)	CMS Payload Type Extension URL: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/cms-payload-type-extension
value[x]		0..1	code	Value of extension Required Pattern: template
Slices for content[x]		1..1	string, Attachment, Reference(Resource)	Message part content Slice: Unordered, Open by type:$this
Slices for content[x]				Content/Rules for all slices
content[x]:contentReference		0..1	Reference(CMSTemplateDocumentReference)	Message part content
Slices for occurrence[x]		0..1	dateTime, Period	When scheduled Slice: Unordered, Open by type:$this
occurrence[x]:occurrenceDateTime		0..1	dateTime	Must be in UTC timezone on the FHIR server
authoredOn		0..1	dateTime	Must be in UTC timezone on the FHIR server
recipient		0..*	Reference(Patient | Practitioner)	Message recipient
Documentation for this format

Terminology Bindings (Differential)

Path	Status	Usage	ValueSet	Version	Source
CommunicationRequest.​statusReason	Base	required	Valueset for Communication Delivery Status	📦1.0.0	This IG
CommunicationRequest.​medium	Base	required	Valueset for Participation Mode	📦1.0.0	This IG

Constraints

Id	Grade	Path(s)	Description	Expression
cms-body-or-template	error	CommunicationRequest	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()

Snapshot View

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
CommunicationRequest	C	0..*	CommunicationRequest	A request for information to be sent to a receiver Constraints: cms-body-or-template
id	Σ	0..1	id	Logical id of this artifact
meta	Σ	1..1	Meta	Metadata about the resource
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
versionId	Σ	0..1	id	Version specific identifier
lastUpdated	Σ	0..1	instant	When the resource version last changed
source	Σ	0..1	uri	Identifies where the resource comes from
profile	Σ	1..1	canonical(StructureDefinition)	Profiles this resource claims to conform to
security	Σ	0..*	Coding	Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
Slices for tag	Σ	1..*	Coding	Tags applied to this resource Slice: Unordered, Open by value:system Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
tag:correlationId	Σ	1..1	Coding	Tags applied to this resource Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
system	Σ	1..1	uri	Hub correlation ID system Required Pattern: https://hub.services.digital.health.nz/ns/correlation-id
version	Σ	0..1	string	Version of the system - if relevant
code	Σ	1..1	code	Symbol in syntax defined by the system
display	Σ	0..1	string	Representation defined by the system
userSelected	Σ	0..1	boolean	If this coding was chosen directly by the user
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
language		0..1	code	Language of the resource content Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
text		0..1	Narrative	Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements
Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url
extension:Campaign		0..1	(Complex)	Campaign details URL: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/hnz-campaign-extension
extension:ContactPoint		1..1	(Complex)	Send to and from communication to contact points URL: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/hnz-contact-point-extension
extension:CallbackUrl		0..1	url	Callback Url URL: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/hnz-system-callback-url-extension
extension:Reply		0..1	(Complex)	For sms reply URL: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/hnz-system-reply-extension
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
identifier	Σ	0..*	Identifier	Unique identifier
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
use	?!Σ	1..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type	Σ	0..1	CodeableConcept	Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
system	Σ	1..1	uri	The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
value	Σ	1..1	string	The value that is unique Example General: 123456
period	Σ	0..1	Period	Time period when id is/was valid for use
assigner	Σ	0..1	Reference(Organization)	Organization that issued id (may be just text)
basedOn	Σ	0..*	Reference(Resource)	Fulfills plan or proposal
replaces	Σ	0..*	Reference(CommunicationRequest)	Request(s) replaced by this request
groupIdentifier	Σ	0..1	Identifier	Composite request this is part of
status	?!Σ	1..1	code	draft | active | on-hold | revoked | completed | entered-in-error | unknown Binding: RequestStatus (required): The status of the communication request.
statusReason		0..1	CodeableConcept	Reason for current status Binding: Valueset for Communication Delivery Status (required)
category		0..*	CodeableConcept	Message category Binding: CommunicationCategory (example): Codes for general categories of communications such as alerts, instruction, etc.
priority	Σ	0..1	code	routine | urgent | asap | stat Binding: RequestPriority (required): Codes indicating the relative importance of a communication request.
doNotPerform	?!Σ	0..1	boolean	True if request is prohibiting action
medium		1..*	CodeableConcept	A channel of communication Binding: Valueset for Participation Mode (required)
subject		0..1	Reference(Patient)	Focus of message
about		0..*	Reference(Resource)	Resources that pertain to this communication request
encounter	Σ	0..1	Reference(Encounter)	Encounter created as part of
Slices for payload		0..*	BackboneElement	Message payload Slice: Unordered, Open by value:extension('https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/cms-payload-type-extension').value
payload:All Slices				Content/Rules for all slices
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
content[x]		1..1		Message part content
contentString			string
contentAttachment			Attachment
contentReference			Reference(Resource)
payload:message-body		0..1	BackboneElement	Message payload
id		0..1	string	Unique id for inter-element referencing
Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url
Slices for extension				Content/Rules for all slices
extension:payloadType		1..1	(Complex)	CMS Payload Type Extension URL: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/cms-payload-type-extension
id		0..1	string	Unique id for inter-element referencing
extension		0..0		Extension Slice: Unordered, Open by value:url
url		1..1	uri	"https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/cms-payload-type-extension"
value[x]		0..1	code	Value of extension Binding: CMS Payload Type ValueSet (required) Required Pattern: body
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
Slices for content[x]		1..1	Attachment	Message part content Slice: Unordered, Closed by type:$this
Slices for content[x]				Content/Rules for all slices
content[x]:contentAttachment		1..1	Attachment	Message part content
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
contentType	Σ	0..1	code	Mime type of the content, with charset etc. Binding: Mime Types (required): The mime type of an attachment. Any valid mime type is allowed. Required Pattern: text/plain
language	Σ	0..1	code	Human language of the content (BCP-47) Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding Example General: en-AU
data		0..1	base64Binary	Data inline, base64ed
url	Σ	0..1	url	Uri where the data can be found Example General: http://www.acme.com/logo-small.png
size	Σ	0..1	unsignedInt	Number of bytes of content (if url provided)
hash	Σ	0..1	base64Binary	Hash of the data (sha-1, base64ed)
title	Σ	0..1	string	Label to display in place of the data Example General: Official Corporate Logo
creation	Σ	0..1	dateTime	Date attachment was first created
payload:message-parameters		0..1	BackboneElement	Message payload
id		0..1	string	Unique id for inter-element referencing
Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url
Slices for extension				Content/Rules for all slices
extension:payloadType		1..1	(Complex)	CMS Payload Type Extension URL: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/cms-payload-type-extension
id		0..1	string	Unique id for inter-element referencing
extension		0..0		Extension Slice: Unordered, Open by value:url
url		1..1	uri	"https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/cms-payload-type-extension"
value[x]		0..1	code	Value of extension Binding: CMS Payload Type ValueSet (required) Required Pattern: parameters
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
Slices for content[x]		1..1	Attachment	Message part content Slice: Unordered, Closed by type:$this
Slices for content[x]				Content/Rules for all slices
content[x]:contentAttachment		1..1	Attachment	Message part content
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
contentType	Σ	0..1	code	Mime type of the content, with charset etc. Binding: Mime Types (required): The mime type of an attachment. Any valid mime type is allowed. Required Pattern: application/json
language	Σ	0..1	code	Human language of the content (BCP-47) Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding Example General: en-AU
data		0..1	base64Binary	Data inline, base64ed
url	Σ	0..1	url	Uri where the data can be found Example General: http://www.acme.com/logo-small.png
size	Σ	0..1	unsignedInt	Number of bytes of content (if url provided)
hash	Σ	0..1	base64Binary	Hash of the data (sha-1, base64ed)
title	Σ	0..1	string	Label to display in place of the data Example General: Official Corporate Logo
creation	Σ	0..1	dateTime	Date attachment was first created
payload:attachment-file		0..*	BackboneElement	Message payload
id		0..1	string	Unique id for inter-element referencing
Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url
Slices for extension				Content/Rules for all slices
extension:payloadType		1..1	(Complex)	CMS Payload Type Extension URL: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/cms-payload-type-extension
id		0..1	string	Unique id for inter-element referencing
extension		0..0		Extension Slice: Unordered, Open by value:url
url		1..1	uri	"https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/cms-payload-type-extension"
value[x]		0..1	code	Value of extension Binding: CMS Payload Type ValueSet (required) Required Pattern: attachment
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
Slices for content[x]		1..1	Attachment	Message part content Slice: Unordered, Closed by type:$this
Slices for content[x]				Content/Rules for all slices
content[x]:contentAttachment		1..1	Attachment	Message part content
id		0..1	string	Unique id for inter-element referencing
Slices for extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
Slices for extension				Content/Rules for all slices
extension:AttachmentExtension		0..1	(Complex)	Attachment details URL: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/hnz-attachment-extension
contentType	Σ	0..1	code	Mime type of the content, with charset etc. Binding: Mime Types (required): The mime type of an attachment. Any valid mime type is allowed. Example General: text/plain; charset=UTF-8, image/png
language	Σ	0..1	code	Human language of the content (BCP-47) Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding Example General: en-AU
data		0..1	base64Binary	Data inline, base64ed
url	Σ	0..1	url	Uri where the data can be found Example General: http://www.acme.com/logo-small.png
size	Σ	0..1	unsignedInt	Number of bytes of content (if url provided)
hash	Σ	0..1	base64Binary	Hash of the data (sha-1, base64ed)
title	Σ	0..1	string	Label to display in place of the data Example General: Official Corporate Logo
creation	Σ	0..1	dateTime	Date attachment was first created
payload:message-template		0..1	BackboneElement	Message payload
id		0..1	string	Unique id for inter-element referencing
Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url
Slices for extension				Content/Rules for all slices
extension:payloadType		1..1	(Complex)	CMS Payload Type Extension URL: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/cms-payload-type-extension
id		0..1	string	Unique id for inter-element referencing
extension		0..0		Extension Slice: Unordered, Open by value:url
url		1..1	uri	"https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/cms-payload-type-extension"
value[x]		0..1	code	Value of extension Binding: CMS Payload Type ValueSet (required) Required Pattern: template
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
Slices for content[x]		1..1		Message part content Slice: Unordered, Open by type:$this
contentString			string
contentAttachment			Attachment
contentReference			Reference(Resource)
Slices for content[x]				Content/Rules for all slices
content[x]:contentReference		0..1	Reference(CMSTemplateDocumentReference)	Message part content
Slices for occurrence[x]	Σ	0..1		When scheduled Slice: Unordered, Open by type:$this
occurrenceDateTime			dateTime
occurrencePeriod			Period
occurrence[x]:occurrenceDateTime	Σ	0..1	dateTime	Must be in UTC timezone on the FHIR server
authoredOn	Σ	0..1	dateTime	Must be in UTC timezone on the FHIR server
requester	Σ	0..1	Reference(Practitioner | PractitionerRole | Organization | Patient | RelatedPerson | Device)	Who/what is requesting service
recipient		0..*	Reference(Patient | Practitioner)	Message recipient
sender	Σ	0..1	Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson | HealthcareService)	Message sender
reasonCode	Σ	0..*	CodeableConcept	Why is communication needed? Binding: v3 Code System ActReason (example): Codes for describing reasons for the occurrence of a communication.
reasonReference	Σ	0..*	Reference(Condition | Observation | DiagnosticReport | DocumentReference)	Why is communication needed?
note		0..*	Annotation	Comments made about communication request
Documentation for this format

Terminology Bindings

Path	Status	Usage	ValueSet	Version	Source
CommunicationRequest.​meta.security	Base	extensible	SecurityLabels	📍4.0.1	FHIR Std.
CommunicationRequest.​meta.tag	Base	example	Common Tags	📍4.0.1	FHIR Std.
CommunicationRequest.​meta.tag:correlationId	Base	example	Common Tags	📍4.0.1	FHIR Std.
CommunicationRequest.​language	Base	preferred	Common Languages	📍4.0.1	FHIR Std.
CommunicationRequest.​identifier.use	Base	required	IdentifierUse	📍4.0.1	FHIR Std.
CommunicationRequest.​identifier.type	Base	extensible	IdentifierType	📍4.0.1	FHIR Std.
CommunicationRequest.​status	Base	required	RequestStatus	📍4.0.1	FHIR Std.
CommunicationRequest.​statusReason	Base	required	Valueset for Communication Delivery Status	📦1.0.0	This IG
CommunicationRequest.​category	Base	example	CommunicationCategory	📍4.0.1	FHIR Std.
CommunicationRequest.​priority	Base	required	Request priority	📍4.0.1	FHIR Std.
CommunicationRequest.​medium	Base	required	Valueset for Participation Mode	📦1.0.0	This IG
CommunicationRequest.​payload:message-body.​extension:payloadType.​value[x]	Base	required	CMS Payload Type ValueSet	📦0.4.5	This IG
CommunicationRequest.​payload:message-body.​content[x]:contentAttachment.​contentType	Base	required	MimeType	📍4.0.1	FHIR Std.
CommunicationRequest.​payload:message-body.​content[x]:contentAttachment.​language	Base	preferred	Common Languages	📍4.0.1	FHIR Std.
CommunicationRequest.​payload:message-parameters.​extension:payloadType.​value[x]	Base	required	CMS Payload Type ValueSet	📦0.4.5	This IG
CommunicationRequest.​payload:message-parameters.​content[x]:contentAttachment.​contentType	Base	required	MimeType	📍4.0.1	FHIR Std.
CommunicationRequest.​payload:message-parameters.​content[x]:contentAttachment.​language	Base	preferred	Common Languages	📍4.0.1	FHIR Std.
CommunicationRequest.​payload:attachment-file.​extension:payloadType.​value[x]	Base	required	CMS Payload Type ValueSet	📦0.4.5	This IG
CommunicationRequest.​payload:attachment-file.​content[x]:contentAttachment.​contentType	Base	required	MimeType	📍4.0.1	FHIR Std.
CommunicationRequest.​payload:attachment-file.​content[x]:contentAttachment.​language	Base	preferred	Common Languages	📍4.0.1	FHIR Std.
CommunicationRequest.​payload:message-template.​extension:payloadType.​value[x]	Base	required	CMS Payload Type ValueSet	📦0.4.5	This IG
CommunicationRequest.​reasonCode	Base	example	v3 Code System ActReason	📦3.0.0	THO v6.5

Constraints

Id	Grade	Path(s)	Description	Expression
cms-body-or-template	error	CommunicationRequest	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()
dom-2	error	CommunicationRequest	If the resource is contained in another resource, it SHALL NOT contain nested Resources	contained.contained.empty()
dom-3	error	CommunicationRequest	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	error	CommunicationRequest	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	error	CommunicationRequest	If a resource is contained in another resource, it SHALL NOT have a security label	contained.meta.security.empty()
dom-6	best practice	CommunicationRequest	A resource should have narrative for robust management	text.`div`.exists()
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children	hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both	extension.exists() != value.exists()

This structure is derived from CommunicationRequest

Summary

Mandatory: 9 elements(14 nested mandatory elements)
Prohibited: 1 element

Structures

This structure refers to these other structures:

• CMSTemplateDocumentReference (https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/TemplateDocumentReference)

Extensions

This structure refers to these extensions:

• https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/hnz-campaign-extension
• https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/hnz-contact-point-extension
• https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/hnz-system-callback-url-extension
• https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/hnz-system-reply-extension
• https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/cms-payload-type-extension
• https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/hnz-attachment-extension

Slices

This structure defines the following Slices:

• The element 1 is sliced based on the value of CommunicationRequest.meta.tag
• The element 1 is sliced based on the value of CommunicationRequest.payload
• The element 1 is sliced based on the value of CommunicationRequest.payload.content[x]
• The element 1 is sliced based on the value of CommunicationRequest.occurrence[x]