AU eRequesting Implementation Guide
0.3.0-ci-build - CI Build
AU eRequesting Implementation Guide
0.3.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 0.3.0-ci-build built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/mjosborne1/mjo-au-fhir-erequesting/ and changes regularly. See the Directory of published versions
| Official URL: http://hl7.org.au/fhir/ereq/StructureDefinition/au-erequesting-communicationrequest-patient | Version: 0.3.0-ci-build | |||
| Standards status: Draft | Maturity Level: 0 | Computable Name: AUeRequestingCommunicationRequestPatient | ||
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 direct communication from a diagnostic provider (Filler) to a patient. It supports use cases where the diagnostic provider may communicate with the patient, for example, to suggest booking an appointment or to provide instructions for a diagnostic test. It also supports requests for communication not to be performed, for example, when a patient has requested that they not be contacted by SMS. Supported communication mediums include SMS and email.
It is based on the AU eRequesting CommunicationRequest and identifies the additional constraints, extensions, vocabularies and value sets that SHALL be present in the CommunicationRequest when conforming to this profile.
Usages:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from AUeRequestingCommunicationRequest
| Name | Flags | Card. | Type | Description & Constraints Filter:   | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
  CommunicationRequest |
0..* | AUeRequestingCommunicationRequest | A request for information to be sent to a receiver | |||||||||||||
  category |
1..* | CodeableConcept | Message category Binding: AU eRequesting CommunicationRequest Patient Category (required) | |||||||||||||
  coding |
1..1 | Coding | Code defined by a terminology system | |||||||||||||
| doNotPerform |
SO | 0..1 | boolean | Set to true when SMS or email communication with the patient is not to be performed
| ||||||||||||
| medium |
SO | 1..* | CodeableConcept | A channel of communication Binding: AU eRequesting CommunicationRequest Patient Medium (required)
| ||||||||||||
| about |
1..* | Reference(AU eRequesting Pathology Request | AU eRequesting Imaging Request | AU eRequesting Task Group) | Fulfilment task group or diagnostic request the communication is about | |||||||||||||
| requester |
1..1 | Reference(AU Core PractitionerRole | AU Core Patient | AU Core Organization) | Patient, provider or practice requesting the communication (or requesting it not be performed) | |||||||||||||
 recipient |
