AddCommunication Implementation Guide
2.2 - version 2.2

This page is part of the Release of AddCommunication IG (v2.2: Release) based on FHIR (HL7® FHIR® Standard) v5.0.0. . For a full list of available versions, see the Directory of published versions

Resource Profile: Invitation CommunicationRequest

Official URL: http://bki.skane.se/invanartjanster/fhir/StructureDefinition/InvitationCommunicationRequest Version: 2.2
Draft as of 2025-02-04 Computable Name: InvitationCommunicationRequest

Resource to hold information about Communication and Invitation.

Usage:

Formal Views of Profile Content

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

NameFlagsCard.TypeDescription & Constraintsdoco
.. CommunicationRequest C 0..* CommunicationRequest A request for information to be sent to a receiver
dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
dom-5: If a resource is contained in another resource, it SHALL NOT have a security label
dom-6: A resource should have narrative for robust management
must-have-xml-and-rtf: If there is an XML, there must also be an RTF
must-have-rtf-and-xml: If there is an RTF, there must also be an XML
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
ele-1: All FHIR elements must have a @value or children
... contained 0..* Resource Contained, inline Resources
... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... DigitalOnly 0..1 boolean Digital only flag
URL: http://bki.skane.se/invanartjanster/fhir/StructureDefinition/extDigitalOnly
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... InvitationActionType 1..1 string Action Type
URL: http://bki.skane.se/invanartjanster/fhir/StructureDefinition/extInvitationActionType
Binding: Kalla Invitation Action Types (required)
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... ResolveGuardiansFromPU 0..1 boolean Resolve guardians from PU flag
URL: http://bki.skane.se/invanartjanster/fhir/StructureDefinition/extResolveGuardiansFromPU
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
... identifier Σ 1..1 Identifier ReferenceId
ele-1: All FHIR elements must have a @value or children
... status ?!Σ 1..1 code The status of the communication request
Binding: RequestStatus (required): The status of the communication request.


ele-1: All FHIR elements must have a @value or children
... intent ?!Σ 1..1 code The intent of the communication request
Binding: RequestIntent (required): Codes indicating the degree of authority/intentionality associated with a request.


ele-1: All FHIR elements must have a @value or children
... doNotPerform ?!Σ 0..1 boolean True if request is prohibiting action
ele-1: All FHIR elements must have a @value or children
... subject 1..1 Reference(Patient) Reference to the Patient
ele-1: All FHIR elements must have a @value or children
... about 1..* Reference(Invitation Appointment) Reference to Appointment
ele-1: All FHIR elements must have a @value or children
... Slices for payload 0..2 BackboneElement XML for digital content and RTF for content to be printed
Slice: Unordered, Closed by value:content.ofType(Attachment).contentType
ele-1: All FHIR elements must have a @value or children
.... payload:All Slices Content/Rules for all slices
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... content[x] 1..1 Message part content
ele-1: All FHIR elements must have a @value or children
...... contentAttachment Attachment
...... contentReference Reference(Resource)
...... contentCodeableConcept CodeableConcept
.... payload:digital 0..1 BackboneElement DocBook XML file
ele-1: All FHIR elements must have a @value or children
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... Slices for content[x] 1..1 Message part content
Slice: Unordered, Open by type:$this
ele-1: All FHIR elements must have a @value or children
...... contentAttachment Attachment
...... contentReference Reference(Resource)
...... contentCodeableConcept CodeableConcept
...... content[x]:contentAttachment 0..1 Attachment Message part content
ele-1: All FHIR elements must have a @value or children
....... contentType ΣC 1..1 code Content type xml
Binding: MimeTypes (required): BCP 13 (RFCs 2045, 2046, 2047, 4288, 4289 and 2049)


ele-1: All FHIR elements must have a @value or children
Required Pattern: application/xml
.... payload:print 0..1 BackboneElement RTF File
ele-1: All FHIR elements must have a @value or children
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... Slices for content[x] 1..1 Message part content
Slice: Unordered, Open by type:$this
ele-1: All FHIR elements must have a @value or children
...... contentAttachment Attachment
...... contentReference Reference(Resource)
...... contentCodeableConcept CodeableConcept
...... content[x]:contentAttachment 0..1 Attachment Message part content
ele-1: All FHIR elements must have a @value or children
....... contentType ΣC 1..1 code Content type rtf
Binding: MimeTypes (required): BCP 13 (RFCs 2045, 2046, 2047, 4288, 4289 and 2049)


