Foundation
This
page
is
part
of
the
FHIR
Specification
(v4.3.0:
R4B
(v5.0.0:
R5
-
STU
).
The
This
is
the
current
published
version
which
supercedes
in
it's
permanent
home
(it
will
always
be
available
at
this
version
is
5.0.0
.
URL).
For
a
full
list
of
available
versions,
see
the
Directory
of
published
versions
.
Page
versions:
R5
R4B
R5
R4B
R4
R3
| FHIR Infrastructure Work Group | Maturity Level : N/A | Standards Status : Informative |
Compartments
:
|
Raw Turtle (+ also see Turtle/RDF Format Specification )
An example of a search response
@prefix fhir: <http://hl7.org/fhir/> . @prefix owl: <http://www.w3.org/2002/07/owl#> . @prefix rdfs: <http://www.w3.org/2000/01/rdf-schema#> . @prefix xsd: <http://www.w3.org/2001/XMLSchema#> . # - resource -------------------------------------------------------------------<http://hl7.org/fhir/Bundle/bundle-example> a fhir:Bundle; fhir:nodeRole fhir:treeRoot; fhir:Resource.id [ fhir:value "bundle-example"]; fhir:Resource.meta [ fhir:Meta.lastUpdated [ fhir:value "2014-08-18T01:43:30Z"^^xsd:dateTime ] ]; fhir:Bundle.type [ fhir:value "searchset"]; fhir:Bundle.total [ fhir:value "3"^^xsd:nonNegativeInteger]; fhir:Bundle.link [ fhir:index 0; fhir:Bundle.link.relation [ fhir:value "self" ]; fhir:Bundle.link.url [ fhir:value "https://example.com/base/MedicationRequest?patient=347&_include=MedicationRequest.medication&_count=2" ] ], [ fhir:index 1; fhir:Bundle.link.relation [ fhir:value "next" ]; fhir:Bundle.link.url [ fhir:value "https://example.com/base/MedicationRequest?patient=347&searchId=ff15fd40-ff71-4b48-b366-09c706bed9d0&page=2" ] ]; fhir:Bundle.entry [ fhir:index 0; fhir:Bundle.entry.fullUrl [ fhir:value "https://example.com/base/MedicationRequest/3123" ]; fhir:Bundle.entry.resource <https://example.com/base/MedicationRequest/3123>; fhir:Bundle.entry.search [ fhir:Bundle.entry.search.mode [ fhir:value "match" ]; fhir:Bundle.entry.search.score [ fhir:value "1"^^xsd:decimal ] ] ], [ fhir:index 1; fhir:Bundle.entry.fullUrl [ fhir:value "https://example.com/base/Medication/example" ]; fhir:Bundle.entry.resource <https://example.com/base/Medication/example>; fhir:Bundle.entry.search [ fhir:Bundle.entry.search.mode [ fhir:value "include" ][a fhir:Bundle ; fhir:nodeRole fhir:treeRoot ; fhir:id [ fhir:v "bundle-example"] ; # fhir:meta [ fhir:lastUpdated [ fhir:v "2014-08-18T01:43:30Z"^^xsd:dateTime ] ] ; # this example bundle is a search set , when the search was executed fhir:type [ fhir:v "searchset"] ; # fhir:total [ fhir:v "3"^^xsd:nonNegativeInteger] ; # 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 demonstrate what a page link # looks like fhir:link ( [ fhir:relation [ fhir:v "self" ] ; fhir:url [ fhir:v "https://example.com/base/MedicationRequest?patient=347&_include=MedicationRequest.medication&_count=2"^^xsd:anyURI ] ] [ fhir:relation [ fhir:v "next" ] ; fhir:url [ fhir:v "https://example.com/base/MedicationRequest?patient=347&searchId=ff15fd40-ff71-4b48-b366-09c706bed9d0&page=2"^^xsd:anyURI ] ] ) ; # 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 fhir:entry ( [ fhir:fullUrl [ fhir:v "https://example.com/base/MedicationRequest/3123"^^xsd:anyURI ] ; fhir:resource ( <https://example.com/base/MedicationRequest/3123> ) ; # snip fhir:search [ fhir:mode [ fhir:v "match" ] ; # this resource included as a match to the search criteria.\n Servers are not required to populate this, but should, because\n there are a few cases where it might be ambiguous whether a \n resource is added because it's a match or an include fhir:score [ fhir:v "1"^^xsd:decimal ] # score. For matches where the criteria are not determinate,\n e.g. text search on narrative, the server can include a score to indicate\n how well the resource matches the conditions. Since this search is by patient\n identifier, there's nothing fuzzy about it, but for example purposes: ] # and now optional search information ] [ fhir:fullUrl [ fhir:v "https://example.com/base/Medication/example"^^xsd:anyURI ] ; fhir:resource ( <https://example.com/base/Medication/example> ) ; fhir:search [ fhir:mode [ fhir:v "include" ] # added because the client asked to include the medications ]] . <https://example.com/base/MedicationRequest/3123> a fhir:MedicationRequest; fhir:Resource.id [ fhir:value "3123"]; fhir:DomainResource.text [ fhir:Narrative.status [ fhir:value "generated" ]; fhir:Narrative.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 "3123" </p></div><p><b>status</b>: unknown</p><p><b>intent</b>: order</p><p><b>medication</b>: <a href=\"todo.html\">Medication/example</a></p><p><b>subject</b>: <a href=\"todo.html\">Patient/347</a></p></div>" ]; fhir:MedicationRequest.status [ fhir:value "unknown"]; fhir:MedicationRequest.intent [ fhir:value "order"]; fhir:MedicationRequest.medicationReference [ fhir:link <http://hl7.org/fhir/Medication/example>; fhir:Reference.reference [ fhir:value "Medication/example" ] ]; fhir:MedicationRequest.subject [ fhir:link <http://hl7.org/fhir/Patient/347>; fhir:Reference.reference [ fhir:value "Patient/347" ] ] . <http://hl7.org/fhir/Medication/example> a fhir:Medication . <http://hl7.org/fhir/Patient/347> a fhir:Patient . <https://example.com/base/Medication/example> a fhir:Medication; fhir:Resource.id [ fhir:value "example"]; fhir:DomainResource.text [ fhir:Narrative.status [ fhir:value "generated" ]; fhir:Narrative.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" </p></div></div>" ] .] )] . # now, the actual entries# - ontology header ------------------------------------------------------------<https://example.com/base/MedicationRequest/3123> a fhir:MedicationRequest ; fhir:id [ fhir:v "3123"] ; # fhir:text [ fhir:status [ fhir:v "generated" ] ; fhir:div "<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%\"><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>-</td><td><b>Reference</b></td></tr><tr><td>*</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>" ] ; # snip fhir:status [ fhir:v "unknown"] ; # fhir:intent [ fhir:v "order"] ; # fhir:medication [ fhir:reference [ fhir:reference [ fhir:v "Medication/example" ] ] ] ; # fhir:subject [ fhir:reference [ fhir:v "Patient/347" ] ] . #<http://hl7.org/fhir/Bundle/bundle-example.ttl> a owl:Ontology; owl:imports fhir:fhir.ttl; owl:versionIRI <http://build.fhir.org/Bundle/bundle-example.ttl> .<https://example.com/base/Medication/example> a fhir:Medication ; fhir:id [ fhir:v "example"] ; # fhir:text [ fhir:status [ fhir:v "generated" ] ; fhir:div "<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%\"><p style=\"margin-bottom: 0px\">Resource Medication "example" </p></div></div>" ] . # snip # -------------------------------------------------------------------------------------
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
4B
(v4.3.0)
hl7.fhir.r4b.core#4.3.0
R5
hl7.fhir.core#5.0.0
generated
on
Sat,
May
28,
2022
12:54+1000.
Sun,
Mar
26,
2023
15:24+1100.
Links:
Search
|
Version
History
|
Table
of
Contents
|
Glossary
|
QA
Page
|
Compare
to
R4
|
Compare
to
R4B
|
|
Propose
a
change