Skip to content

Composition EHR Share Extension

Canonical../StructureDefinition/composition-ehr-share
Statusdraft · 1.26.0
BaseExtension (constraint)
ContextComposition (element)
SourceFSH · JSON

One completed share of this signed note to an EHR outside the practice. Repeats: a note shared three times carries three.

Elements / Details

Every element this profile touches, with its full definition. Element names in the tables link here.

Extension

Short Composition EHR Share Extension
Definition One completed share of this signed note to an EHR outside the practice. Repeats: a note shared three times carries three. Completed shares only. A share still in flight is not recorded. This element is read back to patients as a disclosure record, and listing a pending share would tell a patient their record went somewhere it has not yet gone. The destination is a string, not Reference(Organization). It is routinely an external system with no Organization in this practice's directory, and a reference that cannot resolve is worse than a name that can be read. FIRST PASS. This extension is declared from its production shape rather than from a modelling pass. See the file comment for the canonical it publishes under and why that is not the URL the software writes today. MIGRATION. Nexus EMR writes this extension today at http://services.well.com/fhir/StructureDefinition/composition-ehr-share. That address is live in stored notes and in code, and is under migration to the canonical declared here (FHIR-370). Write the canonical; when reading, match on the URL suffix composition-ehr-share so that notes filed under either address are seen.
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 2..*
Type Extension
Invariants ele-1, ext-1
Also called extensions, user content

Extension.extension:sharedWith

Short The EHR the note was shared with
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..1
Type Extension
Must Support yes
Invariants ele-1, ext-1
Also called extensions, user content

Extension.extension:sharedWith.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:sharedWith.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:sharedWith.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 sharedWith

Extension.extension:sharedWith.value[x]

Short Value of extension
Definition The EHR the note was shared with, named as a string because the destination is routinely external to this practice's directory.
Cardinality 1..1
Type string
Must Support yes
Invariants ele-1

Extension.extension:sharedAt

Short When the share completed
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..1
Type Extension
Must Support yes
Invariants ele-1, ext-1
Also called extensions, user content

Extension.extension:sharedAt.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:sharedAt.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:sharedAt.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 sharedAt

Extension.extension:sharedAt.value[x]

Short Value of extension
Definition When the share completed. Required: an undated disclosure cannot be reported to a patient truthfully.
Cardinality 1..1
Type dateTime
Must Support yes
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 ../StructureDefinition/composition-ehr-share

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