This page is part of the FHIR Specification v6.0.0-ballot1: Release 6 Ballot (1st Draft) (see Ballot Notes). The current version is 5.0.0. For a full list of available versions, see the Directory of published versions
General example
{
"resourceType" : "SearchParameter",
"id" : "example",
"text" : {
"status" : "extensions",
"div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p><b>Generated Narrative: SearchParameter</b><a name=\"example\"> </a></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 SearchParameter "example" </p></div><p><b>StructureDefinition Work Group</b>: fhir</p><p><b>url</b>: <code>http://hl7.org/fhir/SearchParameter/example</code></p><p><b>version</b>: 1</p><p><b>name</b>: IDSEARCHPARAMETER</p><p><b>title</b>: I D- S E A R C H- P A R A M E T E R</p><p><b>derivedFrom</b>: <a href=\"resource-search.html#Resource-id\">_id</a></p><p><b>status</b>: draft</p><p><b>experimental</b>: true</p><p><b>date</b>: 2013-10-23</p><p><b>publisher</b>: HL7 International / FHIR Infrastructure</p><p><b>contact</b>: [string]: <a href=\"http://www.hl7.org/Special/committees/fiwg\">http://www.hl7.org/Special/committees/fiwg</a></p><p><b>description</b>: Search by resource identifier - e.g. same as the read interaction, but can return included resources</p><h3>UseContexts</h3><table class=\"grid\"><tr><td style=\"display: none\">-</td><td><b>Code</b></td><td><b>Value[x]</b></td></tr><tr><td style=\"display: none\">*</td><td>Clinical Focus (Details: http://terminology.hl7.org/CodeSystem/usage-context-type code focus = 'Clinical Focus', stated as 'null')</td><td>positive <span style=\"background: LightGoldenRodYellow; margin: 4px; border: 1px solid khaki\"> (<a href=\"http://terminology.hl7.org/5.4.0/CodeSystem-variant-state.html\">sequenceStatus</a>#positive)</span></td></tr></table><p><b>jurisdiction</b>: United States of America <span style=\"background: LightGoldenRodYellow; margin: 4px; border: 1px solid khaki\"> (<a href=\"http://terminology.hl7.org/5.4.0/CodeSystem-ISO3166Part1.html\">ISO 3166-1 Codes for the representation of names of countries and their subdivisions — Part 1: Country code</a>#US)</span></p><p><b>purpose</b>: Need to search by identifier for various infrastructural cases - mainly retrieving packages, and matching as part of a chain</p><p><b>code</b>: _id</p><p><b>base</b>: Resource</p><p><b>type</b>: token</p><p><b>expression</b>: id</p><p><b>processingMode</b>: normal</p></div>"
},
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
"valueCode" : "fhir"
}],
"url" : "http://hl7.org/fhir/SearchParameter/example",
"version" : "1",
"name" : "IDSEARCHPARAMETER",
"title" : "I D- S E A R C H- P A R A M E T E R",
"derivedFrom" : "http://hl7.org/fhir/SearchParameter/Resource-id",
"status" : "draft",
"experimental" : true,
"date" : "2013-10-23",
"publisher" : "HL7 International / FHIR Infrastructure",
"contact" : [{
"name" : "[string]",
"telecom" : [{
"system" : "url",
"value" : "http://www.hl7.org/Special/committees/fiwg"
}]
}],
"description" : "Search by resource identifier - e.g. same as the read interaction, but can return included resources",
"useContext" : [{
"code" : {
"system" : "http://terminology.hl7.org/CodeSystem/usage-context-type",
"code" : "focus"
},
"valueCodeableConcept" : {
"coding" : [{
"system" : "http://terminology.hl7.org/CodeSystem/variant-state",
"code" : "positive"
}]
}
}],
"jurisdiction" : [{
"coding" : [{
"system" : "urn:iso:std:iso:3166",
"code" : "US",
"display" : "United States of America"
}]
}],
"purpose" : "Need to search by identifier for various infrastructural cases - mainly retrieving packages, and matching as part of a chain",
"code" : "_id",
"base" : ["Resource"],
"type" : "token",
"expression" : "id",
"processingMode" : "normal"
}
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.