AU eRequesting Implementation Guide
0.3.0-preview - Preview
AU eRequesting Implementation Guide
0.3.0-preview - Preview
This page is part of the AU eRequesting (v0.3.0-preview: QA Preview) based on FHIR (HL7® FHIR® Standard) R4. No current official version has been published yet. For a full list of available versions, see the Directory of published versions
| Official URL: http://hl7.org.au/fhir/ereq/StructureDefinition/au-erequesting-communicationrequest-copyto | Version: 0.3.0-preview | |||
| Standards status: Draft | Maturity Level: 0 | 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 minimum expectations for a CommunicationRequest resource that is used to define a copy-to clinician or copy-to patient as a report recipient. This is differentiated from an urgent practitioner communication as priority may not be urgent and the requester will not be the recipient. It is based on the CommunicationRequest and identifies the additional constraints, extensions, vocabularies and value sets that SHALL be present in the CommunicationRequest when conforming to this profile.
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
| Name | Flags | Card. | Type | Description & Constraints | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
  CommunicationRequest |
0..* | CommunicationRequest | A request for information to be sent to a receiver dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management | |||||||||||||
  implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children | ||||||||||||
 modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | ||||||||||||
 groupIdentifier |
SOΣ | 1..1 | AULocalOrderIdentifier | Composite request this is part of ele-1: All FHIR elements must have a @value or children
| ||||||||||||
 use |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . ele-1: All FHIR elements must have a @value or children | ||||||||||||
| type |
Σ | 1..1 | CodeableConcept | Coded identifier type for local order identifier Binding: Order Identifier Type (required) ele-1: All FHIR elements must have a @value or children | ||||||||||||
 coding |
Σ | 1..1 | Coding | Code defined by a terminology system ele-1: All FHIR elements must have a @value or children Required Pattern: At least the following | ||||||||||||
  system |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203 | |||||||||||||
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: PGN | |||||||||||||
| system |
Σ | 1..1 | uri | System identifier namespace for the organisation that assigned the order identifier ele-1: All FHIR elements must have a @value or children Example General: http://www.acme.com/identifiers/patient | ||||||||||||
| value |
Σ | 1..1 | string | Order identifier ele-1: All FHIR elements must have a @value or children 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. ele-1: All FHIR elements must have a @value or children Fixed Value: active
| ||||||||||||
| category |
SO | 1..1 | CodeableConcept | Message category Binding: CommunicationCategory (example): Codes for general categories of communications such as alerts, instruction, etc. ele-1: All FHIR elements must have a @value or children
| ||||||||||||
| coding |
Σ | 1..1 | Coding | Code defined by a terminology system ele-1: All FHIR elements must have a @value or children 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 | |||||||||||||
 subject |
SO | 1..1 | Reference(AU Core Patient) | Patient that is the subject of the diagnostic request ele-1: All FHIR elements must have a @value or children
| ||||||||||||
| about |
SO | 1..* | Reference(AU eRequesting Pathology Request | AU eRequesting Imaging Request) | Diagnostic request the copy-to communication is about ele-1: All FHIR elements must have a @value or children
| ||||||||||||
| authoredOn |
SOΣ | 1..1 | dateTime | Date/time when communication request direction obtained ele-1: All FHIR elements must have a @value or children
| ||||||||||||
| requester |
SOΣ | 1..1 | Reference(AU Core PractitionerRole) | Individual provider requesting the communication ele-1: All FHIR elements must have a @value or children
| ||||||||||||
| recipient |
SO | 1..1 | Reference(AU Core PractitionerRole | AU Core Patient) | Individual provider or patient who is the intended recipient of the copy ele-1: All FHIR elements must have a @value or children
| ||||||||||||
| sender |
SOΣ | 1..1 | Reference(AU Core Organization) | Diagnostic organisation sending the communication ele-1: All FHIR elements must have a @value or children
| ||||||||||||
| reasonCode |
SOΣ | 1..1 | CodeableConcept | Why is communication needed? Binding: v3 Code System ActReason (example): Codes for describing reasons for the occurrence of a communication. ele-1: All FHIR elements must have a @value or children
| ||||||||||||
| coding |
Σ | 1..1 | Coding | Code defined by a terminology system ele-1: All FHIR elements must have a @value or children Required Pattern: At least the following | ||||||||||||
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org.au/fhir/ereq/CodeSystem/au-erequesting-communication-request-reason | |||||||||||||
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: copyto | |||||||||||||
| 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 | example | CommunicationCategoryhttp://hl7.org/fhir/ValueSet/communication-categoryfrom the FHIR Standard | |
| CommunicationRequest.reasonCode | example | ActReasonhttp://terminology.hl7.org/ValueSet/v3-ActReason |
This structure is derived from CommunicationRequest
| Name | Flags | Card. | Type | Description & Constraints | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| CommunicationRequest |
0..* | CommunicationRequest | A request for information to be sent to a receiver | |||||||||||||
| groupIdentifier |
SO | 1..1 | AULocalOrderIdentifier | Composite request this is part of
| ||||||||||||
 type |
