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: AUeRequestingCommunicationRequestUrgentProvider - Detailed Descriptions

Page standards status: Draft | Maturity Level: 1

Definitions for the au-erequesting-communicationrequest-urgentprovider resource profile.

- Differential Elements Table
- Key Elements Table
- Snapshot Elements Table

Guidance on how to interpret the contents of this table can be foundhere

0. CommunicationRequest
2. CommunicationRequest.category
Control | 0..1
4. CommunicationRequest.category.coding
Control | 1..1
Pattern Value | `{ "system" : "http://terminology.hl7.org/CodeSystem/communication-category", "code" : "alert" }`
6. CommunicationRequest.priority
Control | 1..?
Must Support | true
Obligations |
Obligations | Actor
SHALL:populate | AU eRequesting Placer
SHALL:handle | AU eRequesting Filler
SHALL:handle | AU eRequesting Server
SHALL:able-to-populate | AU eRequesting Server
SHALL:no-error | AU eRequesting Patient
Fixed Value | `urgent`
8. CommunicationRequest.doNotPerform
Control | 0..0
10. CommunicationRequest.medium
Must Support | true
Obligations |
Obligations | Actor
SHALL:populate-if-known | AU eRequesting Placer
SHALL:handle | AU eRequesting Filler
SHALL:handle | AU eRequesting Server
SHALL:able-to-populate | AU eRequesting Server
SHALL:no-error | AU eRequesting Patient
12. CommunicationRequest.about
Short | Diagnostic request the urgent communication is about
Type | Reference(AU eRequesting Pathology Request, AU eRequesting Imaging Request)
14. CommunicationRequest.requester
Short | Individual provider requesting the communication
Type | Reference(AU Core PractitionerRole)
16. CommunicationRequest.recipient
Short | Individual provider receiving the communication
Type | Reference(AU Core PractitionerRole)
18. CommunicationRequest.reasonCode
20. CommunicationRequest.reasonCode.coding
Control | 1..1
Pattern Value | `{ "system" : "http://terminology.hl7.org.au/CodeSystem/communicationrequest-reason", "code" : "urgent" }`

Guidance on how to interpret the contents of this table can be foundhere

