Health New Zealand Te Whatu Ora Shared Care FHIR API - Local Development build (v0.4.1) 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

Usage:

• Examples for this Resource Profile: CommunicationRequest/EmailCommunicationRequestWithTemplateExample, CommunicationRequest/EmailCommunicationRequestWithoutTemplateExample, CommunicationRequest/SMSCommunicationRequestWithTemplateExample and CommunicationRequest/SMSCommunicationRequestWithoutTemplateExample
• CapabilityStatements using this Resource Profile: Shared Care FHIR Server Capability Statement

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
CommunicationRequest		0..*	CommunicationRequest	A request for information to be sent to a receiver dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children
Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension:Campaign		0..1	(Complex)	Campaign details URL: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/hnz-campaign-extension ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
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 ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension:CallbackUrl		0..1	url	Callback Url URL: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/hnz-system-callback-url-extension ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension:Reply		0..1	(Complex)	For sms reply URL: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/hnz-system-reply-extension ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
identifier	Σ	1..*	Identifier	Unique identifier ele-1: All FHIR elements must have a @value or children
use	?!Σ	1..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . ele-1: All FHIR elements must have a @value or children
system	Σ	1..1	uri	The namespace for the identifier value ele-1: All FHIR elements must have a @value or children Example General: http://www.acme.com/identifiers/patient
value	Σ	1..1	string	The value that is unique ele-1: All FHIR elements must have a @value or children Example General: 123456
status	?!Σ	1..1	code	draft | active | on-hold | revoked | completed | entered-in-error | unknown Binding: RequestStatus (required): The status of the communication request. ele-1: All FHIR elements must have a @value or children
statusReason		0..1	CodeableConcept	Reason for current status Binding: Valueset for Communication Delivery Status (required) ele-1: All FHIR elements must have a @value or children
doNotPerform	?!Σ	0..1	boolean	True if request is prohibiting action ele-1: All FHIR elements must have a @value or children
medium		1..*	CodeableConcept	A channel of communication Binding: Valueset for Participation Mode (required) ele-1: All FHIR elements must have a @value or children
subject		0..1	Reference(Patient)	Focus of message ele-1: All FHIR elements must have a @value or children
payload		1..*	BackboneElement	Message payload ele-1: All FHIR elements must have a @value or children
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
Slices for content[x]		1..1		Message part content Slice: Unordered, Open by type:$this ele-1: All FHIR elements must have a @value or children
contentString			string
contentAttachment			Attachment
contentReference			Reference(Resource)
content[x]:contentAttachment		0..1	Attachment	Message part content ele-1: All FHIR elements must have a @value or children
Slices for extension				Content/Rules for all slices
extension:Attachment		0..1	(Complex)	Attachment details URL: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/hnz-attachment-extension ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
Slices for occurrence[x]	Σ	0..1		When scheduled Slice: Unordered, Open by type:$this ele-1: All FHIR elements must have a @value or children
occurrenceDateTime			dateTime
occurrencePeriod			Period
occurrence[x]:occurrenceDateTime	Σ	0..1	dateTime	Must be in UTC timezone on the FHIR server ele-1: All FHIR elements must have a @value or children
authoredOn	Σ	0..1	dateTime	Must be in UTC timezone on the FHIR server ele-1: All FHIR elements must have a @value or children
recipient		0..*	Reference(Patient | Practitioner)	Message recipient ele-1: All FHIR elements must have a @value or children
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
CommunicationRequest.identifier.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard
CommunicationRequest.status	required	RequestStatus http://hl7.org/fhir/ValueSet/request-status|4.0.1 from the FHIR Standard
CommunicationRequest.statusReason	required	CommunicationDeliveryStatusValueSet (a valid code from Codes for CommunicationStatus) https://fhir-ig.digital.health.nz/shared-care/ValueSet/hnz-communication-delivery-status-valueset from this IG
CommunicationRequest.medium	required	ParticipationModeValueSet (a valid code from ParticipationMode) https://fhir-ig.digital.health.nz/shared-care/ValueSet/hnz-participation-mode-valueset from this IG

This structure is derived from CommunicationRequest

