Form Template Field Mapping Extension¶
| Canonical | ../StructureDefinition/nexus-form-template-field-mapping |
|---|---|
| Status | draft · 1.26.0 |
| Base | Extension (constraint) |
| Context | DocumentReference (element) |
| Source | FSH · JSON |
Which fillable fields of a form template's file a chart value pre-fills. One rule per field:
the field's name in the file, verbatim, and the chart value that fills it, coded from the
form chart value vocabulary (patient.lastName, patient.birthDate.year, patient.address.city,
...). A form started from the template opens with each mapped field filled from the patient's
chart and every value still editable; a field the mapping does not name, or whose chart value
cannot be resolved, is left blank.
Elements / Snapshot
The full effective definition: base Extension with this profile's constraints applied.
| Element | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Extension | 0..* | Which fillable fields of the template's file a chart value or a fixed value pre-fills, as the default fill template and any named ones Invariants: ele-1, ext-1, form-template-field-mapping-field-is-substantive, form-template-field-mapping-fields-are-distinct, form-template-field-mapping-rule-has-one-value, form-template-field-mapping-template-rules-are-well-formed, form-template-field-mapping-template-names-are-distinct |
||
| id | 0..1 | http://hl7.org/fhirpath/System.String | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations i Slicing: value:url (open) Invariants: ele-1, ext-1 |
|
| extension:rule | S | 0..* | Extension | One fillable field of the file and what pre-fills it -- the default fill template's rules i Invariants: ele-1, ext-1 |
| id | 0..1 | http://hl7.org/fhirpath/System.String | Unique id for inter-element referencing | |
| extension | 1..* | Extension | Additional content defined by implementations i Slicing: value:url (open) Invariants: ele-1, ext-1 |
|
| extension:field | S | 1..1 | Extension | The field's name in the file, verbatim (an AcroForm field name; spaces and case kept) i Invariants: ele-1, ext-1 |
| id | 0..1 | http://hl7.org/fhirpath/System.String | Unique id for inter-element referencing | |
| extension | 0..0 | Extension | Additional content defined by implementations i Slicing: value:url (open) Invariants: ele-1, ext-1 |
|
| url | 1..1 | http://hl7.org/fhirpath/System.String | identifies the meaning of the extension i Fixed: field |
|
| value[x] | 0..1 | string | Value of extension Invariants: ele-1 |
|
| extension:chartValue | S | 0..1 | Extension | The chart value that pre-fills the field (patient.firstName, patient.birthDate.year, ...) i Invariants: ele-1, ext-1 |
| id | 0..1 | http://hl7.org/fhirpath/System.String | Unique id for inter-element referencing | |
| extension | 0..0 | Extension | Additional content defined by implementations i Slicing: value:url (open) Invariants: ele-1, ext-1 |
|
| url | 1..1 | http://hl7.org/fhirpath/System.String | identifies the meaning of the extension i Fixed: chartValue |
|
| value[x] | 0..1 | code | Value of extension Binding: Form Chart Values ( extensible)e.g. patient.fullName · patient.firstName · patient.lastName …Invariants: ele-1 |
|
| extension:staticValue | S | 0..1 | Extension | The fixed value that pre-fills the field: text as written, or the export value of the box or option to set i Invariants: ele-1, ext-1 |
| id | 0..1 | http://hl7.org/fhirpath/System.String | Unique id for inter-element referencing | |
| extension | 0..0 | Extension | Additional content defined by implementations i Slicing: value:url (open) Invariants: ele-1, ext-1 |
|
| url | 1..1 | http://hl7.org/fhirpath/System.String | identifies the meaning of the extension i Fixed: staticValue |
|
| value[x] | 0..1 | string | Value of extension Invariants: ele-1 |
|
| url | 1..1 | http://hl7.org/fhirpath/System.String | identifies the meaning of the extension i Fixed: rule |
|
| value[x] | 0..0 | 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 | Value of extension Invariants: ele-1 |
|
| extension:template | S | 0..* | Extension | One named fill template beside the default: its name, and its own rules i Invariants: ele-1, ext-1 |
| id | 0..1 | http://hl7.org/fhirpath/System.String | Unique id for inter-element referencing | |
| extension | 1..* | Extension | Additional content defined by implementations i Slicing: value:url (open) Invariants: ele-1, ext-1 |
|
| extension:name | S | 1..1 | Extension | The fill template's name, as the user gave it i Invariants: ele-1, ext-1 |
| id | 0..1 | http://hl7.org/fhirpath/System.String | Unique id for inter-element referencing | |
| extension | 0..0 | Extension | Additional content defined by implementations i Slicing: value:url (open) Invariants: ele-1, ext-1 |
|
| url | 1..1 | http://hl7.org/fhirpath/System.String | identifies the meaning of the extension i Fixed: name |
|
| value[x] | 0..1 | string | Value of extension Invariants: ele-1 |
|
| extension:rule | S | 0..* | Extension | One fillable field of the file and what pre-fills it, in this fill template i Invariants: ele-1, ext-1 |
| id | 0..1 | http://hl7.org/fhirpath/System.String | Unique id for inter-element referencing | |
| extension | 1..* | Extension | Additional content defined by implementations i Slicing: value:url (open) Invariants: ele-1, ext-1 |
|
| extension:field | S | 1..1 | Extension | The field's name in the file, verbatim i Invariants: ele-1, ext-1 |
| id | 0..1 | http://hl7.org/fhirpath/System.String | Unique id for inter-element referencing | |
| extension | 0..0 | Extension | Additional content defined by implementations i Slicing: value:url (open) Invariants: ele-1, ext-1 |
|
| url | 1..1 | http://hl7.org/fhirpath/System.String | identifies the meaning of the extension i Fixed: field |
|
| value[x] | 0..1 | string | Value of extension Invariants: ele-1 |
|
| extension:chartValue | S | 0..1 | Extension | The chart value that pre-fills the field i Invariants: ele-1, ext-1 |
| id | 0..1 | http://hl7.org/fhirpath/System.String | Unique id for inter-element referencing | |
| extension | 0..0 | Extension | Additional content defined by implementations i Slicing: value:url (open) Invariants: ele-1, ext-1 |
|
| url | 1..1 | http://hl7.org/fhirpath/System.String | identifies the meaning of the extension i Fixed: chartValue |
|
| value[x] | 0..1 | code | Value of extension Binding: Form Chart Values ( extensible)e.g. patient.fullName · patient.firstName · patient.lastName …Invariants: ele-1 |
|
| extension:staticValue | S | 0..1 | Extension | The fixed value that pre-fills the field i Invariants: ele-1, ext-1 |
| id | 0..1 | http://hl7.org/fhirpath/System.String | Unique id for inter-element referencing | |
| extension | 0..0 | Extension | Additional content defined by implementations i Slicing: value:url (open) Invariants: ele-1, ext-1 |
|
| url | 1..1 | http://hl7.org/fhirpath/System.String | identifies the meaning of the extension i Fixed: staticValue |
|
| value[x] | 0..1 | string | Value of extension Invariants: ele-1 |
|
| url | 1..1 | http://hl7.org/fhirpath/System.String | identifies the meaning of the extension i Fixed: rule |
|
| value[x] | 0..0 | 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 | Value of extension Invariants: ele-1 |
|
| url | 1..1 | http://hl7.org/fhirpath/System.String | identifies the meaning of the extension i Fixed: template |
|
| value[x] | 0..0 | 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 | Value of extension Invariants: ele-1 |
|
| url | 1..1 | http://hl7.org/fhirpath/System.String | identifies the meaning of the extension i Fixed: ../StructureDefinition/nexus-form-template-field-mapping |
|
| value[x] | 0..0 | 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 | Value of extension Invariants: ele-1 |