Content Source Extension¶
| Canonical | https://fhir.apps.health/StructureDefinition/nexus-content-source |
|---|---|
| Status | draft · 1.33.0 |
| Base | Extension (constraint) |
| Context | DocumentReference.content (element), DiagnosticReport.presentedForm (element) |
| Source | FSH · JSON |
Origin metadata for the file behind one DocumentReference.content or
DiagnosticReport.presentedForm entry: the system the file was delivered through, the channel, and
when the sender sent it.
Elements / Details
Every element this profile touches, with its full definition. Element names in the tables link here.
Extension¶
| Short | Origin of the file behind this rendition (delivered renditions only) |
|---|---|
| Definition | Origin metadata for the file behind one DocumentReference.content or
DiagnosticReport.presentedForm entry: the system the file was delivered through, the channel, and
when the sender sent it.
On the content entry, not on the resource. A DocumentReference or DiagnosticReport may hold
several renditions of one document and only one of them is the file that arrived; the others are
produced locally. The extension rides the delivered rendition, so derived renditions carry nothing.
source is an opaque token, naming the delivery channel as the receiving pipeline knows it.
HRM -- Ontario Health's Health Report Manager -- is the channel this shape was drawn from and the
value carried in this guide's example. No value set is bound: the set of channels is a deployment
fact, and a binding published here would make a deployment nonconformant the day it adds a feed.
Match the values your deployment produces and pass through the rest.
channel is how the file came: a v3 ParticipationMode code -- FAXWRIT (fax and eFax),
MAILWRIT (mail, including a scan of mailed paper), EMAILWRIT (email) or ELECTRONIC (an
electronic feed such as HRM, Ontario Health's clinical report feed, or a portal). Bound extensible:
where none of the four fits, another code may be used, preferably from ParticipationMode. sent is when the sender sent
it, where the channel says (a fax header, an HRM message, a Bundle timestamp). Both are optional.
Received time is not here: it is DocumentReference.date, or the extensions-pack event-recorded
extension on a DiagnosticReport. See Incoming reports.
⚠ FIRST PASS -- do not treat this as a contract. The extension is published under a canonical
minted for it, so nothing predates it: there is no earlier address for this shape and no legacy
instance to reconcile against. A store holds instances of it from the point a delivery pipeline
starts stamping them, and no sooner. Write source, and channel and sent where the delivery
gives them, on the entry holding the delivered file. |
| Cardinality | 0..* |
| Invariants | ele-1, ext-1 |
Extension.id¶
| Short | Unique id for inter-element referencing |
|---|---|
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
| Cardinality | 0..1 |
| Type | http://hl7.org/fhirpath/System.String |
Extension.extension¶
| Short | Additional content defined by implementations |
|---|---|
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
| Cardinality | 1..* |
| Type | Extension |
| Invariants | ele-1, ext-1 |
| Also called | extensions, user content |
Extension.extension:source¶
| Short | The channel or system the file was delivered through |
|---|---|
| Definition | An opaque token naming the delivery channel or system that produced this file, as the receiving pipeline knows it -- for example HRM, Ontario Health's Health Report Manager. Not bound to a value set: the set of channels a deployment receives from is a deployment fact. It names HOW the file arrived, which is not recoverable from custodian (who holds the document) or author (who wrote it). |
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
| Cardinality | 1..1 |
| Type | Extension |
| Must Support | yes |
| Invariants | ele-1, ext-1 |
| Also called | extensions, user content |
Extension.extension:source.id¶
| Short | Unique id for inter-element referencing |
|---|---|
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
| Cardinality | 0..1 |
| Type | http://hl7.org/fhirpath/System.String |
Extension.extension:source.extension¶
| Short | Additional content defined by implementations |
|---|---|
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
| Cardinality | 0..0 |
| Type | Extension |
| Invariants | ele-1, ext-1 |
| Also called | extensions, user content |
Extension.extension:source.url¶
| Short | identifies the meaning of the extension |
|---|---|
| Definition | Source of the definition for the extension code - a logical name or a URL. |
| Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. |
| Cardinality | 1..1 |
| Type | http://hl7.org/fhirpath/System.String |
| Fixed value | source |
Extension.extension:source.value[x]¶
| Short | Value of extension |
|---|---|
| Definition | Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). |
| Cardinality | 0..1 |
| Type | string |
| Invariants | ele-1 |
Extension.extension:channel¶
| Short | How the file came: FAXWRIT | MAILWRIT | EMAILWRIT | ELECTRONIC |
|---|---|
| Definition | The channel the file was delivered through, as a v3 ParticipationMode code: FAXWRIT for fax and eFax, MAILWRIT for mail (including a scan of mailed paper), EMAILWRIT for email, ELECTRONIC for an electronic feed or portal. The same vocabulary Communication.medium names. Extensible: where none of the four fits, another code may be used, preferably from ParticipationMode. |
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
| Cardinality | 0..1 |
| Type | Extension |
| Must Support | yes |
| Invariants | ele-1, ext-1 |
| Also called | extensions, user content |
Extension.extension:channel.id¶
| Short | Unique id for inter-element referencing |
|---|---|
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
| Cardinality | 0..1 |
| Type | http://hl7.org/fhirpath/System.String |
Extension.extension:channel.extension¶
| Short | Additional content defined by implementations |
|---|---|
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
| Cardinality | 0..0 |
| Type | Extension |
| Invariants | ele-1, ext-1 |
| Also called | extensions, user content |
Extension.extension:channel.url¶
| Short | identifies the meaning of the extension |
|---|---|
| Definition | Source of the definition for the extension code - a logical name or a URL. |
| Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. |
| Cardinality | 1..1 |
| Type | http://hl7.org/fhirpath/System.String |
| Fixed value | channel |
Extension.extension:channel.value[x]¶
| Short | Value of extension |
|---|---|
| Definition | Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). |
| Cardinality | 0..1 |
| Type | Coding |
| Binding | Delivery Channel (extensible) |
| Invariants | ele-1 |
Extension.extension:sent¶
| Short | When the sender sent the file |
|---|---|
| Definition | The sender's transmission time, where the channel gives one: a fax header, an HRM message, a document Bundle's timestamp. Not the received time, which is DocumentReference.date or, on a DiagnosticReport, the event-recorded extension. |
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
| Cardinality | 0..1 |
| Type | Extension |
| Must Support | yes |
| Invariants | ele-1, ext-1 |
| Also called | extensions, user content |
Extension.extension:sent.id¶
| Short | Unique id for inter-element referencing |
|---|---|
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
| Cardinality | 0..1 |
| Type | http://hl7.org/fhirpath/System.String |
Extension.extension:sent.extension¶
| Short | Additional content defined by implementations |
|---|---|
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
| Cardinality | 0..0 |
| Type | Extension |
| Invariants | ele-1, ext-1 |
| Also called | extensions, user content |
Extension.extension:sent.url¶
| Short | identifies the meaning of the extension |
|---|---|
| Definition | Source of the definition for the extension code - a logical name or a URL. |
| Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. |
| Cardinality | 1..1 |
| Type | http://hl7.org/fhirpath/System.String |
| Fixed value | sent |
Extension.extension:sent.value[x]¶
| Short | Value of extension |
|---|---|
| Definition | Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). |
| Cardinality | 0..1 |
| Type | dateTime |
| Invariants | ele-1 |
Extension.url¶
| Short | identifies the meaning of the extension |
|---|---|
| Definition | Source of the definition for the extension code - a logical name or a URL. |
| Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. |
| Cardinality | 1..1 |
| Type | http://hl7.org/fhirpath/System.String |
| Fixed value | https://fhir.apps.health/StructureDefinition/nexus-content-source |
Extension.value[x]¶
| Short | Value of extension |
|---|---|
| Definition | Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). |
| Cardinality | 0..0 |
| Type | base64Binary, boolean, canonical, code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, url, uuid, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference, SampledData, Signature, Timing, ContactDetail, Contributor, DataRequirement, Expression, ParameterDefinition, RelatedArtifact, TriggerDefinition, UsageContext, Dosage, Meta |
| Invariants | ele-1 |