OZO FHIR implementation guide - Local Development build (v0.1.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

• Content
• Detailed Descriptions
• Mappings
• XML
• JSON

Resource Profile: OZO CommunicationRequest

CommunicationRequest profile for the OZO platform. Represents a message thread or conversation within the care network. Individual messages are Communication resources that reference this thread via partOf.

Usages:

• Refer to this Profile: OZO Communication and OZO Task

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		0..*	CommunicationRequest	A request for information to be sent 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	?!SΣ	1..1	code	Thread status Binding: RequestStatus (required): The status of the communication request.
doNotPerform	?!Σ	0..1	boolean	True if request is prohibiting action
subject	S	1..1	Reference(OZO Patient)	Focus of message thread
reference	ΣC	1..1	string	Literal reference, Relative, internal or absolute URL
type	Σ	1..1	uri	Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
display	SΣ	0..1	string	Text alternative for the resource
payload	S	0..*	BackboneElement	Thread content
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
Slices for content[x]	S	1..1		Message part content Slice: Unordered, Open by type:$this
contentString			string
contentAttachment			Attachment
content[x]:contentAttachment		0..1	Attachment	Message part content
contentType	SΣ	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
url	SΣ	0..1	url	Uri where the data can be found Example General: http://www.acme.com/logo-small.png
title	SΣ	0..1	string	Label to display in place of the data Example General: Official Corporate Logo
creation	SΣ	0..1	dateTime	Date attachment was first created
requester	SΣ	1..1	Reference(OZO Practitioner | OZO RelatedPerson)	Who created the thread
reference	ΣC	1..1	string	Literal reference, Relative, internal or absolute URL
type	Σ	1..1	uri	Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
recipient	S	1..*	Reference(OZO Practitioner | OZO RelatedPerson | OZO CareTeam)	Thread recipients
reference	ΣC	1..1	string	Literal reference, Relative, internal or absolute URL
type	Σ	1..1	uri	Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
CommunicationRequest.status	required	RequestStatus http://hl7.org/fhir/ValueSet/request-status|4.0.1 From the FHIR Standard
CommunicationRequest.subject.type	extensible	ResourceType http://hl7.org/fhir/ValueSet/resource-types From the FHIR Standard
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.requester.type	extensible	ResourceType http://hl7.org/fhir/ValueSet/resource-types From the FHIR Standard
CommunicationRequest.recipient.type	extensible	ResourceType http://hl7.org/fhir/ValueSet/resource-types From the FHIR Standard

Constraints

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

This structure is derived from CommunicationRequest

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
CommunicationRequest			CommunicationRequest
status	S	1..1	code	Thread status
subject	S	1..1	Reference(OZO Patient)	Focus of message thread
reference		1..1	string	Literal reference, Relative, internal or absolute URL
type		1..1	uri	Type the reference refers to (e.g. "Patient")
display	S	0..1	string	Text alternative for the resource
payload	S	0..*	BackboneElement	Thread content
Slices for content[x]	S	1..1		Message part content Slice: Unordered, Open by type:$this
contentString			string
contentAttachment			Attachment
content[x]:contentAttachment		0..1	Attachment	Message part content
contentType	S	0..1	code	Mime type of the content, with charset etc.
url	S	0..1	url	Uri where the data can be found
title	S	0..1	string	Label to display in place of the data
creation	S	0..1	dateTime	Date attachment was first created
requester	S	1..1	Reference(OZO Practitioner | OZO RelatedPerson)	Who created the thread
reference		1..1	string	Literal reference, Relative, internal or absolute URL
type		1..1	uri	Type the reference refers to (e.g. "Patient")
recipient	S	1..*	Reference(OZO Practitioner | OZO RelatedPerson | OZO CareTeam)	Thread recipients
reference		1..1	string	Literal reference, Relative, internal or absolute URL
type		1..1	uri	Type the reference refers to (e.g. "Patient")
Documentation for this format

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
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
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
language		0..1	code	Language of the resource content Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
text		0..1	Narrative	Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements
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
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	?!SΣ	1..1	code	Thread status Binding: RequestStatus (required): The status of the communication request.
statusReason		0..1	CodeableConcept	Reason for current status Binding Description: (example): Codes identifying the reason for the current state of a request.
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		0..*	CodeableConcept	A channel of communication Binding: ParticipationMode (example): Codes for communication mediums such as phone, fax, email, in person, etc.
subject	S	1..1	Reference(OZO Patient)	Focus of message thread
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
reference	ΣC	1..1	string	Literal reference, Relative, internal or absolute URL
type	Σ	1..1	uri	Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
identifier	Σ	0..1	Identifier	Logical reference, when literal reference is not known
display	SΣ	0..1	string	Text alternative for the resource
about		0..*	Reference(Resource)	Resources that pertain to this communication request
encounter	Σ	0..1	Reference(Encounter)	Encounter created as part of
payload	S	0..*	BackboneElement	Thread content
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]	S	1..1		Message part content Slice: Unordered, Open by type:$this
contentString			string
contentAttachment			Attachment
content[x]:contentAttachment		0..1	Attachment	Message part content
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
contentType	SΣ	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	SΣ	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	SΣ	0..1	string	Label to display in place of the data Example General: Official Corporate Logo
creation	SΣ	0..1	dateTime	Date attachment was first created
occurrence[x]	Σ	0..1		When scheduled
occurrenceDateTime			dateTime
occurrencePeriod			Period
authoredOn	Σ	0..1	dateTime	When request transitioned to being actionable
requester	SΣ	1..1	Reference(OZO Practitioner | OZO RelatedPerson)	Who created the thread
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
reference	ΣC	1..1	string	Literal reference, Relative, internal or absolute URL
type	Σ	1..1	uri	Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
identifier	Σ	0..1	Identifier	Logical reference, when literal reference is not known
display	Σ	0..1	string	Text alternative for the resource
recipient	S	1..*	Reference(OZO Practitioner | OZO RelatedPerson | OZO CareTeam)	Thread recipients
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
reference	ΣC	1..1	string	Literal reference, Relative, internal or absolute URL
type	Σ	1..1	uri	Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
identifier	Σ	0..1	Identifier	Logical reference, when literal reference is not known
display	Σ	0..1	string	Text alternative for the resource
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.language	preferred	CommonLanguages http://hl7.org/fhir/ValueSet/languages From the FHIR Standard Additional Bindings Purpose AllLanguages Max Binding
CommunicationRequest.status	required	RequestStatus http://hl7.org/fhir/ValueSet/request-status|4.0.1 From the FHIR Standard
CommunicationRequest.statusReason	example
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	example	ParticipationMode http://terminology.hl7.org/ValueSet/v3-ParticipationMode
CommunicationRequest.subject.type	extensible	ResourceType http://hl7.org/fhir/ValueSet/resource-types From the FHIR Standard
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.requester.type	extensible	ResourceType http://hl7.org/fhir/ValueSet/resource-types From the FHIR Standard
CommunicationRequest.recipient.type	extensible	ResourceType http://hl7.org/fhir/ValueSet/resource-types From the FHIR Standard
CommunicationRequest.reasonCode	example	ActReason http://terminology.hl7.org/ValueSet/v3-ActReason

