OZO FHIR implementation guide
0.9.0 - ci-build

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

Resource Profile: OZO CommunicationRequest

Official URL: http://ozoverbindzorg.nl/fhir/StructureDefinition/OZOCommunicationRequest Version: 0.9.0
Active as of 2026-10-07 Computable Name: OZOCommunicationRequest

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:

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.

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. CommunicationRequest C 0..* CommunicationRequest A request for information to be sent to a receiver
Constraints: ozo-communicationrequest-unique-recipients, ozo-cr-sender-careteam-not-in-recipient
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:senderCareTeam S 0..1 Reference(OZO Organizational CareTeam) Initiating CareTeam (reply-to address for team-level messaging)
URL: http://ozoverbindzorg.nl/fhir/StructureDefinition/ozo-sender-careteam
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... 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 | OZO Patient) 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 | OZO Organizational CareTeam) Addressed parties
.... 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).
... sender SΣ 0..1 Reference(OZO Practitioner | OZO RelatedPerson | OZO Patient) Individual reply-to address
.... 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).

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
CommunicationRequest.​status Base required RequestStatus 📍4.0.1 FHIR Std.
CommunicationRequest.​subject.type Base extensible ResourceType 📍4.0.1 FHIR Std.
CommunicationRequest.​payload.content[x]:contentAttachment.​contentType Base required MimeType 📍4.0.1 FHIR Std.
CommunicationRequest.​requester.type Base extensible ResourceType 📍4.0.1 FHIR Std.
CommunicationRequest.​recipient.type Base extensible ResourceType 📍4.0.1 FHIR Std.
CommunicationRequest.​sender.type Base extensible ResourceType 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
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()
ozo-communicationrequest-unique-recipients error CommunicationRequest Each recipient can appear at most once in a CommunicationRequest. Compares the literal recipient.reference strings; logical references via identifier (no reference field) are not de-duplicated. recipient.reference.distinct().count() = recipient.reference.count()
ozo-cr-sender-careteam-not-in-recipient warning CommunicationRequest When extension[senderCareTeam] is present, the referenced CareTeam should not be listed in recipient. recipient contains the addressed parties; the initiating team is identified by the extension, and the participant search parameter covers both elements for access scoping. The 0.8.x shape with the team in both places is deprecated: it is accepted in 0.9.0 (this invariant is a warning) and has no effect, because the thread parties are the set union of recipient and the extension. The severity becomes error in the release after 0.9.0. extension('http://ozoverbindzorg.nl/fhir/StructureDefinition/ozo-sender-careteam').empty() or (extension('http://ozoverbindzorg.nl/fhir/StructureDefinition/ozo-sender-careteam').value.reference in recipient.reference).not()

This structure is derived from CommunicationRequest

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. CommunicationRequest C 0..* CommunicationRequest A request for information to be sent to a receiver
Constraints: ozo-communicationrequest-unique-recipients, ozo-cr-sender-careteam-not-in-recipient
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:senderCareTeam S 0..1 Reference(OZO Organizational CareTeam) Initiating CareTeam (reply-to address for team-level messaging)
URL: http://ozoverbindzorg.nl/fhir/StructureDefinition/ozo-sender-careteam
... 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
.... 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 | OZO Patient) 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 | OZO Organizational CareTeam) Addressed parties
.... reference 1..1 string Literal reference, Relative, internal or absolute URL
.... type 1..1 uri Type the reference refers to (e.g. "Patient")
... sender S 0..1 Reference(OZO Practitioner | OZO RelatedPerson | OZO Patient) Individual reply-to address
.... reference 1..1 string Literal reference, Relative, internal or absolute URL
.... type 1..1 uri Type the reference refers to (e.g. "Patient")

doco Documentation for this format

Constraints