ele-1: All FHIR elements must have a @value or children
Required Pattern: application/rtf

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
CommunicationRequest.statusrequiredRequestStatus
http://hl7.org/fhir/ValueSet/request-status|5.0.0
from the FHIR Standard
CommunicationRequest.intentrequiredRequestIntent
http://hl7.org/fhir/ValueSet/request-intent|5.0.0
from the FHIR Standard
CommunicationRequest.payload:digital.content[x]:contentAttachment.contentTyperequiredPattern: application/xml
http://hl7.org/fhir/ValueSet/mimetypes|5.0.0
from the FHIR Standard
CommunicationRequest.payload:print.content[x]:contentAttachment.contentTyperequiredPattern: application/rtf
http://hl7.org/fhir/ValueSet/mimetypes|5.0.0
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
must-have-rtf-and-xmlerrorCommunicationRequestIf there is an RTF, there must also be an XML
: payload.where(content.ofType(Attachment).contentType = 'application/rtf').exists() implies payload.where(content.ofType(Attachment).contentType = 'application/xml').exists()
must-have-xml-and-rtferrorCommunicationRequestIf there is an XML, there must also be an RTF
: payload.where(content.ofType(Attachment).contentType = 'application/xml').exists() implies payload.where(content.ofType(Attachment).contentType = 'application/rtf').exists()

This structure is derived from CommunicationRequest

NameFlagsCard.TypeDescription & Constraintsdoco
.. CommunicationRequest C 0..* CommunicationRequest A request for information to be sent to a receiver
must-have-xml-and-rtf: If there is an XML, there must also be an RTF
must-have-rtf-and-xml: If there is an RTF, there must also be an XML
... meta
.... versionId 1..1 id Version Id must be included
... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
.... DigitalOnly 0..1 boolean Digital only flag
URL: http://bki.skane.se/invanartjanster/fhir/StructureDefinition/extDigitalOnly
.... InvitationActionType 1..1 string Action Type
URL: http://bki.skane.se/invanartjanster/fhir/StructureDefinition/extInvitationActionType
Binding: Kalla Invitation Action Types (required)
.... ResolveGuardiansFromPU 0..1 boolean Resolve guardians from PU flag
URL: http://bki.skane.se/invanartjanster/fhir/StructureDefinition/extResolveGuardiansFromPU
... identifier 1..1 Identifier ReferenceId
... intent 1..1 code The intent of the communication request
... subject 1..1 Reference(Patient) Reference to the Patient
... about 1..* Reference(Invitation Appointment) Reference to Appointment
... Slices for payload 0..2 BackboneElement XML for digital content and RTF for content to be printed
Slice: Unordered, Closed by value:content.ofType(Attachment).contentType
.... payload:digital 0..1 BackboneElement DocBook XML file
..... Slices for content[x] 1..1 Attachment, Reference(Resource), CodeableConcept Message part content
Slice: Unordered, Open by type:$this
...... content[x]:contentAttachment 0..1 Attachment Message part content
....... contentType 1..1 code Content type xml
Required Pattern: application/xml
.... payload:print 0..1 BackboneElement RTF File
..... Slices for content[x] 1..1 Attachment, Reference(Resource), CodeableConcept Message part content
Slice: Unordered, Open by type:$this
...... content[x]:contentAttachment 0..1 Attachment Message part content
....... contentType 1..1 code Content type rtf
Required Pattern: application/rtf

doco Documentation for this format

Constraints

IdGradePath(s)DetailsRequirements
must-have-rtf-and-xmlerrorCommunicationRequestIf there is an RTF, there must also be an XML
: payload.where(content.ofType(Attachment).contentType = 'application/rtf').exists() implies payload.where(content.ofType(Attachment).contentType = 'application/xml').exists()
must-have-xml-and-rtferrorCommunicationRequestIf there is an XML, there must also be an RTF
: payload.where(content.ofType(Attachment).contentType = 'application/xml').exists() implies payload.where(content.ofType(Attachment).contentType = 'application/rtf').exists()
NameFlagsCard.TypeDescription & Constraintsdoco
.. CommunicationRequest C 0..* CommunicationRequest A request for information to be sent to a receiver
must-have-xml-and-rtf: If there is an XML, there must also be an RTF
must-have-rtf-and-xml: If there is an RTF, there must also be an XML
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
.... id 0..1 id Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... versionId Σ 1..1 id Version Id must be included
.... lastUpdated Σ 0..1 instant When the resource version last changed
.... source Σ 0..1 uri Identifies where the resource comes from
.... profile Σ 0..* canonical(StructureDefinition) Profiles this resource claims to conform to
.... security Σ 0..* Coding Security Labels applied to this resource
Binding: AllSecurityLabels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.


