QI-Core Implementation Guide
4.1.0 - release

Publication Build: This will be filled in by the publication tooling

## Resource Profile: QICoreCommunicationRequest

Defining URL: | http://hl7.org/fhir/us/qicore/StructureDefinition/qicore-communicationrequest
Version: | 4.1.0
Name: | QICoreCommunicationRequest
Status: | Draft as of 8/22/18
Definition: | Profile of CommunicationRequest for decision support/quality metrics. Defines the core set of elements and extensions for quality rule and measure authors.
Publisher: | http://www.hl7.org/Special/committees/cqi/index.cfm
Source Resource: | XML / JSON / Turtle

The official URL for this profile is:

    http://hl7.org/fhir/us/qicore/StructureDefinition/qicore-communicationrequest

Usage

See the patterns page for implementation and usage patterns.

### Examples

CommunicationRequest Example

### Formal Views of Profile Content

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

- Text Summary
- Differential Table
- Snapshot Table
- Snapshot Table (Must Support)
- All

This structure is derived from CommunicationRequest

Summary

Must-Support: 7 elements

Structures

This structure refers to these other structures:

- QICorePatient (http://hl7.org/fhir/us/qicore/StructureDefinition/qicore-patient)
- QICoreEncounter (http://hl7.org/fhir/us/qicore/StructureDefinition/qicore-encounter)
- QICoreDevice (http://hl7.org/fhir/us/qicore/StructureDefinition/qicore-device)
- QICoreOrganization (http://hl7.org/fhir/us/qicore/StructureDefinition/qicore-organization)
- QICorePractitioner (http://hl7.org/fhir/us/qicore/StructureDefinition/qicore-practitioner)
- QICoreRelatedPerson (http://hl7.org/fhir/us/qicore/StructureDefinition/qicore-relatedperson)

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
status | S | 1..1 | code | draft | active | on-hold | revoked | completed | entered-in-error | unknown
category | S | 0..* | CodeableConcept | Message category
doNotPerform | S | 0..1 | boolean | True if request is prohibiting action
subject | S | 0..1 | Reference(QICorePatient) | Focus of message
encounter | S | 0..1 | Reference(QICoreEncounter) | Encounter created as part of
recipient | S | 0..* | Reference(QICoreDevice | QICoreOrganization | QICorePatient | QICorePractitioner | QICoreRelatedPerson | Group | CareTeam) | Message recipient
sender | S | 0..1 | Reference(QICoreDevice | QICoreOrganization | QICorePatient | QICorePractitioner | QICoreRelatedPerson) | Message sender
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 | string | 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) Max Binding: AllLanguages: 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 | Σ | 0..1 | Identifier | Composite request this is part of
status | ?!S Σ | 1..1 | code | draft | active | on-hold | revoked | completed | entered-in-error | unknown Binding: RequestStatus (required): The status of the communication request.
statusReason |  | 0..1 | CodeableConcept | Reason for current status Binding: (unbound) (example): Codes identifying the reason for the current state of a request.
category | S | 0..* | CodeableConcept | Message category Binding: CommunicationCategory (example): Codes for general categories of communications such as alerts, instruction, etc.
priority | Σ | 0..1 | code | routine | urgent | asap | stat Binding: RequestPriority (required): Codes indicating the relative importance of a communication request.
doNotPerform | ?!S Σ | 0..1 | boolean | True if request is prohibiting action
medium |  | 0..* | CodeableConcept | A channel of communication Binding: ParticipationMode (example): Codes for communication mediums such as phone, fax, email, in person, etc.
subject | S | 0..1 | Reference(QICorePatient) | Focus of message
about |  | 0..* | Reference(Resource) | Resources that pertain to this communication request
encounter | S Σ | 0..1 | Reference(QICoreEncounter) | 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 | Σ | 0..1 | dateTime | When request transitioned to being actionable
requester | Σ | 0..1 | Reference(Practitioner | PractitionerRole | Organization | Patient | RelatedPerson | Device) | Who/what is requesting service
recipient | S | 0..* | Reference(QICoreDevice | QICoreOrganization | QICorePatient | QICorePractitioner | QICoreRelatedPerson | Group | CareTeam) | Message recipient
sender | S Σ | 0..1 | Reference(QICoreDevice | QICoreOrganization | QICorePatient | QICorePractitioner | QICoreRelatedPerson) | Message sender
reasonCode | Σ | 0..* | CodeableConcept | Why is communication needed? Binding: v3 Code System ActReason (example): Codes for describing reasons for the occurrence of a communication.
reasonReference | Σ | 0..* | Reference(Condition | Observation | DiagnosticReport | DocumentReference) | Why is communication needed?
note |  | 0..* | Annotation | Comments made about communication request
Documentation for this format

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
CommunicationRequest |  | 0..* | CommunicationRequest | A request for information to be sent to a receiver
status | ?!Σ | 1..1 | code | draft | active | on-hold | revoked | completed | entered-in-error | unknown Binding: RequestStatus (required): The status of the communication request.
category |  | 0..* | CodeableConcept | Message category Binding: CommunicationCategory (example): Codes for general categories of communications such as alerts, instruction, etc.
doNotPerform | ?!Σ | 0..1 | boolean | True if request is prohibiting action
subject |  | 0..1 | Reference(QICorePatient) | Focus of message
encounter | Σ | 0..1 | Reference(QICoreEncounter) | Encounter created as part of
recipient |  | 0..* | Reference(QICoreDevice | QICoreOrganization | QICorePatient | QICorePractitioner | QICoreRelatedPerson | Group | CareTeam) | Message recipient
sender | Σ | 0..1 | Reference(QICoreDevice | QICoreOrganization | QICorePatient | QICorePractitioner | QICoreRelatedPerson) | Message sender
Documentation for this format

This structure is derived from CommunicationRequest

Summary

Must-Support: 7 elements

Structures

This structure refers to these other structures:

- QICorePatient (http://hl7.org/fhir/us/qicore/StructureDefinition/qicore-patient)
- QICoreEncounter (http://hl7.org/fhir/us/qicore/StructureDefinition/qicore-encounter)
- QICoreDevice (http://hl7.org/fhir/us/qicore/StructureDefinition/qicore-device)
- QICoreOrganization (http://hl7.org/fhir/us/qicore/StructureDefinition/qicore-organization)
- QICorePractitioner (http://hl7.org/fhir/us/qicore/StructureDefinition/qicore-practitioner)
- QICoreRelatedPerson (http://hl7.org/fhir/us/qicore/StructureDefinition/qicore-relatedperson)

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
status | S | 1..1 | code | draft | active | on-hold | revoked | completed | entered-in-error | unknown
category | S | 0..* | CodeableConcept | Message category
doNotPerform | S | 0..1 | boolean | True if request is prohibiting action
subject | S | 0..1 | Reference(QICorePatient) | Focus of message
encounter | S | 0..1 | Reference(QICoreEncounter) | Encounter created as part of
recipient | S | 0..* | Reference(QICoreDevice | QICoreOrganization | QICorePatient | QICorePractitioner | QICoreRelatedPerson | Group | CareTeam) | Message recipient
sender | S | 0..1 | Reference(QICoreDevice | QICoreOrganization | QICorePatient | QICorePractitioner | QICoreRelatedPerson) | Message sender
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 | string | 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) Max Binding: AllLanguages: 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 | Σ | 0..1 | Identifier | Composite request this is part of
status | ?!S Σ | 1..1 | code | draft | active | on-hold | revoked | completed | entered-in-error | unknown Binding: RequestStatus (required): The status of the communication request.
statusReason |  | 0..1 | CodeableConcept | Reason for current status Binding: (unbound) (example): Codes identifying the reason for the current state of a request.
category | S | 0..* | CodeableConcept | Message category Binding: CommunicationCategory (example): Codes for general categories of communications such as alerts, instruction, etc.
priority | Σ | 0..1 | code | routine | urgent | asap | stat Binding: RequestPriority (required): Codes indicating the relative importance of a communication request.
doNotPerform | ?!S Σ | 0..1 | boolean | True if request is prohibiting action
medium |  | 0..* | CodeableConcept | A channel of communication Binding: ParticipationMode (example): Codes for communication mediums such as phone, fax, email, in person, etc.
subject | S | 0..1 | Reference(QICorePatient) | Focus of message
about |  | 0..* | Reference(Resource) | Resources that pertain to this communication request
encounter | S Σ | 0..1 | Reference(QICoreEncounter) | 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 | Σ | 0..1 | dateTime | When request transitioned to being actionable
requester | Σ | 0..1 | Reference(Practitioner | PractitionerRole | Organization | Patient | RelatedPerson | Device) | Who/what is requesting service
recipient | S | 0..* | Reference(QICoreDevice | QICoreOrganization | QICorePatient | QICorePractitioner | QICoreRelatedPerson | Group | CareTeam) | Message recipient
sender | S Σ | 0..1 | Reference(QICoreDevice | QICoreOrganization | QICorePatient | QICorePractitioner | QICoreRelatedPerson) | Message sender
reasonCode | Σ | 0..* | CodeableConcept | Why is communication needed? Binding: v3 Code System ActReason (example): Codes for describing reasons for the occurrence of a communication.
reasonReference | Σ | 0..* | Reference(Condition | Observation | DiagnosticReport | DocumentReference) | Why is communication needed?
note |  | 0..* | Annotation | Comments made about communication request
Documentation for this format

Other representations of profile: CSV, Excel, Schematron

#### Terminology Bindings

Path | Conformance | ValueSet
CommunicationRequest.language | preferred | CommonLanguages Max Binding: AllLanguages
CommunicationRequest.status | required | RequestStatus
CommunicationRequest.statusReason | example |
CommunicationRequest.category | example | CommunicationCategory
CommunicationRequest.priority | required | RequestPriority
CommunicationRequest.medium | example | ParticipationMode
CommunicationRequest.reasonCode | example | ActReason

#### Constraints

Id | Grade | Path | Details | Requirements
dom-2 | error | CommunicationRequest | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() |
dom-3 | error | CommunicationRequest | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() |
dom-4 | error | CommunicationRequest | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() |
dom-5 | error | CommunicationRequest | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() |
dom-6 | Best Practice | CommunicationRequest | A resource should have narrative for robust management : text.`div`.exists() |
ele-1 | error | CommunicationRequest.meta | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
ele-1 | error | CommunicationRequest.implicitRules | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
ele-1 | error | CommunicationRequest.language | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
ele-1 | error | CommunicationRequest.text | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
ele-1 | error | CommunicationRequest.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
ext-1 | error | CommunicationRequest.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
ele-1 | error | CommunicationRequest.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
ext-1 | error | CommunicationRequest.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
ele-1 | error | CommunicationRequest.identifier | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
ele-1 | error | CommunicationRequest.basedOn | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
ele-1 | error | CommunicationRequest.replaces | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
ele-1 | error | CommunicationRequest.groupIdentifier | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
ele-1 | error | CommunicationRequest.status | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
ele-1 | error | CommunicationRequest.statusReason | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
ele-1 | error | CommunicationRequest.category | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
ele-1 | error | CommunicationRequest.priority | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
ele-1 | error | CommunicationRequest.doNotPerform | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
ele-1 | error | CommunicationRequest.medium | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
ele-1 | error | CommunicationRequest.subject | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
ele-1 | error | CommunicationRequest.about | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
ele-1 | error | CommunicationRequest.encounter | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
ele-1 | error | CommunicationRequest.payload | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
ele-1 | error | CommunicationRequest.payload.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
ext-1 | error | CommunicationRequest.payload.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
ele-1 | error | CommunicationRequest.payload.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
ext-1 | error | CommunicationRequest.payload.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
ele-1 | error | CommunicationRequest.payload.content[x] | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
ele-1 | error | CommunicationRequest.occurrence[x] | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
ele-1 | error | CommunicationRequest.authoredOn | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
ele-1 | error | CommunicationRequest.requester | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
ele-1 | error | CommunicationRequest.recipient | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
ele-1 | error | CommunicationRequest.sender | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
ele-1 | error | CommunicationRequest.reasonCode | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
ele-1 | error | CommunicationRequest.reasonReference | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
ele-1 | error | CommunicationRequest.note | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |