This page is part of the Clinical Guidelines (v0.1.0: STU 1 Ballot 1) based on FHIR R4. The current version which supercedes this version is 1.0.0. For a full list of available versions, see the Directory of published versions
The official URL for this profile is:
http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-communicationrequest
Profile of CommunicationRequest for use with CPG Implementation Guide
This profile builds on CommunicationRequest.
This profile was published on Thu Jun 06 00:00:00 EDT 2019 as a draft by Health Level Seven, Inc. - CDS WG.
Description of Profiles, Differentials, and Snapshots.
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
CommunicationRequest | I | 0..* | 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) Max Binding: AllLanguages | |
text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |
contained | 0..* | Resource | Contained, inline Resources | |
extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
workflow-instantiatesCanonical | SI | 0..* | canonical(ActivityDefinition | Measure | OperationDefinition | PlanDefinition | Questionnaire) | FHIR protocol or definition URL: http://hl7.org/fhir/StructureDefinition/workflow-instantiatesCanonical |
cqf-strengthOfRecommendation | SI | 0..* | CodeableConcept | The strength of the recommendation URL: http://hl7.org/fhir/StructureDefinition/cqf-strengthOfRecommendation Binding: StrengthOfRecommendationRating (example) |
cqf-qualityOfEvidence | SI | 0..* | CodeableConcept | The quality of the evidence URL: http://hl7.org/fhir/StructureDefinition/cqf-qualityOfEvidence Binding: QualityOfEvidenceRating (example) |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
identifier | SΣ | 1..* | 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 | suspended | cancelled | completed | entered-in-error | unknown Binding: RequestStatus (required) |
statusReason | 0..1 | CodeableConcept | Reason for current status Binding: (unbound) (example) | |
category | S | 0..* | CodeableConcept | Message category Binding: CommunicationCategory (example) |
priority | SΣ | 0..1 | code | Message urgency Binding: RequestPriority (required) |
doNotPerform | ?!SΣ | 0..1 | boolean | True if request is prohibiting action |
medium | 0..* | CodeableConcept | A channel of communication Binding: v3 Code System ParticipationMode (example) | |
subject | S | 0..1 | Reference(Patient | Group) | Focus of message |
about | S | 0..* | Reference(Resource) | Resources that pertain to this communication request |
encounter | SΣ | 0..1 | Reference(Encounter) | Encounter created as part of |
payload | I | 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(http://hl7.org/fhir/R4/resource.html) | |||
occurrence[x] | Σ | 0..1 | When scheduled | |
occurrenceDateTime | dateTime | |||
occurrencePeriod | Period | |||
authoredOn | Σ | 0..1 | dateTime | When request transitioned to being actionable |
requester | SΣ | 0..1 | Reference(Practitioner | PractitionerRole | Organization | Patient | RelatedPerson | Device) | Who/what is requesting service |
recipient | S | 0..* | Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson | Group | CareTeam | HealthcareService) | Message recipient |
sender | SΣ | 0..1 | Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson | HealthcareService) | Message sender |
reasonCode | Σ | 0..* | CodeableConcept | Why is communication needed? Binding: v3 Code System ActReason (example) |
reasonReference | Σ | 0..* | Reference(Condition | Observation | DiagnosticReport | DocumentReference) | Why is communication needed? |
note | 0..* | Annotation | Comments made about communication request | |
Documentation for this format |
Differential View
Snapshot View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
CommunicationRequest | I | 0..* | 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) Max Binding: AllLanguages | |
text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |
contained | 0..* | Resource | Contained, inline Resources | |
extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
workflow-instantiatesCanonical | SI | 0..* | canonical(ActivityDefinition | Measure | OperationDefinition | PlanDefinition | Questionnaire) | FHIR protocol or definition URL: http://hl7.org/fhir/StructureDefinition/workflow-instantiatesCanonical |
cqf-strengthOfRecommendation | SI | 0..* | CodeableConcept | The strength of the recommendation URL: http://hl7.org/fhir/StructureDefinition/cqf-strengthOfRecommendation Binding: StrengthOfRecommendationRating (example) |
cqf-qualityOfEvidence | SI | 0..* | CodeableConcept | The quality of the evidence URL: http://hl7.org/fhir/StructureDefinition/cqf-qualityOfEvidence Binding: QualityOfEvidenceRating (example) |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
identifier | SΣ | 1..* | 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 | suspended | cancelled | completed | entered-in-error | unknown Binding: RequestStatus (required) |
statusReason | 0..1 | CodeableConcept | Reason for current status Binding: (unbound) (example) | |
category | S | 0..* | CodeableConcept | Message category Binding: CommunicationCategory (example) |
priority | SΣ | 0..1 | code | Message urgency Binding: RequestPriority (required) |
doNotPerform | ?!SΣ | 0..1 | boolean | True if request is prohibiting action |
medium | 0..* | CodeableConcept | A channel of communication Binding: v3 Code System ParticipationMode (example) | |
subject | S | 0..1 | Reference(Patient | Group) | Focus of message |
about | S | 0..* | Reference(Resource) | Resources that pertain to this communication request |
encounter | SΣ | 0..1 | Reference(Encounter) | Encounter created as part of |
payload | I | 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(http://hl7.org/fhir/R4/resource.html) | |||
occurrence[x] | Σ | 0..1 | When scheduled | |
occurrenceDateTime | dateTime | |||
occurrencePeriod | Period | |||
authoredOn | Σ | 0..1 | dateTime | When request transitioned to being actionable |
requester | SΣ | 0..1 | Reference(Practitioner | PractitionerRole | Organization | Patient | RelatedPerson | Device) | Who/what is requesting service |
recipient | S | 0..* | Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson | Group | CareTeam | HealthcareService) | Message recipient |
sender | SΣ | 0..1 | Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson | HealthcareService) | Message sender |
reasonCode | Σ | 0..* | CodeableConcept | Why is communication needed? Binding: v3 Code System ActReason (example) |
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 |
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-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-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-6 | CommunicationRequest | A resource should have narrative for robust management : text.div.exists() | |
dom-5 | CommunicationRequest | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
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.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.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.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.payload | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |