Foundation
This
page
is
part
of
the
FHIR
Specification
(v5.0.0:
R5
-
STU
v6.0.0-ballot1:
Release
6
Ballot
(1st
Draft)
(see
Ballot
Notes
).
This
is
the
The
current
published
version
in
it's
permanent
home
(it
will
always
be
available
at
this
URL).
is
5.0.0
.
For
a
full
list
of
available
versions,
see
the
Directory
of
published
versions
.
Page
versions:
R5
R4B
R4
R3
R2
| FHIR Infrastructure Work Group | Maturity Level : N/A | Standards Status : Informative | Compartments : No defined 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"?><Bundle xmlns="http://hl7.org/fhir"> <id value="bundle-example"/> <!-- this example bundle is a search set --> <meta> <lastUpdated value="2014-08-18T01:43:30Z"/> <!-- when the search was executed --> </meta> <type value="searchset"/> <!-- the total number of matches. This is a stupid example - there's a grand totalof 3 matches, andof 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 -->what a page link looks like --> <total value="3"/> <!-- all search sets include the self link - the server's statement of what it thoughtit wasit was searching on. The client can use this to cross-check whether the server executedwhat it asked the server to, if it cares -->what it asked the server to, if it cares --> <link> <relation value="self"/> <url value="https://example.com/base/MedicationRequest?patient=347&_include=MedicationRequest.medication&_count=2ion&_count=2"/> </link> <!-- now, the link to the next set of results. The actual URL is entirely at thediscretion of the server, and is opaque to the client. Many servers will insertsome kind of search instance identifiersome kind of search instance identifier Note that a big set of results will include prev, first, last links as well asnext -->next --> <link> <relation value="next"/> <url value="https://example.com/base/MedicationRequest?patient=347&searchId=ff15fd40-ff71-4b48-b366-09c706bed9d0&page=29c706bed9d0&page=2"/> </link> <!-- now, the actual entries --> <entry> <fullUrl value="https://example.com/base/MedicationRequest/3123"/> <!-- the matching resource --> <resource> <MedicationRequest> <id value="3123"/> <!-- snip --> <text> <status value="generated"/> <div xmlns="http://www.w3.org/1999/xhtml"><p> <b> Generated Narrative: MedicationRequest</b> <a name="3123"> </a> </p> <div style="display: inline-block; background-color: #d9e0e7; padding: 6px; margin: 4px; border:1px solid #8da1b4; border-radius: 5px; line-height: 60% <!-- 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 patient1px solid #8da1b4; border-radius: 5px; line-height: 60%"><p style="margin-bottom: 0px">Resource MedicationRequest "3123" </p> </div> <p> <b> status</b> : <span title=" snip ">unknown</span> </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="broken-link.html">Patient/347</a> </p> </div> </text> <status value="unknown"/> <intent value="order"/> <medication> <reference> <reference value="Medication/example"/> </reference> </medication> <subject> <reference value="Patient/347"/> </subject> <!-- snip --> </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"/> <resource> <Medication> <id value="example"/> <!-- snip --> <text> <status value="generated"/> <div xmlns="http://www.w3.org/1999/xhtml"><p> <b> Generated Narrative: Medication</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%1px solid #8da1b4; border-radius: 5px; line-height: 60%"><p style="margin-bottom: 0px">Resource Medication "example" </p> </div> </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
R5
hl7.fhir.core#5.0.0
R6
hl7.fhir.core#6.0.0-ballot1
generated
on
Sun,
Mar
26,
Mon,
Dec
18,
2023
15:24+1100.
15:16+1100.
Links:
Search
|
Version
History
|
Contents
|
Glossary
|
QA
|
Compare
to
R4
|
Compare
to
R4B
R5
|
|
Propose
a
change