QI-Core Implementation Guide, published by HL7 International / Clinical Quality Information. This guide is not an authorized publication; it is the continuous build for version 7.0.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/fhir-qi-core/ and changes regularly. See the Directory of published versions
Official URL: http://hl7.org/fhir/us/qicore/StructureDefinition/qicore-communicationrequest | Version: 7.0.0 | |||
Active as of 2018-08-22 | Computable Name: QICoreCommunicationRequest |
Profile of CommunicationRequest for decision support/quality metrics. Defines the core set of elements and extensions for quality rule and measure authors.
CommunicationRequest Example |
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
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 | 1..1 | code | (QI) draft | active | on-hold | revoked | completed | entered-in-error | unknown | |
category | 0..* | CodeableConcept | (QI) Message category Binding: CommunicationCategory (preferred) | |
doNotPerform | 0..1 | boolean | (QI) True if request is prohibiting action | |
subject | 0..1 | Reference(QICore Patient) | (QI) Focus of message | |
encounter | 0..1 | Reference(QICore Encounter) | (QI) Encounter created as part of | |
recipient | 0..* | Reference(QICore Device | US Core Implantable Device Profile | QICore Organization | QICore Patient | QICore Practitioner | QICore RelatedPerson | Group | QICore CareTeam) | (QI) Message recipient | |
sender | 0..1 | Reference(QICore Device | US Core Implantable Device Profile | QICore Organization | QICore Patient | QICore Practitioner | QICore RelatedPerson) | (QI) Message sender | |
Documentation for this format |
Path | Conformance | ValueSet | URI |
CommunicationRequest.category | preferred | CommunicationCategoryhttp://hl7.org/fhir/ValueSet/communication-category from the FHIR Standard |
Path | Conformance | ValueSet | URI |
CommunicationRequest.status | required | RequestStatushttp://hl7.org/fhir/ValueSet/request-status|4.0.1 from the FHIR Standard | |
CommunicationRequest.category | preferred | CommunicationCategoryhttp://hl7.org/fhir/ValueSet/communication-category from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
dom-2 | error | CommunicationRequest | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | CommunicationRequest | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
dom-4 | error | CommunicationRequest | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
dom-5 | error | CommunicationRequest | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | CommunicationRequest | A resource should have narrative for robust management : text.`div`.exists() | |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
CommunicationRequest | 0..* | CommunicationRequest | A request for information to be sent to a receiver | |||||
id | Σ | 0..1 | id | Logical id of this artifact | ||||
meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
contained | 0..* | Resource | Contained, inline Resources | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
identifier | Σ | 0..* | Identifier | Unique identifier | ||||
basedOn | Σ | 0..* | Reference(Resource) | Fulfills plan or proposal | ||||
replaces | Σ | 0..* | Reference(CommunicationRequest) | Request(s) replaced by this request | ||||
groupIdentifier | Σ | 0..1 | Identifier | Composite request this is part of | ||||
status | ?!Σ | 1..1 | code | (QI) 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 Description (No ValueSet): (example): Codes identifying the reason for the current state of a request. | |||||
category | 0..* | CodeableConcept | (QI) Message category Binding: CommunicationCategory (preferred) | |||||
priority | Σ | 0..1 | code | routine | urgent | asap | stat Binding: RequestPriority (required): Codes indicating the relative importance of a communication request. | ||||
doNotPerform | ?!Σ | 0..1 | boolean | (QI) 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 | 0..1 | Reference(QICore Patient) | (QI) Focus of message | |||||
about | 0..* | Reference(Resource) | Resources that pertain to this communication request | |||||
encounter | Σ | 0..1 | Reference(QICore Encounter) | (QI) 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 | 0..* | Reference(QICore Device | US Core Implantable Device Profile | QICore Organization | QICore Patient | QICore Practitioner | QICore RelatedPerson | Group | QICore CareTeam) | (QI) Message recipient | |||||
sender | Σ | 0..1 | Reference(QICore Device | US Core Implantable Device Profile | QICore Organization | QICore Patient | QICore Practitioner | QICore RelatedPerson) | (QI) 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 |
Path | Conformance | ValueSet | URI | |||
CommunicationRequest.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languages from the FHIR Standard | ||||
CommunicationRequest.status | required | RequestStatushttp://hl7.org/fhir/ValueSet/request-status|4.0.1 from the FHIR Standard | ||||
CommunicationRequest.statusReason | example | |||||
CommunicationRequest.category | preferred | CommunicationCategoryhttp://hl7.org/fhir/ValueSet/communication-category from the FHIR Standard | ||||
CommunicationRequest.priority | required | RequestPriorityhttp://hl7.org/fhir/ValueSet/request-priority|4.0.1 from the FHIR Standard | ||||
CommunicationRequest.medium | example | ParticipationModehttp://terminology.hl7.org/ValueSet/v3-ParticipationMode | ||||
CommunicationRequest.reasonCode | example | ActReasonhttp://terminology.hl7.org/ValueSet/v3-ActReason |
Id | Grade | Path(s) | Details | Requirements |
dom-2 | error | CommunicationRequest | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | CommunicationRequest | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
dom-4 | error | CommunicationRequest | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
dom-5 | error | CommunicationRequest | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | CommunicationRequest | A resource should have narrative for robust management : text.`div`.exists() | |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
This structure is derived from CommunicationRequest
Summary
Structures
This structure refers to these other structures:
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 | 1..1 | code | (QI) draft | active | on-hold | revoked | completed | entered-in-error | unknown | |
category | 0..* | CodeableConcept | (QI) Message category Binding: CommunicationCategory (preferred) | |
doNotPerform | 0..1 | boolean | (QI) True if request is prohibiting action | |
subject | 0..1 | Reference(QICore Patient) | (QI) Focus of message | |
encounter | 0..1 | Reference(QICore Encounter) | (QI) Encounter created as part of | |
recipient | 0..* | Reference(QICore Device | US Core Implantable Device Profile | QICore Organization | QICore Patient | QICore Practitioner | QICore RelatedPerson | Group | QICore CareTeam) | (QI) Message recipient | |
sender | 0..1 | Reference(QICore Device | US Core Implantable Device Profile | QICore Organization | QICore Patient | QICore Practitioner | QICore RelatedPerson) | (QI) Message sender | |
Documentation for this format |
Path | Conformance | ValueSet | URI |
CommunicationRequest.category | preferred | CommunicationCategoryhttp://hl7.org/fhir/ValueSet/communication-category from the FHIR Standard |
Key Elements View
Path | Conformance | ValueSet | URI |
CommunicationRequest.status | required | RequestStatushttp://hl7.org/fhir/ValueSet/request-status|4.0.1 from the FHIR Standard | |
CommunicationRequest.category | preferred | CommunicationCategoryhttp://hl7.org/fhir/ValueSet/communication-category from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
dom-2 | error | CommunicationRequest | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | CommunicationRequest | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
dom-4 | error | CommunicationRequest | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
dom-5 | error | CommunicationRequest | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | CommunicationRequest | A resource should have narrative for robust management : text.`div`.exists() | |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
CommunicationRequest | 0..* | CommunicationRequest | A request for information to be sent to a receiver | |||||
id | Σ | 0..1 | id | Logical id of this artifact | ||||
meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
contained | 0..* | Resource | Contained, inline Resources | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
identifier | Σ | 0..* | Identifier | Unique identifier | ||||
basedOn | Σ | 0..* | Reference(Resource) | Fulfills plan or proposal | ||||
replaces | Σ | 0..* | Reference(CommunicationRequest) | Request(s) replaced by this request | ||||
groupIdentifier | Σ | 0..1 | Identifier | Composite request this is part of | ||||
status | ?!Σ | 1..1 | code | (QI) 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 Description (No ValueSet): (example): Codes identifying the reason for the current state of a request. | |||||
category | 0..* | CodeableConcept | (QI) Message category Binding: CommunicationCategory (preferred) | |||||
priority | Σ | 0..1 | code | routine | urgent | asap | stat Binding: RequestPriority (required): Codes indicating the relative importance of a communication request. | ||||
doNotPerform | ?!Σ | 0..1 | boolean | (QI) 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 | 0..1 | Reference(QICore Patient) | (QI) Focus of message | |||||
about | 0..* | Reference(Resource) | Resources that pertain to this communication request | |||||
encounter | Σ | 0..1 | Reference(QICore Encounter) | (QI) 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 | 0..* | Reference(QICore Device | US Core Implantable Device Profile | QICore Organization | QICore Patient | QICore Practitioner | QICore RelatedPerson | Group | QICore CareTeam) | (QI) Message recipient | |||||
sender | Σ | 0..1 | Reference(QICore Device | US Core Implantable Device Profile | QICore Organization | QICore Patient | QICore Practitioner | QICore RelatedPerson) | (QI) 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 |
Path | Conformance | ValueSet | URI | |||
CommunicationRequest.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languages from the FHIR Standard | ||||
CommunicationRequest.status | required | RequestStatushttp://hl7.org/fhir/ValueSet/request-status|4.0.1 from the FHIR Standard | ||||
CommunicationRequest.statusReason | example | |||||
CommunicationRequest.category | preferred | CommunicationCategoryhttp://hl7.org/fhir/ValueSet/communication-category from the FHIR Standard | ||||
CommunicationRequest.priority | required | RequestPriorityhttp://hl7.org/fhir/ValueSet/request-priority|4.0.1 from the FHIR Standard | ||||
CommunicationRequest.medium | example | ParticipationModehttp://terminology.hl7.org/ValueSet/v3-ParticipationMode | ||||
CommunicationRequest.reasonCode | example | ActReasonhttp://terminology.hl7.org/ValueSet/v3-ActReason |
Id | Grade | Path(s) | Details | Requirements |
dom-2 | error | CommunicationRequest | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | CommunicationRequest | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
dom-4 | error | CommunicationRequest | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
dom-5 | error | CommunicationRequest | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | CommunicationRequest | A resource should have narrative for robust management : text.`div`.exists() | |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
This structure is derived from CommunicationRequest
Summary
Structures
This structure refers to these other structures:
Other representations of profile: CSV, Excel, Schematron