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
| 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 a reference example
{
"resourceType": "SearchParameter",
"id": "example-reference",
"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-reference</p><p><b>url</b>: <b>http://hl7.org/fhir/SearchParameter/example-reference</b></p><p><b>name</b>: Example Search Parameter</p><p><b>status</b>: draft</p><p><b>experimental</b>: true</p><p><b>date</b>: 23/10/2013</p><p><b>publisher</b>: Health Level Seven International (FHIR Infrastructure)</p><p><b>contact</b>: </p><p><b>description</b>: Search by condition subject</p><p><b>purpose</b>: Need to search Condition by subject</p><p><b>code</b>: subject</p><p><b>base</b>: Condition</p><p><b>type</b>: reference</p><p><b>expression</b>: Condition.subject</p><p><b>xpathUsage</b>: normal</p><p><b>target</b>: Organization</p><p><b>modifier</b>: missing</p><p><b>chain</b>: name, identifier</p></div>"
"resourceType" : "SearchParameter",
"id" : "example-reference",
"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 "example-reference" </p></div><p><b>url</b>: <code>http://hl7.org/fhir/SearchParameter/example-reference</code></p><p><b>name</b>: Example Search Parameter</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>: Health Level Seven International (FHIR Infrastructure)</p><p><b>contact</b>: [string]: <a href=\"http://hl7.org/fhir\">http://hl7.org/fhir</a></p><p><b>description</b>: Search by condition subject</p><p><b>purpose</b>: Need to search Condition by subject</p><p><b>code</b>: subject</p><p><b>base</b>: Condition</p><p><b>type</b>: reference</p><p><b>expression</b>: Condition.subject</p><p><b>xpathUsage</b>: normal</p><p><b>target</b>: Organization</p><p><b>modifier</b>: missing</p><p><b>chain</b>: name, identifier</p></div>"
},
"url": "http://hl7.org/fhir/SearchParameter/example-reference",
"name": "Example Search Parameter",
"status": "draft",
"experimental": true,
"date": "2013-10-23",
"publisher": "Health Level Seven International (FHIR Infrastructure)",
"contact": [
{
"name": "[string]",
"telecom": [
{
"system": "url",
"value": "http://hl7.org/fhir"
}
]
}
],
"description": "Search by condition subject",
"purpose": "Need to search Condition by subject",
"code": "subject",
"base": [
"Condition"
],
"type": "reference",
"expression": "Condition.subject",
"xpathUsage": "normal",
"target": [
"Organization"
],
"modifier": [
"missing"
],
"chain": [
"name",
"identifier"
]
"url" : "http://hl7.org/fhir/SearchParameter/example-reference",
"name" : "Example Search Parameter",
"status" : "draft",
"experimental" : true,
"date" : "2013-10-23",
"publisher" : "Health Level Seven International (FHIR Infrastructure)",
"contact" : [{
"name" : "[string]",
"telecom" : [{
"system" : "url",
"value" : "http://hl7.org/fhir"
}]
}],
"description" : "Search by condition subject",
"purpose" : "Need to search Condition by subject",
"code" : "subject",
"base" : ["Condition"],
"type" : "reference",
"expression" : "Condition.subject",
"xpathUsage" : "normal",
"target" : ["Organization"],
"modifier" : ["missing"],
"chain" : ["name",
"identifier"]
}
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.