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: CommunicationRequestSTU3

The official URL for this profile is:

    http://hl7.org/fhir/us/davinci-crd/STU3/StructureDefinition/profile-communicationreq-stu3

### 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: 10 elements
Fixed Value: 1 element

Structures

This structure refers to these other structures:

- http://hl7.org/fhir/us/davinci-crd/STU3/StructureDefinition/profile-communicationreq-stu3
- http://hl7.org/fhir/us/davinci-crd/STU3/StructureDefinition/profile-patient-stu3
- http://hl7.org/fhir/us/davinci-crd/STU3/StructureDefinition/profile-practitioner-stu3
- http://hl7.org/fhir/us/davinci-crd/STU3/StructureDefinition/profile-encounter-stu3
- 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(CommunicationRequestSTU3) |
groupIdentifier |  | 0..1 | Identifier |
status | S | 1..1 | code | Fixed Value: draft
category |  | 0..* | CodeableConcept |
priority |  | 0..1 | code |
medium |  | 0..* | CodeableConcept |
subject | S | 1..1 | Reference(PatientSTU3) |
recipient | S | 0..* | Reference(PractitionerSTU3) |
topic |  | 0..* | Reference(Resource) |
context |  | 0..1 | Reference(EncounterSTU3) |
payload |  | 0..* | BackboneElement |
occurrence[x] | S | 0..1 | dateTime, Period |
authoredOn | S | 1..1 | dateTime |
sender | S | 0..1 | Reference(PractitionerSTU3) |
requester |  | 1..1 | BackboneElement |
agent | S | 1..1 | Reference(PractitionerSTU3) |
onBehalfOf |  | 0..1 | Reference(Organization) |
reasonCode | S | 0..* | CodeableConcept |
reasonReference |  | 0..* | Reference(US Core Condition Profile | US Core Result Observation) |
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: Common Languages (extensible) Max Binding: All Languages
text | I | 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(CommunicationRequestSTU3) | 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
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: ParticipationMode (example)
subject | S | 1..1 | Reference(PatientSTU3) | Focus of message
recipient | S | 0..* | Reference(PractitionerSTU3) | Message recipient
topic |  | 0..* | Reference(Resource) | Focal resources
context | Σ | 0..1 | Reference(EncounterSTU3) | Encounter or episode leading to message
payload | I | 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
occurrence[x] | S Σ | 0..1 | dateTime, Period | When scheduled
authoredOn | S Σ | 1..1 | dateTime | When request transitioned to being actionable
sender | S | 0..1 | Reference(PractitionerSTU3) | Message sender
requester | Σ I | 1..1 | BackboneElement | Who/what is requesting service
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
agent | S Σ | 1..1 | Reference(PractitionerSTU3) | Individual making the request
onBehalfOf | Σ I | 0..1 | Reference(Organization) | Organization agent is acting for
reasonCode | S Σ | 0..* | CodeableConcept | Why is communication needed? Binding: ActReason (example)
reasonReference | Σ | 0..* | Reference(US Core Condition Profile | US Core Result Observation) | 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: 10 elements
Fixed Value: 1 element

Structures

This structure refers to these other structures:

- http://hl7.org/fhir/us/davinci-crd/STU3/StructureDefinition/profile-communicationreq-stu3
- http://hl7.org/fhir/us/davinci-crd/STU3/StructureDefinition/profile-patient-stu3
- http://hl7.org/fhir/us/davinci-crd/STU3/StructureDefinition/profile-practitioner-stu3
- http://hl7.org/fhir/us/davinci-crd/STU3/StructureDefinition/profile-encounter-stu3
- 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(CommunicationRequestSTU3) |
groupIdentifier |  | 0..1 | Identifier |
status | S | 1..1 | code | Fixed Value: draft
category |  | 0..* | CodeableConcept |
priority |  | 0..1 | code |
medium |  | 0..* | CodeableConcept |
subject | S | 1..1 | Reference(PatientSTU3) |
recipient | S | 0..* | Reference(PractitionerSTU3) |
topic |  | 0..* | Reference(Resource) |
context |  | 0..1 | Reference(EncounterSTU3) |
payload |  | 0..* | BackboneElement |
occurrence[x] | S | 0..1 | dateTime, Period |
authoredOn | S | 1..1 | dateTime |
sender | S | 0..1 | Reference(PractitionerSTU3) |
requester |  | 1..1 | BackboneElement |
agent | S | 1..1 | Reference(PractitionerSTU3) |
onBehalfOf |  | 0..1 | Reference(Organization) |
reasonCode | S | 0..* | CodeableConcept |
reasonReference |  | 0..* | Reference(US Core Condition Profile | US Core Result Observation) |
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: Common Languages (extensible) Max Binding: All Languages
text | I | 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(CommunicationRequestSTU3) | 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
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: ParticipationMode (example)
subject | S | 1..1 | Reference(PatientSTU3) | Focus of message
recipient | S | 0..* | Reference(PractitionerSTU3) | Message recipient
topic |  | 0..* | Reference(Resource) | Focal resources
context | Σ | 0..1 | Reference(EncounterSTU3) | Encounter or episode leading to message
payload | I | 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
occurrence[x] | S Σ | 0..1 | dateTime, Period | When scheduled
authoredOn | S Σ | 1..1 | dateTime | When request transitioned to being actionable
sender | S | 0..1 | Reference(PractitionerSTU3) | Message sender
requester | Σ I | 1..1 | BackboneElement | Who/what is requesting service
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
agent | S Σ | 1..1 | Reference(PractitionerSTU3) | Individual making the request
onBehalfOf | Σ I | 0..1 | Reference(Organization) | Organization agent is acting for
reasonCode | S Σ | 0..* | CodeableConcept | Why is communication needed? Binding: ActReason (example)
reasonReference | Σ | 0..* | Reference(US Core Condition Profile | US Core Result Observation) | 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 Code System 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-1 | CommunicationRequest | If the resource is contained in another resource, it SHALL NOT contain any narrative : contained.text.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 : contained.where(('#'+id in %resource.descendants().reference).not()).empty() |
ele-1 | CommunicationRequest.payload | All FHIR elements must have a @value or children : hasValue() | (children().count() > id.count()) |
ele-1 | CommunicationRequest.requester | All FHIR elements must have a @value or children : hasValue() | (children().count() > id.count()) |
cmr-1 | CommunicationRequest.requester | onBehalfOf can only be specified if agent is practitioner or device : (agent.resolve() is Practitioner) or (agent.resolve() is Device) or onBehalfOf.exists().not() |