1..1 | Reference(AU Core Patient) | Patient receiving the communication | |||||||||||||
| 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: patient | |||||||||||||
| Documentation for this format | ||||||||||||||||
| Path | Conformance | ValueSet | URI |
| CommunicationRequest.category | required | AUeRequestingCommunicationRequestPatientCategoryhttp://hl7.org.au/fhir/ereq/ValueSet/au-erequesting-communicationrequest-patientcategoryFrom this IG | |
| CommunicationRequest.medium | required | AUeRequestingCommunicationRequestPatientMediumhttp://hl7.org.au/fhir/ereq/ValueSet/au-erequesting-communicationrequest-patientmediumFrom this IG |
| Path | Conformance | ValueSet / Code | URI |
| CommunicationRequest.groupIdentifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1From the FHIR Standard | |
| CommunicationRequest.groupIdentifier.type | required | OrderIdentifierTypehttp://terminology.hl7.org.au/ValueSet/order-identifier-type | |
| CommunicationRequest.status | required | Fixed Value: activehttp://hl7.org/fhir/ValueSet/request-status|4.0.1From the FHIR Standard | |
| CommunicationRequest.category | required | AUeRequestingCommunicationRequestPatientCategoryhttp://hl7.org.au/fhir/ereq/ValueSet/au-erequesting-communicationrequest-patientcategoryFrom this IG | |
| CommunicationRequest.medium | required | AUeRequestingCommunicationRequestPatientMediumhttp://hl7.org.au/fhir/ereq/ValueSet/au-erequesting-communicationrequest-patientmediumFrom this IG | |
| CommunicationRequest.reasonCode | required | AUeRequestingCommunicationRequestReason(a valid code from CommunicationRequest Reason)http://hl7.org.au/fhir/ereq/ValueSet/au-erequesting-communicationrequest-reasonFrom this IG |
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | CommunicationRequest | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | CommunicationRequest | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
| dom-4 | error | CommunicationRequest | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
| dom-5 | error | CommunicationRequest | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | CommunicationRequest | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
| Name | Flags | Card. | Type | Description & Constraints Filter: | |||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| 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.
| ||||||||||||||||||
| text |
0..1 | Narrative | Text summary of the resource, for human interpretation | ||||||||||||||||||
| 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
| |||||||||||||||||
| 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
| |||||||||||||||||
| 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..* | CodeableConcept | Message category Binding: AU eRequesting CommunicationRequest Patient Category (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 | |||||||||||||||||
| 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. | |||||||||||||||||
| doNotPerform |
?!SOΣ | 0..1 | boolean | Set to true when SMS or email communication with the patient is not to be performed
| |||||||||||||||||
| medium |
SO | 1..* | CodeableConcept | A channel of communication Binding: AU eRequesting CommunicationRequest Patient Medium (required)
| |||||||||||||||||
| subject |
SO | 1..1 | Reference(AU Core Patient) | Patient that is the subject of the communication request
| |||||||||||||||||
| about |
SO | 1..* | Reference(AU eRequesting Pathology Request | AU eRequesting Imaging Request | AU eRequesting Task Group) | Fulfilment task group or diagnostic request the communication is about
| |||||||||||||||||
| 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 | Date/time communication request direction obtained
| |||||||||||||||||
| requester |
SOΣ | 1..1 | Reference(AU Core PractitionerRole | AU Core Patient | AU Core Organization) | Patient, provider or practice requesting the communication (or requesting it not be performed)
| |||||||||||||||||
| recipient |
SO | 1..1 | Reference(AU Core Patient) | Patient receiving the communication
| |||||||||||||||||
| sender |
SOΣ | 1..1 | Reference(AU Core Organization) | Organisation sending the communication
| |||||||||||||||||
| reasonCode |
SOΣ | 1..1 | CodeableConcept | Why is communication needed? Binding: AU eRequesting CommunicationRequest Reason (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.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: patient | ||||||||||||||||||
| 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 | |||||||||||||||||||||
| Path | Conformance | ValueSet / Code | URI | |||
| CommunicationRequest.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languagesFrom the FHIR Standard
| ||||
| CommunicationRequest.groupIdentifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1From the FHIR Standard | ||||
| CommunicationRequest.groupIdentifier.type | required | OrderIdentifierTypehttp://terminology.hl7.org.au/ValueSet/order-identifier-type | ||||
| CommunicationRequest.groupIdentifier.assigner.type | extensible | ResourceTypehttp://hl7.org/fhir/ValueSet/resource-typesFrom the FHIR Standard | ||||
| CommunicationRequest.status | required | Fixed Value: activehttp://hl7.org/fhir/ValueSet/request-status|4.0.1From the FHIR Standard | ||||
| CommunicationRequest.statusReason | example | |||||
| CommunicationRequest.category | required | AUeRequestingCommunicationRequestPatientCategoryhttp://hl7.org.au/fhir/ereq/ValueSet/au-erequesting-communicationrequest-patientcategoryFrom this IG | ||||
| CommunicationRequest.priority | required | RequestPriorityhttp://hl7.org/fhir/ValueSet/request-priority|4.0.1From the FHIR Standard | ||||
| CommunicationRequest.medium | required | AUeRequestingCommunicationRequestPatientMediumhttp://hl7.org.au/fhir/ereq/ValueSet/au-erequesting-communicationrequest-patientmediumFrom this IG | ||||
| CommunicationRequest.reasonCode | required | AUeRequestingCommunicationRequestReason(a valid code from CommunicationRequest Reason)http://hl7.org.au/fhir/ereq/ValueSet/au-erequesting-communicationrequest-reasonFrom this IG |
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | CommunicationRequest | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | CommunicationRequest | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
| dom-4 | error | CommunicationRequest | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
| dom-5 | error | CommunicationRequest | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | CommunicationRequest | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
This structure is derived from AUeRequestingCommunicationRequest
Summary
Mandatory: 3 elements
Must-Support: 2 elements
Structures
This structure refers to these other structures:
Maturity: 0
Differential View
This structure is derived from AUeRequestingCommunicationRequest
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| CommunicationRequest |
0..* | AUeRequestingCommunicationRequest | A request for information to be sent to a receiver | |||||||||||||
| category |
1..* | CodeableConcept | Message category Binding: AU eRequesting CommunicationRequest Patient Category (required) | |||||||||||||
| coding |
1..1 | Coding | Code defined by a terminology system | |||||||||||||
| doNotPerform |
SO | 0..1 | boolean | Set to true when SMS or email communication with the patient is not to be performed
| ||||||||||||
| medium |
SO | 1..* | CodeableConcept | A channel of communication Binding: AU eRequesting CommunicationRequest Patient Medium (required)
| ||||||||||||
| about |
1..* | Reference(AU eRequesting Pathology Request | AU eRequesting Imaging Request | AU eRequesting Task Group) | Fulfilment task group or diagnostic request the communication is about | |||||||||||||
| requester |
1..1 | Reference(AU Core PractitionerRole | AU Core Patient | AU Core Organization) | Patient, provider or practice requesting the communication (or requesting it not be performed) | |||||||||||||
| recipient |
1..1 | Reference(AU Core Patient) | Patient receiving the communication | |||||||||||||
| 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: patient | |||||||||||||
| Documentation for this format | ||||||||||||||||
| Path | Conformance | ValueSet | URI |
| CommunicationRequest.category | required | AUeRequestingCommunicationRequestPatientCategoryhttp://hl7.org.au/fhir/ereq/ValueSet/au-erequesting-communicationrequest-patientcategoryFrom this IG | |
| CommunicationRequest.medium | required | AUeRequestingCommunicationRequestPatientMediumhttp://hl7.org.au/fhir/ereq/ValueSet/au-erequesting-communicationrequest-patientmediumFrom this IG |
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: | |||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| 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
| |||||||||||||||||
| 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
| |||||||||||||||||
| category |
SO | 1..* | CodeableConcept | Message category Binding: AU eRequesting CommunicationRequest Patient Category (required)
| |||||||||||||||||
| coding |
Σ | 1..1 | Coding | Code defined by a terminology system | |||||||||||||||||
| doNotPerform |
?!SOΣ | 0..1 | boolean | Set to true when SMS or email communication with the patient is not to be performed
| |||||||||||||||||
| medium |
SO | 1..* | CodeableConcept | A channel of communication Binding: AU eRequesting CommunicationRequest Patient Medium (required)
| |||||||||||||||||
| subject |
SO | 1..1 | Reference(AU Core Patient) | Patient that is the subject of the communication request
| |||||||||||||||||
| about |
SO | 1..* | Reference(AU eRequesting Pathology Request | AU eRequesting Imaging Request | AU eRequesting Task Group) | Fulfilment task group or diagnostic request the communication is about
| |||||||||||||||||
| authoredOn |
SOΣ | 1..1 | dateTime | Date/time communication request direction obtained
| |||||||||||||||||
| requester |
SOΣ | 1..1 | Reference(AU Core PractitionerRole | AU Core Patient | AU Core Organization) | Patient, provider or practice requesting the communication (or requesting it not be performed)
| |||||||||||||||||
| recipient |
SO | 1..1 | Reference(AU Core Patient) | Patient receiving the communication
| |||||||||||||||||
| sender |
SOΣ | 1..1 | Reference(AU Core Organization) | Organisation sending the communication
| |||||||||||||||||
| reasonCode |
SOΣ | 1..1 | CodeableConcept | Why is communication needed? Binding: AU eRequesting CommunicationRequest Reason (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.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: patient | ||||||||||||||||||
| 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 | |||||||||||||||||||||
| Path | Conformance | ValueSet / Code | URI |
| CommunicationRequest.groupIdentifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1From the FHIR Standard | |
| CommunicationRequest.groupIdentifier.type | required | OrderIdentifierTypehttp://terminology.hl7.org.au/ValueSet/order-identifier-type | |
| CommunicationRequest.status | required | Fixed Value: activehttp://hl7.org/fhir/ValueSet/request-status|4.0.1From the FHIR Standard | |
| CommunicationRequest.category | required | AUeRequestingCommunicationRequestPatientCategoryhttp://hl7.org.au/fhir/ereq/ValueSet/au-erequesting-communicationrequest-patientcategoryFrom this IG | |
| CommunicationRequest.medium | required | AUeRequestingCommunicationRequestPatientMediumhttp://hl7.org.au/fhir/ereq/ValueSet/au-erequesting-communicationrequest-patientmediumFrom this IG | |
| CommunicationRequest.reasonCode | required | AUeRequestingCommunicationRequestReason(a valid code from CommunicationRequest Reason)http://hl7.org.au/fhir/ereq/ValueSet/au-erequesting-communicationrequest-reasonFrom this IG |
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | CommunicationRequest | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | CommunicationRequest | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
| dom-4 | error | CommunicationRequest | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
| dom-5 | error | CommunicationRequest | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | CommunicationRequest | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: | |||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| 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.
| ||||||||||||||||||
| text |
0..1 | Narrative | Text summary of the resource, for human interpretation | ||||||||||||||||||
| 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
| |||||||||||||||||
| 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
| |||||||||||||||||
| 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..* | CodeableConcept | Message category Binding: AU eRequesting CommunicationRequest Patient Category (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 | |||||||||||||||||
| 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. | |||||||||||||||||
| doNotPerform |
?!SOΣ | 0..1 | boolean | Set to true when SMS or email communication with the patient is not to be performed
| |||||||||||||||||
| medium |
SO | 1..* | CodeableConcept | A channel of communication Binding: AU eRequesting CommunicationRequest Patient Medium (required)
| |||||||||||||||||
| subject |
SO | 1..1 | Reference(AU Core Patient) | Patient that is the subject of the communication request
| |||||||||||||||||
| about |
SO | 1..* | Reference(AU eRequesting Pathology Request | AU eRequesting Imaging Request | AU eRequesting Task Group) | Fulfilment task group or diagnostic request the communication is about
| |||||||||||||||||
| 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 | Date/time communication request direction obtained
| |||||||||||||||||
| requester |
SOΣ | 1..1 | Reference(AU Core PractitionerRole | AU Core Patient | AU Core Organization) | Patient, provider or practice requesting the communication (or requesting it not be performed)
| |||||||||||||||||
| recipient |
SO | 1..1 | Reference(AU Core Patient) | Patient receiving the communication
| |||||||||||||||||
| sender |
SOΣ | 1..1 | Reference(AU Core Organization) | Organisation sending the communication
| |||||||||||||||||
| reasonCode |
SOΣ | 1..1 | CodeableConcept | Why is communication needed? Binding: AU eRequesting CommunicationRequest Reason (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.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: patient | ||||||||||||||||||
| 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 | |||||||||||||||||||||
| Path | Conformance | ValueSet / Code | URI | |||
| CommunicationRequest.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languagesFrom the FHIR Standard
| ||||
| CommunicationRequest.groupIdentifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1From the FHIR Standard | ||||
| CommunicationRequest.groupIdentifier.type | required | OrderIdentifierTypehttp://terminology.hl7.org.au/ValueSet/order-identifier-type | ||||
| CommunicationRequest.groupIdentifier.assigner.type | extensible | ResourceTypehttp://hl7.org/fhir/ValueSet/resource-typesFrom the FHIR Standard | ||||
| CommunicationRequest.status | required | Fixed Value: activehttp://hl7.org/fhir/ValueSet/request-status|4.0.1From the FHIR Standard | ||||
| CommunicationRequest.statusReason | example | |||||
| CommunicationRequest.category | required | AUeRequestingCommunicationRequestPatientCategoryhttp://hl7.org.au/fhir/ereq/ValueSet/au-erequesting-communicationrequest-patientcategoryFrom this IG | ||||
| CommunicationRequest.priority | required | RequestPriorityhttp://hl7.org/fhir/ValueSet/request-priority|4.0.1From the FHIR Standard | ||||
| CommunicationRequest.medium | required | AUeRequestingCommunicationRequestPatientMediumhttp://hl7.org.au/fhir/ereq/ValueSet/au-erequesting-communicationrequest-patientmediumFrom this IG | ||||
| CommunicationRequest.reasonCode | required | AUeRequestingCommunicationRequestReason(a valid code from CommunicationRequest Reason)http://hl7.org.au/fhir/ereq/ValueSet/au-erequesting-communicationrequest-reasonFrom this IG |
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | CommunicationRequest | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | CommunicationRequest | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
| dom-4 | error | CommunicationRequest | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
| dom-5 | error | CommunicationRequest | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | CommunicationRequest | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
This structure is derived from AUeRequestingCommunicationRequest
Summary
Mandatory: 3 elements
Must-Support: 2 elements
Structures
This structure refers to these other structures:
Maturity: 0
Other representations of profile: CSV, Excel, Schematron
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 |
The following search parameters and search parameter combinations are supported. Conformance obligations are detailed in the table above.
_id search parameter
GET [base]/CommunicationRequest?_id=[id]
Example:
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)
IG © 2024 HL7 Australia. Package hl7.fhir.au.ereq#0.3.0-ci-build based on FHIR 4.0.1. Generated 2025-06-11
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change