FHIR New Zealand Patient Summary IG, published by Health NZ | Te Whatu Ora. This guide is not an authorized publication; it is the continuous build for version 0.3.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/tewhatuora/fhir-nzps/ and changes regularly. See the Directory of published versions

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

Resource Profile: NZPS-Communication

The NZPS Communication is a profile for the FHIR Communication resource. It is used to record communication between a health professional and a patient or other person about their wishes for future care.

Usage:

• This Resource Profile is not used by any profiles in this Implementation Guide

Formal Views of Profile Content

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

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

This structure is derived from Communication

Name	Flags	Card.	Type	Description & Constraints
Communication		0..*	Communication	A record of information transmitted from a sender to a receiver
category		0..*	CodeableConcept	The type of message conveyed - this should be Patient story
medium		0..*	CodeableConcept	How the communication was sent - for example verbal, written, on-behalf
recipient		0..*	Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson | Group | CareTeam | HealthcareService)	The person who received the communication - this could be the GP, nurse or receptionist
sender		0..1	Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson | HealthcareService)	The person who sent the communication - this could be the patient's Aunty, church minister, or a health professional
payload		0..*	BackboneElement	Important things the Patient wants known
Slices for content[x]		1..1	string, Attachment, Reference(Resource)	Message part content Slice: Unordered, Open by type:$this
content[x]:contentString		0..1	string	The Patient Wellness statement
content[x]:contentReference		0..1	Reference(Resource)	People that are important to the Patient and their care
Documentation for this format

Name	Flags	Card.	Type	Description & Constraints
Communication		0..*	Communication	A record of information transmitted from a sender to a receiver
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
status	?!Σ	1..1	code	preparation | in-progress | not-done | on-hold | stopped | completed | entered-in-error | unknown Binding: EventStatus (required): The status of the communication.
category		0..*	CodeableConcept	The type of message conveyed - this should be Patient story Binding: CommunicationCategory (example): Codes for general categories of communications such as alerts, instructions, etc.
medium		0..*	CodeableConcept	How the communication was sent - for example verbal, written, on-behalf Binding: ParticipationMode (example): Codes for communication mediums such as phone, fax, email, in person, etc.
recipient		0..*	Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson | Group | CareTeam | HealthcareService)	The person who received the communication - this could be the GP, nurse or receptionist
sender		0..1	Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson | HealthcareService)	The person who sent the communication - this could be the patient's Aunty, church minister, or a health professional
payload		0..*	BackboneElement	Important things the Patient wants known
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]:contentString		0..1	string	The Patient Wellness statement
content[x]:contentReference		0..1	Reference(Resource)	People that are important to the Patient and their care
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
Communication.status	required	EventStatus http://hl7.org/fhir/ValueSet/event-status|4.0.1 from the FHIR Standard
Communication.category	example	CommunicationCategory http://hl7.org/fhir/ValueSet/communication-category from the FHIR Standard
Communication.medium	example	ParticipationMode http://terminology.hl7.org/ValueSet/v3-ParticipationMode

Constraints

Id	Grade	Path(s)	Details	Requirements
dom-2	error	Communication	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	Communication	If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4	error	Communication	If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5	error	Communication	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	Communication	A resource should have narrative for robust management : text.`div`.exists()
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()

Name	Flags	Card.	Type	Description & Constraints
Communication		0..*	Communication	A record of information transmitted from a sender to a receiver
id	Σ	0..1	id	Logical id of this artifact
meta	Σ	0..1	Meta	Metadata about the resource
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
contained		0..*	Resource	Contained, inline Resources
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
identifier	Σ	0..*	Identifier	Unique identifier
instantiatesCanonical	Σ	0..*	canonical(PlanDefinition | ActivityDefinition | Measure | OperationDefinition | Questionnaire)	Instantiates FHIR protocol or definition
instantiatesUri	Σ	0..*	uri	Instantiates external protocol or definition
basedOn	Σ	0..*	Reference(Resource)	Request fulfilled by this communication
partOf	Σ	0..*	Reference(Resource)	Part of this action
inResponseTo		0..*	Reference(Communication)	Reply to
status	?!Σ	1..1	code	preparation | in-progress | not-done | on-hold | stopped | completed | entered-in-error | unknown Binding: EventStatus (required): The status of the communication.
statusReason	Σ	0..1	CodeableConcept	Reason for current status Binding: CommunicationNotDoneReason (example): Codes for the reason why a communication did not happen.
category		0..*	CodeableConcept	The type of message conveyed - this should be Patient story Binding: CommunicationCategory (example): Codes for general categories of communications such as alerts, instructions, etc.
priority	Σ	0..1	code	routine | urgent | asap | stat Binding: RequestPriority (required): Codes indicating the relative importance of a communication.
medium		0..*	CodeableConcept	How the communication was sent - for example verbal, written, on-behalf Binding: ParticipationMode (example): Codes for communication mediums such as phone, fax, email, in person, etc.
subject	Σ	0..1	Reference(Patient | Group)	Focus of message
topic		0..1	CodeableConcept	Description of the purpose/content Binding: CommunicationTopic (example): Codes describing the purpose or content of the communication.
about		0..*	Reference(Resource)	Resources that pertain to this communication
encounter	Σ	0..1	Reference(Encounter)	Encounter created as part of
sent		0..1	dateTime	When sent
received		0..1	dateTime	When received
recipient		0..*	Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson | Group | CareTeam | HealthcareService)	The person who received the communication - this could be the GP, nurse or receptionist
sender		0..1	Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson | HealthcareService)	The person who sent the communication - this could be the patient's Aunty, church minister, or a health professional
reasonCode	Σ	0..*	CodeableConcept	Indication for message Binding: SNOMEDCTClinicalFindings (example): Codes for describing reasons for the occurrence of a communication.
reasonReference	Σ	0..*	Reference(Condition | Observation | DiagnosticReport | DocumentReference)	Why was communication done?
payload		0..*	BackboneElement	Important things the Patient wants known
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]:contentString		0..1	string	The Patient Wellness statement
content[x]:contentReference		0..1	Reference(Resource)	People that are important to the Patient and their care
note		0..*	Annotation	Comments made about the communication
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
Communication.language	preferred	CommonLanguages Additional Bindings Purpose AllLanguages Max Binding http://hl7.org/fhir/ValueSet/languages from the FHIR Standard
Communication.status	required	EventStatus http://hl7.org/fhir/ValueSet/event-status|4.0.1 from the FHIR Standard
Communication.statusReason	example	CommunicationNotDoneReason http://hl7.org/fhir/ValueSet/communication-not-done-reason from the FHIR Standard
Communication.category	example	CommunicationCategory http://hl7.org/fhir/ValueSet/communication-category from the FHIR Standard
Communication.priority	required	RequestPriority http://hl7.org/fhir/ValueSet/request-priority|4.0.1 from the FHIR Standard
Communication.medium	example	ParticipationMode http://terminology.hl7.org/ValueSet/v3-ParticipationMode
Communication.topic	example	CommunicationTopic http://hl7.org/fhir/ValueSet/communication-topic from the FHIR Standard
Communication.reasonCode	example	SNOMEDCTClinicalFindings http://hl7.org/fhir/ValueSet/clinical-findings from the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
dom-2	error	Communication	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	Communication	If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4	error	Communication	If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5	error	Communication	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	Communication	A resource should have narrative for robust management : text.`div`.exists()
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()

This structure is derived from Communication

Summary

Slices

This structure defines the following Slices:

• The element 1 is sliced based on the value of Communication.payload.content[x]

Differential View

This structure is derived from Communication

Name	Flags	Card.	Type	Description & Constraints
Communication		0..*	Communication	A record of information transmitted from a sender to a receiver
category		0..*	CodeableConcept	The type of message conveyed - this should be Patient story
medium		0..*	CodeableConcept	How the communication was sent - for example verbal, written, on-behalf
recipient		0..*	Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson | Group | CareTeam | HealthcareService)	The person who received the communication - this could be the GP, nurse or receptionist
sender		0..1	Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson | HealthcareService)	The person who sent the communication - this could be the patient's Aunty, church minister, or a health professional
payload		0..*	BackboneElement	Important things the Patient wants known
Slices for content[x]		1..1	string, Attachment, Reference(Resource)	Message part content Slice: Unordered, Open by type:$this
content[x]:contentString		0..1	string	The Patient Wellness statement
content[x]:contentReference		0..1	Reference(Resource)	People that are important to the Patient and their care
Documentation for this format

Key Elements View

Name	Flags	Card.	Type	Description & Constraints
Communication		0..*	Communication	A record of information transmitted from a sender to a receiver
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
status	?!Σ	1..1	code	preparation | in-progress | not-done | on-hold | stopped | completed | entered-in-error | unknown Binding: EventStatus (required): The status of the communication.
category		0..*	CodeableConcept	The type of message conveyed - this should be Patient story Binding: CommunicationCategory (example): Codes for general categories of communications such as alerts, instructions, etc.
medium		0..*	CodeableConcept	How the communication was sent - for example verbal, written, on-behalf Binding: ParticipationMode (example): Codes for communication mediums such as phone, fax, email, in person, etc.
recipient		0..*	Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson | Group | CareTeam | HealthcareService)	The person who received the communication - this could be the GP, nurse or receptionist
sender		0..1	Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson | HealthcareService)	The person who sent the communication - this could be the patient's Aunty, church minister, or a health professional
payload		0..*	BackboneElement	Important things the Patient wants known
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]:contentString		0..1	string	The Patient Wellness statement
content[x]:contentReference		0..1	Reference(Resource)	People that are important to the Patient and their care
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
Communication.status	required	EventStatus http://hl7.org/fhir/ValueSet/event-status|4.0.1 from the FHIR Standard
Communication.category	example	CommunicationCategory http://hl7.org/fhir/ValueSet/communication-category from the FHIR Standard
Communication.medium	example	ParticipationMode http://terminology.hl7.org/ValueSet/v3-ParticipationMode

