Communication Request Profile¶
| Canonical | https://fhir.apps.health/StructureDefinition/nexus-core-communicationrequest |
|---|---|
| Status | draft · 1.33.0 |
| Base | CommunicationRequest (constraint) |
| Source | FSH · JSON |
The request a client submits to send one message by fax, SMS or email: to which recipients, by which channel and sending account, and what to send. It is the input to the message exchange service's $send-message operation, validated against this profile and not stored. Each send is recorded as an outbound-delivery Communication. One channel, or fax with email. Recipients are contained Organizations holding the name and address to use. First pass.
Elements / Key elements
The working view: must-support, required, modifier and sliced elements from the effective (snapshot) definition.
| Element | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| CommunicationRequest | 0..* | Nexus EMR request to send a fax, SMS or email Invariants: dom-2, dom-3, dom-4, dom-5, dom-6, nexus-note-extension-not-where-native, nexus-commreq-status, nexus-commreq-channels, nexus-commreq-recipient-contained, nexus-commreq-recipient-named, nexus-commreq-address-matches-medium, nexus-commreq-one-address-per-channel, nexus-commreq-channel-has-addressee, nexus-commreq-email-subject, nexus-commreq-fax-document, nexus-commreq-email-body, nexus-commreq-sms-text |
||
| implicitRules | ?! | 0..0 | uri | A set of rules under which this content was created i Invariants: ele-1 |
| contained | S | 1..* | Organization | The recipients: one Organization each, with a name and the address to use i |
| extension:emailSubject | S | 0..1 | Extension(Communication Email Subject Extension) | The subject line of the email i Invariants: ele-1, ext-1 |
| status | S ?! | 1..1 | code | active i Binding: request-status ( required)Invariants: ele-1 |
| doNotPerform | ?! | 0..0 | boolean | True if request is prohibiting action i Invariants: ele-1 |
| medium | S | 1..2 | CodeableConcept | One entry per channel: the kind (FAXWRIT | EMAILWRIT | SMSWRIT) and the account that sends it i Binding: v3-ParticipationMode ( example)Invariants: ele-1 |
| coding | 2..* | Coding | Code defined by a terminology system i Slicing: value:system (closed) Invariants: ele-1 |
|
| coding:kind | S | 1..1 | Coding | FAXWRIT | EMAILWRIT | SMSWRIT i Binding: Communication Medium Value Set ( required)e.g. FAXWRIT · EMAILWRIT · SMSWRITInvariants: ele-1 |
| system | 1..1 | uri | Identity of the terminology system i Pattern: http://terminology.hl7.org/CodeSystem/v3-ParticipationModeInvariants: ele-1 |
|
| code | 1..1 | code | Symbol in syntax defined by the system Invariants: ele-1 |
|
| coding:integration | S | 1..1 | Coding | The clinic sending account that carries this channel i Invariants: ele-1 |
| system | 1..1 | uri | Identity of the terminology system i Pattern: https://fhir.apps.health/CodeSystem/nexus-message-integrationInvariants: ele-1 |
|
| code | 1..1 | code | Symbol in syntax defined by the system Invariants: ele-1 |
|
| subject | S | 0..1 | Reference(Patient Profile) | The patient the message is about i Invariants: ele-1 |
| payload | S | 1..* | BackboneElement | What to send i Invariants: ele-1 |
| content[x] | 1..1 | string, Reference(DocumentReference) | Message part content Invariants: ele-1 |
|
| recipient | S | 1..* | Reference(Organization) | A local reference to a contained recipient i Invariants: ele-1 |
| display | S | 1..1 | string | Text alternative for the resource i Invariants: ele-1 |