AU eRequesting Implementation Guide
1.0.0-ci-build - CI Build

AU eRequesting Implementation Guide, published by HL7 Australia. This guide is not an authorized publication; it is the continuous build for version 1.0.0-ci-build built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/hl7au/au-fhir-erequesting/ and changes regularly. See the Directory of published versions

## Resource Profile: AU eRequesting CommunicationRequest CopyTo

Official URL: http://hl7.org.au/fhir/ereq/StructureDefinition/au-erequesting-communicationrequest-copyto | Version: 1.0.0-ci-build
Standards status: Draft | Maturity Level: 1 | Computable Name: AUeRequestingCommunicationRequestCopyTo
Copyright/Legal: Used by permission of HL7 International, all rights reserved Creative Commons License. HL7 Australia© 2024+; Licensed Under Creative Commons No Rights Reserved.

This profile sets the minimum expectations for a CommunicationRequest resource used to represent a request for a report to be copied to a clinician or patient as an additional recipient. A copy-to clinician is distinct from a request for urgent communication to a provider, as the priority may not be urgent. It is based on the AU eRequesting CommunicationRequest profile and identifies the additional constraints, extensions, vocabularies and value sets that SHALL be present in the CommunicationRequest when conforming to this profile.

Usages:

- Refer to this Profile: AU eRequesting Task Communication Request
- Examples for this Profile: CommunicationRequest/communicationrequest-copyto-gp
- CapabilityStatements using this Profile: AU eRequesting Filler CapabilityStatement, AU eRequesting Patient CapabilityStatement, AU eRequesting Placer CapabilityStatement and AU eRequesting Server CapabilityStatement

You can also check for usages in the FHIR IG Statistics

Changes since version 1.0.0-ballot:

- The resource metadata has changed (description)

### Formal Views of Profile Content

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

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