Name	Flags	Card.	Type	Description & Constraints
CommunicationRequest		0..*	CommunicationRequest	A request for information to be sent to a receiver
meta
profile		1..1	canonical(StructureDefinition)	Profiles this resource claims to conform to
contained		0..0
Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url
extension:Campaign		0..1	(Complex)	Campaign details URL: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/hnz-campaign-extension
extension:ContactPoint		1..1	(Complex)	Send to and from communication to contact points URL: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/hnz-contact-point-extension
extension:CallbackUrl		0..1	url	Callback Url URL: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/hnz-system-callback-url-extension
extension:Reply		0..1	(Complex)	For sms reply URL: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/hnz-system-reply-extension
identifier		1..*	Identifier	Unique identifier
use		1..1	code	usual | official | temp | secondary | old (If known)
system		1..1	uri	The namespace for the identifier value
value		1..1	string	The value that is unique
statusReason		0..1	CodeableConcept	Reason for current status Binding: Valueset for Communication Delivery Status (required)
medium		1..*	CodeableConcept	A channel of communication Binding: Valueset for Participation Mode (required)
subject		0..1	Reference(Patient)	Focus of message
payload		1..*	BackboneElement	Message payload
Slices for content[x]		1..1	string, Attachment, Reference(Resource)	Message part content Slice: Unordered, Open by type:$this
content[x]:contentAttachment		0..1	Attachment	Message part content
Slices for extension				Content/Rules for all slices
extension:Attachment		0..1	(Complex)	Attachment details URL: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/hnz-attachment-extension
Slices for occurrence[x]		0..1	dateTime, Period	When scheduled Slice: Unordered, Open by type:$this
occurrence[x]:occurrenceDateTime		0..1	dateTime	Must be in UTC timezone on the FHIR server
authoredOn		0..1	dateTime	Must be in UTC timezone on the FHIR server
recipient		0..*	Reference(Patient | Practitioner)	Message recipient
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet	URI
CommunicationRequest.statusReason	required	CommunicationDeliveryStatusValueSet (a valid code from Codes for CommunicationStatus) https://fhir-ig.digital.health.nz/shared-care/ValueSet/hnz-communication-delivery-status-valueset from this IG
CommunicationRequest.medium	required	ParticipationModeValueSet (a valid code from ParticipationMode) https://fhir-ig.digital.health.nz/shared-care/ValueSet/hnz-participation-mode-valueset from this IG

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

Terminology Bindings

Path	Conformance	ValueSet	URI
CommunicationRequest.meta.security	extensible	All Security Labels http://hl7.org/fhir/ValueSet/security-labels from the FHIR Standard
CommunicationRequest.meta.tag	example	CommonTags http://hl7.org/fhir/ValueSet/common-tags from the FHIR Standard
CommunicationRequest.language	preferred	CommonLanguages http://hl7.org/fhir/ValueSet/languages from the FHIR Standard Additional Bindings Purpose AllLanguages Max Binding
CommunicationRequest.identifier.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard
CommunicationRequest.identifier.type	extensible	Identifier Type Codes http://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard
CommunicationRequest.status	required	RequestStatus http://hl7.org/fhir/ValueSet/request-status|4.0.1 from the FHIR Standard
CommunicationRequest.statusReason	required	CommunicationDeliveryStatusValueSet (a valid code from Codes for CommunicationStatus) https://fhir-ig.digital.health.nz/shared-care/ValueSet/hnz-communication-delivery-status-valueset from this IG
CommunicationRequest.category	example	CommunicationCategory http://hl7.org/fhir/ValueSet/communication-category from the FHIR Standard
CommunicationRequest.priority	required	RequestPriority http://hl7.org/fhir/ValueSet/request-priority|4.0.1 from the FHIR Standard
CommunicationRequest.medium	required	ParticipationModeValueSet (a valid code from ParticipationMode) https://fhir-ig.digital.health.nz/shared-care/ValueSet/hnz-participation-mode-valueset from this IG
CommunicationRequest.payload.content[x]:contentAttachment.contentType	required	Mime Types (a valid code from urn:ietf:bcp:13) http://hl7.org/fhir/ValueSet/mimetypes|4.0.1 from the FHIR Standard
CommunicationRequest.payload.content[x]:contentAttachment.language	preferred	CommonLanguages http://hl7.org/fhir/ValueSet/languages from the FHIR Standard Additional Bindings Purpose AllLanguages Max Binding
CommunicationRequest.reasonCode	example	ActReason http://terminology.hl7.org/ValueSet/v3-ActReason

