0.3.0 - Second STU ballot

This page is part of a downloaded copy of this specification. This page is part of the Da Vinci Coverage Requirements Discovery (CRD) FHIR IG (v0.3.0: STU 1 Ballot 2) based on FHIR R4. . For a full list of available versions, see the Directory of published versions

## StructureDefinition: CommunicationRequestR4

The official URL for this profile is:

    http://hl7.org/fhir/us/davinci-crd/StructureDefinition/profile-communicationrequest-r4

### Formal Views of Profile Content

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

- Text Summary
- Differential Table
- Snapshot Table
- All

This structure is derived from CommunicationRequest

Summary

Mandatory: 5 elements
Must-Support: 11 elements
Fixed Value: 1 element
Prohibited: 1 element

Structures

This structure refers to these other structures:

- http://hl7.org/fhir/us/davinci-crd/StructureDefinition/profile-communicationrequest-r4
- http://hl7.org/fhir/us/davinci-crd/StructureDefinition/profile-patient-r4
- http://hl7.org/fhir/us/davinci-crd/StructureDefinition/profile-encounter-r4
- http://hl7.org/fhir/us/davinci-crd/StructureDefinition/profile-practitioner-r4
- http://hl7.org/fhir/us/core/StructureDefinition/us-core-condition

This structure is derived from CommunicationRequest

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
CommunicationRequest |  | 0..* |  |
identifier | S | 0..* | Identifier |
basedOn | S | 1..1 | Reference(Resource) |
replaces |  | 0..* | Reference(CommunicationRequestR4) |
groupIdentifier |  | 0..1 | Identifier |
status | S | 1..1 | code | Fixed Value: draft
statusReason |  | 0..1 | CodeableConcept |
category |  | 0..* | CodeableConcept |
priority |  | 0..1 | code |
doNotPerform |  | 0..0 |  |
medium |  | 0..* | CodeableConcept |
subject | S | 1..1 | Reference(PatientR4) |
about |  | 0..* | Reference(Resource) |
encounter |  | 0..1 | Reference(EncounterR4) |
payload |  | 0..* | BackboneElement |
occurrence[x] | S | 0..1 | dateTime, Period |
authoredOn | S | 1..1 | dateTime |
requester | S | 1..1 | Reference(PractitionerR4 | US Core PractitionerRole Profile) |
recipient | S | 0..* | Reference(PractitionerR4 | US Core PractitionerRole Profile) |
sender | S | 0..1 | Reference(PractitionerR4 | US Core PractitionerRole Profile) |
reasonCode | S | 0..* | CodeableConcept |
reasonReference | S | 0..* | Reference(US Core Condition Profile | US Core Result Observation Profile) |
note |  | 0..* | Annotation |
Documentation for this format

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 | Additional content defined by implementations
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored
identifier | S Σ | 0..* | Identifier | Unique identifier
basedOn | S Σ | 1..1 | Reference(Resource) | Fulfills plan or proposal
replaces | Σ | 0..* | Reference(CommunicationRequestR4) | 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) Fixed Value: draft
statusReason |  | 0..1 | CodeableConcept | Reason for current status Binding: (unbound) (example)
category |  | 0..* | CodeableConcept | Message category Binding: CommunicationCategory (example)
priority | Σ | 0..1 | code | Message urgency Binding: RequestPriority (required)
medium |  | 0..* | CodeableConcept | A channel of communication Binding: v3 Code System ParticipationMode (example)
subject | S | 1..1 | Reference(PatientR4) | Focus of message
about |  | 0..* | Reference(Resource) | Resources that pertain to this communication request
encounter | Σ | 0..1 | Reference(EncounterR4) | 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 | string, Attachment, Reference(Resource) | Message part content
occurrence[x] | S Σ | 0..1 | dateTime, Period | When scheduled
authoredOn | S Σ | 1..1 | dateTime | When request transitioned to being actionable
requester | S Σ | 1..1 | Reference(PractitionerR4 | US Core PractitionerRole Profile) | Who/what is requesting service
recipient | S | 0..* | Reference(PractitionerR4 | US Core PractitionerRole Profile) | Message recipient
sender | S Σ | 0..1 | Reference(PractitionerR4 | US Core PractitionerRole Profile) | Message sender
reasonCode | S Σ | 0..* | CodeableConcept | Why is communication needed? Binding: v3 Code System ActReason (example)
reasonReference | S Σ | 0..* | Reference(US Core Condition Profile | US Core Result Observation Profile) | Why is communication needed?
note |  | 0..* | Annotation | Comments made about communication request
Documentation for this format