This structure is derived from AUeRequestingCommunicationRequest

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
CommunicationRequest |  | 0..* | AUeRequestingCommunicationRequest | A request for information to be sent to a receiver
category |  | 1..1 | CodeableConcept | Message category
coding |  | 1..1 | Coding | Code defined by a terminology system Required Pattern: At least the following
system |  | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/communication-category
code |  | 1..1 | code | Symbol in syntax defined by the system Fixed Value: notification
doNotPerform |  | 0..0 |  |
about |  | 1..* | Reference(AU eRequesting Pathology Request | AU eRequesting Imaging Request) | Diagnostic request the copy-to communication is about
requester |  | 1..1 | Reference(AU Core PractitionerRole) | Individual provider requesting the communication
recipient |  | 1..1 | Reference(AU Core PractitionerRole | AU Core Patient) | Individual provider or patient who is the intended recipient of the copy
reasonCode |  |  |  |
coding |  | 1..1 | Coding | Code defined by a terminology system Required Pattern: At least the following
system |  | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org.au/CodeSystem/communicationrequest-reason
code |  | 1..1 | code | Symbol in syntax defined by the system Fixed Value: copyto
Documentation for this format

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
CommunicationRequest |  | 0..* | AUeRequestingCommunicationRequest | A request for information to be sent to a receiver
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored
groupIdentifier | SO Σ | 1..1 | AULocalOrderIdentifier | Composite request this is part of
Obligations | Actor | Source
SHALL:populate | AU eRequesting Placer | from AU eRequesting CommunicationRequest
SHALL:handle | AU eRequesting Filler | from AU eRequesting CommunicationRequest
SHALL:handle | AU eRequesting Server | from AU eRequesting CommunicationRequest
SHALL:able-to-populate | AU eRequesting Server | from AU eRequesting CommunicationRequest
SHALL:no-error | AU eRequesting Patient | from AU eRequesting CommunicationRequest
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type | Σ | 1..1 | CodeableConcept | Coded identifier type for local order identifier Binding: Order Identifier Type (required)
coding | Σ | 1..1 | Coding | Code defined by a terminology system Required Pattern: At least the following
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
system |  | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
version |  | 0..1 | string | Version of the system - if relevant
code |  | 1..1 | code | Symbol in syntax defined by the system Fixed Value: PGN
display |  | 0..1 | string | Representation defined by the system
userSelected |  | 0..1 | boolean | If this coding was chosen directly by the user
system | Σ | 1..1 | uri | System identifier namespace for the organisation that assigned the order identifier Example General: http://www.acme.com/identifiers/patient
value | Σ | 1..1 | string | Order identifier Example General: 123456
status | ?!SO Σ | 1..1 | code | draft | active | on-hold | revoked | completed | entered-in-error | unknown Binding: RequestStatus (required): The status of the communication request. Fixed Value: active
Obligations | Actor | Source
SHALL:populate | AU eRequesting Placer | from AU eRequesting CommunicationRequest
SHALL:handle | AU eRequesting Filler | from AU eRequesting CommunicationRequest
SHALL:handle | AU eRequesting Server | from AU eRequesting CommunicationRequest
SHALL:able-to-populate | AU eRequesting Server | from AU eRequesting CommunicationRequest
SHALL:no-error | AU eRequesting Patient | from AU eRequesting CommunicationRequest
category | SO | 1..1 | CodeableConcept | Message category Binding: CommunicationCategory (example): Codes for general categories of communications such as alerts, instruction, etc.
Obligations | Actor | Source
SHALL:populate | AU eRequesting Placer | from AU eRequesting CommunicationRequest
SHALL:handle | AU eRequesting Filler | from AU eRequesting CommunicationRequest
SHALL:handle | AU eRequesting Server | from AU eRequesting CommunicationRequest
SHALL:able-to-populate | AU eRequesting Server | from AU eRequesting CommunicationRequest
SHALL:no-error | AU eRequesting Patient | from AU eRequesting CommunicationRequest
coding | Σ | 1..1 | Coding | Code defined by a terminology system Required Pattern: At least the following
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
system |  | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/communication-category
version |  | 0..1 | string | Version of the system - if relevant
code |  | 1..1 | code | Symbol in syntax defined by the system Fixed Value: notification
display |  | 0..1 | string | Representation defined by the system
userSelected |  | 0..1 | boolean | If this coding was chosen directly by the user
subject | SO | 1..1 | Reference(AU Core Patient) | Patient that is the subject of the communication request
Obligations | Actor | Source
SHALL:populate | AU eRequesting Placer | from AU eRequesting CommunicationRequest
SHALL:handle | AU eRequesting Filler | from AU eRequesting CommunicationRequest
SHALL:handle | AU eRequesting Server | from AU eRequesting CommunicationRequest
SHALL:able-to-populate | AU eRequesting Server | from AU eRequesting CommunicationRequest
SHALL:no-error | AU eRequesting Patient | from AU eRequesting CommunicationRequest
about | SO | 1..* | Reference(AU eRequesting Pathology Request | AU eRequesting Imaging Request) | Diagnostic request the copy-to communication is about
Obligations | Actor | Source
SHALL:populate | AU eRequesting Placer | from AU eRequesting CommunicationRequest
SHALL:handle | AU eRequesting Filler | from AU eRequesting CommunicationRequest
SHALL:handle | AU eRequesting Server | from AU eRequesting CommunicationRequest
SHALL:able-to-populate | AU eRequesting Server | from AU eRequesting CommunicationRequest
SHALL:no-error | AU eRequesting Patient | from AU eRequesting CommunicationRequest
authoredOn | SO Σ | 1..1 | dateTime | When request transitioned to being actionable
Obligations | Actor | Source
SHALL:populate | AU eRequesting Placer | from AU eRequesting CommunicationRequest
SHALL:handle | AU eRequesting Filler | from AU eRequesting CommunicationRequest
SHALL:handle | AU eRequesting Server | from AU eRequesting CommunicationRequest
SHALL:able-to-populate | AU eRequesting Server | from AU eRequesting CommunicationRequest
SHALL:no-error | AU eRequesting Patient | from AU eRequesting CommunicationRequest
requester | SO Σ | 1..1 | Reference(AU Core PractitionerRole) | Individual provider requesting the communication
Obligations | Actor | Source
SHALL:populate | AU eRequesting Placer | from AU eRequesting CommunicationRequest
SHALL:handle | AU eRequesting Filler | from AU eRequesting CommunicationRequest
SHALL:handle | AU eRequesting Server | from AU eRequesting CommunicationRequest
SHALL:able-to-populate | AU eRequesting Server | from AU eRequesting CommunicationRequest
SHALL:no-error | AU eRequesting Patient | from AU eRequesting CommunicationRequest
recipient | SO | 1..1 | Reference(AU Core PractitionerRole | AU Core Patient) | Individual provider or patient who is the intended recipient of the copy
Obligations | Actor | Source
SHALL:populate | AU eRequesting Placer | from AU eRequesting CommunicationRequest
SHALL:handle | AU eRequesting Filler | from AU eRequesting CommunicationRequest
SHALL:handle | AU eRequesting Server | from AU eRequesting CommunicationRequest
SHALL:able-to-populate | AU eRequesting Server | from AU eRequesting CommunicationRequest
SHALL:no-error | AU eRequesting Patient | from AU eRequesting CommunicationRequest
sender | SO Σ | 0..1 | Reference(AU Core Organization) | Organisation sending the communication
Obligations | Actor | Source
SHALL:populate-if-known | AU eRequesting Placer | from AU eRequesting CommunicationRequest
SHALL:handle | AU eRequesting Filler | from AU eRequesting CommunicationRequest
SHALL:handle | AU eRequesting Server | from AU eRequesting CommunicationRequest
SHALL:able-to-populate | AU eRequesting Server | from AU eRequesting CommunicationRequest
SHALL:no-error | AU eRequesting Patient | from AU eRequesting CommunicationRequest
reasonCode | SO Σ | 1..1 | CodeableConcept | Why is communication needed? Binding: AU eRequesting CommunicationRequest Reason (required)
Obligations | Actor | Source
SHALL:populate | AU eRequesting Placer | from AU eRequesting CommunicationRequest
SHALL:handle | AU eRequesting Filler | from AU eRequesting CommunicationRequest
SHALL:handle | AU eRequesting Server | from AU eRequesting CommunicationRequest
SHALL:able-to-populate | AU eRequesting Server | from AU eRequesting CommunicationRequest
SHALL:no-error | AU eRequesting Patient | from AU eRequesting CommunicationRequest
coding | Σ | 1..1 | Coding | Code defined by a terminology system Required Pattern: At least the following
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
system |  | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org.au/CodeSystem/communicationrequest-reason
version |  | 0..1 | string | Version of the system - if relevant
code |  | 1..1 | code | Symbol in syntax defined by the system Fixed Value: copyto
display |  | 0..1 | string | Representation defined by the system
userSelected |  | 0..1 | boolean | If this coding was chosen directly by the user
Documentation for this format

#### Terminology Bindings

Path | Status | Usage | ValueSet | Version | Source
CommunicationRequest.​groupIdentifier.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std.
CommunicationRequest.​groupIdentifier.type | Base | required | Order Identifier Type | 📦6.0.0-ci-build | AU Base Implementation Guide vnull
CommunicationRequest.​status | Base | required | RequestStatus | 📍4.0.1 | FHIR Std.
CommunicationRequest.​category | Base | example | CommunicationCategory | 📍4.0.1 | FHIR Std.
CommunicationRequest.​reasonCode | Base | required | AU eRequesting CommunicationRequest Reason | 📦1.0.0-ci-build | This IG