.... tag Σ 0..* Coding Tags applied to this resource
Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".


... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... language 0..1 code Language of the resource content
Binding: AllLanguages (required): IETF language tag for a human language

Additional BindingsPurpose
CommonLanguages Starter Set
... text 0..1 Narrative Text summary of the resource, for human interpretation
... contained 0..* Resource Contained, inline Resources
... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
.... DigitalOnly 0..1 boolean Digital only flag
URL: http://bki.skane.se/invanartjanster/fhir/StructureDefinition/extDigitalOnly
.... InvitationActionType 1..1 string Action Type
URL: http://bki.skane.se/invanartjanster/fhir/StructureDefinition/extInvitationActionType
Binding: Kalla Invitation Action Types (required)
.... ResolveGuardiansFromPU 0..1 boolean Resolve guardians from PU flag
URL: http://bki.skane.se/invanartjanster/fhir/StructureDefinition/extResolveGuardiansFromPU
... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
... identifier Σ 1..1 Identifier ReferenceId
... basedOn Σ 0..* Reference(Resource) Fulfills plan or proposal
... replaces Σ 0..* Reference(CommunicationRequest) Request(s) replaced by this request
... groupIdentifier Σ 0..1 Identifier Composite request this is part of
... status ?!Σ 1..1 code The status of the communication request
Binding: RequestStatus (required): The status of the communication request.

... statusReason 0..1 CodeableConcept Reason for current status
Binding: CommunicationRequestStatusReason (example): Codes identifying the reason for the current state of a request.

... intent ?!Σ 1..1 code The intent of the communication request
Binding: RequestIntent (required): Codes indicating the degree of authority/intentionality associated with 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 1..1 Reference(Patient) Reference to the Patient
... about 1..* Reference(Invitation Appointment) Reference to Appointment
... encounter Σ 0..1 Reference(Encounter) The Encounter during which this CommunicationRequest was created
... Slices for payload 0..2 BackboneElement XML for digital content and RTF for content to be printed
Slice: Unordered, Closed by value:content.ofType(Attachment).contentType
.... payload:All Slices Content/Rules for all slices
..... 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
..... content[x] 1..1 Message part content
...... contentAttachment Attachment
...... contentReference Reference(Resource)
...... contentCodeableConcept CodeableConcept
.... payload:digital 0..1 BackboneElement DocBook XML file
..... 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
...... contentAttachment Attachment
...... contentReference Reference(Resource)
...... contentCodeableConcept CodeableConcept
...... content[x]:contentAttachment 0..1 Attachment Message part content
....... id 0..1 id Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
....... contentType ΣC 1..1 code Content type xml
Binding: MimeTypes (required): BCP 13 (RFCs 2045, 2046, 2047, 4288, 4289 and 2049)


Required Pattern: application/xml
....... language Σ 0..1 code Human language of the content (BCP-47)
Binding: AllLanguages (required): IETF language tag for a human language.

Additional BindingsPurpose
CommonLanguages Starter Set

Example General: en-AU
....... data C 0..1 base64Binary Data inline, base64ed
....... url Σ 0..1 url Uri where the data can be found
Example General: http://www.acme.com/logo-small.png
....... size Σ 0..1 integer64 Number of bytes of content (if url provided)
....... hash Σ 0..1 base64Binary Hash of the data (sha-1, base64ed)
....... title Σ 0..1 string Label to display in place of the data
Example General: Official Corporate Logo
....... creation Σ 0..1 dateTime Date attachment was first created
....... height 0..1 positiveInt Height of the image in pixels (photo/video)
....... width 0..1 positiveInt Width of the image in pixels (photo/video)
....... frames 0..1 positiveInt Number of frames if > 1 (photo)
....... duration 0..1 decimal Length in seconds (audio / video)
....... pages 0..1 positiveInt Number of printed pages
.... payload:print 0..1 BackboneElement RTF File
..... 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
...... contentAttachment Attachment
...... contentReference Reference(Resource)
...... contentCodeableConcept CodeableConcept
...... content[x]:contentAttachment 0..1 Attachment Message part content
....... id 0..1 id Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
....... contentType ΣC 1..1 code Content type rtf
Binding: MimeTypes (required): BCP 13 (RFCs 2045, 2046, 2047, 4288, 4289 and 2049)


