Requisition Form Answers Extension¶
| Canonical | ../StructureDefinition/nexus-requisition-answers |
|---|---|
| Status | draft · 1.26.0 |
| Base | Extension (constraint) |
| Context | ServiceRequest (element) |
| Source | FSH · JSON |
The keyed answers written onto a laboratory requisition: the dependent inputs printed beside individual boxes, the check-one category choices, and the insured / uninsured billing choices.
Elements / Details
Every element this profile touches, with its full definition. Element names in the tables link here.
Extension¶
| Short | The keyed answers written onto the requisition form |
|---|---|
| Definition | The keyed answers written onto a laboratory requisition: the dependent inputs printed beside
individual boxes, the check-one category choices, and the insured / uninsured billing choices.
One keyed list, not three shapes. Every entry is "an answer written on the form", and its key
says which question it answers. A consumer learns one shape and reads all three kinds.
Why not a QuestionnaireResponse. Not because of separability -- a CONTAINED
QuestionnaireResponse has no independent identity, cannot be deleted or versioned on its own, and
travels with its parent, which is exactly the inseparability a requisition needs. The reason is that
there is no Questionnaire for it to reference: this guide does not enumerate the provincial form's
keys, so a response would carry the same opaque keys with its questionnaire element empty, and a
response with no questionnaire cannot be interpreted beyond its own display text. What the contained
shape would genuinely buy is TYPED answers -- a category: index would be an integer rather than a
decimal held as a string -- and that gain is real. Publishing a Questionnaire for the form is what
would change this answer.
### Reading a key
A key is a prefix naming the kind of question, followed by the form's own identifier for the
specific input, category or billing choice:
| prefix | what the answer answers | what the value holds |
|---|---|---|
| mod: | a dependent input printed beside a single box | the text typed onto the ruled line, or the option circled |
| category: | a section's check-one category | a decimal index into the printed option list, as a string |
| billing: | a section's insured / uninsured choice | the chosen option's value |
The identifiers after the prefix are the form's own and are not enumerated here. They belong to
a particular revision of a particular provincial requisition, which is republished on its own
cadence; a copy inside this specification would be a snapshot that starts drifting the day it is
written. A consumer should treat an unrecognised key as an answer to a question it does not render,
and must not fail on one.
Values are strings, including the numeric one. A category: value is a positional index, held
as a decimal string, and it is meaningful only against the form revision that produced it. It is
not a code and must not be read as one.
An empty list is not written. A producer emits the extension only when at least one answer
carries both a key and a value, so a stored entry is never blank.
At most one, on the order only. The answers are not echoed onto the DiagnosticReport the
requisition eventually produces. |
| 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:answer¶
| Short | One answer written on the form: which question, and what was put |
|---|---|
| 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 | Repeats once per answered question. Order is not significant -- a consumer selects by key rather than by position. |
| Cardinality | 1..* |
| Type | Extension |
| Must Support | yes |
| Invariants | ele-1, ext-1 |
| Also called | extensions, user content |
Extension.extension:answer.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:answer.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:answer.extension:key¶
| Short | Which question -- a mod: / category: / billing: prefix, then the form's own identifier |
|---|---|
| Definition | The question this answer answers. A prefix naming the kind of question (mod: for a dependent input printed beside a box, category: for a section's check-one choice, billing: for a section's insured / uninsured choice) followed by the form's own identifier for that input, category or choice. Those identifiers are specific to a revision of the provincial requisition form and are not enumerated by this guide. A consumer must tolerate a key it does not recognise. |
| 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:answer.extension:key.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:answer.extension:key.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:answer.extension:key.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 | key |
Extension.extension:answer.extension:key.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:answer.extension:value¶
| Short | What was answered -- always a string, even where it holds a number |
|---|---|
| Definition | The answer as stored. For a mod: key it is the text typed onto the form's ruled line or the option circled. For a billing: key it is the chosen option's value. For a category: key it is a decimal index into the section's printed option list, held as a string: that index is positional and is meaningful only against the form revision that produced it, so it is not a code and must not be read as one. |
| 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:answer.extension:value.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:answer.extension:value.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:answer.extension:value.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 | value |
Extension.extension:answer.extension:value.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:answer.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 | answer |
Extension.extension:answer.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 |
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/nexus-requisition-answers |
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 |