Skip to content

Communication Delivery Address Extension

Canonicalhttps://fhir.apps.health/StructureDefinition/nexus-communication-delivery-address
Statusdraft · 1.33.0
BaseExtension (constraint)
ContextCommunication (element)
SourceFSH · JSON

The fax number, mobile number or email address an outbound delivery was actually sent to, as dialled or addressed at the time of sending.

FSH

The authored source of truth: extensions/CommunicationDeliveryExtensions.fsh (edit on GitHub). One FSH file may define several related artifacts.

// CommunicationDeliveryExtensions.fsh
// Facts about an OUTBOUND DELIVERY -- a fax, SMS or email this platform transmitted to one
// recipient -- that R4 Communication has no element for. Each is declared on Communication and is
// meaningful only on a Communication carrying the `outbound-delivery` category
// (CodeSystem-nexus-communication-category.fsh); the Communication profile states the rules.
//
// 1. THE ADDRESS ACTUALLY USED (the rule is in the extension's Description). A fax is a disclosure
//    the clinic has to be able to account for, so "which number did this go to" is answered from
//    the delivery record itself.
//
//    ONE HOME. The address lives only in this extension. The request to send held it in a
//    contained Organization (one per recipient), but the request is not stored: each send copies
//    the address here, and this is where it is kept.
//
// 2. THE PAGE COUNT, as the delivery service reported it. unsignedInt rather than positiveInt: the
//    count is pages TRANSMITTED, and a fax that failed before its first page reports 0, which is a
//    fact worth keeping rather than a value to reject.
//
// 3. RETIRED: THE ATTEMPT A RESEND REPEATS. A resend names the attempt it repeats in
//    `Communication.basedOn`, which on an outbound delivery means that and nothing else: a first
//    send carries no `basedOn`, because the request it was sent from is not stored. The
//    `nexus-communication-resend-of` extension below is retired and kept only because a canonical,
//    once published, is never reused or removed. Do not write it.

Extension: NexusCommunicationDeliveryAddress
Id: nexus-communication-delivery-address
Title: "Communication Delivery Address Extension"
Description: """
The fax number, mobile number or email address an outbound delivery was actually sent to, as
dialled or addressed at the time of sending.

Required on every Communication carrying the `outbound-delivery` category, whether or not
`recipient` also references a Practitioner or Organization: that resource's contact details can
change after the send, and this records where the message went. A fax to a bare number with no
resource behind it carries this extension and a `recipient` whose `display` is the number.

`system` says what kind of address it is (`fax`, `sms` or `email`) and `value` carries it
as sent. It is not normalised: a reader comparing addresses must normalise both sides.
"""
* ^url = "https://fhir.apps.health/StructureDefinition/nexus-communication-delivery-address"
* ^status = #draft
* ^context[+].type = #element
* ^context[=].expression = "Communication"
* value[x] 1..1 MS
* value[x] only ContactPoint
* valueContactPoint.system 1..1 MS
* valueContactPoint.value 1..1 MS

Extension: NexusCommunicationPageCount
Id: nexus-communication-page-count
Title: "Communication Page Count Extension"
Description: """
How many pages of an outbound fax the delivery service reports it transmitted. A count of pages
transmitted, not of pages in the document: a fax that failed partway reports the pages that went,
and one that failed before its first page reports `0`. Absent means the service has not reported a
count, not that none were sent.
"""
* ^url = "https://fhir.apps.health/StructureDefinition/nexus-communication-page-count"
* ^status = #draft
* ^context[+].type = #element
* ^context[=].expression = "Communication"
* value[x] 1..1 MS
* value[x] only unsignedInt

Extension: NexusCommunicationResendOf
Id: nexus-communication-resend-of
Title: "Communication Resend Of Extension"
Description: """
RETIRED. Do not write this extension.

A resend names the earlier outbound delivery it repeats in `Communication.basedOn` (see the
Communication profile), and the Communication profile no longer declares this extension.

It meant the earlier outbound delivery this one repeats. It is kept, retired, because a published
canonical is never removed or reused.
"""
* ^url = "https://fhir.apps.health/StructureDefinition/nexus-communication-resend-of"
* ^status = #retired
* ^context[+].type = #element
* ^context[=].expression = "Communication"
* value[x] 1..1 MS
* value[x] only Reference(NexusEmrCoreCommunication)


// 4. THE SUBJECT OF A REQUESTED EMAIL. CommunicationRequest has no `topic` (R4 or R5) and no
//    published extension supplies one. The fact lands in `Communication.topic.text`, which R4
//    defines as the subject line, so this extension exists only to carry it on the request.

Extension: NexusCommunicationEmailSubject
Id: nexus-communication-email-subject
Title: "Communication Email Subject Extension"
Description: """
The subject line of an email a CommunicationRequest asks to be sent. Meaningful only when the
request's `medium` includes email (ParticipationMode `EMAILWRIT`); a request for fax or SMS alone
does not carry it.

It maps to `Communication.topic.text`: the Communication written for the email send carries the
same text there. The body stays in `payload`.
"""
* ^url = "https://fhir.apps.health/StructureDefinition/nexus-communication-email-subject"
* ^status = #draft
* ^context[+].type = #element
* ^context[=].expression = "CommunicationRequest"
* value[x] 1..1 MS
* value[x] only string