Skip to content

Extraction Evidence Extension

Canonicalhttps://fhir.apps.health/StructureDefinition/nexus-extraction-evidence
Statusdraft (experimental) · 1.33.0
BaseExtension (constraint)
ContextCondition (element), MedicationStatement (element), MedicationRequest (element), AllergyIntolerance (element), Patient (element)
SourceFSH · JSON

The source passage a single extracted field was read from.

Elements / Details

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

Extension

Short One extracted field and the source passage it was read from
Definition The source passage a single extracted field was read from. Repeats, once per field that was extracted onto this resource. Each repeat names the field and carries the verbatim text the value was taken from, so a reader can check one value against the document it came from without re-running the extraction. field is the producer's own name for what was extracted, for example Condition.clinical_status. It is opaque: it is not required to be a resolvable FHIR element path, and a consumer MUST NOT parse it to navigate the resource. text is the passage itself, as it appeared in the source. This grain is deliberately finer than Provenance.entity, which records which documents an extraction read. A consumer that only needs "where did this resource come from" should read Provenance and ignore this extension.
Cardinality 0..*
Invariants ele-1, ext-1, extraction-evidence-is-substantive

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:field

Short The producer's name for the extracted field (opaque; not a navigable path)
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:field.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:field.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:field.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 field

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

Short The source passage the value was read from, verbatim
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:text.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:text.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:text.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 text

Extension.extension:text.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.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-extraction-evidence

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