Required Pattern: application/rtf
....... language Σ 0..1 code Human language of the content (BCP-47)
Binding: AllLanguages (required): IETF language tag for a human language.

Additional BindingsPurpose
CommonLanguages Starter Set

Example General: en-AU
....... data C 0..1 base64Binary Data inline, base64ed
....... url Σ 0..1 url Uri where the data can be found
Example General: http://www.acme.com/logo-small.png
....... size Σ 0..1 integer64 Number of bytes of content (if url provided)
....... hash Σ 0..1 base64Binary Hash of the data (sha-1, base64ed)
....... title Σ 0..1 string Label to display in place of the data
Example General: Official Corporate Logo
....... creation Σ 0..1 dateTime Date attachment was first created
....... height 0..1 positiveInt Height of the image in pixels (photo/video)
....... width 0..1 positiveInt Width of the image in pixels (photo/video)
....... frames 0..1 positiveInt Number of frames if > 1 (photo)
....... duration 0..1 decimal Length in seconds (audio / video)
....... pages 0..1 positiveInt Number of printed pages
... occurrence[x] Σ 0..1 When scheduled
.... occurrenceDateTime dateTime
.... occurrencePeriod Period
... authoredOn Σ 0..1 dateTime When request transitioned to being actionable
... requester Σ 0..1 Reference(Practitioner | PractitionerRole | Organization | Patient | RelatedPerson | Device) Who asks for the information to be shared
... recipient 0..* Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson | Group | CareTeam | HealthcareService | Endpoint) Who to share the information with
... informationProvider Σ 0..* Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson | HealthcareService | Endpoint) Who should share the information
... reason Σ 0..* CodeableReference(Resource) Why is communication needed?
Binding: v3 Code System ActReason (example): Codes for describing reasons for the occurrence of a communication.


... note 0..* Annotation Comments made about communication request

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
CommunicationRequest.meta.securityextensibleAllSecurityLabels
http://hl7.org/fhir/ValueSet/security-labels
from the FHIR Standard
CommunicationRequest.meta.tagexampleCommonTags
http://hl7.org/fhir/ValueSet/common-tags
from the FHIR Standard
CommunicationRequest.languagerequiredAllLanguages
http://hl7.org/fhir/ValueSet/all-languages|5.0.0
from the FHIR Standard
CommunicationRequest.statusrequiredRequestStatus
http://hl7.org/fhir/ValueSet/request-status|5.0.0
from the FHIR Standard
CommunicationRequest.statusReasonexampleCommunicationRequestStatusReason
http://hl7.org/fhir/ValueSet/communication-request-status-reason
from the FHIR Standard
CommunicationRequest.intentrequiredRequestIntent
http://hl7.org/fhir/ValueSet/request-intent|5.0.0
from the FHIR Standard
CommunicationRequest.categoryexampleCommunicationCategory
http://hl7.org/fhir/ValueSet/communication-category
from the FHIR Standard
CommunicationRequest.priorityrequiredRequestPriority
http://hl7.org/fhir/ValueSet/request-priority|5.0.0
from the FHIR Standard
CommunicationRequest.mediumexampleParticipationMode
http://terminology.hl7.org/ValueSet/v3-ParticipationMode
CommunicationRequest.payload:digital.content[x]:contentAttachment.contentTyperequiredPattern: application/xml
http://hl7.org/fhir/ValueSet/mimetypes|5.0.0
from the FHIR Standard
CommunicationRequest.payload:digital.content[x]:contentAttachment.languagerequiredAllLanguages
http://hl7.org/fhir/ValueSet/all-languages|5.0.0
from the FHIR Standard
CommunicationRequest.payload:print.content[x]:contentAttachment.contentTyperequiredPattern: application/rtf
http://hl7.org/fhir/ValueSet/mimetypes|5.0.0
from the FHIR Standard
CommunicationRequest.payload:print.content[x]:contentAttachment.languagerequiredAllLanguages
http://hl7.org/fhir/ValueSet/all-languages|5.0.0
from the FHIR Standard
CommunicationRequest.reasonexampleActReason
http://terminology.hl7.org/ValueSet/v3-ActReason

Constraints

IdGradePath(s)DetailsRequirements
must-have-rtf-and-xmlerrorCommunicationRequestIf there is an RTF, there must also be an XML
: payload.where(content.ofType(Attachment).contentType = 'application/rtf').exists() implies payload.where(content.ofType(Attachment).contentType = 'application/xml').exists()
must-have-xml-and-rtferrorCommunicationRequestIf there is an XML, there must also be an RTF
: payload.where(content.ofType(Attachment).contentType = 'application/xml').exists() implies payload.where(content.ofType(Attachment).contentType = 'application/rtf').exists()

