Implementation Guide
ePA MHD Service
Version 1.1.1 - release

## Extension: FullTextSearchMatchSnippet - JSON Profile

Active as of 2026-02-18

JSON representation of the ihe-full-text-search-match-snippet extension.

Raw json | Download

    {
      "resourceType" : "StructureDefinition",
      "id" : "ihe-full-text-search-match-snippet",
      "url" : "https://profiles.ihe.net/ITI/MHD/StructureDefinition/ihe-full-text-search-match-snippet",
      "version" : "4.2.4-current",
      "name" : "FullTextSearchMatchSnippet",
      "title" : "Full-Text Search Match Snippet",
      "status" : "active",
      "date" : "2026-02-18T15:27:46+00:00",
      "publisher" : "IHE IT Infrastructure Technical Committee",
      "contact" : [
        {
          "telecom" : [
            {
              "system" : "url",
              "value" : "https://www.ihe.net/ihe_domains/it_infrastructure/"
            }
          ]
        },
        {
          "telecom" : [
            {
              "system" : "email",
              "value" : "iti@ihe.net"
            }
          ]
        },
        {
          "name" : "IHE IT Infrastructure Technical Committee",
          "telecom" : [
            {
              "system" : "email",
              "value" : "iti@ihe.net"
            }
          ]
        }
      ],
      "description" : "This extension contains a text snippet describing the context of a full-text search match. It highlights relevant content that corresponds to the provided search terms and provides a concise preview of the search result.",
      "jurisdiction" : [
        {
          "coding" : [
            {
              "system" : "urn:iso:std:iso:3166",
              "code" : "DE"
            }
          ]
        }
      ],
      "fhirVersion" : "4.0.1",
      "mapping" : [
        {
          "identity" : "rim",
          "uri" : "http://hl7.org/v3",
          "name" : "RIM Mapping"
        }
      ],
      "kind" : "complex-type",
      "abstract" : false,
      "context" : [
        {
          "type" : "element",
          "expression" : "Bundle.entry.search"
        }
      ],
      "type" : "Extension",
      "baseDefinition" : "http://hl7.org/fhir/StructureDefinition/Extension",
      "derivation" : "constraint",
      "snapshot" : {
        "extension" : [
          {
            "url" : "http://hl7.org/fhir/tools/StructureDefinition/snapshot-base-version",
            "valueString" : "4.0.1"
          }
        ],
        "element" : [
          {
            "id" : "Extension",
            "path" : "Extension",
            "short" : "Full-Text Search Match Snippet",
            "definition" : "This extension contains a text snippet describing the context of a full-text search match. It highlights relevant content that corresponds to the provided search terms and provides a concise preview of the search result.",
            "min" : 0,
            "max" : "*",
            "base" : {
              "path" : "Extension",
              "min" : 0,
              "max" : "*"
            },
            "condition" : [
              "ele-1"
            ],
            "constraint" : [
              {
                "key" : "ele-1",
                "severity" : "error",
                "human" : "All FHIR elements must have a @value or children",
                "expression" : "hasValue() or (children().count() > id.count())",
                "xpath" : "@value|f:*|h:div",
                "source" : "http://hl7.org/fhir/StructureDefinition/Element"
              },
              {
                "key" : "ext-1",
                "severity" : "error",
                "human" : "Must have either extensions or value[x], not both",
                "expression" : "extension.exists() != value.exists()",
                "xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])",
                "source" : "http://hl7.org/fhir/StructureDefinition/Extension"
              }
            ],
            "isModifier" : false
          },
          {
            "id" : "Extension.id",
            "path" : "Extension.id",
            "representation" : [
              "xmlAttr"
            ],
            "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.",
            "min" : 0,
            "max" : "1",
            "base" : {
              "path" : "Element.id",
              "min" : 0,
              "max" : "1"
            },
            "type" : [
              {
                "extension" : [
                  {
                    "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
                    "valueUrl" : "string"
                  }
                ],
                "code" : "http://hl7.org/fhirpath/System.String"
              }
            ],
            "isModifier" : false,
            "isSummary" : false,
            "mapping" : [
              {
                "identity" : "rim",
                "map" : "n/a"
              }
            ]
          },
          {
            "id" : "Extension.extension",
            "path" : "Extension.extension",
            "slicing" : {
              "discriminator" : [
                {
                  "type" : "value",
                  "path" : "url"
                }
              ],
              "description" : "Extensions are always sliced by (at least) url",
              "rules" : "closed"
            },
            "short" : "Extension",
            "definition" : "An Extension",
            "min" : 0,
            "max" : "*",
            "base" : {
              "path" : "Element.extension",
              "min" : 0,
              "max" : "*"
            },
            "type" : [
              {
                "code" : "Extension"
              }
            ],
            "constraint" : [
              {
                "key" : "ele-1",
                "severity" : "error",
                "human" : "All FHIR elements must have a @value or children",
                "expression" : "hasValue() or (children().count() > id.count())",
                "xpath" : "@value|f:*|h:div",
                "source" : "http://hl7.org/fhir/StructureDefinition/Element"
              },
              {
                "key" : "ext-1",
                "severity" : "error",
                "human" : "Must have either extensions or value[x], not both",
                "expression" : "extension.exists() != value.exists()",
                "xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
                "source" : "http://hl7.org/fhir/StructureDefinition/Extension"
              }
            ],
            "isModifier" : false,
            "isSummary" : false
          },
          {
            "id" : "Extension.extension:snippet",
            "path" : "Extension.extension",
            "sliceName" : "snippet",
            "short" : "Extension",
            "definition" : "An Extension",
            "min" : 0,
            "max" : "1",
            "base" : {
              "path" : "Element.extension",
              "min" : 0,
              "max" : "*"
            },
            "type" : [
              {
                "code" : "Extension"
              }
            ],
            "constraint" : [
              {
                "key" : "ele-1",
                "severity" : "error",
                "human" : "All FHIR elements must have a @value or children",
                "expression" : "hasValue() or (children().count() > id.count())",
                "xpath" : "@value|f:*|h:div",
                "source" : "http://hl7.org/fhir/StructureDefinition/Element"
              },
              {
                "key" : "ext-1",
                "severity" : "error",
                "human" : "Must have either extensions or value[x], not both",
                "expression" : "extension.exists() != value.exists()",
                "xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
                "source" : "http://hl7.org/fhir/StructureDefinition/Extension"
              }
            ],
            "isModifier" : false,
            "isSummary" : false
          },
          {
            "id" : "Extension.extension:snippet.id",
            "path" : "Extension.extension.id",
            "representation" : [
              "xmlAttr"
            ],
            "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.",
            "min" : 0,
            "max" : "1",
            "base" : {
              "path" : "Element.id",
              "min" : 0,
              "max" : "1"
            },
            "type" : [
              {
                "extension" : [
                  {
                    "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
                    "valueUrl" : "string"
                  }
                ],
                "code" : "http://hl7.org/fhirpath/System.String"
              }
            ],
            "isModifier" : false,
            "isSummary" : false,
            "mapping" : [
              {
                "identity" : "rim",
                "map" : "n/a"
              }
            ]
          },
          {
            "id" : "Extension.extension:snippet.extension",
            "path" : "Extension.extension.extension",
            "slicing" : {
              "discriminator" : [
                {
                  "type" : "value",
                  "path" : "url"
                }
              ],
              "description" : "Extensions are always sliced by (at least) url",
              "rules" : "open"
            },
            "short" : "Extension",
            "definition" : "An Extension",
            "min" : 0,
            "max" : "0",
            "base" : {
              "path" : "Element.extension",
              "min" : 0,
              "max" : "*"
            },
            "type" : [
              {
                "code" : "Extension"
              }
            ],
            "constraint" : [
              {
                "key" : "ele-1",
                "severity" : "error",
                "human" : "All FHIR elements must have a @value or children",
                "expression" : "hasValue() or (children().count() > id.count())",
                "xpath" : "@value|f:*|h:div",
                "source" : "http://hl7.org/fhir/StructureDefinition/Element"
              },
              {
                "key" : "ext-1",
                "severity" : "error",
                "human" : "Must have either extensions or value[x], not both",
                "expression" : "extension.exists() != value.exists()",
                "xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
                "source" : "http://hl7.org/fhir/StructureDefinition/Extension"
              }
            ],
            "isModifier" : false,
            "isSummary" : false
          },
          {
            "id" : "Extension.extension:snippet.url",
            "path" : "Extension.extension.url",
            "representation" : [
              "xmlAttr"
            ],
            "short" : "identifies the meaning of the extension",
            "definition" : "Source of the definition for the extension code - a logical name or a URL.",
            "comment" : "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.",
            "min" : 1,
            "max" : "1",
            "base" : {
              "path" : "Extension.url",
              "min" : 1,
              "max" : "1"
            },
            "type" : [
              {
                "extension" : [
                  {
                    "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
                    "valueUrl" : "uri"
                  }
                ],
                "code" : "http://hl7.org/fhirpath/System.String"
              }
            ],
            "fixedUri" : "snippet",
            "isModifier" : false,
            "isSummary" : false,
            "mapping" : [
              {
                "identity" : "rim",
                "map" : "N/A"
              }
            ]
          },
          {
            "id" : "Extension.extension:snippet.value[x]",
            "path" : "Extension.extension.value[x]",
            "short" : "Human-readable text snippet describing the context of the search match.",
            "definition" : "This value contains a short, human-readable text snippet that describes the context of the search match. It enables quick orientation by presenting relevant content from the identified document or resource.",
            "min" : 1,
            "max" : "1",
            "base" : {
              "path" : "Extension.value[x]",
              "min" : 0,
              "max" : "1"
            },
            "type" : [
              {
                "code" : "string"
              }
            ],
            "constraint" : [
              {
                "key" : "ele-1",
                "severity" : "error",
                "human" : "All FHIR elements must have a @value or children",
                "expression" : "hasValue() or (children().count() > id.count())",
                "xpath" : "@value|f:*|h:div",
                "source" : "http://hl7.org/fhir/StructureDefinition/Element"
              }
            ],
            "isModifier" : false,
            "isSummary" : false,
            "mapping" : [
              {
                "identity" : "rim",
                "map" : "N/A"
              }
            ]
          },
          {
            "id" : "Extension.extension:pageNumber",
            "path" : "Extension.extension",
            "sliceName" : "pageNumber",
            "short" : "Extension",
            "definition" : "An Extension",
            "min" : 0,
            "max" : "1",
            "base" : {
              "path" : "Element.extension",
              "min" : 0,
              "max" : "*"
            },
            "type" : [
              {
                "code" : "Extension"
              }
            ],
            "constraint" : [
              {
                "key" : "ele-1",
                "severity" : "error",
                "human" : "All FHIR elements must have a @value or children",
                "expression" : "hasValue() or (children().count() > id.count())",
                "xpath" : "@value|f:*|h:div",
                "source" : "http://hl7.org/fhir/StructureDefinition/Element"
              },
              {
                "key" : "ext-1",
                "severity" : "error",
                "human" : "Must have either extensions or value[x], not both",
                "expression" : "extension.exists() != value.exists()",
                "xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
                "source" : "http://hl7.org/fhir/StructureDefinition/Extension"
              }
            ],
            "isModifier" : false,
            "isSummary" : false
          },
          {
            "id" : "Extension.extension:pageNumber.id",
            "path" : "Extension.extension.id",
            "representation" : [
              "xmlAttr"
            ],
            "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.",
            "min" : 0,
            "max" : "1",
            "base" : {
              "path" : "Element.id",
              "min" : 0,
              "max" : "1"
            },
            "type" : [
              {
                "extension" : [
                  {
                    "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
                    "valueUrl" : "string"
                  }
                ],
                "code" : "http://hl7.org/fhirpath/System.String"
              }
            ],
            "isModifier" : false,
            "isSummary" : false,
            "mapping" : [
              {
                "identity" : "rim",
                "map" : "n/a"
              }
            ]
          },
          {
            "id" : "Extension.extension:pageNumber.extension",
            "path" : "Extension.extension.extension",
            "slicing" : {
              "discriminator" : [
                {
                  "type" : "value",
                  "path" : "url"
                }
              ],
              "description" : "Extensions are always sliced by (at least) url",
              "rules" : "open"
            },
            "short" : "Extension",
            "definition" : "An Extension",
            "min" : 0,
            "max" : "0",
            "base" : {
              "path" : "Element.extension",
              "min" : 0,
              "max" : "*"
            },
            "type" : [
              {
                "code" : "Extension"
              }
            ],
            "constraint" : [
              {
                "key" : "ele-1",
                "severity" : "error",
                "human" : "All FHIR elements must have a @value or children",
                "expression" : "hasValue() or (children().count() > id.count())",
                "xpath" : "@value|f:*|h:div",
                "source" : "http://hl7.org/fhir/StructureDefinition/Element"
              },
              {
                "key" : "ext-1",
                "severity" : "error",
                "human" : "Must have either extensions or value[x], not both",
                "expression" : "extension.exists() != value.exists()",
                "xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
                "source" : "http://hl7.org/fhir/StructureDefinition/Extension"
              }
            ],
            "isModifier" : false,
            "isSummary" : false
          },
          {
            "id" : "Extension.extension:pageNumber.url",
            "path" : "Extension.extension.url",
            "representation" : [
              "xmlAttr"
            ],
            "short" : "identifies the meaning of the extension",
            "definition" : "Source of the definition for the extension code - a logical name or a URL.",
            "comment" : "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.",
            "min" : 1,
            "max" : "1",
            "base" : {
              "path" : "Extension.url",
              "min" : 1,
              "max" : "1"
            },
            "type" : [
              {
                "extension" : [
                  {
                    "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
                    "valueUrl" : "uri"
                  }
                ],
                "code" : "http://hl7.org/fhirpath/System.String"
              }
            ],
            "fixedUri" : "pageNumber",
            "isModifier" : false,
            "isSummary" : false,
            "mapping" : [
              {
                "identity" : "rim",
                "map" : "N/A"
              }
            ]
          },
          {
            "id" : "Extension.extension:pageNumber.value[x]",
            "path" : "Extension.extension.value[x]",
            "short" : "For paginated documents (e.g. PDF), indicates the page on which the full-text search match was found.",
            "definition" : "For documents with pagination, such as PDF files, this element may be used to indicate the specific page on which the full-text search identified a match.",
            "min" : 1,
            "max" : "1",
            "base" : {
              "path" : "Extension.value[x]",
              "min" : 0,
              "max" : "1"
            },
            "type" : [
              {
                "code" : "string"
              }
            ],
            "constraint" : [
              {
                "key" : "ele-1",
                "severity" : "error",
                "human" : "All FHIR elements must have a @value or children",
                "expression" : "hasValue() or (children().count() > id.count())",
                "xpath" : "@value|f:*|h:div",
                "source" : "http://hl7.org/fhir/StructureDefinition/Element"
              }
            ],
            "isModifier" : false,
            "isSummary" : false,
            "mapping" : [
              {
                "identity" : "rim",
                "map" : "N/A"
              }
            ]
          },
          {
            "id" : "Extension.url",
            "path" : "Extension.url",
            "representation" : [
              "xmlAttr"
            ],
            "short" : "identifies the meaning of the extension",
            "definition" : "Source of the definition for the extension code - a logical name or a URL.",
            "comment" : "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.",
            "min" : 1,
            "max" : "1",
            "base" : {
              "path" : "Extension.url",
              "min" : 1,
              "max" : "1"
            },
            "type" : [
              {
                "extension" : [
                  {
                    "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
                    "valueUrl" : "uri"
                  }
                ],
                "code" : "http://hl7.org/fhirpath/System.String"
              }
            ],
            "fixedUri" : "https://profiles.ihe.net/ITI/MHD/StructureDefinition/ihe-full-text-search-match-snippet",
            "isModifier" : false,
            "isSummary" : false,
            "mapping" : [
              {
                "identity" : "rim",
                "map" : "N/A"
              }
            ]
          },
          {
            "id" : "Extension.value[x]",
            "path" : "Extension.value[x]",
            "short" : "Value of extension",
            "definition" : "Value of extension - must be one of a constrained set of the data types (see [Extensibility](http://hl7.org/fhir/R4/extensibility.html) for a list).",
            "min" : 0,
            "max" : "0",
            "base" : {
              "path" : "Extension.value[x]",
              "min" : 0,
              "max" : "1"
            },
            "type" : [
              {
                "code" : "base64Binary"
              },
              {
                "code" : "boolean"
              },
              {
                "code" : "canonical"
              },
              {
                "code" : "code"
              },
              {
                "code" : "date"
              },
              {
                "code" : "dateTime"
              },
              {
                "code" : "decimal"
              },
              {
                "code" : "id"
              },
              {
                "code" : "instant"
              },
              {
                "code" : "integer"
              },
              {
                "code" : "markdown"
              },
              {
                "code" : "oid"
              },
              {
                "code" : "positiveInt"
              },
              {
                "code" : "string"
              },
              {
                "code" : "time"
              },
              {
                "code" : "unsignedInt"
              },
              {
                "code" : "uri"
              },
              {
                "code" : "url"
              },
              {
                "code" : "uuid"
              },
              {
                "code" : "Address"
              },
              {
                "code" : "Age"
              },
              {
                "code" : "Annotation"
              },
              {
                "code" : "Attachment"
              },
              {
                "code" : "CodeableConcept"
              },
              {
                "code" : "Coding"
              },
              {
                "code" : "ContactPoint"
              },
              {
                "code" : "Count"
              },
              {
                "code" : "Distance"
              },
              {
                "code" : "Duration"
              },
              {
                "code" : "HumanName"
              },
              {
                "code" : "Identifier"
              },
              {
                "code" : "Money"
              },
              {
                "code" : "Period"
              },
              {
                "code" : "Quantity"
              },
              {
                "code" : "Range"
              },
              {
                "code" : "Ratio"
              },
              {
                "code" : "Reference"
              },
              {
                "code" : "SampledData"
              },
              {
                "code" : "Signature"
              },
              {
                "code" : "Timing"
              },
              {
                "code" : "ContactDetail"
              },
              {
                "code" : "Contributor"
              },
              {
                "code" : "DataRequirement"
              },
              {
                "code" : "Expression"
              },
              {
                "code" : "ParameterDefinition"
              },
              {
                "code" : "RelatedArtifact"
              },
              {
                "code" : "TriggerDefinition"
              },
              {
                "code" : "UsageContext"
              },
              {
                "code" : "Dosage"
              },
              {
                "code" : "Meta"
              }
            ],
            "constraint" : [
              {
                "key" : "ele-1",
                "severity" : "error",
                "human" : "All FHIR elements must have a @value or children",
                "expression" : "hasValue() or (children().count() > id.count())",
                "xpath" : "@value|f:*|h:div",
                "source" : "http://hl7.org/fhir/StructureDefinition/Element"
              }
            ],
            "isModifier" : false,
            "isSummary" : false,
            "mapping" : [
              {
                "identity" : "rim",
                "map" : "N/A"
              }
            ]
          }
        ]
      },
      "differential" : {
        "element" : [
          {
            "id" : "Extension",
            "path" : "Extension",
            "short" : "Full-Text Search Match Snippet",
            "definition" : "This extension contains a text snippet describing the context of a full-text search match. It highlights relevant content that corresponds to the provided search terms and provides a concise preview of the search result."
          },
          {
            "id" : "Extension.extension",
            "path" : "Extension.extension",
            "slicing" : {
              "discriminator" : [
                {
                  "type" : "value",
                  "path" : "url"
                }
              ],
              "description" : "Extensions are always sliced by (at least) url",
              "rules" : "closed"
            }
          },
          {
            "id" : "Extension.extension:snippet",
            "path" : "Extension.extension",
            "sliceName" : "snippet",
            "min" : 0,
            "max" : "1"
          },
          {
            "id" : "Extension.extension:snippet.extension",
            "path" : "Extension.extension.extension",
            "max" : "0"
          },
          {
            "id" : "Extension.extension:snippet.url",
            "path" : "Extension.extension.url",
            "fixedUri" : "snippet"
          },
          {
            "id" : "Extension.extension:snippet.value[x]",
            "path" : "Extension.extension.value[x]",
            "short" : "Human-readable text snippet describing the context of the search match.",
            "definition" : "This value contains a short, human-readable text snippet that describes the context of the search match. It enables quick orientation by presenting relevant content from the identified document or resource.",
            "min" : 1,
            "type" : [
              {
                "code" : "string"
              }
            ]
          },
          {
            "id" : "Extension.extension:pageNumber",
            "path" : "Extension.extension",
            "sliceName" : "pageNumber",
            "min" : 0,
            "max" : "1"
          },
          {
            "id" : "Extension.extension:pageNumber.extension",
            "path" : "Extension.extension.extension",
            "max" : "0"
          },
          {
            "id" : "Extension.extension:pageNumber.url",
            "path" : "Extension.extension.url",
            "fixedUri" : "pageNumber"
          },
          {
            "id" : "Extension.extension:pageNumber.value[x]",
            "path" : "Extension.extension.value[x]",
            "short" : "For paginated documents (e.g. PDF), indicates the page on which the full-text search match was found.",
            "definition" : "For documents with pagination, such as PDF files, this element may be used to indicate the specific page on which the full-text search identified a match.",
            "min" : 1,
            "type" : [
              {
                "code" : "string"
              }
            ]
          },
          {
            "id" : "Extension.url",
            "path" : "Extension.url",
            "fixedUri" : "https://profiles.ihe.net/ITI/MHD/StructureDefinition/ihe-full-text-search-match-snippet"
          },
          {
            "id" : "Extension.value[x]",
            "path" : "Extension.value[x]",
            "max" : "0"
          }
        ]
      }
    }