Report Recipient Extension¶
| Canonical | https://fhir.apps.health/StructureDefinition/nexus-report-recipient |
|---|---|
| Status | draft · 1.33.0 |
| Base | Extension (constraint) |
| Context | DiagnosticReport (element), DocumentReference (element) |
| Source | FSH · JSON |
Who a received report was addressed to, as the sender stated it: one repeat per recipient, each naming the recipient and whether they were the primary recipient or were copied.
FSH
The authored source of truth: extensions/ReportRecipientExtension.fsh (edit on GitHub). One FSH file may define several related artifacts.
// ReportRecipientExtension.fsh
// Who a received report was addressed to: the primary recipient, and anyone copied.
//
// WHY AN EXTENSION. R4 gives neither `DiagnosticReport` nor `DocumentReference` an element for the
// people a report was sent to, and R5 adds none. `Communication.recipient` is the only native
// recipient in FHIR, and it belongs to a message, not to the report a reader is holding. A clinic
// sorting its inbox, or a reader asking "was this sent to me, or was I copied?", needs the answer on
// the report itself. No HL7 or national extension carries it for these two resources.
//
// ONE EXTENSION WITH A ROLE, NOT ONE PER ROLE. Ontario Health publishes two recipient extensions,
// one for intended recipients and one for copied participants, at two different canonical bases.
// Neither is contexted on DocumentReference, which is where every received clinical document lands
// in this guide, and the intended-recipient one cannot reference a PractitionerRole. So they cannot
// be adopted as they are. Two Nexus extensions mirroring them would make a reader check two URLs to
// answer one question. One extension, typed by role, answers it with one read.
//
// THE ROLE CODES ARE HL7's, AND CDA IS THE PRECEDENT. A CDA document carries its recipients in
// `informationRecipient`, typed `PRCP` (primary information recipient) or `TRC` (tracker: a
// secondary recipient who receives a copy). That is the one international model that puts primary
// and copied recipients on a document, and its two codes are exactly the two roles a received report
// has. No code system is minted.
//
// IDENTIFIER-ONLY REFERENCES ARE EXPECTED. A report is often copied to someone the clinic has no
// record of. The sender names them by licence number, and the receiving clinic cannot resolve that to
// a Practitioner it holds. A reference carrying only an identifier, such as a CPSO number, says who
// the recipient is without inventing a record for them.
//
// A RECIPIENT IS NOT THE RESPONSIBLE PROVIDER. The sender addresses a report to its recipients. The
// clinic makes someone responsible for acting on it, and that is the owner of the report's open
// review Task. The primary recipient usually becomes that owner, but they are two facts and this
// extension records only the first.
Extension: NexusReportRecipient
Id: nexus-report-recipient
Title: "Report Recipient"
Description: """
Who a received report was addressed to, as the sender stated it: one repeat per recipient, each
naming the recipient and whether they were the primary recipient or were copied.
**Roles are HL7 v3 ParticipationType codes.** `PRCP` (primary information recipient) is who the
report was sent to. `TRC` (tracker) is a secondary recipient who receives a copy. These are the two
codes CDA uses on `informationRecipient`, the document-level recipient of a clinical document.
**The recipient may be identifier-only.** A report is often copied to a clinician the receiving
clinic holds no record of. Reference them by identifier alone -- for example a CPSO number under
`https://fhir.infoway-inforoute.ca/NamingSystem/ca-on-license-physician` -- rather than creating a
Practitioner for them.
**Mapping from Ontario sources.** Ontario Health's
`http://ontariohealth.ca/fhir/ehr/StructureDefinition/ext-recipient` and HRM's `DeliverToUserID`
map to `PRCP`. Ontario Health's
`http://ontariohealth.ca/StructureDefinition/oh-ehr-copied-participants-EXT` and an OLIS copy-to
(OBR-28) map to `TRC`.
**A recipient is not the responsible provider.** The clinic provider responsible for acting on a
received report is the owner of its open review Task. See
[Incoming reports](../guide/patterns/incoming-reports.md).
"""
* ^url = "https://fhir.apps.health/StructureDefinition/nexus-report-recipient"
* ^status = #draft
* ^date = "2026-10-19"
* ^publisher = "WELLSTAR Technologies Corp."
* ^contact.name = "Nexus EMR FHIR Implementation Guide"
* ^contact.telecom.system = #url
* ^contact.telecom.value = "https://fhir.apps.health"
* ^jurisdiction = urn:iso:std:iso:3166#CA "Canada"
* ^context[0].type = #element
* ^context[0].expression = "DiagnosticReport"
* ^context[1].type = #element
* ^context[1].expression = "DocumentReference"
* . ^short = "A recipient of the report, primary or copied"
* value[x] 0..0
* url 1..1
* extension contains
recipient 1..1 MS and
type 1..1 MS
* extension[recipient].value[x] only Reference(NexusEmrCorePractitioner or NexusEmrCorePractitionerRole or NexusEmrCoreOrganization)
* extension[recipient] ^short = "Who the report was addressed to (may be identifier-only)"
* extension[recipient] ^definition = "The practitioner, practitioner in a role, or organization the sender addressed the report to. An identifier-only reference -- for example a CPSO number for a recipient the clinic holds no record of -- is permitted and expected."
* extension[type].value[x] only Coding
* extension[type].valueCoding from NexusReportRecipientTypeVS (required)
* extension[type] ^short = "PRCP (primary recipient) | TRC (copied)"
* extension[type] ^definition = "Whether this recipient was the primary recipient of the report (`PRCP`) or a secondary recipient who was copied (`TRC`), from HL7 v3 ParticipationType."
ValueSet: NexusReportRecipientTypeVS
Id: nexus-report-recipient-type
Title: "Report Recipient Type"
Description: "The role of a recipient of a received report, from HL7 v3 ParticipationType: the primary information recipient, or a tracker (a secondary recipient who receives a copy). These are the two codes CDA uses on `informationRecipient`."
* ^url = "https://fhir.apps.health/ValueSet/nexus-report-recipient-type"
* ^status = #draft
* ^experimental = false
* http://terminology.hl7.org/CodeSystem/v3-ParticipationType#PRCP "primary information recipient"
* http://terminology.hl7.org/CodeSystem/v3-ParticipationType#TRC "tracker"