This structure is derived from CommunicationRequest

Summary

Mandatory: 5 elements(3 nested mandatory 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 (Closed)
  • The element 1 is sliced based on the value of CommunicationRequest.payload.content[x]

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. CommunicationRequest C 0..* CommunicationRequest A request for information to be sent to a receiver
dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
dom-5: If a resource is contained in another resource, it SHALL NOT have a security label
dom-6: A resource should have narrative for robust management
must-have-xml-and-rtf: If there is an XML, there must also be an RTF
must-have-rtf-and-xml: If there is an RTF, there must also be an XML
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
ele-1: All FHIR elements must have a @value or children
... contained 0..* Resource Contained, inline Resources
... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... DigitalOnly 0..1 boolean Digital only flag
URL: http://bki.skane.se/invanartjanster/fhir/StructureDefinition/extDigitalOnly
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... InvitationActionType 1..1 string Action Type
URL: http://bki.skane.se/invanartjanster/fhir/StructureDefinition/extInvitationActionType
Binding: Kalla Invitation Action Types (required)
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... ResolveGuardiansFromPU 0..1 boolean Resolve guardians from PU flag
URL: http://bki.skane.se/invanartjanster/fhir/StructureDefinition/extResolveGuardiansFromPU
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
... identifier Σ 1..1 Identifier ReferenceId
ele-1: All FHIR elements must have a @value or children
... status ?!Σ 1..1 code The status of the communication request
Binding: RequestStatus (required): The status of the communication request.


ele-1: All FHIR elements must have a @value or children
... intent ?!Σ 1..1 code The intent of the communication request
Binding: RequestIntent (required): Codes indicating the degree of authority/intentionality associated with a request.


ele-1: All FHIR elements must have a @value or children
... doNotPerform ?!Σ 0..1 boolean True if request is prohibiting action
ele-1: All FHIR elements must have a @value or children
... subject 1..1 Reference(Patient) Reference to the Patient
ele-1: All FHIR elements must have a @value or children
... about 1..* Reference(Invitation Appointment) Reference to Appointment
ele-1: All FHIR elements must have a @value or children
... Slices for payload 0..2 BackboneElement XML for digital content and RTF for content to be printed
Slice: Unordered, Closed by value:content.ofType(Attachment).contentType
ele-1: All FHIR elements must have a @value or children
.... payload:All Slices Content/Rules for all slices
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... content[x] 1..1 Message part content
ele-1: All FHIR elements must have a @value or children
...... contentAttachment Attachment
...... contentReference Reference(Resource)
...... contentCodeableConcept CodeableConcept
.... payload:digital 0..1 BackboneElement DocBook XML file
ele-1: All FHIR elements must have a @value or children
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... Slices for content[x] 1..1 Message part content
Slice: Unordered, Open by type:$this
ele-1: All FHIR elements must have a @value or children
...... contentAttachment Attachment
...... contentReference Reference(Resource)
...... contentCodeableConcept CodeableConcept
...... content[x]:contentAttachment 0..1 Attachment Message part content
ele-1: All FHIR elements must have a @value or children
....... contentType ΣC 1..1 code Content type xml
Binding: MimeTypes (required): BCP 13 (RFCs 2045, 2046, 2047, 4288, 4289 and 2049)


ele-1: All FHIR elements must have a @value or children
Required Pattern: application/xml
.... payload:print 0..1 BackboneElement RTF File
ele-1: All FHIR elements must have a @value or children
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... Slices for content[x] 1..1 Message part content
Slice: Unordered, Open by type:$this
ele-1: All FHIR elements must have a @value or children
...... contentAttachment Attachment
...... contentReference Reference(Resource)
...... contentCodeableConcept CodeableConcept
...... content[x]:contentAttachment 0..1 Attachment Message part content
ele-1: All FHIR elements must have a @value or children
....... contentType ΣC 1..1 code Content type rtf
Binding: MimeTypes (required): BCP 13 (RFCs 2045, 2046, 2047, 4288, 4289 and 2049)


ele-1: All FHIR elements must have a @value or children
Required Pattern: application/rtf

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
CommunicationRequest.statusrequiredRequestStatus
http://hl7.org/fhir/ValueSet/request-status|5.0.0
from the FHIR Standard
CommunicationRequest.intentrequiredRequestIntent
http://hl7.org/fhir/ValueSet/request-intent|5.0.0
from the FHIR Standard
CommunicationRequest.payload:digital.content[x]:contentAttachment.contentTyperequiredPattern: application/xml
http://hl7.org/fhir/ValueSet/mimetypes|5.0.0
from the FHIR Standard
CommunicationRequest.payload:print.content[x]:contentAttachment.contentTyperequiredPattern: application/rtf
http://hl7.org/fhir/ValueSet/mimetypes|5.0.0
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
must-have-rtf-and-xmlerrorCommunicationRequestIf there is an RTF, there must also be an XML
: payload.where(content.ofType(Attachment).contentType = 'application/rtf').exists() implies payload.where(content.ofType(Attachment).contentType = 'application/xml').exists()
must-have-xml-and-rtferrorCommunicationRequestIf there is an XML, there must also be an RTF
: payload.where(content.ofType(Attachment).contentType = 'application/xml').exists() implies payload.where(content.ofType(Attachment).contentType = 'application/rtf').exists()

Differential View

This structure is derived from CommunicationRequest

NameFlagsCard.TypeDescription & Constraintsdoco
.. CommunicationRequest C 0..* CommunicationRequest A request for information to be sent to a receiver
must-have-xml-and-rtf: If there is an XML, there must also be an RTF
must-have-rtf-and-xml: If there is an RTF, there must also be an XML
... meta
.... versionId 1..1 id Version Id must be included
... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
.... DigitalOnly 0..1 boolean Digital only flag
URL: http://bki.skane.se/invanartjanster/fhir/StructureDefinition/extDigitalOnly
.... InvitationActionType 1..1 string Action Type
URL: http://bki.skane.se/invanartjanster/fhir/StructureDefinition/extInvitationActionType
Binding: Kalla Invitation Action Types (required)
.... ResolveGuardiansFromPU 0..1 boolean Resolve guardians from PU flag
URL: http://bki.skane.se/invanartjanster/fhir/StructureDefinition/extResolveGuardiansFromPU
... identifier 1..1 Identifier ReferenceId
... intent 1..1 code The intent of the communication request
... subject 1..1 Reference(Patient) Reference to the Patient
... about 1..* Reference(Invitation Appointment) Reference to Appointment
... Slices for payload 0..2 BackboneElement XML for digital content and RTF for content to be printed
Slice: Unordered, Closed by value:content.ofType(Attachment).contentType
.... payload:digital 0..1 BackboneElement DocBook XML file
..... Slices for content[x] 1..1 Attachment, Reference(Resource), CodeableConcept Message part content
Slice: Unordered, Open by type:$this
...... content[x]:contentAttachment 0..1 Attachment Message part content
....... contentType 1..1 code Content type xml
Required Pattern: application/xml
.... payload:print 0..1 BackboneElement RTF File
..... Slices for content[x] 1..1 Attachment, Reference(Resource), CodeableConcept Message part content
Slice: Unordered, Open by type:$this
...... content[x]:contentAttachment 0..1 Attachment Message part content
....... contentType 1..1 code Content type rtf
Required Pattern: application/rtf

doco Documentation for this format

Constraints

IdGradePath(s)DetailsRequirements
must-have-rtf-and-xmlerrorCommunicationRequestIf there is an RTF, there must also be an XML
: payload.where(content.ofType(Attachment).contentType = 'application/rtf').exists() implies payload.where(content.ofType(Attachment).contentType = 'application/xml').exists()
must-have-xml-and-rtferrorCommunicationRequestIf there is an XML, there must also be an RTF
: payload.where(content.ofType(Attachment).contentType = 'application/xml').exists() implies payload.where(content.ofType(Attachment).contentType = 'application/rtf').exists()

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. CommunicationRequest C 0..* CommunicationRequest A request for information to be sent to a receiver
must-have-xml-and-rtf: If there is an XML, there must also be an RTF
must-have-rtf-and-xml: If there is an RTF, there must also be an XML
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
.... id 0..1 id Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... versionId Σ 1..1 id Version Id must be included
.... lastUpdated Σ 0..1 instant When the resource version last changed
.... source Σ 0..1 uri Identifies where the resource comes from
.... profile Σ 0..* canonical(StructureDefinition) Profiles this resource claims to conform to
.... security Σ 0..* Coding Security Labels applied to this resource
Binding: AllSecurityLabels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.


.... tag Σ 0..* Coding Tags applied to this resource
Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".


... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... language 0..1 code Language of the resource content
Binding: AllLanguages (required): IETF language tag for a human language

Additional BindingsPurpose
CommonLanguages Starter Set
... text 0..1 Narrative Text summary of the resource, for human interpretation
... contained 0..* Resource Contained, inline Resources
... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
.... DigitalOnly 0..1 boolean Digital only flag
URL: http://bki.skane.se/invanartjanster/fhir/StructureDefinition/extDigitalOnly
.... InvitationActionType 1..1 string Action Type
URL: http://bki.skane.se/invanartjanster/fhir/StructureDefinition/extInvitationActionType
Binding: Kalla Invitation Action Types (required)
.... ResolveGuardiansFromPU 0..1 boolean Resolve guardians from PU flag
URL: http://bki.skane.se/invanartjanster/fhir/StructureDefinition/extResolveGuardiansFromPU
... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
... identifier Σ 1..1 Identifier ReferenceId
... basedOn Σ 0..* Reference(Resource) Fulfills plan or proposal
... replaces Σ 0..* Reference(CommunicationRequest) Request(s) replaced by this request
... groupIdentifier Σ 0..1 Identifier Composite request this is part of
... status ?!Σ 1..1 code The status of the communication request
Binding: RequestStatus (required): The status of the communication request.

... statusReason 0..1 CodeableConcept Reason for current status
Binding: CommunicationRequestStatusReason (example): Codes identifying the reason for the current state of a request.

... intent ?!Σ 1..1 code The intent of the communication request
Binding: RequestIntent (required): Codes indicating the degree of authority/intentionality associated with 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 1..1 Reference(Patient) Reference to the Patient
... about 1..* Reference(Invitation Appointment) Reference to Appointment
... encounter Σ 0..1 Reference(Encounter) The Encounter during which this CommunicationRequest was created
... Slices for payload 0..2 BackboneElement XML for digital content and RTF for content to be printed
Slice: Unordered, Closed by value:content.ofType(Attachment).contentType
.... payload:All Slices Content/Rules for all slices
..... 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
..... content[x] 1..1 Message part content
...... contentAttachment Attachment
...... contentReference Reference(Resource)
...... contentCodeableConcept CodeableConcept
.... payload:digital 0..1 BackboneElement DocBook XML file
..... 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
...... contentAttachment Attachment
...... contentReference Reference(Resource)
...... contentCodeableConcept CodeableConcept
...... content[x]:contentAttachment 0..1 Attachment Message part content
....... id 0..1 id Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
....... contentType ΣC 1..1 code Content type xml
Binding: MimeTypes (required): BCP 13 (RFCs 2045, 2046, 2047, 4288, 4289 and 2049)


Required Pattern: application/xml
....... language Σ 0..1 code Human language of the content (BCP-47)
Binding: AllLanguages (required): IETF language tag for a human language.

Additional BindingsPurpose
CommonLanguages Starter Set

Example General: en-AU
....... data C 0..1 base64Binary Data inline, base64ed
....... url Σ 0..1 url Uri where the data can be found
Example General: http://www.acme.com/logo-small.png
....... size Σ 0..1 integer64 Number of bytes of content (if url provided)
....... hash Σ 0..1 base64Binary Hash of the data (sha-1, base64ed)
....... title Σ 0..1 string Label to display in place of the data
Example General: Official Corporate Logo
....... creation Σ 0..1 dateTime Date attachment was first created
....... height 0..1 positiveInt Height of the image in pixels (photo/video)
....... width 0..1 positiveInt Width of the image in pixels (photo/video)
....... frames 0..1 positiveInt Number of frames if > 1 (photo)
....... duration 0..1 decimal Length in seconds (audio / video)
....... pages 0..1 positiveInt Number of printed pages
.... payload:print 0..1 BackboneElement RTF File
..... 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
...... contentAttachment Attachment
...... contentReference Reference(Resource)
...... contentCodeableConcept CodeableConcept
...... content[x]:contentAttachment 0..1 Attachment Message part content
....... id 0..1 id Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
....... contentType ΣC 1..1 code Content type rtf
Binding: MimeTypes (required): BCP 13 (RFCs 2045, 2046, 2047, 4288, 4289 and 2049)


Required Pattern: application/rtf
....... language Σ 0..1 code Human language of the content (BCP-47)
Binding: AllLanguages (required): IETF language tag for a human language.

Additional BindingsPurpose
CommonLanguages Starter Set

Example General: en-AU
....... data C 0..1 base64Binary Data inline, base64ed
....... url Σ 0..1 url Uri where the data can be found
Example General: http://www.acme.com/logo-small.png
....... size Σ 0..1 integer64 Number of bytes of content (if url provided)
....... hash Σ 0..1 base64Binary Hash of the data (sha-1, base64ed)
....... title Σ 0..1 string Label to display in place of the data
Example General: Official Corporate Logo
....... creation Σ 0..1 dateTime Date attachment was first created
....... height 0..1 positiveInt Height of the image in pixels (photo/video)
....... width 0..1 positiveInt Width of the image in pixels (photo/video)
....... frames 0..1 positiveInt Number of frames if > 1 (photo)
....... duration 0..1 decimal Length in seconds (audio / video)
....... pages 0..1 positiveInt Number of printed pages
... occurrence[x] Σ 0..1 When scheduled
.... occurrenceDateTime dateTime
.... occurrencePeriod Period
... authoredOn Σ 0..1 dateTime When request transitioned to being actionable
... requester Σ 0..1 Reference(Practitioner | PractitionerRole | Organization | Patient | RelatedPerson | Device) Who asks for the information to be shared
... recipient 0..* Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson | Group | CareTeam | HealthcareService | Endpoint) Who to share the information with
... informationProvider Σ 0..* Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson | HealthcareService | Endpoint) Who should share the information
... reason Σ 0..* CodeableReference(Resource) Why is communication needed?
Binding: v3 Code System ActReason (example): Codes for describing reasons for the occurrence of a communication.