This structure is derived from CommunicationRequest

Summary

Mandatory: 8 elements(1 nested mandatory element)
Prohibited: 1 element

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/hnz-attachment-extension

Slices

This structure defines the following Slices:

• 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
CommunicationRequest		0..*	CommunicationRequest	A request for information to be sent to a receiver dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children
Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension:Campaign		0..1	(Complex)	Campaign details URL: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/hnz-campaign-extension ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
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 ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension:CallbackUrl		0..1	url	Callback Url URL: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/hnz-system-callback-url-extension ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension:Reply		0..1	(Complex)	For sms reply URL: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/hnz-system-reply-extension ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
identifier	Σ	1..*	Identifier	Unique identifier ele-1: All FHIR elements must have a @value or children
use	?!Σ	1..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . ele-1: All FHIR elements must have a @value or children
system	Σ	1..1	uri	The namespace for the identifier value ele-1: All FHIR elements must have a @value or children Example General: http://www.acme.com/identifiers/patient
value	Σ	1..1	string	The value that is unique ele-1: All FHIR elements must have a @value or children Example General: 123456
status	?!Σ	1..1	code	draft | active | on-hold | revoked | completed | entered-in-error | unknown Binding: RequestStatus (required): The status of the communication request. ele-1: All FHIR elements must have a @value or children
statusReason		0..1	CodeableConcept	Reason for current status Binding: Valueset for Communication Delivery Status (required) ele-1: All FHIR elements must have a @value or children
doNotPerform	?!Σ	0..1	boolean	True if request is prohibiting action ele-1: All FHIR elements must have a @value or children
medium		1..*	CodeableConcept	A channel of communication Binding: Valueset for Participation Mode (required) ele-1: All FHIR elements must have a @value or children
subject		0..1	Reference(Patient)	Focus of message ele-1: All FHIR elements must have a @value or children
payload		1..*	BackboneElement	Message payload ele-1: All FHIR elements must have a @value or children
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
Slices for content[x]		1..1		Message part content Slice: Unordered, Open by type:$this ele-1: All FHIR elements must have a @value or children
contentString			string
contentAttachment			Attachment
contentReference			Reference(Resource)
content[x]:contentAttachment		0..1	Attachment	Message part content ele-1: All FHIR elements must have a @value or children
Slices for extension				Content/Rules for all slices
extension:Attachment		0..1	(Complex)	Attachment details URL: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/hnz-attachment-extension ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
Slices for occurrence[x]	Σ	0..1		When scheduled Slice: Unordered, Open by type:$this ele-1: All FHIR elements must have a @value or children
occurrenceDateTime			dateTime
occurrencePeriod			Period
occurrence[x]:occurrenceDateTime	Σ	0..1	dateTime	Must be in UTC timezone on the FHIR server ele-1: All FHIR elements must have a @value or children
authoredOn	Σ	0..1	dateTime	Must be in UTC timezone on the FHIR server ele-1: All FHIR elements must have a @value or children
recipient		0..*	Reference(Patient | Practitioner)	Message recipient ele-1: All FHIR elements must have a @value or children
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
CommunicationRequest.identifier.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard
CommunicationRequest.status	required	RequestStatus http://hl7.org/fhir/ValueSet/request-status|4.0.1 from the FHIR Standard
CommunicationRequest.statusReason	required	CommunicationDeliveryStatusValueSet (a valid code from Codes for CommunicationStatus) https://fhir-ig.digital.health.nz/shared-care/ValueSet/hnz-communication-delivery-status-valueset from this IG
CommunicationRequest.medium	required	ParticipationModeValueSet (a valid code from ParticipationMode) https://fhir-ig.digital.health.nz/shared-care/ValueSet/hnz-participation-mode-valueset from this IG

Differential View

This structure is derived from CommunicationRequest

