QI-Core Implementation Guide: STU 4 (v4.0.0 for FHIR 4.0.1)
QI-Core Implementation Guide - This is the current published version.. See the Directory of published versions
| CommunicationRequest Example |
The official URL for this profile is:
http://hl7.org/fhir/us/qicore/StructureDefinition/qicore-communicationrequest
Profile of CommunicationRequest for decision support/quality metrics. Defines the core set of elements and extensions for quality rule and measure authors.
This profile builds on CommunicationRequest.
This profile was published on Wed Aug 22 00:00:00 UTC 2018 as a draft by Health Level Seven, Inc. - CQI WG.
Description of Profiles, Differentials, and Snapshots.
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  CommunicationRequest | I | 0..* | CommunicationRequest | A request for information to be sent to a receiver |
  id | Σ | 0..1 | string | Logical id of this artifact |
 meta | ΣI | 0..1 | Meta | Metadata about the resource |
| implicitRules | ?!ΣI | 0..1 | uri | A set of rules under which this content was created |
| language | I | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred) Max Binding: AllLanguages |
| text | I | 0..1 | Narrative | Text summary of the resource, for human interpretation |
| contained | 0..* | Resource | Contained, inline Resources | |
 extension | I | 0..* | Extension | Additional content defined by implementations |
 modifierExtension | ?!I | 0..* | Extension | Extensions that cannot be ignored |
| identifier | ΣI | 0..* | Identifier | Unique identifier |
 basedOn | ΣI | 0..* | Reference(Resource) | Fulfills plan or proposal |
| replaces | ΣI | 0..* | Reference(CommunicationRequest) | Request(s) replaced by this request |
| groupIdentifier | ΣI | 0..1 | Identifier | Composite request this is part of |
| status | ?!SΣI | 1..1 | code | draft | active | on-hold | revoked | completed | entered-in-error | unknown Binding: RequestStatus (required) |
| statusReason | I | 0..1 | CodeableConcept | Reason for current status Binding: (unbound) (example) |
| category | SI | 0..* | CodeableConcept | Message category Binding: CommunicationCategory (example) |
| priority | ΣI | 0..1 | code | routine | urgent | asap | stat Binding: RequestPriority (required) |
| doNotPerform | ?!SΣI | 0..1 | boolean | True if request is prohibiting action |
| medium | I | 0..* | CodeableConcept | A channel of communication Binding: v3 Code System ParticipationMode (example) |
| subject | SI | 0..1 | Reference(QICorePatient) | Focus of message |
| about | I | 0..* | Reference(Resource) | Resources that pertain to this communication request |
| encounter | SΣI | 0..1 | Reference(QICoreEncounter) | Encounter created as part of |
| payload | I | 0..* | BackboneElement | Message payload |
 id | 0..1 | string | Unique id for inter-element referencing | |
| extension | I | 0..* | Extension | Additional content defined by implementations |
| modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
  content[x] | I | 1..1 | Message part content | |
 contentString | string | |||