Constraints

Id	Grade	Path(s)	Details	Requirements
dom-2	error	Communication	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	Communication	If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4	error	Communication	If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5	error	Communication	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	Communication	A resource should have narrative for robust management : text.`div`.exists()
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()

Snapshot View

Name	Flags	Card.	Type	Description & Constraints
Communication		0..*	Communication	A record of information transmitted from a sender to a receiver
id	Σ	0..1	id	Logical id of this artifact
meta	Σ	0..1	Meta	Metadata about the resource
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
contained		0..*	Resource	Contained, inline Resources
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
identifier	Σ	0..*	Identifier	Unique identifier
instantiatesCanonical	Σ	0..*	canonical(PlanDefinition | ActivityDefinition | Measure | OperationDefinition | Questionnaire)	Instantiates FHIR protocol or definition
instantiatesUri	Σ	0..*	uri	Instantiates external protocol or definition
basedOn	Σ	0..*	Reference(Resource)	Request fulfilled by this communication
partOf	Σ	0..*	Reference(Resource)	Part of this action
inResponseTo		0..*	Reference(Communication)	Reply to
status	?!Σ	1..1	code	preparation | in-progress | not-done | on-hold | stopped | completed | entered-in-error | unknown Binding: EventStatus (required): The status of the communication.
statusReason	Σ	0..1	CodeableConcept	Reason for current status Binding: CommunicationNotDoneReason (example): Codes for the reason why a communication did not happen.
category		0..*	CodeableConcept	The type of message conveyed - this should be Patient story Binding: CommunicationCategory (example): Codes for general categories of communications such as alerts, instructions, etc.
priority	Σ	0..1	code	routine | urgent | asap | stat Binding: RequestPriority (required): Codes indicating the relative importance of a communication.
medium		0..*	CodeableConcept	How the communication was sent - for example verbal, written, on-behalf Binding: ParticipationMode (example): Codes for communication mediums such as phone, fax, email, in person, etc.
subject	Σ	0..1	Reference(Patient | Group)	Focus of message
topic		0..1	CodeableConcept	Description of the purpose/content Binding: CommunicationTopic (example): Codes describing the purpose or content of the communication.
about		0..*	Reference(Resource)	Resources that pertain to this communication
encounter	Σ	0..1	Reference(Encounter)	Encounter created as part of
sent		0..1	dateTime	When sent
received		0..1	dateTime	When received
recipient		0..*	Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson | Group | CareTeam | HealthcareService)	The person who received the communication - this could be the GP, nurse or receptionist
sender		0..1	Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson | HealthcareService)	The person who sent the communication - this could be the patient's Aunty, church minister, or a health professional
reasonCode	Σ	0..*	CodeableConcept	Indication for message Binding: SNOMEDCTClinicalFindings (example): Codes for describing reasons for the occurrence of a communication.
reasonReference	Σ	0..*	Reference(Condition | Observation | DiagnosticReport | DocumentReference)	Why was communication done?
payload		0..*	BackboneElement	Important things the Patient wants known
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]:contentString		0..1	string	The Patient Wellness statement
content[x]:contentReference		0..1	Reference(Resource)	People that are important to the Patient and their care
note		0..*	Annotation	Comments made about the communication
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
Communication.language	preferred	CommonLanguages Additional Bindings Purpose AllLanguages Max Binding http://hl7.org/fhir/ValueSet/languages from the FHIR Standard
Communication.status	required	EventStatus http://hl7.org/fhir/ValueSet/event-status|4.0.1 from the FHIR Standard
Communication.statusReason	example	CommunicationNotDoneReason http://hl7.org/fhir/ValueSet/communication-not-done-reason from the FHIR Standard
Communication.category	example	CommunicationCategory http://hl7.org/fhir/ValueSet/communication-category from the FHIR Standard
Communication.priority	required	RequestPriority http://hl7.org/fhir/ValueSet/request-priority|4.0.1 from the FHIR Standard
Communication.medium	example	ParticipationMode http://terminology.hl7.org/ValueSet/v3-ParticipationMode
Communication.topic	example	CommunicationTopic http://hl7.org/fhir/ValueSet/communication-topic from the FHIR Standard
Communication.reasonCode	example	SNOMEDCTClinicalFindings http://hl7.org/fhir/ValueSet/clinical-findings from the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
dom-2	error	Communication	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	Communication	If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4	error	Communication	If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5	error	Communication	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	Communication	A resource should have narrative for robust management : text.`div`.exists()
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()

This structure is derived from Communication

Summary

Slices

This structure defines the following Slices:

• The element 1 is sliced based on the value of Communication.payload.content[x]

Other representations of profile: CSV, Excel, Schematron