#### 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()`

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
CommunicationRequest |  | 0..* | AUeRequestingCommunicationRequest | A request for information to be sent to a receiver
id | Σ | 0..1 | id | Logical id of this artifact
meta | Σ | 0..1 | Meta | Metadata about the resource
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created
language |  | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
Additional Bindings | Purpose
AllLanguages | Max Binding
text |  | 0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements
contained |  | 0..* | Resource | Contained, inline Resources
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored
identifier | Σ | 0..* | Identifier | Unique identifier
basedOn | Σ | 0..* | Reference(Resource) | Fulfills plan or proposal
replaces | Σ | 0..* | Reference(CommunicationRequest) | Request(s) replaced by this request
groupIdentifier | SO Σ | 1..1 | AULocalOrderIdentifier | Composite request this is part of
Obligations | Actor | Source
SHALL:populate | AU eRequesting Placer | from AU eRequesting CommunicationRequest
SHALL:handle | AU eRequesting Filler | from AU eRequesting CommunicationRequest
SHALL:handle | AU eRequesting Server | from AU eRequesting CommunicationRequest
SHALL:able-to-populate | AU eRequesting Server | from AU eRequesting CommunicationRequest
SHALL:no-error | AU eRequesting Patient | from AU eRequesting CommunicationRequest
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type | Σ | 1..1 | CodeableConcept | Coded identifier type for local order identifier Binding: Order Identifier Type (required)
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
coding | Σ | 1..1 | Coding | Code defined by a terminology system Required Pattern: At least the following
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
system |  | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
version |  | 0..1 | string | Version of the system - if relevant
code |  | 1..1 | code | Symbol in syntax defined by the system Fixed Value: PGN
display |  | 0..1 | string | Representation defined by the system
userSelected |  | 0..1 | boolean | If this coding was chosen directly by the user
text | Σ | 0..1 | string | Plain text representation of the concept
system | Σ | 1..1 | uri | System identifier namespace for the organisation that assigned the order identifier Example General: http://www.acme.com/identifiers/patient
value | Σ | 1..1 | string | Order identifier Example General: 123456
period | Σ | 0..1 | Period | Time period when id is/was valid for use
assigner | Σ | 0..1 | Reference(Organization) | Organisation that assigned the order identifier
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 | 0..1 | string | Literal reference, Relative, internal or absolute URL
type | Σ | 0..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 | Σ | 1..1 | string | Name of the assigning organisation
status | ?!SO Σ | 1..1 | code | draft | active | on-hold | revoked | completed | entered-in-error | unknown Binding: RequestStatus (required): The status of the communication request. Fixed Value: active
Obligations | Actor | Source
SHALL:populate | AU eRequesting Placer | from AU eRequesting CommunicationRequest
SHALL:handle | AU eRequesting Filler | from AU eRequesting CommunicationRequest
SHALL:handle | AU eRequesting Server | from AU eRequesting CommunicationRequest
SHALL:able-to-populate | AU eRequesting Server | from AU eRequesting CommunicationRequest
SHALL:no-error | AU eRequesting Patient | from AU eRequesting CommunicationRequest
statusReason |  | 0..1 | CodeableConcept | Reason for current status Binding Description: (example): Codes identifying the reason for the current state of a request.
category | SO | 1..1 | CodeableConcept | Message category Binding: CommunicationCategory (example): Codes for general categories of communications such as alerts, instruction, etc.
Obligations | Actor | Source
SHALL:populate | AU eRequesting Placer | from AU eRequesting CommunicationRequest
SHALL:handle | AU eRequesting Filler | from AU eRequesting CommunicationRequest
SHALL:handle | AU eRequesting Server | from AU eRequesting CommunicationRequest
SHALL:able-to-populate | AU eRequesting Server | from AU eRequesting CommunicationRequest
SHALL:no-error | AU eRequesting Patient | from AU eRequesting CommunicationRequest
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
coding | Σ | 1..1 | Coding | Code defined by a terminology system Required Pattern: At least the following
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
system |  | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/communication-category
version |  | 0..1 | string | Version of the system - if relevant
code |  | 1..1 | code | Symbol in syntax defined by the system Fixed Value: notification
display |  | 0..1 | string | Representation defined by the system
userSelected |  | 0..1 | boolean | If this coding was chosen directly by the user
text | Σ | 0..1 | string | Plain text representation of the concept
priority | Σ | 0..1 | code | routine | urgent | asap | stat Binding: RequestPriority (required): Codes indicating the relative importance of a communication request.
medium |  | 0..* | CodeableConcept | A channel of communication Binding: ParticipationMode (example): Codes for communication mediums such as phone, fax, email, in person, etc.
subject | SO | 1..1 | Reference(AU Core Patient) | Patient that is the subject of the communication request
Obligations | Actor | Source
SHALL:populate | AU eRequesting Placer | from AU eRequesting CommunicationRequest
SHALL:handle | AU eRequesting Filler | from AU eRequesting CommunicationRequest
SHALL:handle | AU eRequesting Server | from AU eRequesting CommunicationRequest
SHALL:able-to-populate | AU eRequesting Server | from AU eRequesting CommunicationRequest
SHALL:no-error | AU eRequesting Patient | from AU eRequesting CommunicationRequest
about | SO | 1..* | Reference(AU eRequesting Pathology Request | AU eRequesting Imaging Request) | Diagnostic request the copy-to communication is about
Obligations | Actor | Source
SHALL:populate | AU eRequesting Placer | from AU eRequesting CommunicationRequest
SHALL:handle | AU eRequesting Filler | from AU eRequesting CommunicationRequest
SHALL:handle | AU eRequesting Server | from AU eRequesting CommunicationRequest
SHALL:able-to-populate | AU eRequesting Server | from AU eRequesting CommunicationRequest
SHALL:no-error | AU eRequesting Patient | from AU eRequesting CommunicationRequest
encounter | Σ | 0..1 | Reference(Encounter) | Encounter created as part of
payload |  | 0..* | BackboneElement | Message payload
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
contentString |  |  | string |
contentAttachment |  |  | Attachment |
contentReference |  |  | Reference(Resource) |
occurrence[x] | Σ | 0..1 |  | When scheduled
occurrenceDateTime |  |  | dateTime |
occurrencePeriod |  |  | Period |
authoredOn | SO Σ | 1..1 | dateTime | When request transitioned to being actionable
Obligations | Actor | Source
SHALL:populate | AU eRequesting Placer | from AU eRequesting CommunicationRequest
SHALL:handle | AU eRequesting Filler | from AU eRequesting CommunicationRequest
SHALL:handle | AU eRequesting Server | from AU eRequesting CommunicationRequest
SHALL:able-to-populate | AU eRequesting Server | from AU eRequesting CommunicationRequest
SHALL:no-error | AU eRequesting Patient | from AU eRequesting CommunicationRequest
requester | SO Σ | 1..1 | Reference(AU Core PractitionerRole) | Individual provider requesting the communication
Obligations | Actor | Source
SHALL:populate | AU eRequesting Placer | from AU eRequesting CommunicationRequest
SHALL:handle | AU eRequesting Filler | from AU eRequesting CommunicationRequest
SHALL:handle | AU eRequesting Server | from AU eRequesting CommunicationRequest
SHALL:able-to-populate | AU eRequesting Server | from AU eRequesting CommunicationRequest
SHALL:no-error | AU eRequesting Patient | from AU eRequesting CommunicationRequest
recipient | SO | 1..1 | Reference(AU Core PractitionerRole | AU Core Patient) | Individual provider or patient who is the intended recipient of the copy
Obligations | Actor | Source
SHALL:populate | AU eRequesting Placer | from AU eRequesting CommunicationRequest
SHALL:handle | AU eRequesting Filler | from AU eRequesting CommunicationRequest
SHALL:handle | AU eRequesting Server | from AU eRequesting CommunicationRequest
SHALL:able-to-populate | AU eRequesting Server | from AU eRequesting CommunicationRequest
SHALL:no-error | AU eRequesting Patient | from AU eRequesting CommunicationRequest
sender | SO Σ | 0..1 | Reference(AU Core Organization) | Organisation sending the communication
Obligations | Actor | Source
SHALL:populate-if-known | AU eRequesting Placer | from AU eRequesting CommunicationRequest
SHALL:handle | AU eRequesting Filler | from AU eRequesting CommunicationRequest
SHALL:handle | AU eRequesting Server | from AU eRequesting CommunicationRequest
SHALL:able-to-populate | AU eRequesting Server | from AU eRequesting CommunicationRequest
SHALL:no-error | AU eRequesting Patient | from AU eRequesting CommunicationRequest
reasonCode | SO Σ | 1..1 | CodeableConcept | Why is communication needed? Binding: AU eRequesting CommunicationRequest Reason (required)
Obligations | Actor | Source
SHALL:populate | AU eRequesting Placer | from AU eRequesting CommunicationRequest
SHALL:handle | AU eRequesting Filler | from AU eRequesting CommunicationRequest
SHALL:handle | AU eRequesting Server | from AU eRequesting CommunicationRequest
SHALL:able-to-populate | AU eRequesting Server | from AU eRequesting CommunicationRequest
SHALL:no-error | AU eRequesting Patient | from AU eRequesting CommunicationRequest
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
coding | Σ | 1..1 | Coding | Code defined by a terminology system Required Pattern: At least the following
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
system |  | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org.au/CodeSystem/communicationrequest-reason
version |  | 0..1 | string | Version of the system - if relevant
code |  | 1..1 | code | Symbol in syntax defined by the system Fixed Value: copyto
display |  | 0..1 | string | Representation defined by the system
userSelected |  | 0..1 | boolean | If this coding was chosen directly by the user
text | Σ | 0..1 | string | Plain text representation of the concept
reasonReference | Σ | 0..* | Reference(Condition | Observation | DiagnosticReport | DocumentReference) | Why is communication needed?
note |  | 0..* | Annotation | Comments made about communication request
Documentation for this format

