This
page
is
part
of
the
FHIR
Specification
(v3.0.2:
(v4.0.1:
R4
-
Mixed
Normative
and
STU
3).
)
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
R3
R4
R3
R2
| FHIR Infrastructure Work Group | Maturity Level : N/A |
|
Compartments : Not linked to any defined compartments |
Raw XML ( canonical form + also see XML Format Specification )
General example (id = "example")
<?xml version="1.0" encoding="UTF-8"?> <SearchParameter xmlns="http://hl7.org/fhir"> <id value="example"/>(Details : {urn:iso:std:iso:3166 code 'US' = 'United States', given as 'United States of America (the)'}): Need to search by identifier for various infrastructural cases - mainly retrieving packages, and matching as part of a chain: Search by resource identifier - e.g. same as the read interaction, but can return included resources<text> <status value="generated"/> <div xmlns="http://www.w3.org/1999/xhtml"><p> <b> Generated Narrative with Details</b> </p> <p> <b> id</b> : example</p> <p> <b> url</b> : <b> http://hl7.org/fhir/SearchParameter/example</b> </p> <p> <b> version</b> : 1</p> <p> <b> name</b> : ID-SEARCH-PARAMETER</p> <p> <b> derivedFrom</b> : <a> http://hl7.org/fhir/SearchParameter/Resource-id</a> </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 resource identifier - e.g. same as the read interaction, but can return included resources</p> <p> <b> useContext</b> : </p> <p> <b> jurisdiction</b> : United States of America (the) <span> (Details : {urn:iso:std:iso:3166 code 'US' = 'United States of America', given as 'United States of America (the)'})</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> xpath</b> : f:*/f:id</p> <p> <b> xpathUsage</b> : normal</p> <p> <b> comparator</b> : eq</p> </div> </text> <url value="http://hl7.org/fhir/SearchParameter/example"/> <version value="1"/> <name value="ID-SEARCH-PARAMETER"/> <derivedFrom value="http://hl7.org/fhir/SearchParameter/Resource-id"/> <status value="draft"/> <experimental value="true"/> <date value="2013-10-23"/> <publisher value="Health Level Seven International (FHIR Infrastructure)"/> <contact> <name value="[string]"/> <!-- 0..1 Name of an individual to contact --> <telecom> <system value="url"/> <value value="http://hl7.org/fhir"/> </telecom> </contact> <description value="Search by resource identifier - e.g. same as the read interaction, but can return included resources"/> <useContext> <code><system value="http://terminology.hl7.org/CodeSystem/usage-context-type"/> <code value="focus"/> </code> <valueCodeableConcept> <coding><system value="http://terminology.hl7.org/CodeSystem/variant-state"/> <code value="positive"/> </coding> </valueCodeableConcept> </useContext> <jurisdiction> <coding> <system value="urn:iso:std:iso:3166"/> <code value="US"/> <display value="United States of America (the)"/> </coding> </jurisdiction> <!-- this is the canonical definition for the _id search parameter --> <purpose value="Need to search by identifier for various infrastructural cases - mainly retrieving packages, and matching as part of a chain"/> <code value="_id"/> <base value="Resource"/> <type value="token"/>Search by resource identifier - e.g. same as the read interaction, but can return included resources<expression value="id"/> <xpath value="f:*/f:id"/> <xpathUsage value="normal"/> <comparator value="eq"/> </ SearchParameter >
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.