Composition Note Setup Extension¶
| Canonical | ../StructureDefinition/composition-note-setup |
|---|---|
| Status | draft · 1.26.0 |
| Base | Extension (constraint) |
| Context | Composition (element) |
| Source | FSH · JSON |
The editor setup an encounter note was opened on: the visit type the provider chose, and the template the note started from. Present so that a draft reopens on the footing it was left on rather than as a blank note.
Elements / Details
Every element this profile touches, with its full definition. Element names in the tables link here.
Extension¶
| Short | Composition Note Setup Extension |
|---|---|
| Definition | The editor setup an encounter note was opened on: the visit type the provider chose, and the
template the note started from. Present so that a draft reopens on the footing it was left on
rather than as a blank note.
Both parts or neither. A reader that finds only one of the two has no usable setup -- a
template without its visit type cannot be offered again, and a visit type without its template
does not say what the note started as -- so both sub-extensions are required when the extension is
present. The extension itself is optional and is absent on notes written before it existed.
It records what the note was OPENED FROM, not what it contains. A provider may switch templates
mid-note, delete every heading the template gave, or type their own. The authoritative structure of
a note is always Composition.section; this element is editor state, and a consumer reconstructing
the note's content from the template code rather than from the sections will be wrong.
The two vocabularies are separate systems, and the template one is NOT the stored template
registry. encounter-note-template names the fixed catalogue of note structures compiled into the
application. CodeSystem/nexus-template is a different value space -- the per-tenant slugs of
template List resources, which a letter carries on meta.tag to say which stored template it was
composed from. Both are kebab-case slugs and they are not interchangeable.
Both bindings are extensible, deliberately. Each set is closed in the application today, but a
required binding would make this guide a release gate on the note editor: ship a template and every
note carrying one is nonconformant until the guide cuts a release. A reader that meets an
unrecognised code MUST write it back unchanged; normalising it destroys the record of what the
provider actually started from.
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-note-setup. 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-note-setup 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:visitType¶
| Short | The visit type the note was opened on |
|---|---|
| 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:visitType.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:visitType.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:visitType.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 | visitType |
Extension.extension:visitType.value[x]¶
| Short | Value of extension |
|---|---|
| Definition | The visit type the provider chose before writing, which is what selects the templates offered. It is NOT Encounter.class and makes no claim about the care setting. Required alongside template: a template without its visit type cannot be offered again. |
| Cardinality | 1..1 |
| Type | code |
| Must Support | yes |
| Binding | Encounter Visit Types (extensible) |
| Invariants | ele-1 |
Extension.extension:template¶
| Short | The template the note was opened from |
|---|---|
| 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:template.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:template.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:template.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 | template |
Extension.extension:template.value[x]¶
| Short | Value of extension |
|---|---|
| Definition | The template the note started from, naming a structure in the application's note catalogue -- NOT a slug in the stored template registry that CodeSystem/nexus-template names. It records what the note was opened from and not what it now contains: the authoritative structure is Composition.section. |
| Cardinality | 1..1 |
| Type | code |
| Must Support | yes |
| Binding | Encounter Note Templates (extensible) |
| 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-note-setup |
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 |