Name	Flags	Card.	Type	Description & Constraints
CommunicationRequest		0..*	CommunicationRequest	A request for information to be sent to a receiver
meta
profile		1..1	canonical(StructureDefinition)	Profiles this resource claims to conform to
contained		0..0
Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url
extension:Campaign		0..1	(Complex)	Campaign details URL: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/hnz-campaign-extension
extension:ContactPoint		1..1	(Complex)	Send to and from communication to contact points URL: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/hnz-contact-point-extension
extension:CallbackUrl		0..1	url	Callback Url URL: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/hnz-system-callback-url-extension
extension:Reply		0..1	(Complex)	For sms reply URL: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/hnz-system-reply-extension
identifier		1..*	Identifier	Unique identifier
use		1..1	code	usual | official | temp | secondary | old (If known)
system		1..1	uri	The namespace for the identifier value
value		1..1	string	The value that is unique
statusReason		0..1	CodeableConcept	Reason for current status Binding: Valueset for Communication Delivery Status (required)
medium		1..*	CodeableConcept	A channel of communication Binding: Valueset for Participation Mode (required)
subject		0..1	Reference(Patient)	Focus of message
payload		1..*	BackboneElement	Message payload
Slices for content[x]		1..1	string, Attachment, Reference(Resource)	Message part content Slice: Unordered, Open by type:$this
content[x]:contentAttachment		0..1	Attachment	Message part content
Slices for extension				Content/Rules for all slices
extension:Attachment		0..1	(Complex)	Attachment details URL: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/hnz-attachment-extension
Slices for occurrence[x]		0..1	dateTime, Period	When scheduled Slice: Unordered, Open by type:$this
occurrence[x]:occurrenceDateTime		0..1	dateTime	Must be in UTC timezone on the FHIR server
authoredOn		0..1	dateTime	Must be in UTC timezone on the FHIR server
recipient		0..*	Reference(Patient | Practitioner)	Message recipient
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet	URI
CommunicationRequest.statusReason	required	CommunicationDeliveryStatusValueSet (a valid code from Codes for CommunicationStatus) https://fhir-ig.digital.health.nz/shared-care/ValueSet/hnz-communication-delivery-status-valueset from this IG
CommunicationRequest.medium	required	ParticipationModeValueSet (a valid code from ParticipationMode) https://fhir-ig.digital.health.nz/shared-care/ValueSet/hnz-participation-mode-valueset from this IG

Snapshot View

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

Terminology Bindings

Path	Conformance	ValueSet	URI
CommunicationRequest.meta.security	extensible	All Security Labels http://hl7.org/fhir/ValueSet/security-labels from the FHIR Standard
CommunicationRequest.meta.tag	example	CommonTags http://hl7.org/fhir/ValueSet/common-tags from the FHIR Standard
CommunicationRequest.language	preferred	CommonLanguages http://hl7.org/fhir/ValueSet/languages from the FHIR Standard Additional Bindings Purpose AllLanguages Max Binding
CommunicationRequest.identifier.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard
CommunicationRequest.identifier.type	extensible	Identifier Type Codes http://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard
CommunicationRequest.status	required	RequestStatus http://hl7.org/fhir/ValueSet/request-status|4.0.1 from the FHIR Standard
CommunicationRequest.statusReason	required	CommunicationDeliveryStatusValueSet (a valid code from Codes for CommunicationStatus) https://fhir-ig.digital.health.nz/shared-care/ValueSet/hnz-communication-delivery-status-valueset from this IG
CommunicationRequest.category	example	CommunicationCategory http://hl7.org/fhir/ValueSet/communication-category from the FHIR Standard
CommunicationRequest.priority	required	RequestPriority http://hl7.org/fhir/ValueSet/request-priority|4.0.1 from the FHIR Standard
CommunicationRequest.medium	required	ParticipationModeValueSet (a valid code from ParticipationMode) https://fhir-ig.digital.health.nz/shared-care/ValueSet/hnz-participation-mode-valueset from this IG
CommunicationRequest.payload.content[x]:contentAttachment.contentType	required	Mime Types (a valid code from urn:ietf:bcp:13) http://hl7.org/fhir/ValueSet/mimetypes|4.0.1 from the FHIR Standard
CommunicationRequest.payload.content[x]:contentAttachment.language	preferred	CommonLanguages http://hl7.org/fhir/ValueSet/languages from the FHIR Standard Additional Bindings Purpose AllLanguages Max Binding
CommunicationRequest.reasonCode	example	ActReason http://terminology.hl7.org/ValueSet/v3-ActReason

This structure is derived from CommunicationRequest

Summary

Mandatory: 8 elements(1 nested mandatory element)
Prohibited: 1 element

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/hnz-attachment-extension

Slices

This structure defines the following Slices:

• 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]

Other representations of profile: CSV, Excel, Schematron