This page is part of the Quality Improvement Core Framework (v1.6.0: STU 2 Ballot 1) based on FHIR v1.6.0. The current version which supercedes this version is 4.1.1. For a full list of available versions, see the Directory of published versions
The official URL for this profile is:
http://hl7.org/fhir/qicore/StructureDefinition/qicore-communicationrequest
This profile was published on Fri Feb 27 00:00:00 AEDT 2015 as a draft by Health Level Seven International (Clinical Quality Information - QICore).
Description of Profiles, Differentials, Snapshots, and how the XML and JSON presentations work.
This structure is derived from CommunicationRequest
Summary
Must-Support: 7 elements
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
This structure is derived from CommunicationRequest
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
CommunicationRequest | I | 0..* | A request for information to be sent to a receiver dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-1: If the resource is contained in another resource, it SHALL NOT contain any narrative dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource | |
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: Common Languages (extensible) | |
text | I | 0..1 | Narrative | Text summary of the resource, for human interpretation |
contained | 0..* | Resource | Contained, inline Resources | |
communicationrequest-reasonRejected | I | 0..1 | CodeableConcept | Extension URL: http://hl7.org/fhir/StructureDefinition/communicationrequest-reasonRejected Binding: Communication reason not performed codes (example) ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
identifier | ∑ | 0..* | Identifier | Unique identifier |
category | S | 0..1 | CodeableConcept | Message category Binding: (unbound) (example) |
sender | S | 0..1 | Reference(Profile qicore-practitioner | Profile qicore-patient | Profile qicore-device | Profile qicore-relatedperson | Profile qicore-organization) | Message sender |
recipient | S | 0..* | Reference(Profile qicore-practitioner | Profile qicore-patient | Profile qicore-device | Profile qicore-relatedperson | Profile qicore-organization) | Message recipient |
payload | ∑ | 0..* | BackboneElement | Message payload |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations | |
modifierExtension | ?!∑ | 0..* | Extension | Extensions that cannot be ignored |
content[x] | ∑ | 1..1 | string, Attachment, Reference(Resource) | Message part content |
medium | 0..* | CodeableConcept | A channel of communication Binding: QICore Communication Medium Codes (example) | |
requester | 0..1 | Reference(Profile qicore-patient | Profile qicore-practitioner | Profile qicore-relatedperson) | An individual who requested a communication | |
status | ?!S | 0..1 | code | proposed | planned | requested | received | accepted | in-progress | completed | suspended | rejected | failed Binding: CommunicationRequestStatus (required) |
encounter | S | 0..1 | Reference(Profile qicore-encounter) | Encounter leading to message |
scheduled[x] | 0..1 | dateTime, Period | When scheduled | |
reason | 0..* | CodeableConcept | Indication for message Binding: v3 Code System ActReason (example) | |
requestedOn | S | 0..1 | dateTime | When ordered or proposed |
subject | S | 0..1 | Reference(Patient) | Focus of message |
priority | ∑ | 0..1 | CodeableConcept | Message urgency Binding: RequestPriority (example) |
Documentation for this format |
yet to be done: Xml template
yet to be done: Json template
This structure is derived from StructureDefinition.
Summary
Must-Support: 7 elements
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Differential View
This structure is derived from StructureDefinition.
Snapshot View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
CommunicationRequest | I | 0..* | A request for information to be sent to a receiver dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-1: If the resource is contained in another resource, it SHALL NOT contain any narrative dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource | |
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: Common Languages (extensible) | |
text | I | 0..1 | Narrative | Text summary of the resource, for human interpretation |
contained | 0..* | Resource | Contained, inline Resources | |
communicationrequest-reasonRejected | I | 0..1 | CodeableConcept | Extension URL: http://hl7.org/fhir/StructureDefinition/communicationrequest-reasonRejected Binding: Communication reason not performed codes (example) ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
identifier | ∑ | 0..* | Identifier | Unique identifier |
category | S | 0..1 | CodeableConcept | Message category Binding: (unbound) (example) |
sender | S | 0..1 | Reference(Profile qicore-practitioner | Profile qicore-patient | Profile qicore-device | Profile qicore-relatedperson | Profile qicore-organization) | Message sender |
recipient | S | 0..* | Reference(Profile qicore-practitioner | Profile qicore-patient | Profile qicore-device | Profile qicore-relatedperson | Profile qicore-organization) | Message recipient |
payload | ∑ | 0..* | BackboneElement | Message payload |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations | |
modifierExtension | ?!∑ | 0..* | Extension | Extensions that cannot be ignored |
content[x] | ∑ | 1..1 | string, Attachment, Reference(Resource) | Message part content |
medium | 0..* | CodeableConcept | A channel of communication Binding: QICore Communication Medium Codes (example) | |
requester | 0..1 | Reference(Profile qicore-patient | Profile qicore-practitioner | Profile qicore-relatedperson) | An individual who requested a communication | |
status | ?!S | 0..1 | code | proposed | planned | requested | received | accepted | in-progress | completed | suspended | rejected | failed Binding: CommunicationRequestStatus (required) |
encounter | S | 0..1 | Reference(Profile qicore-encounter) | Encounter leading to message |
scheduled[x] | 0..1 | dateTime, Period | When scheduled | |
reason | 0..* | CodeableConcept | Indication for message Binding: v3 Code System ActReason (example) | |
requestedOn | S | 0..1 | dateTime | When ordered or proposed |
subject | S | 0..1 | Reference(Patient) | Focus of message |
priority | ∑ | 0..1 | CodeableConcept | Message urgency Binding: RequestPriority (example) |
Documentation for this format |
XML Template
yet to be done: Xml template
JSON Template
yet to be done: Json template
Path | Name | Conformance | ValueSet |
CommunicationRequest.language | Common Languages | extensible | Common Languages |
CommunicationRequest.extension http://hl7.org/fhir/StructureDefinition/communicationrequest-reasonRejected | Communication reason not performed codes | example | Communication reason not performed codes |
CommunicationRequest.category | ?ext | example | |
CommunicationRequest.medium | QICore Communication Medium Codes | example | QICore Communication Medium Codes |
CommunicationRequest.status | CommunicationRequestStatus | required | CommunicationRequestStatus |
CommunicationRequest.reason | v3 Code System ActReason | example | v3 Code System ActReason |
CommunicationRequest.priority | RequestPriority | example | RequestPriority |
Id | Path | Details | Requirements |
dom-2 | CommunicationRequest | If the resource is contained in another resource, it SHALL NOT contain nested Resources XPath: not(parent::f:contained and f:contained) | |
dom-1 | CommunicationRequest | If the resource is contained in another resource, it SHALL NOT contain any narrative XPath: not(parent::f:contained and f:text) | |
dom-4 | CommunicationRequest | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated XPath: not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated)) | |
dom-3 | CommunicationRequest | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource XPath: not(exists(for $id in f:contained/*/@id return $id[not(ancestor::f:contained/parent::*/descendant::f:reference/@value=concat('#', $id))])) | |
ele-1 | CommunicationRequest.extension | All FHIR elements must have a @value or children XPath: @value|f:*|h:div | |
ext-1 | CommunicationRequest.extension | Must have either extensions or value[x], not both XPath: exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')]) |