Health New Zealand Te Whatu Ora Shared Care FHIR API - Local Development build (v0.4.7) 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
CommunicationRequest.meta	Σ This element is included in summaries.	1..1	Meta	Metadata about the resource
CommunicationRequest.meta.profile	Σ This element is included in summaries.	1..1	canonical(StructureDefinition)	Profiles this resource claims to conform to
CommunicationRequest.meta.Slices for tag	Σ This element is included in summaries.	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". Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
CommunicationRequest.meta.Slices for tag.tag:correlationId	Σ This element is included in summaries.	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".
CommunicationRequest.meta.Slices for tag.tag:correlationId.system	Σ This element is included in summaries.	1..1	uri	Hub correlation ID system Required Pattern: https://hub.services.digital.health.nz/ns/correlation-id
CommunicationRequest.meta.Slices for tag.tag:correlationId.code	Σ This element is included in summaries.	1..1	code	Symbol in syntax defined by the system
CommunicationRequest.implicitRules	?! This element is a modifier element. Σ This element is included in summaries.	0..1	uri	A set of rules under which this content was created
CommunicationRequest.Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
CommunicationRequest.Slices for extension.extension:Campaign		0..1	(Complex)	Campaign details URL: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/hnz-campaign-extension
CommunicationRequest.Slices for 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
CommunicationRequest.Slices for extension.extension:CallbackUrl		0..1	url	Callback Url URL: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/hnz-system-callback-url-extension
CommunicationRequest.Slices for extension.extension:Reply		0..1	(Complex)	For sms reply URL: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/hnz-system-reply-extension
CommunicationRequest.modifierExtension	?! This element is a modifier element.	0..*	Extension	Extensions that cannot be ignored
CommunicationRequest.status	?! This element is a modifier element. Σ This element is included in summaries.	1..1	code	draft | active | on-hold | revoked | completed | entered-in-error | unknown Binding: RequestStatus (required): The status of the communication request.
CommunicationRequest.statusReason		0..1	CodeableConcept	Reason for current status Binding: Valueset for Communication Delivery Status (required)
CommunicationRequest.doNotPerform	?! This element is a modifier element. Σ This element is included in summaries.	0..1	boolean	True if request is prohibiting action
CommunicationRequest.medium		1..*	CodeableConcept	A channel of communication Binding: Valueset for Participation Mode (required)
CommunicationRequest.subject		0..1	Reference(Patient)	Focus of message
CommunicationRequest.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 Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
CommunicationRequest.Slices for payload.payload:All Slices				Content/Rules for all slices
CommunicationRequest.Slices for payload.payload:All Slices.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored even if unrecognized
CommunicationRequest.Slices for payload.payload:All Slices.content[x]		1..1		Message part content
CommunicationRequest.Slices for payload.payload:All Slices.content[x].contentString			string
CommunicationRequest.Slices for payload.payload:All Slices.content[x].contentAttachment			Attachment
CommunicationRequest.Slices for payload.payload:All Slices.content[x].contentReference			Reference(Resource)
CommunicationRequest.Slices for payload.payload:message-body		0..1	BackboneElement	Message payload
CommunicationRequest.Slices for payload.payload:message-body.Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
CommunicationRequest.Slices for payload.payload:message-body.Slices for extension				Content/Rules for all slices
CommunicationRequest.Slices for payload.payload:message-body.Slices for extension.extension:payloadType		1..1	(Complex)	CMS Payload Type Extension URL: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/cms-payload-type-extension
CommunicationRequest.Slices for payload.payload:message-body.Slices for extension.extension:payloadType.extension		0..0		Extension Slice: Unordered, Open by value:url
CommunicationRequest.Slices for payload.payload:message-body.Slices for extension.extension:payloadType.url		1..1	uri	"https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/cms-payload-type-extension"
CommunicationRequest.Slices for payload.payload:message-body.Slices for extension.extension:payloadType.value[x]		0..1	code	Value of extension Binding: CMS Payload Type ValueSet (required) Required Pattern: body
CommunicationRequest.Slices for payload.payload:message-body.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored even if unrecognized
CommunicationRequest.Slices for payload.payload:message-body.Slices for content[x]		1..1	Attachment	Message part content Slice: Unordered, Closed by type:$this Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
CommunicationRequest.Slices for payload.payload:message-body.Slices for content[x]				Content/Rules for all slices
CommunicationRequest.Slices for payload.payload:message-body.Slices for content[x].content[x]:contentAttachment		1..1	Attachment	Message part content
CommunicationRequest.Slices for payload.payload:message-body.Slices for content[x].content[x]:contentAttachment.contentType	Σ This element is included in summaries.	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
CommunicationRequest.Slices for payload.payload:message-parameters		0..1	BackboneElement	Message payload
CommunicationRequest.Slices for payload.payload:message-parameters.Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
CommunicationRequest.Slices for payload.payload:message-parameters.Slices for extension				Content/Rules for all slices
CommunicationRequest.Slices for payload.payload:message-parameters.Slices for extension.extension:payloadType		1..1	(Complex)	CMS Payload Type Extension URL: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/cms-payload-type-extension
CommunicationRequest.Slices for payload.payload:message-parameters.Slices for extension.extension:payloadType.extension		0..0		Extension Slice: Unordered, Open by value:url
CommunicationRequest.Slices for payload.payload:message-parameters.Slices for extension.extension:payloadType.url		1..1	uri	"https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/cms-payload-type-extension"
CommunicationRequest.Slices for payload.payload:message-parameters.Slices for extension.extension:payloadType.value[x]		0..1	code	Value of extension Binding: CMS Payload Type ValueSet (required) Required Pattern: parameters
CommunicationRequest.Slices for payload.payload:message-parameters.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored even if unrecognized
CommunicationRequest.Slices for payload.payload:message-parameters.Slices for content[x]		1..1	Attachment	Message part content Slice: Unordered, Closed by type:$this Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
CommunicationRequest.Slices for payload.payload:message-parameters.Slices for content[x]				Content/Rules for all slices
CommunicationRequest.Slices for payload.payload:message-parameters.Slices for content[x].content[x]:contentAttachment		1..1	Attachment	Message part content
CommunicationRequest.Slices for payload.payload:message-parameters.Slices for content[x].content[x]:contentAttachment.contentType	Σ This element is included in summaries.	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
CommunicationRequest.Slices for payload.payload:attachment-file		0..*	BackboneElement	Message payload
CommunicationRequest.Slices for payload.payload:attachment-file.Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
CommunicationRequest.Slices for payload.payload:attachment-file.Slices for extension				Content/Rules for all slices
CommunicationRequest.Slices for payload.payload:attachment-file.Slices for extension.extension:payloadType		1..1	(Complex)	CMS Payload Type Extension URL: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/cms-payload-type-extension
CommunicationRequest.Slices for payload.payload:attachment-file.Slices for extension.extension:payloadType.extension		0..0		Extension Slice: Unordered, Open by value:url
CommunicationRequest.Slices for payload.payload:attachment-file.Slices for extension.extension:payloadType.url		1..1	uri	"https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/cms-payload-type-extension"
CommunicationRequest.Slices for payload.payload:attachment-file.Slices for extension.extension:payloadType.value[x]		0..1	code	Value of extension Binding: CMS Payload Type ValueSet (required) Required Pattern: attachment
CommunicationRequest.Slices for payload.payload:attachment-file.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored even if unrecognized
CommunicationRequest.Slices for payload.payload:attachment-file.Slices for content[x]		1..1	Attachment	Message part content Slice: Unordered, Closed by type:$this Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
CommunicationRequest.Slices for payload.payload:attachment-file.Slices for content[x]				Content/Rules for all slices
CommunicationRequest.Slices for payload.payload:attachment-file.Slices for content[x].content[x]:contentAttachment		1..1	Attachment	Message part content
CommunicationRequest.Slices for payload.payload:attachment-file.Slices for content[x].content[x]:contentAttachment.Slices for extension				Content/Rules for all slices
CommunicationRequest.Slices for payload.payload:attachment-file.Slices for content[x].content[x]:contentAttachment.Slices for extension.extension:AttachmentExtension		0..1	(Complex)	Attachment details URL: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/hnz-attachment-extension
CommunicationRequest.Slices for payload.payload:message-template		0..1	BackboneElement	Message payload
CommunicationRequest.Slices for payload.payload:message-template.Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
CommunicationRequest.Slices for payload.payload:message-template.Slices for extension				Content/Rules for all slices
CommunicationRequest.Slices for payload.payload:message-template.Slices for extension.extension:payloadType		1..1	(Complex)	CMS Payload Type Extension URL: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/cms-payload-type-extension
CommunicationRequest.Slices for payload.payload:message-template.Slices for extension.extension:payloadType.extension		0..0		Extension Slice: Unordered, Open by value:url
CommunicationRequest.Slices for payload.payload:message-template.Slices for extension.extension:payloadType.url		1..1	uri	"https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/cms-payload-type-extension"
CommunicationRequest.Slices for payload.payload:message-template.Slices for extension.extension:payloadType.value[x]		0..1	code	Value of extension Binding: CMS Payload Type ValueSet (required) Required Pattern: template
CommunicationRequest.Slices for payload.payload:message-template.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored even if unrecognized
CommunicationRequest.Slices for payload.payload:message-template.Slices for content[x]		1..1		Message part content Slice: Unordered, Closed by type:$this Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them Other type slices that contain no new information are not shown in this view
CommunicationRequest.Slices for payload.payload:message-template.Slices for content[x].contentString			string
CommunicationRequest.Slices for payload.payload:message-template.Slices for content[x].contentAttachment			Attachment
CommunicationRequest.Slices for payload.payload:message-template.Slices for content[x].contentReference			Reference(Resource)
CommunicationRequest.Slices for payload.payload:message-template.Slices for content[x]				Content/Rules for all slices
CommunicationRequest.Slices for payload.payload:message-template.Slices for content[x].content[x]:contentReference		0..1	Reference(CMSTemplateDocumentReference)	Message part content
CommunicationRequest.Slices for occurrence[x]	Σ This element is included in summaries.	0..1		When scheduled Slice: Unordered, Closed by type:$this Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them Other type slices that contain no new information are not shown in this view
CommunicationRequest.Slices for occurrence[x].occurrenceDateTime			dateTime
CommunicationRequest.Slices for occurrence[x].occurrencePeriod			Period
CommunicationRequest.Slices for occurrence[x].occurrence[x]:occurrenceDateTime	Σ This element is included in summaries.	0..1	dateTime	Must be in UTC timezone on the FHIR server
CommunicationRequest.authoredOn	Σ This element is included in summaries.	0..1	dateTime	Must be in UTC timezone on the FHIR server
CommunicationRequest.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.7	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.7	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.7	This IG
CommunicationRequest.​payload:message-template.​extension:payloadType.​value[x]	Base	required	CMS Payload Type ValueSet	📦0.4.7	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()

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

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
CommunicationRequest.meta	Σ This element is included in summaries.	1..1	Meta	Metadata about the resource
CommunicationRequest.meta.profile	Σ This element is included in summaries.	1..1	canonical(StructureDefinition)	Profiles this resource claims to conform to
CommunicationRequest.meta.Slices for tag	Σ This element is included in summaries.	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". Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
CommunicationRequest.meta.Slices for tag.tag:correlationId	Σ This element is included in summaries.	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".
CommunicationRequest.meta.Slices for tag.tag:correlationId.system	Σ This element is included in summaries.	1..1	uri	Hub correlation ID system Required Pattern: https://hub.services.digital.health.nz/ns/correlation-id
CommunicationRequest.meta.Slices for tag.tag:correlationId.code	Σ This element is included in summaries.	1..1	code	Symbol in syntax defined by the system
CommunicationRequest.implicitRules	?! This element is a modifier element. Σ This element is included in summaries.	0..1	uri	A set of rules under which this content was created
CommunicationRequest.Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
CommunicationRequest.Slices for extension.extension:Campaign		0..1	(Complex)	Campaign details URL: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/hnz-campaign-extension
CommunicationRequest.Slices for 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
CommunicationRequest.Slices for extension.extension:CallbackUrl		0..1	url	Callback Url URL: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/hnz-system-callback-url-extension
CommunicationRequest.Slices for extension.extension:Reply		0..1	(Complex)	For sms reply URL: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/hnz-system-reply-extension
CommunicationRequest.modifierExtension	?! This element is a modifier element.	0..*	Extension	Extensions that cannot be ignored
CommunicationRequest.status	?! This element is a modifier element. Σ This element is included in summaries.	1..1	code	draft | active | on-hold | revoked | completed | entered-in-error | unknown Binding: RequestStatus (required): The status of the communication request.
CommunicationRequest.statusReason		0..1	CodeableConcept	Reason for current status Binding: Valueset for Communication Delivery Status (required)
CommunicationRequest.doNotPerform	?! This element is a modifier element. Σ This element is included in summaries.	0..1	boolean	True if request is prohibiting action
CommunicationRequest.medium		1..*	CodeableConcept	A channel of communication Binding: Valueset for Participation Mode (required)
CommunicationRequest.subject		0..1	Reference(Patient)	Focus of message
CommunicationRequest.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 Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
CommunicationRequest.Slices for payload.payload:All Slices				Content/Rules for all slices
CommunicationRequest.Slices for payload.payload:All Slices.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored even if unrecognized
CommunicationRequest.Slices for payload.payload:All Slices.content[x]		1..1		Message part content
CommunicationRequest.Slices for payload.payload:All Slices.content[x].contentString			string
CommunicationRequest.Slices for payload.payload:All Slices.content[x].contentAttachment			Attachment
CommunicationRequest.Slices for payload.payload:All Slices.content[x].contentReference			Reference(Resource)
CommunicationRequest.Slices for payload.payload:message-body		0..1	BackboneElement	Message payload
CommunicationRequest.Slices for payload.payload:message-body.Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
CommunicationRequest.Slices for payload.payload:message-body.Slices for extension				Content/Rules for all slices
CommunicationRequest.Slices for payload.payload:message-body.Slices for extension.extension:payloadType		1..1	(Complex)	CMS Payload Type Extension URL: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/cms-payload-type-extension
CommunicationRequest.Slices for payload.payload:message-body.Slices for extension.extension:payloadType.extension		0..0		Extension Slice: Unordered, Open by value:url
CommunicationRequest.Slices for payload.payload:message-body.Slices for extension.extension:payloadType.url		1..1	uri	"https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/cms-payload-type-extension"
CommunicationRequest.Slices for payload.payload:message-body.Slices for extension.extension:payloadType.value[x]		0..1	code	Value of extension Binding: CMS Payload Type ValueSet (required) Required Pattern: body
CommunicationRequest.Slices for payload.payload:message-body.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored even if unrecognized
CommunicationRequest.Slices for payload.payload:message-body.Slices for content[x]		1..1	Attachment	Message part content Slice: Unordered, Closed by type:$this Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
CommunicationRequest.Slices for payload.payload:message-body.Slices for content[x]				Content/Rules for all slices
CommunicationRequest.Slices for payload.payload:message-body.Slices for content[x].content[x]:contentAttachment		1..1	Attachment	Message part content
CommunicationRequest.Slices for payload.payload:message-body.Slices for content[x].content[x]:contentAttachment.contentType	Σ This element is included in summaries.	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
CommunicationRequest.Slices for payload.payload:message-parameters		0..1	BackboneElement	Message payload
CommunicationRequest.Slices for payload.payload:message-parameters.Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
CommunicationRequest.Slices for payload.payload:message-parameters.Slices for extension				Content/Rules for all slices
CommunicationRequest.Slices for payload.payload:message-parameters.Slices for extension.extension:payloadType		1..1	(Complex)	CMS Payload Type Extension URL: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/cms-payload-type-extension
CommunicationRequest.Slices for payload.payload:message-parameters.Slices for extension.extension:payloadType.extension		0..0		Extension Slice: Unordered, Open by value:url
CommunicationRequest.Slices for payload.payload:message-parameters.Slices for extension.extension:payloadType.url		1..1	uri	"https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/cms-payload-type-extension"
CommunicationRequest.Slices for payload.payload:message-parameters.Slices for extension.extension:payloadType.value[x]		0..1	code	Value of extension Binding: CMS Payload Type ValueSet (required) Required Pattern: parameters
CommunicationRequest.Slices for payload.payload:message-parameters.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored even if unrecognized
CommunicationRequest.Slices for payload.payload:message-parameters.Slices for content[x]		1..1	Attachment	Message part content Slice: Unordered, Closed by type:$this Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
CommunicationRequest.Slices for payload.payload:message-parameters.Slices for content[x]				Content/Rules for all slices
CommunicationRequest.Slices for payload.payload:message-parameters.Slices for content[x].content[x]:contentAttachment		1..1	Attachment	Message part content
CommunicationRequest.Slices for payload.payload:message-parameters.Slices for content[x].content[x]:contentAttachment.contentType	Σ This element is included in summaries.	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
CommunicationRequest.Slices for payload.payload:attachment-file		0..*	BackboneElement	Message payload
CommunicationRequest.Slices for payload.payload:attachment-file.Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
CommunicationRequest.Slices for payload.payload:attachment-file.Slices for extension				Content/Rules for all slices
CommunicationRequest.Slices for payload.payload:attachment-file.Slices for extension.extension:payloadType		1..1	(Complex)	CMS Payload Type Extension URL: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/cms-payload-type-extension
CommunicationRequest.Slices for payload.payload:attachment-file.Slices for extension.extension:payloadType.extension		0..0		Extension Slice: Unordered, Open by value:url
CommunicationRequest.Slices for payload.payload:attachment-file.Slices for extension.extension:payloadType.url		1..1	uri	"https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/cms-payload-type-extension"
CommunicationRequest.Slices for payload.payload:attachment-file.Slices for extension.extension:payloadType.value[x]		0..1	code	Value of extension Binding: CMS Payload Type ValueSet (required) Required Pattern: attachment
CommunicationRequest.Slices for payload.payload:attachment-file.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored even if unrecognized
CommunicationRequest.Slices for payload.payload:attachment-file.Slices for content[x]		1..1	Attachment	Message part content Slice: Unordered, Closed by type:$this Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
CommunicationRequest.Slices for payload.payload:attachment-file.Slices for content[x]				Content/Rules for all slices
CommunicationRequest.Slices for payload.payload:attachment-file.Slices for content[x].content[x]:contentAttachment		1..1	Attachment	Message part content
CommunicationRequest.Slices for payload.payload:attachment-file.Slices for content[x].content[x]:contentAttachment.Slices for extension				Content/Rules for all slices
CommunicationRequest.Slices for payload.payload:attachment-file.Slices for content[x].content[x]:contentAttachment.Slices for extension.extension:AttachmentExtension		0..1	(Complex)	Attachment details URL: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/hnz-attachment-extension
CommunicationRequest.Slices for payload.payload:message-template		0..1	BackboneElement	Message payload
CommunicationRequest.Slices for payload.payload:message-template.Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
CommunicationRequest.Slices for payload.payload:message-template.Slices for extension				Content/Rules for all slices
CommunicationRequest.Slices for payload.payload:message-template.Slices for extension.extension:payloadType		1..1	(Complex)	CMS Payload Type Extension URL: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/cms-payload-type-extension
CommunicationRequest.Slices for payload.payload:message-template.Slices for extension.extension:payloadType.extension		0..0		Extension Slice: Unordered, Open by value:url
CommunicationRequest.Slices for payload.payload:message-template.Slices for extension.extension:payloadType.url		1..1	uri	"https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/cms-payload-type-extension"
CommunicationRequest.Slices for payload.payload:message-template.Slices for extension.extension:payloadType.value[x]		0..1	code	Value of extension Binding: CMS Payload Type ValueSet (required) Required Pattern: template
CommunicationRequest.Slices for payload.payload:message-template.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored even if unrecognized
CommunicationRequest.Slices for payload.payload:message-template.Slices for content[x]		1..1		Message part content Slice: Unordered, Closed by type:$this Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them Other type slices that contain no new information are not shown in this view
CommunicationRequest.Slices for payload.payload:message-template.Slices for content[x].contentString			string
CommunicationRequest.Slices for payload.payload:message-template.Slices for content[x].contentAttachment			Attachment
CommunicationRequest.Slices for payload.payload:message-template.Slices for content[x].contentReference			Reference(Resource)
CommunicationRequest.Slices for payload.payload:message-template.Slices for content[x]				Content/Rules for all slices
CommunicationRequest.Slices for payload.payload:message-template.Slices for content[x].content[x]:contentReference		0..1	Reference(CMSTemplateDocumentReference)	Message part content
CommunicationRequest.Slices for occurrence[x]	Σ This element is included in summaries.	0..1		When scheduled Slice: Unordered, Closed by type:$this Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them Other type slices that contain no new information are not shown in this view
CommunicationRequest.Slices for occurrence[x].occurrenceDateTime			dateTime
CommunicationRequest.Slices for occurrence[x].occurrencePeriod			Period
CommunicationRequest.Slices for occurrence[x].occurrence[x]:occurrenceDateTime	Σ This element is included in summaries.	0..1	dateTime	Must be in UTC timezone on the FHIR server
CommunicationRequest.authoredOn	Σ This element is included in summaries.	0..1	dateTime	Must be in UTC timezone on the FHIR server
CommunicationRequest.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.7	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.7	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.7	This IG
CommunicationRequest.​payload:message-template.​extension:payloadType.​value[x]	Base	required	CMS Payload Type ValueSet	📦0.4.7	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()

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

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]