Constraints

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

This structure is derived from CommunicationRequest

Summary

Mandatory: 9 elements
Must-Support: 11 elements

Structures

This structure refers to these other structures:

• OZO Patient (http://headease.gitlab.io/ozo-refererence-impl/ozo-implementation-guide/StructureDefinition/ozo-patient)
• OZO Practitioner (http://headease.gitlab.io/ozo-refererence-impl/ozo-implementation-guide/StructureDefinition/ozo-practitioner)
• OZO RelatedPerson (http://headease.gitlab.io/ozo-refererence-impl/ozo-implementation-guide/StructureDefinition/ozo-relatedperson)
• OZO CareTeam (http://headease.gitlab.io/ozo-refererence-impl/ozo-implementation-guide/StructureDefinition/ozo-careteam)

Slices

This structure defines the following Slices:

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

Key Elements View

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
CommunicationRequest		0..*	CommunicationRequest	A request for information to be sent 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	?!SΣ	1..1	code	Thread status Binding: RequestStatus (required): The status of the communication request.
doNotPerform	?!Σ	0..1	boolean	True if request is prohibiting action
subject	S	1..1	Reference(OZO Patient)	Focus of message thread
reference	ΣC	1..1	string	Literal reference, Relative, internal or absolute URL
type	Σ	1..1	uri	Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
display	SΣ	0..1	string	Text alternative for the resource
payload	S	0..*	BackboneElement	Thread content
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
Slices for content[x]	S	1..1		Message part content Slice: Unordered, Open by type:$this
contentString			string
contentAttachment			Attachment
content[x]:contentAttachment		0..1	Attachment	Message part content
contentType	SΣ	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
url	SΣ	0..1	url	Uri where the data can be found Example General: http://www.acme.com/logo-small.png
title	SΣ	0..1	string	Label to display in place of the data Example General: Official Corporate Logo
creation	SΣ	0..1	dateTime	Date attachment was first created
requester	SΣ	1..1	Reference(OZO Practitioner | OZO RelatedPerson)	Who created the thread
reference	ΣC	1..1	string	Literal reference, Relative, internal or absolute URL
type	Σ	1..1	uri	Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
recipient	S	1..*	Reference(OZO Practitioner | OZO RelatedPerson | OZO CareTeam)	Thread recipients
reference	ΣC	1..1	string	Literal reference, Relative, internal or absolute URL
type	Σ	1..1	uri	Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
CommunicationRequest.status	required	RequestStatus http://hl7.org/fhir/ValueSet/request-status|4.0.1 From the FHIR Standard
CommunicationRequest.subject.type	extensible	ResourceType http://hl7.org/fhir/ValueSet/resource-types From the FHIR Standard
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.requester.type	extensible	ResourceType http://hl7.org/fhir/ValueSet/resource-types From the FHIR Standard
CommunicationRequest.recipient.type	extensible	ResourceType http://hl7.org/fhir/ValueSet/resource-types From the FHIR Standard

Constraints

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

Differential View

This structure is derived from CommunicationRequest

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
CommunicationRequest			CommunicationRequest
status	S	1..1	code	Thread status
subject	S	1..1	Reference(OZO Patient)	Focus of message thread
reference		1..1	string	Literal reference, Relative, internal or absolute URL
type		1..1	uri	Type the reference refers to (e.g. "Patient")
display	S	0..1	string	Text alternative for the resource
payload	S	0..*	BackboneElement	Thread content
Slices for content[x]	S	1..1		Message part content Slice: Unordered, Open by type:$this
contentString			string
contentAttachment			Attachment
content[x]:contentAttachment		0..1	Attachment	Message part content
contentType	S	0..1	code	Mime type of the content, with charset etc.
url	S	0..1	url	Uri where the data can be found
title	S	0..1	string	Label to display in place of the data
creation	S	0..1	dateTime	Date attachment was first created
requester	S	1..1	Reference(OZO Practitioner | OZO RelatedPerson)	Who created the thread
reference		1..1	string	Literal reference, Relative, internal or absolute URL
type		1..1	uri	Type the reference refers to (e.g. "Patient")
recipient	S	1..*	Reference(OZO Practitioner | OZO RelatedPerson | OZO CareTeam)	Thread recipients
reference		1..1	string	Literal reference, Relative, internal or absolute URL
type		1..1	uri	Type the reference refers to (e.g. "Patient")
Documentation for this format

Snapshot View

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
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
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
language		0..1	code	Language of the resource content Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
text		0..1	Narrative	Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements
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
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	?!SΣ	1..1	code	Thread status Binding: RequestStatus (required): The status of the communication request.
statusReason		0..1	CodeableConcept	Reason for current status Binding Description: (example): Codes identifying the reason for the current state of a request.
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		0..*	CodeableConcept	A channel of communication Binding: ParticipationMode (example): Codes for communication mediums such as phone, fax, email, in person, etc.
subject	S	1..1	Reference(OZO Patient)	Focus of message thread
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
reference	ΣC	1..1	string	Literal reference, Relative, internal or absolute URL
type	Σ	1..1	uri	Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
identifier	Σ	0..1	Identifier	Logical reference, when literal reference is not known
display	SΣ	0..1	string	Text alternative for the resource
about		0..*	Reference(Resource)	Resources that pertain to this communication request
encounter	Σ	0..1	Reference(Encounter)	Encounter created as part of
payload	S	0..*	BackboneElement	Thread content
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]	S	1..1		Message part content Slice: Unordered, Open by type:$this
contentString			string
contentAttachment			Attachment
content[x]:contentAttachment		0..1	Attachment	Message part content
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
contentType	SΣ	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	SΣ	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	SΣ	0..1	string	Label to display in place of the data Example General: Official Corporate Logo
creation	SΣ	0..1	dateTime	Date attachment was first created
occurrence[x]	Σ	0..1		When scheduled
occurrenceDateTime			dateTime
occurrencePeriod			Period
authoredOn	Σ	0..1	dateTime	When request transitioned to being actionable
requester	SΣ	1..1	Reference(OZO Practitioner | OZO RelatedPerson)	Who created the thread
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
reference	ΣC	1..1	string	Literal reference, Relative, internal or absolute URL
type	Σ	1..1	uri	Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
identifier	Σ	0..1	Identifier	Logical reference, when literal reference is not known
display	Σ	0..1	string	Text alternative for the resource
recipient	S	1..*	Reference(OZO Practitioner | OZO RelatedPerson | OZO CareTeam)	Thread recipients
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
reference	ΣC	1..1	string	Literal reference, Relative, internal or absolute URL
type	Σ	1..1	uri	Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
identifier	Σ	0..1	Identifier	Logical reference, when literal reference is not known
display	Σ	0..1	string	Text alternative for the resource
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.language	preferred	CommonLanguages http://hl7.org/fhir/ValueSet/languages From the FHIR Standard Additional Bindings Purpose AllLanguages Max Binding
CommunicationRequest.status	required	RequestStatus http://hl7.org/fhir/ValueSet/request-status|4.0.1 From the FHIR Standard
CommunicationRequest.statusReason	example
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	example	ParticipationMode http://terminology.hl7.org/ValueSet/v3-ParticipationMode
CommunicationRequest.subject.type	extensible	ResourceType http://hl7.org/fhir/ValueSet/resource-types From the FHIR Standard
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.requester.type	extensible	ResourceType http://hl7.org/fhir/ValueSet/resource-types From the FHIR Standard
CommunicationRequest.recipient.type	extensible	ResourceType http://hl7.org/fhir/ValueSet/resource-types From the FHIR Standard
CommunicationRequest.reasonCode	example	ActReason http://terminology.hl7.org/ValueSet/v3-ActReason

Constraints

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

This structure is derived from CommunicationRequest

Summary

Mandatory: 9 elements
Must-Support: 11 elements

Structures

This structure refers to these other structures:

• OZO Patient (http://headease.gitlab.io/ozo-refererence-impl/ozo-implementation-guide/StructureDefinition/ozo-patient)
• OZO Practitioner (http://headease.gitlab.io/ozo-refererence-impl/ozo-implementation-guide/StructureDefinition/ozo-practitioner)
• OZO RelatedPerson (http://headease.gitlab.io/ozo-refererence-impl/ozo-implementation-guide/StructureDefinition/ozo-relatedperson)
• OZO CareTeam (http://headease.gitlab.io/ozo-refererence-impl/ozo-implementation-guide/StructureDefinition/ozo-careteam)

Slices

This structure defines the following Slices:

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

Other representations of profile: CSV, Excel, Schematron