Id Grade Path(s) Description Expression
ozo-communicationrequest-unique-recipients error CommunicationRequest Each recipient can appear at most once in a CommunicationRequest. Compares the literal recipient.reference strings; logical references via identifier (no reference field) are not de-duplicated. recipient.reference.distinct().count() = recipient.reference.count()
ozo-cr-sender-careteam-not-in-recipient warning CommunicationRequest When extension[senderCareTeam] is present, the referenced CareTeam should not be listed in recipient. recipient contains the addressed parties; the initiating team is identified by the extension, and the participant search parameter covers both elements for access scoping. The 0.8.x shape with the team in both places is deprecated: it is accepted in 0.9.0 (this invariant is a warning) and has no effect, because the thread parties are the set union of recipient and the extension. The severity becomes error in the release after 0.9.0. extension('http://ozoverbindzorg.nl/fhir/StructureDefinition/ozo-sender-careteam').empty() or (extension('http://ozoverbindzorg.nl/fhir/StructureDefinition/ozo-sender-careteam').value.reference in recipient.reference).not()
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. CommunicationRequest C 0..* CommunicationRequest A request for information to be sent to a receiver
Constraints: ozo-communicationrequest-unique-recipients, ozo-cr-sender-careteam-not-in-recipient
... 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 BindingsPurpose
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
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:senderCareTeam S 0..1 Reference(OZO Organizational CareTeam) Initiating CareTeam (reply-to address for team-level messaging)
URL: http://ozoverbindzorg.nl/fhir/StructureDefinition/ozo-sender-careteam
... 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 BindingsPurpose
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 | OZO Patient) 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 | OZO Organizational CareTeam) Addressed parties
.... 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 SΣ 0..1 Reference(OZO Practitioner | OZO RelatedPerson | OZO Patient) Individual reply-to address
.... 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
... 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

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
CommunicationRequest.​language Base preferred Common Languages 📍4.0.1 FHIR Std.
CommunicationRequest.​status Base required RequestStatus 📍4.0.1 FHIR Std.
CommunicationRequest.​statusReason Base example Not State Unknown
CommunicationRequest.​category Base example CommunicationCategory 📍4.0.1 FHIR Std.
CommunicationRequest.​priority Base required Request priority 📍4.0.1 FHIR Std.
CommunicationRequest.​medium Base example ParticipationMode 📦3.0.0 THO v7.4
CommunicationRequest.​subject.type Base extensible ResourceType 📍4.0.1 FHIR Std.
CommunicationRequest.​payload.content[x]:contentAttachment.​contentType Base required MimeType 📍4.0.1 FHIR Std.
CommunicationRequest.​payload.content[x]:contentAttachment.​language Base preferred Common Languages 📍4.0.1 FHIR Std.
CommunicationRequest.​requester.type Base extensible ResourceType 📍4.0.1 FHIR Std.
CommunicationRequest.​recipient.type Base extensible ResourceType 📍4.0.1 FHIR Std.
CommunicationRequest.​sender.type Base extensible ResourceType 📍4.0.1 FHIR Std.
CommunicationRequest.​reasonCode Base example v3 Code System ActReason 📦3.0.0 THO v7.4

Constraints

Id Grade Path(s) Description Expression
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()
ozo-communicationrequest-unique-recipients error CommunicationRequest Each recipient can appear at most once in a CommunicationRequest. Compares the literal recipient.reference strings; logical references via identifier (no reference field) are not de-duplicated. recipient.reference.distinct().count() = recipient.reference.count()
ozo-cr-sender-careteam-not-in-recipient warning CommunicationRequest When extension[senderCareTeam] is present, the referenced CareTeam should not be listed in recipient. recipient contains the addressed parties; the initiating team is identified by the extension, and the participant search parameter covers both elements for access scoping. The 0.8.x shape with the team in both places is deprecated: it is accepted in 0.9.0 (this invariant is a warning) and has no effect, because the thread parties are the set union of recipient and the extension. The severity becomes error in the release after 0.9.0. extension('http://ozoverbindzorg.nl/fhir/StructureDefinition/ozo-sender-careteam').empty() or (extension('http://ozoverbindzorg.nl/fhir/StructureDefinition/ozo-sender-careteam').value.reference in recipient.reference).not()