#### Terminology Bindings

Path | Status | Usage | ValueSet | Version | Source
CommunicationRequest.​language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std.
CommunicationRequest.​groupIdentifier.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std.
CommunicationRequest.​groupIdentifier.type | Base | required | Order Identifier Type | 📦6.0.0-ci-build | AU Base Implementation Guide vnull
CommunicationRequest.​groupIdentifier.assigner.​type | Base | extensible | ResourceType | 📍4.0.1 | FHIR Std.
CommunicationRequest.​status | Base | required | RequestStatus | 📍4.0.1 | FHIR Std.
CommunicationRequest.​statusReason | Base | example |  | Not Stated | 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 v6.5
CommunicationRequest.​reasonCode | Base | required | AU eRequesting CommunicationRequest Reason | 📦1.0.0-ci-build | This IG

#### 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()`

This structure is derived from AUeRequestingCommunicationRequest

Summary

Mandatory: 2 elements
Prohibited: 1 element

Structures

This structure refers to these other structures:

- AU eRequesting Pathology Request (http://hl7.org.au/fhir/ereq/StructureDefinition/au-erequesting-servicerequest-path)
- AU eRequesting Imaging Request (http://hl7.org.au/fhir/ereq/StructureDefinition/au-erequesting-servicerequest-imag)
- AU Core PractitionerRole (http://hl7.org.au/fhir/core/StructureDefinition/au-core-practitionerrole)

Maturity: 1

Differential View

This structure is derived from AUeRequestingCommunicationRequest

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
CommunicationRequest |  | 0..* | AUeRequestingCommunicationRequest | A request for information to be sent to a receiver
category |  | 1..1 | CodeableConcept | Message category
coding |  | 1..1 | Coding | Code defined by a terminology system Required Pattern: At least the following
system |  | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/communication-category
code |  | 1..1 | code | Symbol in syntax defined by the system Fixed Value: notification
doNotPerform |  | 0..0 |  |
about |  | 1..* | Reference(AU eRequesting Pathology Request | AU eRequesting Imaging Request) | Diagnostic request the copy-to communication is about
requester |  | 1..1 | Reference(AU Core PractitionerRole) | Individual provider requesting the communication
recipient |  | 1..1 | Reference(AU Core PractitionerRole | AU Core Patient) | Individual provider or patient who is the intended recipient of the copy
reasonCode |  |  |  |
coding |  | 1..1 | Coding | Code defined by a terminology system Required Pattern: At least the following
system |  | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org.au/CodeSystem/communicationrequest-reason
code |  | 1..1 | code | Symbol in syntax defined by the system Fixed Value: copyto
Documentation for this format

Key Elements View

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
CommunicationRequest |  | 0..* | AUeRequestingCommunicationRequest | A request for information to be sent to a receiver
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored
groupIdentifier | SO Σ | 1..1 | AULocalOrderIdentifier | Composite request this is part of
Obligations | Actor | Source
SHALL:populate | AU eRequesting Placer | from AU eRequesting CommunicationRequest
SHALL:handle | AU eRequesting Filler | from AU eRequesting CommunicationRequest
SHALL:handle | AU eRequesting Server | from AU eRequesting CommunicationRequest
SHALL:able-to-populate | AU eRequesting Server | from AU eRequesting CommunicationRequest
SHALL:no-error | AU eRequesting Patient | from AU eRequesting CommunicationRequest
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type | Σ | 1..1 | CodeableConcept | Coded identifier type for local order identifier Binding: Order Identifier Type (required)
coding | Σ | 1..1 | Coding | Code defined by a terminology system Required Pattern: At least the following
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
system |  | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
version |  | 0..1 | string | Version of the system - if relevant
code |  | 1..1 | code | Symbol in syntax defined by the system Fixed Value: PGN
display |  | 0..1 | string | Representation defined by the system
userSelected |  | 0..1 | boolean | If this coding was chosen directly by the user
system | Σ | 1..1 | uri | System identifier namespace for the organisation that assigned the order identifier Example General: http://www.acme.com/identifiers/patient
value | Σ | 1..1 | string | Order identifier Example General: 123456
status | ?!SO Σ | 1..1 | code | draft | active | on-hold | revoked | completed | entered-in-error | unknown Binding: RequestStatus (required): The status of the communication request. Fixed Value: active
Obligations | Actor | Source
SHALL:populate | AU eRequesting Placer | from AU eRequesting CommunicationRequest
SHALL:handle | AU eRequesting Filler | from AU eRequesting CommunicationRequest
SHALL:handle | AU eRequesting Server | from AU eRequesting CommunicationRequest
SHALL:able-to-populate | AU eRequesting Server | from AU eRequesting CommunicationRequest
SHALL:no-error | AU eRequesting Patient | from AU eRequesting CommunicationRequest
category | SO | 1..1 | CodeableConcept | Message category Binding: CommunicationCategory (example): Codes for general categories of communications such as alerts, instruction, etc.
Obligations | Actor | Source
SHALL:populate | AU eRequesting Placer | from AU eRequesting CommunicationRequest
SHALL:handle | AU eRequesting Filler | from AU eRequesting CommunicationRequest
SHALL:handle | AU eRequesting Server | from AU eRequesting CommunicationRequest
SHALL:able-to-populate | AU eRequesting Server | from AU eRequesting CommunicationRequest
SHALL:no-error | AU eRequesting Patient | from AU eRequesting CommunicationRequest
coding | Σ | 1..1 | Coding | Code defined by a terminology system Required Pattern: At least the following
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
system |  | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/communication-category
version |  | 0..1 | string | Version of the system - if relevant
code |  | 1..1 | code | Symbol in syntax defined by the system Fixed Value: notification
display |  | 0..1 | string | Representation defined by the system
userSelected |  | 0..1 | boolean | If this coding was chosen directly by the user
subject | SO | 1..1 | Reference(AU Core Patient) | Patient that is the subject of the communication request
Obligations | Actor | Source
SHALL:populate | AU eRequesting Placer | from AU eRequesting CommunicationRequest
SHALL:handle | AU eRequesting Filler | from AU eRequesting CommunicationRequest
SHALL:handle | AU eRequesting Server | from AU eRequesting CommunicationRequest
SHALL:able-to-populate | AU eRequesting Server | from AU eRequesting CommunicationRequest
SHALL:no-error | AU eRequesting Patient | from AU eRequesting CommunicationRequest
about | SO | 1..* | Reference(AU eRequesting Pathology Request | AU eRequesting Imaging Request) | Diagnostic request the copy-to communication is about
Obligations | Actor | Source
SHALL:populate | AU eRequesting Placer | from AU eRequesting CommunicationRequest
SHALL:handle | AU eRequesting Filler | from AU eRequesting CommunicationRequest
SHALL:handle | AU eRequesting Server | from AU eRequesting CommunicationRequest
SHALL:able-to-populate | AU eRequesting Server | from AU eRequesting CommunicationRequest
SHALL:no-error | AU eRequesting Patient | from AU eRequesting CommunicationRequest
authoredOn | SO Σ | 1..1 | dateTime | When request transitioned to being actionable
Obligations | Actor | Source
SHALL:populate | AU eRequesting Placer | from AU eRequesting CommunicationRequest
SHALL:handle | AU eRequesting Filler | from AU eRequesting CommunicationRequest
SHALL:handle | AU eRequesting Server | from AU eRequesting CommunicationRequest
SHALL:able-to-populate | AU eRequesting Server | from AU eRequesting CommunicationRequest
SHALL:no-error | AU eRequesting Patient | from AU eRequesting CommunicationRequest
requester | SO Σ | 1..1 | Reference(AU Core PractitionerRole) | Individual provider requesting the communication
Obligations | Actor | Source
SHALL:populate | AU eRequesting Placer | from AU eRequesting CommunicationRequest
SHALL:handle | AU eRequesting Filler | from AU eRequesting CommunicationRequest
SHALL:handle | AU eRequesting Server | from AU eRequesting CommunicationRequest
SHALL:able-to-populate | AU eRequesting Server | from AU eRequesting CommunicationRequest
SHALL:no-error | AU eRequesting Patient | from AU eRequesting CommunicationRequest
recipient | SO | 1..1 | Reference(AU Core PractitionerRole | AU Core Patient) | Individual provider or patient who is the intended recipient of the copy
Obligations | Actor | Source
SHALL:populate | AU eRequesting Placer | from AU eRequesting CommunicationRequest
SHALL:handle | AU eRequesting Filler | from AU eRequesting CommunicationRequest
SHALL:handle | AU eRequesting Server | from AU eRequesting CommunicationRequest
SHALL:able-to-populate | AU eRequesting Server | from AU eRequesting CommunicationRequest
SHALL:no-error | AU eRequesting Patient | from AU eRequesting CommunicationRequest
sender | SO Σ | 0..1 | Reference(AU Core Organization) | Organisation sending the communication
Obligations | Actor | Source
SHALL:populate-if-known | AU eRequesting Placer | from AU eRequesting CommunicationRequest
SHALL:handle | AU eRequesting Filler | from AU eRequesting CommunicationRequest
SHALL:handle | AU eRequesting Server | from AU eRequesting CommunicationRequest
SHALL:able-to-populate | AU eRequesting Server | from AU eRequesting CommunicationRequest
SHALL:no-error | AU eRequesting Patient | from AU eRequesting CommunicationRequest
reasonCode | SO Σ | 1..1 | CodeableConcept | Why is communication needed? Binding: AU eRequesting CommunicationRequest Reason (required)
Obligations | Actor | Source
SHALL:populate | AU eRequesting Placer | from AU eRequesting CommunicationRequest
SHALL:handle | AU eRequesting Filler | from AU eRequesting CommunicationRequest
SHALL:handle | AU eRequesting Server | from AU eRequesting CommunicationRequest
SHALL:able-to-populate | AU eRequesting Server | from AU eRequesting CommunicationRequest
SHALL:no-error | AU eRequesting Patient | from AU eRequesting CommunicationRequest
coding | Σ | 1..1 | Coding | Code defined by a terminology system Required Pattern: At least the following
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
system |  | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org.au/CodeSystem/communicationrequest-reason
version |  | 0..1 | string | Version of the system - if relevant
code |  | 1..1 | code | Symbol in syntax defined by the system Fixed Value: copyto
display |  | 0..1 | string | Representation defined by the system
userSelected |  | 0..1 | boolean | If this coding was chosen directly by the user
Documentation for this format

#### Terminology Bindings

Path | Status | Usage | ValueSet | Version | Source
CommunicationRequest.​groupIdentifier.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std.
CommunicationRequest.​groupIdentifier.type | Base | required | Order Identifier Type | 📦6.0.0-ci-build | AU Base Implementation Guide vnull
CommunicationRequest.​status | Base | required | RequestStatus | 📍4.0.1 | FHIR Std.
CommunicationRequest.​category | Base | example | CommunicationCategory | 📍4.0.1 | FHIR Std.
CommunicationRequest.​reasonCode | Base | required | AU eRequesting CommunicationRequest Reason | 📦1.0.0-ci-build | This IG

#### 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()`

Snapshot View

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
CommunicationRequest |  | 0..* | AUeRequestingCommunicationRequest | A request for information to be sent to a receiver
id | Σ | 0..1 | id | Logical id of this artifact
meta | Σ | 0..1 | Meta | Metadata about the resource
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created
language |  | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
Additional Bindings | Purpose
AllLanguages | Max Binding
text |  | 0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements
contained |  | 0..* | Resource | Contained, inline Resources
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored
identifier | Σ | 0..* | Identifier | Unique identifier
basedOn | Σ | 0..* | Reference(Resource) | Fulfills plan or proposal
replaces | Σ | 0..* | Reference(CommunicationRequest) | Request(s) replaced by this request
groupIdentifier | SO Σ | 1..1 | AULocalOrderIdentifier | Composite request this is part of
Obligations | Actor | Source
SHALL:populate | AU eRequesting Placer | from AU eRequesting CommunicationRequest
SHALL:handle | AU eRequesting Filler | from AU eRequesting CommunicationRequest
SHALL:handle | AU eRequesting Server | from AU eRequesting CommunicationRequest
SHALL:able-to-populate | AU eRequesting Server | from AU eRequesting CommunicationRequest
SHALL:no-error | AU eRequesting Patient | from AU eRequesting CommunicationRequest
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type | Σ | 1..1 | CodeableConcept | Coded identifier type for local order identifier Binding: Order Identifier Type (required)
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
coding | Σ | 1..1 | Coding | Code defined by a terminology system Required Pattern: At least the following
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
system |  | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
version |  | 0..1 | string | Version of the system - if relevant
code |  | 1..1 | code | Symbol in syntax defined by the system Fixed Value: PGN
display |  | 0..1 | string | Representation defined by the system
userSelected |  | 0..1 | boolean | If this coding was chosen directly by the user
text | Σ | 0..1 | string | Plain text representation of the concept
system | Σ | 1..1 | uri | System identifier namespace for the organisation that assigned the order identifier Example General: http://www.acme.com/identifiers/patient
value | Σ | 1..1 | string | Order identifier Example General: 123456
period | Σ | 0..1 | Period | Time period when id is/was valid for use
assigner | Σ | 0..1 | Reference(Organization) | Organisation that assigned the order identifier
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 | 0..1 | string | Literal reference, Relative, internal or absolute URL
type | Σ | 0..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 | Σ | 1..1 | string | Name of the assigning organisation
status | ?!SO Σ | 1..1 | code | draft | active | on-hold | revoked | completed | entered-in-error | unknown Binding: RequestStatus (required): The status of the communication request. Fixed Value: active
Obligations | Actor | Source
SHALL:populate | AU eRequesting Placer | from AU eRequesting CommunicationRequest
SHALL:handle | AU eRequesting Filler | from AU eRequesting CommunicationRequest
SHALL:handle | AU eRequesting Server | from AU eRequesting CommunicationRequest
SHALL:able-to-populate | AU eRequesting Server | from AU eRequesting CommunicationRequest
SHALL:no-error | AU eRequesting Patient | from AU eRequesting CommunicationRequest
statusReason |  | 0..1 | CodeableConcept | Reason for current status Binding Description: (example): Codes identifying the reason for the current state of a request.
category | SO | 1..1 | CodeableConcept | Message category Binding: CommunicationCategory (example): Codes for general categories of communications such as alerts, instruction, etc.
Obligations | Actor | Source
SHALL:populate | AU eRequesting Placer | from AU eRequesting CommunicationRequest
SHALL:handle | AU eRequesting Filler | from AU eRequesting CommunicationRequest
SHALL:handle | AU eRequesting Server | from AU eRequesting CommunicationRequest
SHALL:able-to-populate | AU eRequesting Server | from AU eRequesting CommunicationRequest
SHALL:no-error | AU eRequesting Patient | from AU eRequesting CommunicationRequest
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
coding | Σ | 1..1 | Coding | Code defined by a terminology system Required Pattern: At least the following
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
system |  | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/communication-category
version |  | 0..1 | string | Version of the system - if relevant
code |  | 1..1 | code | Symbol in syntax defined by the system Fixed Value: notification
display |  | 0..1 | string | Representation defined by the system
userSelected |  | 0..1 | boolean | If this coding was chosen directly by the user
text | Σ | 0..1 | string | Plain text representation of the concept
priority | Σ | 0..1 | code | routine | urgent | asap | stat Binding: RequestPriority (required): Codes indicating the relative importance of a communication request.
medium |  | 0..* | CodeableConcept | A channel of communication Binding: ParticipationMode (example): Codes for communication mediums such as phone, fax, email, in person, etc.
subject | SO | 1..1 | Reference(AU Core Patient) | Patient that is the subject of the communication request
Obligations | Actor | Source
SHALL:populate | AU eRequesting Placer | from AU eRequesting CommunicationRequest
SHALL:handle | AU eRequesting Filler | from AU eRequesting CommunicationRequest
SHALL:handle | AU eRequesting Server | from AU eRequesting CommunicationRequest
SHALL:able-to-populate | AU eRequesting Server | from AU eRequesting CommunicationRequest
SHALL:no-error | AU eRequesting Patient | from AU eRequesting CommunicationRequest
about | SO | 1..* | Reference(AU eRequesting Pathology Request | AU eRequesting Imaging Request) | Diagnostic request the copy-to communication is about
Obligations | Actor | Source
SHALL:populate | AU eRequesting Placer | from AU eRequesting CommunicationRequest
SHALL:handle | AU eRequesting Filler | from AU eRequesting CommunicationRequest
SHALL:handle | AU eRequesting Server | from AU eRequesting CommunicationRequest
SHALL:able-to-populate | AU eRequesting Server | from AU eRequesting CommunicationRequest
SHALL:no-error | AU eRequesting Patient | from AU eRequesting CommunicationRequest
encounter | Σ | 0..1 | Reference(Encounter) | Encounter created as part of
payload |  | 0..* | BackboneElement | Message payload
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
contentString |  |  | string |
contentAttachment |  |  | Attachment |
contentReference |  |  | Reference(Resource) |
occurrence[x] | Σ | 0..1 |  | When scheduled
occurrenceDateTime |  |  | dateTime |
occurrencePeriod |  |  | Period |
authoredOn | SO Σ | 1..1 | dateTime | When request transitioned to being actionable
Obligations | Actor | Source
SHALL:populate | AU eRequesting Placer | from AU eRequesting CommunicationRequest
SHALL:handle | AU eRequesting Filler | from AU eRequesting CommunicationRequest
SHALL:handle | AU eRequesting Server | from AU eRequesting CommunicationRequest
SHALL:able-to-populate | AU eRequesting Server | from AU eRequesting CommunicationRequest
SHALL:no-error | AU eRequesting Patient | from AU eRequesting CommunicationRequest
requester | SO Σ | 1..1 | Reference(AU Core PractitionerRole) | Individual provider requesting the communication
Obligations | Actor | Source
SHALL:populate | AU eRequesting Placer | from AU eRequesting CommunicationRequest
SHALL:handle | AU eRequesting Filler | from AU eRequesting CommunicationRequest
SHALL:handle | AU eRequesting Server | from AU eRequesting CommunicationRequest
SHALL:able-to-populate | AU eRequesting Server | from AU eRequesting CommunicationRequest
SHALL:no-error | AU eRequesting Patient | from AU eRequesting CommunicationRequest
recipient | SO | 1..1 | Reference(AU Core PractitionerRole | AU Core Patient) | Individual provider or patient who is the intended recipient of the copy
Obligations | Actor | Source
SHALL:populate | AU eRequesting Placer | from AU eRequesting CommunicationRequest
SHALL:handle | AU eRequesting Filler | from AU eRequesting CommunicationRequest
SHALL:handle | AU eRequesting Server | from AU eRequesting CommunicationRequest
SHALL:able-to-populate | AU eRequesting Server | from AU eRequesting CommunicationRequest
SHALL:no-error | AU eRequesting Patient | from AU eRequesting CommunicationRequest
sender | SO Σ | 0..1 | Reference(AU Core Organization) | Organisation sending the communication
Obligations | Actor | Source
SHALL:populate-if-known | AU eRequesting Placer | from AU eRequesting CommunicationRequest
SHALL:handle | AU eRequesting Filler | from AU eRequesting CommunicationRequest
SHALL:handle | AU eRequesting Server | from AU eRequesting CommunicationRequest
SHALL:able-to-populate | AU eRequesting Server | from AU eRequesting CommunicationRequest
SHALL:no-error | AU eRequesting Patient | from AU eRequesting CommunicationRequest
reasonCode | SO Σ | 1..1 | CodeableConcept | Why is communication needed? Binding: AU eRequesting CommunicationRequest Reason (required)
Obligations | Actor | Source
SHALL:populate | AU eRequesting Placer | from AU eRequesting CommunicationRequest
SHALL:handle | AU eRequesting Filler | from AU eRequesting CommunicationRequest
SHALL:handle | AU eRequesting Server | from AU eRequesting CommunicationRequest
SHALL:able-to-populate | AU eRequesting Server | from AU eRequesting CommunicationRequest
SHALL:no-error | AU eRequesting Patient | from AU eRequesting CommunicationRequest
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
coding | Σ | 1..1 | Coding | Code defined by a terminology system Required Pattern: At least the following
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
system |  | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org.au/CodeSystem/communicationrequest-reason
version |  | 0..1 | string | Version of the system - if relevant
code |  | 1..1 | code | Symbol in syntax defined by the system Fixed Value: copyto
display |  | 0..1 | string | Representation defined by the system
userSelected |  | 0..1 | boolean | If this coding was chosen directly by the user
text | Σ | 0..1 | string | Plain text representation of the concept
reasonReference | Σ | 0..* | Reference(Condition | Observation | DiagnosticReport | DocumentReference) | Why is communication needed?
note |  | 0..* | Annotation | Comments made about communication request
Documentation for this format

#### Terminology Bindings

Path | Status | Usage | ValueSet | Version | Source
CommunicationRequest.​language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std.
CommunicationRequest.​groupIdentifier.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std.
CommunicationRequest.​groupIdentifier.type | Base | required | Order Identifier Type | 📦6.0.0-ci-build | AU Base Implementation Guide vnull
CommunicationRequest.​groupIdentifier.assigner.​type | Base | extensible | ResourceType | 📍4.0.1 | FHIR Std.
CommunicationRequest.​status | Base | required | RequestStatus | 📍4.0.1 | FHIR Std.
CommunicationRequest.​statusReason | Base | example |  | Not Stated | 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 v6.5
CommunicationRequest.​reasonCode | Base | required | AU eRequesting CommunicationRequest Reason | 📦1.0.0-ci-build | This IG

#### 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()`

This structure is derived from AUeRequestingCommunicationRequest

Summary

Mandatory: 2 elements
Prohibited: 1 element

Structures

This structure refers to these other structures:

- AU eRequesting Pathology Request (http://hl7.org.au/fhir/ereq/StructureDefinition/au-erequesting-servicerequest-path)
- AU eRequesting Imaging Request (http://hl7.org.au/fhir/ereq/StructureDefinition/au-erequesting-servicerequest-imag)
- AU Core PractitionerRole (http://hl7.org.au/fhir/core/StructureDefinition/au-core-practitionerrole)

Maturity: 1

Other representations of profile: CSV, Excel, Schematron

### Notes:

Below is an overview of the mandatory and optional search parameters and combined search parameters. See the AU eRequesting CapabilityStatements for a complete list of supported RESTful interactions for this IG.

FHIR search operations are described here and the syntax used to describe AU eRequesting interactions is defined here.

Any search parameter defined in FHIR may be ‘allowed’ by the system unless explicitly marked as “SHALL NOT”.

Parameter(s) | Server Conformance | Placer Conformance | Filler Conformance | Patient Conformance | Type(s) | Requirements (when used alone or in combination)
--- | --- | --- | --- | --- | --- | ---
_id | SHALL | MAY | MAY | MAY | `token` |

#### Search Parameters:

The following search parameters and search parameter combinations are supported. Conformance obligations are detailed in the table above.

1. `_id` search parameter

   `GET [base]/CommunicationRequest?_id=[id]`

   Example:

   1. GET [base]/CommunicationRequest?_id=2169591

   Implementation Notes: Fetches a bundle with the requested CommunicationRequest, instead of just the resource itself, and allows for the inclusion of additional search parameters such as _include, _revinclude, or _lastUpdated (how to search by id of the resource)