HL7® Austria TC FHIR® Messaging
0.1.0 - ci-build
HL7® Austria TC FHIR® Messaging, published by HL7® Austria, TC FHIR®. This guide is not an authorized publication; it is the continuous build for version 0.1.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7Austria/TC-FHIR-AG-Messaging-R5/ and changes regularly. See the Directory of published versions
| Official URL: http://fhir.hl7.at/fhir/ATMessaging/0.1.0/StructureDefinition/at-messaging-communication-request | Version: 0.1.0 | |||
| Draft as of 2026-02-02 | Responsible: HL7® Austria, TC FHIR® | Computable Name: ATMessagingCommunicationRequest | ||
Usage:Jurisdiction: Austria |
||||
CommunicationRequest to be used for all communication request messages transfered with the AT FHIR messaging.
Usages:
You can also check for usages in the FHIR IG Statistics
Description of Profiles, Differentials, Snapshots and how the different presentations work.
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
0..* | CommunicationRequest | A request for information to be sent to a receiver | |
![]() ![]() |
Σ | 1..1 | id | Logical id of this artifact |
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
![]() ![]() |
0..* | Resource | Contained, inline Resources | |
![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored |
![]() ![]() |
?!Σ | 1..1 | code | draft | active | on-hold | revoked | completed | entered-in-error | unknown Binding: RequestStatus (required): The status of the communication request. |
![]() ![]() |
?!Σ | 1..1 | code | proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option Binding: RequestIntent (required): Codes indicating the degree of authority/intentionality associated with a request. |
![]() ![]() |
?!Σ | 0..1 | boolean | True if request is prohibiting action |
![]() ![]() |
S | 0..1 | BackboneElement | Message payload |
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() |
1..1 | ATMessagingCommunicationAttachment | Message part content | |
Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| CommunicationRequest.status | Base | required | RequestStatus | 📍5.0.0 | FHIR Std. |
| CommunicationRequest.intent | Base | required | RequestIntent | 📍5.0.0 | FHIR Std. |
| 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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(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: ![]() ![]() |
|---|---|---|---|---|
![]() |
0..* | CommunicationRequest | A request for information to be sent to a receiver | |
![]() ![]() |
1..1 | id | Logical id of this artifact | |
![]() ![]() |
S | 0..1 | BackboneElement | Message payload |
![]() ![]() ![]() |
1..1 | ATMessagingCommunicationAttachment | Message part content | |
![]() ![]() |
0..0 | Comments made about communication request | ||
Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() | ||||
|---|---|---|---|---|---|---|---|---|
![]() |
0..* | CommunicationRequest | A request for information to be sent to a receiver | |||||
![]() ![]() |
Σ | 1..1 | id | Logical id of this artifact | ||||
![]() ![]() |
Σ | 0..1 | Meta | Metadata about the resource | ||||
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]() |
0..1 | code | Language of the resource content Binding: AllLanguages (required): IETF language tag for a human language
| |||||
![]() ![]() |
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 | |||||
![]() ![]() |
0..* | Resource | Contained, inline Resources | |||||
![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() |
Σ | 0..* | Identifier | Unique identifier | ||||
![]() ![]() |
Σ | 0..* | Reference(Resource) | Fulfills plan or proposal | ||||
![]() ![]() |
Σ | 0..* | Reference(CommunicationRequest) | Request(s) replaced by this request | ||||
![]() ![]() |
Σ | 0..1 | Identifier | Composite request this is part of | ||||
![]() ![]() |
?!Σ | 1..1 | code | draft | active | on-hold | revoked | completed | entered-in-error | unknown Binding: RequestStatus (required): The status of the communication request. | ||||
![]() ![]() |
0..1 | CodeableConcept | Reason for current status Binding: CommunicationRequestStatusReason (example): Codes identifying the reason for the current state of a request. | |||||
![]() ![]() |
?!Σ | 1..1 | code | proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option Binding: RequestIntent (required): Codes indicating the degree of authority/intentionality associated with a request. | ||||
![]() ![]() |
0..* | CodeableConcept | Message category Binding: CommunicationCategory (example): Codes for general categories of communications such as alerts, instruction, etc. | |||||
![]() ![]() |
Σ | 0..1 | code | routine | urgent | asap | stat Binding: RequestPriority (required): Codes indicating the relative importance of a communication request. | ||||
![]() ![]() |
?!Σ | 0..1 | boolean | True if request is prohibiting action | ||||
![]() ![]() |
0..* | CodeableConcept | A channel of communication Binding: ParticipationMode (example): Codes for communication mediums such as phone, fax, email, in person, etc. | |||||
![]() ![]() |
0..1 | Reference(Patient | Group) | Focus of message | |||||
![]() ![]() |
0..* | Reference(Resource) | Resources that pertain to this communication request | |||||
![]() ![]() |
Σ | 0..1 | Reference(Encounter) | The Encounter during which this CommunicationRequest was created | ||||
![]() ![]() |
S | 0..1 | BackboneElement | Message payload | ||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() |
1..1 | ATMessagingCommunicationAttachment | Message part content | |||||
![]() ![]() |
Σ | 0..1 | When scheduled | |||||
![]() ![]() ![]() |
dateTime | |||||||
![]() ![]() ![]() |
Period | |||||||
![]() ![]() |
Σ | 0..1 | dateTime | When request transitioned to being actionable | ||||
![]() ![]() |
Σ | 0..1 | Reference(Practitioner | PractitionerRole | Organization | Patient | RelatedPerson | Device) | Who asks for the information to be shared | ||||
![]() ![]() |
0..* | Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson | Group | CareTeam | HealthcareService | Endpoint) | Who to share the information with | |||||
![]() ![]() |
Σ | 0..* | Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson | HealthcareService | Endpoint) | Who should share the information | ||||
![]() ![]() |
Σ | 0..* | CodeableReference(Resource) | Why is communication needed? Binding: v3 Code System ActReason (example): Codes for describing reasons for the occurrence of a communication. | ||||
Documentation for this format | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| CommunicationRequest.language | Base | required | All Languages | 📍5.0.0 | FHIR Std. |
| CommunicationRequest.status | Base | required | RequestStatus | 📍5.0.0 | FHIR Std. |
| CommunicationRequest.statusReason | Base | example | CommunicationRequest Status Reason | 📍5.0.0 | FHIR Std. |
| CommunicationRequest.intent | Base | required | RequestIntent | 📍5.0.0 | FHIR Std. |
| CommunicationRequest.category | Base | example | Communication Category | 📍5.0.0 | FHIR Std. |
| CommunicationRequest.priority | Base | required | RequestPriority | 📍5.0.0 | FHIR Std. |
| CommunicationRequest.medium | Base | example | ParticipationMode | 📦3.0.0 | THO v7.0 |
| CommunicationRequest.reason | Base | example | v3 Code System ActReason | 📦3.0.0 | THO v7.0 |
| 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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(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
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
0..* | CommunicationRequest | A request for information to be sent to a receiver | |
![]() ![]() |
Σ | 1..1 | id | Logical id of this artifact |
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
![]() ![]() |
0..* | Resource | Contained, inline Resources | |
![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored |
![]() ![]() |
?!Σ | 1..1 | code | draft | active | on-hold | revoked | completed | entered-in-error | unknown Binding: RequestStatus (required): The status of the communication request. |
![]() ![]() |
?!Σ | 1..1 | code | proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option Binding: RequestIntent (required): Codes indicating the degree of authority/intentionality associated with a request. |
![]() ![]() |
?!Σ | 0..1 | boolean | True if request is prohibiting action |
![]() ![]() |
S | 0..1 | BackboneElement | Message payload |
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() |
1..1 | ATMessagingCommunicationAttachment | Message part content | |
Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| CommunicationRequest.status | Base | required | RequestStatus | 📍5.0.0 | FHIR Std. |
| CommunicationRequest.intent | Base | required | RequestIntent | 📍5.0.0 | FHIR Std. |
| 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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(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: ![]() ![]() |
|---|---|---|---|---|
![]() |
0..* | CommunicationRequest | A request for information to be sent to a receiver | |
![]() ![]() |
1..1 | id | Logical id of this artifact | |
![]() ![]() |
S | 0..1 | BackboneElement | Message payload |
![]() ![]() ![]() |
1..1 | ATMessagingCommunicationAttachment | Message part content | |
![]() ![]() |
0..0 | Comments made about communication request | ||
Documentation for this format | ||||
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() | ||||
|---|---|---|---|---|---|---|---|---|
![]() |
0..* | CommunicationRequest | A request for information to be sent to a receiver | |||||
![]() ![]() |
Σ | 1..1 | id | Logical id of this artifact | ||||
![]() ![]() |
Σ | 0..1 | Meta | Metadata about the resource | ||||
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]() |
0..1 | code | Language of the resource content Binding: AllLanguages (required): IETF language tag for a human language
| |||||
![]() ![]() |
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 | |||||
![]() ![]() |
0..* | Resource | Contained, inline Resources | |||||
![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() |
Σ | 0..* | Identifier | Unique identifier | ||||
![]() ![]() |
Σ | 0..* | Reference(Resource) | Fulfills plan or proposal | ||||
![]() ![]() |
Σ | 0..* | Reference(CommunicationRequest) | Request(s) replaced by this request | ||||
![]() ![]() |
Σ | 0..1 | Identifier | Composite request this is part of | ||||
![]() ![]() |
?!Σ | 1..1 | code | draft | active | on-hold | revoked | completed | entered-in-error | unknown Binding: RequestStatus (required): The status of the communication request. | ||||
![]() ![]() |
0..1 | CodeableConcept | Reason for current status Binding: CommunicationRequestStatusReason (example): Codes identifying the reason for the current state of a request. | |||||
![]() ![]() |
?!Σ | 1..1 | code | proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option Binding: RequestIntent (required): Codes indicating the degree of authority/intentionality associated with a request. | ||||
![]() ![]() |
0..* | CodeableConcept | Message category Binding: CommunicationCategory (example): Codes for general categories of communications such as alerts, instruction, etc. | |||||
![]() ![]() |
Σ | 0..1 | code | routine | urgent | asap | stat Binding: RequestPriority (required): Codes indicating the relative importance of a communication request. | ||||
![]() ![]() |
?!Σ | 0..1 | boolean | True if request is prohibiting action | ||||
![]() ![]() |
0..* | CodeableConcept | A channel of communication Binding: ParticipationMode (example): Codes for communication mediums such as phone, fax, email, in person, etc. | |||||
![]() ![]() |
0..1 | Reference(Patient | Group) | Focus of message | |||||
![]() ![]() |
0..* | Reference(Resource) | Resources that pertain to this communication request | |||||
![]() ![]() |
Σ | 0..1 | Reference(Encounter) | The Encounter during which this CommunicationRequest was created | ||||
![]() ![]() |
S | 0..1 | BackboneElement | Message payload | ||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() |
1..1 | ATMessagingCommunicationAttachment | Message part content | |||||
![]() ![]() |
Σ | 0..1 | When scheduled | |||||
![]() ![]() ![]() |
dateTime | |||||||
![]() ![]() ![]() |
Period | |||||||
![]() ![]() |
Σ | 0..1 | dateTime | When request transitioned to being actionable | ||||
![]() ![]() |
Σ | 0..1 | Reference(Practitioner | PractitionerRole | Organization | Patient | RelatedPerson | Device) | Who asks for the information to be shared | ||||
![]() ![]() |
0..* | Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson | Group | CareTeam | HealthcareService | Endpoint) | Who to share the information with | |||||
![]() ![]() |
Σ | 0..* | Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson | HealthcareService | Endpoint) | Who should share the information | ||||
![]() ![]() |
Σ | 0..* | CodeableReference(Resource) | Why is communication needed? Binding: v3 Code System ActReason (example): Codes for describing reasons for the occurrence of a communication. | ||||
Documentation for this format | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| CommunicationRequest.language | Base | required | All Languages | 📍5.0.0 | FHIR Std. |
| CommunicationRequest.status | Base | required | RequestStatus | 📍5.0.0 | FHIR Std. |
| CommunicationRequest.statusReason | Base | example | CommunicationRequest Status Reason | 📍5.0.0 | FHIR Std. |
| CommunicationRequest.intent | Base | required | RequestIntent | 📍5.0.0 | FHIR Std. |
| CommunicationRequest.category | Base | example | Communication Category | 📍5.0.0 | FHIR Std. |
| CommunicationRequest.priority | Base | required | RequestPriority | 📍5.0.0 | FHIR Std. |
| CommunicationRequest.medium | Base | example | ParticipationMode | 📦3.0.0 | THO v7.0 |
| CommunicationRequest.reason | Base | example | v3 Code System ActReason | 📦3.0.0 | THO v7.0 |
| 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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(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
Other representations of profile: CSV, Excel, Schematron