This structure is derived from CommunicationRequest

Summary

Mandatory: 9 elements(2 nested mandatory elements)
Must-Support: 13 elements

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

Slices

This structure defines the following Slices:

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

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. CommunicationRequest C 0..* CommunicationRequest A request for information to be sent to a receiver
Constraints: ozo-communicationrequest-unique-recipients, ozo-cr-sender-careteam-not-in-recipient
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:senderCareTeam S 0..1 Reference(OZO Organizational CareTeam) Initiating CareTeam (reply-to address for team-level messaging)
URL: http://ozoverbindzorg.nl/fhir/StructureDefinition/ozo-sender-careteam
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... 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 | OZO Patient) 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 | OZO Organizational CareTeam) Addressed parties
.... 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).
... sender SΣ 0..1 Reference(OZO Practitioner | OZO RelatedPerson | OZO Patient) Individual reply-to address
.... 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).

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
CommunicationRequest.​status Base required RequestStatus 📍4.0.1 FHIR Std.
CommunicationRequest.​subject.type Base extensible ResourceType 📍4.0.1 FHIR Std.
CommunicationRequest.​payload.content[x]:contentAttachment.​contentType Base required MimeType 📍4.0.1 FHIR Std.
CommunicationRequest.​requester.type Base extensible ResourceType 📍4.0.1 FHIR Std.
CommunicationRequest.​recipient.type Base extensible ResourceType 📍4.0.1 FHIR Std.
CommunicationRequest.​sender.type Base extensible ResourceType 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
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()
ozo-communicationrequest-unique-recipients error CommunicationRequest Each recipient can appear at most once in a CommunicationRequest. Compares the literal recipient.reference strings; logical references via identifier (no reference field) are not de-duplicated. recipient.reference.distinct().count() = recipient.reference.count()
ozo-cr-sender-careteam-not-in-recipient warning CommunicationRequest When extension[senderCareTeam] is present, the referenced CareTeam should not be listed in recipient. recipient contains the addressed parties; the initiating team is identified by the extension, and the participant search parameter covers both elements for access scoping. The 0.8.x shape with the team in both places is deprecated: it is accepted in 0.9.0 (this invariant is a warning) and has no effect, because the thread parties are the set union of recipient and the extension. The severity becomes error in the release after 0.9.0. extension('http://ozoverbindzorg.nl/fhir/StructureDefinition/ozo-sender-careteam').empty() or (extension('http://ozoverbindzorg.nl/fhir/StructureDefinition/ozo-sender-careteam').value.reference in recipient.reference).not()

Differential View

This structure is derived from CommunicationRequest

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. CommunicationRequest C 0..* CommunicationRequest A request for information to be sent to a receiver
Constraints: ozo-communicationrequest-unique-recipients, ozo-cr-sender-careteam-not-in-recipient
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:senderCareTeam S 0..1 Reference(OZO Organizational CareTeam) Initiating CareTeam (reply-to address for team-level messaging)
URL: http://ozoverbindzorg.nl/fhir/StructureDefinition/ozo-sender-careteam
... 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
.... 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 | OZO Patient) 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 | OZO Organizational CareTeam) Addressed parties
.... reference 1..1 string Literal reference, Relative, internal or absolute URL
.... type 1..1 uri Type the reference refers to (e.g. "Patient")
... sender S 0..1 Reference(OZO Practitioner | OZO RelatedPerson | OZO Patient) Individual reply-to address
.... reference 1..1 string Literal reference, Relative, internal or absolute URL
.... type 1..1 uri Type the reference refers to (e.g. "Patient")

doco Documentation for this format

Constraints