0. CommunicationRequest
Definition | A request to convey information; e.g. the CDS system proposes that an alert be sent to a responsible provider, the CDS system proposes that the public health agency be notified about a reportable condition.
Short | A request for information to be sent to a receiver
Control | 0..*
Is Modifier | false
Summary | false
Invariants | dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty()) 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 (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: 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: If a resource is contained in another resource, it SHALL NOT have a security label (contained.meta.security.empty()) dom-6: A resource should have narrative for robust management (text.`div`.exists())
2. CommunicationRequest.implicitRules
Definition | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
Short | A set of rules under which this content was created
Comments | Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.
Control | 0..1
Type | uri
Is Modifier | true because This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
4. CommunicationRequest.modifierExtension
Definition | May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Short | Extensions that cannot be ignored
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..*
Type | Extension
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them
Summary | false
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.
Alternate Names | extensions, user content
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
6. CommunicationRequest.groupIdentifier
Definition | A shared identifier common to all requests that were authorized more or less simultaneously by a single author, representing the identifier of the requisition, prescription or similar form.
Short | Composite request this is part of
Comments | Requests are linked either by a "basedOn" relationship (i.e. one request is fulfilling another) or by having a common requisition. Requests that are part of the same requisition are generally treated independently from the perspective of changing their state or maintaining them after initial creation.
Control | 10..1
Type | Identifier(AU Local Order Identifier)
Is Modifier | false
Must Support | true
Obligations |
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
Summary | true
Alternate Names | grouperId
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
8. CommunicationRequest.groupIdentifier.use
Definition | The purpose of this identifier.
Short | usual | official | temp | secondary | old (If known)
Comments | Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.
Control | 0..1
Binding | The codes SHALL be taken from IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 (required to `http://hl7.org/fhir/ValueSet/identifier-use|4.0.1` ) Identifies the purpose for this identifier, if known .
Type | code
Is Modifier | true because This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one.
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Requirements | Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
10. CommunicationRequest.groupIdentifier.type
Definition | A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.
Short | Coded identifier type for local order identifierDescription of identifier
Comments | This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.
Control | 10..1
Binding | The codes SHALL be taken from Unless not suitable, these codes SHALL be taken from Order Identifier Type http://hl7.org/fhir/ValueSet/identifier-type|4.0.1 (required to `http://terminology.hl7.org.au/ValueSet/order-identifier-type` )
Type | CodeableConcept
Is Modifier | false
Summary | true
Requirements | Allows users to make use of identifiers when the identifier system is not known.
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
12. CommunicationRequest.groupIdentifier.type.coding
Definition | A reference to a code defined by a terminology system.
Short | Code defined by a terminology system
Comments | Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.
Control | 10..1*
Type | Coding
Is Modifier | false
Summary | true
Requirements | Allows for alternative encodings within a code system, and translations to other code systems.
Pattern Value | `{ "system" : "http://terminology.hl7.org/CodeSystem/v2-0203", "code" : "PGN" }`
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
14. CommunicationRequest.groupIdentifier.system
Definition | Establishes the namespace for the value - that is, a URL that describes a set values that are unique.
Short | System identifier namespace for the organisation that assigned the order identifierThe namespace for the identifier value
Comments | Identifier.system is always case sensitive.
Control | 10..1
Type | uri
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Requirements | There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.
Example | General: http://www.acme.com/identifiers/patient
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
16. CommunicationRequest.groupIdentifier.value
Definition | The portion of the identifier typically relevant to the user and which is unique within the context of the system.
Short | Order identifierThe value that is unique
Comments | If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.
Control | 10..1
Type | string
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Example | General: 123456
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
18. CommunicationRequest.status
Definition | The status of the proposal or order.
Short | draft | active | on-hold | revoked | completed | entered-in-error | unknown
Control | 1..1
Binding | The codes SHALL be taken from RequestStatus http://hl7.org/fhir/ValueSet/request-status|4.0.1 (required to `http://hl7.org/fhir/ValueSet/request-status|4.0.1` ) The status of the communication request.
Type | code
Is Modifier | true because This element is labelled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid.
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Obligations |
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
Summary | true
Fixed Value | `active`
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
20. CommunicationRequest.category
Definition | The type of message to be sent such as alert, notification, reminder, instruction, etc.
Short | Message category
Comments | There may be multiple axes of categorization and one communication request may serve multiple purposes.
Control | 10..1*
Binding | For example codes, see CommunicationCategory http://hl7.org/fhir/ValueSet/communication-category|4.0.1 (example to `http://hl7.org/fhir/ValueSet/communication-category|4.0.1` ) Codes for general categories of communications such as alerts, instruction, etc.
Type | CodeableConcept
Is Modifier | false
Must Support | true
Obligations |
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
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
22. CommunicationRequest.category.coding
Definition | A reference to a code defined by a terminology system.
Short | Code defined by a terminology system
Comments | Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.
Control | 10..1*
Type | Coding
Is Modifier | false
Summary | true
Requirements | Allows for alternative encodings within a code system, and translations to other code systems.
Pattern Value | `{ "system" : "http://terminology.hl7.org/CodeSystem/communication-category", "code" : "alert" }`
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
24. CommunicationRequest.priority
Definition | Characterizes how quickly the proposed act must be initiated. Includes concepts such as stat, urgent, routine.
Short | routine | urgent | asap | stat
Control | 10..1
Binding | The codes SHALL be taken from RequestPriority http://hl7.org/fhir/ValueSet/request-priority|4.0.1 (required to `http://hl7.org/fhir/ValueSet/request-priority|4.0.1` ) Codes indicating the relative importance of a communication request.
Type | code
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Obligations |
Obligations | Actor
SHALL:populate | AU eRequesting Placer
SHALL:handle | AU eRequesting Filler
SHALL:handle | AU eRequesting Server
SHALL:able-to-populate | AU eRequesting Server
SHALL:no-error | AU eRequesting Patient
Summary | true
Meaning if Missing | If missing, this task should be performed with normal priority
Fixed Value | `urgent`
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
26. CommunicationRequest.doNotPerform
Definition | If true indicates that the CommunicationRequest is asking for the specified action to not occur.
Short | True if request is prohibiting action
Comments | The attributes provided with the request qualify what is not to be done.
Control | 0..01
Type | boolean
Is Modifier | true because If true this element negates the specified action. For Example, instead of a request for a communication, it is a request for the communication to not occur.
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Alternate Names | prohibited
Meaning if Missing | If do not perform is not specified, the request is a positive request e.g. "do perform"
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
28. CommunicationRequest.medium
Definition | A channel that was used for this communication (e.g. email, fax).
Short | A channel of communication
Control | 0..*
Binding | For example codes, see ParticipationMode http://terminology.hl7.org/ValueSet/v3-ParticipationMode (example to `http://terminology.hl7.org/ValueSet/v3-ParticipationMode` ) Codes for communication mediums such as phone, fax, email, in person, etc.
Type | CodeableConcept
Is Modifier | false
Must Support | true
Obligations |
Obligations | Actor
SHALL:populate-if-known | AU eRequesting Placer
SHALL:handle | AU eRequesting Filler
SHALL:handle | AU eRequesting Server
SHALL:able-to-populate | AU eRequesting Server
SHALL:no-error | AU eRequesting Patient
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
30. CommunicationRequest.subject
Definition | The patient or group that is the focus of this communication request.
Short | Patient that is the subject of the communication requestFocus of message
Control | 10..1
Type | Reference(AU Core Patient, Patient, Group)
Is Modifier | false
Must Support | true
Obligations |
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
Summary | false
Alternate Names | patient
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
32. CommunicationRequest.about
Definition | Other resources that pertain to this communication request and to which this communication request should be associated.
Short | Diagnostic request the urgent communication is aboutResources that pertain to this communication request
Comments | Don't use CommunicationRequest.about element when a more specific element exists, such as basedOn, reasonReference, or replaces.
Control | 10..*
Type | Reference(AU eRequesting Pathology Request, AU eRequesting Imaging Request, Resource)
Is Modifier | false
Must Support | true
Must Support Types | No must-support rules about the choice of types/profiles
Obligations |
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
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
34. CommunicationRequest.authoredOn
Definition | For draft requests, indicates the date of initial creation. For requests with other statuses, indicates the date of activation.
Short | When request transitioned to being actionable
Control | 10..1
Type | dateTime
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Obligations |
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
Summary | true
Alternate Names | createdOn
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
36. CommunicationRequest.requester
Definition | The device, individual, or organization who initiated the request and has responsibility for its activation.
Short | Individual provider requesting the communicationWho/what is requesting service
Control | 10..1
Type | Reference(AU Core PractitionerRole, Practitioner, PractitionerRole, Organization, Patient, RelatedPerson, Device)
Is Modifier | false
Must Support | true
Obligations |
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
Summary | true
Alternate Names | author
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
38. CommunicationRequest.recipient
Definition | The entity (e.g. person, organization, clinical information system, device, group, or care team) which is the intended target of the communication.
Short | Individual provider receiving the communicationMessage recipient
Control | 10..1*
Type | Reference(AU Core PractitionerRole, Device, Organization, Patient, Practitioner, PractitionerRole, RelatedPerson, Group, CareTeam, HealthcareService)
Is Modifier | false
Must Support | true
Obligations |
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
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
40. CommunicationRequest.sender
Definition | The entity (e.g. person, organization, clinical information system, or device) which is to be the source of the communication.
Short | Organisation sending the communicationMessage sender
Control | 0..1
Type | Reference(AU Core Organization, Device, Organization, Patient, Practitioner, PractitionerRole, RelatedPerson, HealthcareService)
Is Modifier | false
Must Support | true
Obligations |
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
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
42. CommunicationRequest.reasonCode
Definition | Describes why the request is being made in coded or textual form.
Short | Why is communication needed?
Comments | Textual reasons can be captured using reasonCode.text.
Control | 10..1*
Binding | The codes SHALL be taken from For example codes, see AU eRequesting CommunicationRequest Reason http://terminology.hl7.org/ValueSet/v3-ActReason (required to `http://hl7.org.au/fhir/ereq/ValueSet/au-erequesting-communicationrequest-reason` )
Type | CodeableConcept
Is Modifier | false
Must Support | true
Obligations |
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
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
44. CommunicationRequest.reasonCode.coding
Definition | A reference to a code defined by a terminology system.
Short | Code defined by a terminology system
Comments | Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.
Control | 10..1*
Type | Coding
Is Modifier | false
Summary | true
Requirements | Allows for alternative encodings within a code system, and translations to other code systems.
Pattern Value | `{ "system" : "http://terminology.hl7.org.au/CodeSystem/communicationrequest-reason", "code" : "urgent" }`
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

Guidance on how to interpret the contents of this table can be foundhere

0. CommunicationRequest
Definition | A request to convey information; e.g. the CDS system proposes that an alert be sent to a responsible provider, the CDS system proposes that the public health agency be notified about a reportable condition.
Short | A request for information to be sent to a receiver
Control | 0..*
Is Modifier | false
Summary | false
Invariants | dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (`contained.contained.empty()`) 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 (`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: 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: If a resource is contained in another resource, it SHALL NOT have a security label (`contained.meta.security.empty()`) dom-6: A resource should have narrative for robust management (`text.`div`.exists()`)
2. CommunicationRequest.id
Definition | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
Short | Logical id of this artifact
Comments | The only time that a resource does not have an id is when it is being submitted to the server using a create operation.
Control | 0..1
Type | id
Is Modifier | false
Summary | true
4. CommunicationRequest.meta
Definition | The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
Short | Metadata about the resource
Control | 0..1
Type | Meta
Is Modifier | false
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
6. CommunicationRequest.implicitRules
Definition | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
Short | A set of rules under which this content was created
Comments | Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.
Control | 0..1
Type | uri
Is Modifier | true because This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
8. CommunicationRequest.language
Definition | The base language in which the resource is written.
Short | Language of the resource content
Comments | Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).
Control | 0..1
Binding | The codes SHOULD be taken from CommonLanguages (preferred to `http://hl7.org/fhir/ValueSet/languages|4.0.1` ) A human language.
Additional Bindings | Purpose
AllLanguages | Max Binding
Type | code
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
10. CommunicationRequest.text
Definition | A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
Short | Text summary of the resource, for human interpretation
Comments | Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.
Control | 0..1
Type | Narrative
Is Modifier | false
Summary | false
Alternate Names | narrative, html, xhtml, display
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
12. CommunicationRequest.contained
Definition | These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
Short | Contained, inline Resources
Comments | This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.
Control | 0..*
Type | Resource
Is Modifier | false
Summary | false
Alternate Names | inline resources, anonymous resources, contained resources
14. CommunicationRequest.extension
Definition | May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Short | Additional content defined by implementations
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..*
Type | Extension
Is Modifier | false
Summary | false
Alternate Names | extensions, user content
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
16. CommunicationRequest.modifierExtension
Definition | May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Short | Extensions that cannot be ignored
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..*
Type | Extension
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them
Summary | false
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.
Alternate Names | extensions, user content
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
18. CommunicationRequest.identifier
Definition | Business identifiers assigned to this communication request by the performer or other systems which remain constant as the resource is updated and propagates from server to server.
Short | Unique identifier
Comments | This is a business identifier, not a resource identifier (see discussion). It is best practice for the identifier to only appear on a single resource instance, however business practices may occasionally dictate that multiple resource instances with the same identifier can exist - possibly even with different resource types. For example, multiple Patient and a Person resource instance might share the same social insurance number.
Note | This is a business identifier, not a resource identifier (see discussion)
Control | 0..*
Type | Identifier
Is Modifier | false
Summary | true
Requirements | Allows identification of the communication request as it is known by various participating systems and in a way that remains consistent across servers.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
20. CommunicationRequest.basedOn
Definition | A plan or proposal that is fulfilled in whole or in part by this request.
Short | Fulfills plan or proposal
Control | 0..*
Type | Reference(Resource)
Is Modifier | false
Summary | true
Requirements | Allows tracing of authorization for the request and tracking whether proposals/recommendations were acted upon.
Alternate Names | fulfills
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
22. CommunicationRequest.replaces
Definition | Completed or terminated request(s) whose function is taken by this new request.
Short | Request(s) replaced by this request
Comments | The replacement could be because the initial request was immediately rejected (due to an issue) or because the previous request was completed, but the need for the action described by the request remains ongoing.
Control | 0..*
Type | Reference(CommunicationRequest)
Is Modifier | false
Summary | true
Requirements | Allows tracing the continuation of a therapy or administrative process instantiated through multiple requests.
Alternate Names | supersedes, prior
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
24. CommunicationRequest.groupIdentifier
Definition | A shared identifier common to all requests that were authorized more or less simultaneously by a single author, representing the identifier of the requisition, prescription or similar form.
Short | Composite request this is part of
Comments | Requests are linked either by a "basedOn" relationship (i.e. one request is fulfilling another) or by having a common requisition. Requests that are part of the same requisition are generally treated independently from the perspective of changing their state or maintaining them after initial creation.
Control | 1..1
Type | Identifier(AU Local Order Identifier)
Is Modifier | false
Must Support | true
Obligations |
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
Summary | true
Alternate Names | grouperId
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
26. CommunicationRequest.groupIdentifier.id
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Short | Unique id for inter-element referencing
Control | 0..1
Type | string
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
28. CommunicationRequest.groupIdentifier.extension
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Short | Additional content defined by implementations
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..*
Type | Extension
Is Modifier | false
Summary | false
Alternate Names | extensions, user content
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
Slicing | This element introduces a set of slices on `CommunicationRequest.groupIdentifier.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
30. CommunicationRequest.groupIdentifier.use
Definition | The purpose of this identifier.
Short | usual | official | temp | secondary | old (If known)
Comments | Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.
Control | 0..1
Binding | The codes SHALL be taken from IdentifierUse (required to `http://hl7.org/fhir/ValueSet/identifier-use|4.0.1` ) Identifies the purpose for this identifier, if known .
Type | code
Is Modifier | true because This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one.
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Requirements | Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
32. CommunicationRequest.groupIdentifier.type
Definition | A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.
Short | Coded identifier type for local order identifier
Comments | This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.
Control | 1..1
Binding | The codes SHALL be taken from Order Identifier Type (required to `http://terminology.hl7.org.au/ValueSet/order-identifier-type` )
Type | CodeableConcept
Is Modifier | false
Summary | true
Requirements | Allows users to make use of identifiers when the identifier system is not known.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
34. CommunicationRequest.groupIdentifier.type.id
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Short | Unique id for inter-element referencing
Control | 0..1
Type | string
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
36. CommunicationRequest.groupIdentifier.type.extension
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Short | Additional content defined by implementations
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..*
Type | Extension
Is Modifier | false
Summary | false
Alternate Names | extensions, user content
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
Slicing | This element introduces a set of slices on `CommunicationRequest.groupIdentifier.type.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
38. CommunicationRequest.groupIdentifier.type.coding
Definition | A reference to a code defined by a terminology system.
Short | Code defined by a terminology system
Comments | Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.
Control | 1..1
Type | Coding
Is Modifier | false
Summary | true
Requirements | Allows for alternative encodings within a code system, and translations to other code systems.
Pattern Value | `{ "system" : "http://terminology.hl7.org/CodeSystem/v2-0203", "code" : "PGN" }`
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
40. CommunicationRequest.groupIdentifier.type.text
Definition | A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.
Short | Plain text representation of the concept
Comments | Very often the text is the same as a displayName of one of the codings.
Control | 0..1
Type | string
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Requirements | The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
42. CommunicationRequest.groupIdentifier.system
Definition | Establishes the namespace for the value - that is, a URL that describes a set values that are unique.
Short | System identifier namespace for the organisation that assigned the order identifier
Comments | Identifier.system is always case sensitive.
Control | 1..1
Type | uri
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Requirements | There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.
Example | General: http://www.acme.com/identifiers/patient
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
44. CommunicationRequest.groupIdentifier.value
Definition | The portion of the identifier typically relevant to the user and which is unique within the context of the system.
Short | Order identifier
Comments | If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.
Control | 1..1
Type | string
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Example | General: 123456
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
46. CommunicationRequest.groupIdentifier.period
Definition | Time period during which identifier is/was valid for use.
Short | Time period when id is/was valid for use
Control | 0..1
Type | Period
Is Modifier | false
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
48. CommunicationRequest.groupIdentifier.assigner
Definition | Organization that issued/manages the identifier.
Short | Organisation that assigned the order identifier
Comments | The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.
Control | 0..1
Type | Reference(Organization)
Is Modifier | false
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
50. CommunicationRequest.groupIdentifier.assigner.id
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Short | Unique id for inter-element referencing
Control | 0..1
Type | string
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
52. CommunicationRequest.groupIdentifier.assigner.extension
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Short | Additional content defined by implementations
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..*
Type | Extension
Is Modifier | false
Summary | false
Alternate Names | extensions, user content
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
Slicing | This element introduces a set of slices on `CommunicationRequest.groupIdentifier.assigner.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
54. CommunicationRequest.groupIdentifier.assigner.reference
Definition | A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.
Short | Literal reference, Relative, internal or absolute URL
Comments | Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server.
Control | 0..1 This element is affected by the following invariants: ref-1
Type | string
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
56. CommunicationRequest.groupIdentifier.assigner.type
Definition | The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent. The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).
Short | Type the reference refers to (e.g. "Patient")
Comments | This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified.
Control | 0..1
Binding | Unless not suitable, these codes SHALL be taken from ResourceType (extensible to `http://hl7.org/fhir/ValueSet/resource-types|4.0.1` ) Aa resource (or, for logical models, the URI of the logical model).
Type | uri
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
58. CommunicationRequest.groupIdentifier.assigner.identifier
Definition | An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.
Short | Logical reference, when literal reference is not known
Comments | When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it. Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any).
Note | This is a business identifier, not a resource identifier (see discussion)
Control | 0..1
Type | Identifier
Is Modifier | false
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
60. CommunicationRequest.groupIdentifier.assigner.display
Definition | Plain text narrative that identifies the resource in addition to the resource reference.
Short | Name of the assigning organisation
Comments | This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.
Control | 1..1
Type | string
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
62. CommunicationRequest.status
Definition | The status of the proposal or order.
Short | draft | active | on-hold | revoked | completed | entered-in-error | unknown
Control | 1..1
Binding | The codes SHALL be taken from RequestStatus (required to `http://hl7.org/fhir/ValueSet/request-status|4.0.1` ) The status of the communication request.
Type | code
Is Modifier | true because This element is labelled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid.
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Obligations |
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
Summary | true
Fixed Value | `active`
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
64. CommunicationRequest.statusReason
Definition | Captures the reason for the current state of the CommunicationRequest.
Short | Reason for current status
Comments | This is generally only used for "exception" statuses such as "suspended" or "cancelled". The reason why the CommunicationRequest was created at all is captured in reasonCode, not here. [distinct reason codes for different statuses can be enforced using invariants if they are universal bindings].
Control | 0..1
Binding | Codes identifying the reason for the current state of a request.
Type | CodeableConcept
Is Modifier | false
Summary | false
Alternate Names | Suspended Reason, Cancelled Reason
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
66. CommunicationRequest.category
Definition | The type of message to be sent such as alert, notification, reminder, instruction, etc.
Short | Message category
Comments | There may be multiple axes of categorization and one communication request may serve multiple purposes.
Control | 1..1
Binding | For example codes, see CommunicationCategory (example to `http://hl7.org/fhir/ValueSet/communication-category|4.0.1` ) Codes for general categories of communications such as alerts, instruction, etc.
Type | CodeableConcept
Is Modifier | false
Must Support | true
Obligations |
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
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
68. CommunicationRequest.category.id
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Short | Unique id for inter-element referencing
Control | 0..1
Type | string
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
70. CommunicationRequest.category.extension
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Short | Additional content defined by implementations
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..*
Type | Extension
Is Modifier | false
Summary | false
Alternate Names | extensions, user content
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
Slicing | This element introduces a set of slices on `CommunicationRequest.category.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
72. CommunicationRequest.category.coding
Definition | A reference to a code defined by a terminology system.
Short | Code defined by a terminology system
Comments | Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.
Control | 1..1
Type | Coding
Is Modifier | false
Summary | true
Requirements | Allows for alternative encodings within a code system, and translations to other code systems.
Pattern Value | `{ "system" : "http://terminology.hl7.org/CodeSystem/communication-category", "code" : "alert" }`
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
74. CommunicationRequest.category.text
Definition | A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.
Short | Plain text representation of the concept
Comments | Very often the text is the same as a displayName of one of the codings.
Control | 0..1
Type | string
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Requirements | The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
76. CommunicationRequest.priority
Definition | Characterizes how quickly the proposed act must be initiated. Includes concepts such as stat, urgent, routine.
Short | routine | urgent | asap | stat
Control | 1..1
Binding | The codes SHALL be taken from RequestPriority (required to `http://hl7.org/fhir/ValueSet/request-priority|4.0.1` ) Codes indicating the relative importance of a communication request.
Type | code
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Obligations |
Obligations | Actor
SHALL:populate | AU eRequesting Placer
SHALL:handle | AU eRequesting Filler
SHALL:handle | AU eRequesting Server
SHALL:able-to-populate | AU eRequesting Server
SHALL:no-error | AU eRequesting Patient
Summary | true
Meaning if Missing | If missing, this task should be performed with normal priority
Fixed Value | `urgent`
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
78. CommunicationRequest.doNotPerform
Definition | If true indicates that the CommunicationRequest is asking for the specified action to not occur.
Short | True if request is prohibiting action
Comments | The attributes provided with the request qualify what is not to be done.
Control | 0..0
Type | boolean
Is Modifier | true because If true this element negates the specified action. For Example, instead of a request for a communication, it is a request for the communication to not occur.
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Alternate Names | prohibited
Meaning if Missing | If do not perform is not specified, the request is a positive request e.g. "do perform"
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
80. CommunicationRequest.medium
Definition | A channel that was used for this communication (e.g. email, fax).
Short | A channel of communication
Control | 0..*
Binding | For example codes, see ParticipationMode (example to `http://terminology.hl7.org/ValueSet/v3-ParticipationMode` ) Codes for communication mediums such as phone, fax, email, in person, etc.
Type | CodeableConcept
Is Modifier | false
Must Support | true
Obligations |
Obligations | Actor
SHALL:populate-if-known | AU eRequesting Placer
SHALL:handle | AU eRequesting Filler
SHALL:handle | AU eRequesting Server
SHALL:able-to-populate | AU eRequesting Server
SHALL:no-error | AU eRequesting Patient
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
82. CommunicationRequest.subject
Definition | The patient or group that is the focus of this communication request.
Short | Patient that is the subject of the communication request
Control | 1..1
Type | Reference(AU Core Patient)
Is Modifier | false
Must Support | true
Obligations |
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
Summary | false
Alternate Names | patient
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
84. CommunicationRequest.about
Definition | Other resources that pertain to this communication request and to which this communication request should be associated.
Short | Diagnostic request the urgent communication is about
Comments | Don't use CommunicationRequest.about element when a more specific element exists, such as basedOn, reasonReference, or replaces.
Control | 1..*
Type | Reference(AU eRequesting Pathology Request, AU eRequesting Imaging Request)
Is Modifier | false
Must Support | true
Must Support Types | No must-support rules about the choice of types/profiles
Obligations |
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
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
86. CommunicationRequest.encounter
Definition | The Encounter during which this CommunicationRequest was created or to which the creation of this record is tightly associated.
Short | Encounter created as part of
Comments | This will typically be the encounter the event occurred within, but some activities may be initiated prior to or after the official completion of an encounter but still be tied to the context of the encounter.
Control | 0..1
Type | Reference(Encounter)
Is Modifier | false
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
88. CommunicationRequest.payload
Definition | Text, attachment(s), or resource(s) to be communicated to the recipient.
Short | Message payload
Control | 0..*
Type | BackboneElement
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
90. CommunicationRequest.payload.id
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Short | Unique id for inter-element referencing
Control | 0..1
Type | string
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
92. CommunicationRequest.payload.extension
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Short | Additional content defined by implementations
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..*
Type | Extension
Is Modifier | false
Summary | false
Alternate Names | extensions, user content
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
94. CommunicationRequest.payload.modifierExtension
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Short | Extensions that cannot be ignored even if unrecognized
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..*
Type | Extension
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summary | true
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.
Alternate Names | extensions, user content, modifiers
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
96. CommunicationRequest.payload.content[x]
Definition | The communicated content (or for multi-part communications, one portion of the communication).
Short | Message part content
Control | 1..1
Type | Choice of: string, Attachment, Reference(Resource)
[x] Note | SeeChoice of Data Typesfor further information about how to use [x]
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
98. CommunicationRequest.occurrence[x]
Definition | The time when this communication is to occur.
Short | When scheduled
Control | 0..1
Type | Choice of: dateTime, Period
[x] Note | SeeChoice of Data Typesfor further information about how to use [x]
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Alternate Names | timing
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
100. CommunicationRequest.authoredOn
Definition | For draft requests, indicates the date of initial creation. For requests with other statuses, indicates the date of activation.
Short | Changed:When request transitioned to being actionable
Control | 1..1
Type | dateTime
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Obligations |
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
Summary | true
Alternate Names | createdOn
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
102. CommunicationRequest.requester
Definition | The device, individual, or organization who initiated the request and has responsibility for its activation.
Short | Individual provider requesting the communication
Control | 1..1
Type | Reference(AU Core PractitionerRole)
Is Modifier | false
Must Support | true
Obligations |
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
Summary | true
Alternate Names | author
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
104. CommunicationRequest.recipient
Definition | The entity (e.g. person, organization, clinical information system, device, group, or care team) which is the intended target of the communication.
Short | Individual provider receiving the communication
Control | 1..1
Type | Reference(AU Core PractitionerRole)
Is Modifier | false
Must Support | true
Obligations |
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
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
106. CommunicationRequest.sender
Definition | The entity (e.g. person, organization, clinical information system, or device) which is to be the source of the communication.
Short | Organisation sending the communication
Control | 0..1
Type | Reference(AU Core Organization)
Is Modifier | false
Must Support | true
Obligations |
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
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
108. CommunicationRequest.reasonCode
Definition | Describes why the request is being made in coded or textual form.
Short | Why is communication needed?
Comments | Textual reasons can be captured using reasonCode.text.
Control | 1..1
Binding | The codes SHALL be taken from AU eRequesting CommunicationRequest Reason (required to `http://hl7.org.au/fhir/ereq/ValueSet/au-erequesting-communicationrequest-reason` )
Type | CodeableConcept
Is Modifier | false
Must Support | true
Obligations |
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
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
110. CommunicationRequest.reasonCode.id
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Short | Unique id for inter-element referencing
Control | 0..1
Type | string
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
112. CommunicationRequest.reasonCode.extension
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Short | Additional content defined by implementations
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..*
Type | Extension
Is Modifier | false
Summary | false
Alternate Names | extensions, user content
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
Slicing | This element introduces a set of slices on `CommunicationRequest.reasonCode.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
114. CommunicationRequest.reasonCode.coding
Definition | A reference to a code defined by a terminology system.
Short | Code defined by a terminology system
Comments | Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.
Control | 1..1
Type | Coding
Is Modifier | false
Summary | true
Requirements | Allows for alternative encodings within a code system, and translations to other code systems.
Pattern Value | `{ "system" : "http://terminology.hl7.org.au/CodeSystem/communicationrequest-reason", "code" : "urgent" }`
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
116. CommunicationRequest.reasonCode.text
Definition | A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.
Short | Plain text representation of the concept
Comments | Very often the text is the same as a displayName of one of the codings.
Control | 0..1
Type | string
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Requirements | The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
118. CommunicationRequest.reasonReference
Definition | Indicates another resource whose existence justifies this request.
Short | Why is communication needed?
Control | 0..*
Type | Reference(Condition, Observation, DiagnosticReport, DocumentReference)
Is Modifier | false
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
120. CommunicationRequest.note
Definition | Comments made about the request by the requester, sender, recipient, subject or other participants.
Short | Comments made about communication request
Control | 0..*
Type | Annotation
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)