Release 4 4B

This page is part of the FHIR Specification (v4.0.1: R4 (v4.3.0: R4B - Mixed Normative and STU ) in it's permanent home (it will always be available at this URL). ). The current version which supercedes this version is 5.0.0 . For a full list of available versions, see the Directory of published versions . Page versions: R5 R4B R4 R4B R4 R3 R2

Searchparameter-example-extension.json

FHIR Infrastructure Work Group Maturity Level : N/A Standards Status : Informative Compartments : Not linked to any defined compartments

Raw JSON ( canonical form + also see JSON Format Specification )

Search parameter for an extension example 

{
  "resourceType": "SearchParameter",
  "id": "example-extension",
  "text": {
    "status": "generated",
    "div": "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p><b>Generated Narrative with Details</b></p><p><b>id</b>: example-extension</p><p><b>url</b>: <b>http://hl7.org/fhir/SearchParameter/example-extension</b></p><p><b>name</b>: Example Search Parameter on an extension</p><p><b>status</b>: draft</p><p><b>experimental</b>: true</p><p><b>publisher</b>: Health Level Seven International (FHIR Infrastructure)</p><p><b>contact</b>: </p><p><b>description</b>: Search by url for a participation agreement, which is stored in a DocumentReference</p><p><b>code</b>: part-agree</p><p><b>base</b>: Patient</p><p><b>type</b>: reference</p><p><b>expression</b>: DocumentReference.extension('http://example.org/fhir/StructureDefinition/participation-agreement')</p><p><b>xpath</b>: f:DocumentReference/f:extension[@url='http://example.org/fhir/StructureDefinition/participation-agreement']</p><p><b>xpathUsage</b>: normal</p><p><b>target</b>: DocumentReference</p></div>"

  "resourceType" : "SearchParameter",
  "id" : "example-extension",
  "text" : {
    "status" : "generated",
    "div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p><b>Generated Narrative</b></p><div style=\"display: inline-block; background-color: #d9e0e7; padding: 6px; margin: 4px; border: 1px solid #8da1b4; border-radius: 5px; line-height: 60%\"><p style=\"margin-bottom: 0px\">Resource &quot;example-extension&quot; </p></div><p><b>url</b>: <code>http://hl7.org/fhir/SearchParameter/example-extension</code></p><p><b>name</b>: Example Search Parameter on an extension</p><p><b>status</b>: draft</p><p><b>experimental</b>: true</p><p><b>publisher</b>: Health Level Seven International (FHIR Infrastructure)</p><p><b>contact</b>: <a href=\"http://hl7.org/fhir\">http://hl7.org/fhir</a></p><p><b>description</b>: Search by url for a participation agreement, which is stored in a DocumentReference</p><p><b>code</b>: part-agree</p><p><b>base</b>: Patient</p><p><b>type</b>: reference</p><p><b>expression</b>: DocumentReference.extension('http://example.org/fhir/StructureDefinition/participation-agreement')</p><p><b>xpath</b>: f:DocumentReference/f:extension[@url='http://example.org/fhir/StructureDefinition/participation-agreement']</p><p><b>xpathUsage</b>: normal</p><p><b>target</b>: DocumentReference</p></div>"

  },
  "url": "http://hl7.org/fhir/SearchParameter/example-extension",
  "name": "Example Search Parameter on an extension",
  "status": "draft",
  "experimental": true,
  "publisher": "Health Level Seven International (FHIR Infrastructure)",
  "contact": [
    {
      "telecom": [
        {
          "system": "url",
          "value": "http://hl7.org/fhir"
        }
      ]
    }
  ],
  "description": "Search by url for a participation agreement, which is stored in a DocumentReference",
  "code": "part-agree",
  "base": [
    "Patient"
  ],
  "type": "reference",
  "expression": "DocumentReference.extension('http://example.org/fhir/StructureDefinition/participation-agreement')",
  "xpath": "f:DocumentReference/f:extension[@url='http://example.org/fhir/StructureDefinition/participation-agreement']",
  "xpathUsage": "normal",
  "target": [
    "DocumentReference"
  ]

  "url" : "http://hl7.org/fhir/SearchParameter/example-extension",
  "name" : "Example Search Parameter on an extension",
  "status" : "draft",
  "experimental" : true,
  "publisher" : "Health Level Seven International (FHIR Infrastructure)",
  "contact" : [{
    "telecom" : [{
      "system" : "url",
      "value" : "http://hl7.org/fhir"
    }]
  }],
  "description" : "Search by url for a participation agreement, which is stored in a DocumentReference",
  "code" : "part-agree",
  "base" : ["Patient"],
  "type" : "reference",
  "expression" : "DocumentReference.extension('http://example.org/fhir/StructureDefinition/participation-agreement')",
  "xpath" : "f:DocumentReference/f:extension[@url='http://example.org/fhir/StructureDefinition/participation-agreement']",
  "xpathUsage" : "normal",
  "target" : ["DocumentReference"]

}

Usage note: every effort has been made to ensure that the examples are correct and useful, but they are not a normative part of the specification.