Id Grade Path(s) Description Expression
ozo-communicationrequest-unique-recipients error CommunicationRequest Each recipient can appear at most once in a CommunicationRequest. Compares the literal recipient.reference strings; logical references via identifier (no reference field) are not de-duplicated. recipient.reference.distinct().count() = recipient.reference.count()
ozo-cr-sender-careteam-not-in-recipient warning CommunicationRequest When extension[senderCareTeam] is present, the referenced CareTeam should not be listed in recipient. recipient contains the addressed parties; the initiating team is identified by the extension, and the participant search parameter covers both elements for access scoping. The 0.8.x shape with the team in both places is deprecated: it is accepted in 0.9.0 (this invariant is a warning) and has no effect, because the thread parties are the set union of recipient and the extension. The severity becomes error in the release after 0.9.0. extension('http://ozoverbindzorg.nl/fhir/StructureDefinition/ozo-sender-careteam').empty() or (extension('http://ozoverbindzorg.nl/fhir/StructureDefinition/ozo-sender-careteam').value.reference in recipient.reference).not()

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. CommunicationRequest C 0..* CommunicationRequest A request for information to be sent to a receiver
Constraints: ozo-communicationrequest-unique-recipients, ozo-cr-sender-careteam-not-in-recipient
... 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 BindingsPurpose
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
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:senderCareTeam S 0..1 Reference(OZO Organizational CareTeam) Initiating CareTeam (reply-to address for team-level messaging)
URL: http://ozoverbindzorg.nl/fhir/StructureDefinition/ozo-sender-careteam
... 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 BindingsPurpose
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 | OZO Patient) 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 | OZO Organizational CareTeam) Addressed parties
.... 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 SΣ 0..1 Reference(OZO Practitioner | OZO RelatedPerson | OZO Patient) Individual reply-to address
.... 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
... 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

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
CommunicationRequest.​language Base preferred Common Languages 📍4.0.1 FHIR Std.
CommunicationRequest.​status Base required RequestStatus 📍4.0.1 FHIR Std.
CommunicationRequest.​statusReason Base example Not State Unknown
CommunicationRequest.​category Base example CommunicationCategory 📍4.0.1 FHIR Std.
CommunicationRequest.​priority Base required Request priority 📍4.0.1 FHIR Std.
CommunicationRequest.​medium Base example ParticipationMode 📦3.0.0 THO v7.4
CommunicationRequest.​subject.type Base extensible ResourceType 📍4.0.1 FHIR Std.
CommunicationRequest.​payload.content[x]:contentAttachment.​contentType Base required MimeType 📍4.0.1 FHIR Std.
CommunicationRequest.​payload.content[x]:contentAttachment.​language Base preferred Common Languages 📍4.0.1 FHIR Std.
CommunicationRequest.​requester.type Base extensible ResourceType 📍4.0.1 FHIR Std.
CommunicationRequest.​recipient.type Base extensible ResourceType 📍4.0.1 FHIR Std.
CommunicationRequest.​sender.type Base extensible ResourceType 📍4.0.1 FHIR Std.
CommunicationRequest.​reasonCode Base example v3 Code System ActReason 📦3.0.0 THO v7.4

Constraints

Id Grade Path(s) Description Expression
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()
ozo-communicationrequest-unique-recipients error CommunicationRequest Each recipient can appear at most once in a CommunicationRequest. Compares the literal recipient.reference strings; logical references via identifier (no reference field) are not de-duplicated. recipient.reference.distinct().count() = recipient.reference.count()
ozo-cr-sender-careteam-not-in-recipient warning CommunicationRequest When extension[senderCareTeam] is present, the referenced CareTeam should not be listed in recipient. recipient contains the addressed parties; the initiating team is identified by the extension, and the participant search parameter covers both elements for access scoping. The 0.8.x shape with the team in both places is deprecated: it is accepted in 0.9.0 (this invariant is a warning) and has no effect, because the thread parties are the set union of recipient and the extension. The severity becomes error in the release after 0.9.0. extension('http://ozoverbindzorg.nl/fhir/StructureDefinition/ozo-sender-careteam').empty() or (extension('http://ozoverbindzorg.nl/fhir/StructureDefinition/ozo-sender-careteam').value.reference in recipient.reference).not()

This structure is derived from CommunicationRequest

Summary

Mandatory: 9 elements(2 nested mandatory elements)
Must-Support: 13 elements

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

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