| contentAttachment | Attachment | |||
| contentReference | Reference(Resource) | |||
| occurrence[x] | ΣI | 0..1 | When scheduled | |
| occurrenceDateTime | dateTime | |||
| occurrencePeriod | Period | |||
| authoredOn | ΣI | 0..1 | dateTime | When request transitioned to being actionable |
| requester | ΣI | 0..1 | Reference(Practitioner | PractitionerRole | Organization | Patient | RelatedPerson | Device) | Who/what is requesting service |
| recipient | SI | 0..* | Reference(QICoreDevice | QICoreOrganization | QICorePatient | QICorePractitioner | QICoreRelatedPerson | Group | CareTeam) | Message recipient |
| sender | SΣI | 0..1 | Reference(QICoreDevice | QICoreOrganization | QICorePatient | QICorePractitioner | QICoreRelatedPerson) | Message sender |
| reasonCode | ΣI | 0..* | CodeableConcept | Why is communication needed? Binding: v3 Code System ActReason (example) |
| reasonReference | ΣI | 0..* | Reference(Condition | Observation | DiagnosticReport | DocumentReference) | Why is communication needed? |
| note | I | 0..* | Annotation | Comments made about communication request |
| Documentation for this format | ||||
Differential View
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| CommunicationRequest | I | 0..* | CommunicationRequest | A request for information to be sent to a receiver |
| id | Σ | 0..1 | string | Logical id of this artifact |
| meta | ΣI | 0..1 | Meta | Metadata about the resource |
| implicitRules | ?!ΣI | 0..1 | uri | A set of rules under which this content was created |
| language | I | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred) Max Binding: AllLanguages |
| text | I | 0..1 | Narrative | Text summary of the resource, for human interpretation |
| contained | 0..* | Resource | Contained, inline Resources | |
| extension | I | 0..* | Extension | Additional content defined by implementations |
| modifierExtension | ?!I | 0..* | Extension | Extensions that cannot be ignored |
| identifier | ΣI | 0..* | Identifier | Unique identifier |
| basedOn | ΣI | 0..* | Reference(Resource) | Fulfills plan or proposal |
| replaces | ΣI | 0..* | Reference(CommunicationRequest) | Request(s) replaced by this request |
| groupIdentifier | ΣI | 0..1 | Identifier | Composite request this is part of |
| status | ?!SΣI | 1..1 | code | draft | active | on-hold | revoked | completed | entered-in-error | unknown Binding: RequestStatus (required) |
| statusReason | I | 0..1 | CodeableConcept | Reason for current status Binding: (unbound) (example) |
| category | SI | 0..* | CodeableConcept | Message category Binding: CommunicationCategory (example) |
| priority | ΣI | 0..1 | code | routine | urgent | asap | stat Binding: RequestPriority (required) |
| doNotPerform | ?!SΣI | 0..1 | boolean | True if request is prohibiting action |
| medium | I | 0..* | CodeableConcept | A channel of communication Binding: v3 Code System ParticipationMode (example) |
| subject | SI | 0..1 | Reference(QICorePatient) | Focus of message |
| about | I | 0..* | Reference(Resource) | Resources that pertain to this communication request |
| encounter | SΣI | 0..1 | Reference(QICoreEncounter) | Encounter created as part of |
| payload | I | 0..* | BackboneElement | Message payload |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | I | 0..* | Extension | Additional content defined by implementations |
| modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| content[x] | I | 1..1 | Message part content | |
| contentString | string | |||
| contentAttachment | Attachment | |||
| contentReference | Reference(Resource) | |||
| occurrence[x] | ΣI | 0..1 | When scheduled | |
| occurrenceDateTime | dateTime | |||
| occurrencePeriod | Period | |||
| authoredOn | ΣI | 0..1 | dateTime | When request transitioned to being actionable |
| requester | ΣI | 0..1 | Reference(Practitioner | PractitionerRole | Organization | Patient | RelatedPerson | Device) | Who/what is requesting service |
| recipient | SI | 0..* | Reference(QICoreDevice | QICoreOrganization | QICorePatient | QICorePractitioner | QICoreRelatedPerson | Group | CareTeam) | Message recipient |
| sender | SΣI | 0..1 | Reference(QICoreDevice | QICoreOrganization | QICorePatient | QICorePractitioner | QICoreRelatedPerson) | Message sender |
| reasonCode | ΣI | 0..* | CodeableConcept | Why is communication needed? Binding: v3 Code System ActReason (example) |
| reasonReference | ΣI | 0..* | Reference(Condition | Observation | DiagnosticReport | DocumentReference) | Why is communication needed? |
| note | I | 0..* | Annotation | Comments made about communication request |
| Documentation for this format | ||||
| 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 | v3.ParticipationMode |
| CommunicationRequest.reasonCode | example | v3.ActReason |
| Id | Path | Details | Requirements |
| dom-2 | CommunicationRequest | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | 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 | 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 | CommunicationRequest | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | CommunicationRequest | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | CommunicationRequest.meta | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | CommunicationRequest.implicitRules | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | CommunicationRequest.language | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | CommunicationRequest.text | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | CommunicationRequest.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | CommunicationRequest.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | CommunicationRequest.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | CommunicationRequest.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | CommunicationRequest.identifier | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | CommunicationRequest.basedOn | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | CommunicationRequest.replaces | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | CommunicationRequest.groupIdentifier | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | CommunicationRequest.status | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | CommunicationRequest.statusReason | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | CommunicationRequest.category | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | CommunicationRequest.priority | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | CommunicationRequest.doNotPerform | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | CommunicationRequest.medium | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | CommunicationRequest.subject | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | CommunicationRequest.about | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | CommunicationRequest.encounter | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | CommunicationRequest.payload | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | CommunicationRequest.payload.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | CommunicationRequest.payload.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | CommunicationRequest.payload.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | CommunicationRequest.payload.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | CommunicationRequest.payload.content[x] | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | CommunicationRequest.occurrence[x] | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | CommunicationRequest.authoredOn | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | CommunicationRequest.requester | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | CommunicationRequest.recipient | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | CommunicationRequest.sender | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | CommunicationRequest.reasonCode | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | CommunicationRequest.reasonReference | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | CommunicationRequest.note | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
© HL7.org 2011+. (Clinical Quality Improvement WG). hl7.fhir.us.qicore#4.0.0 based on FHIR v4.0.1 Generated 2020-03-24.
Links: Home
| QA Report | Search
| Version History
| 
| Propose a change 