... note 0..* Annotation Comments made about communication request

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
CommunicationRequest.meta.securityextensibleAllSecurityLabels
http://hl7.org/fhir/ValueSet/security-labels
from the FHIR Standard
CommunicationRequest.meta.tagexampleCommonTags
http://hl7.org/fhir/ValueSet/common-tags
from the FHIR Standard
CommunicationRequest.languagerequiredAllLanguages
http://hl7.org/fhir/ValueSet/all-languages|5.0.0
from the FHIR Standard
CommunicationRequest.statusrequiredRequestStatus
http://hl7.org/fhir/ValueSet/request-status|5.0.0
from the FHIR Standard
CommunicationRequest.statusReasonexampleCommunicationRequestStatusReason
http://hl7.org/fhir/ValueSet/communication-request-status-reason
from the FHIR Standard
CommunicationRequest.intentrequiredRequestIntent
http://hl7.org/fhir/ValueSet/request-intent|5.0.0
from the FHIR Standard
CommunicationRequest.categoryexampleCommunicationCategory
http://hl7.org/fhir/ValueSet/communication-category
from the FHIR Standard
CommunicationRequest.priorityrequiredRequestPriority
http://hl7.org/fhir/ValueSet/request-priority|5.0.0
from the FHIR Standard
CommunicationRequest.mediumexampleParticipationMode
http://terminology.hl7.org/ValueSet/v3-ParticipationMode
CommunicationRequest.payload:digital.content[x]:contentAttachment.contentTyperequiredPattern: application/xml
http://hl7.org/fhir/ValueSet/mimetypes|5.0.0
from the FHIR Standard
CommunicationRequest.payload:digital.content[x]:contentAttachment.languagerequiredAllLanguages
http://hl7.org/fhir/ValueSet/all-languages|5.0.0
from the FHIR Standard
CommunicationRequest.payload:print.content[x]:contentAttachment.contentTyperequiredPattern: application/rtf
http://hl7.org/fhir/ValueSet/mimetypes|5.0.0
from the FHIR Standard
CommunicationRequest.payload:print.content[x]:contentAttachment.languagerequiredAllLanguages
http://hl7.org/fhir/ValueSet/all-languages|5.0.0
from the FHIR Standard
CommunicationRequest.reasonexampleActReason
http://terminology.hl7.org/ValueSet/v3-ActReason

Constraints

IdGradePath(s)DetailsRequirements
must-have-rtf-and-xmlerrorCommunicationRequestIf there is an RTF, there must also be an XML
: payload.where(content.ofType(Attachment).contentType = 'application/rtf').exists() implies payload.where(content.ofType(Attachment).contentType = 'application/xml').exists()
must-have-xml-and-rtferrorCommunicationRequestIf there is an XML, there must also be an RTF
: payload.where(content.ofType(Attachment).contentType = 'application/xml').exists() implies payload.where(content.ofType(Attachment).contentType = 'application/rtf').exists()

This structure is derived from CommunicationRequest

Summary

Mandatory: 5 elements(3 nested mandatory 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 (Closed)
  • The element 1 is sliced based on the value of CommunicationRequest.payload.content[x]

 

Other representations of profile: CSV, Excel, Schematron