||||||||||||||||
| 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/v2-0203 | |||||||||||||
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: PGN | |||||||||||||
| status |
SO | 1..1 | code | draft | active | on-hold | revoked | completed | entered-in-error | unknown Fixed Value: active
| ||||||||||||
| category |
SO | 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 | |||||||||||||||
| subject |
SO | 1..1 | Reference(AU Core Patient) | Patient that is the subject of the diagnostic request
| ||||||||||||
| about |
SO | 1..* | Reference(AU eRequesting Pathology Request | AU eRequesting Imaging Request) | Diagnostic request the copy-to communication is about
| ||||||||||||
| authoredOn |
SO | 1..1 | dateTime | Date/time when communication request direction obtained
| ||||||||||||
| requester |
SO | 1..1 | Reference(AU Core PractitionerRole) | Individual provider requesting the communication
| ||||||||||||
| recipient |
SO | 1..1 | Reference(AU Core PractitionerRole | AU Core Patient) | Individual provider or patient who is the intended recipient of the copy
| ||||||||||||
| sender |
SO | 1..1 | Reference(AU Core Organization) | Diagnostic organisation sending the communication
| ||||||||||||
| reasonCode |
SO | 1..1 | CodeableConcept | Why is communication needed?
| ||||||||||||
| 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://hl7.org.au/fhir/ereq/CodeSystem/au-erequesting-communication-request-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 | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| CommunicationRequest |
0..* | CommunicationRequest | 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 (No ValueSet): (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.
| ||||||||||||
| 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 diagnostic request
| ||||||||||||
| about |
SO | 1..* | Reference(AU eRequesting Pathology Request | AU eRequesting Imaging Request) | Diagnostic request the copy-to 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 when communication request direction obtained
| ||||||||||||
| requester |
SOΣ | 1..1 | Reference(AU Core PractitionerRole) | Individual provider requesting the communication
| ||||||||||||
| recipient |
SO | 1..1 | Reference(AU Core PractitionerRole | AU Core Patient) | Individual provider or patient who is the intended recipient of the copy
| ||||||||||||
| sender |
SOΣ | 1..1 | Reference(AU Core Organization) | Diagnostic organisation sending the communication
| ||||||||||||
| reasonCode |
SOΣ | 1..1 | CodeableConcept | Why is communication needed? Binding: v3 Code System ActReason (example): Codes for describing reasons for the occurrence of a communication.
| ||||||||||||
| 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://hl7.org.au/fhir/ereq/CodeSystem/au-erequesting-communication-request-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 | ||||||||||||||||
| 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 | example | CommunicationCategoryhttp://hl7.org/fhir/ValueSet/communication-categoryfrom the FHIR Standard | ||||
| CommunicationRequest.priority | required | RequestPriorityhttp://hl7.org/fhir/ValueSet/request-priority|4.0.1from the FHIR Standard | ||||
| CommunicationRequest.medium | example | ParticipationModehttp://terminology.hl7.org/ValueSet/v3-ParticipationMode | ||||
| CommunicationRequest.reasonCode | example | ActReasonhttp://terminology.hl7.org/ValueSet/v3-ActReason |
This structure is derived from CommunicationRequest
Summary
Mandatory: 12 elements
Must-Support: 10 elements
Fixed: 1 element
Prohibited: 1 element
Structures
This structure refers to these other structures:
Maturity: 0
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| CommunicationRequest |
0..* | CommunicationRequest | A request for information to be sent to a receiver dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management | |||||||||||||
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children | ||||||||||||
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | ||||||||||||
| groupIdentifier |
SOΣ | 1..1 | AULocalOrderIdentifier | Composite request this is part of ele-1: All FHIR elements must have a @value or children
| ||||||||||||
| use |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . ele-1: All FHIR elements must have a @value or children | ||||||||||||
| type |
Σ | 1..1 | CodeableConcept | Coded identifier type for local order identifier Binding: Order Identifier Type (required) ele-1: All FHIR elements must have a @value or children | ||||||||||||
| coding |
Σ | 1..1 | Coding | Code defined by a terminology system ele-1: All FHIR elements must have a @value or children Required Pattern: At least the following | ||||||||||||
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203 | |||||||||||||
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: PGN | |||||||||||||
| system |
Σ | 1..1 | uri | System identifier namespace for the organisation that assigned the order identifier ele-1: All FHIR elements must have a @value or children Example General: http://www.acme.com/identifiers/patient | ||||||||||||
| value |
Σ | 1..1 | string | Order identifier ele-1: All FHIR elements must have a @value or children 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. ele-1: All FHIR elements must have a @value or children Fixed Value: active
| ||||||||||||
| category |
SO | 1..1 | CodeableConcept | Message category Binding: CommunicationCategory (example): Codes for general categories of communications such as alerts, instruction, etc. ele-1: All FHIR elements must have a @value or children
| ||||||||||||
| coding |
Σ | 1..1 | Coding | Code defined by a terminology system ele-1: All FHIR elements must have a @value or children 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 | |||||||||||||
| subject |
SO | 1..1 | Reference(AU Core Patient) | Patient that is the subject of the diagnostic request ele-1: All FHIR elements must have a @value or children
| ||||||||||||
| about |
SO | 1..* | Reference(AU eRequesting Pathology Request | AU eRequesting Imaging Request) | Diagnostic request the copy-to communication is about ele-1: All FHIR elements must have a @value or children
| ||||||||||||
| authoredOn |
SOΣ | 1..1 | dateTime | Date/time when communication request direction obtained ele-1: All FHIR elements must have a @value or children
| ||||||||||||
| requester |
SOΣ | 1..1 | Reference(AU Core PractitionerRole) | Individual provider requesting the communication ele-1: All FHIR elements must have a @value or children
| ||||||||||||
| recipient |
SO | 1..1 | Reference(AU Core PractitionerRole | AU Core Patient) | Individual provider or patient who is the intended recipient of the copy ele-1: All FHIR elements must have a @value or children
| ||||||||||||
| sender |
SOΣ | 1..1 | Reference(AU Core Organization) | Diagnostic organisation sending the communication ele-1: All FHIR elements must have a @value or children
| ||||||||||||
| reasonCode |
SOΣ | 1..1 | CodeableConcept | Why is communication needed? Binding: v3 Code System ActReason (example): Codes for describing reasons for the occurrence of a communication. ele-1: All FHIR elements must have a @value or children
| ||||||||||||
| coding |
Σ | 1..1 | Coding | Code defined by a terminology system ele-1: All FHIR elements must have a @value or children Required Pattern: At least the following | ||||||||||||
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org.au/fhir/ereq/CodeSystem/au-erequesting-communication-request-reason | |||||||||||||
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: copyto | |||||||||||||
| 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 | example | CommunicationCategoryhttp://hl7.org/fhir/ValueSet/communication-categoryfrom the FHIR Standard | |
| CommunicationRequest.reasonCode | example | ActReasonhttp://terminology.hl7.org/ValueSet/v3-ActReason |
Differential View
This structure is derived from CommunicationRequest
| Name | Flags | Card. | Type | Description & Constraints | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| CommunicationRequest |
0..* | CommunicationRequest | A request for information to be sent to a receiver | |||||||||||||
| groupIdentifier |
SO | 1..1 | AULocalOrderIdentifier | Composite request this is part of
| ||||||||||||
| type |
||||||||||||||||
| 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/v2-0203 | |||||||||||||
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: PGN | |||||||||||||
| status |
SO | 1..1 | code | draft | active | on-hold | revoked | completed | entered-in-error | unknown Fixed Value: active
| ||||||||||||
| category |
SO | 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 | |||||||||||||||
| subject |
SO | 1..1 | Reference(AU Core Patient) | Patient that is the subject of the diagnostic request
| ||||||||||||
| about |
SO | 1..* | Reference(AU eRequesting Pathology Request | AU eRequesting Imaging Request) | Diagnostic request the copy-to communication is about
| ||||||||||||
| authoredOn |
SO | 1..1 | dateTime | Date/time when communication request direction obtained
| ||||||||||||
| requester |
SO | 1..1 | Reference(AU Core PractitionerRole) | Individual provider requesting the communication
| ||||||||||||
| recipient |
SO | 1..1 | Reference(AU Core PractitionerRole | AU Core Patient) | Individual provider or patient who is the intended recipient of the copy
| ||||||||||||
| sender |
SO | 1..1 | Reference(AU Core Organization) | Diagnostic organisation sending the communication
| ||||||||||||
| reasonCode |
SO | 1..1 | CodeableConcept | Why is communication needed?
| ||||||||||||
| 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://hl7.org.au/fhir/ereq/CodeSystem/au-erequesting-communication-request-reason | |||||||||||||
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: copyto | |||||||||||||
| Documentation for this format | ||||||||||||||||
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| CommunicationRequest |
0..* | CommunicationRequest | 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 (No ValueSet): (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.
| ||||||||||||
| 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 diagnostic request
| ||||||||||||
| about |
SO | 1..* | Reference(AU eRequesting Pathology Request | AU eRequesting Imaging Request) | Diagnostic request the copy-to 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 when communication request direction obtained
| ||||||||||||
| requester |
SOΣ | 1..1 | Reference(AU Core PractitionerRole) | Individual provider requesting the communication
| ||||||||||||
| recipient |
SO | 1..1 | Reference(AU Core PractitionerRole | AU Core Patient) | Individual provider or patient who is the intended recipient of the copy
| ||||||||||||
| sender |
SOΣ | 1..1 | Reference(AU Core Organization) | Diagnostic organisation sending the communication
| ||||||||||||
| reasonCode |
SOΣ | 1..1 | CodeableConcept | Why is communication needed? Binding: v3 Code System ActReason (example): Codes for describing reasons for the occurrence of a communication.
| ||||||||||||
| 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://hl7.org.au/fhir/ereq/CodeSystem/au-erequesting-communication-request-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 | ||||||||||||||||
| 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 | example | CommunicationCategoryhttp://hl7.org/fhir/ValueSet/communication-categoryfrom the FHIR Standard | ||||
| CommunicationRequest.priority | required | RequestPriorityhttp://hl7.org/fhir/ValueSet/request-priority|4.0.1from the FHIR Standard | ||||
| CommunicationRequest.medium | example | ParticipationModehttp://terminology.hl7.org/ValueSet/v3-ParticipationMode | ||||
| CommunicationRequest.reasonCode | example | ActReasonhttp://terminology.hl7.org/ValueSet/v3-ActReason |
This structure is derived from CommunicationRequest
Summary
Mandatory: 12 elements
Must-Support: 10 elements
Fixed: 1 element
Prohibited: 1 element
Structures
This structure refers to these other structures:
Maturity: 0
Other representations of profile: CSV, Excel, Schematron
IG © 2025 HL7 Australia. Package hl7.fhir.au.ereq#0.3.0-preview based on FHIR 4.0.1. Generated 2025-03-12
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change