Foundation
This
page
is
part
of
the
Continuous
Integration
Build
of
FHIR
Specification
(v4.0.1:
R4
-
Mixed
Normative
and
STU
)
in
it's
permanent
home
(it
will
always
(will
be
available
incorrect/inconsistent
at
this
URL).
The
current
version
which
supercedes
this
version
is
5.0.0
.
For
a
full
list
of
available
versions,
see
times).
See
the
Directory
of
published
versions
.
Page
versions:
R5
R4B
R4
R3
R2
| Responsible Owner: FHIR Infrastructure Work Group | Standards Status : Informative |
Compartments
:
|
Raw XML ( canonical form + also see XML Format Specification )
An example of a search response (id = "bundle-example")
<?xml version="1.0" encoding="UTF-8"?><!-- the total number of matches. This is a stupid example - there's a grand total of 3 matches, and<Bundle xmlns="http://hl7.org/fhir"> <id value="bundle-example"/> <!-- this example bundle is a search set --> <!-- when the search was executed --> <meta> <lastUpdated value="2014-08-18T01:43:30Z"/> </meta> <type value="searchset"/> <!-- the total number of matches. This is a stupid example - there's a grand total of 3 matches, and we're only going to return the first 1, with a next link, in order to demonstratewhat a page link looks like --> <!-- all search sets include the self link - the server's statement of what it thought it was searching on. The client can use this to cross-check whether the server executed what it asked the server to, if it cares --> https://example.com/base/MedicationRequest?patient=347&_include=MedicationRequest.medication& ;_count=2 <!-- now, the link to the next set of results. The actual URL is entirely at the discretion of the server, and is opaque to the client. Many servers will insert some kind of search instance identifier Note that a big set of results will include prev, first, last links as well as next --> https://example.com/base/MedicationRequest?patient=347&searchId=ff15fd40-ff71-4b48-b366-09c706be d9d0&page=2 <!-- this resource included as a match to the search criteria. Servers are not required to populate this, but should, because there are a few cases where it might be ambiguous whether a resource is added because it's a match or an include --> <!-- score. For matches where the criteria are not determinate, e.g. text search on narrative, the server can include a score to indicate how well the resource matches the conditions. Since this search is by patient identifier, there's nothing fuzzy about it, but for example purposes: -->what a page link looks like --> <total value="3"/> <!-- all search sets include the self link - the server's statement of what it thought it was searching on. The client can use this to cross-check whether the server executed what it asked the server to, if it cares --> <link> <relation value="self"/> <url value="https://example.com/base/MedicationRequest?patient=347&_include=MedicationRequest.medicat ion&_count=2"/> </link> <!-- now, the link to the next set of results. The actual URL is entirely at the discretion of the server, and is opaque to the client. Many servers will insert some kind of search instance identifier Note that a big set of results will include prev, first, last links as well as next --> <link> <relation value="next"/> <url value="https://example.com/base/MedicationRequest?patient=347&searchId=ff15fd40-ff71-4b48-b366-0 9c706bed9d0&page=2"/> </link> <!-- now, the actual entries --> <entry> <fullUrl value="https://example.com/base/MedicationRequest/3123"/> <!-- snip --> <resource> <MedicationRequest> <id value="3123"/> <text> <status value="generated"/> <div xmlns="http://www.w3.org/1999/xhtml"><p class="res-header-id"><b> Generated Narrative: MedicationRequest 3123</b> </p> <a name="3123"> </a> <a name="hc3123"> </a> <p> <b> status</b> : Unknown</p> <p> <b> intent</b> : Order</p> <h3> Medications</h3> <table class="grid"><tr> <td style="display: none">-</td> <td> <b> Reference</b> </td> </tr> <tr> <td style="display: none">*</td> <td> <a href="broken-link.html">Medication/example</a> </td> </tr> </table> <p> <b> subject</b> : <a href="patient-example-f001-pieter.html">Pieter van de Heuvel Male, DoB: 1944-11-17 ( urn:oid:2.16.840.1.113883.2.4.6.3#?ngen-9? (use : usual, ))</a> </p> </div> </text> <!-- snip --> <status value="unknown"/> <intent value="order"/> <medication> <reference> <reference value="Medication/example"/> </reference> </medication> <subject> <reference value="Patient/f001"/> </subject> </MedicationRequest> </resource> <!-- and now optional search information --> <search> <!-- this resource included as a match to the search criteria. Servers are not required to populate this, but should, because there are a few cases where it might be ambiguous whether a resource is added because it's a match or an include --> <mode value="match"/> <!-- score. For matches where the criteria are not determinate, e.g. text search on narrative, the server can include a score to indicate how well the resource matches the conditions. Since this search is by patient identifier, there's nothing fuzzy about it, but for example purposes: --> <score value="1"/> </search> </entry> <entry> <fullUrl value="https://example.com/base/Medication/example"/> <!-- snip --> <resource> <Medication> <id value="example"/> <text> <status value="generated"/> <div xmlns="http://www.w3.org/1999/xhtml"><p class="res-header-id"><b> Generated Narrative: Medication example</b> </p> <a name="example"> </a> <a name="hcexample"> </a> </div> </text> </Medication> </resource> <search> <!-- added because the client asked to include the medications --> <mode value="include"/> </search> </entry> </ Bundle >
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.
FHIR
®©
HL7.org
2011+.
FHIR
Release
4
(Technical
Correction
#1)
(v4.0.1)
R6
hl7.fhir.core#6.0.0-ballot3
generated
on
Fri,
Mon,
Nov
1,
2019
09:34+1100.
QA
Page
10,
2025
15:21+0000.
Links:
Search
|
Version
History
|
Table
of
Contents
|
Credits
Glossary
|
QA
|
Compare
to
R3
R4
|
Compare
to
R5
|
Compare
to
Last
Ballot
|
|
Propose
a
change