This structure is derived from CommunicationRequest

Summary

Mandatory: 5 elements
Must-Support: 11 elements
Fixed Value: 1 element
Prohibited: 1 element

Structures

This structure refers to these other structures:

- http://hl7.org/fhir/us/davinci-crd/StructureDefinition/profile-communicationrequest-r4
- http://hl7.org/fhir/us/davinci-crd/StructureDefinition/profile-patient-r4
- http://hl7.org/fhir/us/davinci-crd/StructureDefinition/profile-encounter-r4
- http://hl7.org/fhir/us/davinci-crd/StructureDefinition/profile-practitioner-r4
- http://hl7.org/fhir/us/core/StructureDefinition/us-core-condition

Differential View

This structure is derived from CommunicationRequest

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
CommunicationRequest |  | 0..* |  |
identifier | S | 0..* | Identifier |
basedOn | S | 1..1 | Reference(Resource) |
replaces |  | 0..* | Reference(CommunicationRequestR4) |
groupIdentifier |  | 0..1 | Identifier |
status | S | 1..1 | code | Fixed Value: draft
statusReason |  | 0..1 | CodeableConcept |
category |  | 0..* | CodeableConcept |
priority |  | 0..1 | code |
doNotPerform |  | 0..0 |  |
medium |  | 0..* | CodeableConcept |
subject | S | 1..1 | Reference(PatientR4) |
about |  | 0..* | Reference(Resource) |
encounter |  | 0..1 | Reference(EncounterR4) |
payload |  | 0..* | BackboneElement |
occurrence[x] | S | 0..1 | dateTime, Period |
authoredOn | S | 1..1 | dateTime |
requester | S | 1..1 | Reference(PractitionerR4 | US Core PractitionerRole Profile) |
recipient | S | 0..* | Reference(PractitionerR4 | US Core PractitionerRole Profile) |
sender | S | 0..1 | Reference(PractitionerR4 | US Core PractitionerRole Profile) |
reasonCode | S | 0..* | CodeableConcept |
reasonReference | S | 0..* | Reference(US Core Condition Profile | US Core Result Observation Profile) |
note |  | 0..* | Annotation |
Documentation for this format

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 | Additional content defined by implementations
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored
identifier | S Σ | 0..* | Identifier | Unique identifier
basedOn | S Σ | 1..1 | Reference(Resource) | Fulfills plan or proposal
replaces | Σ | 0..* | Reference(CommunicationRequestR4) | 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) Fixed Value: draft
statusReason |  | 0..1 | CodeableConcept | Reason for current status Binding: (unbound) (example)
category |  | 0..* | CodeableConcept | Message category Binding: CommunicationCategory (example)
priority | Σ | 0..1 | code | Message urgency Binding: RequestPriority (required)
medium |  | 0..* | CodeableConcept | A channel of communication Binding: v3 Code System ParticipationMode (example)
subject | S | 1..1 | Reference(PatientR4) | Focus of message
about |  | 0..* | Reference(Resource) | Resources that pertain to this communication request
encounter | Σ | 0..1 | Reference(EncounterR4) | 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 | string, Attachment, Reference(Resource) | Message part content
occurrence[x] | S Σ | 0..1 | dateTime, Period | When scheduled
authoredOn | S Σ | 1..1 | dateTime | When request transitioned to being actionable
requester | S Σ | 1..1 | Reference(PractitionerR4 | US Core PractitionerRole Profile) | Who/what is requesting service
recipient | S | 0..* | Reference(PractitionerR4 | US Core PractitionerRole Profile) | Message recipient
sender | S Σ | 0..1 | Reference(PractitionerR4 | US Core PractitionerRole Profile) | Message sender
reasonCode | S Σ | 0..* | CodeableConcept | Why is communication needed? Binding: v3 Code System ActReason (example)
reasonReference | S Σ | 0..* | Reference(US Core Condition Profile | US Core Result Observation Profile) | Why is communication needed?
note |  | 0..* | Annotation | Comments made about communication request
Documentation for this format

Other representations of profile: Schematron

### Terminology Bindings

Path | Conformance | ValueSet / Code
CommunicationRequest.status | required | Fixed Value: draft
CommunicationRequest.reasonCode | example | v3.ActReason

### Constraints

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.payload | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |